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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.76 by root, Tue Jan 10 19:46:28 2006 UTC vs.
Revision 1.113 by root, Fri Jan 20 10:27:08 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
…		…
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	evalution, web-browser starting etc.), depending on content.
71		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
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.
86		166
87	=item mark-urls	167	=item mark-urls
88		168
89	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
90		181
91	=item block-graphics-to-ascii	182	=item block-graphics-to-ascii
92		183
93	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,
94	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
95	similar-looking ascii character.	186	similar-looking ascii character.
96		187
		188	=item digital-clock
		189
		190	Displays a digital clock using the built-in overlay.
		191
97	=item example-refresh-hooks	192	=item example-refresh-hooks
98		193
99	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
100	window. Illustrates overwriting the refresh callbacks to create your own	195	window. Illustrates overwriting the refresh callbacks to create your own
101	overlays or changes.	196	overlays or changes.
		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/%
102		226
103	=back	227	=back
104		228
105	=head1 API DOCUMENTATION	229	=head1 API DOCUMENTATION
106		230
…		…
123	=over 4	247	=over 4
124		248
125	=item $text	249	=item $text
126		250
127	Rxvt-unicodes special way of encoding text, where one "unicode" character	251	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.	252	always represents one screen cell. See L<ROW_t> for a discussion of this format.
129		253
130	=item $string	254	=item $string
131		255
132	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
133	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
…		…
179	called whenever the relevant event happens.	303	called whenever the relevant event happens.
180		304
181	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
182	the in the C<Extension Objects> section.	306	the in the C<Extension Objects> section.
183		307
184	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
185	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
186	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.
187		311
188	I<< When in doubt, return a false value (preferably C<()>). >>	312	I<< When in doubt, return a false value (preferably C<()>). >>
189		313
190	=over 4	314	=over 4
191		315
192	=item on_init $term	316	=item on_init $term
193		317
194	Called after a new terminal object has been initialized, but before	318	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	319	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	320	call or deliver senseless data, as terminal size and other characteristics
197	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
198	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.
199		335
200	=item on_reset $term	336	=item on_reset $term
201		337
202	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
203	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
204	variables.	340	variables.
205		341
206	=item on_start $term	342	=item on_child_start $term, $pid
207		343
208	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.
209	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>.
210		350
211	=item on_sel_make $term, $eventtime	351	=item on_sel_make $term, $eventtime
212		352
213	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
214	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
…		…
228	=item on_sel_extend $term	368	=item on_sel_extend $term
229		369
230	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
231	click) and is either supposed to return false (normal operation), or	371	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	372	should extend the selection itelf and return true to suppress the built-in
233	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.
234		376
235	See the F<selection> example extension.	377	See the F<selection> example extension.
236		378
237	=item on_view_change $term, $offset	379	=item on_view_change $term, $offset
238		380
…		…
305		447
306	Called whenever the user presses a key combination that has a	448	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>	449	C<perl:string> action bound to it (see description of the B<keysym>
308	resource in the @@RXVT_NAME@@(1) manpage).	450	resource in the @@RXVT_NAME@@(1) manpage).
309		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
310	=item on_focus_in $term	458	=item on_focus_in $term
311		459
312	Called whenever the window gets the keyboard focus, before rxvt-unicode	460	Called whenever the window gets the keyboard focus, before rxvt-unicode
313	does focus in processing.	461	does focus in processing.
314		462
315	=item on_focus_out $term	463	=item on_focus_out $term
316		464
317	Called wheneever the window loses keyboard focus, before rxvt-unicode does	465	Called wheneever the window loses keyboard focus, before rxvt-unicode does
318	focus out processing.	466	focus out processing.
		467
		468	=item on_configure_notify $term, $event
