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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC vs.
Revision 1.112 by root, Thu Jan 19 21:02:06 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.
		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	};
70		116
71	=item searchable-scrollback<hotkey> (enabled by default)	117	=item searchable-scrollback<hotkey> (enabled by default)
72		118
73	Adds regex search functionality to the scrollback buffer, triggered	119	Adds regex search functionality to the scrollback buffer, triggered
74	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
75	input/output is suspended.	121	input/output is suspended and a regex is displayed at the bottom of the
		122	screen.
76		123
77	C</> starts an incremental regex search, C<n> searches further, C<p> or	124	Inputting characters appends them to the regex and continues incremental
78	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>
79	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
80	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.
81		131
82	=item digital-clock	132	=item selection-autotransform
83		133
84	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.
85		166
86	=item mark-urls	167	=item mark-urls
87		168
88	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
89		181
90	=item block-graphics-to-ascii	182	=item block-graphics-to-ascii
91		183
92	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,
93	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
94	similar-looking ascii character.	186	similar-looking ascii character.
95		187
		188	=item digital-clock
		189
		190	Displays a digital clock using the built-in overlay.
		191
96	=item example-refresh-hooks	192	=item example-refresh-hooks
97		193
98	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
99	window. Illustrates overwriting the refresh callbacks to create your own	195	window. Illustrates overwriting the refresh callbacks to create your own
100	overlays or changes.	196	overlays or changes.
101		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
102	=back	227	=back
		228
		229	=head1 API DOCUMENTATION
103		230
104	=head2 General API Considerations	231	=head2 General API Considerations
105		232
106	All objects (such as terminals, time watchers etc.) are typical	233	All objects (such as terminals, time watchers etc.) are typical
107	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
…		…
120	=over 4	247	=over 4
121		248
122	=item $text	249	=item $text
123		250
124	Rxvt-unicodes special way of encoding text, where one "unicode" character	251	Rxvt-unicodes special way of encoding text, where one "unicode" character
125	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.
126		253
127	=item $string	254	=item $string
128		255
129	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
130	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
…		…
176	called whenever the relevant event happens.	303	called whenever the relevant event happens.
177		304
178	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
179	the in the C<Extension Objects> section.	306	the in the C<Extension Objects> section.
180		307
181	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
182	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
183	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.
184		311
185	I<< When in doubt, return a false value (preferably C<()>). >>	312	I<< When in doubt, return a false value (preferably C<()>). >>
186		313
187	=over 4	314	=over 4
188		315
189	=item on_init $term	316	=item on_init $term
190		317
191	Called after a new terminal object has been initialized, but before	318	Called after a new terminal object has been initialized, but before
192	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
193	call or deliver senseless data, as terminal size and other characteristics	320	call or deliver senseless data, as terminal size and other characteristics
194	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
195	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	returning to the mainloop.
196		329
197	=item on_reset $term	330	=item on_reset $term
198		331
199	Called after the screen is "reset" for any reason, such as resizing or	332	Called after the screen is "reset" for any reason, such as resizing or
200	control sequences. Here is where you can react on changes to size-related	333	control sequences. Here is where you can react on changes to size-related
201	variables.	334	variables.
202		335
203	=item on_start $term	336	=item on_child_start $term, $pid
204		337
205	Called at the very end of initialisation of a new terminal, just before	338	Called just after the child process has been C<fork>ed.
206	returning to the mainloop.	339
		340	=item on_child_exit $term, $status
		341
		342	Called just after the child process has exited. C<$status> is the status
		343	from C<waitpid>.
207		344
208	=item on_sel_make $term, $eventtime	345	=item on_sel_make $term, $eventtime
209		346
210	Called whenever a selection has been made by the user, but before the	347	Called whenever a selection has been made by the user, but before the
211	selection text is copied, so changes to the beginning, end or type of the	348	selection text is copied, so changes to the beginning, end or type of the
…		…
225	=item on_sel_extend $term	362	=item on_sel_extend $term
226		363
227	Called whenever the user tries to extend the selection (e.g. with a double	364	Called whenever the user tries to extend the selection (e.g. with a double
228	click) and is either supposed to return false (normal operation), or	365	click) and is either supposed to return false (normal operation), or
229	should extend the selection itelf and return true to suppress the built-in	366	should extend the selection itelf and return true to suppress the built-in
230	processing.	367	processing. This can happen multiple times, as long as the callback
		368	returns true, it will be called on every further click by the user and is
		369	supposed to enlarge the selection more and more, if possible.
