[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.114 by root, Fri Jan 20 12:16:28 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.
82		166
83	=item mark-urls	167	=item mark-urls
84		168
85	Uses per-line display filtering (C<on_line_update>) to underline urls.	169	Uses per-line display filtering (C<on_line_update>) to underline urls and
		170	make them clickable. When middle-clicked, the program specified in the
		171	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		172	the URL as first argument.
		173
		174	=item automove-background
		175
		176	This is basically a one-line extension that dynamically changes the background pixmap offset
		177	to the window position, in effect creating the same effect as pseudo transparency with
		178	a custom pixmap. No scaling is supported in this mode. Exmaple:
		179
		180	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
86		181
87	=item block-graphics-to-ascii	182	=item block-graphics-to-ascii
88		183
89	A not very useful example of filtering all text output to the terminal,	184	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	185	by replacing all line-drawing characters (U+2500 .. U+259F) by a
91	similar-looking ascii character.	186	similar-looking ascii character.
92		187
		188	=item digital-clock
		189
		190	Displays a digital clock using the built-in overlay.
		191
93	=item example-refresh-hooks	192	=item example-refresh-hooks
94		193
95	Displays a very simple digital clock in the upper right corner of the	194	Displays a very simple digital clock in the upper right corner of the
96	window. Illustrates overwriting the refresh callbacks to create your own	195	window. Illustrates overwriting the refresh callbacks to create your own
97	overlays or changes.	196	overlays or changes.
98		197
		198	=item selection-pastebin
		199
		200	This is a little rarely useful extension that Uploads the selection as
		201	textfile to a remote site (or does other things). (The implementation is
		202	not currently secure for use in a multiuser environment as it writes to
		203	F</tmp> directly.).
		204
		205	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		206	i.e.
		207
		208	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		209
		210	Pressing this combination runs a command with C<%> replaced by the name of
		211	the textfile. This command can be set via a resource:
		212
		213	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		214
		215	And the default is likely not useful to anybody but the few people around
		216	here :)
		217
		218	The name of the textfile is the hex encoded md5 sum of the selection, so
		219	the same content should lead to the same filename.
		220
		221	After a successful upload the selection will be replaced by the text given
		222	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		223	for the filename):
		224
		225	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		226
99	=back	227	=back
		228
		229	=head1 API DOCUMENTATION
100		230
101	=head2 General API Considerations	231	=head2 General API Considerations
102		232
103	All objects (such as terminals, time watchers etc.) are typical	233	All objects (such as terminals, time watchers etc.) are typical
104	reference-to-hash objects. The hash can be used to store anything you	234	reference-to-hash objects. The hash can be used to store anything you
…		…
117	=over 4	247	=over 4
118		248
119	=item $text	249	=item $text
120		250
121	Rxvt-unicodes special way of encoding text, where one "unicode" character	251	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.	252	always represents one screen cell. See L<ROW_t> for a discussion of this format.
123		253
124	=item $string	254	=item $string
125		255
126	A perl text string, with an emphasis on I<text>. It can store all unicode	256	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	257	characters and is to be distinguished with text encoded in a specific
…		…
173	called whenever the relevant event happens.	303	called whenever the relevant event happens.
174		304
175	The first argument passed to them is an extension oject as described in	305	The first argument passed to them is an extension oject as described in
176	the in the C<Extension Objects> section.	306	the in the C<Extension Objects> section.
177		307
178	B<All> of these hooks must return a boolean value. If it is true, then the	308	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	309	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.	310	relevant action might not be carried out by the C++ code.
181		311
182	I<< When in doubt, return a false value (preferably C<()>). >>	312	I<< When in doubt, return a false value (preferably C<()>). >>
183		313
184	=over 4	314	=over 4
185		315
186	=item on_init $term	316	=item on_init $term
187		317
188	Called after a new terminal object has been initialized, but before	318	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	319	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	320	call or deliver senseless data, as terminal size and other characteristics
191	have not yet been determined. You can safely query and change resources,	321	have not yet been determined. You can safely query and change resources
192	though.	322	and options, though. For many purposes the C<on_start> hook is a better
		323	place.
		324
		325	=item on_start $term
		326
		327	Called at the very end of initialisation of a new terminal, just before
		328	trying to map (display) the toplevel and returning to the mainloop.
		329
		330	=item on_destroy $term
		331
		332	Called whenever something tries to destroy terminal, before doing anything
		333	yet. If this hook returns true, then destruction is skipped, but this is
		334	rarely a good idea.
193		335
194	=item on_reset $term	336	=item on_reset $term
195		337
196	Called after the screen is "reset" for any reason, such as resizing or	338	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	339	control sequences. Here is where you can react on changes to size-related
198	variables.	340	variables.
199		341
200	=item on_start $term	342	=item on_child_start $term, $pid
201		343
202	Called at the very end of initialisation of a new terminal, just before	344	Called just after the child process has been C<fork>ed.
203	returning to the mainloop.	345
		346	=item on_child_exit $term, $status
		347
		348	Called just after the child process has exited. C<$status> is the status
		349	from C<waitpid>.
