[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.129 by root, Wed Jan 25 15:11:31 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	Another example: Programs I use often output "absolute path: " at the
		73	beginning of a line when they process multiple files. The following
		74	pattern matches the filename (note, there is a single space at the very
		75	end):
		76
		77	URxvt.selection.pattern-0: ^(/[^:]+):\
		78
		79	You can look at the source of the selection extension to see more
		80	interesting uses, such as parsing a line from beginning to end.
		81
49	It also offers the following bindable keyboard command:	82	This extension also offers following bindable keyboard commands:
50		83
51	=over 4	84	=over 4
52		85
53	=item rot13	86	=item rot13
54		87
…		…
65		98
66	=item selection-popup (enabled by default)	99	=item selection-popup (enabled by default)
67		100
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	101	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	102	text into various other formats/action (such as uri unescaping, perl
70	evalution, web-browser starting etc.), depending on content.	103	evaluation, web-browser starting etc.), depending on content.
		104
		105	Other extensions can extend this popup menu by pushing a code reference
		106	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		107	popup is displayed.
		108
		109	It's sole argument is the popup menu, which can be modified. The selection
		110	is in C<$_>, which can be used to decide wether to add something or not.
		111	It should either return nothing or a string and a code reference. The
		112	string will be used as button text and the code reference will be called
		113	when the button gets activated and should transform C<$_>.
		114
		115	The following will add an entry C<a to b> that transforms all C<a>s in
		116	the selection to C<b>s, but only if the selection currently contains any
		117	C<a>s:
		118
		119	push @{ $self->{term}{selection_popup_hook} }, sub {
		120	/a/ ? ("a to be" => sub { s/a/b/g }
		121	: ()
		122	};
71		123
72	=item searchable-scrollback<hotkey> (enabled by default)	124	=item searchable-scrollback<hotkey> (enabled by default)
73		125
74	Adds regex search functionality to the scrollback buffer, triggered	126	Adds regex search functionality to the scrollback buffer, triggered
75	by a hotkey (default: C<M-s>). When in search mode, normal terminal	127	by a hotkey (default: C<M-s>). While in search mode, normal terminal
76	input/output is suspended.	128	input/output is suspended and a regex is displayed at the bottom of the
		129	screen.
77		130
78	C</> starts an incremental regex search, C<n> searches further, C<p> or	131	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	132	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>	133	search upwards/downwards in the scrollback buffer, C<End> jumps to the
81	returns to the original position.	134	bottom. C<Escape> leaves search mode and returns to the point where search
		135	was started, while C<Enter> or C<Return> stay at the current position and
		136	additionally stores the first match in the current line into the primary
		137	selection.
82		138
83	=item digital-clock	139	=item readline (enabled by default)
84		140
85	Displays a digital clock using the built-in overlay.	141	A support package that tries to make editing with readline easier. At the
		142	moment, it reacts to clicking with the left mouse button by trying to
		143	move the text cursor to this position. It does so by generating as many
		144	cursor-left or cursor-right keypresses as required (the this only works
		145	for programs that correctly support wide characters).
		146
		147	To avoid too many false positives, this is only done when:
		148
		149	=over 4
		150
		151	=item - the tty is in ICANON state.
		152
		153	=item - the text cursor is visible.
		154
		155	=item - the primary screen is currently being displayed.
		156
		157	=item - the mouse is on the same (multi-row-) line as the text cursor.
		158
		159	=back
		160
		161	The normal selection mechanism isn't disabled, so quick successive clicks
		162	might interfere with selection creation in harmless ways.
		163
		164	=item selection-autotransform
		165
		166	This selection allows you to do automatic transforms on a selection
		167	whenever a selection is made.
		168
		169	It works by specifying perl snippets (most useful is a single C<s///>
		170	operator) that modify C<$_> as resources:
		171
		172	URxvt.selection-autotransform.0: transform
		173	URxvt.selection-autotransform.1: transform
		174	...
		175
		176	For example, the following will transform selections of the form
		177	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		178	$word>:
		179
		180	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		181
		182	And this example matches the same,but replaces it with vi-commands you can
		183	paste directly into your (vi :) editor:
		184
		185	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		186
		187	Of course, this can be modified to suit your needs and your editor :)
		188
		189	To expand the example above to typical perl error messages ("XXX at
		190	FILENAME line YYY."), you need a slightly more elaborate solution:
		191
		192	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		193	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		194
		195	The first line tells the selection code to treat the unchanging part of
		196	every error message as a selection pattern, and the second line transforms
		197	the message into vi commands to load the file.
		198
		199	=item tabbed
		200
		201	This transforms the terminal into a tabbar with additional terminals, that
		202	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		203	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		204	button per tab.
		205
		206	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		207	B<Shift-Right> will switch to the tab left or right of the current one,
		208	while B<Shift-Down> creates a new tab.
86		209
87	=item mark-urls	210	=item mark-urls
88		211
89	Uses per-line display filtering (C<on_line_update>) to underline urls.	212	Uses per-line display filtering (C<on_line_update>) to underline urls and
		213	make them clickable. When middle-clicked, the program specified in the
		214	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		215	the URL as first argument.
		216
		217	=item xim-onthespot
		218
		219	This (experimental) perl extension implements OnTheSpot editing. It does
		220	not work perfectly, and some input methods don't seem to work well with
		221	OnTheSpot editing in general, but it seems to work at leats for SCIM and
		222	kinput2.
		223
		224	You enable it by specifying this extension and a preedit style of
		225	C<OnTheSpot>, i.e.:
		226
		227	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		228
		229	=item automove-background
		230
		231	This is basically a one-line extension that dynamically changes the background pixmap offset
		232	to the window position, in effect creating the same effect as pseudo transparency with
		233	a custom pixmap. No scaling is supported in this mode. Exmaple:
		234
		235	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
90		236
91	=item block-graphics-to-ascii	237	=item block-graphics-to-ascii
92		238
93	A not very useful example of filtering all text output to the terminal,	239	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	240	by replacing all line-drawing characters (U+2500 .. U+259F) by a
95	similar-looking ascii character.	241	similar-looking ascii character.
		242
		243	=item digital-clock
		244
		245	Displays a digital clock using the built-in overlay.
		246
		247	=item remote-selection
		248
		249	Somewhat of a misnomer, this extension adds two menu entries to the
		250	selection popup that allows one ti run external commands to store the
		251	selection somewhere and fetch it again.
		252
		253	We use it to implement a "distributed selection mechanism", which just
		254	means that one command uploads the file to a remote server, and another
		255	reads it.
		256
		257	The commands can be set using the C<URxvt.remote-selection.store> and
		258	C<URxvt.remote-selection.fetch> resources. The first should read the
		259	selection to store from STDIN (always in UTF-8), the second should provide
		260	the selection data on STDOUT (also in UTF-8).
		261
		262	The defaults (which are likely useless to you) use rsh and cat:
		263
		264	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		265	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		266
		267	=item selection-pastebin
		268
		269	This is a little rarely useful extension that Uploads the selection as
		270	textfile to a remote site (or does other things). (The implementation is
		271	not currently secure for use in a multiuser environment as it writes to
		272	F</tmp> directly.).
		273
		274	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		275	i.e.
		276
		277	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		278
		279	Pressing this combination runs a command with C<%> replaced by the name of
		280	the textfile. This command can be set via a resource:
		281
		282	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		283
		284	And the default is likely not useful to anybody but the few people around
		285	here :)
		286
		287	The name of the textfile is the hex encoded md5 sum of the selection, so
		288	the same content should lead to the same filename.
		289
		290	After a successful upload the selection will be replaced by the text given
		291	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		292	for the filename):
		293
		294	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
