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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.70 by root, Mon Jan 9 23:00:07 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.
70		97
		98	Other extensions can extend this popup menu by pushing a code reference
		99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		100	popup is displayed.
		101
		102	It's sole argument is the popup menu, which can be modified. The selection
		103	is in C<$_>, which can be used to decide wether to add something or not.
		104	It should either return nothing or a string and a code reference. The
		105	string will be used as button text and the code reference will be called
		106	when the button gets activated and should transform C<$_>.
		107
		108	The following will add an entry C<a to b> that transforms all C<a>s in
		109	the selection to C<b>s, but only if the selection currently contains any
		110	C<a>s:
		111
		112	push @{ $self->{term}{selection_popup_hook} }, sub {
		113	/a/ ? ("a to be" => sub { s/a/b/g }
		114	: ()
		115	};
		116
71	=item searchable-scrollback (enabled by default)	117	=item searchable-scrollback<hotkey> (enabled by default)
72		118
73	Adds regex search functionality to the scrollback buffer, triggered by a	119	Adds regex search functionality to the scrollback buffer, triggered
74	hotkey (default: C<M-s>). When in search mode, terminal input/output is	120	by a hotkey (default: C<M-s>). While in search mode, normal terminal
75	suspended, C</> starts an incremental regex search, C<n> searches further,	121	input/output is suspended and a regex is displayed at the bottom of the
76	C<p> jumps to the previous match. C<enter> leaves search mode at the	122	screen.
77	current position and C<escape> returns to the original position.
78		123
79	=item digital-clock	124	Inputting characters appends them to the regex and continues incremental
		125	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		126	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		127	bottom. C<Escape> leaves search mode and returns to the point where search
		128	was started, while C<Enter> or C<Return> stay at the current position and
		129	additionally stores the first match in the current line into the primary
		130	selection.
80		131
81	Displays a digital clock using the built-in overlay.	132	=item selection-autotransform
		133
		134	This selection allows you to do automatic transforms on a selection
		135	whenever a selection is made.
		136
		137	It works by specifying perl snippets (most useful is a single C<s///>
		138	operator) that modify C<$_> as resources:
		139
		140	URxvt.selection-autotransform.0: transform
		141	URxvt.selection-autotransform.1: transform
		142	...
		143
		144	For example, the following will transform selections of the form
		145	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		146	$word>:
		147
		148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		149
		150	And this example matches the same,but replaces it with vi-commands you can
		151	paste directly into your (vi :) editor:
		152
		153	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		154
		155	Of course, this can be modified to suit your needs and your editor :)
		156
		157	To expand the example above to typical perl error messages ("XXX at
		158	FILENAME line YYY."), you need a slightly more elaborate solution:
		159
		160	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		161	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		162
		163	The first line tells the selection code to treat the unchanging part of
		164	every error message as a selection pattern, and the second line transforms
		165	the message into vi commands to load the file.
82		166
83	=item mark-urls	167	=item mark-urls
84		168
85	Uses per-line display filtering (C<on_line_update>) to underline urls.	169	Uses per-line display filtering (C<on_line_update>) to underline urls and
		170	make them clickable. When middle-clicked, the program specified in the
		171	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		172	the URL as first argument.
		173
		174	=item automove-background
		175
		176	This is basically a one-line extension that dynamically changes the background pixmap offset
		177	to the window position, in effect creating the same effect as pseudo transparency with
		178	a custom pixmap. No scaling is supported in this mode. Exmaple:
		179
		180	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
86		181
87	=item block-graphics-to-ascii	182	=item block-graphics-to-ascii
88		183
89	A not very useful example of filtering all text output to the terminal,	184	A not very useful example of filtering all text output to the terminal,
90	by replacing all line-drawing characters (U+2500 .. U+259F) by a	185	by replacing all line-drawing characters (U+2500 .. U+259F) by a
91	similar-looking ascii character.	186	similar-looking ascii character.
92		187
		188	=item digital-clock
		189
		190	Displays a digital clock using the built-in overlay.
		191
93	=item example-refresh-hooks	192	=item example-refresh-hooks
94		193
95	Displays a very simple digital clock in the upper right corner of the	194	Displays a very simple digital clock in the upper right corner of the
96	window. Illustrates overwriting the refresh callbacks to create your own	195	window. Illustrates overwriting the refresh callbacks to create your own
97	overlays or changes.	196	overlays or changes.
98		197
		198	=item selection-pastebin
		199
		200	This is a little rarely useful extension that Uploads the selection as
		201	textfile to a remote site (or does other things). (The implementation is
		202	not currently secure for use in a multiuser environment as it writes to
		203	F</tmp> directly.).
		204
		205	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		206	i.e.
		207
		208	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		209
		210	Pressing this combination runs a command with C<%> replaced by the name of
		211	the textfile. This command can be set via a resource:
		212
		213	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		214
		215	And the default is likely not useful to anybody but the few people around
		216	here :)
		217
		218	The name of the textfile is the hex encoded md5 sum of the selection, so
		219	the same content should lead to the same filename.
		220
		221	After a successful upload the selection will be replaced by the text given
		222	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		223	for the filename):
		224
		225	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		226
