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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.68 by root, Mon Jan 9 20:00:31 2006 UTC vs.
Revision 1.111 by root, Thu Jan 19 19:52:54 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
71	=item digital-clock	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.
72		101
73	Displays a digital clock using the built-in overlay.	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
		117	=item searchable-scrollback<hotkey> (enabled by default)
		118
		119	Adds regex search functionality to the scrollback buffer, triggered
		120	by a hotkey (default: C<M-s>). While in search mode, normal terminal
		121	input/output is suspended and a regex is displayed at the bottom of the
		122	screen.
		123
		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.
		131
		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.
74		166
75	=item mark-urls	167	=item mark-urls
76		168
77	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
78		181
79	=item block-graphics-to-ascii	182	=item block-graphics-to-ascii
80		183
81	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,
82	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
83	similar-looking ascii character.	186	similar-looking ascii character.
84		187
		188	=item digital-clock
		189
		190	Displays a digital clock using the built-in overlay.
		191
85	=item example-refresh-hooks	192	=item example-refresh-hooks
86		193
87	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
88	window. Illustrates overwriting the refresh callbacks to create your own	195	window. Illustrates overwriting the refresh callbacks to create your own
89	overlays or changes.	196	overlays or changes.
90		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
91	=back	227	=back
		228
		229	=head1 API DOCUMENTATION
92		230
93	=head2 General API Considerations	231	=head2 General API Considerations
94		232
95	All objects (such as terminals, time watchers etc.) are typical	233	All objects (such as terminals, time watchers etc.) are typical
96	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
…		…
109	=over 4	247	=over 4
110		248
111	=item $text	249	=item $text
112		250
113	Rxvt-unicodes special way of encoding text, where one "unicode" character	251	Rxvt-unicodes special way of encoding text, where one "unicode" character
114	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.
115		253
116	=item $string	254	=item $string
117		255
118	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
119	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
…		…
124	Either binary data or - more common - a text string encoded in a	262	Either binary data or - more common - a text string encoded in a
125	locale-specific way.	263	locale-specific way.
126		264
127	=back	265	=back
128		266
		267	=head2 Extension Objects
		268
		269	Very perl extension is a perl class. A separate perl object is created
		270	for each terminal and each extension and passed as the first parameter to
		271	hooks. So extensions can use their C<$self> object without having to think
		272	about other extensions, with the exception of methods and members that
		273	begin with an underscore character C<_>: these are reserved for internal
		274	use.
		275
		276	Although it isn't a C<urxvt::term> object, you can call all methods of the
		277	C<urxvt::term> class on this object.
		278
		279	It has the following methods and data members:
		280
		281	=over 4
		282
		283	=item $urxvt_term = $self->{term}
		284
		285	Returns the C<urxvt::term> object associated with this instance of the
		286	extension. This member I<must not> be changed in any way.
		287
		288	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		289
		290	Dynamically enable the given hooks (named without the C<on_> prefix) for
		291	this extension, replacing any previous hook. This is useful when you want
		292	to overwrite time-critical hooks only temporarily.
		293
		294	=item $self->disable ($hook_name[, $hook_name..])
		295
		296	Dynamically disable the given hooks.
		297
		298	=back
		299
129	=head2 Hooks	300	=head2 Hooks
130		301
131	The following subroutines can be declared in extension files, and will be	302	The following subroutines can be declared in extension files, and will be
132	called whenever the relevant event happens.	303	called whenever the relevant event happens.
133		304
134	The first argument passed to them is an object private to each terminal	305	The first argument passed to them is an extension oject as described in
135	and extension package. You can call all C<urxvt::term> methods on it, but	306	the in the C<Extension Objects> section.
136	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
137	object that is shared between all packages is stored in the C<term>
138	member. It is, however, blessed intot he package of the extension script,
139	so for all practical purposes you can treat an extension script as a class.
140		307
141	All of them must return a boolean value. If it is true, then the event	308	B<All> of these hooks must return a boolean value. If it is true, then the
142	counts as being I<consumed>, and the invocation of other hooks is skipped,	309	event counts as being I<consumed>, and the invocation of other hooks is
143	and the relevant action might not be carried out by the C++ code.	310	skipped, and the relevant action might not be carried out by the C++ code.
144		311
145	When in doubt, return a false value (preferably C<()>).	312	I<< When in doubt, return a false value (preferably C<()>). >>
146		313
147	=over 4	314	=over 4
148		315
149	=item on_init $term	316	=item on_init $term
150		317
…		…
163	=item on_start $term	330	=item on_start $term
164		331
165	Called at the very end of initialisation of a new terminal, just before	332	Called at the very end of initialisation of a new terminal, just before
166	returning to the mainloop.	333	returning to the mainloop.
167		334
		335	=item on_child_start $term, $pid
		336
		337	Called just after the child process has been C<fork>ed.
		338
		339	=item on_child_exit $term, $status
		340
		341	Called just after the child process has exited. C<$status> is the status
		342	from C<waitpid>.
		343