204		350
205	=item on_sel_make $term, $eventtime	351	=item on_sel_make $term, $eventtime
206		352
207	Called whenever a selection has been made by the user, but before the	353	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	354	selection text is copied, so changes to the beginning, end or type of the
…		…
222	=item on_sel_extend $term	368	=item on_sel_extend $term
223		369
224	Called whenever the user tries to extend the selection (e.g. with a double	370	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	371	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	372	should extend the selection itelf and return true to suppress the built-in
227	processing.	373	processing. This can happen multiple times, as long as the callback
		374	returns true, it will be called on every further click by the user and is
		375	supposed to enlarge the selection more and more, if possible.
228		376
229	See the F<selection> example extension.	377	See the F<selection> example extension.
230		378
231	=item on_view_change $term, $offset	379	=item on_view_change $term, $offset
232		380
…		…
299		447
300	Called whenever the user presses a key combination that has a	448	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>	449	C<perl:string> action bound to it (see description of the B<keysym>
302	resource in the @@RXVT_NAME@@(1) manpage).	450	resource in the @@RXVT_NAME@@(1) manpage).
303		451
		452	=item on_x_event $term, $event
		453
		454	Called on every X event received on the vt window (and possibly other
		455	windows). Should only be used as a last resort. Most event structure
		456	members are not passed.
		457
304	=item on_focus_in $term	458	=item on_focus_in $term
305		459
306	Called whenever the window gets the keyboard focus, before rxvt-unicode	460	Called whenever the window gets the keyboard focus, before rxvt-unicode
307	does focus in processing.	461	does focus in processing.
308		462
309	=item on_focus_out $term	463	=item on_focus_out $term
310		464
311	Called wheneever the window loses keyboard focus, before rxvt-unicode does	465	Called wheneever the window loses keyboard focus, before rxvt-unicode does
312	focus out processing.	466	focus out processing.
		467
		468	=item on_configure_notify $term, $event
