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

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.73 by root, Tue Jan 10 04:23:39 2006 UTC vs. Revision 1.121 by root, Fri Jan 20 22:49:34 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.73 by root, Tue Jan 10 04:23:39 2006 UTC vs.
Revision 1.121 by root, Fri Jan 20 22:49:34 2006 UTC