168	=item on_sel_make $term, $eventtime	344	=item on_sel_make $term, $eventtime
169		345
170	Called whenever a selection has been made by the user, but before the	346	Called whenever a selection has been made by the user, but before the
171	selection text is copied, so changes to the beginning, end or type of the	347	selection text is copied, so changes to the beginning, end or type of the
172	selection will be honored.	348	selection will be honored.
…		…
185	=item on_sel_extend $term	361	=item on_sel_extend $term
186		362
187	Called whenever the user tries to extend the selection (e.g. with a double	363	Called whenever the user tries to extend the selection (e.g. with a double
188	click) and is either supposed to return false (normal operation), or	364	click) and is either supposed to return false (normal operation), or
189	should extend the selection itelf and return true to suppress the built-in	365	should extend the selection itelf and return true to suppress the built-in
190	processing.	366	processing. This can happen multiple times, as long as the callback
		367	returns true, it will be called on every further click by the user and is
		368	supposed to enlarge the selection more and more, if possible.
191		369
192	See the F<selection> example extension.	370	See the F<selection> example extension.
193		371
194	=item on_view_change $term, $offset	372	=item on_view_change $term, $offset
195		373
…		…
226	can filter/change and output the text yourself by returning a true value	404	can filter/change and output the text yourself by returning a true value
227	and calling C<< $term->scr_add_lines >> yourself. Please note that this	405	and calling C<< $term->scr_add_lines >> yourself. Please note that this
228	might be very slow, however, as your hook is called for B<all> text being	406	might be very slow, however, as your hook is called for B<all> text being
229	output.	407	output.
230		408
		409	=item on_tt_write $term, $octets
		410
		411	Called whenever some data is written to the tty/pty and can be used to
		412	suppress or filter tty input.
		413
231	=item on_line_update $term, $row	414	=item on_line_update $term, $row
232		415
233	Called whenever a line was updated or changed. Can be used to filter	416	Called whenever a line was updated or changed. Can be used to filter
234	screen output (e.g. underline urls or other useless stuff). Only lines	417	screen output (e.g. underline urls or other useless stuff). Only lines
235	that are being shown will be filtered, and, due to performance reasons,	418	that are being shown will be filtered, and, due to performance reasons,
…		…
257		440
258	Called whenever the user presses a key combination that has a	441	Called whenever the user presses a key combination that has a
259	C<perl:string> action bound to it (see description of the B<keysym>	442	C<perl:string> action bound to it (see description of the B<keysym>
260	resource in the @@RXVT_NAME@@(1) manpage).	443	resource in the @@RXVT_NAME@@(1) manpage).
261		444
		445	=item on_x_event $term, $event
		446
		447	Called on every X event received on the vt window (and possibly other
		448	windows). Should only be used as a last resort. Most event structure
		449	members are not passed.
		450
262	=item on_focus_in $term	451	=item on_focus_in $term
263		452
264	Called whenever the window gets the keyboard focus, before rxvt-unicode	453	Called whenever the window gets the keyboard focus, before rxvt-unicode
265	does focus in processing.	454	does focus in processing.
266		455
267	=item on_focus_out $term	456	=item on_focus_out $term
268		457
269	Called wheneever the window loses keyboard focus, before rxvt-unicode does	458	Called wheneever the window loses keyboard focus, before rxvt-unicode does
270	focus out processing.	459	focus out processing.
271		460
		461	=item on_configure_notify $term, $event
		462
272	=item on_key_press $term, $event, $octets	463	=item on_key_press $term, $event, $keysym, $octets
273		464
274	=item on_key_release $term, $event	465	=item on_key_release $term, $event, $keysym
275		466
276	=item on_button_press $term, $event	467	=item on_button_press $term, $event
277		468
278	=item on_button_release $term, $event	469	=item on_button_release $term, $event
279		470
…		…
295		486
296	subwindow.	487	subwindow.
297		488
298	=back	489	=back
299		490
		491	=cut
		492
		493	package urxvt;
		494
		495	use utf8;
		496	use strict;
		497	use Carp ();
		498	use Scalar::Util ();
		499	use List::Util ();
		500
		501	our $VERSION = 1;
		502	our $TERM;
		503	our @HOOKNAME;
		504	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		505	our %OPTION;
		506
		507	our $LIBDIR;
		508	our $RESNAME;
		509	our $RESCLASS;
		510	our $RXVTNAME;
		511
