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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.72 by root, Mon Jan 9 23:30:01 2006 UTC vs.
Revision 1.120 by root, Fri Jan 20 22:05:41 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	evaluation, 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.
		166
		167	=item tabbed
		168
		169	This transforms the terminal into a tabbar with additional terminals, that
		170	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		171	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		172	button per tab.
		173
		174	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		175	B<Shift-Right> will switch to the tab left or right of the current one,
		176	while B<Shift-Down> creates a new tab.
82		177
83	=item mark-urls	178	=item mark-urls
84		179
85	Uses per-line display filtering (C<on_line_update>) to underline urls.	180	Uses per-line display filtering (C<on_line_update>) to underline urls and
		181	make them clickable. When middle-clicked, the program specified in the
		182	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		183	the URL as first argument.
		184
		185	=item automove-background
		186
		187	This is basically a one-line extension that dynamically changes the background pixmap offset
		188	to the window position, in effect creating the same effect as pseudo transparency with
		189	a custom pixmap. No scaling is supported in this mode. Exmaple:
		190
		191	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
86		192
87	=item block-graphics-to-ascii	193	=item block-graphics-to-ascii
88		194
89	A not very useful example of filtering all text output to the terminal,	195	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	196	by replacing all line-drawing characters (U+2500 .. U+259F) by a
91	similar-looking ascii character.	197	similar-looking ascii character.
92		198
		199	=item digital-clock
		200
		201	Displays a digital clock using the built-in overlay.
		202
93	=item example-refresh-hooks	203	=item example-refresh-hooks
94		204
95	Displays a very simple digital clock in the upper right corner of the	205	Displays a very simple digital clock in the upper right corner of the
96	window. Illustrates overwriting the refresh callbacks to create your own	206	window. Illustrates overwriting the refresh callbacks to create your own
97	overlays or changes.	207	overlays or changes.
98		208
		209	=item selection-pastebin
		210
		211	This is a little rarely useful extension that Uploads the selection as
		212	textfile to a remote site (or does other things). (The implementation is
		213	not currently secure for use in a multiuser environment as it writes to
		214	F</tmp> directly.).
		215
		216	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		217	i.e.
		218
		219	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		220
		221	Pressing this combination runs a command with C<%> replaced by the name of
		222	the textfile. This command can be set via a resource:
		223
		224	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		225
		226	And the default is likely not useful to anybody but the few people around
		227	here :)
		228
		229	The name of the textfile is the hex encoded md5 sum of the selection, so
		230	the same content should lead to the same filename.
		231
		232	After a successful upload the selection will be replaced by the text given
		233	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		234	for the filename):
		235
		236	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		237
99	=back	238	=back
		239
		240	=head1 API DOCUMENTATION
100		241
101	=head2 General API Considerations	242	=head2 General API Considerations
102		243
103	All objects (such as terminals, time watchers etc.) are typical	244	All objects (such as terminals, time watchers etc.) are typical
104	reference-to-hash objects. The hash can be used to store anything you	245	reference-to-hash objects. The hash can be used to store anything you
…		…
117	=over 4	258	=over 4
118		259
119	=item $text	260	=item $text
120		261
121	Rxvt-unicodes special way of encoding text, where one "unicode" character	262	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.	263	always represents one screen cell. See L<ROW_t> for a discussion of this format.
123		264
124	=item $string	265	=item $string
125		266
126	A perl text string, with an emphasis on I<text>. It can store all unicode	267	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	268	characters and is to be distinguished with text encoded in a specific
…		…
173	called whenever the relevant event happens.	314	called whenever the relevant event happens.
174		315
175	The first argument passed to them is an extension oject as described in	316	The first argument passed to them is an extension oject as described in
176	the in the C<Extension Objects> section.	317	the in the C<Extension Objects> section.
177		318
178	B<All> of these hooks must return a boolean value. If it is true, then the	319	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	320	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.	321	relevant action might not be carried out by the C++ code.
181		322
182	I<< When in doubt, return a false value (preferably C<()>). >>	323	I<< When in doubt, return a false value (preferably C<()>). >>
183		324
184	=over 4	325	=over 4
185		326
186	=item on_init $term	327	=item on_init $term
187		328
188	Called after a new terminal object has been initialized, but before	329	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	330	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	331	call or deliver senseless data, as terminal size and other characteristics
191	have not yet been determined. You can safely query and change resources,	332	have not yet been determined. You can safely query and change resources
192	though.	333	and options, though. For many purposes the C<on_start> hook is a better
		334	place.
		335
		336	=item on_start $term
		337
		338	Called at the very end of initialisation of a new terminal, just before
		339	trying to map (display) the toplevel and returning to the mainloop.
		340
		341	=item on_destroy $term
		342
		343	Called whenever something tries to destroy terminal, before doing anything
		344	yet. If this hook returns true, then destruction is skipped, but this is
		345	rarely a good idea.
193		346
194	=item on_reset $term	347	=item on_reset $term
195		348
196	Called after the screen is "reset" for any reason, such as resizing or	349	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	350	control sequences. Here is where you can react on changes to size-related
198	variables.	351	variables.
199		352
200	=item on_start $term	353	=item on_child_start $term, $pid
201		354
202	Called at the very end of initialisation of a new terminal, just before	355	Called just after the child process has been C<fork>ed.
203	returning to the mainloop.	356
		357	=item on_child_exit $term, $status
		358
		359	Called just after the child process has exited. C<$status> is the status
		360	from C<waitpid>.
