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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.75 by root, Tue Jan 10 05:00:13 2006 UTC vs.
Revision 1.119 by root, Fri Jan 20 18:59:31 2006 UTC

…		…
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
39		39
		40	Or by adding them to the resource for extensions loaded by default:
		41
		42	URxvt.perl-ext-common: default,automove-background,selection-autotransform
		43
40	=over 4	44	=over 4
41		45
42	=item selection (enabled by default)	46	=item selection (enabled by default)
43		47
44	(More) intelligent selection. This extension tries to be more intelligent	48	(More) intelligent selection. This extension tries to be more intelligent
45	when the user extends selections (double-click). Right now, it tries to	49	when the user extends selections (double-click and further clicks). Right
46	select urls and complete shell-quoted arguments, which is very convenient,	50	now, it tries to select words, urls and complete shell-quoted
47	too, if your F<ls> supports C<--quoting-style=shell>.	51	arguments, which is very convenient, too, if your F<ls> supports
		52	C<--quoting-style=shell>.
48		53
		54	A double-click usually selects the word under the cursor, further clicks
		55	will enlarge the selection.
		56
		57	The selection works by trying to match a number of regexes and displaying
		58	them in increasing order of length. You can add your own regexes by
		59	specifying resources of the form:
		60
		61	URxvt.selection.pattern-0: perl-regex
		62	URxvt.selection.pattern-1: perl-regex
		63	...
		64
		65	The index number (0, 1...) must not have any holes, and each regex must
		66	contain at least one pair of capturing parentheses, which will be used for
		67	the match. For example, the followign adds a regex that matches everything
		68	between two vertical bars:
		69
		70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
		71
		72	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
49	It also offers the following bindable keyboard command:	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
…		…
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 (such as uri unescaping, perl	95	text into various other formats/action (such as uri unescaping, perl
70	evalution, web-browser starting etc.), depending on content.	96	evaluation, web-browser starting etc.), depending on content.
		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	};
71		116
72	=item searchable-scrollback<hotkey> (enabled by default)	117	=item searchable-scrollback<hotkey> (enabled by default)
73		118
74	Adds regex search functionality to the scrollback buffer, triggered	119	Adds regex search functionality to the scrollback buffer, triggered
75	by a hotkey (default: C<M-s>). When in search mode, normal terminal	120	by a hotkey (default: C<M-s>). While in search mode, normal terminal
76	input/output is suspended.	121	input/output is suspended and a regex is displayed at the bottom of the
		122	screen.
77		123
78	C</> starts an incremental regex search, C<n> searches further, C<p> or	124	Inputting characters appends them to the regex and continues incremental
79	C<N> jump to the previous match, C<G> jumps to the bottom and clears the	125	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
80	history, C<enter> leaves search mode at the current position and C<escape>	126	search upwards/downwards in the scrollback buffer, C<End> jumps to the
81	returns to the original position.	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.
82		131
83	=item digital-clock	132	=item selection-autotransform
84		133
85	Displays a digital clock using the built-in overlay.	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.
86		177
87	=item mark-urls	178	=item mark-urls
88		179
89	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
90		192
91	=item block-graphics-to-ascii	193	=item block-graphics-to-ascii
92		194
93	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,
94	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
95	similar-looking ascii character.	197	similar-looking ascii character.
96		198
		199	=item digital-clock
		200
		201	Displays a digital clock using the built-in overlay.
		202
97	=item example-refresh-hooks	203	=item example-refresh-hooks
98		204
99	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
100	window. Illustrates overwriting the refresh callbacks to create your own	206	window. Illustrates overwriting the refresh callbacks to create your own
101	overlays or changes.	207	overlays or changes.
		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/%
102		237
103	=back	238	=back
104		239
105	=head1 API DOCUMENTATION	240	=head1 API DOCUMENTATION
106		241
…		…
123	=over 4	258	=over 4
124		259
125	=item $text	260	=item $text
126		261
127	Rxvt-unicodes special way of encoding text, where one "unicode" character	262	Rxvt-unicodes special way of encoding text, where one "unicode" character
128	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.
129		264
130	=item $string	265	=item $string
131		266
132	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
133	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
…		…
179	called whenever the relevant event happens.	314	called whenever the relevant event happens.
180		315
181	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
182	the in the C<Extension Objects> section.	317	the in the C<Extension Objects> section.
183		318
184	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
185	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
186	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.
187		322
188	I<< When in doubt, return a false value (preferably C<()>). >>	323	I<< When in doubt, return a false value (preferably C<()>). >>
189		324
190	=over 4	325	=over 4
191		326
192	=item on_init $term	327	=item on_init $term
193		328
194	Called after a new terminal object has been initialized, but before	329	Called after a new terminal object has been initialized, but before
195	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
196	call or deliver senseless data, as terminal size and other characteristics	331	call or deliver senseless data, as terminal size and other characteristics
197	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
198	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.
199		346
200	=item on_reset $term	347	=item on_reset $term
201		348
202	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
203	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
204	variables.	351	variables.
205		352
206	=item on_start $term	353	=item on_child_start $term, $pid
207		354
208	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.
209	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>.
210		361
211	=item on_sel_make $term, $eventtime	362	=item on_sel_make $term, $eventtime
212		363
213	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
214	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
…		…
228	=item on_sel_extend $term	379	=item on_sel_extend $term
229		380
230	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
231	click) and is either supposed to return false (normal operation), or	382	click) and is either supposed to return false (normal operation), or
232	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
233	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.
234		387
235	See the F<selection> example extension.	388	See the F<selection> example extension.
236		389
237	=item on_view_change $term, $offset	390	=item on_view_change $term, $offset
238		391
…		…
305		458
306	Called whenever the user presses a key combination that has a	459	Called whenever the user presses a key combination that has a
307	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>
308	resource in the @@RXVT_NAME@@(1) manpage).	461	resource in the @@RXVT_NAME@@(1) manpage).
309		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
310	=item on_focus_in $term	469	=item on_focus_in $term
311		470
312	Called whenever the window gets the keyboard focus, before rxvt-unicode	471	Called whenever the window gets the keyboard focus, before rxvt-unicode
313	does focus in processing.	472	does focus in processing.
314		473
315	=item on_focus_out $term	474	=item on_focus_out $term
316		475
317	Called wheneever the window loses keyboard focus, before rxvt-unicode does	476	Called wheneever the window loses keyboard focus, before rxvt-unicode does
318	focus out processing.	477	focus out processing.
		478
		479	=item on_configure_notify $term, $event
		480
		481	=item on_property_notify $term, $event