99	=back	227	=back
		228
		229	=head1 API DOCUMENTATION
100		230
101	=head2 General API Considerations	231	=head2 General API Considerations
102		232
103	All objects (such as terminals, time watchers etc.) are typical	233	All objects (such as terminals, time watchers etc.) are typical
104	reference-to-hash objects. The hash can be used to store anything you	234	reference-to-hash objects. The hash can be used to store anything you
…		…
117	=over 4	247	=over 4
118		248
119	=item $text	249	=item $text
120		250
121	Rxvt-unicodes special way of encoding text, where one "unicode" character	251	Rxvt-unicodes special way of encoding text, where one "unicode" character
122	always represents one screen cell. See L<row_t> for a discussion of this format.	252	always represents one screen cell. See L<ROW_t> for a discussion of this format.
123		253
124	=item $string	254	=item $string
125		255
126	A perl text string, with an emphasis on I<text>. It can store all unicode	256	A perl text string, with an emphasis on I<text>. It can store all unicode
127	characters and is to be distinguished with text encoded in a specific	257	characters and is to be distinguished with text encoded in a specific
…		…
173	called whenever the relevant event happens.	303	called whenever the relevant event happens.
174		304
175	The first argument passed to them is an extension oject as described in	305	The first argument passed to them is an extension oject as described in
176	the in the C<Extension Objects> section.	306	the in the C<Extension Objects> section.
177		307
178	B<All> of these hooks must return a boolean value. If it is true, then the	308	B<All> of these hooks must return a boolean value. If any of the called
179	event counts as being I<consumed>, and the invocation of other hooks is	309	hooks returns true, then the event counts as being I<consumed>, and the
180	skipped, and the relevant action might not be carried out by the C++ code.	310	relevant action might not be carried out by the C++ code.
181		311
182	I<< When in doubt, return a false value (preferably C<()>). >>	312	I<< When in doubt, return a false value (preferably C<()>). >>
183		313
184	=over 4	314	=over 4
185		315
186	=item on_init $term	316	=item on_init $term
187		317
188	Called after a new terminal object has been initialized, but before	318	Called after a new terminal object has been initialized, but before
189	windows are created or the command gets run. Most methods are unsafe to	319	windows are created or the command gets run. Most methods are unsafe to
190	call or deliver senseless data, as terminal size and other characteristics	320	call or deliver senseless data, as terminal size and other characteristics
191	have not yet been determined. You can safely query and change resources,	321	have not yet been determined. You can safely query and change resources
192	though.	322	and options, though. For many purposes the C<on_start> hook is a better
		323	place.
		324
		325	=item on_start $term
		326
		327	Called at the very end of initialisation of a new terminal, just before
		328	returning to the mainloop.