204		361
205	=item on_sel_make $term, $eventtime	362	=item on_sel_make $term, $eventtime
206		363
207	Called whenever a selection has been made by the user, but before the	364	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	365	selection text is copied, so changes to the beginning, end or type of the
…		…
222	=item on_sel_extend $term	379	=item on_sel_extend $term
223		380
224	Called whenever the user tries to extend the selection (e.g. with a double	381	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	382	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	383	should extend the selection itelf and return true to suppress the built-in
227	processing.	384	processing. This can happen multiple times, as long as the callback
		385	returns true, it will be called on every further click by the user and is
		386	supposed to enlarge the selection more and more, if possible.
228		387
229	See the F<selection> example extension.	388	See the F<selection> example extension.
230		389
231	=item on_view_change $term, $offset	390	=item on_view_change $term, $offset
232		391
…		…
299		458
300	Called whenever the user presses a key combination that has a	459	Called whenever the user presses a key combination that has a
301	C<perl:string> action bound to it (see description of the B<keysym>	460	C<perl:string> action bound to it (see description of the B<keysym>
302	resource in the @@RXVT_NAME@@(1) manpage).	461	resource in the @@RXVT_NAME@@(1) manpage).
303		462
		463	=item on_x_event $term, $event
		464
		465	Called on every X event received on the vt window (and possibly other
		466	windows). Should only be used as a last resort. Most event structure
		467	members are not passed.
		468
304	=item on_focus_in $term	469	=item on_focus_in $term
305		470
306	Called whenever the window gets the keyboard focus, before rxvt-unicode	471	Called whenever the window gets the keyboard focus, before rxvt-unicode
307	does focus in processing.	472	does focus in processing.
308		473
309	=item on_focus_out $term	474	=item on_focus_out $term
310		475
311	Called wheneever the window loses keyboard focus, before rxvt-unicode does	476	Called wheneever the window loses keyboard focus, before rxvt-unicode does
312	focus out processing.	477	focus out processing.
313		478
		479	=item on_configure_notify $term, $event
		480
		481	=item on_property_notify $term, $event
		482
314	=item on_key_press $term, $event, $keysym, $octets	483	=item on_key_press $term, $event, $keysym, $octets
315		484
316	=item on_key_release $term, $event, $keysym	485	=item on_key_release $term, $event, $keysym
317		486
318	=item on_button_press $term, $event	487	=item on_button_press $term, $event
…		…
327		496
328	Called whenever the corresponding X event is received for the terminal If	497	Called whenever the corresponding X event is received for the terminal If
329	the hook returns true, then the even will be ignored by rxvt-unicode.	498	the hook returns true, then the even will be ignored by rxvt-unicode.
330		499
331	The event is a hash with most values as named by Xlib (see the XEvent	500	The event is a hash with most values as named by Xlib (see the XEvent
332	manpage), with the additional members C<row> and C<col>, which are the row	501	manpage), with the additional members C<row> and C<col>, which are the
333	and column under the mouse cursor.	502	(real, not screen-based) row and column under the mouse cursor.
334		503
335	C<on_key_press> additionally receives the string rxvt-unicode would	504	C<on_key_press> additionally receives the string rxvt-unicode would
336	output, if any, in locale-specific encoding.	505	output, if any, in locale-specific encoding.
337		506
338	subwindow.	507	subwindow.
339		508
340	=back	509	=item on_client_message $term, $event
341		510
342	=head2 Variables in the C<urxvt> Package	511	=item on_wm_protocols $term, $event
343		512
344	=over 4	513	=item on_wm_delete_window $term, $event
345		514
346	=item $urxvt::TERM	515	Called when various types of ClientMessage events are received (all with
347		516	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
348	The current terminal. This variable stores the current C<urxvt::term>
349	object, whenever a callback/hook is executing.
350
351	=back
352
353	=head2 Functions in the C<urxvt> Package
354
355	=over 4
356
357	=item $term = new urxvt [arg...]
358
359	Creates a new terminal, very similar as if you had started it with
360	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
361	if the new instance couldn't be created. Returns C<undef> if the new
362	instance didn't initialise perl, and the terminal object otherwise. The
363	C<init> and C<start> hooks will be called during the call.
364
365	=item urxvt::fatal $errormessage
366
367	Fatally aborts execution with the given error message. Avoid at all
368	costs! The only time this is acceptable is when the terminal process
369	starts up.
370
371	=item urxvt::warn $string
372
373	Calls C<rxvt_warn> with the given string which should not include a
374	newline. The module also overwrites the C<warn> builtin with a function
375	that calls this function.
376
377	Using this function has the advantage that its output ends up in the
378	correct place, e.g. on stderr of the connecting urxvtc client.
379
380	=item $is_safe = urxvt::safe
381
382	Returns true when it is safe to do potentially unsafe things, such as
383	evaluating perl code specified by the user. This is true when urxvt was
384	started setuid or setgid.
385
386	=item $time = urxvt::NOW
387
388	Returns the "current time" (as per the event loop).
389
390	=item urxvt::CurrentTime
391
392	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
393	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
394	Button4Mask, Button5Mask, AnyModifier
395
396	Various constants for use in X calls and event processing.
397
398	=back
399
400	=head2 RENDITION
401
402	Rendition bitsets contain information about colour, font, font styles and
403	similar information for each screen cell.
404
405	The following "macros" deal with changes in rendition sets. You should
406	never just create a bitset, you should always modify an existing one,
407	as they contain important information required for correct operation of
408	rxvt-unicode.
409
410	=over 4
411
412	=item $rend = urxvt::DEFAULT_RSTYLE
413
414	Returns the default rendition, as used when the terminal is starting up or
415	being reset. Useful as a base to start when creating renditions.
416
417	=item $rend = urxvt::OVERLAY_RSTYLE
418
419	Return the rendition mask used for overlays by default.
420
421	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
422
423	Return the bit that enabled bold, italic, blink, reverse-video and
424	underline, respectively. To enable such a style, just logically OR it into
425	the bitset.
426
427	=item $foreground = urxvt::GET_BASEFG $rend
428
429	=item $background = urxvt::GET_BASEBG $rend
430
431	Return the foreground/background colour index, respectively.
432
433	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
434
435	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
436
437	Replace the foreground/background colour in the rendition mask with the
438	specified one.
439
440	=item $value = urxvt::GET_CUSTOM ($rend)
441
442	Return the "custom" value: Every rendition has 5 bits for use by
443	extensions. They can be set and changed as you like and are initially
444	zero.
445
446	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
447
448	Change the custom value.
449		517
450	=back	518	=back
451		519
452	=cut	520	=cut
453		521
…		…
459	use Scalar::Util ();	527	use Scalar::Util ();
460	use List::Util ();	528	use List::Util ();
461		529
462	our $VERSION = 1;	530	our $VERSION = 1;
463	our $TERM;	531	our $TERM;
		532	our @TERM_INIT;
		533	our @TERM_EXT;
464	our @HOOKNAME;	534	our @HOOKNAME;
465	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	535	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
466	our %OPTION;	536	our %OPTION;
		537
467	our $LIBDIR;	538	our $LIBDIR;
		539	our $RESNAME;
		540	our $RESCLASS;
		541	our $RXVTNAME;
		542
		543	=head2 Variables in the C<urxvt> Package
		544
		545	=over 4
		546
		547	=item $urxvt::LIBDIR
		548
		549	The rxvt-unicode library directory, where, among other things, the perl
		550	modules and scripts are stored.
		551
		552	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		553
		554	The resource class and name rxvt-unicode uses to look up X resources.
		555
		556	=item $urxvt::RXVTNAME
		557
		558	The basename of the installed binaries, usually C<urxvt>.
		559
		560	=item $urxvt::TERM
		561
		562	The current terminal. This variable stores the current C<urxvt::term>
		563	object, whenever a callback/hook is executing.
		564
		565	=item @urxvt::TERM_INIT
		566
		567	All coderefs in this array will be called as methods of the next newly
		568	created C<urxvt::term> object (during the C<on_init> phase). The array
		569	gets cleared before the codereferences that were in it are being executed,
		570	so coderefs can push themselves onto it again if they so desire.
		571
		572	This complements to the perl-eval commandline option, but gets executed
		573	first.
		574
		575	=item @urxvt::TERM_EXT
		576
		577	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		578	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		579	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		580
		581	=back
		582
		583	=head2 Functions in the C<urxvt> Package
		584
		585	=over 4
		586
		587	=item urxvt::fatal $errormessage
		588
		589	Fatally aborts execution with the given error message. Avoid at all
		590	costs! The only time this is acceptable is when the terminal process
		591	starts up.
		592
		593	=item urxvt::warn $string
		594
		595	Calls C<rxvt_warn> with the given string which should not include a
		596	newline. The module also overwrites the C<warn> builtin with a function
		597	that calls this function.
		598
		599	Using this function has the advantage that its output ends up in the
		600	correct place, e.g. on stderr of the connecting urxvtc client.
		601
		602	Messages have a size limit of 1023 bytes currently.
		603
		604	=item $time = urxvt::NOW
		605
		606	Returns the "current time" (as per the event loop).
		607
		608	=item urxvt::CurrentTime
		609
		610	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		611	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		612	Button4Mask, Button5Mask, AnyModifier
		613
		614	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		615	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		616	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		617	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		618	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		619	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		620	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		621
		622	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		623	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		624	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		625	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		626	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		627	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		628	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		629
		630	Various constants for use in X calls and event processing.
		631
		632	=back
		633
		634	=head2 RENDITION
		635
		636	Rendition bitsets contain information about colour, font, font styles and
		637	similar information for each screen cell.
		638
		639	The following "macros" deal with changes in rendition sets. You should
		640	never just create a bitset, you should always modify an existing one,
		641	as they contain important information required for correct operation of
		642	rxvt-unicode.
		643
		644	=over 4
		645
		646	=item $rend = urxvt::DEFAULT_RSTYLE
		647
		648	Returns the default rendition, as used when the terminal is starting up or
		649	being reset. Useful as a base to start when creating renditions.
		650
		651	=item $rend = urxvt::OVERLAY_RSTYLE
		652
		653	Return the rendition mask used for overlays by default.
		654
		655	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		656
		657	Return the bit that enabled bold, italic, blink, reverse-video and
		658	underline, respectively. To enable such a style, just logically OR it into
		659	the bitset.
		660
		661	=item $foreground = urxvt::GET_BASEFG $rend
		662
		663	=item $background = urxvt::GET_BASEBG $rend
		664
		665	Return the foreground/background colour index, respectively.
		666
		667	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		668
		669	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		670
		671	Replace the foreground/background colour in the rendition mask with the
		672	specified one.
		673
		674	=item $value = urxvt::GET_CUSTOM $rend
		675
		676	Return the "custom" value: Every rendition has 5 bits for use by
		677	extensions. They can be set and changed as you like and are initially
		678	zero.
		679
		680	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		681
		682	Change the custom value.
		683
		684	=back
		685
		686	=cut
468		687
469	BEGIN {	688	BEGIN {
470	urxvt->bootstrap;
471
472	# overwrite perl's warn	689	# overwrite perl's warn
473	*CORE::GLOBAL::warn = sub {	690	*CORE::GLOBAL::warn = sub {
474	my $msg = join "", @_;	691	my $msg = join "", @_;
475	$msg .= "\n"	692	$msg .= "\n"
476	unless $msg =~ /\n$/;	693	unless $msg =~ /\n$/;
477	urxvt::warn ($msg);	694	urxvt::warn ($msg);
478	};	695	};
479
480	delete $ENV{IFS};
481	delete $ENV{CDPATH};
482	delete $ENV{BASH_ENV};
483	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
484	}	696	}
485		697
486	my @hook_count;
487	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	698	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
488		699
489	sub verbose {	700	sub verbose {
490	my ($level, $msg) = @_;	701	my ($level, $msg) = @_;
491	warn "$msg\n" if $level <= $verbosity;	702	warn "$msg\n" if $level <= $verbosity;
492	}	703	}
493		704
494	my $extension_pkg = "extension0000";
495	my %extension_pkg;	705	my %extension_pkg;
496		706
497	# load a single script into its own package, once only	707	# load a single script into its own package, once only
498	sub extension_package($) {	708	sub extension_package($) {
499	my ($path) = @_;	709	my ($path) = @_;
500		710
501	$extension_pkg{$path} \|\|= do {	711	$extension_pkg{$path} \|\|= do {
502	my $pkg = "urxvt::" . ($extension_pkg++);	712	$path =~ /([^\/\\]+)$/;
		713	my $pkg = $1;
		714	$pkg =~ s/[^[:word:]]/_/g;
		715	$pkg = "urxvt::ext::$pkg";
503		716
504	verbose 3, "loading extension '$path' into package '$pkg'";	717	verbose 3, "loading extension '$path' into package '$pkg'";
505		718
506	open my $fh, "<:raw", $path	719	open my $fh, "<:raw", $path
507	or die "$path: $!";	720	or die "$path: $!";
508		721
509	my $source = untaint	722	my $source =
510	"package $pkg; use strict; use utf8;\n"	723	"package $pkg; use strict; use utf8;\n"
511	. "use base urxvt::term::extension::;\n"
512	. "#line 1 \"$path\"\n{\n"	724	. "#line 1 \"$path\"\n{\n"
513	. (do { local $/; <$fh> })	725	. (do { local $/; <$fh> })
514	. "\n};\n1";	726	. "\n};\n1";
515		727
516	eval $source	728	eval $source
…		…
530	if ($htype == 0) { # INIT	742	if ($htype == 0) { # INIT
531	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	743	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
532		744
533	my %ext_arg;	745	my %ext_arg;
534		746
		747	{
		748	my @init = @TERM_INIT;
		749	@TERM_INIT = ();
		750	$_->($TERM) for @init;
		751	my @pkg = @TERM_EXT;
		752	@TERM_EXT = ();
		753	$TERM->register_package ($_) for @pkg;
		754	}
		755
535	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	756	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
536	if ($_ eq "default") {	757	if ($_ eq "default") {
537	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	758	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
538	} elsif (/^-(.*)$/) {	759	} elsif (/^-(.*)$/) {
539	delete $ext_arg{$1};	760	delete $ext_arg{$1};
540	} elsif (/^([^<]+)<(.*)>$/) {	761	} elsif (/^([^<]+)<(.*)>$/) {
…		…
565	if $verbosity >= 10;	786	if $verbosity >= 10;
566		787
567	keys %$cb;	788	keys %$cb;
568		789
569	while (my ($pkg, $cb) = each %$cb) {	790	while (my ($pkg, $cb) = each %$cb) {
570	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	791	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
571	and last;	792	$retval \|\|= $retval_;
572		793
573	if ($@) {	794	if ($@) {
574	$TERM->ungrab; # better to lose the grab than the session	795	$TERM->ungrab; # better to lose the grab than the session
575	warn $@;	796	warn $@;
576	}	797	}
577	}	798	}
		799
		800	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		801	if $verbosity >= 11;
578	}	802	}
579		803
580	if ($htype == 1) { # DESTROY	804	if ($htype == 1) { # DESTROY
581	if (my $hook = delete $TERM->{_hook}) {
582	for my $htype (0..$#$hook) {
583	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
584	or set_should_invoke $htype, 0;
585	}
586	}
587
588	# clear package objects	805	# clear package objects
589	%$_ = () for values %{ $TERM->{_pkg} };	806	%$_ = () for values %{ $TERM->{_pkg} };
590		807
591	# clear package	808	# clear package
592	%$TERM = ();	809	%$TERM = ();
…		…
606	while (my ($name, $cb) = each %hook) {	823	while (my ($name, $cb) = each %hook) {
607	my $htype = $HOOKTYPE{uc $name};	824	my $htype = $HOOKTYPE{uc $name};
608	defined $htype	825	defined $htype
609	or Carp::croak "unsupported hook type '$name'";	826	or Carp::croak "unsupported hook type '$name'";
610		827
		828	$self->set_should_invoke ($htype, +1)
611	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	829	unless exists $self->{term}{_hook}[$htype]{$pkg};
612	$hook_count[$htype]++
613	or urxvt::set_should_invoke $htype, 1;
614	}
615		830
616	$self->{term}{_hook}[$htype]{$pkg} = $cb;	831	$self->{term}{_hook}[$htype]{$pkg} = $cb;
617	}	832	}
618	}	833	}
619		834
…		…
624	for my $name (@hook) {	839	for my $name (@hook) {
625	my $htype = $HOOKTYPE{uc $name};	840	my $htype = $HOOKTYPE{uc $name};
626	defined $htype	841	defined $htype
627	or Carp::croak "unsupported hook type '$name'";	842	or Carp::croak "unsupported hook type '$name'";
628		843
		844	$self->set_should_invoke ($htype, -1)
629	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	845	if delete $self->{term}{_hook}[$htype]{$pkg};
630	--$hook_count[$htype]
631	or urxvt::set_should_invoke $htype, 0;
632	}
633	}	846	}
634	}	847	}
635		848
636	our $AUTOLOAD;	849	our $AUTOLOAD;
637		850
…		…
668		881
669	=head2 The C<urxvt::anyevent> Class	882	=head2 The C<urxvt::anyevent> Class
670		883
671	The sole purpose of this class is to deliver an interface to the	884	The sole purpose of this class is to deliver an interface to the
672	C<AnyEvent> module - any module using it will work inside urxvt without	885	C<AnyEvent> module - any module using it will work inside urxvt without
673	further work. The only exception is that you cannot wait on condition	886	further programming. The only exception is that you cannot wait on
674	variables, but non-blocking condvar use is ok. What this means is that you	887	condition variables, but non-blocking condvar use is ok. What this means
675	cannot use blocking APIs, but the non-blocking variant should work.	888	is that you cannot use blocking APIs, but the non-blocking variant should
		889	work.
676		890
677	=cut	891	=cut
678		892
679	our $VERSION = 1;	893	our $VERSION = 1;
680		894
…		…
742	# find on_xxx subs in the package and register them	956	# find on_xxx subs in the package and register them
743	# as hooks	957	# as hooks
744	sub register_package {	958	sub register_package {
745	my ($self, $pkg, $argv) = @_;	959	my ($self, $pkg, $argv) = @_;
746		960
		961	no strict 'refs';
		962
		963	urxvt::verbose 6, "register package $pkg to $self";
		964
		965	@{"$pkg\::ISA"} = urxvt::term::extension::;
		966
747	my $proxy = bless {	967	my $proxy = bless {
748	_pkg => $pkg,	968	_pkg => $pkg,
749	argv => $argv,	969	argv => $argv,
750	}, $pkg;	970	}, $pkg;
751	Scalar::Util::weaken ($proxy->{term} = $self);	971	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
757	$proxy->enable ($name => $ref);	977	$proxy->enable ($name => $ref);
758	}	978	}
759	}	979	}
760	}	980	}
761		981
		982	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		983
		984	Creates a new terminal, very similar as if you had started it with system
		985	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		986	hash which defines the environment of the new terminal.
		987
		988	Croaks (and probably outputs an error message) if the new instance
		989	couldn't be created. Returns C<undef> if the new instance didn't
		990	initialise perl, and the terminal object otherwise. The C<init> and
		991	C<start> hooks will be called during this call.
		992
		993	=cut
		994
		995	sub new {
		996	my ($class, $env, @args) = @_;
		997
		998	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		999	}
		1000