319		482
320	=item on_key_press $term, $event, $keysym, $octets	483	=item on_key_press $term, $event, $keysym, $octets
321		484
322	=item on_key_release $term, $event, $keysym	485	=item on_key_release $term, $event, $keysym
323		486
…		…
341	C<on_key_press> additionally receives the string rxvt-unicode would	504	C<on_key_press> additionally receives the string rxvt-unicode would
342	output, if any, in locale-specific encoding.	505	output, if any, in locale-specific encoding.
343		506
344	subwindow.	507	subwindow.
345		508
346	=back	509	=item on_client_message $term, $event
347		510
348	=head2 Variables in the C<urxvt> Package	511	=item on_wm_protocols $term, $event
349		512
350	=over 4	513	=item on_wm_delete_window $term, $event
351		514
352	=item $urxvt::LIBDIR	515	Called when various types of ClientMessage events are received (all with
353		516	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
354	The rxvt-unicode library directory, where, among other things, the perl
355	modules and scripts are stored.
356
357	=item $urxvt::RESCLASS, $urxvt::RESCLASS
358
359	The resource class and name rxvt-unicode uses to look up X resources.
360
361	=item $urxvt::RXVTNAME
362
363	The basename of the installed binaries, usually C<urxvt>.
364
365	=item $urxvt::TERM
366
367	The current terminal. This variable stores the current C<urxvt::term>
368	object, whenever a callback/hook is executing.
369
370	=item
371
372	=back
373
374	=head2 Functions in the C<urxvt> Package
375
376	=over 4
377
378	=item $term = new urxvt [arg...]
379
380	Creates a new terminal, very similar as if you had started it with
381	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
382	if the new instance couldn't be created. Returns C<undef> if the new
383	instance didn't initialise perl, and the terminal object otherwise. The
384	C<init> and C<start> hooks will be called during the call.
385
386	=item urxvt::fatal $errormessage
387
388	Fatally aborts execution with the given error message. Avoid at all
389	costs! The only time this is acceptable is when the terminal process
390	starts up.
391
392	=item urxvt::warn $string
393
394	Calls C<rxvt_warn> with the given string which should not include a
395	newline. The module also overwrites the C<warn> builtin with a function
396	that calls this function.
397
398	Using this function has the advantage that its output ends up in the
399	correct place, e.g. on stderr of the connecting urxvtc client.
400
401	=item $is_safe = urxvt::safe
402
403	Returns true when it is safe to do potentially unsafe things, such as
404	evaluating perl code specified by the user. This is true when urxvt was
405	started setuid or setgid.
406
407	=item $time = urxvt::NOW
408
409	Returns the "current time" (as per the event loop).
410
411	=item urxvt::CurrentTime
412
413	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
414	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
415	Button4Mask, Button5Mask, AnyModifier
416
417	Various constants for use in X calls and event processing.
418
419	=back
420
421	=head2 RENDITION
422
423	Rendition bitsets contain information about colour, font, font styles and
424	similar information for each screen cell.
425
426	The following "macros" deal with changes in rendition sets. You should
427	never just create a bitset, you should always modify an existing one,
428	as they contain important information required for correct operation of
429	rxvt-unicode.
430
431	=over 4
432
433	=item $rend = urxvt::DEFAULT_RSTYLE
434
435	Returns the default rendition, as used when the terminal is starting up or
436	being reset. Useful as a base to start when creating renditions.
437
438	=item $rend = urxvt::OVERLAY_RSTYLE
439
440	Return the rendition mask used for overlays by default.
441
442	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
443
444	Return the bit that enabled bold, italic, blink, reverse-video and
445	underline, respectively. To enable such a style, just logically OR it into
446	the bitset.
447
448	=item $foreground = urxvt::GET_BASEFG $rend
449
450	=item $background = urxvt::GET_BASEBG $rend
451
452	Return the foreground/background colour index, respectively.
453
454	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
455
456	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
457
458	Replace the foreground/background colour in the rendition mask with the
459	specified one.
460
461	=item $value = urxvt::GET_CUSTOM $rend
462
463	Return the "custom" value: Every rendition has 5 bits for use by
464	extensions. They can be set and changed as you like and are initially
465	zero.
466
467	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
468
469	Change the custom value.
470		517
471	=back	518	=back
472		519
473	=cut	520	=cut
474		521
…		…
480	use Scalar::Util ();	527	use Scalar::Util ();
481	use List::Util ();	528	use List::Util ();
482		529
483	our $VERSION = 1;	530	our $VERSION = 1;
484	our $TERM;	531	our $TERM;
		532	our @TERM_INIT;
		533	our @TERM_EXT;
485	our @HOOKNAME;	534	our @HOOKNAME;
486	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	535	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
487	our %OPTION;	536	our %OPTION;
488		537
489	our $LIBDIR;	538	our $LIBDIR;
490	our $RESNAME;	539	our $RESNAME;
491	our $RESCLASS;	540	our $RESCLASS;
492	our $RXVTNAME;	541	our $RXVTNAME;
493		542
		543	=head2 Variables in the C<urxvt> Package
		544
		545	=over 4
		546
		547	=item $urxvt::LIBDIR
		548
		549	The rxvt-unicode library directory, where, among other things, the perl
		550	modules and scripts are stored.
		551
		552	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		553
		554	The resource class and name rxvt-unicode uses to look up X resources.
		555
		556	=item $urxvt::RXVTNAME
		557
		558	The basename of the installed binaries, usually C<urxvt>.
		559
		560	=item $urxvt::TERM
		561
		562	The current terminal. This variable stores the current C<urxvt::term>
		563	object, whenever a callback/hook is executing.
		564
		565	=item @urxvt::TERM_INIT
		566
		567	All coderefs in this array will be called as methods of the next newly
		568	created C<urxvt::term> object (during the C<on_init> phase). The array
		569	gets cleared before the codereferences that were in it are being executed,
		570	so coderefs can push themselves onto it again if they so desire.
		571
		572	This complements to the perl-eval commandline option, but gets executed
		573	first.
		574
		575	=item @urxvt::TERM_EXT
		576
		577	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		578	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		579	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		580
		581	=back
		582
		583	=head2 Functions in the C<urxvt> Package
		584
		585	=over 4
		586
		587	=item urxvt::fatal $errormessage
		588
		589	Fatally aborts execution with the given error message. Avoid at all
		590	costs! The only time this is acceptable is when the terminal process
		591	starts up.
		592
		593	=item urxvt::warn $string
		594
		595	Calls C<rxvt_warn> with the given string which should not include a
		596	newline. The module also overwrites the C<warn> builtin with a function
		597	that calls this function.
		598
		599	Using this function has the advantage that its output ends up in the
		600	correct place, e.g. on stderr of the connecting urxvtc client.
		601
		602	Messages have a size limit of 1023 bytes currently.
		603
		604	=item $time = urxvt::NOW
		605
		606	Returns the "current time" (as per the event loop).
		607
		608	=item urxvt::CurrentTime
		609
		610	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		611	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		612	Button4Mask, Button5Mask, AnyModifier
		613
		614	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		615	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		616	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		617	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		618	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		619	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		620	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		621
		622	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		623	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		624	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		625	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		626	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		627	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		628	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		629
		630	Various constants for use in X calls and event processing.
		631
		632	=back
		633
		634	=head2 RENDITION
		635
		636	Rendition bitsets contain information about colour, font, font styles and
		637	similar information for each screen cell.
		638
		639	The following "macros" deal with changes in rendition sets. You should
		640	never just create a bitset, you should always modify an existing one,
		641	as they contain important information required for correct operation of
		642	rxvt-unicode.
		643
		644	=over 4
		645
		646	=item $rend = urxvt::DEFAULT_RSTYLE
		647
		648	Returns the default rendition, as used when the terminal is starting up or
		649	being reset. Useful as a base to start when creating renditions.
		650
		651	=item $rend = urxvt::OVERLAY_RSTYLE
		652
		653	Return the rendition mask used for overlays by default.
		654
		655	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		656
		657	Return the bit that enabled bold, italic, blink, reverse-video and
		658	underline, respectively. To enable such a style, just logically OR it into
		659	the bitset.
		660
		661	=item $foreground = urxvt::GET_BASEFG $rend
		662
		663	=item $background = urxvt::GET_BASEBG $rend
		664
		665	Return the foreground/background colour index, respectively.
		666
		667	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		668
		669	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		670
		671	Replace the foreground/background colour in the rendition mask with the
		672	specified one.
		673
		674	=item $value = urxvt::GET_CUSTOM $rend
		675
		676	Return the "custom" value: Every rendition has 5 bits for use by
		677	extensions. They can be set and changed as you like and are initially
		678	zero.
		679
		680	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		681
		682	Change the custom value.
		683
		684	=back
		685
		686	=cut
		687
494	BEGIN {	688	BEGIN {
495	urxvt->bootstrap;
496
497	# overwrite perl's warn	689	# overwrite perl's warn
498	*CORE::GLOBAL::warn = sub {	690	*CORE::GLOBAL::warn = sub {
499	my $msg = join "", @_;	691	my $msg = join "", @_;
500	$msg .= "\n"	692	$msg .= "\n"
501	unless $msg =~ /\n$/;	693	unless $msg =~ /\n$/;
502	urxvt::warn ($msg);	694	urxvt::warn ($msg);
503	};	695	};
504
505	delete $ENV{IFS};
506	delete $ENV{CDPATH};
507	delete $ENV{BASH_ENV};
508	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
509	}	696	}
510		697
511	my @hook_count;
512	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	698	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
513		699
514	sub verbose {	700	sub verbose {
515	my ($level, $msg) = @_;	701	my ($level, $msg) = @_;
516	warn "$msg\n" if $level <= $verbosity;	702	warn "$msg\n" if $level <= $verbosity;
517	}	703	}
518		704
519	my $extension_pkg = "extension0000";
520	my %extension_pkg;	705	my %extension_pkg;
521		706
522	# load a single script into its own package, once only	707	# load a single script into its own package, once only
523	sub extension_package($) {	708	sub extension_package($) {
524	my ($path) = @_;	709	my ($path) = @_;
525		710
526	$extension_pkg{$path} \|\|= do {	711	$extension_pkg{$path} \|\|= do {
527	my $pkg = "urxvt::" . ($extension_pkg++);	712	$path =~ /([^\/\\]+)$/;
		713	my $pkg = $1;
		714	$pkg =~ s/[^[:word:]]/_/g;
		715	$pkg = "urxvt::ext::$pkg";
528		716
529	verbose 3, "loading extension '$path' into package '$pkg'";	717	verbose 3, "loading extension '$path' into package '$pkg'";
530		718
531	open my $fh, "<:raw", $path	719	open my $fh, "<:raw", $path
532	or die "$path: $!";	720	or die "$path: $!";
533		721
534	my $source = untaint	722	my $source =
535	"package $pkg; use strict; use utf8;\n"	723	"package $pkg; use strict; use utf8;\n"
536	. "use base urxvt::term::extension::;\n"
537	. "#line 1 \"$path\"\n{\n"	724	. "#line 1 \"$path\"\n{\n"
538	. (do { local $/; <$fh> })	725	. (do { local $/; <$fh> })
539	. "\n};\n1";	726	. "\n};\n1";
540		727
541	eval $source	728	eval $source
…		…
555	if ($htype == 0) { # INIT	742	if ($htype == 0) { # INIT
556	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	743	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
557		744
558	my %ext_arg;	745	my %ext_arg;
559		746
		747	{
		748	my @init = @TERM_INIT;
		749	@TERM_INIT = ();
		750	$_->($TERM) for @init;
		751	my @pkg = @TERM_EXT;
		752	@TERM_EXT = ();
		753	$TERM->register_package ($_) for @pkg;
		754	}
		755
560	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	756	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
561	if ($_ eq "default") {	757	if ($_ eq "default") {
562	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	758	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
563	} elsif (/^-(.*)$/) {	759	} elsif (/^-(.*)$/) {
564	delete $ext_arg{$1};	760	delete $ext_arg{$1};
565	} elsif (/^([^<]+)<(.*)>$/) {	761	} elsif (/^([^<]+)<(.*)>$/) {
…		…
590	if $verbosity >= 10;	786	if $verbosity >= 10;
591		787
592	keys %$cb;	788	keys %$cb;
593		789
594	while (my ($pkg, $cb) = each %$cb) {	790	while (my ($pkg, $cb) = each %$cb) {
595	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	791	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
596	and last;	792	$retval \|\|= $retval_;
597		793
598	if ($@) {	794	if ($@) {
599	$TERM->ungrab; # better to lose the grab than the session	795	$TERM->ungrab; # better to lose the grab than the session
600	warn $@;	796	warn $@;
601	}	797	}
602	}	798	}
		799
		800	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		801	if $verbosity >= 11;
603	}	802	}
604		803
605	if ($htype == 1) { # DESTROY	804	if ($htype == 1) { # DESTROY
606	if (my $hook = delete $TERM->{_hook}) {
607	for my $htype (0..$#$hook) {
608	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
609	or set_should_invoke $htype, 0;
610	}
611	}
612
613	# clear package objects	805	# clear package objects
614	%$_ = () for values %{ $TERM->{_pkg} };	806	%$_ = () for values %{ $TERM->{_pkg} };
615		807
616	# clear package	808	# clear package
617	%$TERM = ();	809	%$TERM = ();
…		…
631	while (my ($name, $cb) = each %hook) {	823	while (my ($name, $cb) = each %hook) {
632	my $htype = $HOOKTYPE{uc $name};	824	my $htype = $HOOKTYPE{uc $name};
633	defined $htype	825	defined $htype
634	or Carp::croak "unsupported hook type '$name'";	826	or Carp::croak "unsupported hook type '$name'";
635		827
		828	$self->set_should_invoke ($htype, +1)
636	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	829	unless exists $self->{term}{_hook}[$htype]{$pkg};
637	$hook_count[$htype]++
638	or urxvt::set_should_invoke $htype, 1;
639	}
640		830
641	$self->{term}{_hook}[$htype]{$pkg} = $cb;	831	$self->{term}{_hook}[$htype]{$pkg} = $cb;
642	}	832	}
643	}	833	}
644		834
…		…
649	for my $name (@hook) {	839	for my $name (@hook) {
650	my $htype = $HOOKTYPE{uc $name};	840	my $htype = $HOOKTYPE{uc $name};
651	defined $htype	841	defined $htype
652	or Carp::croak "unsupported hook type '$name'";	842	or Carp::croak "unsupported hook type '$name'";
653		843
		844	$self->set_should_invoke ($htype, -1)
654	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	845	if delete $self->{term}{_hook}[$htype]{$pkg};
655	--$hook_count[$htype]
656	or urxvt::set_should_invoke $htype, 0;
657	}
658	}	846	}
659	}	847	}
660		848
661	our $AUTOLOAD;	849	our $AUTOLOAD;
662		850
…		…
768	# find on_xxx subs in the package and register them	956	# find on_xxx subs in the package and register them
769	# as hooks	957	# as hooks
770	sub register_package {	958	sub register_package {
771	my ($self, $pkg, $argv) = @_;	959	my ($self, $pkg, $argv) = @_;
772		960
		961	no strict 'refs';
		962
		963	urxvt::verbose 6, "register package $pkg to $self";
		964
		965	@{"$pkg\::ISA"} = urxvt::term::extension::;
		966
773	my $proxy = bless {	967	my $proxy = bless {
774	_pkg => $pkg,	968	_pkg => $pkg,
775	argv => $argv,	969	argv => $argv,
776	}, $pkg;	970	}, $pkg;
777	Scalar::Util::weaken ($proxy->{term} = $self);	971	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
783	$proxy->enable ($name => $ref);	977	$proxy->enable ($name => $ref);
784	}	978	}
785	}	979	}
786	}	980	}
787		981
		982	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		983
		984	Creates a new terminal, very similar as if you had started it with system
		985	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		986	hash which defines the environment of the new terminal.
		987
		988	Croaks (and probably outputs an error message) if the new instance
		989	couldn't be created. Returns C<undef> if the new instance didn't
		990	initialise perl, and the terminal object otherwise. The C<init> and
		991	C<start> hooks will be called during this call.
		992
		993	=cut
		994
		995	sub new {
		996	my ($class, $env, @args) = @_;
		997
		998	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		999	}
		1000