231		370
232	See the F<selection> example extension.	371	See the F<selection> example extension.
233		372
234	=item on_view_change $term, $offset	373	=item on_view_change $term, $offset
235		374
…		…
302		441
303	Called whenever the user presses a key combination that has a	442	Called whenever the user presses a key combination that has a
304	C<perl:string> action bound to it (see description of the B<keysym>	443	C<perl:string> action bound to it (see description of the B<keysym>
305	resource in the @@RXVT_NAME@@(1) manpage).	444	resource in the @@RXVT_NAME@@(1) manpage).
306		445
		446	=item on_x_event $term, $event
		447
		448	Called on every X event received on the vt window (and possibly other
		449	windows). Should only be used as a last resort. Most event structure
		450	members are not passed.
		451
307	=item on_focus_in $term	452	=item on_focus_in $term
308		453
309	Called whenever the window gets the keyboard focus, before rxvt-unicode	454	Called whenever the window gets the keyboard focus, before rxvt-unicode
310	does focus in processing.	455	does focus in processing.
311		456
312	=item on_focus_out $term	457	=item on_focus_out $term
313		458
314	Called wheneever the window loses keyboard focus, before rxvt-unicode does	459	Called wheneever the window loses keyboard focus, before rxvt-unicode does
315	focus out processing.	460	focus out processing.
		461
		462	=item on_configure_notify $term, $event