300	=head2 Variables in the C<urxvt> Package	512	=head2 Variables in the C<urxvt> Package
301		513
302	=over 4	514	=over 4
		515
		516	=item $urxvt::LIBDIR
		517
		518	The rxvt-unicode library directory, where, among other things, the perl
		519	modules and scripts are stored.
		520
		521	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		522
		523	The resource class and name rxvt-unicode uses to look up X resources.
		524
		525	=item $urxvt::RXVTNAME
		526
		527	The basename of the installed binaries, usually C<urxvt>.
303		528
304	=item $urxvt::TERM	529	=item $urxvt::TERM
305		530
306	The current terminal. This variable stores the current C<urxvt::term>	531	The current terminal. This variable stores the current C<urxvt::term>
307	object, whenever a callback/hook is executing.	532	object, whenever a callback/hook is executing.
…		…
309	=back	534	=back
310		535
311	=head2 Functions in the C<urxvt> Package	536	=head2 Functions in the C<urxvt> Package
312		537
313	=over 4	538	=over 4
314
315	=item $term = new urxvt [arg...]
316
317	Creates a new terminal, very similar as if you had started it with
318	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
319	if the new instance couldn't be created. Returns C<undef> if the new
320	instance didn't initialise perl, and the terminal object otherwise. The
321	C<init> and C<start> hooks will be called during the call.
322		539
323	=item urxvt::fatal $errormessage	540	=item urxvt::fatal $errormessage
324		541
325	Fatally aborts execution with the given error message. Avoid at all	542	Fatally aborts execution with the given error message. Avoid at all
326	costs! The only time this is acceptable is when the terminal process	543	costs! The only time this is acceptable is when the terminal process
…		…
333	that calls this function.	550	that calls this function.
334		551
335	Using this function has the advantage that its output ends up in the	552	Using this function has the advantage that its output ends up in the
336	correct place, e.g. on stderr of the connecting urxvtc client.	553	correct place, e.g. on stderr of the connecting urxvtc client.
337		554
338	=item $is_safe = urxvt::safe	555	Messages have a size limit of 1023 bytes currently.
339
340	Returns true when it is safe to do potentially unsafe things, such as
341	evaluating perl code specified by the user. This is true when urxvt was
342	started setuid or setgid.
343		556
344	=item $time = urxvt::NOW	557	=item $time = urxvt::NOW
345		558
346	Returns the "current time" (as per the event loop).	559	Returns the "current time" (as per the event loop).
347		560
348	=item urxvt::CurrentTime	561	=item urxvt::CurrentTime
349		562
350	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	563	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
351	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	564	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
352	Button4Mask, Button5Mask, AnyModifier	565	Button4Mask, Button5Mask, AnyModifier
		566
		567	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		568	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		569	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		570	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		571	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		572	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		573	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		574
		575	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		576	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		577	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		578	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		579	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		580	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		581	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