762	=item $term->destroy	1001	=item $term->destroy
763		1002
764	Destroy the terminal object (close the window, free resources etc.).	1003	Destroy the terminal object (close the window, free resources
		1004	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1005	watchers (timers, io watchers) are still active.
		1006
		1007	=item $term->exec_async ($cmd[, @args])
		1008
		1009	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1010	("starts") programs in the background. This function takes care of setting
		1011	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1012	be preferred over explicit calls to C<exec> or C<system>.
		1013
		1014	Returns the pid of the subprocess or C<undef> on error.
		1015
		1016	=cut
		1017
		1018	sub exec_async {
		1019	my $self = shift;
		1020
		1021	my $pid = fork;
		1022
		1023	return $pid
		1024	if !defined $pid or $pid;
		1025
		1026	%ENV = %{ $self->env };
		1027
		1028	exec @_;
		1029	urxvt::_exit 255;
		1030	}
765		1031
766	=item $isset = $term->option ($optval[, $set])	1032	=item $isset = $term->option ($optval[, $set])
767		1033
768	Returns true if the option specified by C<$optval> is enabled, and	1034	Returns true if the option specified by C<$optval> is enabled, and
769	optionally change it. All option values are stored by name in the hash	1035	optionally change it. All option values are stored by name in the hash
…		…
772	Here is a a likely non-exhaustive list of option names, please see the	1038	Here is a a likely non-exhaustive list of option names, please see the
773	source file F</src/optinc.h> to see the actual list:	1039	source file F</src/optinc.h> to see the actual list:
774		1040
775	borderLess console cursorBlink cursorUnderline hold iconic insecure	1041	borderLess console cursorBlink cursorUnderline hold iconic insecure
776	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1042	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
777	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1043	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
778	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1044	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
779	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1045	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
780	tripleclickwords utmpInhibit visualBell	1046	transparent tripleclickwords utmpInhibit visualBell
781		1047
782	=item $value = $term->resource ($name[, $newval])	1048	=item $value = $term->resource ($name[, $newval])
783		1049
784	Returns the current resource value associated with a given name and	1050	Returns the current resource value associated with a given name and
785	optionally sets a new value. Setting values is most useful in the C<init>	1051	optionally sets a new value. Setting values is most useful in the C<init>
…		…
802		1068
803	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1069	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
804	borderLess color cursorBlink cursorUnderline cutchars delete_key	1070	borderLess color cursorBlink cursorUnderline cutchars delete_key
805	display_name embed ext_bwidth fade font geometry hold iconName	1071	display_name embed ext_bwidth fade font geometry hold iconName
806	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1072	imFont imLocale inputMethod insecure int_bwidth intensityStyles
807	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1073	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
808	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1074	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
809	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1075	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
810	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1076	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
811	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1077	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
812	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1078	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
813	shade term_name title transparent transparent_all tripleclickwords	1079	secondaryScreen secondaryScroll selectstyle shade term_name title
814	utmpInhibit visualBell	1080	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1081	visualBell
815		1082
816	=cut	1083	=cut
817		1084
818	sub resource($$;$) {	1085	sub resource($$;$) {
819	my ($self, $name) = (shift, shift);	1086	my ($self, $name) = (shift, shift);
820	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1087	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
821	&urxvt::term::_resource	1088	&urxvt::term::_resource
822	}	1089	}
823		1090
		1091	=item $value = $term->x_resource ($pattern)
		1092
		1093	Returns the X-Resource for the given pattern, excluding the program or
		1094	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1095	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1096	resource with that pattern exists.
		1097
		1098	This method should only be called during the C<on_start> hook, as there is
		1099	only one resource database per display, and later invocations might return
		1100	the wrong resources.
		1101
824	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1102	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
825		1103
826	Adds a keymap translation exactly as specified via a resource. See the	1104	Adds a keymap translation exactly as specified via a resource. See the
827	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1105	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
828		1106
…		…
843	=item ($row, $col) = $term->selection_end ([$row, $col])	1121	=item ($row, $col) = $term->selection_end ([$row, $col])
844		1122
845	Return the current values of the selection mark, begin or end positions,	1123	Return the current values of the selection mark, begin or end positions,
846	and optionally set them to new values.	1124	and optionally set them to new values.
847		1125
		1126	=item $term->selection_make ($eventtime[, $rectangular])
		1127
		1128	Tries to make a selection as set by C<selection_beg> and
		1129	C<selection_end>. If C<$rectangular> is true (default: false), a
		1130	rectangular selection will be made. This is the prefered function to make
		1131	a selection.
		1132
848	=item $success = $term->selection_grab ($eventtime)	1133	=item $success = $term->selection_grab ($eventtime)
849		1134
850	Try to request the primary selection from the server (for example, as set	1135	Try to request the primary selection text from the server (for example, as
851	by the next method).	1136	set by the next method). No visual feedback will be given. This function
		1137	is mostly useful from within C<on_sel_grab> hooks.
852		1138
853	=item $oldtext = $term->selection ([$newtext])	1139	=item $oldtext = $term->selection ([$newtext])
854		1140
855	Return the current selection text and optionally replace it by C<$newtext>.	1141	Return the current selection text and optionally replace it by C<$newtext>.
856		1142
…		…
949	Convert the given locale-encoded octets into a perl string.	1235	Convert the given locale-encoded octets into a perl string.
950		1236
951	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1237	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
952		1238
953	XORs the rendition values in the given span with the provided value	1239	XORs the rendition values in the given span with the provided value
954	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1240	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
955	to the selection.	1241	refresh hooks to provide effects similar to the selection.
956		1242
957	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1243	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
958		1244
959	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1245	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
960	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1246	whitespace will additionally be xored with the C<$rstyle2>, which defaults
961	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines	1247	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
962	it instead.	1248	it instead. Both styles I<MUST NOT> contain font styles.
963		1249
964	=item $term->scr_bell	1250	=item $term->scr_bell
965		1251
966	Ring the bell!	1252	Ring the bell!
967		1253
…		…
1001		1287
1002	=item $windowid = $term->vt	1288	=item $windowid = $term->vt
1003		1289
1004	Return the window id of the terminal window.	1290	Return the window id of the terminal window.
1005		1291
		1292	=item $term->vt_emask_add ($x_event_mask)
		1293
		1294	Adds the specified events to the vt event mask. Useful e.g. when you want
		1295	to receive pointer events all the times:
		1296
		1297	$term->vt_emask_add (urxvt::PointerMotionMask);
		1298
1006	=item $window_width = $term->width	1299	=item $window_width = $term->width
1007		1300
1008	=item $window_height = $term->height	1301	=item $window_height = $term->height
1009		1302
1010	=item $font_width = $term->fwidth	1303	=item $font_width = $term->fwidth
…		…
1023		1316
1024	=item $max_scrollback = $term->saveLines	1317	=item $max_scrollback = $term->saveLines
1025		1318
1026	=item $nrow_plus_saveLines = $term->total_rows	1319	=item $nrow_plus_saveLines = $term->total_rows
1027		1320
1028	=item $lines_in_scrollback = $term->nsaved	1321	=item $topmost_scrollback_row = $term->top_row
1029		1322
1030	Return various integers describing terminal characteristics.	1323	Return various integers describing terminal characteristics.
1031		1324
		1325	=item $x_display = $term->display_id
		1326
		1327	Return the DISPLAY used by rxvt-unicode.
		1328
1032	=item $lc_ctype = $term->locale	1329	=item $lc_ctype = $term->locale
1033		1330
1034	Returns the LC_CTYPE category string used by this rxvt-unicode.	1331	Returns the LC_CTYPE category string used by this rxvt-unicode.
1035		1332
1036	=item $x_display = $term->display_id	1333	=item $env = $term->env
1037		1334
1038	Return the DISPLAY used by rxvt-unicode.	1335	Returns a copy of the environment in effect for the terminal as a hashref
		1336	similar to C<\%ENV>.
		1337
		1338	=cut
		1339
		1340	sub env {
		1341	if (my $env = $_[0]->_env) {
		1342	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1343	} else {
		1344	+{ %ENV }
		1345	}
		1346	}
1039		1347
1040	=item $modifiermask = $term->ModLevel3Mask	1348	=item $modifiermask = $term->ModLevel3Mask
1041		1349
1042	=item $modifiermask = $term->ModMetaMask	1350	=item $modifiermask = $term->ModMetaMask
1043		1351
…		…
1046	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1354	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1047	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1355	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1048		1356
1049	=item $view_start = $term->view_start ([$newvalue])	1357	=item $view_start = $term->view_start ([$newvalue])
1050		1358
1051	Returns the negative row number of the topmost line. Minimum value is	1359	Returns the row number of the topmost displayed line. Maximum value is
1052	C<0>, which displays the normal terminal contents. Larger values scroll	1360	C<0>, which displays the normal terminal contents. Lower values scroll
1053	this many lines into the scrollback buffer.	1361	this many lines into the scrollback buffer.
1054		1362
1055	=item $term->want_refresh	1363	=item $term->want_refresh
1056		1364
1057	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1365	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1136	Return the row number of the first/last row of the line, respectively.	1444	Return the row number of the first/last row of the line, respectively.
1137		1445
1138	=item $offset = $line->offset_of ($row, $col)	1446	=item $offset = $line->offset_of ($row, $col)
1139		1447
1140	Returns the character offset of the given row\|col pair within the logical	1448	Returns the character offset of the given row\|col pair within the logical
1141	line.	1449	line. Works for rows outside the line, too, and returns corresponding
		1450	offsets outside the string.
1142		1451
1143	=item ($row, $col) = $line->coord_of ($offset)	1452	=item ($row, $col) = $line->coord_of ($offset)
1144		1453
1145	Translates a string offset into terminal coordinates again.	1454	Translates a string offset into terminal coordinates again.
1146		1455
…		…
1259		1568
1260	Calls XUngrab for the most recent grab. Is called automatically on	1569	Calls XUngrab for the most recent grab. Is called automatically on
1261	evaluation errors, as it is better to lose the grab in the error case as	1570	evaluation errors, as it is better to lose the grab in the error case as
1262	the session.	1571	the session.
1263		1572
		1573	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1574
		1575	=item $atom_name = $term->XGetAtomName ($atom)
		1576
		1577	=item @atoms = $term->XListProperties ($window)
		1578
		1579	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1580
		1581	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1582
		1583	=item $term->XDeleteProperty ($window, $property)
		1584
		1585	=item $window = $term->DefaultRootWindow
		1586
		1587	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1588
		1589	=item $term->XMapWindow ($window)
		1590
		1591	=item $term->XUnmapWindow ($window)
		1592
		1593	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1594
		1595	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1596
		1597	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1598
		1599	Various X or X-related functions. The C<$term> object only serves as
		1600	the source of the display, otherwise those functions map more-or-less
		1601	directory onto the X functions of the same name.
		1602
1264	=back	1603	=back
1265		1604
1266	=cut	1605	=cut
1267		1606
1268	package urxvt::popup;	1607	package urxvt::popup;
…		…
1282		1621
1283	$item->{render} \|\|= sub { $_[0]{text} };	1622	$item->{render} \|\|= sub { $_[0]{text} };
1284		1623
1285	push @{ $self->{item} }, $item;	1624	push @{ $self->{item} }, $item;
1286	}	1625	}
		1626
		1627	=item $popup->add_title ($title)
		1628
		1629	Adds a non-clickable title to the popup.
		1630
		1631	=cut
		1632
		1633	sub add_title {
		1634	my ($self, $title) = @_;
		1635
		1636	$self->add_item ({
		1637	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1638	text => $title,
		1639	activate => sub { },
		1640	});
		1641	}
		1642
		1643	=item $popup->add_separator ([$sepchr])
		1644
		1645	Creates a separator, optionally using the character given as C<$sepchr>.
		1646
		1647	=cut