316		463
317	=item on_key_press $term, $event, $keysym, $octets	464	=item on_key_press $term, $event, $keysym, $octets
318		465
319	=item on_key_release $term, $event, $keysym	466	=item on_key_release $term, $event, $keysym
320		467
…		…
337		484
338	C<on_key_press> additionally receives the string rxvt-unicode would	485	C<on_key_press> additionally receives the string rxvt-unicode would
339	output, if any, in locale-specific encoding.	486	output, if any, in locale-specific encoding.
340		487
341	subwindow.	488	subwindow.
342
343	=back
344
345	=head2 Variables in the C<urxvt> Package
346
347	=over 4
348
349	=item $urxvt::TERM
350
351	The current terminal. This variable stores the current C<urxvt::term>
352	object, whenever a callback/hook is executing.
353
354	=back
355
356	=head2 Functions in the C<urxvt> Package
357
358	=over 4
359
360	=item $term = new urxvt [arg...]
361
362	Creates a new terminal, very similar as if you had started it with
363	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
364	if the new instance couldn't be created. Returns C<undef> if the new
365	instance didn't initialise perl, and the terminal object otherwise. The
366	C<init> and C<start> hooks will be called during the call.
367
368	=item urxvt::fatal $errormessage
369
370	Fatally aborts execution with the given error message. Avoid at all
371	costs! The only time this is acceptable is when the terminal process
372	starts up.
373
374	=item urxvt::warn $string
375
376	Calls C<rxvt_warn> with the given string which should not include a
377	newline. The module also overwrites the C<warn> builtin with a function
378	that calls this function.
379
380	Using this function has the advantage that its output ends up in the
381	correct place, e.g. on stderr of the connecting urxvtc client.
382
383	=item $is_safe = urxvt::safe
384
385	Returns true when it is safe to do potentially unsafe things, such as
386	evaluating perl code specified by the user. This is true when urxvt was
387	started setuid or setgid.
388
389	=item $time = urxvt::NOW
390
391	Returns the "current time" (as per the event loop).
392
393	=item urxvt::CurrentTime
394
395	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
396	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
397	Button4Mask, Button5Mask, AnyModifier
398
399	Various constants for use in X calls and event processing.
400
401	=back
402
403	=head2 RENDITION
404
405	Rendition bitsets contain information about colour, font, font styles and
406	similar information for each screen cell.
407
408	The following "macros" deal with changes in rendition sets. You should
409	never just create a bitset, you should always modify an existing one,
410	as they contain important information required for correct operation of
411	rxvt-unicode.
412
413	=over 4
414
415	=item $rend = urxvt::DEFAULT_RSTYLE
416
417	Returns the default rendition, as used when the terminal is starting up or
418	being reset. Useful as a base to start when creating renditions.
419
420	=item $rend = urxvt::OVERLAY_RSTYLE
421
422	Return the rendition mask used for overlays by default.
423
424	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
425
426	Return the bit that enabled bold, italic, blink, reverse-video and
427	underline, respectively. To enable such a style, just logically OR it into
428	the bitset.
429
430	=item $foreground = urxvt::GET_BASEFG $rend
431
432	=item $background = urxvt::GET_BASEBG $rend
433
434	Return the foreground/background colour index, respectively.
435
436	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
437
438	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
439
440	Replace the foreground/background colour in the rendition mask with the
441	specified one.
442
443	=item $value = urxvt::GET_CUSTOM ($rend)
444
445	Return the "custom" value: Every rendition has 5 bits for use by
446	extensions. They can be set and changed as you like and are initially
447	zero.
448
449	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
450
451	Change the custom value.
452		489
453	=back	490	=back
454		491
455	=cut	492	=cut
456		493
…		…
471	our $LIBDIR;	508	our $LIBDIR;
472	our $RESNAME;	509	our $RESNAME;
473	our $RESCLASS;	510	our $RESCLASS;
474	our $RXVTNAME;	511	our $RXVTNAME;
475		512
		513	=head2 Variables in the C<urxvt> Package
		514
		515	=over 4
		516
		517	=item $urxvt::LIBDIR
		518
		519	The rxvt-unicode library directory, where, among other things, the perl
		520	modules and scripts are stored.
		521
		522	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		523
		524	The resource class and name rxvt-unicode uses to look up X resources.
		525
		526	=item $urxvt::RXVTNAME
		527
		528	The basename of the installed binaries, usually C<urxvt>.
		529
		530	=item $urxvt::TERM
		531
		532	The current terminal. This variable stores the current C<urxvt::term>
		533	object, whenever a callback/hook is executing.
		534
		535	=back
		536
		537	=head2 Functions in the C<urxvt> Package
		538
		539	=over 4
		540
		541	=item urxvt::fatal $errormessage
		542
		543	Fatally aborts execution with the given error message. Avoid at all
		544	costs! The only time this is acceptable is when the terminal process
		545	starts up.
		546
		547	=item urxvt::warn $string
		548
		549	Calls C<rxvt_warn> with the given string which should not include a
		550	newline. The module also overwrites the C<warn> builtin with a function
		551	that calls this function.
		552
		553	Using this function has the advantage that its output ends up in the
		554	correct place, e.g. on stderr of the connecting urxvtc client.
		555
		556	Messages have a size limit of 1023 bytes currently.
		557
		558	=item $time = urxvt::NOW
		559
		560	Returns the "current time" (as per the event loop).
		561
		562	=item urxvt::CurrentTime
		563
		564	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		565	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		566	Button4Mask, Button5Mask, AnyModifier
		567
		568	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		569	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		570	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		571	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		572	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		573	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		574	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		575
		576	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		577	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		578	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		579	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		580	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		581	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		582	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		583
		584	Various constants for use in X calls and event processing.
		585
		586	=back
		587
		588	=head2 RENDITION
		589
		590	Rendition bitsets contain information about colour, font, font styles and
		591	similar information for each screen cell.
		592
		593	The following "macros" deal with changes in rendition sets. You should
		594	never just create a bitset, you should always modify an existing one,
		595	as they contain important information required for correct operation of
		596	rxvt-unicode.
		597
		598	=over 4
		599
		600	=item $rend = urxvt::DEFAULT_RSTYLE
		601
		602	Returns the default rendition, as used when the terminal is starting up or
		603	being reset. Useful as a base to start when creating renditions.
		604
		605	=item $rend = urxvt::OVERLAY_RSTYLE
		606
		607	Return the rendition mask used for overlays by default.
		608
		609	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		610
		611	Return the bit that enabled bold, italic, blink, reverse-video and
		612	underline, respectively. To enable such a style, just logically OR it into
		613	the bitset.
		614
		615	=item $foreground = urxvt::GET_BASEFG $rend
		616
		617	=item $background = urxvt::GET_BASEBG $rend
		618
		619	Return the foreground/background colour index, respectively.
		620
		621	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		622
		623	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		624
		625	Replace the foreground/background colour in the rendition mask with the
		626	specified one.
		627
		628	=item $value = urxvt::GET_CUSTOM $rend
		629
		630	Return the "custom" value: Every rendition has 5 bits for use by
		631	extensions. They can be set and changed as you like and are initially
		632	zero.
		633
		634	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		635
		636	Change the custom value.
		637
		638	=back
		639
		640	=cut
		641