788	=item $term->destroy	1001	=item $term->destroy
789		1002
790	Destroy the terminal object (close the window, free resources	1003	Destroy the terminal object (close the window, free resources
791	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1004	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
792	watchers (timers, io watchers) are still active.	1005	watchers (timers, io watchers) are still active.
793		1006
		1007	=item $term->exec_async ($cmd[, @args])
		1008
		1009	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1010	("starts") programs in the background. This function takes care of setting
		1011	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1012	be preferred over explicit calls to C<exec> or C<system>.
		1013
		1014	Returns the pid of the subprocess or C<undef> on error.
		1015
		1016	=cut
		1017
		1018	sub exec_async {
		1019	my $self = shift;
		1020
		1021	my $pid = fork;
		1022
		1023	return $pid
		1024	if !defined $pid or $pid;
		1025
		1026	%ENV = %{ $self->env };
		1027
		1028	exec @_;
		1029	urxvt::_exit 255;
		1030	}
		1031
794	=item $isset = $term->option ($optval[, $set])	1032	=item $isset = $term->option ($optval[, $set])
795		1033
796	Returns true if the option specified by C<$optval> is enabled, and	1034	Returns true if the option specified by C<$optval> is enabled, and
797	optionally change it. All option values are stored by name in the hash	1035	optionally change it. All option values are stored by name in the hash
798	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1036	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
800	Here is a a likely non-exhaustive list of option names, please see the	1038	Here is a a likely non-exhaustive list of option names, please see the
801	source file F</src/optinc.h> to see the actual list:	1039	source file F</src/optinc.h> to see the actual list:
802		1040
803	borderLess console cursorBlink cursorUnderline hold iconic insecure	1041	borderLess console cursorBlink cursorUnderline hold iconic insecure
804	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1042	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
805	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1043	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
806	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1044	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
807	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1045	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
808	tripleclickwords utmpInhibit visualBell	1046	transparent tripleclickwords utmpInhibit visualBell
809		1047
810	=item $value = $term->resource ($name[, $newval])	1048	=item $value = $term->resource ($name[, $newval])
811		1049
812	Returns the current resource value associated with a given name and	1050	Returns the current resource value associated with a given name and
813	optionally sets a new value. Setting values is most useful in the C<init>	1051	optionally sets a new value. Setting values is most useful in the C<init>
…		…
830		1068
831	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1069	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
832	borderLess color cursorBlink cursorUnderline cutchars delete_key	1070	borderLess color cursorBlink cursorUnderline cutchars delete_key
833	display_name embed ext_bwidth fade font geometry hold iconName	1071	display_name embed ext_bwidth fade font geometry hold iconName
834	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1072	imFont imLocale inputMethod insecure int_bwidth intensityStyles
835	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1073	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
836	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1074	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
837	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1075	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
838	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1076	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
839	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1077	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
840	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1078	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
841	shade term_name title transparent transparent_all tripleclickwords	1079	secondaryScreen secondaryScroll selectstyle shade term_name title
842	utmpInhibit visualBell	1080	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1081	visualBell
843		1082
844	=cut	1083	=cut
845		1084
846	sub resource($$;$) {	1085	sub resource($$;$) {
847	my ($self, $name) = (shift, shift);	1086	my ($self, $name) = (shift, shift);
848	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1087	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
849	&urxvt::term::_resource	1088	&urxvt::term::_resource
850	}	1089	}
851		1090
		1091	=item $value = $term->x_resource ($pattern)
		1092
		1093	Returns the X-Resource for the given pattern, excluding the program or
		1094	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1095	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1096	resource with that pattern exists.
		1097
		1098	This method should only be called during the C<on_start> hook, as there is
		1099	only one resource database per display, and later invocations might return
		1100	the wrong resources.
		1101
852	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1102	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
853		1103
854	Adds a keymap translation exactly as specified via a resource. See the	1104	Adds a keymap translation exactly as specified via a resource. See the
855	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1105	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
856		1106
…		…
871	=item ($row, $col) = $term->selection_end ([$row, $col])	1121	=item ($row, $col) = $term->selection_end ([$row, $col])
872		1122
873	Return the current values of the selection mark, begin or end positions,	1123	Return the current values of the selection mark, begin or end positions,
874	and optionally set them to new values.	1124	and optionally set them to new values.
875		1125
		1126	=item $term->selection_make ($eventtime[, $rectangular])
		1127
		1128	Tries to make a selection as set by C<selection_beg> and
		1129	C<selection_end>. If C<$rectangular> is true (default: false), a
		1130	rectangular selection will be made. This is the prefered function to make
		1131	a selection.
		1132
876	=item $success = $term->selection_grab ($eventtime)	1133	=item $success = $term->selection_grab ($eventtime)
877		1134
878	Try to request the primary selection from the server (for example, as set	1135	Try to request the primary selection text from the server (for example, as
879	by the next method).	1136	set by the next method). No visual feedback will be given. This function
		1137	is mostly useful from within C<on_sel_grab> hooks.
880		1138
881	=item $oldtext = $term->selection ([$newtext])	1139	=item $oldtext = $term->selection ([$newtext])
882		1140
883	Return the current selection text and optionally replace it by C<$newtext>.	1141	Return the current selection text and optionally replace it by C<$newtext>.
884		1142
…		…
977	Convert the given locale-encoded octets into a perl string.	1235	Convert the given locale-encoded octets into a perl string.
978		1236
979	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1237	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
980		1238
981	XORs the rendition values in the given span with the provided value	1239	XORs the rendition values in the given span with the provided value
982	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1240	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
983	to the selection.	1241	refresh hooks to provide effects similar to the selection.
984		1242
985	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1243	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
986		1244
987	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1245	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
988	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1246	whitespace will additionally be xored with the C<$rstyle2>, which defaults
989	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines	1247	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
990	it instead.	1248	it instead. Both styles I<MUST NOT> contain font styles.
991		1249
992	=item $term->scr_bell	1250	=item $term->scr_bell
993		1251
994	Ring the bell!	1252	Ring the bell!
995		1253
…		…
1029		1287
1030	=item $windowid = $term->vt	1288	=item $windowid = $term->vt
1031		1289
1032	Return the window id of the terminal window.	1290	Return the window id of the terminal window.
1033		1291
		1292	=item $term->vt_emask_add ($x_event_mask)
		1293
		1294	Adds the specified events to the vt event mask. Useful e.g. when you want
		1295	to receive pointer events all the times:
		1296
		1297	$term->vt_emask_add (urxvt::PointerMotionMask);
		1298
1034	=item $window_width = $term->width	1299	=item $window_width = $term->width
1035		1300
1036	=item $window_height = $term->height	1301	=item $window_height = $term->height
1037		1302
1038	=item $font_width = $term->fwidth	1303	=item $font_width = $term->fwidth
…		…
1051		1316
1052	=item $max_scrollback = $term->saveLines	1317	=item $max_scrollback = $term->saveLines
1053		1318
1054	=item $nrow_plus_saveLines = $term->total_rows	1319	=item $nrow_plus_saveLines = $term->total_rows
1055		1320
1056	=item $lines_in_scrollback = $term->nsaved	1321	=item $topmost_scrollback_row = $term->top_row
1057		1322
1058	Return various integers describing terminal characteristics.	1323	Return various integers describing terminal characteristics.
1059		1324
		1325	=item $x_display = $term->display_id
		1326
		1327	Return the DISPLAY used by rxvt-unicode.
		1328
1060	=item $lc_ctype = $term->locale	1329	=item $lc_ctype = $term->locale
1061		1330
1062	Returns the LC_CTYPE category string used by this rxvt-unicode.	1331	Returns the LC_CTYPE category string used by this rxvt-unicode.
1063		1332
1064	=item $x_display = $term->display_id	1333	=item $env = $term->env
1065		1334
1066	Return the DISPLAY used by rxvt-unicode.	1335	Returns a copy of the environment in effect for the terminal as a hashref
		1336	similar to C<\%ENV>.
		1337
		1338	=cut
		1339
		1340	sub env {
		1341	if (my $env = $_[0]->_env) {
		1342	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1343	} else {
		1344	+{ %ENV }
		1345	}
		1346	}
1067		1347
1068	=item $modifiermask = $term->ModLevel3Mask	1348	=item $modifiermask = $term->ModLevel3Mask
1069		1349
1070	=item $modifiermask = $term->ModMetaMask	1350	=item $modifiermask = $term->ModMetaMask
1071		1351
…		…
1074	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1354	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1075	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1355	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1076		1356
1077	=item $view_start = $term->view_start ([$newvalue])	1357	=item $view_start = $term->view_start ([$newvalue])
1078		1358
1079	Returns the negative row number of the topmost line. Minimum value is	1359	Returns the row number of the topmost displayed line. Maximum value is
1080	C<0>, which displays the normal terminal contents. Larger values scroll	1360	C<0>, which displays the normal terminal contents. Lower values scroll
1081	this many lines into the scrollback buffer.	1361	this many lines into the scrollback buffer.
1082		1362
1083	=item $term->want_refresh	1363	=item $term->want_refresh
1084		1364
1085	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1365	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1164	Return the row number of the first/last row of the line, respectively.	1444	Return the row number of the first/last row of the line, respectively.
1165		1445
1166	=item $offset = $line->offset_of ($row, $col)	1446	=item $offset = $line->offset_of ($row, $col)
1167		1447
1168	Returns the character offset of the given row\|col pair within the logical	1448	Returns the character offset of the given row\|col pair within the logical
1169	line.	1449	line. Works for rows outside the line, too, and returns corresponding
		1450	offsets outside the string.
1170		1451
1171	=item ($row, $col) = $line->coord_of ($offset)	1452	=item ($row, $col) = $line->coord_of ($offset)
1172		1453
1173	Translates a string offset into terminal coordinates again.	1454	Translates a string offset into terminal coordinates again.
1174		1455
…		…
1287		1568
1288	Calls XUngrab for the most recent grab. Is called automatically on	1569	Calls XUngrab for the most recent grab. Is called automatically on
1289	evaluation errors, as it is better to lose the grab in the error case as	1570	evaluation errors, as it is better to lose the grab in the error case as
1290	the session.	1571	the session.
1291		1572
		1573	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1574
		1575	=item $atom_name = $term->XGetAtomName ($atom)
		1576
		1577	=item @atoms = $term->XListProperties ($window)
		1578
		1579	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1580
		1581	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1582
		1583	=item $term->XDeleteProperty ($window, $property)
		1584
		1585	=item $window = $term->DefaultRootWindow
		1586
		1587	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1588
		1589	=item $term->XMapWindow ($window)
		1590
		1591	=item $term->XUnmapWindow ($window)
		1592
		1593	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1594
		1595	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1596
		1597	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1598
		1599	Various X or X-related functions. The C<$term> object only serves as
		1600	the source of the display, otherwise those functions map more-or-less
		1601	directory onto the X functions of the same name.
		1602
1292	=back	1603	=back
1293		1604
1294	=cut	1605	=cut
1295		1606
1296	package urxvt::popup;	1607	package urxvt::popup;
…		…
1310		1621
1311	$item->{render} \|\|= sub { $_[0]{text} };	1622	$item->{render} \|\|= sub { $_[0]{text} };
1312		1623
1313	push @{ $self->{item} }, $item;	1624	push @{ $self->{item} }, $item;
1314	}	1625	}
		1626
		1627	=item $popup->add_title ($title)
		1628
		1629	Adds a non-clickable title to the popup.
		1630
		1631	=cut
		1632
		1633	sub add_title {
		1634	my ($self, $title) = @_;
		1635
		1636	$self->add_item ({
		1637	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1638	text => $title,
		1639	activate => sub { },
		1640	});
		1641	}
		1642
		1643	=item $popup->add_separator ([$sepchr])
		1644
		1645	Creates a separator, optionally using the character given as C<$sepchr>.
		1646
		1647	=cut