193		329
194	=item on_reset $term	330	=item on_reset $term
195		331
196	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
197	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
198	variables.	334	variables.
199		335
200	=item on_start $term	336	=item on_child_start $term, $pid
201		337
202	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.
203	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>.
204		344
205	=item on_sel_make $term, $eventtime	345	=item on_sel_make $term, $eventtime
206		346
207	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
208	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
…		…
222	=item on_sel_extend $term	362	=item on_sel_extend $term
223		363
224	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
225	click) and is either supposed to return false (normal operation), or	365	click) and is either supposed to return false (normal operation), or
226	should extend the selection itelf and return true to suppress the built-in	366	should extend the selection itelf and return true to suppress the built-in
227	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.
228		370
229	See the F<selection> example extension.	371	See the F<selection> example extension.
230		372
231	=item on_view_change $term, $offset	373	=item on_view_change $term, $offset
232		374
…		…
263	can filter/change and output the text yourself by returning a true value	405	can filter/change and output the text yourself by returning a true value
264	and calling C<< $term->scr_add_lines >> yourself. Please note that this	406	and calling C<< $term->scr_add_lines >> yourself. Please note that this
265	might be very slow, however, as your hook is called for B<all> text being	407	might be very slow, however, as your hook is called for B<all> text being
266	output.	408	output.
267		409
		410	=item on_tt_write $term, $octets
		411
		412	Called whenever some data is written to the tty/pty and can be used to
		413	suppress or filter tty input.
		414
268	=item on_line_update $term, $row	415	=item on_line_update $term, $row
269		416
270	Called whenever a line was updated or changed. Can be used to filter	417	Called whenever a line was updated or changed. Can be used to filter
271	screen output (e.g. underline urls or other useless stuff). Only lines	418	screen output (e.g. underline urls or other useless stuff). Only lines
272	that are being shown will be filtered, and, due to performance reasons,	419	that are being shown will be filtered, and, due to performance reasons,
…		…
294		441
295	Called whenever the user presses a key combination that has a	442	Called whenever the user presses a key combination that has a
296	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>
297	resource in the @@RXVT_NAME@@(1) manpage).	444	resource in the @@RXVT_NAME@@(1) manpage).
298		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
299	=item on_focus_in $term	452	=item on_focus_in $term
300		453
301	Called whenever the window gets the keyboard focus, before rxvt-unicode	454	Called whenever the window gets the keyboard focus, before rxvt-unicode
302	does focus in processing.	455	does focus in processing.
303		456
304	=item on_focus_out $term	457	=item on_focus_out $term
305		458
306	Called wheneever the window loses keyboard focus, before rxvt-unicode does	459	Called wheneever the window loses keyboard focus, before rxvt-unicode does
307	focus out processing.	460	focus out processing.
		461
		462	=item on_configure_notify $term, $event