96		295
97	=item example-refresh-hooks	296	=item example-refresh-hooks
98		297
99	Displays a very simple digital clock in the upper right corner of the	298	Displays a very simple digital clock in the upper right corner of the
100	window. Illustrates overwriting the refresh callbacks to create your own	299	window. Illustrates overwriting the refresh callbacks to create your own
…		…
123	=over 4	322	=over 4
124		323
125	=item $text	324	=item $text
126		325
127	Rxvt-unicodes special way of encoding text, where one "unicode" character	326	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.	327	always represents one screen cell. See L<ROW_t> for a discussion of this format.
129		328
130	=item $string	329	=item $string
131		330
132	A perl text string, with an emphasis on I<text>. It can store all unicode	331	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	332	characters and is to be distinguished with text encoded in a specific
…		…
179	called whenever the relevant event happens.	378	called whenever the relevant event happens.
180		379
181	The first argument passed to them is an extension oject as described in	380	The first argument passed to them is an extension oject as described in
182	the in the C<Extension Objects> section.	381	the in the C<Extension Objects> section.
183		382
184	B<All> of these hooks must return a boolean value. If it is true, then the	383	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	384	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.	385	relevant action might not be carried out by the C++ code.
187		386
188	I<< When in doubt, return a false value (preferably C<()>). >>	387	I<< When in doubt, return a false value (preferably C<()>). >>
189		388
190	=over 4	389	=over 4
191		390
192	=item on_init $term	391	=item on_init $term
193		392
194	Called after a new terminal object has been initialized, but before	393	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	394	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	395	call or deliver senseless data, as terminal size and other characteristics
197	have not yet been determined. You can safely query and change resources,	396	have not yet been determined. You can safely query and change resources
198	though.	397	and options, though. For many purposes the C<on_start> hook is a better
		398	place.
		399
		400	=item on_start $term
		401
		402	Called at the very end of initialisation of a new terminal, just before
		403	trying to map (display) the toplevel and returning to the mainloop.
		404
		405	=item on_destroy $term
		406
		407	Called whenever something tries to destroy terminal, when the terminal is
		408	still fully functional (not for long, though).
199		409
200	=item on_reset $term	410	=item on_reset $term
201		411
202	Called after the screen is "reset" for any reason, such as resizing or	412	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	413	control sequences. Here is where you can react on changes to size-related
204	variables.	414	variables.
205		415
206	=item on_start $term	416	=item on_child_start $term, $pid
207		417
208	Called at the very end of initialisation of a new terminal, just before	418	Called just after the child process has been C<fork>ed.
209	returning to the mainloop.	419
		420	=item on_child_exit $term, $status
		421
		422	Called just after the child process has exited. C<$status> is the status
		423	from C<waitpid>.
210		424
211	=item on_sel_make $term, $eventtime	425	=item on_sel_make $term, $eventtime
212		426
213	Called whenever a selection has been made by the user, but before the	427	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	428	selection text is copied, so changes to the beginning, end or type of the
…		…
228	=item on_sel_extend $term	442	=item on_sel_extend $term
229		443
230	Called whenever the user tries to extend the selection (e.g. with a double	444	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	445	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	446	should extend the selection itelf and return true to suppress the built-in
233	processing.	447	processing. This can happen multiple times, as long as the callback
		448	returns true, it will be called on every further click by the user and is
		449	supposed to enlarge the selection more and more, if possible.
234		450
235	See the F<selection> example extension.	451	See the F<selection> example extension.
236		452
237	=item on_view_change $term, $offset	453	=item on_view_change $term, $offset
238		454
…		…
305		521
306	Called whenever the user presses a key combination that has a	522	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>	523	C<perl:string> action bound to it (see description of the B<keysym>
308	resource in the @@RXVT_NAME@@(1) manpage).	524	resource in the @@RXVT_NAME@@(1) manpage).
309		525
		526	=item on_x_event $term, $event
		527
		528	Called on every X event received on the vt window (and possibly other
		529	windows). Should only be used as a last resort. Most event structure
		530	members are not passed.
		531