1287		1648
1288	sub add_separator {	1649	sub add_separator {
1289	my ($self, $sep) = @_;	1650	my ($self, $sep) = @_;
1290		1651
1291	$sep \|\|= "=";	1652	$sep \|\|= "=";
…		…
1296	render => sub { $sep x $self->{term}->ncol },	1657	render => sub { $sep x $self->{term}->ncol },
1297	activate => sub { },	1658	activate => sub { },
1298	});	1659	});
1299	}	1660	}
1300		1661
1301	sub add_title {	1662	=item $popup->add_button ($text, $cb)
1302	my ($self, $title) = @_;
1303		1663
1304	$self->add_item ({	1664	Adds a clickable button to the popup. C<$cb> is called whenever it is
1305	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1665	selected.
1306	text => $title,	1666
1307	activate => sub { },	1667	=cut
1308	});
1309	}
1310		1668
1311	sub add_button {	1669	sub add_button {
1312	my ($self, $text, $cb) = @_;	1670	my ($self, $text, $cb) = @_;
1313		1671
1314	$self->add_item ({ type => "button", text => $text, activate => $cb});	1672	$self->add_item ({ type => "button", text => $text, activate => $cb});
1315	}	1673	}
		1674
		1675	=item $popup->add_toggle ($text, $cb, $initial_value)
		1676
		1677	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1678	whenever it gets toggled, with a boolean indicating its value as its first
		1679	argument.
		1680
		1681	=cut