353		582
354	Various constants for use in X calls and event processing.	583	Various constants for use in X calls and event processing.
355		584
356	=back	585	=back
357		586
…		…
386		615
387	=item $background = urxvt::GET_BASEBG $rend	616	=item $background = urxvt::GET_BASEBG $rend
388		617
389	Return the foreground/background colour index, respectively.	618	Return the foreground/background colour index, respectively.
390		619
391	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	620	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
392		621
393	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	622	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
394		623
395	Replace the foreground/background colour in the rendition mask with the	624	Replace the foreground/background colour in the rendition mask with the
396	specified one.	625	specified one.
397		626
398	=item $value = urxvt::GET_CUSTOM ($rend)	627	=item $value = urxvt::GET_CUSTOM $rend
399		628
400	Return the "custom" value: Every rendition has 5 bits for use by	629	Return the "custom" value: Every rendition has 5 bits for use by
401	extensions. They can be set and changed as you like and are initially	630	extensions. They can be set and changed as you like and are initially
402	zero.	631	zero.
403		632
404	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	633	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
405		634
406	Change the custom value.	635	Change the custom value.
407		636
408	=back	637	=back
409		638
410	=cut	639	=cut
411		640
412	package urxvt;
413
414	use utf8;
415	use strict;
416	use Scalar::Util ();
417	use List::Util ();
418
419	our $VERSION = 1;
420	our $TERM;
421	our @HOOKNAME;
422	our %OPTION;
423	our $LIBDIR;
424
425	BEGIN {	641	BEGIN {
426	urxvt->bootstrap;
427
428	# overwrite perl's warn	642	# overwrite perl's warn
429	*CORE::GLOBAL::warn = sub {	643	*CORE::GLOBAL::warn = sub {
430	my $msg = join "", @_;	644	my $msg = join "", @_;
431	$msg .= "\n"	645	$msg .= "\n"
432	unless $msg =~ /\n$/;	646	unless $msg =~ /\n$/;
433	urxvt::warn ($msg);	647	urxvt::warn ($msg);
434	};	648	};
435
436	delete $ENV{IFS};
437	delete $ENV{CDPATH};
438	delete $ENV{BASH_ENV};
439	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
440	}	649	}
441		650
442	my @hook_count;
443	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	651	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
444		652
445	sub verbose {	653	sub verbose {
446	my ($level, $msg) = @_;	654	my ($level, $msg) = @_;
447	warn "$msg\n" if $level <= $verbosity;	655	warn "$msg\n" if $level <= $verbosity;
448	}	656	}
449		657
450	my $extension_pkg = "extension0000";
451	my %extension_pkg;	658	my %extension_pkg;
452		659
453	# load a single script into its own package, once only	660	# load a single script into its own package, once only
454	sub extension_package($) {	661	sub extension_package($) {
455	my ($path) = @_;	662	my ($path) = @_;
456		663
		664	no strict 'refs';
		665
457	$extension_pkg{$path} \|\|= do {	666	$extension_pkg{$path} \|\|= do {
458	my $pkg = "urxvt::" . ($extension_pkg++);	667	$path =~ /([^\/\\]+)$/;
		668	my $pkg = $1;
		669	$pkg =~ s/[^[:word:]]/_/g;
		670	$pkg = "urxvt::ext::$pkg";
459		671
460	verbose 3, "loading extension '$path' into package '$pkg'";	672	verbose 3, "loading extension '$path' into package '$pkg'";
461		673
462	open my $fh, "<:raw", $path	674	open my $fh, "<:raw", $path
463	or die "$path: $!";	675	or die "$path: $!";
464		676
		677	@{"$pkg\::ISA"} = urxvt::term::extension::;
		678
		679	my $source =
465	my $source = untaint "package $pkg; use strict; use utf8;\n"	680	"package $pkg; use strict; use utf8;\n"
466	. "use base urxvt::term::proxy::;\n"
467	. "#line 1 \"$path\"\n{\n"	681	. "#line 1 \"$path\"\n{\n"
468	. (do { local $/; <$fh> })	682	. (do { local $/; <$fh> })
469	. "\n};\n1";	683	. "\n};\n1";
470		684
		685	eval $source
471	eval $source or die "$path: $@";	686	or die "$path: $@";
472		687
473	$pkg	688	$pkg
474	}	689	}
475	}	690	}
476		691
…		…
486		701
487	my %ext_arg;	702	my %ext_arg;
488		703
489	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	704	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
490	if ($_ eq "default") {	705	if ($_ eq "default") {
491	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup);	706	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
492	} elsif (/^-(.*)$/) {	707	} elsif (/^-(.*)$/) {
493	delete $ext_arg{$1};	708	delete $ext_arg{$1};
494	} elsif (/^([^<]+)<(.*)>$/) {	709	} elsif (/^([^<]+)<(.*)>$/) {
495	push @{ $ext_arg{$1} }, $2;	710	push @{ $ext_arg{$1} }, $2;
496	} else {	711	} else {
…		…
527	if ($@) {	742	if ($@) {
528	$TERM->ungrab; # better to lose the grab than the session	743	$TERM->ungrab; # better to lose the grab than the session
529	warn $@;	744	warn $@;
530	}	745	}
531	}	746	}
		747
		748	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		749	if $verbosity >= 11;
