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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.75 by root, Tue Jan 10 05:00:13 2006 UTC vs.
Revision 1.121 by root, Fri Jan 20 22:49:34 2006 UTC

…		…
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
39		39
		40	Or by adding them to the resource for extensions loaded by default:
		41
		42	URxvt.perl-ext-common: default,automove-background,selection-autotransform
		43
40	=over 4	44	=over 4
41		45
42	=item selection (enabled by default)	46	=item selection (enabled by default)
43		47
44	(More) intelligent selection. This extension tries to be more intelligent	48	(More) intelligent selection. This extension tries to be more intelligent
45	when the user extends selections (double-click). Right now, it tries to	49	when the user extends selections (double-click and further clicks). Right
46	select urls and complete shell-quoted arguments, which is very convenient,	50	now, it tries to select words, urls and complete shell-quoted
47	too, if your F<ls> supports C<--quoting-style=shell>.	51	arguments, which is very convenient, too, if your F<ls> supports
		52	C<--quoting-style=shell>.
48		53
		54	A double-click usually selects the word under the cursor, further clicks
		55	will enlarge the selection.
		56
		57	The selection works by trying to match a number of regexes and displaying
		58	them in increasing order of length. You can add your own regexes by
		59	specifying resources of the form:
		60
		61	URxvt.selection.pattern-0: perl-regex
		62	URxvt.selection.pattern-1: perl-regex
		63	...
		64
		65	The index number (0, 1...) must not have any holes, and each regex must
		66	contain at least one pair of capturing parentheses, which will be used for
		67	the match. For example, the followign adds a regex that matches everything
		68	between two vertical bars:
		69
		70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
		71
		72	You can look at the source of the selection extension to see more
		73	interesting uses, such as parsing a line from beginning to end.
		74
49	It also offers the following bindable keyboard command:	75	This extension also offers following bindable keyboard commands:
50		76
51	=over 4	77	=over 4
52		78
53	=item rot13	79	=item rot13
54		80
…		…
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 (such as uri unescaping, perl	95	text into various other formats/action (such as uri unescaping, perl
70	evalution, web-browser starting etc.), depending on content.	96	evaluation, web-browser starting etc.), depending on content.
		97
		98	Other extensions can extend this popup menu by pushing a code reference
		99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		100	popup is displayed.
		101
		102	It's sole argument is the popup menu, which can be modified. The selection
		103	is in C<$_>, which can be used to decide wether to add something or not.
		104	It should either return nothing or a string and a code reference. The
		105	string will be used as button text and the code reference will be called
		106	when the button gets activated and should transform C<$_>.
		107
		108	The following will add an entry C<a to b> that transforms all C<a>s in
		109	the selection to C<b>s, but only if the selection currently contains any
		110	C<a>s:
		111
		112	push @{ $self->{term}{selection_popup_hook} }, sub {
		113	/a/ ? ("a to be" => sub { s/a/b/g }
		114	: ()
		115	};
71		116
72	=item searchable-scrollback<hotkey> (enabled by default)	117	=item searchable-scrollback<hotkey> (enabled by default)
73		118
74	Adds regex search functionality to the scrollback buffer, triggered	119	Adds regex search functionality to the scrollback buffer, triggered
75	by a hotkey (default: C<M-s>). When in search mode, normal terminal	120	by a hotkey (default: C<M-s>). While in search mode, normal terminal
76	input/output is suspended.	121	input/output is suspended and a regex is displayed at the bottom of the
		122	screen.
77		123
78	C</> starts an incremental regex search, C<n> searches further, C<p> or	124	Inputting characters appends them to the regex and continues incremental
79	C<N> jump to the previous match, C<G> jumps to the bottom and clears the	125	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
80	history, C<enter> leaves search mode at the current position and C<escape>	126	search upwards/downwards in the scrollback buffer, C<End> jumps to the
81	returns to the original position.	127	bottom. C<Escape> leaves search mode and returns to the point where search
		128	was started, while C<Enter> or C<Return> stay at the current position and
		129	additionally stores the first match in the current line into the primary
		130	selection.
82		131
83	=item digital-clock	132	=item selection-autotransform
84		133
85	Displays a digital clock using the built-in overlay.	134	This selection allows you to do automatic transforms on a selection
		135	whenever a selection is made.
		136
		137	It works by specifying perl snippets (most useful is a single C<s///>
		138	operator) that modify C<$_> as resources:
		139
		140	URxvt.selection-autotransform.0: transform
		141	URxvt.selection-autotransform.1: transform
		142	...
		143
		144	For example, the following will transform selections of the form
		145	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		146	$word>:
		147
		148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		149
		150	And this example matches the same,but replaces it with vi-commands you can
		151	paste directly into your (vi :) editor:
		152
		153	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		154
		155	Of course, this can be modified to suit your needs and your editor :)
		156
		157	To expand the example above to typical perl error messages ("XXX at
		158	FILENAME line YYY."), you need a slightly more elaborate solution:
		159
		160	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		161	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		162
		163	The first line tells the selection code to treat the unchanging part of
		164	every error message as a selection pattern, and the second line transforms
		165	the message into vi commands to load the file.
		166
		167	=item readline
		168
		169	A support package that tries to make editing with readline easier. At the
		170	moment, it reacts to clicking with the left mouse button by trying to
		171	move the text cursor to this position. It does so by generating as many
		172	cursor-left or cursor-right keypresses as required (the this only works
		173	for programs that correctly support wide characters).
		174
		175	It only works when clicking into the same line (possibly extended over
		176	multiple rows) as the text cursor and on the primary screen, to reduce the
		177	risk of misinterpreting. The normal selection isn't disabled, so quick
		178	successive clicks might interfere with selection creation in harmless
		179	ways.
		180
		181	=item tabbed
		182
		183	This transforms the terminal into a tabbar with additional terminals, that
		184	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		185	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		186	button per tab.
		187
		188	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		189	B<Shift-Right> will switch to the tab left or right of the current one,
		190	while B<Shift-Down> creates a new tab.
86		191
87	=item mark-urls	192	=item mark-urls
88		193
89	Uses per-line display filtering (C<on_line_update>) to underline urls.	194	Uses per-line display filtering (C<on_line_update>) to underline urls and
		195	make them clickable. When middle-clicked, the program specified in the
		196	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		197	the URL as first argument.
		198
		199	=item automove-background
		200
		201	This is basically a one-line extension that dynamically changes the background pixmap offset
		202	to the window position, in effect creating the same effect as pseudo transparency with
		203	a custom pixmap. No scaling is supported in this mode. Exmaple:
		204
		205	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
90		206
91	=item block-graphics-to-ascii	207	=item block-graphics-to-ascii
92		208
93	A not very useful example of filtering all text output to the terminal,	209	A not very useful example of filtering all text output to the terminal,
94	by replacing all line-drawing characters (U+2500 .. U+259F) by a	210	by replacing all line-drawing characters (U+2500 .. U+259F) by a
95	similar-looking ascii character.	211	similar-looking ascii character.
96		212
		213	=item digital-clock
		214
		215	Displays a digital clock using the built-in overlay.
		216
97	=item example-refresh-hooks	217	=item example-refresh-hooks
98		218
99	Displays a very simple digital clock in the upper right corner of the	219	Displays a very simple digital clock in the upper right corner of the
100	window. Illustrates overwriting the refresh callbacks to create your own	220	window. Illustrates overwriting the refresh callbacks to create your own
101	overlays or changes.	221	overlays or changes.
		222
		223	=item selection-pastebin
		224
		225	This is a little rarely useful extension that Uploads the selection as
		226	textfile to a remote site (or does other things). (The implementation is
		227	not currently secure for use in a multiuser environment as it writes to
		228	F</tmp> directly.).
		229
		230	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		231	i.e.
		232
		233	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		234
		235	Pressing this combination runs a command with C<%> replaced by the name of
		236	the textfile. This command can be set via a resource:
		237
		238	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		239
		240	And the default is likely not useful to anybody but the few people around
		241	here :)
		242
		243	The name of the textfile is the hex encoded md5 sum of the selection, so
		244	the same content should lead to the same filename.
		245
		246	After a successful upload the selection will be replaced by the text given
		247	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		248	for the filename):
		249
		250	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