476	BEGIN {	642	BEGIN {
477	urxvt->bootstrap;
478
479	# overwrite perl's warn	643	# overwrite perl's warn
480	*CORE::GLOBAL::warn = sub {	644	*CORE::GLOBAL::warn = sub {
481	my $msg = join "", @_;	645	my $msg = join "", @_;
482	$msg .= "\n"	646	$msg .= "\n"
483	unless $msg =~ /\n$/;	647	unless $msg =~ /\n$/;
484	urxvt::warn ($msg);	648	urxvt::warn ($msg);
485	};	649	};
486
487	delete $ENV{IFS};
488	delete $ENV{CDPATH};
489	delete $ENV{BASH_ENV};
490	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
491	}	650	}
492		651
493	my @hook_count;
494	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	652	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
495		653
496	sub verbose {	654	sub verbose {
497	my ($level, $msg) = @_;	655	my ($level, $msg) = @_;
498	warn "$msg\n" if $level <= $verbosity;	656	warn "$msg\n" if $level <= $verbosity;
499	}	657	}
500		658
501	my $extension_pkg = "extension0000";
502	my %extension_pkg;	659	my %extension_pkg;
503		660
504	# load a single script into its own package, once only	661	# load a single script into its own package, once only
505	sub extension_package($) {	662	sub extension_package($) {
506	my ($path) = @_;	663	my ($path) = @_;
507		664
		665	no strict 'refs';
		666
508	$extension_pkg{$path} \|\|= do {	667	$extension_pkg{$path} \|\|= do {
509	my $pkg = "urxvt::" . ($extension_pkg++);	668	$path =~ /([^\/\\]+)$/;
		669	my $pkg = $1;
		670	$pkg =~ s/[^[:word:]]/_/g;
		671	$pkg = "urxvt::ext::$pkg";
510		672
511	verbose 3, "loading extension '$path' into package '$pkg'";	673	verbose 3, "loading extension '$path' into package '$pkg'";
512		674
513	open my $fh, "<:raw", $path	675	open my $fh, "<:raw", $path
514	or die "$path: $!";	676	or die "$path: $!";
515		677
		678	@{"$pkg\::ISA"} = urxvt::term::extension::;
		679
516	my $source = untaint	680	my $source =
517	"package $pkg; use strict; use utf8;\n"	681	"package $pkg; use strict; use utf8;\n"
518	. "use base urxvt::term::extension::;\n"
519	. "#line 1 \"$path\"\n{\n"	682	. "#line 1 \"$path\"\n{\n"
520	. (do { local $/; <$fh> })	683	. (do { local $/; <$fh> })
521	. "\n};\n1";	684	. "\n};\n1";
522		685
523	eval $source	686	eval $source
…		…
572	if $verbosity >= 10;	735	if $verbosity >= 10;
573		736
574	keys %$cb;	737	keys %$cb;
575		738
576	while (my ($pkg, $cb) = each %$cb) {	739	while (my ($pkg, $cb) = each %$cb) {
577	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	740	$retval \|\|= eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
578	and last;
579		741
580	if ($@) {	742	if ($@) {
581	$TERM->ungrab; # better to lose the grab than the session	743	$TERM->ungrab; # better to lose the grab than the session
582	warn $@;	744	warn $@;
583	}	745	}
584	}	746	}
		747
		748	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		749	if $verbosity >= 11;
585	}	750	}
586		751
587	if ($htype == 1) { # DESTROY	752	if ($htype == 1) { # DESTROY
588	if (my $hook = delete $TERM->{_hook}) {
589	for my $htype (0..$#$hook) {
590	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
591	or set_should_invoke $htype, 0;
592	}
593	}
594
595	# clear package objects	753	# clear package objects
596	%$_ = () for values %{ $TERM->{_pkg} };	754	%$_ = () for values %{ $TERM->{_pkg} };
597		755
598	# clear package	756	# clear package
599	%$TERM = ();	757	%$TERM = ();
…		…
613	while (my ($name, $cb) = each %hook) {	771	while (my ($name, $cb) = each %hook) {
614	my $htype = $HOOKTYPE{uc $name};	772	my $htype = $HOOKTYPE{uc $name};
615	defined $htype	773	defined $htype
616	or Carp::croak "unsupported hook type '$name'";	774	or Carp::croak "unsupported hook type '$name'";
617		775
		776	$self->set_should_invoke ($htype, +1)
618	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	777	unless exists $self->{term}{_hook}[$htype]{$pkg};
619	$hook_count[$htype]++
620	or urxvt::set_should_invoke $htype, 1;
621	}
622		778
623	$self->{term}{_hook}[$htype]{$pkg} = $cb;	779	$self->{term}{_hook}[$htype]{$pkg} = $cb;
624	}	780	}
625	}	781	}
626		782
…		…
631	for my $name (@hook) {	787	for my $name (@hook) {
632	my $htype = $HOOKTYPE{uc $name};	788	my $htype = $HOOKTYPE{uc $name};
633	defined $htype	789	defined $htype
634	or Carp::croak "unsupported hook type '$name'";	790	or Carp::croak "unsupported hook type '$name'";
635		791
		792	$self->set_should_invoke ($htype, -1)
636	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	793	if delete $self->{term}{_hook}[$htype]{$pkg};
637	--$hook_count[$htype]
638	or urxvt::set_should_invoke $htype, 0;
639	}
640	}	794	}
641	}	795	}
642		796
643	our $AUTOLOAD;	797	our $AUTOLOAD;
644		798
…		…
675		829
676	=head2 The C<urxvt::anyevent> Class	830	=head2 The C<urxvt::anyevent> Class
677		831
678	The sole purpose of this class is to deliver an interface to the	832	The sole purpose of this class is to deliver an interface to the
679	C<AnyEvent> module - any module using it will work inside urxvt without	833	C<AnyEvent> module - any module using it will work inside urxvt without
680	further work. The only exception is that you cannot wait on condition	834	further programming. The only exception is that you cannot wait on
681	variables, but non-blocking condvar use is ok. What this means is that you	835	condition variables, but non-blocking condvar use is ok. What this means
682	cannot use blocking APIs, but the non-blocking variant should work.	836	is that you cannot use blocking APIs, but the non-blocking variant should
		837	work.