310	=item on_focus_in $term	532	=item on_focus_in $term
311		533
312	Called whenever the window gets the keyboard focus, before rxvt-unicode	534	Called whenever the window gets the keyboard focus, before rxvt-unicode
313	does focus in processing.	535	does focus in processing.
314		536
315	=item on_focus_out $term	537	=item on_focus_out $term
316		538
317	Called wheneever the window loses keyboard focus, before rxvt-unicode does	539	Called wheneever the window loses keyboard focus, before rxvt-unicode does
318	focus out processing.	540	focus out processing.
319		541
		542	=item on_configure_notify $term, $event
		543
		544	=item on_property_notify $term, $event
		545
320	=item on_key_press $term, $event, $keysym, $octets	546	=item on_key_press $term, $event, $keysym, $octets
321		547
322	=item on_key_release $term, $event, $keysym	548	=item on_key_release $term, $event, $keysym
323		549
324	=item on_button_press $term, $event	550	=item on_button_press $term, $event
…		…
333		559
334	Called whenever the corresponding X event is received for the terminal If	560	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.	561	the hook returns true, then the even will be ignored by rxvt-unicode.
336		562
337	The event is a hash with most values as named by Xlib (see the XEvent	563	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	564	manpage), with the additional members C<row> and C<col>, which are the
339	and column under the mouse cursor.	565	(real, not screen-based) row and column under the mouse cursor.
340		566
341	C<on_key_press> additionally receives the string rxvt-unicode would	567	C<on_key_press> additionally receives the string rxvt-unicode would
342	output, if any, in locale-specific encoding.	568	output, if any, in locale-specific encoding.
343		569
344	subwindow.	570	subwindow.
345		571
346	=back	572	=item on_client_message $term, $event
347		573
348	=head2 Variables in the C<urxvt> Package	574	=item on_wm_protocols $term, $event
349		575
350	=over 4	576	=item on_wm_delete_window $term, $event
351		577
352	=item $urxvt::LIBDIR	578	Called when various types of ClientMessage events are received (all with
353		579	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		580
471	=back	581	=back
472		582
473	=cut	583	=cut
474		584
…		…
480	use Scalar::Util ();	590	use Scalar::Util ();
481	use List::Util ();	591	use List::Util ();
482		592
483	our $VERSION = 1;	593	our $VERSION = 1;
484	our $TERM;	594	our $TERM;
		595	our @TERM_INIT;
		596	our @TERM_EXT;
485	our @HOOKNAME;	597	our @HOOKNAME;
486	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	598	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
487	our %OPTION;	599	our %OPTION;
488		600
489	our $LIBDIR;	601	our $LIBDIR;
490	our $RESNAME;	602	our $RESNAME;
491	our $RESCLASS;	603	our $RESCLASS;
492	our $RXVTNAME;	604	our $RXVTNAME;
493		605
		606	our $NOCHAR = chr 0xffff;
		607
		608	=head2 Variables in the C<urxvt> Package
		609
		610	=over 4
		611
		612	=item $urxvt::LIBDIR
		613
		614	The rxvt-unicode library directory, where, among other things, the perl
		615	modules and scripts are stored.
		616
		617	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		618
		619	The resource class and name rxvt-unicode uses to look up X resources.
		620
		621	=item $urxvt::RXVTNAME
		622
		623	The basename of the installed binaries, usually C<urxvt>.
		624
		625	=item $urxvt::TERM
		626
		627	The current terminal. This variable stores the current C<urxvt::term>
		628	object, whenever a callback/hook is executing.
		629
		630	=item @urxvt::TERM_INIT
		631
		632	All coderefs in this array will be called as methods of the next newly
		633	created C<urxvt::term> object (during the C<on_init> phase). The array
		634	gets cleared before the codereferences that were in it are being executed,
		635	so coderefs can push themselves onto it again if they so desire.
		636
		637	This complements to the perl-eval commandline option, but gets executed
		638	first.
		639
		640	=item @urxvt::TERM_EXT
		641
		642	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		643	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		644	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		645
		646	=back
		647
		648	=head2 Functions in the C<urxvt> Package
		649
		650	=over 4
		651
		652	=item urxvt::fatal $errormessage
		653
		654	Fatally aborts execution with the given error message. Avoid at all
		655	costs! The only time this is acceptable is when the terminal process
		656	starts up.
		657
		658	=item urxvt::warn $string
		659
		660	Calls C<rxvt_warn> with the given string which should not include a
		661	newline. The module also overwrites the C<warn> builtin with a function
		662	that calls this function.
		663
		664	Using this function has the advantage that its output ends up in the
		665	correct place, e.g. on stderr of the connecting urxvtc client.
		666
		667	Messages have a size limit of 1023 bytes currently.
		668
		669	=item $time = urxvt::NOW
		670
		671	Returns the "current time" (as per the event loop).
		672
		673	=item urxvt::CurrentTime
		674
		675	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		676	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		677	Button4Mask, Button5Mask, AnyModifier
		678
		679	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		680	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		681	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		682	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		683	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		684	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		685	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		686
		687	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		688	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		689	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		690	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		691	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		692	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		693	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		694
		695	Various constants for use in X calls and event processing.
		696
		697	=back
		698
		699	=head2 RENDITION
		700
		701	Rendition bitsets contain information about colour, font, font styles and
		702	similar information for each screen cell.
		703
		704	The following "macros" deal with changes in rendition sets. You should
		705	never just create a bitset, you should always modify an existing one,
		706	as they contain important information required for correct operation of
		707	rxvt-unicode.
		708
		709	=over 4
		710
		711	=item $rend = urxvt::DEFAULT_RSTYLE
		712
		713	Returns the default rendition, as used when the terminal is starting up or
		714	being reset. Useful as a base to start when creating renditions.
		715
		716	=item $rend = urxvt::OVERLAY_RSTYLE
		717
		718	Return the rendition mask used for overlays by default.
		719
		720	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		721
		722	Return the bit that enabled bold, italic, blink, reverse-video and
		723	underline, respectively. To enable such a style, just logically OR it into
		724	the bitset.
		725
		726	=item $foreground = urxvt::GET_BASEFG $rend
		727
		728	=item $background = urxvt::GET_BASEBG $rend
		729
		730	Return the foreground/background colour index, respectively.
		731
		732	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		733
		734	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		735
		736	Replace the foreground/background colour in the rendition mask with the
		737	specified one.
		738
		739	=item $value = urxvt::GET_CUSTOM $rend
		740
		741	Return the "custom" value: Every rendition has 5 bits for use by
		742	extensions. They can be set and changed as you like and are initially
		743	zero.
		744
		745	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		746
		747	Change the custom value.
		748
		749	=back
		750
		751	=cut
		752
494	BEGIN {	753	BEGIN {
495	urxvt->bootstrap;
496
497	# overwrite perl's warn	754	# overwrite perl's warn
498	*CORE::GLOBAL::warn = sub {	755	*CORE::GLOBAL::warn = sub {
499	my $msg = join "", @_;	756	my $msg = join "", @_;
500	$msg .= "\n"	757	$msg .= "\n"
501	unless $msg =~ /\n$/;	758	unless $msg =~ /\n$/;
502	urxvt::warn ($msg);	759	urxvt::warn ($msg);
503	};	760	};
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	}	761	}
510		762
511	my @hook_count;	763	no warnings 'utf8';
		764
512	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	765	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
513		766
514	sub verbose {	767	sub verbose {
515	my ($level, $msg) = @_;	768	my ($level, $msg) = @_;
516	warn "$msg\n" if $level <= $verbosity;	769	warn "$msg\n" if $level <= $verbosity;
517	}	770	}
518		771
519	my $extension_pkg = "extension0000";
520	my %extension_pkg;	772	my %extension_pkg;
521		773
522	# load a single script into its own package, once only	774	# load a single script into its own package, once only
523	sub extension_package($) {	775	sub extension_package($) {
524	my ($path) = @_;	776	my ($path) = @_;
525		777
526	$extension_pkg{$path} \|\|= do {	778	$extension_pkg{$path} \|\|= do {
527	my $pkg = "urxvt::" . ($extension_pkg++);	779	$path =~ /([^\/\\]+)$/;
		780	my $pkg = $1;
		781	$pkg =~ s/[^[:word:]]/_/g;
		782	$pkg = "urxvt::ext::$pkg";
528		783
529	verbose 3, "loading extension '$path' into package '$pkg'";	784	verbose 3, "loading extension '$path' into package '$pkg'";
530		785
531	open my $fh, "<:raw", $path	786	open my $fh, "<:raw", $path
532	or die "$path: $!";	787	or die "$path: $!";
533		788
534	my $source = untaint	789	my $source =
535	"package $pkg; use strict; use utf8;\n"	790	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
536	. "use base urxvt::term::extension::;\n"
537	. "#line 1 \"$path\"\n{\n"	791	. "#line 1 \"$path\"\n{\n"
538	. (do { local $/; <$fh> })	792	. (do { local $/; <$fh> })
539	. "\n};\n1";	793	. "\n};\n1";
540		794
541	eval $source	795	eval $source
…		…
555	if ($htype == 0) { # INIT	809	if ($htype == 0) { # INIT
556	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	810	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
557		811
558	my %ext_arg;	812	my %ext_arg;
559		813
		814	{
		815	my @init = @TERM_INIT;
		816	@TERM_INIT = ();
		817	$_->($TERM) for @init;
		818	my @pkg = @TERM_EXT;
		819	@TERM_EXT = ();
		820	$TERM->register_package ($_) for @pkg;
		821	}
		822
560	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	823	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
561	if ($_ eq "default") {	824	if ($_ eq "default") {
562	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	825	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
563	} elsif (/^-(.*)$/) {	826	} elsif (/^-(.*)$/) {
564	delete $ext_arg{$1};	827	delete $ext_arg{$1};
565	} elsif (/^([^<]+)<(.*)>$/) {	828	} elsif (/^([^<]+)<(.*)>$/) {
566	push @{ $ext_arg{$1} }, $2;	829	push @{ $ext_arg{$1} }, $2;
567	} else {	830	} else {
…		…
590	if $verbosity >= 10;	853	if $verbosity >= 10;
591		854
592	keys %$cb;	855	keys %$cb;
593		856
594	while (my ($pkg, $cb) = each %$cb) {	857	while (my ($pkg, $cb) = each %$cb) {
595	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	858	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
596	and last;	859	$retval \|\|= $retval_;
597		860
598	if ($@) {	861	if ($@) {
599	$TERM->ungrab; # better to lose the grab than the session	862	$TERM->ungrab; # better to lose the grab than the session
600	warn $@;	863	warn $@;
601	}	864	}
602	}	865	}
		866
		867	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		868	if $verbosity >= 11;
603	}	869	}
604		870
605	if ($htype == 1) { # DESTROY	871	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	872	# clear package objects
614	%$_ = () for values %{ $TERM->{_pkg} };	873	%$_ = () for values %{ $TERM->{_pkg} };
615		874
616	# clear package	875	# clear package
617	%$TERM = ();	876	%$TERM = ();
…		…
631	while (my ($name, $cb) = each %hook) {	890	while (my ($name, $cb) = each %hook) {
632	my $htype = $HOOKTYPE{uc $name};	891	my $htype = $HOOKTYPE{uc $name};
633	defined $htype	892	defined $htype
634	or Carp::croak "unsupported hook type '$name'";	893	or Carp::croak "unsupported hook type '$name'";
635		894
		895	$self->set_should_invoke ($htype, +1)
636	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	896	unless exists $self->{term}{_hook}[$htype]{$pkg};
637	$hook_count[$htype]++
638	or urxvt::set_should_invoke $htype, 1;
639	}
640		897
641	$self->{term}{_hook}[$htype]{$pkg} = $cb;	898	$self->{term}{_hook}[$htype]{$pkg} = $cb;
642	}	899	}
643	}	900	}
644		901
…		…
649	for my $name (@hook) {	906	for my $name (@hook) {
650	my $htype = $HOOKTYPE{uc $name};	907	my $htype = $HOOKTYPE{uc $name};
651	defined $htype	908	defined $htype
652	or Carp::croak "unsupported hook type '$name'";	909	or Carp::croak "unsupported hook type '$name'";
653		910
		911	$self->set_should_invoke ($htype, -1)
654	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	912	if delete $self->{term}{_hook}[$htype]{$pkg};
655	--$hook_count[$htype]
656	or urxvt::set_should_invoke $htype, 0;
657	}
658	}	913	}
659	}	914	}
660		915
661	our $AUTOLOAD;	916	our $AUTOLOAD;
662		917
…		…
768	# find on_xxx subs in the package and register them	1023	# find on_xxx subs in the package and register them
769	# as hooks	1024	# as hooks
770	sub register_package {	1025	sub register_package {
771	my ($self, $pkg, $argv) = @_;	1026	my ($self, $pkg, $argv) = @_;
772		1027
		1028	no strict 'refs';
		1029
		1030	urxvt::verbose 6, "register package $pkg to $self";
		1031
		1032	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1033
773	my $proxy = bless {	1034	my $proxy = bless {
774	_pkg => $pkg,	1035	_pkg => $pkg,
775	argv => $argv,	1036	argv => $argv,
776	}, $pkg;	1037	}, $pkg;
777	Scalar::Util::weaken ($proxy->{term} = $self);	1038	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
783	$proxy->enable ($name => $ref);	1044	$proxy->enable ($name => $ref);
784	}	1045	}
785	}	1046	}
786	}	1047	}
787		1048
		1049	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1050
		1051	Creates a new terminal, very similar as if you had started it with system
		1052	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1053	hash which defines the environment of the new terminal.
		1054
		1055	Croaks (and probably outputs an error message) if the new instance
		1056	couldn't be created. Returns C<undef> if the new instance didn't
		1057	initialise perl, and the terminal object otherwise. The C<init> and
		1058	C<start> hooks will be called during this call.
		1059
		1060	=cut
		1061
		1062	sub new {
		1063	my ($class, $env, @args) = @_;
		1064
		1065	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		1066	}
		1067