102		251
103	=back	252	=back
104		253
105	=head1 API DOCUMENTATION	254	=head1 API DOCUMENTATION
106		255
…		…
123	=over 4	272	=over 4
124		273
125	=item $text	274	=item $text
126		275
127	Rxvt-unicodes special way of encoding text, where one "unicode" character	276	Rxvt-unicodes special way of encoding text, where one "unicode" character
128	always represents one screen cell. See L<row_t> for a discussion of this format.	277	always represents one screen cell. See L<ROW_t> for a discussion of this format.
129		278
130	=item $string	279	=item $string
131		280
132	A perl text string, with an emphasis on I<text>. It can store all unicode	281	A perl text string, with an emphasis on I<text>. It can store all unicode
133	characters and is to be distinguished with text encoded in a specific	282	characters and is to be distinguished with text encoded in a specific
…		…
179	called whenever the relevant event happens.	328	called whenever the relevant event happens.
180		329
181	The first argument passed to them is an extension oject as described in	330	The first argument passed to them is an extension oject as described in
182	the in the C<Extension Objects> section.	331	the in the C<Extension Objects> section.
183		332
184	B<All> of these hooks must return a boolean value. If it is true, then the	333	B<All> of these hooks must return a boolean value. If any of the called
185	event counts as being I<consumed>, and the invocation of other hooks is	334	hooks returns true, then the event counts as being I<consumed>, and the
186	skipped, and the relevant action might not be carried out by the C++ code.	335	relevant action might not be carried out by the C++ code.
187		336
188	I<< When in doubt, return a false value (preferably C<()>). >>	337	I<< When in doubt, return a false value (preferably C<()>). >>
189		338
190	=over 4	339	=over 4
191		340
192	=item on_init $term	341	=item on_init $term
193		342
194	Called after a new terminal object has been initialized, but before	343	Called after a new terminal object has been initialized, but before
195	windows are created or the command gets run. Most methods are unsafe to	344	windows are created or the command gets run. Most methods are unsafe to
196	call or deliver senseless data, as terminal size and other characteristics	345	call or deliver senseless data, as terminal size and other characteristics
197	have not yet been determined. You can safely query and change resources,	346	have not yet been determined. You can safely query and change resources
198	though.	347	and options, though. For many purposes the C<on_start> hook is a better
		348	place.
		349
		350	=item on_start $term
		351
		352	Called at the very end of initialisation of a new terminal, just before
		353	trying to map (display) the toplevel and returning to the mainloop.
		354
		355	=item on_destroy $term
		356
		357	Called whenever something tries to destroy terminal, before doing anything
		358	yet. If this hook returns true, then destruction is skipped, but this is
		359	rarely a good idea.
199		360
200	=item on_reset $term	361	=item on_reset $term
201		362
202	Called after the screen is "reset" for any reason, such as resizing or	363	Called after the screen is "reset" for any reason, such as resizing or
203	control sequences. Here is where you can react on changes to size-related	364	control sequences. Here is where you can react on changes to size-related
204	variables.	365	variables.
205		366
206	=item on_start $term	367	=item on_child_start $term, $pid
207		368
208	Called at the very end of initialisation of a new terminal, just before	369	Called just after the child process has been C<fork>ed.
209	returning to the mainloop.	370
		371	=item on_child_exit $term, $status
		372
		373	Called just after the child process has exited. C<$status> is the status
		374	from C<waitpid>.
210		375
211	=item on_sel_make $term, $eventtime	376	=item on_sel_make $term, $eventtime
212		377
213	Called whenever a selection has been made by the user, but before the	378	Called whenever a selection has been made by the user, but before the
214	selection text is copied, so changes to the beginning, end or type of the	379	selection text is copied, so changes to the beginning, end or type of the
…		…
228	=item on_sel_extend $term	393	=item on_sel_extend $term
229		394
230	Called whenever the user tries to extend the selection (e.g. with a double	395	Called whenever the user tries to extend the selection (e.g. with a double
231	click) and is either supposed to return false (normal operation), or	396	click) and is either supposed to return false (normal operation), or
232	should extend the selection itelf and return true to suppress the built-in	397	should extend the selection itelf and return true to suppress the built-in
233	processing.	398	processing. This can happen multiple times, as long as the callback
		399	returns true, it will be called on every further click by the user and is
		400	supposed to enlarge the selection more and more, if possible.
234		401
235	See the F<selection> example extension.	402	See the F<selection> example extension.
236		403
237	=item on_view_change $term, $offset	404	=item on_view_change $term, $offset
238		405
…		…
305		472
306	Called whenever the user presses a key combination that has a	473	Called whenever the user presses a key combination that has a
307	C<perl:string> action bound to it (see description of the B<keysym>	474	C<perl:string> action bound to it (see description of the B<keysym>
308	resource in the @@RXVT_NAME@@(1) manpage).	475	resource in the @@RXVT_NAME@@(1) manpage).
309		476
		477	=item on_x_event $term, $event
		478
		479	Called on every X event received on the vt window (and possibly other
		480	windows). Should only be used as a last resort. Most event structure
		481	members are not passed.
		482