308		463
309	=item on_key_press $term, $event, $keysym, $octets	464	=item on_key_press $term, $event, $keysym, $octets
310		465
311	=item on_key_release $term, $event, $keysym	466	=item on_key_release $term, $event, $keysym
312		467
…		…
329		484
330	C<on_key_press> additionally receives the string rxvt-unicode would	485	C<on_key_press> additionally receives the string rxvt-unicode would
331	output, if any, in locale-specific encoding.	486	output, if any, in locale-specific encoding.
332		487
333	subwindow.	488	subwindow.
334
335	=back
336
337	=head2 Variables in the C<urxvt> Package
338
339	=over 4
340
341	=item $urxvt::TERM
342
343	The current terminal. This variable stores the current C<urxvt::term>
344	object, whenever a callback/hook is executing.
345
346	=back
347
348	=head2 Functions in the C<urxvt> Package
349
350	=over 4
351
352	=item $term = new urxvt [arg...]
353
354	Creates a new terminal, very similar as if you had started it with
355	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
356	if the new instance couldn't be created. Returns C<undef> if the new
357	instance didn't initialise perl, and the terminal object otherwise. The
358	C<init> and C<start> hooks will be called during the call.
359
360	=item urxvt::fatal $errormessage
361
362	Fatally aborts execution with the given error message. Avoid at all
363	costs! The only time this is acceptable is when the terminal process
364	starts up.
365
366	=item urxvt::warn $string
367
368	Calls C<rxvt_warn> with the given string which should not include a
369	newline. The module also overwrites the C<warn> builtin with a function
370	that calls this function.
371
372	Using this function has the advantage that its output ends up in the
373	correct place, e.g. on stderr of the connecting urxvtc client.
374
375	=item $is_safe = urxvt::safe
376
377	Returns true when it is safe to do potentially unsafe things, such as
378	evaluating perl code specified by the user. This is true when urxvt was
379	started setuid or setgid.
380
381	=item $time = urxvt::NOW
382
383	Returns the "current time" (as per the event loop).
384
385	=item urxvt::CurrentTime
386
387	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
388	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
389	Button4Mask, Button5Mask, AnyModifier
390
391	Various constants for use in X calls and event processing.
392
393	=back
394
395	=head2 RENDITION
396
397	Rendition bitsets contain information about colour, font, font styles and
398	similar information for each screen cell.
399
400	The following "macros" deal with changes in rendition sets. You should
401	never just create a bitset, you should always modify an existing one,
402	as they contain important information required for correct operation of
403	rxvt-unicode.
404
405	=over 4
406
407	=item $rend = urxvt::DEFAULT_RSTYLE
408
409	Returns the default rendition, as used when the terminal is starting up or
410	being reset. Useful as a base to start when creating renditions.
411
412	=item $rend = urxvt::OVERLAY_RSTYLE
413
414	Return the rendition mask used for overlays by default.
415
416	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
417
418	Return the bit that enabled bold, italic, blink, reverse-video and
419	underline, respectively. To enable such a style, just logically OR it into
420	the bitset.
421
422	=item $foreground = urxvt::GET_BASEFG $rend
423
424	=item $background = urxvt::GET_BASEBG $rend
425
426	Return the foreground/background colour index, respectively.
427
428	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
429
430	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
431
432	Replace the foreground/background colour in the rendition mask with the
433	specified one.
434
435	=item $value = urxvt::GET_CUSTOM ($rend)
436
437	Return the "custom" value: Every rendition has 5 bits for use by
438	extensions. They can be set and changed as you like and are initially
439	zero.
440
441	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
442
443	Change the custom value.
444		489
445	=back	490	=back
446		491
447	=cut	492	=cut
448		493
…		…
457	our $VERSION = 1;	502	our $VERSION = 1;
458	our $TERM;	503	our $TERM;
459	our @HOOKNAME;	504	our @HOOKNAME;
460	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	505	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
461	our %OPTION;	506	our %OPTION;
		507
462	our $LIBDIR;	508	our $LIBDIR;
		509	our $RESNAME;
		510	our $RESCLASS;
		511	our $RXVTNAME;
		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