788	=item $term->destroy	1068	=item $term->destroy
789		1069
790	Destroy the terminal object (close the window, free resources	1070	Destroy the terminal object (close the window, free resources
791	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1071	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
792	watchers (timers, io watchers) are still active.	1072	watchers (timers, io watchers) are still active.
793		1073
		1074	=item $term->exec_async ($cmd[, @args])
		1075
		1076	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1077	("starts") programs in the background. This function takes care of setting
		1078	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1079	be preferred over explicit calls to C<exec> or C<system>.
		1080
		1081	Returns the pid of the subprocess or C<undef> on error.
		1082
		1083	=cut
		1084
		1085	sub exec_async {
		1086	my $self = shift;
		1087
		1088	my $pid = fork;
		1089
		1090	return $pid
		1091	if !defined $pid or $pid;
		1092
		1093	%ENV = %{ $self->env };
		1094
		1095	exec @_;
		1096	urxvt::_exit 255;
		1097	}
		1098
794	=item $isset = $term->option ($optval[, $set])	1099	=item $isset = $term->option ($optval[, $set])
795		1100
796	Returns true if the option specified by C<$optval> is enabled, and	1101	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	1102	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.	1103	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	1105	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:	1106	source file F</src/optinc.h> to see the actual list:
802		1107
803	borderLess console cursorBlink cursorUnderline hold iconic insecure	1108	borderLess console cursorBlink cursorUnderline hold iconic insecure
804	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1109	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
805	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1110	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
806	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1111	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
807	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1112	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
808	tripleclickwords utmpInhibit visualBell	1113	transparent tripleclickwords utmpInhibit visualBell
809		1114
810	=item $value = $term->resource ($name[, $newval])	1115	=item $value = $term->resource ($name[, $newval])
811		1116
812	Returns the current resource value associated with a given name and	1117	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>	1118	optionally sets a new value. Setting values is most useful in the C<init>
…		…
830		1135
831	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1136	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
832	borderLess color cursorBlink cursorUnderline cutchars delete_key	1137	borderLess color cursorBlink cursorUnderline cutchars delete_key
833	display_name embed ext_bwidth fade font geometry hold iconName	1138	display_name embed ext_bwidth fade font geometry hold iconName
834	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1139	imFont imLocale inputMethod insecure int_bwidth intensityStyles
835	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1140	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
836	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1141	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
837	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1142	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
838	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1143	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
839	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1144	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
840	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1145	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
841	shade term_name title transparent transparent_all tripleclickwords	1146	secondaryScreen secondaryScroll selectstyle shade term_name title
842	utmpInhibit visualBell	1147	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1148	visualBell
843		1149
844	=cut	1150	=cut
845		1151
846	sub resource($$;$) {	1152	sub resource($$;$) {
847	my ($self, $name) = (shift, shift);	1153	my ($self, $name) = (shift, shift);
848	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1154	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
849	&urxvt::term::_resource	1155	&urxvt::term::_resource
850	}	1156	}
851		1157
		1158	=item $value = $term->x_resource ($pattern)
		1159
		1160	Returns the X-Resource for the given pattern, excluding the program or
		1161	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1162	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1163	resource with that pattern exists.
		1164
		1165	This method should only be called during the C<on_start> hook, as there is
		1166	only one resource database per display, and later invocations might return
		1167	the wrong resources.
		1168
852	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1169	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
853		1170
854	Adds a keymap translation exactly as specified via a resource. See the	1171	Adds a keymap translation exactly as specified via a resource. See the
855	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1172	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
856		1173
…		…
871	=item ($row, $col) = $term->selection_end ([$row, $col])	1188	=item ($row, $col) = $term->selection_end ([$row, $col])
872		1189
873	Return the current values of the selection mark, begin or end positions,	1190	Return the current values of the selection mark, begin or end positions,
874	and optionally set them to new values.	1191	and optionally set them to new values.
875		1192
		1193	=item $term->selection_make ($eventtime[, $rectangular])
		1194
		1195	Tries to make a selection as set by C<selection_beg> and
		1196	C<selection_end>. If C<$rectangular> is true (default: false), a
		1197	rectangular selection will be made. This is the prefered function to make
		1198	a selection.
		1199
876	=item $success = $term->selection_grab ($eventtime)	1200	=item $success = $term->selection_grab ($eventtime)
877		1201
878	Try to request the primary selection from the server (for example, as set	1202	Try to request the primary selection text from the server (for example, as
879	by the next method).	1203	set by the next method). No visual feedback will be given. This function
		1204	is mostly useful from within C<on_sel_grab> hooks.
880		1205
881	=item $oldtext = $term->selection ([$newtext])	1206	=item $oldtext = $term->selection ([$newtext])
882		1207
883	Return the current selection text and optionally replace it by C<$newtext>.	1208	Return the current selection text and optionally replace it by C<$newtext>.
884		1209
…		…
977	Convert the given locale-encoded octets into a perl string.	1302	Convert the given locale-encoded octets into a perl string.
978		1303
979	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1304	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
980		1305
981	XORs the rendition values in the given span with the provided value	1306	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	1307	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
983	to the selection.	1308	refresh hooks to provide effects similar to the selection.
984		1309
985	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1310	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
986		1311
987	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1312	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
988	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1313	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	1314	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
990	it instead.	1315	it instead. Both styles I<MUST NOT> contain font styles.
991		1316
992	=item $term->scr_bell	1317	=item $term->scr_bell
993		1318
994	Ring the bell!	1319	Ring the bell!
995		1320
…		…
1002		1327
1003	Normally its not a good idea to use this function, as programs might be	1328	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	1329	confused by changes in cursor position or scrolling. Its useful inside a
1005	C<on_add_lines> hook, though.	1330	C<on_add_lines> hook, though.
1006		1331
		1332	=item $term->scr_change_screen ($screen)
		1333
		1334	Switch to given screen - 0 primary, 1 secondary.
		1335
1007	=item $term->cmd_parse ($octets)	1336	=item $term->cmd_parse ($octets)
1008		1337
1009	Similar to C<scr_add_lines>, but the argument must be in the	1338	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	1339	locale-specific encoding of the terminal and can contain command sequences
1011	(escape codes) that will be interpreted.	1340	(escape codes) that will be interpreted.
…		…
1021	Replaces the event mask of the pty watcher by the given event mask. Can	1350	Replaces the event mask of the pty watcher by the given event mask. Can
1022	be used to suppress input and output handling to the pty/tty. See the	1351	be used to suppress input and output handling to the pty/tty. See the
1023	description of C<< urxvt::timer->events >>. Make sure to always restore	1352	description of C<< urxvt::timer->events >>. Make sure to always restore
1024	the previous value.	1353	the previous value.
1025		1354
		1355	=item $fd = $term->pty_fd
		1356
		1357	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1358	is used.
		1359
1026	=item $windowid = $term->parent	1360	=item $windowid = $term->parent
1027		1361
1028	Return the window id of the toplevel window.	1362	Return the window id of the toplevel window.
1029		1363
1030	=item $windowid = $term->vt	1364	=item $windowid = $term->vt
1031		1365
1032	Return the window id of the terminal window.	1366	Return the window id of the terminal window.
1033		1367
		1368	=item $term->vt_emask_add ($x_event_mask)
		1369
		1370	Adds the specified events to the vt event mask. Useful e.g. when you want
		1371	to receive pointer events all the times:
		1372
		1373	$term->vt_emask_add (urxvt::PointerMotionMask);
		1374
1034	=item $window_width = $term->width	1375	=item $window_width = $term->width
1035		1376
1036	=item $window_height = $term->height	1377	=item $window_height = $term->height
1037		1378
1038	=item $font_width = $term->fwidth	1379	=item $font_width = $term->fwidth
…		…
1051		1392
1052	=item $max_scrollback = $term->saveLines	1393	=item $max_scrollback = $term->saveLines
1053		1394
1054	=item $nrow_plus_saveLines = $term->total_rows	1395	=item $nrow_plus_saveLines = $term->total_rows
1055		1396
1056	=item $lines_in_scrollback = $term->nsaved	1397	=item $topmost_scrollback_row = $term->top_row
1057		1398
1058	Return various integers describing terminal characteristics.	1399	Return various integers describing terminal characteristics.
1059		1400
		1401	=item $x_display = $term->display_id
		1402
		1403	Return the DISPLAY used by rxvt-unicode.
		1404
1060	=item $lc_ctype = $term->locale	1405	=item $lc_ctype = $term->locale
1061		1406
1062	Returns the LC_CTYPE category string used by this rxvt-unicode.	1407	Returns the LC_CTYPE category string used by this rxvt-unicode.
1063		1408
1064	=item $x_display = $term->display_id	1409	=item $env = $term->env
1065		1410
1066	Return the DISPLAY used by rxvt-unicode.	1411	Returns a copy of the environment in effect for the terminal as a hashref
		1412	similar to C<\%ENV>.
		1413
		1414	=cut
		1415
		1416	sub env {
		1417	if (my $env = $_[0]->_env) {
		1418	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1419	} else {
		1420	+{ %ENV }
		1421	}
		1422	}
1067		1423
1068	=item $modifiermask = $term->ModLevel3Mask	1424	=item $modifiermask = $term->ModLevel3Mask
1069		1425
1070	=item $modifiermask = $term->ModMetaMask	1426	=item $modifiermask = $term->ModMetaMask
1071		1427
1072	=item $modifiermask = $term->ModNumLockMask	1428	=item $modifiermask = $term->ModNumLockMask
1073		1429
1074	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1430	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.	1431	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1076		1432
		1433	=item $screen = $term->current_screen
		1434
		1435	Returns the currently displayed screen (0 primary, 1 secondary).
		1436
		1437	=item $cursor_is_hidden = $term->hidden_cursor
		1438
		1439	Returns wether the cursor is currently hidden or not.
		1440
1077	=item $view_start = $term->view_start ([$newvalue])	1441	=item $view_start = $term->view_start ([$newvalue])
1078		1442
1079	Returns the negative row number of the topmost line. Minimum value is	1443	Returns the row number of the topmost displayed line. Maximum value is
1080	C<0>, which displays the normal terminal contents. Larger values scroll	1444	C<0>, which displays the normal terminal contents. Lower values scroll
1081	this many lines into the scrollback buffer.	1445	this many lines into the scrollback buffer.
1082		1446
1083	=item $term->want_refresh	1447	=item $term->want_refresh
1084		1448
1085	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1449	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1100	line, starting at column C<$start_col> (default C<0>), which is useful	1464	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	1465	to replace only parts of a line. The font index in the rendition will
1102	automatically be updated.	1466	automatically be updated.
1103		1467
1104	C<$text> is in a special encoding: tabs and wide characters that use more	1468	C<$text> is in a special encoding: tabs and wide characters that use more
1105	than one cell when displayed are padded with urxvt::NOCHAR characters	1469	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1106	(C<chr 65535>). Characters with combining characters and other characters	1470	characters. Characters with combining characters and other characters that
1107	that do not fit into the normal tetx encoding will be replaced with	1471	do not fit into the normal tetx encoding will be replaced with characters
1108	characters in the private use area.	1472	in the private use area.
1109		1473
1110	You have to obey this encoding when changing text. The advantage is	1474	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	1475	that C<substr> and similar functions work on screen cells and not on
1112	characters.	1476	characters.
1113		1477
…		…
1164	Return the row number of the first/last row of the line, respectively.	1528	Return the row number of the first/last row of the line, respectively.
1165		1529
1166	=item $offset = $line->offset_of ($row, $col)	1530	=item $offset = $line->offset_of ($row, $col)
1167		1531
1168	Returns the character offset of the given row\|col pair within the logical	1532	Returns the character offset of the given row\|col pair within the logical
1169	line.	1533	line. Works for rows outside the line, too, and returns corresponding
		1534	offsets outside the string.
1170		1535
1171	=item ($row, $col) = $line->coord_of ($offset)	1536	=item ($row, $col) = $line->coord_of ($offset)
1172		1537
1173	Translates a string offset into terminal coordinates again.	1538	Translates a string offset into terminal coordinates again.
1174		1539
…		…
1287		1652
1288	Calls XUngrab for the most recent grab. Is called automatically on	1653	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	1654	evaluation errors, as it is better to lose the grab in the error case as
1290	the session.	1655	the session.
1291		1656
		1657	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1658
		1659	=item $atom_name = $term->XGetAtomName ($atom)
		1660
		1661	=item @atoms = $term->XListProperties ($window)
		1662
		1663	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1664
		1665	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1666
		1667	=item $term->XDeleteProperty ($window, $property)
		1668
		1669	=item $window = $term->DefaultRootWindow
		1670
		1671	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1672
		1673	=item $term->XMapWindow ($window)
		1674
		1675	=item $term->XUnmapWindow ($window)
		1676
		1677	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1678
		1679	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1680
		1681	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1682
		1683	Various X or X-related functions. The C<$term> object only serves as
		1684	the source of the display, otherwise those functions map more-or-less
		1685	directory onto the X functions of the same name.
		1686
1292	=back	1687	=back
1293		1688
1294	=cut	1689	=cut
1295		1690
1296	package urxvt::popup;	1691	package urxvt::popup;
…		…
1310		1705
1311	$item->{render} \|\|= sub { $_[0]{text} };	1706	$item->{render} \|\|= sub { $_[0]{text} };
1312		1707
1313	push @{ $self->{item} }, $item;	1708	push @{ $self->{item} }, $item;
1314	}	1709	}
		1710
		1711	=item $popup->add_title ($title)
		1712
		1713	Adds a non-clickable title to the popup.
		1714
		1715	=cut
		1716
		1717	sub add_title {
		1718	my ($self, $title) = @_;
		1719
		1720	$self->add_item ({
		1721	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1722	text => $title,
		1723	activate => sub { },
		1724	});
		1725	}
		1726
		1727	=item $popup->add_separator ([$sepchr])
		1728
		1729	Creates a separator, optionally using the character given as C<$sepchr>.
		1730
		1731	=cut