310	=item on_focus_in $term	483	=item on_focus_in $term
311		484
312	Called whenever the window gets the keyboard focus, before rxvt-unicode	485	Called whenever the window gets the keyboard focus, before rxvt-unicode
313	does focus in processing.	486	does focus in processing.
314		487
315	=item on_focus_out $term	488	=item on_focus_out $term
316		489
317	Called wheneever the window loses keyboard focus, before rxvt-unicode does	490	Called wheneever the window loses keyboard focus, before rxvt-unicode does
318	focus out processing.	491	focus out processing.
319		492
		493	=item on_configure_notify $term, $event
		494
		495	=item on_property_notify $term, $event
		496
320	=item on_key_press $term, $event, $keysym, $octets	497	=item on_key_press $term, $event, $keysym, $octets
321		498
322	=item on_key_release $term, $event, $keysym	499	=item on_key_release $term, $event, $keysym
323		500
324	=item on_button_press $term, $event	501	=item on_button_press $term, $event
…		…
333		510
334	Called whenever the corresponding X event is received for the terminal If	511	Called whenever the corresponding X event is received for the terminal If
335	the hook returns true, then the even will be ignored by rxvt-unicode.	512	the hook returns true, then the even will be ignored by rxvt-unicode.
336		513
337	The event is a hash with most values as named by Xlib (see the XEvent	514	The event is a hash with most values as named by Xlib (see the XEvent
338	manpage), with the additional members C<row> and C<col>, which are the row	515	manpage), with the additional members C<row> and C<col>, which are the
339	and column under the mouse cursor.	516	(real, not screen-based) row and column under the mouse cursor.
340		517
341	C<on_key_press> additionally receives the string rxvt-unicode would	518	C<on_key_press> additionally receives the string rxvt-unicode would
342	output, if any, in locale-specific encoding.	519	output, if any, in locale-specific encoding.
343		520
344	subwindow.	521	subwindow.
345		522
346	=back	523	=item on_client_message $term, $event
347		524
348	=head2 Variables in the C<urxvt> Package	525	=item on_wm_protocols $term, $event
349		526
350	=over 4	527	=item on_wm_delete_window $term, $event
351		528
352	=item $urxvt::LIBDIR	529	Called when various types of ClientMessage events are received (all with
353		530	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
354	The rxvt-unicode library directory, where, among other things, the perl
355	modules and scripts are stored.
356
357	=item $urxvt::RESCLASS, $urxvt::RESCLASS
358
359	The resource class and name rxvt-unicode uses to look up X resources.
360
361	=item $urxvt::RXVTNAME
362
363	The basename of the installed binaries, usually C<urxvt>.
364
365	=item $urxvt::TERM
366
367	The current terminal. This variable stores the current C<urxvt::term>
368	object, whenever a callback/hook is executing.
369
370	=item
371
372	=back
373
374	=head2 Functions in the C<urxvt> Package
375
376	=over 4
377
378	=item $term = new urxvt [arg...]
379
380	Creates a new terminal, very similar as if you had started it with
381	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
382	if the new instance couldn't be created. Returns C<undef> if the new
383	instance didn't initialise perl, and the terminal object otherwise. The
384	C<init> and C<start> hooks will be called during the call.
385
386	=item urxvt::fatal $errormessage
387
388	Fatally aborts execution with the given error message. Avoid at all
389	costs! The only time this is acceptable is when the terminal process
390	starts up.
391
392	=item urxvt::warn $string
393
394	Calls C<rxvt_warn> with the given string which should not include a
395	newline. The module also overwrites the C<warn> builtin with a function
396	that calls this function.
397
398	Using this function has the advantage that its output ends up in the
399	correct place, e.g. on stderr of the connecting urxvtc client.
400
401	=item $is_safe = urxvt::safe
402
403	Returns true when it is safe to do potentially unsafe things, such as
404	evaluating perl code specified by the user. This is true when urxvt was
405	started setuid or setgid.
406
407	=item $time = urxvt::NOW
408
409	Returns the "current time" (as per the event loop).
410
411	=item urxvt::CurrentTime
412
413	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
414	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
415	Button4Mask, Button5Mask, AnyModifier
416
417	Various constants for use in X calls and event processing.
418
419	=back
420
421	=head2 RENDITION
422
423	Rendition bitsets contain information about colour, font, font styles and
424	similar information for each screen cell.
425
426	The following "macros" deal with changes in rendition sets. You should
427	never just create a bitset, you should always modify an existing one,
428	as they contain important information required for correct operation of
429	rxvt-unicode.
430
431	=over 4
432
433	=item $rend = urxvt::DEFAULT_RSTYLE
434
435	Returns the default rendition, as used when the terminal is starting up or
436	being reset. Useful as a base to start when creating renditions.
437
438	=item $rend = urxvt::OVERLAY_RSTYLE
439
440	Return the rendition mask used for overlays by default.
441
442	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
443
444	Return the bit that enabled bold, italic, blink, reverse-video and
445	underline, respectively. To enable such a style, just logically OR it into
446	the bitset.
447
448	=item $foreground = urxvt::GET_BASEFG $rend
449
450	=item $background = urxvt::GET_BASEBG $rend
451
452	Return the foreground/background colour index, respectively.
453
454	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
455
456	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
457
458	Replace the foreground/background colour in the rendition mask with the
459	specified one.
460
461	=item $value = urxvt::GET_CUSTOM $rend
462
463	Return the "custom" value: Every rendition has 5 bits for use by
464	extensions. They can be set and changed as you like and are initially
465	zero.
466
467	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
468
469	Change the custom value.
470		531
471	=back	532	=back
472		533
473	=cut	534	=cut
474		535
…		…
480	use Scalar::Util ();	541	use Scalar::Util ();
481	use List::Util ();	542	use List::Util ();
482		543
483	our $VERSION = 1;	544	our $VERSION = 1;
484	our $TERM;	545	our $TERM;
		546	our @TERM_INIT;
		547	our @TERM_EXT;
485	our @HOOKNAME;	548	our @HOOKNAME;
486	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	549	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
487	our %OPTION;	550	our %OPTION;
488		551
489	our $LIBDIR;	552	our $LIBDIR;
490	our $RESNAME;	553	our $RESNAME;
491	our $RESCLASS;	554	our $RESCLASS;
492	our $RXVTNAME;	555	our $RXVTNAME;
493		556
		557	our $NOCHAR = chr 0xfffe;
		558
		559	=head2 Variables in the C<urxvt> Package
		560
		561	=over 4
		562
		563	=item $urxvt::LIBDIR
		564
		565	The rxvt-unicode library directory, where, among other things, the perl
		566	modules and scripts are stored.
		567
		568	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		569
		570	The resource class and name rxvt-unicode uses to look up X resources.
		571
		572	=item $urxvt::RXVTNAME
		573
		574	The basename of the installed binaries, usually C<urxvt>.
		575
		576	=item $urxvt::TERM
		577
		578	The current terminal. This variable stores the current C<urxvt::term>
		579	object, whenever a callback/hook is executing.
		580
		581	=item @urxvt::TERM_INIT
		582
		583	All coderefs in this array will be called as methods of the next newly
		584	created C<urxvt::term> object (during the C<on_init> phase). The array
		585	gets cleared before the codereferences that were in it are being executed,
		586	so coderefs can push themselves onto it again if they so desire.
		587
		588	This complements to the perl-eval commandline option, but gets executed
		589	first.
		590
		591	=item @urxvt::TERM_EXT
		592
		593	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		594	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		595	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		596
		597	=back
		598
		599	=head2 Functions in the C<urxvt> Package
		600
		601	=over 4
		602
		603	=item urxvt::fatal $errormessage
		604
		605	Fatally aborts execution with the given error message. Avoid at all
		606	costs! The only time this is acceptable is when the terminal process
		607	starts up.
		608
		609	=item urxvt::warn $string
		610
		611	Calls C<rxvt_warn> with the given string which should not include a
		612	newline. The module also overwrites the C<warn> builtin with a function
		613	that calls this function.
		614
		615	Using this function has the advantage that its output ends up in the
		616	correct place, e.g. on stderr of the connecting urxvtc client.
		617
		618	Messages have a size limit of 1023 bytes currently.
		619
		620	=item $time = urxvt::NOW
		621
		622	Returns the "current time" (as per the event loop).
		623
		624	=item urxvt::CurrentTime
		625
		626	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		627	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		628	Button4Mask, Button5Mask, AnyModifier
		629
		630	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		631	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		632	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		633	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		634	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		635	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		636	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		637
		638	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		639	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		640	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		641	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		642	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		643	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		644	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		645
		646	Various constants for use in X calls and event processing.
		647
		648	=back
		649
		650	=head2 RENDITION
		651
		652	Rendition bitsets contain information about colour, font, font styles and
		653	similar information for each screen cell.
		654
		655	The following "macros" deal with changes in rendition sets. You should
		656	never just create a bitset, you should always modify an existing one,
		657	as they contain important information required for correct operation of
		658	rxvt-unicode.
		659
		660	=over 4
		661
		662	=item $rend = urxvt::DEFAULT_RSTYLE
		663
		664	Returns the default rendition, as used when the terminal is starting up or
		665	being reset. Useful as a base to start when creating renditions.
		666
		667	=item $rend = urxvt::OVERLAY_RSTYLE
		668
		669	Return the rendition mask used for overlays by default.
		670
		671	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		672
		673	Return the bit that enabled bold, italic, blink, reverse-video and
		674	underline, respectively. To enable such a style, just logically OR it into
		675	the bitset.
		676
		677	=item $foreground = urxvt::GET_BASEFG $rend
		678
		679	=item $background = urxvt::GET_BASEBG $rend
		680
		681	Return the foreground/background colour index, respectively.
		682
		683	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		684
		685	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		686
		687	Replace the foreground/background colour in the rendition mask with the
		688	specified one.
		689
		690	=item $value = urxvt::GET_CUSTOM $rend
		691
		692	Return the "custom" value: Every rendition has 5 bits for use by
		693	extensions. They can be set and changed as you like and are initially
		694	zero.
		695
		696	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		697
		698	Change the custom value.
		699
		700	=back
		701
		702	=cut
		703
494	BEGIN {	704	BEGIN {
495	urxvt->bootstrap;
496
497	# overwrite perl's warn	705	# overwrite perl's warn
498	*CORE::GLOBAL::warn = sub {	706	*CORE::GLOBAL::warn = sub {
499	my $msg = join "", @_;	707	my $msg = join "", @_;
500	$msg .= "\n"	708	$msg .= "\n"
501	unless $msg =~ /\n$/;	709	unless $msg =~ /\n$/;
502	urxvt::warn ($msg);	710	urxvt::warn ($msg);
503	};	711	};
504
505	delete $ENV{IFS};
506	delete $ENV{CDPATH};
507	delete $ENV{BASH_ENV};
508	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
509	}	712	}
510		713
511	my @hook_count;
512	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	714	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
513		715
514	sub verbose {	716	sub verbose {
515	my ($level, $msg) = @_;	717	my ($level, $msg) = @_;
516	warn "$msg\n" if $level <= $verbosity;	718	warn "$msg\n" if $level <= $verbosity;
517	}	719	}
518		720
519	my $extension_pkg = "extension0000";
520	my %extension_pkg;	721	my %extension_pkg;
521		722
522	# load a single script into its own package, once only	723	# load a single script into its own package, once only
523	sub extension_package($) {	724	sub extension_package($) {
524	my ($path) = @_;	725	my ($path) = @_;
525		726
526	$extension_pkg{$path} \|\|= do {	727	$extension_pkg{$path} \|\|= do {
527	my $pkg = "urxvt::" . ($extension_pkg++);	728	$path =~ /([^\/\\]+)$/;
		729	my $pkg = $1;
		730	$pkg =~ s/[^[:word:]]/_/g;
		731	$pkg = "urxvt::ext::$pkg";
528		732
529	verbose 3, "loading extension '$path' into package '$pkg'";	733	verbose 3, "loading extension '$path' into package '$pkg'";
530		734
531	open my $fh, "<:raw", $path	735	open my $fh, "<:raw", $path
532	or die "$path: $!";	736	or die "$path: $!";
533		737
534	my $source = untaint	738	my $source =
535	"package $pkg; use strict; use utf8;\n"	739	"package $pkg; use strict; use utf8;\n"
536	. "use base urxvt::term::extension::;\n"
537	. "#line 1 \"$path\"\n{\n"	740	. "#line 1 \"$path\"\n{\n"
538	. (do { local $/; <$fh> })	741	. (do { local $/; <$fh> })
539	. "\n};\n1";	742	. "\n};\n1";
540		743
541	eval $source	744	eval $source
…		…
555	if ($htype == 0) { # INIT	758	if ($htype == 0) { # INIT
556	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	759	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
557		760
558	my %ext_arg;	761	my %ext_arg;
559		762
		763	{
		764	my @init = @TERM_INIT;
		765	@TERM_INIT = ();
		766	$_->($TERM) for @init;
		767	my @pkg = @TERM_EXT;
		768	@TERM_EXT = ();
		769	$TERM->register_package ($_) for @pkg;
		770	}
		771
560	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	772	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
561	if ($_ eq "default") {	773	if ($_ eq "default") {
562	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	774	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
563	} elsif (/^-(.*)$/) {	775	} elsif (/^-(.*)$/) {
564	delete $ext_arg{$1};	776	delete $ext_arg{$1};
565	} elsif (/^([^<]+)<(.*)>$/) {	777	} elsif (/^([^<]+)<(.*)>$/) {
…		…
590	if $verbosity >= 10;	802	if $verbosity >= 10;
591		803
592	keys %$cb;	804	keys %$cb;
593		805
594	while (my ($pkg, $cb) = each %$cb) {	806	while (my ($pkg, $cb) = each %$cb) {
595	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	807	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
596	and last;	808	$retval \|\|= $retval_;
597		809
598	if ($@) {	810	if ($@) {
599	$TERM->ungrab; # better to lose the grab than the session	811	$TERM->ungrab; # better to lose the grab than the session
600	warn $@;	812	warn $@;
601	}	813	}
602	}	814	}
		815
		816	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		817	if $verbosity >= 11;
603	}	818	}
604		819
605	if ($htype == 1) { # DESTROY	820	if ($htype == 1) { # DESTROY
606	if (my $hook = delete $TERM->{_hook}) {
607	for my $htype (0..$#$hook) {
608	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
609	or set_should_invoke $htype, 0;
610	}
611	}
612
613	# clear package objects	821	# clear package objects
614	%$_ = () for values %{ $TERM->{_pkg} };	822	%$_ = () for values %{ $TERM->{_pkg} };
615		823
616	# clear package	824	# clear package
617	%$TERM = ();	825	%$TERM = ();
…		…
631	while (my ($name, $cb) = each %hook) {	839	while (my ($name, $cb) = each %hook) {
632	my $htype = $HOOKTYPE{uc $name};	840	my $htype = $HOOKTYPE{uc $name};
633	defined $htype	841	defined $htype
634	or Carp::croak "unsupported hook type '$name'";	842	or Carp::croak "unsupported hook type '$name'";
635		843
		844	$self->set_should_invoke ($htype, +1)
636	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	845	unless exists $self->{term}{_hook}[$htype]{$pkg};
637	$hook_count[$htype]++
638	or urxvt::set_should_invoke $htype, 1;
639	}
640		846
641	$self->{term}{_hook}[$htype]{$pkg} = $cb;	847	$self->{term}{_hook}[$htype]{$pkg} = $cb;
642	}	848	}
643	}	849	}
644		850
…		…
649	for my $name (@hook) {	855	for my $name (@hook) {
650	my $htype = $HOOKTYPE{uc $name};	856	my $htype = $HOOKTYPE{uc $name};
651	defined $htype	857	defined $htype
652	or Carp::croak "unsupported hook type '$name'";	858	or Carp::croak "unsupported hook type '$name'";
653		859
		860	$self->set_should_invoke ($htype, -1)
654	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	861	if delete $self->{term}{_hook}[$htype]{$pkg};
655	--$hook_count[$htype]
656	or urxvt::set_should_invoke $htype, 0;
657	}
658	}	862	}
659	}	863	}
660		864
661	our $AUTOLOAD;	865	our $AUTOLOAD;
662		866
…		…
768	# find on_xxx subs in the package and register them	972	# find on_xxx subs in the package and register them
769	# as hooks	973	# as hooks
770	sub register_package {	974	sub register_package {
771	my ($self, $pkg, $argv) = @_;	975	my ($self, $pkg, $argv) = @_;
772		976
		977	no strict 'refs';
		978
		979	urxvt::verbose 6, "register package $pkg to $self";
		980
		981	@{"$pkg\::ISA"} = urxvt::term::extension::;
		982
773	my $proxy = bless {	983	my $proxy = bless {
774	_pkg => $pkg,	984	_pkg => $pkg,
775	argv => $argv,	985	argv => $argv,
776	}, $pkg;	986	}, $pkg;
777	Scalar::Util::weaken ($proxy->{term} = $self);	987	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
783	$proxy->enable ($name => $ref);	993	$proxy->enable ($name => $ref);
784	}	994	}
785	}	995	}
786	}	996	}
787		997
		998	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		999
		1000	Creates a new terminal, very similar as if you had started it with system
		1001	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1002	hash which defines the environment of the new terminal.
		1003
		1004	Croaks (and probably outputs an error message) if the new instance
		1005	couldn't be created. Returns C<undef> if the new instance didn't
		1006	initialise perl, and the terminal object otherwise. The C<init> and
		1007	C<start> hooks will be called during this call.
		1008
		1009	=cut
		1010
		1011	sub new {
		1012	my ($class, $env, @args) = @_;
		1013
		1014	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		1015	}
		1016
