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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.72 by root, Mon Jan 9 23:30:01 2006 UTC vs.
Revision 1.122 by root, Sat Jan 21 08:07:38 2006 UTC

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.72 by root, Mon Jan 9 23:30:01 2006 UTC vs. Revision 1.122 by root, Sat Jan 21 08:07:38 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.72 by root, Mon Jan 9 23:30:01 2006 UTC vs.
Revision 1.122 by root, Sat Jan 21 08:07:38 2006 UTC