1315		1732
1316	sub add_separator {	1733	sub add_separator {
1317	my ($self, $sep) = @_;	1734	my ($self, $sep) = @_;
1318		1735
1319	$sep \|\|= "=";	1736	$sep \|\|= "=";
…		…
1324	render => sub { $sep x $self->{term}->ncol },	1741	render => sub { $sep x $self->{term}->ncol },
1325	activate => sub { },	1742	activate => sub { },
1326	});	1743	});
1327	}	1744	}
1328		1745
1329	sub add_title {	1746	=item $popup->add_button ($text, $cb)
1330	my ($self, $title) = @_;
1331		1747
1332	$self->add_item ({	1748	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" },	1749	selected.
1334	text => $title,	1750
1335	activate => sub { },	1751	=cut
1336	});
1337	}
1338		1752
1339	sub add_button {	1753	sub add_button {
1340	my ($self, $text, $cb) = @_;	1754	my ($self, $text, $cb) = @_;
1341		1755
1342	$self->add_item ({ type => "button", text => $text, activate => $cb});	1756	$self->add_item ({ type => "button", text => $text, activate => $cb});
1343	}	1757	}
		1758
		1759	=item $popup->add_toggle ($text, $cb, $initial_value)
		1760
		1761	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1762	whenever it gets toggled, with a boolean indicating its value as its first
		1763	argument.
		1764
		1765	=cut