788	=item $term->destroy	1017	=item $term->destroy
789		1018
790	Destroy the terminal object (close the window, free resources	1019	Destroy the terminal object (close the window, free resources
791	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1020	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
792	watchers (timers, io watchers) are still active.	1021	watchers (timers, io watchers) are still active.
793		1022
		1023	=item $term->exec_async ($cmd[, @args])
		1024
		1025	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1026	("starts") programs in the background. This function takes care of setting
		1027	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1028	be preferred over explicit calls to C<exec> or C<system>.
		1029
		1030	Returns the pid of the subprocess or C<undef> on error.
		1031
		1032	=cut
		1033
		1034	sub exec_async {
		1035	my $self = shift;
		1036
		1037	my $pid = fork;
		1038
		1039	return $pid
		1040	if !defined $pid or $pid;
		1041
		1042	%ENV = %{ $self->env };
		1043
		1044	exec @_;
		1045	urxvt::_exit 255;
		1046	}
		1047
794	=item $isset = $term->option ($optval[, $set])	1048	=item $isset = $term->option ($optval[, $set])
795		1049
796	Returns true if the option specified by C<$optval> is enabled, and	1050	Returns true if the option specified by C<$optval> is enabled, and
797	optionally change it. All option values are stored by name in the hash	1051	optionally change it. All option values are stored by name in the hash
798	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1052	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
800	Here is a a likely non-exhaustive list of option names, please see the	1054	Here is a a likely non-exhaustive list of option names, please see the
801	source file F</src/optinc.h> to see the actual list:	1055	source file F</src/optinc.h> to see the actual list:
802		1056
803	borderLess console cursorBlink cursorUnderline hold iconic insecure	1057	borderLess console cursorBlink cursorUnderline hold iconic insecure
804	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1058	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
805	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1059	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
806	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1060	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
807	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1061	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
808	tripleclickwords utmpInhibit visualBell	1062	transparent tripleclickwords utmpInhibit visualBell
809		1063
810	=item $value = $term->resource ($name[, $newval])	1064	=item $value = $term->resource ($name[, $newval])
811		1065
812	Returns the current resource value associated with a given name and	1066	Returns the current resource value associated with a given name and
813	optionally sets a new value. Setting values is most useful in the C<init>	1067	optionally sets a new value. Setting values is most useful in the C<init>
…		…
830		1084
831	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1085	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
832	borderLess color cursorBlink cursorUnderline cutchars delete_key	1086	borderLess color cursorBlink cursorUnderline cutchars delete_key
833	display_name embed ext_bwidth fade font geometry hold iconName	1087	display_name embed ext_bwidth fade font geometry hold iconName
834	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1088	imFont imLocale inputMethod insecure int_bwidth intensityStyles
835	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1089	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
836	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1090	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
837	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1091	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
838	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1092	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
839	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1093	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
840	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1094	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
841	shade term_name title transparent transparent_all tripleclickwords	1095	secondaryScreen secondaryScroll selectstyle shade term_name title
842	utmpInhibit visualBell	1096	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1097	visualBell
843		1098
844	=cut	1099	=cut
845		1100
846	sub resource($$;$) {	1101	sub resource($$;$) {
847	my ($self, $name) = (shift, shift);	1102	my ($self, $name) = (shift, shift);
848	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1103	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
849	&urxvt::term::_resource	1104	&urxvt::term::_resource
850	}	1105	}
851		1106
		1107	=item $value = $term->x_resource ($pattern)
		1108
		1109	Returns the X-Resource for the given pattern, excluding the program or
		1110	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1111	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1112	resource with that pattern exists.
		1113
		1114	This method should only be called during the C<on_start> hook, as there is
		1115	only one resource database per display, and later invocations might return
		1116	the wrong resources.
		1117
852	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1118	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
853		1119
854	Adds a keymap translation exactly as specified via a resource. See the	1120	Adds a keymap translation exactly as specified via a resource. See the
855	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1121	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
856		1122
…		…
871	=item ($row, $col) = $term->selection_end ([$row, $col])	1137	=item ($row, $col) = $term->selection_end ([$row, $col])
872		1138
873	Return the current values of the selection mark, begin or end positions,	1139	Return the current values of the selection mark, begin or end positions,
874	and optionally set them to new values.	1140	and optionally set them to new values.
875		1141
		1142	=item $term->selection_make ($eventtime[, $rectangular])
		1143
		1144	Tries to make a selection as set by C<selection_beg> and
		1145	C<selection_end>. If C<$rectangular> is true (default: false), a
		1146	rectangular selection will be made. This is the prefered function to make
		1147	a selection.
		1148
876	=item $success = $term->selection_grab ($eventtime)	1149	=item $success = $term->selection_grab ($eventtime)
877		1150
878	Try to request the primary selection from the server (for example, as set	1151	Try to request the primary selection text from the server (for example, as
879	by the next method).	1152	set by the next method). No visual feedback will be given. This function
		1153	is mostly useful from within C<on_sel_grab> hooks.
880		1154
881	=item $oldtext = $term->selection ([$newtext])	1155	=item $oldtext = $term->selection ([$newtext])
882		1156
883	Return the current selection text and optionally replace it by C<$newtext>.	1157	Return the current selection text and optionally replace it by C<$newtext>.
884		1158
…		…
977	Convert the given locale-encoded octets into a perl string.	1251	Convert the given locale-encoded octets into a perl string.
978		1252
979	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1253	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
980		1254
981	XORs the rendition values in the given span with the provided value	1255	XORs the rendition values in the given span with the provided value
982	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1256	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
983	to the selection.	1257	refresh hooks to provide effects similar to the selection.
984		1258
985	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1259	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
986		1260
987	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1261	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
988	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1262	whitespace will additionally be xored with the C<$rstyle2>, which defaults
989	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines	1263	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
990	it instead.	1264	it instead. Both styles I<MUST NOT> contain font styles.
991		1265
992	=item $term->scr_bell	1266	=item $term->scr_bell
993		1267
994	Ring the bell!	1268	Ring the bell!
995		1269
…		…
1002		1276
1003	Normally its not a good idea to use this function, as programs might be	1277	Normally its not a good idea to use this function, as programs might be
1004	confused by changes in cursor position or scrolling. Its useful inside a	1278	confused by changes in cursor position or scrolling. Its useful inside a
1005	C<on_add_lines> hook, though.	1279	C<on_add_lines> hook, though.
1006		1280
		1281	=item $term->scr_change_screen ($screen)
		1282
		1283	Switch to given screen - 0 primary, 1 secondary.
		1284
1007	=item $term->cmd_parse ($octets)	1285	=item $term->cmd_parse ($octets)
1008		1286
1009	Similar to C<scr_add_lines>, but the argument must be in the	1287	Similar to C<scr_add_lines>, but the argument must be in the
1010	locale-specific encoding of the terminal and can contain command sequences	1288	locale-specific encoding of the terminal and can contain command sequences
1011	(escape codes) that will be interpreted.	1289	(escape codes) that will be interpreted.
…		…
1029		1307
1030	=item $windowid = $term->vt	1308	=item $windowid = $term->vt
1031		1309
1032	Return the window id of the terminal window.	1310	Return the window id of the terminal window.
1033		1311
		1312	=item $term->vt_emask_add ($x_event_mask)
		1313
		1314	Adds the specified events to the vt event mask. Useful e.g. when you want
		1315	to receive pointer events all the times:
		1316
		1317	$term->vt_emask_add (urxvt::PointerMotionMask);
		1318
1034	=item $window_width = $term->width	1319	=item $window_width = $term->width
1035		1320
1036	=item $window_height = $term->height	1321	=item $window_height = $term->height
1037		1322
1038	=item $font_width = $term->fwidth	1323	=item $font_width = $term->fwidth
…		…
1051		1336
1052	=item $max_scrollback = $term->saveLines	1337	=item $max_scrollback = $term->saveLines
1053		1338
1054	=item $nrow_plus_saveLines = $term->total_rows	1339	=item $nrow_plus_saveLines = $term->total_rows
1055		1340
1056	=item $lines_in_scrollback = $term->nsaved	1341	=item $topmost_scrollback_row = $term->top_row
1057		1342
1058	Return various integers describing terminal characteristics.	1343	Return various integers describing terminal characteristics.
1059		1344
		1345	=item $x_display = $term->display_id
		1346
		1347	Return the DISPLAY used by rxvt-unicode.
		1348
1060	=item $lc_ctype = $term->locale	1349	=item $lc_ctype = $term->locale
1061		1350
1062	Returns the LC_CTYPE category string used by this rxvt-unicode.	1351	Returns the LC_CTYPE category string used by this rxvt-unicode.
1063		1352
1064	=item $x_display = $term->display_id	1353	=item $env = $term->env
1065		1354
1066	Return the DISPLAY used by rxvt-unicode.	1355	Returns a copy of the environment in effect for the terminal as a hashref
		1356	similar to C<\%ENV>.
		1357
		1358	=cut
		1359
		1360	sub env {
		1361	if (my $env = $_[0]->_env) {
		1362	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1363	} else {
		1364	+{ %ENV }
		1365	}
		1366	}
1067		1367
1068	=item $modifiermask = $term->ModLevel3Mask	1368	=item $modifiermask = $term->ModLevel3Mask
1069		1369
1070	=item $modifiermask = $term->ModMetaMask	1370	=item $modifiermask = $term->ModMetaMask
1071		1371
1072	=item $modifiermask = $term->ModNumLockMask	1372	=item $modifiermask = $term->ModNumLockMask
1073		1373
1074	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1374	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1075	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1375	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1076		1376
		1377	=item $screen = $term->current_screen
		1378
		1379	Returns the currently displayed screen (0 primary, 1 secondary).
		1380
1077	=item $view_start = $term->view_start ([$newvalue])	1381	=item $view_start = $term->view_start ([$newvalue])
1078		1382
1079	Returns the negative row number of the topmost line. Minimum value is	1383	Returns the row number of the topmost displayed line. Maximum value is
1080	C<0>, which displays the normal terminal contents. Larger values scroll	1384	C<0>, which displays the normal terminal contents. Lower values scroll
1081	this many lines into the scrollback buffer.	1385	this many lines into the scrollback buffer.
1082		1386
1083	=item $term->want_refresh	1387	=item $term->want_refresh
1084		1388
1085	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1389	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1099	If C<$new_text> is specified, it will replace characters in the current	1403	If C<$new_text> is specified, it will replace characters in the current
1100	line, starting at column C<$start_col> (default C<0>), which is useful	1404	line, starting at column C<$start_col> (default C<0>), which is useful
1101	to replace only parts of a line. The font index in the rendition will	1405	to replace only parts of a line. The font index in the rendition will
1102	automatically be updated.	1406	automatically be updated.
1103		1407
1104	C<$text> is in a special encoding: tabs and wide characters that use more	1408	C<$text> is in a special encoding: tabs and wide characters that use
1105	than one cell when displayed are padded with urxvt::NOCHAR characters	1409	more than one cell when displayed are padded with C<$urxvt::NOCHAR>
1106	(C<chr 65535>). Characters with combining characters and other characters	1410	characters. Characters with combining characters and other characters that
1107	that do not fit into the normal tetx encoding will be replaced with	1411	do not fit into the normal tetx encoding will be replaced with characters
1108	characters in the private use area.	1412	in the private use area.
1109		1413
1110	You have to obey this encoding when changing text. The advantage is	1414	You have to obey this encoding when changing text. The advantage is
1111	that C<substr> and similar functions work on screen cells and not on	1415	that C<substr> and similar functions work on screen cells and not on
1112	characters.	1416	characters.
1113		1417
…		…
1164	Return the row number of the first/last row of the line, respectively.	1468	Return the row number of the first/last row of the line, respectively.
1165		1469
1166	=item $offset = $line->offset_of ($row, $col)	1470	=item $offset = $line->offset_of ($row, $col)
1167		1471
1168	Returns the character offset of the given row\|col pair within the logical	1472	Returns the character offset of the given row\|col pair within the logical
1169	line.	1473	line. Works for rows outside the line, too, and returns corresponding
		1474	offsets outside the string.
1170		1475
1171	=item ($row, $col) = $line->coord_of ($offset)	1476	=item ($row, $col) = $line->coord_of ($offset)
1172		1477
1173	Translates a string offset into terminal coordinates again.	1478	Translates a string offset into terminal coordinates again.
1174		1479
…		…
1287		1592
1288	Calls XUngrab for the most recent grab. Is called automatically on	1593	Calls XUngrab for the most recent grab. Is called automatically on
1289	evaluation errors, as it is better to lose the grab in the error case as	1594	evaluation errors, as it is better to lose the grab in the error case as
1290	the session.	1595	the session.
1291		1596
		1597	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1598
		1599	=item $atom_name = $term->XGetAtomName ($atom)
		1600
		1601	=item @atoms = $term->XListProperties ($window)
		1602
		1603	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1604
		1605	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1606
		1607	=item $term->XDeleteProperty ($window, $property)
		1608
		1609	=item $window = $term->DefaultRootWindow
		1610
		1611	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1612
		1613	=item $term->XMapWindow ($window)
		1614
		1615	=item $term->XUnmapWindow ($window)
		1616
		1617	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1618
		1619	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1620
		1621	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1622
		1623	Various X or X-related functions. The C<$term> object only serves as
		1624	the source of the display, otherwise those functions map more-or-less
		1625	directory onto the X functions of the same name.
		1626
1292	=back	1627	=back
1293		1628
1294	=cut	1629	=cut
1295		1630
1296	package urxvt::popup;	1631	package urxvt::popup;
…		…
1310		1645
1311	$item->{render} \|\|= sub { $_[0]{text} };	1646	$item->{render} \|\|= sub { $_[0]{text} };
1312		1647
1313	push @{ $self->{item} }, $item;	1648	push @{ $self->{item} }, $item;
1314	}	1649	}
		1650
		1651	=item $popup->add_title ($title)
		1652
		1653	Adds a non-clickable title to the popup.
		1654
		1655	=cut
		1656
		1657	sub add_title {
		1658	my ($self, $title) = @_;
		1659
		1660	$self->add_item ({
		1661	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1662	text => $title,
		1663	activate => sub { },
		1664	});
		1665	}
		1666
		1667	=item $popup->add_separator ([$sepchr])
		1668
		1669	Creates a separator, optionally using the character given as C<$sepchr>.
		1670
		1671	=cut