463		641
464	BEGIN {	642	BEGIN {
465	urxvt->bootstrap;
466
467	# overwrite perl's warn	643	# overwrite perl's warn
468	*CORE::GLOBAL::warn = sub {	644	*CORE::GLOBAL::warn = sub {
469	my $msg = join "", @_;	645	my $msg = join "", @_;
470	$msg .= "\n"	646	$msg .= "\n"
471	unless $msg =~ /\n$/;	647	unless $msg =~ /\n$/;
472	urxvt::warn ($msg);	648	urxvt::warn ($msg);
473	};	649	};
474
475	delete $ENV{IFS};
476	delete $ENV{CDPATH};
477	delete $ENV{BASH_ENV};
478	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
479	}	650	}
480		651
481	my @hook_count;
482	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	652	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
483		653
484	sub verbose {	654	sub verbose {
485	my ($level, $msg) = @_;	655	my ($level, $msg) = @_;
486	warn "$msg\n" if $level <= $verbosity;	656	warn "$msg\n" if $level <= $verbosity;
487	}	657	}
488		658
489	my $extension_pkg = "extension0000";
490	my %extension_pkg;	659	my %extension_pkg;
491		660
492	# load a single script into its own package, once only	661	# load a single script into its own package, once only
493	sub extension_package($) {	662	sub extension_package($) {
494	my ($path) = @_;	663	my ($path) = @_;
495		664
		665	no strict 'refs';
		666
496	$extension_pkg{$path} \|\|= do {	667	$extension_pkg{$path} \|\|= do {
497	my $pkg = "urxvt::" . ($extension_pkg++);	668	$path =~ /([^\/\\]+)$/;
		669	my $pkg = $1;
		670	$pkg =~ s/[^[:word:]]/_/g;
		671	$pkg = "urxvt::ext::$pkg";
498		672
499	verbose 3, "loading extension '$path' into package '$pkg'";	673	verbose 3, "loading extension '$path' into package '$pkg'";
500		674
501	open my $fh, "<:raw", $path	675	open my $fh, "<:raw", $path
502	or die "$path: $!";	676	or die "$path: $!";
503		677
		678	@{"$pkg\::ISA"} = urxvt::term::extension::;
		679
504	my $source = untaint	680	my $source =
505	"package $pkg; use strict; use utf8;\n"	681	"package $pkg; use strict; use utf8;\n"
506	. "use base urxvt::term::proxy::;\n"
507	. "#line 1 \"$path\"\n{\n"	682	. "#line 1 \"$path\"\n{\n"
508	. (do { local $/; <$fh> })	683	. (do { local $/; <$fh> })
509	. "\n};\n1";	684	. "\n};\n1";
510		685
511	eval $source	686	eval $source
…		…
560	if $verbosity >= 10;	735	if $verbosity >= 10;
561		736
562	keys %$cb;	737	keys %$cb;
563		738
564	while (my ($pkg, $cb) = each %$cb) {	739	while (my ($pkg, $cb) = each %$cb) {
565	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	740	$retval \|\|= eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
566	and last;
567		741
568	if ($@) {	742	if ($@) {
569	$TERM->ungrab; # better to lose the grab than the session	743	$TERM->ungrab; # better to lose the grab than the session
570	warn $@;	744	warn $@;
571	}	745	}
572	}	746	}
		747
		748	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		749	if $verbosity >= 11;
573	}	750	}
574		751
575	if ($htype == 1) { # DESTROY	752	if ($htype == 1) { # DESTROY
576	if (my $hook = delete $TERM->{_hook}) {
577	for my $htype (0..$#$hook) {
578	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
579	or set_should_invoke $htype, 0;
580	}
581	}
582
583	# clear package objects	753	# clear package objects
584	%$_ = () for values %{ $TERM->{_pkg} };	754	%$_ = () for values %{ $TERM->{_pkg} };
585		755
586	# clear package	756	# clear package
587	%$TERM = ();	757	%$TERM = ();
588	}	758	}
589		759
590	$retval	760	$retval
591	}	761	}
592		762
593	# urxvt::term::proxy	763	# urxvt::term::extension
594		764
595	package urxvt::term::proxy;	765	package urxvt::term::extension;
596		766
597	sub enable {	767	sub enable {
598	my ($self, %hook) = @_;	768	my ($self, %hook) = @_;
599	my $pkg = $self->{_pkg};	769	my $pkg = $self->{_pkg};
600		770
601	while (my ($name, $cb) = each %hook) {	771	while (my ($name, $cb) = each %hook) {
602	my $htype = $HOOKTYPE{uc $name};	772	my $htype = $HOOKTYPE{uc $name};
603	defined $htype	773	defined $htype
604	or Carp::croak "unsupported hook type '$name'";	774	or Carp::croak "unsupported hook type '$name'";
605		775
		776	$self->set_should_invoke ($htype, +1)
606	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	777	unless exists $self->{term}{_hook}[$htype]{$pkg};
607	$hook_count[$htype]++
608	or urxvt::set_should_invoke $htype, 1;
609	}
610		778
611	$self->{term}{_hook}[$htype]{$pkg} = $cb;	779	$self->{term}{_hook}[$htype]{$pkg} = $cb;
612	}	780	}
613	}	781	}
614		782
…		…
619	for my $name (@hook) {	787	for my $name (@hook) {
620	my $htype = $HOOKTYPE{uc $name};	788	my $htype = $HOOKTYPE{uc $name};
621	defined $htype	789	defined $htype
622	or Carp::croak "unsupported hook type '$name'";	790	or Carp::croak "unsupported hook type '$name'";
623		791
		792	$self->set_should_invoke ($htype, -1)
624	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	793	if delete $self->{term}{_hook}[$htype]{$pkg};
625	--$hook_count[$htype]
626	or urxvt::set_should_invoke $htype, 0;
627	}
628	}	794	}
629	}	795	}
630		796
631	our $AUTOLOAD;	797	our $AUTOLOAD;
632		798
…		…
663		829
664	=head2 The C<urxvt::anyevent> Class	830	=head2 The C<urxvt::anyevent> Class
665		831
666	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
667	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
668	further work. The only exception is that you cannot wait on condition	834	further programming. The only exception is that you cannot wait on
669	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
670	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.
671		838
672	=cut	839	=cut
673		840
674	our $VERSION = 1;	841	our $VERSION = 1;
675		842
…		…
752	$proxy->enable ($name => $ref);	919	$proxy->enable ($name => $ref);
753	}	920	}
754	}	921	}
755	}	922	}
756		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
757	=item $term->destroy	943	=item $term->destroy
758		944
759	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	}
760		973
761	=item $isset = $term->option ($optval[, $set])	974	=item $isset = $term->option ($optval[, $set])
762		975
763	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
764	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
…		…
767	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
768	source file F</src/optinc.h> to see the actual list:	981	source file F</src/optinc.h> to see the actual list:
769		982
770	borderLess console cursorBlink cursorUnderline hold iconic insecure	983	borderLess console cursorBlink cursorUnderline hold iconic insecure
771	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	984	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
772	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	985	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
773	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	986	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
774	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	987	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
775	tripleclickwords utmpInhibit visualBell	988	transparent tripleclickwords utmpInhibit visualBell
776		989
777	=item $value = $term->resource ($name[, $newval])	990	=item $value = $term->resource ($name[, $newval])
778		991
779	Returns the current resource value associated with a given name and	992	Returns the current resource value associated with a given name and
780	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>
…		…
797		1010
798	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1011	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
799	borderLess color cursorBlink cursorUnderline cutchars delete_key	1012	borderLess color cursorBlink cursorUnderline cutchars delete_key
800	display_name embed ext_bwidth fade font geometry hold iconName	1013	display_name embed ext_bwidth fade font geometry hold iconName
801	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1014	imFont imLocale inputMethod insecure int_bwidth intensityStyles
802	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1015	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
803	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1016	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
804	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1017	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
805	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1018	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
806	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1019	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
807	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1020	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
808	shade term_name title transparent transparent_all tripleclickwords	1021	secondaryScreen secondaryScroll selectstyle shade term_name title
809	utmpInhibit visualBell	1022	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1023	visualBell
810		1024
811	=cut	1025	=cut
812		1026
813	sub resource($$;$) {	1027	sub resource($$;$) {
814	my ($self, $name) = (shift, shift);	1028	my ($self, $name) = (shift, shift);
815	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1029	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
816	&urxvt::term::_resource	1030	&urxvt::term::_resource
817	}	1031	}
818		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
819	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1044	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
820		1045
821	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
822	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1047	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
823		1048
…		…
838	=item ($row, $col) = $term->selection_end ([$row, $col])	1063	=item ($row, $col) = $term->selection_end ([$row, $col])
839		1064
840	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,
841	and optionally set them to new values.	1066	and optionally set them to new values.
842		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
843	=item $success = $term->selection_grab ($eventtime)	1075	=item $success = $term->selection_grab ($eventtime)
844		1076
845	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
846	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.
847		1080
848	=item $oldtext = $term->selection ([$newtext])	1081	=item $oldtext = $term->selection ([$newtext])
849		1082
850	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>.
851		1084
…		…
944	Convert the given locale-encoded octets into a perl string.	1177	Convert the given locale-encoded octets into a perl string.
945		1178
946	=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])
947		1180
948	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
949	(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
950	to the selection.	1183	refresh hooks to provide effects similar to the selection.
951		1184
952	=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]])
953		1186
954	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
955	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1188	whitespace will additionally be xored with the C<$rstyle2>, which defaults
956	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
957	it instead.	1190	it instead. Both styles I<MUST NOT> contain font styles.
958		1191
959	=item $term->scr_bell	1192	=item $term->scr_bell
960		1193
961	Ring the bell!	1194	Ring the bell!
962		1195
…		…
996		1229
997	=item $windowid = $term->vt	1230	=item $windowid = $term->vt
998		1231
999	Return the window id of the terminal window.	1232	Return the window id of the terminal window.
1000		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
1001	=item $window_width = $term->width	1241	=item $window_width = $term->width
1002		1242
1003	=item $window_height = $term->height	1243	=item $window_height = $term->height
1004		1244
1005	=item $font_width = $term->fwidth	1245	=item $font_width = $term->fwidth
…		…
1018		1258
1019	=item $max_scrollback = $term->saveLines	1259	=item $max_scrollback = $term->saveLines
1020		1260
1021	=item $nrow_plus_saveLines = $term->total_rows	1261	=item $nrow_plus_saveLines = $term->total_rows
1022		1262
1023	=item $lines_in_scrollback = $term->nsaved	1263	=item $topmost_scrollback_row = $term->top_row
1024		1264
1025	Return various integers describing terminal characteristics.	1265	Return various integers describing terminal characteristics.
1026		1266
		1267	=item $x_display = $term->display_id
		1268
		1269	Return the DISPLAY used by rxvt-unicode.
		1270