1316		1682
1317	sub add_toggle {	1683	sub add_toggle {
1318	my ($self, $text, $cb, $value) = @_;	1684	my ($self, $text, $cb, $value) = @_;
1319		1685
1320	my $item; $item = {	1686	my $item; $item = {
1321	type => "button",	1687	type => "button",
1322	text => " $text",	1688	text => " $text",
1323	value => $value,	1689	value => $value,
1324	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1690	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1325	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1691	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1326	};	1692	};
1327		1693
1328	$self->add_item ($item);	1694	$self->add_item ($item);
1329	}	1695	}
		1696
		1697	=item $popup->show
		1698
		1699	Displays the popup (which is initially hidden).
		1700
		1701	=cut
1330		1702
1331	sub show {	1703	sub show {
1332	my ($self) = @_;	1704	my ($self) = @_;
1333		1705
1334	local $urxvt::popup::self = $self;	1706	local $urxvt::popup::self = $self;
1335		1707
		1708	my $env = $self->{term}->env;
		1709	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1710	delete $env->{LC_ALL};
1336	local $ENV{LC_ALL} = $self->{term}->locale;	1711	$env->{LC_CTYPE} = $self->{term}->locale;
1337		1712
1338	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1713	urxvt::term->new ($env, "popup",
		1714	"--perl-lib" => "", "--perl-ext-common" => "",
		1715	"-pty-fd" => -1, "-sl" => 0,
		1716	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1339	"--transient-for" => $self->{term}->parent,	1717	"--transient-for" => $self->{term}->parent,
1340	"-display" => $self->{term}->display_id,	1718	"-display" => $self->{term}->display_id,
1341	"-pe" => "urxvt-popup")	1719	"-pe" => "urxvt-popup")
1342	or die "unable to create popup window\n";	1720	or die "unable to create popup window\n";
1343	}	1721	}
1344		1722
1345	sub DESTROY {	1723	sub DESTROY {
1346	my ($self) = @_;	1724	my ($self) = @_;
1347		1725
1348	delete $self->{term}{_destroy}{$self};	1726	delete $self->{term}{_destroy}{$self};
1349	$self->{term}->ungrab;	1727	$self->{term}->ungrab;
1350	}	1728	}
		1729
		1730	=back
		1731
		1732	=cut
		1733
		1734	package urxvt::watcher;
		1735
		1736	@urxvt::timer::ISA = __PACKAGE__;
		1737	@urxvt::iow::ISA = __PACKAGE__;
		1738	@urxvt::pw::ISA = __PACKAGE__;
		1739	@urxvt::iw::ISA = __PACKAGE__;