313		469
314	=item on_key_press $term, $event, $keysym, $octets	470	=item on_key_press $term, $event, $keysym, $octets
315		471
316	=item on_key_release $term, $event, $keysym	472	=item on_key_release $term, $event, $keysym
317		473
…		…
335	C<on_key_press> additionally receives the string rxvt-unicode would	491	C<on_key_press> additionally receives the string rxvt-unicode would
336	output, if any, in locale-specific encoding.	492	output, if any, in locale-specific encoding.
337		493
338	subwindow.	494	subwindow.
339		495
340	=back	496	=item on_client_message $term, $event
341		497
342	=head2 Variables in the C<urxvt> Package	498	=item on_wm_protocols $term, $event
343		499
344	=over 4	500	=item on_wm_delete_window $term, $event
345		501
346	=item $urxvt::TERM	502	Called when various types of ClientMessage events are received (all with
347		503	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		504
450	=back	505	=back
451		506
452	=cut	507	=cut
453		508
…		…
459	use Scalar::Util ();	514	use Scalar::Util ();
460	use List::Util ();	515	use List::Util ();
461		516
462	our $VERSION = 1;	517	our $VERSION = 1;
463	our $TERM;	518	our $TERM;
		519	our @TERM_INIT;
		520	our @TERM_EXT;
464	our @HOOKNAME;	521	our @HOOKNAME;
465	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	522	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
466	our %OPTION;	523	our %OPTION;
467		524
468	our $LIBDIR;	525	our $LIBDIR;
469	our $RESNAME;	526	our $RESNAME;
470	our $RESCLASS;	527	our $RESCLASS;
471	our $RXVTNAME;	528	our $RXVTNAME;
472		529
		530	=head2 Variables in the C<urxvt> Package
		531
		532	=over 4
		533
		534	=item $urxvt::LIBDIR
		535
		536	The rxvt-unicode library directory, where, among other things, the perl
		537	modules and scripts are stored.
		538
		539	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		540
		541	The resource class and name rxvt-unicode uses to look up X resources.
		542
		543	=item $urxvt::RXVTNAME
		544
		545	The basename of the installed binaries, usually C<urxvt>.
		546
		547	=item $urxvt::TERM
		548
		549	The current terminal. This variable stores the current C<urxvt::term>
		550	object, whenever a callback/hook is executing.
		551
		552	=item @urxvt::TERM_INIT
		553
		554	All coderefs in this array will be called as methods of the next newly
		555	created C<urxvt::term> object (during the C<on_init> phase). The array
		556	gets cleared before the codereferences that were in it are being executed,
		557	so coderefs can push themselves onto it again if they so desire.
		558
		559	This complements to the perl-eval commandline option, but gets executed
		560	first.
		561
		562	=item @urxvt::TERM_EXT
		563
		564	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		565	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		566	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		567
		568	=back
		569
		570	=head2 Functions in the C<urxvt> Package
		571
		572	=over 4
		573
		574	=item urxvt::fatal $errormessage
		575
		576	Fatally aborts execution with the given error message. Avoid at all
		577	costs! The only time this is acceptable is when the terminal process
		578	starts up.
		579
		580	=item urxvt::warn $string
		581
		582	Calls C<rxvt_warn> with the given string which should not include a
		583	newline. The module also overwrites the C<warn> builtin with a function
		584	that calls this function.
		585
		586	Using this function has the advantage that its output ends up in the
		587	correct place, e.g. on stderr of the connecting urxvtc client.
		588
		589	Messages have a size limit of 1023 bytes currently.
		590
		591	=item $time = urxvt::NOW
		592
		593	Returns the "current time" (as per the event loop).
		594
		595	=item urxvt::CurrentTime
		596
		597	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		598	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		599	Button4Mask, Button5Mask, AnyModifier
		600
		601	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		602	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		603	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		604	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		605	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		606	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		607	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		608
		609	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		610	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		611	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		612	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		613	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		614	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		615	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		616
		617	Various constants for use in X calls and event processing.
		618
		619	=back
		620
		621	=head2 RENDITION
		622
		623	Rendition bitsets contain information about colour, font, font styles and
		624	similar information for each screen cell.
		625
		626	The following "macros" deal with changes in rendition sets. You should
		627	never just create a bitset, you should always modify an existing one,
		628	as they contain important information required for correct operation of
		629	rxvt-unicode.
		630
		631	=over 4
		632
		633	=item $rend = urxvt::DEFAULT_RSTYLE
		634
		635	Returns the default rendition, as used when the terminal is starting up or
		636	being reset. Useful as a base to start when creating renditions.
		637
		638	=item $rend = urxvt::OVERLAY_RSTYLE
		639
		640	Return the rendition mask used for overlays by default.
		641
		642	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		643
		644	Return the bit that enabled bold, italic, blink, reverse-video and
		645	underline, respectively. To enable such a style, just logically OR it into
		646	the bitset.
		647
		648	=item $foreground = urxvt::GET_BASEFG $rend
		649
		650	=item $background = urxvt::GET_BASEBG $rend
		651
		652	Return the foreground/background colour index, respectively.
		653
		654	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		655
		656	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		657
		658	Replace the foreground/background colour in the rendition mask with the
		659	specified one.
		660
		661	=item $value = urxvt::GET_CUSTOM $rend
		662
		663	Return the "custom" value: Every rendition has 5 bits for use by
		664	extensions. They can be set and changed as you like and are initially
		665	zero.
		666
		667	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		668
		669	Change the custom value.
		670
		671	=back
		672
		673	=cut
		674
473	BEGIN {	675	BEGIN {
474	urxvt->bootstrap;
475
476	# overwrite perl's warn	676	# overwrite perl's warn
477	*CORE::GLOBAL::warn = sub {	677	*CORE::GLOBAL::warn = sub {
478	my $msg = join "", @_;	678	my $msg = join "", @_;
479	$msg .= "\n"	679	$msg .= "\n"
480	unless $msg =~ /\n$/;	680	unless $msg =~ /\n$/;
481	urxvt::warn ($msg);	681	urxvt::warn ($msg);
482	};	682	};
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	}	683	}
489		684
490	my @hook_count;
491	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	685	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
492		686
493	sub verbose {	687	sub verbose {
494	my ($level, $msg) = @_;	688	my ($level, $msg) = @_;
495	warn "$msg\n" if $level <= $verbosity;	689	warn "$msg\n" if $level <= $verbosity;
496	}	690	}
497		691
498	my $extension_pkg = "extension0000";
499	my %extension_pkg;	692	my %extension_pkg;
500		693
501	# load a single script into its own package, once only	694	# load a single script into its own package, once only
502	sub extension_package($) {	695	sub extension_package($) {
503	my ($path) = @_;	696	my ($path) = @_;
504		697
505	$extension_pkg{$path} \|\|= do {	698	$extension_pkg{$path} \|\|= do {
506	my $pkg = "urxvt::" . ($extension_pkg++);	699	$path =~ /([^\/\\]+)$/;
		700	my $pkg = $1;
		701	$pkg =~ s/[^[:word:]]/_/g;
		702	$pkg = "urxvt::ext::$pkg";
507		703
508	verbose 3, "loading extension '$path' into package '$pkg'";	704	verbose 3, "loading extension '$path' into package '$pkg'";
509		705
510	open my $fh, "<:raw", $path	706	open my $fh, "<:raw", $path
511	or die "$path: $!";	707	or die "$path: $!";
512		708
513	my $source = untaint	709	my $source =
514	"package $pkg; use strict; use utf8;\n"	710	"package $pkg; use strict; use utf8;\n"
515	. "use base urxvt::term::extension::;\n"
516	. "#line 1 \"$path\"\n{\n"	711	. "#line 1 \"$path\"\n{\n"
517	. (do { local $/; <$fh> })	712	. (do { local $/; <$fh> })
518	. "\n};\n1";	713	. "\n};\n1";
519		714
520	eval $source	715	eval $source
…		…
534	if ($htype == 0) { # INIT	729	if ($htype == 0) { # INIT
535	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	730	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
536		731
537	my %ext_arg;	732	my %ext_arg;
538		733
		734	{
		735	my @init = @TERM_INIT;
		736	@TERM_INIT = ();
		737	$_->($TERM) for @init;
		738	my @pkg = @TERM_EXT;
		739	@TERM_EXT = ();
		740	$TERM->register_package ($_) for @pkg;
		741	}
		742
539	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	743	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
540	if ($_ eq "default") {	744	if ($_ eq "default") {
541	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	745	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
542	} elsif (/^-(.*)$/) {	746	} elsif (/^-(.*)$/) {
543	delete $ext_arg{$1};	747	delete $ext_arg{$1};
544	} elsif (/^([^<]+)<(.*)>$/) {	748	} elsif (/^([^<]+)<(.*)>$/) {
…		…
569	if $verbosity >= 10;	773	if $verbosity >= 10;
570		774
571	keys %$cb;	775	keys %$cb;
572		776
573	while (my ($pkg, $cb) = each %$cb) {	777	while (my ($pkg, $cb) = each %$cb) {
574	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	778	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
575	and last;	779	$retval \|\|= $retval_;
576		780
577	if ($@) {	781	if ($@) {
578	$TERM->ungrab; # better to lose the grab than the session	782	$TERM->ungrab; # better to lose the grab than the session
579	warn $@;	783	warn $@;
580	}	784	}
581	}	785	}
		786
		787	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		788	if $verbosity >= 11;
582	}	789	}
583		790
584	if ($htype == 1) { # DESTROY	791	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	792	# clear package objects
593	%$_ = () for values %{ $TERM->{_pkg} };	793	%$_ = () for values %{ $TERM->{_pkg} };
594		794
595	# clear package	795	# clear package
596	%$TERM = ();	796	%$TERM = ();
…		…
610	while (my ($name, $cb) = each %hook) {	810	while (my ($name, $cb) = each %hook) {
611	my $htype = $HOOKTYPE{uc $name};	811	my $htype = $HOOKTYPE{uc $name};
612	defined $htype	812	defined $htype
613	or Carp::croak "unsupported hook type '$name'";	813	or Carp::croak "unsupported hook type '$name'";
614		814
		815	$self->set_should_invoke ($htype, +1)
615	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	816	unless exists $self->{term}{_hook}[$htype]{$pkg};
616	$hook_count[$htype]++
617	or urxvt::set_should_invoke $htype, 1;
618	}
619		817
620	$self->{term}{_hook}[$htype]{$pkg} = $cb;	818	$self->{term}{_hook}[$htype]{$pkg} = $cb;
621	}	819	}
622	}	820	}
623		821
…		…
628	for my $name (@hook) {	826	for my $name (@hook) {
629	my $htype = $HOOKTYPE{uc $name};	827	my $htype = $HOOKTYPE{uc $name};
630	defined $htype	828	defined $htype
631	or Carp::croak "unsupported hook type '$name'";	829	or Carp::croak "unsupported hook type '$name'";
632		830
		831	$self->set_should_invoke ($htype, -1)
633	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	832	if delete $self->{term}{_hook}[$htype]{$pkg};
634	--$hook_count[$htype]
635	or urxvt::set_should_invoke $htype, 0;
636	}
637	}	833	}
638	}	834	}
639		835
640	our $AUTOLOAD;	836	our $AUTOLOAD;
641		837
…		…
672		868
673	=head2 The C<urxvt::anyevent> Class	869	=head2 The C<urxvt::anyevent> Class
674		870
675	The sole purpose of this class is to deliver an interface to the	871	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	872	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	873	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	874	condition variables, but non-blocking condvar use is ok. What this means
679	cannot use blocking APIs, but the non-blocking variant should work.	875	is that you cannot use blocking APIs, but the non-blocking variant should
		876	work.
680		877
681	=cut	878	=cut
682		879
683	our $VERSION = 1;	880	our $VERSION = 1;
684		881
…		…
746	# find on_xxx subs in the package and register them	943	# find on_xxx subs in the package and register them
747	# as hooks	944	# as hooks
748	sub register_package {	945	sub register_package {
749	my ($self, $pkg, $argv) = @_;	946	my ($self, $pkg, $argv) = @_;
750		947
		948	no strict 'refs';
		949
		950	urxvt::verbose 6, "register package $pkg to $self";
		951
		952	@{"$pkg\::ISA"} = urxvt::term::extension::;
		953
751	my $proxy = bless {	954	my $proxy = bless {
752	_pkg => $pkg,	955	_pkg => $pkg,
753	argv => $argv,	956	argv => $argv,
754	}, $pkg;	957	}, $pkg;
755	Scalar::Util::weaken ($proxy->{term} = $self);	958	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
761	$proxy->enable ($name => $ref);	964	$proxy->enable ($name => $ref);
762	}	965	}
763	}	966	}
764	}	967	}
765		968
		969	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		970
		971	Creates a new terminal, very similar as if you had started it with system
		972	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		973	hash which defines the environment of the new terminal.
		974
		975	Croaks (and probably outputs an error message) if the new instance
		976	couldn't be created. Returns C<undef> if the new instance didn't
		977	initialise perl, and the terminal object otherwise. The C<init> and
		978	C<start> hooks will be called during this call.
		979
		980	=cut
		981
		982	sub new {
		983	my ($class, $env, @args) = @_;
		984
		985	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		986	}
		987