1315		1648
1316	sub add_separator {	1649	sub add_separator {
1317	my ($self, $sep) = @_;	1650	my ($self, $sep) = @_;
1318		1651
1319	$sep \|\|= "=";	1652	$sep \|\|= "=";
…		…
1324	render => sub { $sep x $self->{term}->ncol },	1657	render => sub { $sep x $self->{term}->ncol },
1325	activate => sub { },	1658	activate => sub { },
1326	});	1659	});
1327	}	1660	}
1328		1661
1329	sub add_title {	1662	=item $popup->add_button ($text, $cb)
1330	my ($self, $title) = @_;
1331		1663
1332	$self->add_item ({	1664	Adds a clickable button to the popup. C<$cb> is called whenever it is
1333	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1665	selected.
1334	text => $title,	1666
1335	activate => sub { },	1667	=cut
1336	});
1337	}
1338		1668
1339	sub add_button {	1669	sub add_button {
1340	my ($self, $text, $cb) = @_;	1670	my ($self, $text, $cb) = @_;
1341		1671
1342	$self->add_item ({ type => "button", text => $text, activate => $cb});	1672	$self->add_item ({ type => "button", text => $text, activate => $cb});
1343	}	1673	}
		1674
		1675	=item $popup->add_toggle ($text, $cb, $initial_value)
		1676
		1677	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1678	whenever it gets toggled, with a boolean indicating its value as its first
		1679	argument.
		1680
		1681	=cut