1344		1766
1345	sub add_toggle {	1767	sub add_toggle {
1346	my ($self, $text, $cb, $value) = @_;	1768	my ($self, $text, $cb, $value) = @_;
1347		1769
1348	my $item; $item = {	1770	my $item; $item = {
1349	type => "button",	1771	type => "button",
1350	text => " $text",	1772	text => " $text",
1351	value => $value,	1773	value => $value,
1352	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1774	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1353	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1775	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1354	};	1776	};
1355		1777
1356	$self->add_item ($item);	1778	$self->add_item ($item);
1357	}	1779	}
		1780
		1781	=item $popup->show
		1782
		1783	Displays the popup (which is initially hidden).
		1784
		1785	=cut
1358		1786
1359	sub show {	1787	sub show {
1360	my ($self) = @_;	1788	my ($self) = @_;
1361		1789
1362	local $urxvt::popup::self = $self;	1790	local $urxvt::popup::self = $self;
1363		1791
		1792	my $env = $self->{term}->env;
		1793	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1794	delete $env->{LC_ALL};
1364	local $ENV{LC_ALL} = $self->{term}->locale;	1795	$env->{LC_CTYPE} = $self->{term}->locale;
1365		1796
1366	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1797	urxvt::term->new ($env, "popup",
		1798	"--perl-lib" => "", "--perl-ext-common" => "",
		1799	"-pty-fd" => -1, "-sl" => 0,
		1800	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1367	"--transient-for" => $self->{term}->parent,	1801	"--transient-for" => $self->{term}->parent,
1368	"-display" => $self->{term}->display_id,	1802	"-display" => $self->{term}->display_id,
1369	"-pe" => "urxvt-popup")	1803	"-pe" => "urxvt-popup")
1370	or die "unable to create popup window\n";	1804	or die "unable to create popup window\n";
1371	}	1805	}
1372		1806
1373	sub DESTROY {	1807	sub DESTROY {
1374	my ($self) = @_;	1808	my ($self) = @_;
1375		1809
1376	delete $self->{term}{_destroy}{$self};	1810	delete $self->{term}{_destroy}{$self};
1377	$self->{term}->ungrab;	1811	$self->{term}->ungrab;
1378	}	1812	}
		1813
		1814	=back
		1815
		1816	=cut
		1817
		1818	package urxvt::watcher;
		1819
		1820	@urxvt::timer::ISA = __PACKAGE__;
		1821	@urxvt::iow::ISA = __PACKAGE__;
		1822	@urxvt::pw::ISA = __PACKAGE__;
		1823	@urxvt::iw::ISA = __PACKAGE__;
