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

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

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.72 by root, Mon Jan 9 23:30:01 2006 UTC vs. Revision 1.127 by root, Wed Jan 25 00:42:21 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.72 by root, Mon Jan 9 23:30:01 2006 UTC vs.
Revision 1.127 by root, Wed Jan 25 00:42:21 2006 UTC