532	}	750	}
533		751
534	if ($htype == 1) { # DESTROY	752	if ($htype == 1) { # DESTROY
535	# remove hooks if unused
536	if (my $hook = $TERM->{_hook}) {
537	for my $htype (0..$#$hook) {
538	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
539	or set_should_invoke $htype, 0;
540	}
541	}
542
543	# clear package objects	753	# clear package objects
544	%$_ = () for values %{ $TERM->{_pkg} };	754	%$_ = () for values %{ $TERM->{_pkg} };
545		755
546	# clear package	756	# clear package
547	%$TERM = ();	757	%$TERM = ();
548	}	758	}
549		759
550	$retval	760	$retval
551	}	761	}
552		762
553	# urxvt::term::proxy	763	# urxvt::term::extension
554		764
555	sub urxvt::term::proxy::AUTOLOAD {	765	package urxvt::term::extension;
556	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	766
		767	sub enable {
		768	my ($self, %hook) = @_;
		769	my $pkg = $self->{_pkg};
		770
		771	while (my ($name, $cb) = each %hook) {
		772	my $htype = $HOOKTYPE{uc $name};
		773	defined $htype
		774	or Carp::croak "unsupported hook type '$name'";
		775
		776	$self->set_should_invoke ($htype, +1)
		777	unless exists $self->{term}{_hook}[$htype]{$pkg};
		778
		779	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		780	}
		781	}
		782
		783	sub disable {
		784	my ($self, @hook) = @_;
		785	my $pkg = $self->{_pkg};
		786
		787	for my $name (@hook) {
		788	my $htype = $HOOKTYPE{uc $name};
		789	defined $htype
		790	or Carp::croak "unsupported hook type '$name'";
		791
		792	$self->set_should_invoke ($htype, -1)
		793	if delete $self->{term}{_hook}[$htype]{$pkg};
		794	}
		795	}
		796
		797	our $AUTOLOAD;
		798
		799	sub AUTOLOAD {
		800	$AUTOLOAD =~ /:([^:]+)$/
557	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	801	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
558		802
559	eval qq{	803	eval qq{
560	sub $urxvt::term::proxy::AUTOLOAD {	804	sub $AUTOLOAD {
561	my \$proxy = shift;	805	my \$proxy = shift;
562	\$proxy->{term}->$1 (\@_)	806	\$proxy->{term}->$1 (\@_)
563	}	807	}
564	1	808	1
565	} or die "FATAL: unable to compile method forwarder: $@";	809	} or die "FATAL: unable to compile method forwarder: $@";
566		810
567	goto &$urxvt::term::proxy::AUTOLOAD;	811	goto &$AUTOLOAD;
568	}	812	}
569		813
570	sub urxvt::term::proxy::DESTROY {	814	sub DESTROY {
571	# nop	815	# nop
572	}	816	}
573		817
574	# urxvt::destroy_hook	818	# urxvt::destroy_hook
575		819
…		…
585		829
586	=head2 The C<urxvt::anyevent> Class	830	=head2 The C<urxvt::anyevent> Class
587		831
588	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
589	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
590	further work. The only exception is that you cannot wait on condition	834	further programming. The only exception is that you cannot wait on
591	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
592	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.
593		838
594	=cut	839	=cut
595		840
596	our $VERSION = 1;	841	our $VERSION = 1;
597		842
…		…
642	${$_[0]}++;	887	${$_[0]}++;
643	}	888	}
644		889
645	sub urxvt::anyevent::condvar::wait {	890	sub urxvt::anyevent::condvar::wait {
646	unless (${$_[0]}) {	891	unless (${$_[0]}) {
647	require Carp;
648	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	892	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
649	}	893	}
650	}	894	}
651		895
652	package urxvt::term;	896	package urxvt::term;
653		897
…		…
660	# find on_xxx subs in the package and register them	904	# find on_xxx subs in the package and register them
661	# as hooks	905	# as hooks
662	sub register_package {	906	sub register_package {
663	my ($self, $pkg, $argv) = @_;	907	my ($self, $pkg, $argv) = @_;
664		908
665	my $proxy = bless { argv => $argv }, $pkg;	909	my $proxy = bless {
		910	_pkg => $pkg,
		911	argv => $argv,
		912	}, $pkg;
666	Scalar::Util::weaken ($proxy->{term} = $TERM);	913	Scalar::Util::weaken ($proxy->{term} = $self);
667		914
668	$self->{_pkg}{$pkg} = $proxy;	915	$self->{_pkg}{$pkg} = $proxy;
669		916
670	for my $htype (0.. $#HOOKNAME) {	917	for my $name (@HOOKNAME) {
671	my $name = $HOOKNAME[$htype];
672
673	my $ref = $pkg->can ("on_" . lc $name)	918	if (my $ref = $pkg->can ("on_" . lc $name)) {
674	or next;	919	$proxy->enable ($name => $ref);
675		920	}
676	$self->{_hook}[$htype]{$pkg} = $ref;
677	$hook_count[$htype]++
678	or urxvt::set_should_invoke $htype, 1;
679	}	921	}
680	}	922	}
681		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
682	=item $term->destroy	943	=item $term->destroy
683		944
684	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	}
685		973
686	=item $isset = $term->option ($optval[, $set])	974	=item $isset = $term->option ($optval[, $set])
687		975
688	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
689	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
…		…
692	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
693	source file F</src/optinc.h> to see the actual list:	981	source file F</src/optinc.h> to see the actual list:
694		982
695	borderLess console cursorBlink cursorUnderline hold iconic insecure	983	borderLess console cursorBlink cursorUnderline hold iconic insecure
696	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	984	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
697	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	985	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
698	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	986	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
699	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	987	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
700	tripleclickwords utmpInhibit visualBell	988	transparent tripleclickwords utmpInhibit visualBell
701		989
702	=item $value = $term->resource ($name[, $newval])	990	=item $value = $term->resource ($name[, $newval])
703		991
704	Returns the current resource value associated with a given name and	992	Returns the current resource value associated with a given name and
705	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>
…		…
722		1010
723	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1011	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
724	borderLess color cursorBlink cursorUnderline cutchars delete_key	1012	borderLess color cursorBlink cursorUnderline cutchars delete_key
725	display_name embed ext_bwidth fade font geometry hold iconName	1013	display_name embed ext_bwidth fade font geometry hold iconName
726	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1014	imFont imLocale inputMethod insecure int_bwidth intensityStyles
727	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1015	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
728	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1016	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
729	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1017	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
730	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1018	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
731	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1019	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
732	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1020	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
733	shade term_name title transparent transparent_all tripleclickwords	1021	secondaryScreen secondaryScroll selectstyle shade term_name title
734	utmpInhibit visualBell	1022	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1023	visualBell
735		1024
736	=cut	1025	=cut
737		1026
738	sub resource($$;$) {	1027	sub resource($$;$) {
739	my ($self, $name) = (shift, shift);	1028	my ($self, $name) = (shift, shift);
740	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1029	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
741	&urxvt::term::_resource	1030	&urxvt::term::_resource
742	}	1031	}
743		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
		1044	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		1045
		1046	Adds a keymap translation exactly as specified via a resource. See the
		1047	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1048