683		838
684	=cut	839	=cut
685		840
686	our $VERSION = 1;	841	our $VERSION = 1;
687		842
…		…
764	$proxy->enable ($name => $ref);	919	$proxy->enable ($name => $ref);
765	}	920	}
766	}	921	}
767	}	922	}
768		923
		924	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		925
		926	Creates a new terminal, very similar as if you had started it with system
		927	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		928	hash which defines the environment of the new terminal.
		929
		930	Croaks (and probably outputs an error message) if the new instance
		931	couldn't be created. Returns C<undef> if the new instance didn't
		932	initialise perl, and the terminal object otherwise. The C<init> and
		933	C<start> hooks will be called during this call.
		934
		935	=cut
		936
		937	sub new {
		938	my ($class, $env, @args) = @_;
		939
		940	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		941	}
		942
769	=item $term->destroy	943	=item $term->destroy
770		944
771	Destroy the terminal object (close the window, free resources etc.).	945	Destroy the terminal object (close the window, free resources
		946	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		947	watchers (timers, io watchers) are still active.
		948
		949	=item $term->exec_async ($cmd[, @args])
		950
		951	Works like the combination of the C<fork>/C<exec> builtins, which executes
		952	("starts") programs in the background. This function takes care of setting
		953	the user environment before exec'ing the command (e.g. C<PATH>) and should
		954	be preferred over explicit calls to C<exec> or C<system>.
		955
		956	Returns the pid of the subprocess or C<undef> on error.
		957
		958	=cut
		959
		960	sub exec_async {
		961	my $self = shift;
		962
		963	my $pid = fork;
		964
		965	return $pid
		966	if !defined $pid or $pid;
		967
		968	%ENV = %{ $self->env };
		969
		970	exec @_;
		971	urxvt::_exit 255;
		972	}
772		973
773	=item $isset = $term->option ($optval[, $set])	974	=item $isset = $term->option ($optval[, $set])
774		975
775	Returns true if the option specified by C<$optval> is enabled, and	976	Returns true if the option specified by C<$optval> is enabled, and
776	optionally change it. All option values are stored by name in the hash	977	optionally change it. All option values are stored by name in the hash
…		…
779	Here is a a likely non-exhaustive list of option names, please see the	980	Here is a a likely non-exhaustive list of option names, please see the
780	source file F</src/optinc.h> to see the actual list:	981	source file F</src/optinc.h> to see the actual list:
781		982
782	borderLess console cursorBlink cursorUnderline hold iconic insecure	983	borderLess console cursorBlink cursorUnderline hold iconic insecure
783	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	984	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
784	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	985	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
785	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	986	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
786	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	987	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
787	tripleclickwords utmpInhibit visualBell	988	transparent tripleclickwords utmpInhibit visualBell
788		989
789	=item $value = $term->resource ($name[, $newval])	990	=item $value = $term->resource ($name[, $newval])
790		991
791	Returns the current resource value associated with a given name and	992	Returns the current resource value associated with a given name and
792	optionally sets a new value. Setting values is most useful in the C<init>	993	optionally sets a new value. Setting values is most useful in the C<init>
…		…
809		1010
810	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1011	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
811	borderLess color cursorBlink cursorUnderline cutchars delete_key	1012	borderLess color cursorBlink cursorUnderline cutchars delete_key
812	display_name embed ext_bwidth fade font geometry hold iconName	1013	display_name embed ext_bwidth fade font geometry hold iconName
813	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1014	imFont imLocale inputMethod insecure int_bwidth intensityStyles
814	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1015	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
815	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1016	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
816	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1017	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
817	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1018	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
818	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1019	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
819	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1020	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
820	shade term_name title transparent transparent_all tripleclickwords	1021	secondaryScreen secondaryScroll selectstyle shade term_name title
821	utmpInhibit visualBell	1022	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1023	visualBell
822		1024
823	=cut	1025	=cut
824		1026
825	sub resource($$;$) {	1027	sub resource($$;$) {
826	my ($self, $name) = (shift, shift);	1028	my ($self, $name) = (shift, shift);
827	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1029	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
828	&urxvt::term::_resource	1030	&urxvt::term::_resource
829	}	1031	}
830		1032
		1033	=item $value = $term->x_resource ($pattern)
		1034
		1035	Returns the X-Resource for the given pattern, excluding the program or
		1036	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1037	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1038	resource with that pattern exists.
		1039
		1040	This method should only be called during the C<on_start> hook, as there is
		1041	only one resource database per display, and later invocations might return
		1042	the wrong resources.
		1043
831	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1044	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
832		1045
833	Adds a keymap translation exactly as specified via a resource. See the	1046	Adds a keymap translation exactly as specified via a resource. See the
834	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1047	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
835		1048
…		…
850	=item ($row, $col) = $term->selection_end ([$row, $col])	1063	=item ($row, $col) = $term->selection_end ([$row, $col])
851		1064
852	Return the current values of the selection mark, begin or end positions,	1065	Return the current values of the selection mark, begin or end positions,
853	and optionally set them to new values.	1066	and optionally set them to new values.
854		1067
		1068	=item $term->selection_make ($eventtime[, $rectangular])
		1069
		1070	Tries to make a selection as set by C<selection_beg> and
		1071	C<selection_end>. If C<$rectangular> is true (default: false), a
		1072	rectangular selection will be made. This is the prefered function to make
		1073	a selection.
		1074
855	=item $success = $term->selection_grab ($eventtime)	1075	=item $success = $term->selection_grab ($eventtime)
856		1076
857	Try to request the primary selection from the server (for example, as set	1077	Try to request the primary selection text from the server (for example, as
858	by the next method).	1078	set by the next method). No visual feedback will be given. This function
		1079	is mostly useful from within C<on_sel_grab> hooks.
859		1080
860	=item $oldtext = $term->selection ([$newtext])	1081	=item $oldtext = $term->selection ([$newtext])
861		1082
862	Return the current selection text and optionally replace it by C<$newtext>.	1083	Return the current selection text and optionally replace it by C<$newtext>.
863		1084
…		…
956	Convert the given locale-encoded octets into a perl string.	1177	Convert the given locale-encoded octets into a perl string.
957		1178
958	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1179	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
959		1180
960	XORs the rendition values in the given span with the provided value	1181	XORs the rendition values in the given span with the provided value
961	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1182	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
962	to the selection.	1183	refresh hooks to provide effects similar to the selection.
963		1184
964	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1185	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
965		1186
966	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1187	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
967	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1188	whitespace will additionally be xored with the C<$rstyle2>, which defaults
968	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines	1189	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
969	it instead.	1190	it instead. Both styles I<MUST NOT> contain font styles.
970		1191
971	=item $term->scr_bell	1192	=item $term->scr_bell
972		1193
973	Ring the bell!	1194	Ring the bell!
974		1195
…		…
1008		1229
1009	=item $windowid = $term->vt	1230	=item $windowid = $term->vt
1010		1231
1011	Return the window id of the terminal window.	1232	Return the window id of the terminal window.
1012		1233
		1234	=item $term->vt_emask_add ($x_event_mask)
		1235
		1236	Adds the specified events to the vt event mask. Useful e.g. when you want
		1237	to receive pointer events all the times:
		1238
		1239	$term->vt_emask_add (urxvt::PointerMotionMask);
		1240
1013	=item $window_width = $term->width	1241	=item $window_width = $term->width
1014		1242
1015	=item $window_height = $term->height	1243	=item $window_height = $term->height
1016		1244
1017	=item $font_width = $term->fwidth	1245	=item $font_width = $term->fwidth
…		…
1030		1258
1031	=item $max_scrollback = $term->saveLines	1259	=item $max_scrollback = $term->saveLines
1032		1260
1033	=item $nrow_plus_saveLines = $term->total_rows	1261	=item $nrow_plus_saveLines = $term->total_rows
1034		1262
1035	=item $lines_in_scrollback = $term->nsaved	1263	=item $topmost_scrollback_row = $term->top_row
1036		1264
1037	Return various integers describing terminal characteristics.	1265	Return various integers describing terminal characteristics.
1038		1266
		1267	=item $x_display = $term->display_id
		1268
		1269	Return the DISPLAY used by rxvt-unicode.
		1270
1039	=item $lc_ctype = $term->locale	1271	=item $lc_ctype = $term->locale
1040		1272
1041	Returns the LC_CTYPE category string used by this rxvt-unicode.	1273	Returns the LC_CTYPE category string used by this rxvt-unicode.
1042		1274
1043	=item $x_display = $term->display_id	1275	=item $env = $term->env
1044		1276
1045	Return the DISPLAY used by rxvt-unicode.	1277	Returns a copy of the environment in effect for the terminal as a hashref
		1278	similar to C<\%ENV>.
		1279
		1280	=cut
		1281
		1282	sub env {
		1283	if (my $env = $_[0]->_env) {
		1284	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1285	} else {
		1286	+{ %ENV }
		1287	}
		1288	}
1046		1289
1047	=item $modifiermask = $term->ModLevel3Mask	1290	=item $modifiermask = $term->ModLevel3Mask
1048		1291
1049	=item $modifiermask = $term->ModMetaMask	1292	=item $modifiermask = $term->ModMetaMask
1050		1293
…		…
1053	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1296	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1054	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1297	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1055		1298
1056	=item $view_start = $term->view_start ([$newvalue])	1299	=item $view_start = $term->view_start ([$newvalue])
1057		1300
1058	Returns the negative row number of the topmost line. Minimum value is	1301	Returns the row number of the topmost displayed line. Maximum value is
1059	C<0>, which displays the normal terminal contents. Larger values scroll	1302	C<0>, which displays the normal terminal contents. Lower values scroll
1060	this many lines into the scrollback buffer.	1303	this many lines into the scrollback buffer.
1061		1304
1062	=item $term->want_refresh	1305	=item $term->want_refresh
1063		1306
1064	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1307	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1143	Return the row number of the first/last row of the line, respectively.	1386	Return the row number of the first/last row of the line, respectively.
1144		1387
1145	=item $offset = $line->offset_of ($row, $col)	1388	=item $offset = $line->offset_of ($row, $col)
1146		1389
1147	Returns the character offset of the given row\|col pair within the logical	1390	Returns the character offset of the given row\|col pair within the logical
1148	line.	1391	line. Works for rows outside the line, too, and returns corresponding
		1392	offsets outside the string.
1149		1393
1150	=item ($row, $col) = $line->coord_of ($offset)	1394	=item ($row, $col) = $line->coord_of ($offset)
1151		1395
1152	Translates a string offset into terminal coordinates again.	1396	Translates a string offset into terminal coordinates again.
1153		1397
…		…
1290	$item->{render} \|\|= sub { $_[0]{text} };	1534	$item->{render} \|\|= sub { $_[0]{text} };
1291		1535
1292	push @{ $self->{item} }, $item;	1536	push @{ $self->{item} }, $item;
1293	}	1537	}
1294		1538
		1539	=item $popup->add_title ($title)
		1540
		1541	Adds a non-clickable title to the popup.
		1542
		1543	=cut
		1544
		1545	sub add_title {
		1546	my ($self, $title) = @_;
		1547
		1548	$self->add_item ({
		1549	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1550	text => $title,
		1551	activate => sub { },
		1552	});
		1553	}
		1554
		1555	=item $popup->add_separator ([$sepchr])
		1556
		1557	Creates a separator, optionally using the character given as C<$sepchr>.
		1558
		1559	=cut
		1560