766	=item $term->destroy	988	=item $term->destroy
767		989
768	Destroy the terminal object (close the window, free resources etc.).	990	Destroy the terminal object (close the window, free resources
		991	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		992	watchers (timers, io watchers) are still active.
		993
		994	=item $term->exec_async ($cmd[, @args])
		995
		996	Works like the combination of the C<fork>/C<exec> builtins, which executes
		997	("starts") programs in the background. This function takes care of setting
		998	the user environment before exec'ing the command (e.g. C<PATH>) and should
		999	be preferred over explicit calls to C<exec> or C<system>.
		1000
		1001	Returns the pid of the subprocess or C<undef> on error.
		1002
		1003	=cut
		1004
		1005	sub exec_async {
		1006	my $self = shift;
		1007
		1008	my $pid = fork;
		1009
		1010	return $pid
		1011	if !defined $pid or $pid;
		1012
		1013	%ENV = %{ $self->env };
		1014
		1015	exec @_;
		1016	urxvt::_exit 255;
		1017	}
769		1018
770	=item $isset = $term->option ($optval[, $set])	1019	=item $isset = $term->option ($optval[, $set])
771		1020
772	Returns true if the option specified by C<$optval> is enabled, and	1021	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	1022	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	1025	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:	1026	source file F</src/optinc.h> to see the actual list:
778		1027
779	borderLess console cursorBlink cursorUnderline hold iconic insecure	1028	borderLess console cursorBlink cursorUnderline hold iconic insecure
780	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1029	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
781	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1030	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
782	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1031	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
783	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1032	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
784	tripleclickwords utmpInhibit visualBell	1033	transparent tripleclickwords utmpInhibit visualBell
785		1034
786	=item $value = $term->resource ($name[, $newval])	1035	=item $value = $term->resource ($name[, $newval])
787		1036
788	Returns the current resource value associated with a given name and	1037	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>	1038	optionally sets a new value. Setting values is most useful in the C<init>
…		…
806		1055
807	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1056	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
808	borderLess color cursorBlink cursorUnderline cutchars delete_key	1057	borderLess color cursorBlink cursorUnderline cutchars delete_key
809	display_name embed ext_bwidth fade font geometry hold iconName	1058	display_name embed ext_bwidth fade font geometry hold iconName
810	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1059	imFont imLocale inputMethod insecure int_bwidth intensityStyles
811	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1060	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
812	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1061	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
813	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1062	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
814	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1063	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
815	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1064	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
816	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1065	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
817	shade term_name title transparent transparent_all tripleclickwords	1066	secondaryScreen secondaryScroll selectstyle shade term_name title
818	utmpInhibit visualBell	1067	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1068	visualBell
819		1069
820	=cut	1070	=cut
821		1071
822	sub resource($$;$) {	1072	sub resource($$;$) {
823	my ($self, $name) = (shift, shift);	1073	my ($self, $name) = (shift, shift);
824	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1074	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
825	&urxvt::term::_resource	1075	&urxvt::term::_resource
826	}	1076	}
827		1077
		1078	=item $value = $term->x_resource ($pattern)
		1079
		1080	Returns the X-Resource for the given pattern, excluding the program or
		1081	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1082	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1083	resource with that pattern exists.
		1084
		1085	This method should only be called during the C<on_start> hook, as there is
		1086	only one resource database per display, and later invocations might return
		1087	the wrong resources.
		1088
828	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1089	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
829		1090
830	Adds a keymap translation exactly as specified via a resource. See the	1091	Adds a keymap translation exactly as specified via a resource. See the
831	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1092	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
832		1093
…		…
847	=item ($row, $col) = $term->selection_end ([$row, $col])	1108	=item ($row, $col) = $term->selection_end ([$row, $col])
848		1109
849	Return the current values of the selection mark, begin or end positions,	1110	Return the current values of the selection mark, begin or end positions,
850	and optionally set them to new values.	1111	and optionally set them to new values.
851		1112
		1113	=item $term->selection_make ($eventtime[, $rectangular])
		1114
		1115	Tries to make a selection as set by C<selection_beg> and
		1116	C<selection_end>. If C<$rectangular> is true (default: false), a
		1117	rectangular selection will be made. This is the prefered function to make
		1118	a selection.
		1119
852	=item $success = $term->selection_grab ($eventtime)	1120	=item $success = $term->selection_grab ($eventtime)
853		1121
854	Try to request the primary selection from the server (for example, as set	1122	Try to request the primary selection text from the server (for example, as
855	by the next method).	1123	set by the next method). No visual feedback will be given. This function
		1124	is mostly useful from within C<on_sel_grab> hooks.
856		1125
857	=item $oldtext = $term->selection ([$newtext])	1126	=item $oldtext = $term->selection ([$newtext])
858		1127
859	Return the current selection text and optionally replace it by C<$newtext>.	1128	Return the current selection text and optionally replace it by C<$newtext>.
860		1129
…		…
953	Convert the given locale-encoded octets into a perl string.	1222	Convert the given locale-encoded octets into a perl string.
954		1223
955	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1224	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
956		1225
957	XORs the rendition values in the given span with the provided value	1226	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	1227	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
959	to the selection.	1228	refresh hooks to provide effects similar to the selection.
960		1229
961	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1230	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
962		1231
963	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1232	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
964	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1233	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	1234	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
966	it instead.	1235	it instead. Both styles I<MUST NOT> contain font styles.
967		1236
968	=item $term->scr_bell	1237	=item $term->scr_bell
969		1238
970	Ring the bell!	1239	Ring the bell!
971		1240
…		…
1005		1274
1006	=item $windowid = $term->vt	1275	=item $windowid = $term->vt
1007		1276
1008	Return the window id of the terminal window.	1277	Return the window id of the terminal window.
1009		1278
		1279	=item $term->vt_emask_add ($x_event_mask)
		1280
		1281	Adds the specified events to the vt event mask. Useful e.g. when you want
		1282	to receive pointer events all the times:
		1283
		1284	$term->vt_emask_add (urxvt::PointerMotionMask);
		1285
1010	=item $window_width = $term->width	1286	=item $window_width = $term->width
1011		1287
1012	=item $window_height = $term->height	1288	=item $window_height = $term->height
1013		1289
1014	=item $font_width = $term->fwidth	1290	=item $font_width = $term->fwidth
…		…
1027		1303
1028	=item $max_scrollback = $term->saveLines	1304	=item $max_scrollback = $term->saveLines
1029		1305
1030	=item $nrow_plus_saveLines = $term->total_rows	1306	=item $nrow_plus_saveLines = $term->total_rows
1031		1307
1032	=item $lines_in_scrollback = $term->nsaved	1308	=item $topmost_scrollback_row = $term->top_row
1033		1309
1034	Return various integers describing terminal characteristics.	1310	Return various integers describing terminal characteristics.
1035		1311
		1312	=item $x_display = $term->display_id
		1313
		1314	Return the DISPLAY used by rxvt-unicode.
		1315
1036	=item $lc_ctype = $term->locale	1316	=item $lc_ctype = $term->locale
1037		1317
1038	Returns the LC_CTYPE category string used by this rxvt-unicode.	1318	Returns the LC_CTYPE category string used by this rxvt-unicode.
1039		1319
1040	=item $x_display = $term->display_id	1320	=item $env = $term->env
1041		1321
1042	Return the DISPLAY used by rxvt-unicode.	1322	Returns a copy of the environment in effect for the terminal as a hashref
		1323	similar to C<\%ENV>.
		1324
		1325	=cut
		1326
		1327	sub env {
		1328	if (my $env = $_[0]->_env) {
		1329	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1330	} else {
		1331	+{ %ENV }
		1332	}
		1333	}
1043		1334
1044	=item $modifiermask = $term->ModLevel3Mask	1335	=item $modifiermask = $term->ModLevel3Mask
1045		1336
1046	=item $modifiermask = $term->ModMetaMask	1337	=item $modifiermask = $term->ModMetaMask
1047		1338
…		…
1050	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1341	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.	1342	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1052		1343
1053	=item $view_start = $term->view_start ([$newvalue])	1344	=item $view_start = $term->view_start ([$newvalue])
1054		1345
1055	Returns the negative row number of the topmost line. Minimum value is	1346	Returns the row number of the topmost displayed line. Maximum value is
1056	C<0>, which displays the normal terminal contents. Larger values scroll	1347	C<0>, which displays the normal terminal contents. Lower values scroll
1057	this many lines into the scrollback buffer.	1348	this many lines into the scrollback buffer.
1058		1349
1059	=item $term->want_refresh	1350	=item $term->want_refresh
1060		1351
1061	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1352	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.	1431	Return the row number of the first/last row of the line, respectively.
1141		1432
1142	=item $offset = $line->offset_of ($row, $col)	1433	=item $offset = $line->offset_of ($row, $col)
1143		1434
1144	Returns the character offset of the given row\|col pair within the logical	1435	Returns the character offset of the given row\|col pair within the logical
1145	line.	1436	line. Works for rows outside the line, too, and returns corresponding
		1437	offsets outside the string.
1146		1438
1147	=item ($row, $col) = $line->coord_of ($offset)	1439	=item ($row, $col) = $line->coord_of ($offset)
1148		1440
1149	Translates a string offset into terminal coordinates again.	1441	Translates a string offset into terminal coordinates again.
1150		1442
…		…
1287	$item->{render} \|\|= sub { $_[0]{text} };	1579	$item->{render} \|\|= sub { $_[0]{text} };
1288		1580
1289	push @{ $self->{item} }, $item;	1581	push @{ $self->{item} }, $item;
1290	}	1582	}
1291		1583
		1584	=item $popup->add_title ($title)
		1585
		1586	Adds a non-clickable title to the popup.
		1587
		1588	=cut
		1589
		1590	sub add_title {
		1591	my ($self, $title) = @_;
		1592
		1593	$self->add_item ({
		1594	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1595	text => $title,
		1596	activate => sub { },
		1597	});
		1598	}
		1599
		1600	=item $popup->add_separator ([$sepchr])
		1601
		1602	Creates a separator, optionally using the character given as C<$sepchr>.
		1603
		1604	=cut
		1605