319		469
320	=item on_key_press $term, $event, $keysym, $octets	470	=item on_key_press $term, $event, $keysym, $octets
321		471
322	=item on_key_release $term, $event, $keysym	472	=item on_key_release $term, $event, $keysym
323		473
…		…
340		490
341	C<on_key_press> additionally receives the string rxvt-unicode would	491	C<on_key_press> additionally receives the string rxvt-unicode would
342	output, if any, in locale-specific encoding.	492	output, if any, in locale-specific encoding.
343		493
344	subwindow.	494	subwindow.
345
346	=back
347
348	=head2 Variables in the C<urxvt> Package
349
350	=over 4
351
352	=item $urxvt::LIBDIR
353
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		495
471	=back	496	=back
472		497
473	=cut	498	=cut
474		499
…		…
480	use Scalar::Util ();	505	use Scalar::Util ();
481	use List::Util ();	506	use List::Util ();
482		507
483	our $VERSION = 1;	508	our $VERSION = 1;
484	our $TERM;	509	our $TERM;
		510	our @TERM_INIT;
		511	our @TERM_EXT;
485	our @HOOKNAME;	512	our @HOOKNAME;
486	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	513	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
487	our %OPTION;	514	our %OPTION;
488		515
489	our $LIBDIR;	516	our $LIBDIR;
490	our $RESNAME;	517	our $RESNAME;
491	our $RESCLASS;	518	our $RESCLASS;
492	our $RXVTNAME;	519	our $RXVTNAME;
493		520
		521	=head2 Variables in the C<urxvt> Package
		522
		523	=over 4
		524
		525	=item $urxvt::LIBDIR
		526
		527	The rxvt-unicode library directory, where, among other things, the perl
		528	modules and scripts are stored.
		529
		530	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		531
		532	The resource class and name rxvt-unicode uses to look up X resources.
		533
		534	=item $urxvt::RXVTNAME
		535
		536	The basename of the installed binaries, usually C<urxvt>.
		537
		538	=item $urxvt::TERM
		539
		540	The current terminal. This variable stores the current C<urxvt::term>
		541	object, whenever a callback/hook is executing.
		542
		543	=item @urxvt::TERM_INIT
		544
		545	All coderefs in this array will be called as methods of the next newly
		546	created C<urxvt::term> object (during the C<on_init> phase). The array
		547	gets cleared before the codereferences that were in it are being executed,
		548	so coderefs can push themselves onto it again if they so desire.
		549
		550	This complements to the perl-eval commandline option, but gets executed
		551	first.
		552
		553	=item @urxvt::TERM_EXT
		554
		555	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		556	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		557	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		558
		559	=back
		560
		561	=head2 Functions in the C<urxvt> Package
		562
		563	=over 4
		564
		565	=item urxvt::fatal $errormessage
		566
		567	Fatally aborts execution with the given error message. Avoid at all
		568	costs! The only time this is acceptable is when the terminal process
		569	starts up.
		570
		571	=item urxvt::warn $string
		572
		573	Calls C<rxvt_warn> with the given string which should not include a
		574	newline. The module also overwrites the C<warn> builtin with a function
		575	that calls this function.
		576
		577	Using this function has the advantage that its output ends up in the
		578	correct place, e.g. on stderr of the connecting urxvtc client.
		579
		580	Messages have a size limit of 1023 bytes currently.
		581
		582	=item $time = urxvt::NOW
		583
		584	Returns the "current time" (as per the event loop).
		585
		586	=item urxvt::CurrentTime
		587
		588	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		589	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		590	Button4Mask, Button5Mask, AnyModifier
		591
		592	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		593	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		594	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		595	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		596	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		597	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		598	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		599
		600	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		601	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		602	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		603	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		604	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		605	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		606	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		607
		608	Various constants for use in X calls and event processing.
		609
		610	=back
		611
		612	=head2 RENDITION
		613
		614	Rendition bitsets contain information about colour, font, font styles and
		615	similar information for each screen cell.
		616
		617	The following "macros" deal with changes in rendition sets. You should
		618	never just create a bitset, you should always modify an existing one,
		619	as they contain important information required for correct operation of
		620	rxvt-unicode.
		621
		622	=over 4
		623
		624	=item $rend = urxvt::DEFAULT_RSTYLE
		625
		626	Returns the default rendition, as used when the terminal is starting up or
		627	being reset. Useful as a base to start when creating renditions.
		628
		629	=item $rend = urxvt::OVERLAY_RSTYLE
		630
		631	Return the rendition mask used for overlays by default.
		632
		633	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		634
		635	Return the bit that enabled bold, italic, blink, reverse-video and
		636	underline, respectively. To enable such a style, just logically OR it into
		637	the bitset.
		638
		639	=item $foreground = urxvt::GET_BASEFG $rend
		640
		641	=item $background = urxvt::GET_BASEBG $rend
		642
		643	Return the foreground/background colour index, respectively.
		644
		645	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		646
		647	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		648
		649	Replace the foreground/background colour in the rendition mask with the
		650	specified one.
		651
		652	=item $value = urxvt::GET_CUSTOM $rend
		653
		654	Return the "custom" value: Every rendition has 5 bits for use by
		655	extensions. They can be set and changed as you like and are initially
		656	zero.
		657
		658	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		659
		660	Change the custom value.
		661
		662	=back
		663
		664	=cut
		665