1295	sub add_separator {	1561	sub add_separator {
1296	my ($self, $sep) = @_;	1562	my ($self, $sep) = @_;
1297		1563
1298	$sep \|\|= "=";	1564	$sep \|\|= "=";
1299		1565
…		…
1303	render => sub { $sep x $self->{term}->ncol },	1569	render => sub { $sep x $self->{term}->ncol },
1304	activate => sub { },	1570	activate => sub { },
1305	});	1571	});
1306	}	1572	}
1307		1573
1308	sub add_title {	1574	=item $popup->add_button ($text, $cb)
1309	my ($self, $title) = @_;
1310		1575
1311	$self->add_item ({	1576	Adds a clickable button to the popup. C<$cb> is called whenever it is
1312	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1577	selected.
1313	text => $title,	1578
1314	activate => sub { },	1579	=cut
1315	});
1316	}
1317		1580
1318	sub add_button {	1581	sub add_button {
1319	my ($self, $text, $cb) = @_;	1582	my ($self, $text, $cb) = @_;
1320		1583
1321	$self->add_item ({ type => "button", text => $text, activate => $cb});	1584	$self->add_item ({ type => "button", text => $text, activate => $cb});
1322	}	1585	}
		1586
		1587	=item $popup->add_toggle ($text, $cb, $initial_value)
		1588
		1589	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1590	whenever it gets toggled, with a boolean indicating its value as its first
		1591	argument.
		1592
		1593	=cut