1292	sub add_separator {	1606	sub add_separator {
1293	my ($self, $sep) = @_;	1607	my ($self, $sep) = @_;
1294		1608
1295	$sep \|\|= "=";	1609	$sep \|\|= "=";
1296		1610
…		…
1300	render => sub { $sep x $self->{term}->ncol },	1614	render => sub { $sep x $self->{term}->ncol },
1301	activate => sub { },	1615	activate => sub { },
1302	});	1616	});
1303	}	1617	}
1304		1618
1305	sub add_title {	1619	=item $popup->add_button ($text, $cb)
1306	my ($self, $title) = @_;
1307		1620
1308	$self->add_item ({	1621	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" },	1622	selected.
1310	text => $title,	1623
1311	activate => sub { },	1624	=cut
1312	});
1313	}
1314		1625
1315	sub add_button {	1626	sub add_button {
1316	my ($self, $text, $cb) = @_;	1627	my ($self, $text, $cb) = @_;
1317		1628
1318	$self->add_item ({ type => "button", text => $text, activate => $cb});	1629	$self->add_item ({ type => "button", text => $text, activate => $cb});
1319	}	1630	}
		1631
		1632	=item $popup->add_toggle ($text, $cb, $initial_value)
		1633
		1634	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1635	whenever it gets toggled, with a boolean indicating its value as its first
		1636	argument.
		1637
		1638	=cut