744	=item $rend = $term->rstyle ([$new_rstyle])	1049	=item $rend = $term->rstyle ([$new_rstyle])
745		1050
746	Return and optionally change the current rendition. Text that is output by	1051	Return and optionally change the current rendition. Text that is output by
747	the terminal application will use this style.	1052	the terminal application will use this style.
748		1053
…		…
758	=item ($row, $col) = $term->selection_end ([$row, $col])	1063	=item ($row, $col) = $term->selection_end ([$row, $col])
759		1064
760	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,
761	and optionally set them to new values.	1066	and optionally set them to new values.
762		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
763	=item $success = $term->selection_grab ($eventtime)	1075	=item $success = $term->selection_grab ($eventtime)
764		1076
765	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
766	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.
767		1080
768	=item $oldtext = $term->selection ([$newtext])	1081	=item $oldtext = $term->selection ([$newtext])
769		1082
770	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>.
771		1084
772	#=item $term->overlay ($x, $y, $text)	1085	=item $term->overlay_simple ($x, $y, $text)
773	#	1086
774	#Create a simple multi-line overlay box. See the next method for details.	1087	Create a simple multi-line overlay box. See the next method for details.
775	#	1088
776	#=cut	1089	=cut
777	#	1090
778	#sub urxvt::term::scr_overlay {	1091	sub overlay_simple {
779	# my ($self, $x, $y, $text) = @_;	1092	my ($self, $x, $y, $text) = @_;
780	#	1093
781	# my @lines = split /\n/, $text;	1094	my @lines = split /\n/, $text;
782	#	1095
783	# my $w = 0;	1096	my $w = List::Util::max map $self->strwidth ($_), @lines;
784	# for (map $self->strwidth ($_), @lines) {	1097
785	# $w = $_ if $w < $_;
786	# }
787	#
788	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1098	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
789	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1099	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
790	#}	1100
		1101	$overlay
		1102	}
791		1103
792	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1104	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
793		1105
794	Create a new (empty) overlay at the given position with the given	1106	Create a new (empty) overlay at the given position with the given
795	width/height. C<$rstyle> defines the initial rendition style	1107	width/height. C<$rstyle> defines the initial rendition style
…		…
862		1174
863	=item $string = $term->locale_decode ($octets)	1175	=item $string = $term->locale_decode ($octets)
864		1176
865	Convert the given locale-encoded octets into a perl string.	1177	Convert the given locale-encoded octets into a perl string.
866		1178
		1179	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1180
		1181	XORs the rendition values in the given span with the provided value
		1182	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1183	refresh hooks to provide effects similar to the selection.
		1184
		1185	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1186
		1187	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1188	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1189	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1190	it instead. Both styles I<MUST NOT> contain font styles.
		1191
		1192	=item $term->scr_bell
		1193
		1194	Ring the bell!
		1195