1323		1594
1324	sub add_toggle {	1595	sub add_toggle {
1325	my ($self, $text, $cb, $value) = @_;	1596	my ($self, $text, $cb, $value) = @_;
1326		1597
1327	my $item; $item = {	1598	my $item; $item = {
1328	type => "button",	1599	type => "button",
1329	text => " $text",	1600	text => " $text",
1330	value => $value,	1601	value => $value,
1331	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1602	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1332	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1603	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1333	};	1604	};
1334		1605
1335	$self->add_item ($item);	1606	$self->add_item ($item);
1336	}	1607	}
		1608
		1609	=item $popup->show
		1610
		1611	Displays the popup (which is initially hidden).
		1612
		1613	=cut
1337		1614
1338	sub show {	1615	sub show {
1339	my ($self) = @_;	1616	my ($self) = @_;
1340		1617
1341	local $urxvt::popup::self = $self;	1618	local $urxvt::popup::self = $self;
1342		1619
		1620	my $env = $self->{term}->env;
		1621	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1622	delete $env->{LC_ALL};
1343	local $ENV{LC_ALL} = $self->{term}->locale;	1623	$env->{LC_CTYPE} = $self->{term}->locale;
1344		1624
1345	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1625	urxvt::term->new ($env, "popup",
		1626	"--perl-lib" => "", "--perl-ext-common" => "",
		1627	"-pty-fd" => -1, "-sl" => 0,
		1628	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1346	"--transient-for" => $self->{term}->parent,	1629	"--transient-for" => $self->{term}->parent,
1347	"-display" => $self->{term}->display_id,	1630	"-display" => $self->{term}->display_id,
1348	"-pe" => "urxvt-popup")	1631	"-pe" => "urxvt-popup")
1349	or die "unable to create popup window\n";	1632	or die "unable to create popup window\n";
1350	}	1633	}
1351		1634
1352	sub DESTROY {	1635	sub DESTROY {
1353	my ($self) = @_;	1636	my ($self) = @_;
1354		1637
1355	delete $self->{term}{_destroy}{$self};	1638	delete $self->{term}{_destroy}{$self};
1356	$self->{term}->ungrab;	1639	$self->{term}->ungrab;
1357	}	1640	}
		1641
		1642	=back