1320		1639
1321	sub add_toggle {	1640	sub add_toggle {
1322	my ($self, $text, $cb, $value) = @_;	1641	my ($self, $text, $cb, $value) = @_;
1323		1642
1324	my $item; $item = {	1643	my $item; $item = {
1325	type => "button",	1644	type => "button",
1326	text => " $text",	1645	text => " $text",
1327	value => $value,	1646	value => $value,
1328	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1647	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1329	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1648	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1330	};	1649	};
1331		1650
1332	$self->add_item ($item);	1651	$self->add_item ($item);
1333	}	1652	}
		1653
		1654	=item $popup->show
		1655
		1656	Displays the popup (which is initially hidden).
		1657
		1658	=cut
1334		1659
1335	sub show {	1660	sub show {
1336	my ($self) = @_;	1661	my ($self) = @_;
1337		1662
1338	local $urxvt::popup::self = $self;	1663	local $urxvt::popup::self = $self;
1339		1664
		1665	my $env = $self->{term}->env;
		1666	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1667	delete $env->{LC_ALL};
1340	local $ENV{LC_ALL} = $self->{term}->locale;	1668	$env->{LC_CTYPE} = $self->{term}->locale;
1341		1669
1342	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1670	urxvt::term->new ($env, "popup",
		1671	"--perl-lib" => "", "--perl-ext-common" => "",
		1672	"-pty-fd" => -1, "-sl" => 0,
		1673	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1343	"--transient-for" => $self->{term}->parent,	1674	"--transient-for" => $self->{term}->parent,
1344	"-display" => $self->{term}->display_id,	1675	"-display" => $self->{term}->display_id,
1345	"-pe" => "urxvt-popup")	1676	"-pe" => "urxvt-popup")
1346	or die "unable to create popup window\n";	1677	or die "unable to create popup window\n";
1347	}	1678	}
1348		1679
1349	sub DESTROY {	1680	sub DESTROY {
1350	my ($self) = @_;	1681	my ($self) = @_;
1351		1682
1352	delete $self->{term}{_destroy}{$self};	1683	delete $self->{term}{_destroy}{$self};
1353	$self->{term}->ungrab;	1684	$self->{term}->ungrab;
1354	}	1685	}
		1686
		1687	=back
		1688
		1689	=cut
		1690
		1691	package urxvt::watcher;
		1692
		1693	@urxvt::timer::ISA = __PACKAGE__;
		1694	@urxvt::iow::ISA = __PACKAGE__;
		1695	@urxvt::pw::ISA = __PACKAGE__;
		1696	@urxvt::iw::ISA = __PACKAGE__;