1315		1672
1316	sub add_separator {	1673	sub add_separator {
1317	my ($self, $sep) = @_;	1674	my ($self, $sep) = @_;
1318		1675
1319	$sep \|\|= "=";	1676	$sep \|\|= "=";
…		…
1324	render => sub { $sep x $self->{term}->ncol },	1681	render => sub { $sep x $self->{term}->ncol },
1325	activate => sub { },	1682	activate => sub { },
1326	});	1683	});
1327	}	1684	}
1328		1685
1329	sub add_title {	1686	=item $popup->add_button ($text, $cb)
1330	my ($self, $title) = @_;
1331		1687
1332	$self->add_item ({	1688	Adds a clickable button to the popup. C<$cb> is called whenever it is
1333	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1689	selected.
1334	text => $title,	1690
1335	activate => sub { },	1691	=cut
1336	});
1337	}
1338		1692
1339	sub add_button {	1693	sub add_button {
1340	my ($self, $text, $cb) = @_;	1694	my ($self, $text, $cb) = @_;
1341		1695
1342	$self->add_item ({ type => "button", text => $text, activate => $cb});	1696	$self->add_item ({ type => "button", text => $text, activate => $cb});
1343	}	1697	}
		1698
		1699	=item $popup->add_toggle ($text, $cb, $initial_value)
		1700
		1701	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1702	whenever it gets toggled, with a boolean indicating its value as its first
		1703	argument.
		1704
		1705	=cut