1358		1643
1359	=head2 The C<urxvt::timer> Class	1644	=head2 The C<urxvt::timer> Class
1360		1645
1361	This class implements timer watchers/events. Time is represented as a	1646	This class implements timer watchers/events. Time is represented as a
1362	fractional number of seconds since the epoch. Example:	1647	fractional number of seconds since the epoch. Example:
…		…
1400	Start the timer.	1685	Start the timer.
1401		1686
1402	=item $timer = $timer->start ($tstamp)	1687	=item $timer = $timer->start ($tstamp)
1403		1688
1404	Set the event trigger time to C<$tstamp> and start the timer.	1689	Set the event trigger time to C<$tstamp> and start the timer.
		1690
		1691	=item $timer = $timer->after ($delay)
		1692
		1693	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1405		1694
1406	=item $timer = $timer->stop	1695	=item $timer = $timer->stop
1407		1696
1408	Stop the timer.	1697	Stop the timer.
1409		1698
…		…
1469		1758
1470	=item == 0 - fatal messages	1759	=item == 0 - fatal messages
1471		1760
1472	=item >= 3 - script loading and management	1761	=item >= 3 - script loading and management
1473		1762
1474	=item >=10 - all events received	1763	=item >=10 - all called hooks
		1764
		1765	=item >=11 - hook reutrn values
1475		1766
1476	=back	1767	=back
1477		1768
1478	=head1 AUTHOR	1769	=head1 AUTHOR
1479		1770

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC vs. Revision 1.112 by root, Thu Jan 19 21:02:06 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC vs.
Revision 1.112 by root, Thu Jan 19 21:02:06 2006 UTC