1355		1697
1356	=head2 The C<urxvt::timer> Class	1698	=head2 The C<urxvt::timer> Class
1357		1699
1358	This class implements timer watchers/events. Time is represented as a	1700	This class implements timer watchers/events. Time is represented as a
1359	fractional number of seconds since the epoch. Example:	1701	fractional number of seconds since the epoch. Example:
…		…
1397	Start the timer.	1739	Start the timer.
1398		1740
1399	=item $timer = $timer->start ($tstamp)	1741	=item $timer = $timer->start ($tstamp)
1400		1742
1401	Set the event trigger time to C<$tstamp> and start the timer.	1743	Set the event trigger time to C<$tstamp> and start the timer.
		1744
		1745	=item $timer = $timer->after ($delay)
		1746
		1747	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1402		1748
1403	=item $timer = $timer->stop	1749	=item $timer = $timer->stop
1404		1750
1405	Stop the timer.	1751	Stop the timer.
1406		1752
…		…
1453		1799
1454	Stop watching for events on the given filehandle.	1800	Stop watching for events on the given filehandle.
1455		1801
1456	=back	1802	=back
1457		1803
		1804	=head2 The C<urxvt::iw> Class
		1805
		1806	This class implements idle watchers, that get called automatically when
		1807	the process is idle. They should return as fast as possible, after doing
		1808	some useful work.
		1809
		1810	=over 4
		1811
		1812	=item $iw = new urxvt::iw
		1813
		1814	Create a new idle watcher object in stopped state.
		1815
		1816	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1817
		1818	Set the callback to be called when the watcher triggers.
		1819
		1820	=item $timer = $timer->start
		1821
		1822	Start the watcher.
		1823
		1824	=item $timer = $timer->stop
		1825
		1826	Stop the watcher.
		1827
		1828	=back
		1829
		1830	=head2 The C<urxvt::pw> Class
		1831
		1832	This class implements process watchers. They create an event whenever a
		1833	process exits, after which they stop automatically.
		1834
		1835	my $pid = fork;
		1836	...
		1837	$term->{pw} = urxvt::pw
		1838	->new
		1839	->start ($pid)
		1840	->cb (sub {
		1841	my ($pw, $exit_status) = @_;
		1842	...
		1843	});
		1844
		1845	=over 4
		1846
		1847	=item $pw = new urxvt::pw
		1848
		1849	Create a new process watcher in stopped state.
		1850
		1851	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1852
		1853	Set the callback to be called when the timer triggers.
		1854
		1855	=item $pw = $timer->start ($pid)
		1856
		1857	Tells the wqtcher to start watching for process C<$pid>.
		1858
		1859	=item $pw = $pw->stop
		1860
		1861	Stop the watcher.
		1862
		1863	=back
		1864
1458	=head1 ENVIRONMENT	1865	=head1 ENVIRONMENT
1459		1866
1460	=head2 URXVT_PERL_VERBOSITY	1867	=head2 URXVT_PERL_VERBOSITY
1461		1868
1462	This variable controls the verbosity level of the perl extension. Higher	1869	This variable controls the verbosity level of the perl extension. Higher
…		…
1466		1873
1467	=item == 0 - fatal messages	1874	=item == 0 - fatal messages
1468		1875
1469	=item >= 3 - script loading and management	1876	=item >= 3 - script loading and management
1470		1877
1471	=item >=10 - all events received	1878	=item >=10 - all called hooks
		1879
		1880	=item >=11 - hook reutrn values
1472		1881
1473	=back	1882	=back
1474		1883
1475	=head1 AUTHOR	1884	=head1 AUTHOR
1476		1885

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.114 by root, Fri Jan 20 12:16:28 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.114 by root, Fri Jan 20 12:16:28 2006 UTC