494	BEGIN {	666	BEGIN {
495	urxvt->bootstrap;
496
497	# overwrite perl's warn	667	# overwrite perl's warn
498	*CORE::GLOBAL::warn = sub {	668	*CORE::GLOBAL::warn = sub {
499	my $msg = join "", @_;	669	my $msg = join "", @_;
500	$msg .= "\n"	670	$msg .= "\n"
501	unless $msg =~ /\n$/;	671	unless $msg =~ /\n$/;
502	urxvt::warn ($msg);	672	urxvt::warn ($msg);
503	};	673	};
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	}	674	}
510		675
511	my @hook_count;
512	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	676	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
513		677
514	sub verbose {	678	sub verbose {
515	my ($level, $msg) = @_;	679	my ($level, $msg) = @_;
516	warn "$msg\n" if $level <= $verbosity;	680	warn "$msg\n" if $level <= $verbosity;
517	}	681	}
518		682
519	my $extension_pkg = "extension0000";
520	my %extension_pkg;	683	my %extension_pkg;
521		684
522	# load a single script into its own package, once only	685	# load a single script into its own package, once only
523	sub extension_package($) {	686	sub extension_package($) {
524	my ($path) = @_;	687	my ($path) = @_;
525		688
526	$extension_pkg{$path} \|\|= do {	689	$extension_pkg{$path} \|\|= do {
527	my $pkg = "urxvt::" . ($extension_pkg++);	690	$path =~ /([^\/\\]+)$/;
		691	my $pkg = $1;
		692	$pkg =~ s/[^[:word:]]/_/g;
		693	$pkg = "urxvt::ext::$pkg";
528		694
529	verbose 3, "loading extension '$path' into package '$pkg'";	695	verbose 3, "loading extension '$path' into package '$pkg'";
530		696
531	open my $fh, "<:raw", $path	697	open my $fh, "<:raw", $path
532	or die "$path: $!";	698	or die "$path: $!";
533		699
534	my $source = untaint	700	my $source =
535	"package $pkg; use strict; use utf8;\n"	701	"package $pkg; use strict; use utf8;\n"
536	. "use base urxvt::term::extension::;\n"
537	. "#line 1 \"$path\"\n{\n"	702	. "#line 1 \"$path\"\n{\n"
538	. (do { local $/; <$fh> })	703	. (do { local $/; <$fh> })
539	. "\n};\n1";	704	. "\n};\n1";
540		705
541	eval $source	706	eval $source
…		…
555	if ($htype == 0) { # INIT	720	if ($htype == 0) { # INIT
556	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	721	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
557		722
558	my %ext_arg;	723	my %ext_arg;
559		724
		725	{
		726	my @init = @TERM_INIT;
		727	@TERM_INIT = ();
		728	$_->($TERM) for @init;
		729	my @pkg = @TERM_EXT;
		730	@TERM_EXT = ();
		731	$TERM->register_package ($_) for @pkg;
		732	}
		733
560	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	734	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
561	if ($_ eq "default") {	735	if ($_ eq "default") {
562	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	736	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
563	} elsif (/^-(.*)$/) {	737	} elsif (/^-(.*)$/) {
564	delete $ext_arg{$1};	738	delete $ext_arg{$1};
565	} elsif (/^([^<]+)<(.*)>$/) {	739	} elsif (/^([^<]+)<(.*)>$/) {
…		…
590	if $verbosity >= 10;	764	if $verbosity >= 10;
591		765
592	keys %$cb;	766	keys %$cb;
593		767
594	while (my ($pkg, $cb) = each %$cb) {	768	while (my ($pkg, $cb) = each %$cb) {
595	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	769	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
596	and last;	770	$retval \|\|= $retval_;
597		771
598	if ($@) {	772	if ($@) {
599	$TERM->ungrab; # better to lose the grab than the session	773	$TERM->ungrab; # better to lose the grab than the session
600	warn $@;	774	warn $@;
601	}	775	}
602	}	776	}
		777
		778	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		779	if $verbosity >= 11;
603	}	780	}
604		781
605	if ($htype == 1) { # DESTROY	782	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	783	# clear package objects
614	%$_ = () for values %{ $TERM->{_pkg} };	784	%$_ = () for values %{ $TERM->{_pkg} };
615		785
616	# clear package	786	# clear package
617	%$TERM = ();	787	%$TERM = ();
…		…
631	while (my ($name, $cb) = each %hook) {	801	while (my ($name, $cb) = each %hook) {
632	my $htype = $HOOKTYPE{uc $name};	802	my $htype = $HOOKTYPE{uc $name};
633	defined $htype	803	defined $htype
634	or Carp::croak "unsupported hook type '$name'";	804	or Carp::croak "unsupported hook type '$name'";
635		805
		806	$self->set_should_invoke ($htype, +1)
636	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	807	unless exists $self->{term}{_hook}[$htype]{$pkg};
637	$hook_count[$htype]++
638	or urxvt::set_should_invoke $htype, 1;
639	}
640		808
641	$self->{term}{_hook}[$htype]{$pkg} = $cb;	809	$self->{term}{_hook}[$htype]{$pkg} = $cb;
642	}	810	}
643	}	811	}
644		812
…		…
649	for my $name (@hook) {	817	for my $name (@hook) {
650	my $htype = $HOOKTYPE{uc $name};	818	my $htype = $HOOKTYPE{uc $name};
651	defined $htype	819	defined $htype
652	or Carp::croak "unsupported hook type '$name'";	820	or Carp::croak "unsupported hook type '$name'";
653		821
		822	$self->set_should_invoke ($htype, -1)
654	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	823	if delete $self->{term}{_hook}[$htype]{$pkg};
655	--$hook_count[$htype]
656	or urxvt::set_should_invoke $htype, 0;
657	}
658	}	824	}
659	}	825	}
660		826
661	our $AUTOLOAD;	827	our $AUTOLOAD;
662		828
…		…
768	# find on_xxx subs in the package and register them	934	# find on_xxx subs in the package and register them
769	# as hooks	935	# as hooks
770	sub register_package {	936	sub register_package {
771	my ($self, $pkg, $argv) = @_;	937	my ($self, $pkg, $argv) = @_;
772		938
		939	no strict 'refs';
		940
		941	urxvt::verbose 6, "register package $pkg to $self";
		942
		943	@{"$pkg\::ISA"} = urxvt::term::extension::;
		944
773	my $proxy = bless {	945	my $proxy = bless {
774	_pkg => $pkg,	946	_pkg => $pkg,
775	argv => $argv,	947	argv => $argv,
776	}, $pkg;	948	}, $pkg;
777	Scalar::Util::weaken ($proxy->{term} = $self);	949	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
783	$proxy->enable ($name => $ref);	955	$proxy->enable ($name => $ref);
784	}	956	}
785	}	957	}
786	}	958	}
787		959
		960	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		961
		962	Creates a new terminal, very similar as if you had started it with system
		963	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		964	hash which defines the environment of the new terminal.
		965
		966	Croaks (and probably outputs an error message) if the new instance
		967	couldn't be created. Returns C<undef> if the new instance didn't
		968	initialise perl, and the terminal object otherwise. The C<init> and
		969	C<start> hooks will be called during this call.
		970
		971	=cut
		972
		973	sub new {
		974	my ($class, $env, @args) = @_;
		975
		976	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		977	}
		978