1344		1706
1345	sub add_toggle {	1707	sub add_toggle {
1346	my ($self, $text, $cb, $value) = @_;	1708	my ($self, $text, $cb, $value) = @_;
1347		1709
1348	my $item; $item = {	1710	my $item; $item = {
1349	type => "button",	1711	type => "button",
1350	text => " $text",	1712	text => " $text",
1351	value => $value,	1713	value => $value,
1352	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1714	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1353	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1715	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1354	};	1716	};
1355		1717
1356	$self->add_item ($item);	1718	$self->add_item ($item);
1357	}	1719	}
		1720
		1721	=item $popup->show
		1722
		1723	Displays the popup (which is initially hidden).
		1724
		1725	=cut
1358		1726
1359	sub show {	1727	sub show {
1360	my ($self) = @_;	1728	my ($self) = @_;
1361		1729
1362	local $urxvt::popup::self = $self;	1730	local $urxvt::popup::self = $self;
1363		1731
		1732	my $env = $self->{term}->env;
		1733	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1734	delete $env->{LC_ALL};
1364	local $ENV{LC_ALL} = $self->{term}->locale;	1735	$env->{LC_CTYPE} = $self->{term}->locale;
1365		1736
1366	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1737	urxvt::term->new ($env, "popup",
		1738	"--perl-lib" => "", "--perl-ext-common" => "",
		1739	"-pty-fd" => -1, "-sl" => 0,
		1740	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1367	"--transient-for" => $self->{term}->parent,	1741	"--transient-for" => $self->{term}->parent,
1368	"-display" => $self->{term}->display_id,	1742	"-display" => $self->{term}->display_id,
1369	"-pe" => "urxvt-popup")	1743	"-pe" => "urxvt-popup")
1370	or die "unable to create popup window\n";	1744	or die "unable to create popup window\n";
1371	}	1745	}
1372		1746
1373	sub DESTROY {	1747	sub DESTROY {
1374	my ($self) = @_;	1748	my ($self) = @_;
1375		1749
1376	delete $self->{term}{_destroy}{$self};	1750	delete $self->{term}{_destroy}{$self};
1377	$self->{term}->ungrab;	1751	$self->{term}->ungrab;
1378	}	1752	}
		1753
		1754	=back
		1755
		1756	=cut
		1757
		1758	package urxvt::watcher;
		1759
		1760	@urxvt::timer::ISA = __PACKAGE__;
		1761	@urxvt::iow::ISA = __PACKAGE__;
		1762	@urxvt::pw::ISA = __PACKAGE__;
		1763	@urxvt::iw::ISA = __PACKAGE__;