1027	=item $lc_ctype = $term->locale	1271	=item $lc_ctype = $term->locale
1028		1272
1029	Returns the LC_CTYPE category string used by this rxvt-unicode.	1273	Returns the LC_CTYPE category string used by this rxvt-unicode.
1030		1274
1031	=item $x_display = $term->display_id	1275	=item $env = $term->env
1032		1276
1033	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	}
1034		1289
1035	=item $modifiermask = $term->ModLevel3Mask	1290	=item $modifiermask = $term->ModLevel3Mask
1036		1291
1037	=item $modifiermask = $term->ModMetaMask	1292	=item $modifiermask = $term->ModMetaMask
1038		1293
…		…
1041	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
1042	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.
1043		1298
1044	=item $view_start = $term->view_start ([$newvalue])	1299	=item $view_start = $term->view_start ([$newvalue])
1045		1300
1046	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
1047	C<0>, which displays the normal terminal contents. Larger values scroll	1302	C<0>, which displays the normal terminal contents. Lower values scroll
1048	this many lines into the scrollback buffer.	1303	this many lines into the scrollback buffer.
1049		1304
1050	=item $term->want_refresh	1305	=item $term->want_refresh
1051		1306
1052	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1307	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1131	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.
1132		1387
1133	=item $offset = $line->offset_of ($row, $col)	1388	=item $offset = $line->offset_of ($row, $col)
1134		1389
1135	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
1136	line.	1391	line. Works for rows outside the line, too, and returns corresponding
		1392	offsets outside the string.