1344		1682
1345	sub add_toggle {	1683	sub add_toggle {
1346	my ($self, $text, $cb, $value) = @_;	1684	my ($self, $text, $cb, $value) = @_;
1347		1685
1348	my $item; $item = {	1686	my $item; $item = {
1349	type => "button",	1687	type => "button",
1350	text => " $text",	1688	text => " $text",
1351	value => $value,	1689	value => $value,
1352	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1690	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1353	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1691	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1354	};	1692	};
1355		1693
1356	$self->add_item ($item);	1694	$self->add_item ($item);
1357	}	1695	}
		1696
		1697	=item $popup->show
		1698
		1699	Displays the popup (which is initially hidden).
		1700
		1701	=cut
1358		1702
1359	sub show {	1703	sub show {
1360	my ($self) = @_;	1704	my ($self) = @_;
1361		1705
1362	local $urxvt::popup::self = $self;	1706	local $urxvt::popup::self = $self;
1363		1707
		1708	my $env = $self->{term}->env;
		1709	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1710	delete $env->{LC_ALL};
1364	local $ENV{LC_ALL} = $self->{term}->locale;	1711	$env->{LC_CTYPE} = $self->{term}->locale;
1365		1712
1366	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1713	urxvt::term->new ($env, "popup",
		1714	"--perl-lib" => "", "--perl-ext-common" => "",
		1715	"-pty-fd" => -1, "-sl" => 0,
		1716	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1367	"--transient-for" => $self->{term}->parent,	1717	"--transient-for" => $self->{term}->parent,
1368	"-display" => $self->{term}->display_id,	1718	"-display" => $self->{term}->display_id,
1369	"-pe" => "urxvt-popup")	1719	"-pe" => "urxvt-popup")
1370	or die "unable to create popup window\n";	1720	or die "unable to create popup window\n";
1371	}	1721	}
1372		1722
1373	sub DESTROY {	1723	sub DESTROY {
1374	my ($self) = @_;	1724	my ($self) = @_;
1375		1725
1376	delete $self->{term}{_destroy}{$self};	1726	delete $self->{term}{_destroy}{$self};
1377	$self->{term}->ungrab;	1727	$self->{term}->ungrab;
1378	}	1728	}
		1729
		1730	=back
		1731
		1732	=cut
		1733
		1734	package urxvt::watcher;
		1735
		1736	@urxvt::timer::ISA = __PACKAGE__;
		1737	@urxvt::iow::ISA = __PACKAGE__;
		1738	@urxvt::pw::ISA = __PACKAGE__;
		1739	@urxvt::iw::ISA = __PACKAGE__;