1379		1764
1380	=head2 The C<urxvt::timer> Class	1765	=head2 The C<urxvt::timer> Class
1381		1766
1382	This class implements timer watchers/events. Time is represented as a	1767	This class implements timer watchers/events. Time is represented as a
1383	fractional number of seconds since the epoch. Example:	1768	fractional number of seconds since the epoch. Example:
…		…
1421	Start the timer.	1806	Start the timer.
1422		1807
1423	=item $timer = $timer->start ($tstamp)	1808	=item $timer = $timer->start ($tstamp)
1424		1809
1425	Set the event trigger time to C<$tstamp> and start the timer.	1810	Set the event trigger time to C<$tstamp> and start the timer.
		1811
		1812	=item $timer = $timer->after ($delay)
		1813
		1814	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1426		1815
1427	=item $timer = $timer->stop	1816	=item $timer = $timer->stop
1428		1817
1429	Stop the timer.	1818	Stop the timer.
1430		1819
…		…
1477		1866
1478	Stop watching for events on the given filehandle.	1867	Stop watching for events on the given filehandle.
1479		1868
1480	=back	1869	=back
1481		1870
		1871	=head2 The C<urxvt::iw> Class
		1872
		1873	This class implements idle watchers, that get called automatically when
		1874	the process is idle. They should return as fast as possible, after doing
		1875	some useful work.
		1876
		1877	=over 4
		1878
		1879	=item $iw = new urxvt::iw
		1880
		1881	Create a new idle watcher object in stopped state.
		1882
		1883	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1884
		1885	Set the callback to be called when the watcher triggers.
		1886
		1887	=item $timer = $timer->start
		1888
		1889	Start the watcher.
		1890
		1891	=item $timer = $timer->stop
		1892
		1893	Stop the watcher.
		1894
		1895	=back
		1896
		1897	=head2 The C<urxvt::pw> Class
		1898
		1899	This class implements process watchers. They create an event whenever a
		1900	process exits, after which they stop automatically.
		1901
		1902	my $pid = fork;
		1903	...
		1904	$term->{pw} = urxvt::pw
		1905	->new
		1906	->start ($pid)
		1907	->cb (sub {
		1908	my ($pw, $exit_status) = @_;
		1909	...
		1910	});
		1911
		1912	=over 4
		1913
		1914	=item $pw = new urxvt::pw
		1915
		1916	Create a new process watcher in stopped state.
		1917
		1918	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1919
		1920	Set the callback to be called when the timer triggers.
		1921
		1922	=item $pw = $timer->start ($pid)
		1923
		1924	Tells the wqtcher to start watching for process C<$pid>.
		1925
		1926	=item $pw = $pw->stop
		1927
		1928	Stop the watcher.
		1929
		1930	=back
		1931
1482	=head1 ENVIRONMENT	1932	=head1 ENVIRONMENT
1483		1933
1484	=head2 URXVT_PERL_VERBOSITY	1934	=head2 URXVT_PERL_VERBOSITY
1485		1935
1486	This variable controls the verbosity level of the perl extension. Higher	1936	This variable controls the verbosity level of the perl extension. Higher
…		…
1490		1940
1491	=item == 0 - fatal messages	1941	=item == 0 - fatal messages
1492		1942
1493	=item >= 3 - script loading and management	1943	=item >= 3 - script loading and management
1494		1944
1495	=item >=10 - all events received	1945	=item >=10 - all called hooks
		1946
		1947	=item >=11 - hook reutrn values
1496		1948
1497	=back	1949	=back
1498		1950
1499	=head1 AUTHOR	1951	=head1 AUTHOR
1500		1952

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.75 by root, Tue Jan 10 05:00:13 2006 UTC vs. Revision 1.121 by root, Fri Jan 20 22:49:34 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.75 by root, Tue Jan 10 05:00:13 2006 UTC vs.
Revision 1.121 by root, Fri Jan 20 22:49:34 2006 UTC