1137		1393
1138	=item ($row, $col) = $line->coord_of ($offset)	1394	=item ($row, $col) = $line->coord_of ($offset)
1139		1395
1140	Translates a string offset into terminal coordinates again.	1396	Translates a string offset into terminal coordinates again.
1141		1397
…		…
1278	$item->{render} \|\|= sub { $_[0]{text} };	1534	$item->{render} \|\|= sub { $_[0]{text} };
1279		1535
1280	push @{ $self->{item} }, $item;	1536	push @{ $self->{item} }, $item;
1281	}	1537	}
1282		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
1283	sub add_separator {	1561	sub add_separator {
1284	my ($self, $sep) = @_;	1562	my ($self, $sep) = @_;
1285		1563
1286	$sep \|\|= "=";	1564	$sep \|\|= "=";
1287		1565
…		…
1291	render => sub { $sep x $self->{term}->ncol },	1569	render => sub { $sep x $self->{term}->ncol },
1292	activate => sub { },	1570	activate => sub { },
1293	});	1571	});
1294	}	1572	}
1295		1573
1296	sub add_title {	1574	=item $popup->add_button ($text, $cb)
1297	my ($self, $title) = @_;
1298		1575
1299	$self->add_item ({	1576	Adds a clickable button to the popup. C<$cb> is called whenever it is
1300	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1577	selected.
1301	text => $title,	1578
1302	activate => sub { },	1579	=cut
1303	});
1304	}
1305		1580
1306	sub add_button {	1581	sub add_button {
1307	my ($self, $text, $cb) = @_;	1582	my ($self, $text, $cb) = @_;
1308		1583
1309	$self->add_item ({ type => "button", text => $text, activate => $cb});	1584	$self->add_item ({ type => "button", text => $text, activate => $cb});
1310	}	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
1311		1594
1312	sub add_toggle {	1595	sub add_toggle {
1313	my ($self, $text, $cb, $value) = @_;	1596	my ($self, $text, $cb, $value) = @_;
1314		1597
1315	my $item; $item = {	1598	my $item; $item = {
1316	type => "button",	1599	type => "button",
1317	text => " $text",	1600	text => " $text",
1318	value => $value,	1601	value => $value,
1319	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1602	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1320	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1603	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1321	};	1604	};
1322		1605
1323	$self->add_item ($item);	1606	$self->add_item ($item);
1324	}	1607	}
		1608
		1609	=item $popup->show
		1610
		1611	Displays the popup (which is initially hidden).
		1612
		1613	=cut
1325		1614
1326	sub show {	1615	sub show {
1327	my ($self) = @_;	1616	my ($self) = @_;
1328		1617
1329	local $urxvt::popup::self = $self;	1618	local $urxvt::popup::self = $self;
1330		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};
1331	local $ENV{LC_ALL} = $self->{term}->locale;	1623	$env->{LC_CTYPE} = $self->{term}->locale;
1332		1624
1333	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",
1334	"--transient-for" => $self->{term}->parent,	1629	"--transient-for" => $self->{term}->parent,
1335	"-display" => $self->{term}->display_id,	1630	"-display" => $self->{term}->display_id,
1336	"-pe" => "urxvt-popup")	1631	"-pe" => "urxvt-popup")
1337	or die "unable to create popup window\n";	1632	or die "unable to create popup window\n";
1338	}	1633	}
1339		1634
1340	sub DESTROY {	1635	sub DESTROY {
1341	my ($self) = @_;	1636	my ($self) = @_;
1342		1637
1343	delete $self->{term}{_destroy}{$self};	1638	delete $self->{term}{_destroy}{$self};
1344	$self->{term}->ungrab;	1639	$self->{term}->ungrab;
1345	}	1640	}
		1641
		1642	=back