1379		1740
1380	=head2 The C<urxvt::timer> Class	1741	=head2 The C<urxvt::timer> Class
1381		1742
1382	This class implements timer watchers/events. Time is represented as a	1743	This class implements timer watchers/events. Time is represented as a
1383	fractional number of seconds since the epoch. Example:	1744	fractional number of seconds since the epoch. Example:
…		…
1421	Start the timer.	1782	Start the timer.
1422		1783
1423	=item $timer = $timer->start ($tstamp)	1784	=item $timer = $timer->start ($tstamp)
1424		1785
1425	Set the event trigger time to C<$tstamp> and start the timer.	1786	Set the event trigger time to C<$tstamp> and start the timer.
		1787
		1788	=item $timer = $timer->after ($delay)
		1789
		1790	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1426		1791
1427	=item $timer = $timer->stop	1792	=item $timer = $timer->stop
1428		1793
1429	Stop the timer.	1794	Stop the timer.
1430		1795
…		…
1477		1842
1478	Stop watching for events on the given filehandle.	1843	Stop watching for events on the given filehandle.
1479		1844
1480	=back	1845	=back
1481		1846
		1847	=head2 The C<urxvt::iw> Class
		1848
		1849	This class implements idle watchers, that get called automatically when
		1850	the process is idle. They should return as fast as possible, after doing
		1851	some useful work.
		1852
		1853	=over 4
		1854
		1855	=item $iw = new urxvt::iw
		1856
		1857	Create a new idle watcher object in stopped state.
		1858
		1859	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1860
		1861	Set the callback to be called when the watcher triggers.
		1862
		1863	=item $timer = $timer->start
		1864
		1865	Start the watcher.
		1866
		1867	=item $timer = $timer->stop
		1868
		1869	Stop the watcher.
		1870
		1871	=back
		1872
		1873	=head2 The C<urxvt::pw> Class
		1874
		1875	This class implements process watchers. They create an event whenever a
		1876	process exits, after which they stop automatically.
		1877
		1878	my $pid = fork;
		1879	...
		1880	$term->{pw} = urxvt::pw
		1881	->new
		1882	->start ($pid)
		1883	->cb (sub {
		1884	my ($pw, $exit_status) = @_;
		1885	...
		1886	});
		1887
		1888	=over 4
		1889
		1890	=item $pw = new urxvt::pw
		1891
		1892	Create a new process watcher in stopped state.
		1893
		1894	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1895
		1896	Set the callback to be called when the timer triggers.
		1897
		1898	=item $pw = $timer->start ($pid)
		1899
		1900	Tells the wqtcher to start watching for process C<$pid>.
		1901
		1902	=item $pw = $pw->stop
		1903
		1904	Stop the watcher.
		1905
		1906	=back
		1907
1482	=head1 ENVIRONMENT	1908	=head1 ENVIRONMENT
1483		1909
1484	=head2 URXVT_PERL_VERBOSITY	1910	=head2 URXVT_PERL_VERBOSITY
1485		1911
1486	This variable controls the verbosity level of the perl extension. Higher	1912	This variable controls the verbosity level of the perl extension. Higher
…		…
1490		1916
1491	=item == 0 - fatal messages	1917	=item == 0 - fatal messages
1492		1918
1493	=item >= 3 - script loading and management	1919	=item >= 3 - script loading and management
1494		1920
1495	=item >=10 - all events received	1921	=item >=10 - all called hooks
		1922
		1923	=item >=11 - hook reutrn values
1496		1924
1497	=back	1925	=back
1498		1926
1499	=head1 AUTHOR	1927	=head1 AUTHOR
1500		1928

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.75 by root, Tue Jan 10 05:00:13 2006 UTC vs. Revision 1.119 by root, Fri Jan 20 18:59:31 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.75 by root, Tue Jan 10 05:00:13 2006 UTC vs.
Revision 1.119 by root, Fri Jan 20 18:59:31 2006 UTC