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

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.125 by root, Sun Jan 22 20:39:47 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.125 by root, Sun Jan 22 20:39:47 2006 UTC