867	=item $term->scr_add_lines ($string)	1196	=item $term->scr_add_lines ($string)
868		1197
869	Write the given text string to the screen, as if output by the application	1198	Write the given text string to the screen, as if output by the application
870	running inside the terminal. It may not contain command sequences (escape	1199	running inside the terminal. It may not contain command sequences (escape
871	codes), but is free to use line feeds, carriage returns and tabs. The	1200	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
885		1214
886	Write the octets given in C<$data> to the tty (i.e. as program input). To	1215	Write the octets given in C<$data> to the tty (i.e. as program input). To
887	pass characters instead of octets, you should convert your strings first	1216	pass characters instead of octets, you should convert your strings first
888	to the locale-specific encoding using C<< $term->locale_encode >>.	1217	to the locale-specific encoding using C<< $term->locale_encode >>.
889		1218
		1219	=item $old_events = $term->pty_ev_events ([$new_events])
		1220
		1221	Replaces the event mask of the pty watcher by the given event mask. Can
		1222	be used to suppress input and output handling to the pty/tty. See the
		1223	description of C<< urxvt::timer->events >>. Make sure to always restore
		1224	the previous value.
		1225
890	=item $windowid = $term->parent	1226	=item $windowid = $term->parent
891		1227
892	Return the window id of the toplevel window.	1228	Return the window id of the toplevel window.
893		1229
894	=item $windowid = $term->vt	1230	=item $windowid = $term->vt
895		1231
896	Return the window id of the terminal window.	1232	Return the window id of the terminal window.
897		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
898	=item $window_width = $term->width	1241	=item $window_width = $term->width
899		1242
900	=item $window_height = $term->height	1243	=item $window_height = $term->height
901		1244
902	=item $font_width = $term->fwidth	1245	=item $font_width = $term->fwidth
…		…
915		1258
916	=item $max_scrollback = $term->saveLines	1259	=item $max_scrollback = $term->saveLines
917		1260
918	=item $nrow_plus_saveLines = $term->total_rows	1261	=item $nrow_plus_saveLines = $term->total_rows
919		1262
920	=item $lines_in_scrollback = $term->nsaved	1263	=item $topmost_scrollback_row = $term->top_row
921		1264
922	Return various integers describing terminal characteristics.	1265	Return various integers describing terminal characteristics.
923		1266
		1267	=item $x_display = $term->display_id
		1268
		1269	Return the DISPLAY used by rxvt-unicode.
		1270
924	=item $lc_ctype = $term->locale	1271	=item $lc_ctype = $term->locale
925		1272
926	Returns the LC_CTYPE category string used by this rxvt-unicode.	1273	Returns the LC_CTYPE category string used by this rxvt-unicode.
927		1274
928	=item $x_display = $term->display_id	1275	=item $env = $term->env
929		1276
930	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	}
931		1289
932	=item $modifiermask = $term->ModLevel3Mask	1290	=item $modifiermask = $term->ModLevel3Mask
933		1291
934	=item $modifiermask = $term->ModMetaMask	1292	=item $modifiermask = $term->ModMetaMask
935		1293
…		…
938	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
939	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.
940		1298
941	=item $view_start = $term->view_start ([$newvalue])	1299	=item $view_start = $term->view_start ([$newvalue])
942		1300
943	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
944	C<0>, which displays the normal terminal contents. Larger values scroll	1302	C<0>, which displays the normal terminal contents. Lower values scroll
945	this many lines into the scrollback buffer.	1303	this many lines into the scrollback buffer.
946		1304
947	=item $term->want_refresh	1305	=item $term->want_refresh
948		1306
949	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1307	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1028	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.
1029		1387
1030	=item $offset = $line->offset_of ($row, $col)	1388	=item $offset = $line->offset_of ($row, $col)
1031		1389
1032	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
1033	line.	1391	line. Works for rows outside the line, too, and returns corresponding
		1392	offsets outside the string.
1034		1393
1035	=item ($row, $col) = $line->coord_of ($offset)	1394	=item ($row, $col) = $line->coord_of ($offset)
1036		1395
1037	Translates a string offset into terminal coordinates again.	1396	Translates a string offset into terminal coordinates again.
1038		1397
…		…
1175	$item->{render} \|\|= sub { $_[0]{text} };	1534	$item->{render} \|\|= sub { $_[0]{text} };
1176		1535
1177	push @{ $self->{item} }, $item;	1536	push @{ $self->{item} }, $item;
1178	}	1537	}
1179		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
1180	sub add_separator {	1561	sub add_separator {
1181	my ($self, $sep) = @_;	1562	my ($self, $sep) = @_;
1182		1563
1183	$sep \|\|= "=";	1564	$sep \|\|= "=";
1184		1565
…		…
1188	render => sub { $sep x $self->{term}->ncol },	1569	render => sub { $sep x $self->{term}->ncol },
1189	activate => sub { },	1570	activate => sub { },
1190	});	1571	});
1191	}	1572	}
1192		1573
1193	sub add_title {	1574	=item $popup->add_button ($text, $cb)
1194	my ($self, $title) = @_;
1195		1575
1196	$self->add_item ({	1576	Adds a clickable button to the popup. C<$cb> is called whenever it is
1197	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1577	selected.
1198	text => $title,	1578
1199	activate => sub { },	1579	=cut
1200	});
1201	}
1202		1580
1203	sub add_button {	1581	sub add_button {
1204	my ($self, $text, $cb) = @_;	1582	my ($self, $text, $cb) = @_;
1205		1583
1206	$self->add_item ({ type => "button", text => $text, activate => $cb});	1584	$self->add_item ({ type => "button", text => $text, activate => $cb});
1207	}	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
1208		1594
1209	sub add_toggle {	1595	sub add_toggle {
1210	my ($self, $text, $cb, $value) = @_;	1596	my ($self, $text, $cb, $value) = @_;
1211		1597
1212	my $item; $item = {	1598	my $item; $item = {
1213	type => "button",	1599	type => "button",
1214	text => " $text",	1600	text => " $text",
1215	value => $value,	1601	value => $value,
1216	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1602	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1217	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1603	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1218	};	1604	};
1219		1605
1220	$self->add_item ($item);	1606	$self->add_item ($item);
1221	}	1607	}
		1608
		1609	=item $popup->show
		1610
		1611	Displays the popup (which is initially hidden).
		1612
		1613	=cut
1222		1614
1223	sub show {	1615	sub show {
1224	my ($self) = @_;	1616	my ($self) = @_;
1225		1617
1226	local $urxvt::popup::self = $self;	1618	local $urxvt::popup::self = $self;
1227		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};
1228	local $ENV{LC_ALL} = $self->{term}->locale;	1623	$env->{LC_CTYPE} = $self->{term}->locale;
1229		1624
1230	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",
1231	"--transient-for" => $self->{term}->parent,	1629	"--transient-for" => $self->{term}->parent,
1232	"-display" => $self->{term}->display_id,	1630	"-display" => $self->{term}->display_id,
1233	"-pe" => "urxvt-popup")	1631	"-pe" => "urxvt-popup")
1234	or die "unable to create popup window\n";	1632	or die "unable to create popup window\n";
1235	}	1633	}
1236		1634
1237	sub DESTROY {	1635	sub DESTROY {
1238	my ($self) = @_;	1636	my ($self) = @_;
1239		1637
1240	delete $self->{term}{_destroy}{$self};	1638	delete $self->{term}{_destroy}{$self};
1241	$self->{term}->ungrab;	1639	$self->{term}->ungrab;
1242	}	1640	}
		1641
		1642	=back