1379		1824
1380	=head2 The C<urxvt::timer> Class	1825	=head2 The C<urxvt::timer> Class
1381		1826
1382	This class implements timer watchers/events. Time is represented as a	1827	This class implements timer watchers/events. Time is represented as a
1383	fractional number of seconds since the epoch. Example:	1828	fractional number of seconds since the epoch. Example:
…		…
1421	Start the timer.	1866	Start the timer.
1422		1867
1423	=item $timer = $timer->start ($tstamp)	1868	=item $timer = $timer->start ($tstamp)
1424		1869
1425	Set the event trigger time to C<$tstamp> and start the timer.	1870	Set the event trigger time to C<$tstamp> and start the timer.
		1871
		1872	=item $timer = $timer->after ($delay)
		1873
		1874	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1426		1875
1427	=item $timer = $timer->stop	1876	=item $timer = $timer->stop
1428		1877
1429	Stop the timer.	1878	Stop the timer.
1430		1879
…		…
1477		1926
1478	Stop watching for events on the given filehandle.	1927	Stop watching for events on the given filehandle.
1479		1928
1480	=back	1929	=back
1481		1930
		1931	=head2 The C<urxvt::iw> Class
		1932
		1933	This class implements idle watchers, that get called automatically when
		1934	the process is idle. They should return as fast as possible, after doing
		1935	some useful work.
		1936
		1937	=over 4
		1938
		1939	=item $iw = new urxvt::iw
		1940
		1941	Create a new idle watcher object in stopped state.
		1942
		1943	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1944
		1945	Set the callback to be called when the watcher triggers.
		1946
		1947	=item $timer = $timer->start
		1948
		1949	Start the watcher.
		1950
		1951	=item $timer = $timer->stop
		1952
		1953	Stop the watcher.
		1954
		1955	=back
		1956
		1957	=head2 The C<urxvt::pw> Class
		1958
		1959	This class implements process watchers. They create an event whenever a
		1960	process exits, after which they stop automatically.
		1961
		1962	my $pid = fork;
		1963	...
		1964	$term->{pw} = urxvt::pw
		1965	->new
		1966	->start ($pid)
		1967	->cb (sub {
		1968	my ($pw, $exit_status) = @_;
		1969	...
		1970	});
		1971
		1972	=over 4
		1973
		1974	=item $pw = new urxvt::pw
		1975
		1976	Create a new process watcher in stopped state.
		1977
		1978	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1979
		1980	Set the callback to be called when the timer triggers.
		1981
		1982	=item $pw = $timer->start ($pid)
		1983
		1984	Tells the wqtcher to start watching for process C<$pid>.
		1985
		1986	=item $pw = $pw->stop
		1987
		1988	Stop the watcher.
		1989
		1990	=back
		1991
1482	=head1 ENVIRONMENT	1992	=head1 ENVIRONMENT
1483		1993
1484	=head2 URXVT_PERL_VERBOSITY	1994	=head2 URXVT_PERL_VERBOSITY
1485		1995
1486	This variable controls the verbosity level of the perl extension. Higher	1996	This variable controls the verbosity level of the perl extension. Higher
…		…
1490		2000
1491	=item == 0 - fatal messages	2001	=item == 0 - fatal messages
1492		2002
1493	=item >= 3 - script loading and management	2003	=item >= 3 - script loading and management
1494		2004
1495	=item >=10 - all events received	2005	=item >=10 - all called hooks
		2006
		2007	=item >=11 - hook reutrn values
1496		2008
1497	=back	2009	=back
1498		2010
1499	=head1 AUTHOR	2011	=head1 AUTHOR
1500		2012

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.129 by root, Wed Jan 25 15:11:31 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.129 by root, Wed Jan 25 15:11:31 2006 UTC