1351		1740
1352	=head2 The C<urxvt::timer> Class	1741	=head2 The C<urxvt::timer> Class
1353		1742
1354	This class implements timer watchers/events. Time is represented as a	1743	This class implements timer watchers/events. Time is represented as a
1355	fractional number of seconds since the epoch. Example:	1744	fractional number of seconds since the epoch. Example:
…		…
1393	Start the timer.	1782	Start the timer.
1394		1783
1395	=item $timer = $timer->start ($tstamp)	1784	=item $timer = $timer->start ($tstamp)
1396		1785
1397	Set the event trigger time to C<$tstamp> and start the timer.	1786	Set the event trigger time to C<$tstamp> and start the timer.
		1787
		1788	=item $timer = $timer->after ($delay)
		1789
		1790	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1398		1791
1399	=item $timer = $timer->stop	1792	=item $timer = $timer->stop
1400		1793
1401	Stop the timer.	1794	Stop the timer.
1402		1795
…		…
1449		1842
1450	Stop watching for events on the given filehandle.	1843	Stop watching for events on the given filehandle.
1451		1844
1452	=back	1845	=back
1453		1846
		1847	=head2 The C<urxvt::iw> Class
		1848
		1849	This class implements idle watchers, that get called automatically when
		1850	the process is idle. They should return as fast as possible, after doing
		1851	some useful work.
		1852
		1853	=over 4
		1854
		1855	=item $iw = new urxvt::iw
		1856
		1857	Create a new idle watcher object in stopped state.
		1858
		1859	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1860
		1861	Set the callback to be called when the watcher triggers.
		1862
		1863	=item $timer = $timer->start
		1864
		1865	Start the watcher.
		1866
		1867	=item $timer = $timer->stop
		1868
		1869	Stop the watcher.
		1870
		1871	=back
		1872
		1873	=head2 The C<urxvt::pw> Class
		1874
		1875	This class implements process watchers. They create an event whenever a
		1876	process exits, after which they stop automatically.
		1877
		1878	my $pid = fork;
		1879	...
		1880	$term->{pw} = urxvt::pw
		1881	->new
		1882	->start ($pid)
		1883	->cb (sub {
		1884	my ($pw, $exit_status) = @_;
		1885	...
		1886	});
		1887
		1888	=over 4
		1889
		1890	=item $pw = new urxvt::pw
		1891
		1892	Create a new process watcher in stopped state.
		1893
		1894	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1895
		1896	Set the callback to be called when the timer triggers.
		1897
		1898	=item $pw = $timer->start ($pid)
		1899
		1900	Tells the wqtcher to start watching for process C<$pid>.
		1901
		1902	=item $pw = $pw->stop
		1903
		1904	Stop the watcher.
		1905
		1906	=back
		1907
1454	=head1 ENVIRONMENT	1908	=head1 ENVIRONMENT
1455		1909
1456	=head2 URXVT_PERL_VERBOSITY	1910	=head2 URXVT_PERL_VERBOSITY
1457		1911
1458	This variable controls the verbosity level of the perl extension. Higher	1912	This variable controls the verbosity level of the perl extension. Higher
…		…
1462		1916
1463	=item == 0 - fatal messages	1917	=item == 0 - fatal messages
1464		1918
1465	=item >= 3 - script loading and management	1919	=item >= 3 - script loading and management
1466		1920
1467	=item >=10 - all events received	1921	=item >=10 - all called hooks
		1922
		1923	=item >=11 - hook reutrn values
1468		1924
1469	=back	1925	=back
1470		1926
1471	=head1 AUTHOR	1927	=head1 AUTHOR
1472		1928

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.72 by root, Mon Jan 9 23:30:01 2006 UTC vs. Revision 1.120 by root, Fri Jan 20 22:05:41 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.72 by root, Mon Jan 9 23:30:01 2006 UTC vs.
Revision 1.120 by root, Fri Jan 20 22:05:41 2006 UTC