1346		1643
1347	=head2 The C<urxvt::timer> Class	1644	=head2 The C<urxvt::timer> Class
1348		1645
1349	This class implements timer watchers/events. Time is represented as a	1646	This class implements timer watchers/events. Time is represented as a
1350	fractional number of seconds since the epoch. Example:	1647	fractional number of seconds since the epoch. Example:
…		…
1388	Start the timer.	1685	Start the timer.
1389		1686
1390	=item $timer = $timer->start ($tstamp)	1687	=item $timer = $timer->start ($tstamp)
1391		1688
1392	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>.
1393		1694
1394	=item $timer = $timer->stop	1695	=item $timer = $timer->stop
1395		1696
1396	Stop the timer.	1697	Stop the timer.
1397		1698
…		…
1457		1758
1458	=item == 0 - fatal messages	1759	=item == 0 - fatal messages
1459		1760
1460	=item >= 3 - script loading and management	1761	=item >= 3 - script loading and management
1461		1762
1462	=item >=10 - all events received	1763	=item >=10 - all called hooks
		1764
		1765	=item >=11 - hook reutrn values
1463		1766
1464	=back	1767	=back
1465		1768
1466	=head1 AUTHOR	1769	=head1 AUTHOR
1467		1770

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.70 by root, Mon Jan 9 23:00:07 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.70 by root, Mon Jan 9 23:00:07 2006 UTC vs.
Revision 1.112 by root, Thu Jan 19 21:02:06 2006 UTC