788	=item $term->destroy	979	=item $term->destroy
789		980
790	Destroy the terminal object (close the window, free resources	981	Destroy the terminal object (close the window, free resources
791	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	982	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
792	watchers (timers, io watchers) are still active.	983	watchers (timers, io watchers) are still active.
793		984
		985	=item $term->exec_async ($cmd[, @args])
		986
		987	Works like the combination of the C<fork>/C<exec> builtins, which executes
		988	("starts") programs in the background. This function takes care of setting
		989	the user environment before exec'ing the command (e.g. C<PATH>) and should
		990	be preferred over explicit calls to C<exec> or C<system>.
		991
		992	Returns the pid of the subprocess or C<undef> on error.
		993
		994	=cut
		995
		996	sub exec_async {
		997	my $self = shift;
		998
		999	my $pid = fork;
		1000
		1001	return $pid
		1002	if !defined $pid or $pid;
		1003
		1004	%ENV = %{ $self->env };
		1005
		1006	exec @_;
		1007	urxvt::_exit 255;
		1008	}
		1009
794	=item $isset = $term->option ($optval[, $set])	1010	=item $isset = $term->option ($optval[, $set])
795		1011
796	Returns true if the option specified by C<$optval> is enabled, and	1012	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	1013	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.	1014	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	1016	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:	1017	source file F</src/optinc.h> to see the actual list:
802		1018
803	borderLess console cursorBlink cursorUnderline hold iconic insecure	1019	borderLess console cursorBlink cursorUnderline hold iconic insecure
804	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1020	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
805	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1021	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
806	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1022	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
807	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1023	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
808	tripleclickwords utmpInhibit visualBell	1024	transparent tripleclickwords utmpInhibit visualBell
809		1025
810	=item $value = $term->resource ($name[, $newval])	1026	=item $value = $term->resource ($name[, $newval])
811		1027
812	Returns the current resource value associated with a given name and	1028	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>	1029	optionally sets a new value. Setting values is most useful in the C<init>
…		…
830		1046
831	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1047	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
832	borderLess color cursorBlink cursorUnderline cutchars delete_key	1048	borderLess color cursorBlink cursorUnderline cutchars delete_key
833	display_name embed ext_bwidth fade font geometry hold iconName	1049	display_name embed ext_bwidth fade font geometry hold iconName
834	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1050	imFont imLocale inputMethod insecure int_bwidth intensityStyles
835	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1051	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
836	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1052	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
837	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1053	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
838	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1054	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
839	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1055	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
840	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1056	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
841	shade term_name title transparent transparent_all tripleclickwords	1057	secondaryScreen secondaryScroll selectstyle shade term_name title
842	utmpInhibit visualBell	1058	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1059	visualBell
843		1060
844	=cut	1061	=cut
845		1062
846	sub resource($$;$) {	1063	sub resource($$;$) {
847	my ($self, $name) = (shift, shift);	1064	my ($self, $name) = (shift, shift);
848	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1065	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
849	&urxvt::term::_resource	1066	&urxvt::term::_resource
850	}	1067	}
851		1068
		1069	=item $value = $term->x_resource ($pattern)
		1070
		1071	Returns the X-Resource for the given pattern, excluding the program or
		1072	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1073	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1074	resource with that pattern exists.
		1075
		1076	This method should only be called during the C<on_start> hook, as there is
		1077	only one resource database per display, and later invocations might return
		1078	the wrong resources.
		1079
852	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1080	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
853		1081
854	Adds a keymap translation exactly as specified via a resource. See the	1082	Adds a keymap translation exactly as specified via a resource. See the
855	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1083	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
856		1084
…		…
871	=item ($row, $col) = $term->selection_end ([$row, $col])	1099	=item ($row, $col) = $term->selection_end ([$row, $col])
872		1100
873	Return the current values of the selection mark, begin or end positions,	1101	Return the current values of the selection mark, begin or end positions,
874	and optionally set them to new values.	1102	and optionally set them to new values.
875		1103
		1104	=item $term->selection_make ($eventtime[, $rectangular])
		1105
		1106	Tries to make a selection as set by C<selection_beg> and
		1107	C<selection_end>. If C<$rectangular> is true (default: false), a
		1108	rectangular selection will be made. This is the prefered function to make
		1109	a selection.
		1110
876	=item $success = $term->selection_grab ($eventtime)	1111	=item $success = $term->selection_grab ($eventtime)
877		1112
878	Try to request the primary selection from the server (for example, as set	1113	Try to request the primary selection text from the server (for example, as
879	by the next method).	1114	set by the next method). No visual feedback will be given. This function
		1115	is mostly useful from within C<on_sel_grab> hooks.
880		1116
881	=item $oldtext = $term->selection ([$newtext])	1117	=item $oldtext = $term->selection ([$newtext])
882		1118
883	Return the current selection text and optionally replace it by C<$newtext>.	1119	Return the current selection text and optionally replace it by C<$newtext>.
884		1120
…		…
977	Convert the given locale-encoded octets into a perl string.	1213	Convert the given locale-encoded octets into a perl string.
978		1214
979	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1215	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
980		1216
981	XORs the rendition values in the given span with the provided value	1217	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	1218	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
983	to the selection.	1219	refresh hooks to provide effects similar to the selection.
984		1220
985	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1221	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
986		1222
987	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1223	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
988	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1224	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	1225	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
990	it instead.	1226	it instead. Both styles I<MUST NOT> contain font styles.
991		1227
992	=item $term->scr_bell	1228	=item $term->scr_bell
993		1229
994	Ring the bell!	1230	Ring the bell!
995		1231
…		…
1029		1265
1030	=item $windowid = $term->vt	1266	=item $windowid = $term->vt
1031		1267
1032	Return the window id of the terminal window.	1268	Return the window id of the terminal window.
1033		1269
		1270	=item $term->vt_emask_add ($x_event_mask)
		1271
		1272	Adds the specified events to the vt event mask. Useful e.g. when you want
		1273	to receive pointer events all the times:
		1274
		1275	$term->vt_emask_add (urxvt::PointerMotionMask);
		1276
1034	=item $window_width = $term->width	1277	=item $window_width = $term->width
1035		1278
1036	=item $window_height = $term->height	1279	=item $window_height = $term->height
1037		1280
1038	=item $font_width = $term->fwidth	1281	=item $font_width = $term->fwidth
…		…
1051		1294
1052	=item $max_scrollback = $term->saveLines	1295	=item $max_scrollback = $term->saveLines
1053		1296
1054	=item $nrow_plus_saveLines = $term->total_rows	1297	=item $nrow_plus_saveLines = $term->total_rows
1055		1298
1056	=item $lines_in_scrollback = $term->nsaved	1299	=item $topmost_scrollback_row = $term->top_row
1057		1300
1058	Return various integers describing terminal characteristics.	1301	Return various integers describing terminal characteristics.
1059		1302
		1303	=item $x_display = $term->display_id
		1304
		1305	Return the DISPLAY used by rxvt-unicode.
		1306
1060	=item $lc_ctype = $term->locale	1307	=item $lc_ctype = $term->locale
1061		1308
1062	Returns the LC_CTYPE category string used by this rxvt-unicode.	1309	Returns the LC_CTYPE category string used by this rxvt-unicode.
1063		1310
1064	=item $x_display = $term->display_id	1311	=item $env = $term->env
1065		1312
1066	Return the DISPLAY used by rxvt-unicode.	1313	Returns a copy of the environment in effect for the terminal as a hashref
		1314	similar to C<\%ENV>.
		1315
		1316	=cut
		1317
		1318	sub env {
		1319	if (my $env = $_[0]->_env) {
		1320	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1321	} else {
		1322	+{ %ENV }
		1323	}
		1324	}
1067		1325
1068	=item $modifiermask = $term->ModLevel3Mask	1326	=item $modifiermask = $term->ModLevel3Mask
1069		1327
1070	=item $modifiermask = $term->ModMetaMask	1328	=item $modifiermask = $term->ModMetaMask
1071		1329
…		…
1074	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1332	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.	1333	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1076		1334
1077	=item $view_start = $term->view_start ([$newvalue])	1335	=item $view_start = $term->view_start ([$newvalue])
1078		1336
1079	Returns the negative row number of the topmost line. Minimum value is	1337	Returns the row number of the topmost displayed line. Maximum value is
1080	C<0>, which displays the normal terminal contents. Larger values scroll	1338	C<0>, which displays the normal terminal contents. Lower values scroll
1081	this many lines into the scrollback buffer.	1339	this many lines into the scrollback buffer.
1082		1340
1083	=item $term->want_refresh	1341	=item $term->want_refresh
1084		1342
1085	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1343	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.	1422	Return the row number of the first/last row of the line, respectively.
1165		1423
1166	=item $offset = $line->offset_of ($row, $col)	1424	=item $offset = $line->offset_of ($row, $col)
1167		1425
1168	Returns the character offset of the given row\|col pair within the logical	1426	Returns the character offset of the given row\|col pair within the logical
1169	line.	1427	line. Works for rows outside the line, too, and returns corresponding
		1428	offsets outside the string.
1170		1429
1171	=item ($row, $col) = $line->coord_of ($offset)	1430	=item ($row, $col) = $line->coord_of ($offset)
1172		1431
1173	Translates a string offset into terminal coordinates again.	1432	Translates a string offset into terminal coordinates again.
1174		1433
…		…
1392	sub show {	1651	sub show {
1393	my ($self) = @_;	1652	my ($self) = @_;
1394		1653
1395	local $urxvt::popup::self = $self;	1654	local $urxvt::popup::self = $self;
1396		1655
		1656	my $env = $self->{term}->env;
		1657	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1658	delete $env->{LC_ALL};
1397	local $ENV{LC_ALL} = $self->{term}->locale;	1659	$env->{LC_CTYPE} = $self->{term}->locale;
1398		1660
1399	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1661	urxvt::term->new ($env, "popup",
		1662	"--perl-lib" => "", "--perl-ext-common" => "",
		1663	"-pty-fd" => -1, "-sl" => 0,
		1664	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1400	"--transient-for" => $self->{term}->parent,	1665	"--transient-for" => $self->{term}->parent,
1401	"-display" => $self->{term}->display_id,	1666	"-display" => $self->{term}->display_id,
1402	"-pe" => "urxvt-popup")	1667	"-pe" => "urxvt-popup")
1403	or die "unable to create popup window\n";	1668	or die "unable to create popup window\n";
1404	}	1669	}
1405		1670
1406	sub DESTROY {	1671	sub DESTROY {
1407	my ($self) = @_;	1672	my ($self) = @_;
1408		1673
1409	delete $self->{term}{_destroy}{$self};	1674	delete $self->{term}{_destroy}{$self};
1410	$self->{term}->ungrab;	1675	$self->{term}->ungrab;
1411	}	1676	}
		1677
		1678	=back
		1679
		1680	=cut
		1681
		1682	package urxvt::watcher;
		1683
		1684	@urxvt::timer::ISA = __PACKAGE__;
		1685	@urxvt::iow::ISA = __PACKAGE__;
		1686	@urxvt::pw::ISA = __PACKAGE__;
		1687	@urxvt::iw::ISA = __PACKAGE__;
1412		1688
1413	=head2 The C<urxvt::timer> Class	1689	=head2 The C<urxvt::timer> Class
1414		1690
1415	This class implements timer watchers/events. Time is represented as a	1691	This class implements timer watchers/events. Time is represented as a
1416	fractional number of seconds since the epoch. Example:	1692	fractional number of seconds since the epoch. Example:
…		…
1454	Start the timer.	1730	Start the timer.
1455		1731
1456	=item $timer = $timer->start ($tstamp)	1732	=item $timer = $timer->start ($tstamp)
1457		1733
1458	Set the event trigger time to C<$tstamp> and start the timer.	1734	Set the event trigger time to C<$tstamp> and start the timer.
		1735
		1736	=item $timer = $timer->after ($delay)
		1737
		1738	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1459		1739
1460	=item $timer = $timer->stop	1740	=item $timer = $timer->stop
1461		1741
1462	Stop the timer.	1742	Stop the timer.
1463		1743
…		…
1523		1803
1524	=item == 0 - fatal messages	1804	=item == 0 - fatal messages
1525		1805
1526	=item >= 3 - script loading and management	1806	=item >= 3 - script loading and management
1527		1807
1528	=item >=10 - all events received	1808	=item >=10 - all called hooks
		1809
		1810	=item >=11 - hook reutrn values
1529		1811
1530	=back	1812	=back
1531		1813
1532	=head1 AUTHOR	1814	=head1 AUTHOR
1533		1815

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.76 by root, Tue Jan 10 19:46:28 2006 UTC vs. Revision 1.113 by root, Fri Jan 20 10:27:08 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.76 by root, Tue Jan 10 19:46:28 2006 UTC vs.
Revision 1.113 by root, Fri Jan 20 10:27:08 2006 UTC