1243		1643
1244	=head2 The C<urxvt::timer> Class	1644	=head2 The C<urxvt::timer> Class
1245		1645
1246	This class implements timer watchers/events. Time is represented as a	1646	This class implements timer watchers/events. Time is represented as a
1247	fractional number of seconds since the epoch. Example:	1647	fractional number of seconds since the epoch. Example:
…		…
1286		1686
1287	=item $timer = $timer->start ($tstamp)	1687	=item $timer = $timer->start ($tstamp)
1288		1688
1289	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.
1290		1690
		1691	=item $timer = $timer->after ($delay)
		1692
		1693	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
		1694
1291	=item $timer = $timer->stop	1695	=item $timer = $timer->stop
1292		1696
1293	Stop the timer.	1697	Stop the timer.
1294		1698
1295	=back	1699	=back
…		…
1300		1704
1301	$term->{socket} = ...	1705	$term->{socket} = ...
1302	$term->{iow} = urxvt::iow	1706	$term->{iow} = urxvt::iow
1303	->new	1707	->new
1304	->fd (fileno $term->{socket})	1708	->fd (fileno $term->{socket})
1305	->events (1) # wait for read data	1709	->events (urxvt::EVENT_READ)
1306	->start	1710	->start
1307	->cb (sub {	1711	->cb (sub {
1308	my ($iow, $revents) = @_;	1712	my ($iow, $revents) = @_;
1309	# $revents must be 1 here, no need to check	1713	# $revents must be 1 here, no need to check
1310	sysread $term->{socket}, my $buf, 8192	1714	sysread $term->{socket}, my $buf, 8192
…		…
1327		1731
1328	Set the filedescriptor (not handle) to watch.	1732	Set the filedescriptor (not handle) to watch.
1329		1733
1330	=item $iow = $iow->events ($eventmask)	1734	=item $iow = $iow->events ($eventmask)
1331		1735
1332	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	1736	Set the event mask to watch. The only allowed values are
1333	data, Bit #1 (value C<2>) enables watching for write data.	1737	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		1738	together, or C<urxvt::EVENT_NONE>.
1334		1739
1335	=item $iow = $iow->start	1740	=item $iow = $iow->start
1336		1741
1337	Start watching for requested events on the given handle.	1742	Start watching for requested events on the given handle.
1338		1743
…		…
1353		1758
1354	=item == 0 - fatal messages	1759	=item == 0 - fatal messages
1355		1760
1356	=item >= 3 - script loading and management	1761	=item >= 3 - script loading and management
1357		1762
1358	=item >=10 - all events received	1763	=item >=10 - all called hooks
		1764
		1765	=item >=11 - hook reutrn values
1359		1766
1360	=back	1767	=back
1361		1768
1362	=head1 AUTHOR	1769	=head1 AUTHOR
1363		1770

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.68 by root, Mon Jan 9 20:00:31 2006 UTC vs. Revision 1.111 by root, Thu Jan 19 19:52:54 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.68 by root, Mon Jan 9 20:00:31 2006 UTC vs.
Revision 1.111 by root, Thu Jan 19 19:52:54 2006 UTC