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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.76 by root, Tue Jan 10 19:46:28 2006 UTC vs.
Revision 1.131 by root, Sun Jan 29 20:51:28 2006 UTC

…		…
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
39		39
		40	Or by adding them to the resource for extensions loaded by default:
		41
		42	URxvt.perl-ext-common: default,automove-background,selection-autotransform
		43
40	=over 4	44	=over 4
41		45
42	=item selection (enabled by default)	46	=item selection (enabled by default)
43		47
44	(More) intelligent selection. This extension tries to be more intelligent	48	(More) intelligent selection. This extension tries to be more intelligent
45	when the user extends selections (double-click). Right now, it tries to	49	when the user extends selections (double-click and further clicks). Right
46	select urls and complete shell-quoted arguments, which is very convenient,	50	now, it tries to select words, urls and complete shell-quoted
47	too, if your F<ls> supports C<--quoting-style=shell>.	51	arguments, which is very convenient, too, if your F<ls> supports
		52	C<--quoting-style=shell>.
48		53
		54	A double-click usually selects the word under the cursor, further clicks
		55	will enlarge the selection.
		56
		57	The selection works by trying to match a number of regexes and displaying
		58	them in increasing order of length. You can add your own regexes by
		59	specifying resources of the form:
		60
		61	URxvt.selection.pattern-0: perl-regex
		62	URxvt.selection.pattern-1: perl-regex
		63	...
		64
		65	The index number (0, 1...) must not have any holes, and each regex must
		66	contain at least one pair of capturing parentheses, which will be used for
		67	the match. For example, the followign adds a regex that matches everything
		68	between two vertical bars:
		69
		70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
		71
		72	Another example: Programs I use often output "absolute path: " at the
		73	beginning of a line when they process multiple files. The following
		74	pattern matches the filename (note, there is a single space at the very
		75	end):
		76
		77	URxvt.selection.pattern-0: ^(/[^:]+):\
		78
		79	You can look at the source of the selection extension to see more
		80	interesting uses, such as parsing a line from beginning to end.
		81
49	It also offers the following bindable keyboard command:	82	This extension also offers following bindable keyboard commands:
50		83
51	=over 4	84	=over 4
52		85
53	=item rot13	86	=item rot13
54		87
…		…
65		98
66	=item selection-popup (enabled by default)	99	=item selection-popup (enabled by default)
67		100
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	101	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action (such as uri unescaping, perl	102	text into various other formats/action (such as uri unescaping, perl
70	evalution, web-browser starting etc.), depending on content.	103	evaluation, web-browser starting etc.), depending on content.
		104
		105	Other extensions can extend this popup menu by pushing a code reference
		106	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		107	popup is displayed.
		108
		109	It's sole argument is the popup menu, which can be modified. The selection
		110	is in C<$_>, which can be used to decide wether to add something or not.
		111	It should either return nothing or a string and a code reference. The
		112	string will be used as button text and the code reference will be called
		113	when the button gets activated and should transform C<$_>.
		114
		115	The following will add an entry C<a to b> that transforms all C<a>s in
		116	the selection to C<b>s, but only if the selection currently contains any
		117	C<a>s:
		118
		119	push @{ $self->{term}{selection_popup_hook} }, sub {
		120	/a/ ? ("a to be" => sub { s/a/b/g }
		121	: ()
		122	};
71		123
72	=item searchable-scrollback<hotkey> (enabled by default)	124	=item searchable-scrollback<hotkey> (enabled by default)
73		125
74	Adds regex search functionality to the scrollback buffer, triggered	126	Adds regex search functionality to the scrollback buffer, triggered
75	by a hotkey (default: C<M-s>). When in search mode, normal terminal	127	by a hotkey (default: C<M-s>). While in search mode, normal terminal
76	input/output is suspended.	128	input/output is suspended and a regex is displayed at the bottom of the
		129	screen.
77		130
78	C</> starts an incremental regex search, C<n> searches further, C<p> or	131	Inputting characters appends them to the regex and continues incremental
79	C<N> jump to the previous match, C<G> jumps to the bottom and clears the	132	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
80	history, C<enter> leaves search mode at the current position and C<escape>	133	search upwards/downwards in the scrollback buffer, C<End> jumps to the
81	returns to the original position.	134	bottom. C<Escape> leaves search mode and returns to the point where search
		135	was started, while C<Enter> or C<Return> stay at the current position and
		136	additionally stores the first match in the current line into the primary
		137	selection.
82		138
83	=item digital-clock	139	=item readline (enabled by default)
84		140
85	Displays a digital clock using the built-in overlay.	141	A support package that tries to make editing with readline easier. At the
		142	moment, it reacts to clicking with the left mouse button by trying to
		143	move the text cursor to this position. It does so by generating as many
		144	cursor-left or cursor-right keypresses as required (the this only works
		145	for programs that correctly support wide characters).
		146
		147	To avoid too many false positives, this is only done when:
		148
		149	=over 4
		150
		151	=item - the tty is in ICANON state.
		152
		153	=item - the text cursor is visible.
		154
		155	=item - the primary screen is currently being displayed.
		156
		157	=item - the mouse is on the same (multi-row-) line as the text cursor.
		158
		159	=back
		160
		161	The normal selection mechanism isn't disabled, so quick successive clicks
		162	might interfere with selection creation in harmless ways.
		163
		164	=item selection-autotransform
		165
		166	This selection allows you to do automatic transforms on a selection
		167	whenever a selection is made.
		168
		169	It works by specifying perl snippets (most useful is a single C<s///>
		170	operator) that modify C<$_> as resources:
		171
		172	URxvt.selection-autotransform.0: transform
		173	URxvt.selection-autotransform.1: transform
		174	...
		175
		176	For example, the following will transform selections of the form
		177	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		178	$word>:
		179
		180	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		181
		182	And this example matches the same,but replaces it with vi-commands you can
		183	paste directly into your (vi :) editor:
		184
		185	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		186
		187	Of course, this can be modified to suit your needs and your editor :)
		188
		189	To expand the example above to typical perl error messages ("XXX at
		190	FILENAME line YYY."), you need a slightly more elaborate solution:
		191
		192	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		193	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		194
		195	The first line tells the selection code to treat the unchanging part of
		196	every error message as a selection pattern, and the second line transforms
		197	the message into vi commands to load the file.
		198
		199	=item tabbed
		200
		201	This transforms the terminal into a tabbar with additional terminals, that
		202	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		203	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		204	button per tab.
		205
		206	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		207	B<Shift-Right> will switch to the tab left or right of the current one,
		208	while B<Shift-Down> creates a new tab.
86		209
87	=item mark-urls	210	=item mark-urls
88		211
89	Uses per-line display filtering (C<on_line_update>) to underline urls.	212	Uses per-line display filtering (C<on_line_update>) to underline urls and
		213	make them clickable. When middle-clicked, the program specified in the
		214	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		215	the URL as first argument.
		216
		217	=item xim-onthespot
		218
		219	This (experimental) perl extension implements OnTheSpot editing. It does
		220	not work perfectly, and some input methods don't seem to work well with
		221	OnTheSpot editing in general, but it seems to work at leats for SCIM and
		222	kinput2.
		223
		224	You enable it by specifying this extension and a preedit style of
		225	C<OnTheSpot>, i.e.:
		226
		227	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		228
		229	=item automove-background
		230
		231	This is basically a one-line extension that dynamically changes the background pixmap offset
		232	to the window position, in effect creating the same effect as pseudo transparency with
		233	a custom pixmap. No scaling is supported in this mode. Exmaple:
		234
		235	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
90		236
91	=item block-graphics-to-ascii	237	=item block-graphics-to-ascii
92		238
93	A not very useful example of filtering all text output to the terminal,	239	A not very useful example of filtering all text output to the terminal,
94	by replacing all line-drawing characters (U+2500 .. U+259F) by a	240	by replacing all line-drawing characters (U+2500 .. U+259F) by a
95	similar-looking ascii character.	241	similar-looking ascii character.
		242
		243	=item digital-clock
		244
		245	Displays a digital clock using the built-in overlay.
		246
		247	=item remote-clipboard
		248
		249	Somewhat of a misnomer, this extension adds two menu entries to the
		250	selection popup that allows one ti run external commands to store the
		251	selection somewhere and fetch it again.
		252
		253	We use it to implement a "distributed selection mechanism", which just
		254	means that one command uploads the file to a remote server, and another
		255	reads it.
		256
		257	The commands can be set using the C<URxvt.remote-selection.store> and
		258	C<URxvt.remote-selection.fetch> resources. The first should read the
		259	selection to store from STDIN (always in UTF-8), the second should provide
		260	the selection data on STDOUT (also in UTF-8).
		261
		262	The defaults (which are likely useless to you) use rsh and cat:
		263
		264	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		265	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		266
		267	=item selection-pastebin
		268
		269	This is a little rarely useful extension that Uploads the selection as
		270	textfile to a remote site (or does other things). (The implementation is
		271	not currently secure for use in a multiuser environment as it writes to
		272	F</tmp> directly.).
		273
		274	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		275	i.e.
		276
		277	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		278
		279	Pressing this combination runs a command with C<%> replaced by the name of
		280	the textfile. This command can be set via a resource:
		281
		282	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		283
		284	And the default is likely not useful to anybody but the few people around
		285	here :)
		286
		287	The name of the textfile is the hex encoded md5 sum of the selection, so
		288	the same content should lead to the same filename.
		289
		290	After a successful upload the selection will be replaced by the text given
		291	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		292	for the filename):
		293
		294	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
96		295
97	=item example-refresh-hooks	296	=item example-refresh-hooks
98		297
99	Displays a very simple digital clock in the upper right corner of the	298	Displays a very simple digital clock in the upper right corner of the
100	window. Illustrates overwriting the refresh callbacks to create your own	299	window. Illustrates overwriting the refresh callbacks to create your own
…		…
123	=over 4	322	=over 4
124		323
125	=item $text	324	=item $text
126		325
127	Rxvt-unicodes special way of encoding text, where one "unicode" character	326	Rxvt-unicodes special way of encoding text, where one "unicode" character
128	always represents one screen cell. See L<row_t> for a discussion of this format.	327	always represents one screen cell. See L<ROW_t> for a discussion of this format.
129		328
130	=item $string	329	=item $string
131		330
132	A perl text string, with an emphasis on I<text>. It can store all unicode	331	A perl text string, with an emphasis on I<text>. It can store all unicode
133	characters and is to be distinguished with text encoded in a specific	332	characters and is to be distinguished with text encoded in a specific
…		…
179	called whenever the relevant event happens.	378	called whenever the relevant event happens.
180		379
181	The first argument passed to them is an extension oject as described in	380	The first argument passed to them is an extension oject as described in
182	the in the C<Extension Objects> section.	381	the in the C<Extension Objects> section.
183		382
184	B<All> of these hooks must return a boolean value. If it is true, then the	383	B<All> of these hooks must return a boolean value. If any of the called
185	event counts as being I<consumed>, and the invocation of other hooks is	384	hooks returns true, then the event counts as being I<consumed>, and the
186	skipped, and the relevant action might not be carried out by the C++ code.	385	relevant action might not be carried out by the C++ code.
187		386
188	I<< When in doubt, return a false value (preferably C<()>). >>	387	I<< When in doubt, return a false value (preferably C<()>). >>
189		388
190	=over 4	389	=over 4
191		390
192	=item on_init $term	391	=item on_init $term
193		392
194	Called after a new terminal object has been initialized, but before	393	Called after a new terminal object has been initialized, but before
195	windows are created or the command gets run. Most methods are unsafe to	394	windows are created or the command gets run. Most methods are unsafe to
196	call or deliver senseless data, as terminal size and other characteristics	395	call or deliver senseless data, as terminal size and other characteristics
197	have not yet been determined. You can safely query and change resources,	396	have not yet been determined. You can safely query and change resources
198	though.	397	and options, though. For many purposes the C<on_start> hook is a better
		398	place.
		399
		400	=item on_start $term
		401
		402	Called at the very end of initialisation of a new terminal, just before
		403	trying to map (display) the toplevel and returning to the mainloop.
		404
		405	=item on_destroy $term
		406
		407	Called whenever something tries to destroy terminal, when the terminal is
		408	still fully functional (not for long, though).
199		409
200	=item on_reset $term	410	=item on_reset $term
201		411
202	Called after the screen is "reset" for any reason, such as resizing or	412	Called after the screen is "reset" for any reason, such as resizing or
203	control sequences. Here is where you can react on changes to size-related	413	control sequences. Here is where you can react on changes to size-related
204	variables.	414	variables.
205		415
206	=item on_start $term	416	=item on_child_start $term, $pid
207		417
208	Called at the very end of initialisation of a new terminal, just before	418	Called just after the child process has been C<fork>ed.
209	returning to the mainloop.	419
		420	=item on_child_exit $term, $status
		421
		422	Called just after the child process has exited. C<$status> is the status
		423	from C<waitpid>.
210		424
211	=item on_sel_make $term, $eventtime	425	=item on_sel_make $term, $eventtime
212		426
213	Called whenever a selection has been made by the user, but before the	427	Called whenever a selection has been made by the user, but before the
214	selection text is copied, so changes to the beginning, end or type of the	428	selection text is copied, so changes to the beginning, end or type of the
…		…
228	=item on_sel_extend $term	442	=item on_sel_extend $term
229		443
230	Called whenever the user tries to extend the selection (e.g. with a double	444	Called whenever the user tries to extend the selection (e.g. with a double
231	click) and is either supposed to return false (normal operation), or	445	click) and is either supposed to return false (normal operation), or
232	should extend the selection itelf and return true to suppress the built-in	446	should extend the selection itelf and return true to suppress the built-in
233	processing.	447	processing. This can happen multiple times, as long as the callback
		448	returns true, it will be called on every further click by the user and is
		449	supposed to enlarge the selection more and more, if possible.
234		450
235	See the F<selection> example extension.	451	See the F<selection> example extension.
236		452
237	=item on_view_change $term, $offset	453	=item on_view_change $term, $offset
238		454
…		…
299		515
300	=item on_refresh_end $term	516	=item on_refresh_end $term
301		517
302	Called just after the screen gets redrawn. See C<on_refresh_begin>.	518	Called just after the screen gets redrawn. See C<on_refresh_begin>.
303		519
304	=item on_keyboard_command $term, $string	520	=item on_user_command $term, $string
305		521
306	Called whenever the user presses a key combination that has a	522	Called whenever the a user-configured event is being activated (e.g. via
307	C<perl:string> action bound to it (see description of the B<keysym>	523	a C<perl:string> action bound to a key, see description of the B<keysym>
308	resource in the @@RXVT_NAME@@(1) manpage).	524	resource in the @@RXVT_NAME@@(1) manpage).
		525
		526	The event is simply the action string. This interface is assumed to change
		527	slightly in the future.
		528
		529	=item on_x_event $term, $event
		530
		531	Called on every X event received on the vt window (and possibly other
		532	windows). Should only be used as a last resort. Most event structure
		533	members are not passed.
309		534
310	=item on_focus_in $term	535	=item on_focus_in $term
311		536
312	Called whenever the window gets the keyboard focus, before rxvt-unicode	537	Called whenever the window gets the keyboard focus, before rxvt-unicode
313	does focus in processing.	538	does focus in processing.
…		…
315	=item on_focus_out $term	540	=item on_focus_out $term
316		541
317	Called wheneever the window loses keyboard focus, before rxvt-unicode does	542	Called wheneever the window loses keyboard focus, before rxvt-unicode does
318	focus out processing.	543	focus out processing.
319		544
		545	=item on_configure_notify $term, $event
		546
		547	=item on_property_notify $term, $event
		548
320	=item on_key_press $term, $event, $keysym, $octets	549	=item on_key_press $term, $event, $keysym, $octets
321		550
322	=item on_key_release $term, $event, $keysym	551	=item on_key_release $term, $event, $keysym
323		552
324	=item on_button_press $term, $event	553	=item on_button_press $term, $event
…		…
333		562
334	Called whenever the corresponding X event is received for the terminal If	563	Called whenever the corresponding X event is received for the terminal If
335	the hook returns true, then the even will be ignored by rxvt-unicode.	564	the hook returns true, then the even will be ignored by rxvt-unicode.
336		565
337	The event is a hash with most values as named by Xlib (see the XEvent	566	The event is a hash with most values as named by Xlib (see the XEvent
338	manpage), with the additional members C<row> and C<col>, which are the row	567	manpage), with the additional members C<row> and C<col>, which are the
339	and column under the mouse cursor.	568	(real, not screen-based) row and column under the mouse cursor.
340		569
341	C<on_key_press> additionally receives the string rxvt-unicode would	570	C<on_key_press> additionally receives the string rxvt-unicode would
342	output, if any, in locale-specific encoding.	571	output, if any, in locale-specific encoding.
343		572
344	subwindow.	573	subwindow.
345		574
346	=back	575	=item on_client_message $term, $event
347		576
348	=head2 Variables in the C<urxvt> Package	577	=item on_wm_protocols $term, $event
349		578
350	=over 4	579	=item on_wm_delete_window $term, $event
351		580
352	=item $urxvt::LIBDIR	581	Called when various types of ClientMessage events are received (all with
353		582	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
354	The rxvt-unicode library directory, where, among other things, the perl
355	modules and scripts are stored.
356
357	=item $urxvt::RESCLASS, $urxvt::RESCLASS
358
359	The resource class and name rxvt-unicode uses to look up X resources.
360
361	=item $urxvt::RXVTNAME
362
363	The basename of the installed binaries, usually C<urxvt>.
364
365	=item $urxvt::TERM
366
367	The current terminal. This variable stores the current C<urxvt::term>
368	object, whenever a callback/hook is executing.
369
370	=item
371
372	=back
373
374	=head2 Functions in the C<urxvt> Package
375
376	=over 4
377
378	=item $term = new urxvt [arg...]
379
380	Creates a new terminal, very similar as if you had started it with
381	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
382	if the new instance couldn't be created. Returns C<undef> if the new
383	instance didn't initialise perl, and the terminal object otherwise. The
384	C<init> and C<start> hooks will be called during the call.
385
386	=item urxvt::fatal $errormessage
387
388	Fatally aborts execution with the given error message. Avoid at all
389	costs! The only time this is acceptable is when the terminal process
390	starts up.
391
392	=item urxvt::warn $string
393
394	Calls C<rxvt_warn> with the given string which should not include a
395	newline. The module also overwrites the C<warn> builtin with a function
396	that calls this function.
397
398	Using this function has the advantage that its output ends up in the
399	correct place, e.g. on stderr of the connecting urxvtc client.
400
401	=item $is_safe = urxvt::safe
402
403	Returns true when it is safe to do potentially unsafe things, such as
404	evaluating perl code specified by the user. This is true when urxvt was
405	started setuid or setgid.
406
407	=item $time = urxvt::NOW
408
409	Returns the "current time" (as per the event loop).
410
411	=item urxvt::CurrentTime
412
413	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
414	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
415	Button4Mask, Button5Mask, AnyModifier
416
417	Various constants for use in X calls and event processing.
418
419	=back
420
421	=head2 RENDITION
422
423	Rendition bitsets contain information about colour, font, font styles and
424	similar information for each screen cell.
425
426	The following "macros" deal with changes in rendition sets. You should
427	never just create a bitset, you should always modify an existing one,
428	as they contain important information required for correct operation of
429	rxvt-unicode.
430
431	=over 4
432
433	=item $rend = urxvt::DEFAULT_RSTYLE
434
435	Returns the default rendition, as used when the terminal is starting up or
436	being reset. Useful as a base to start when creating renditions.
437
438	=item $rend = urxvt::OVERLAY_RSTYLE
439
440	Return the rendition mask used for overlays by default.
441
442	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
443
444	Return the bit that enabled bold, italic, blink, reverse-video and
445	underline, respectively. To enable such a style, just logically OR it into
446	the bitset.
447
448	=item $foreground = urxvt::GET_BASEFG $rend
449
450	=item $background = urxvt::GET_BASEBG $rend
451
452	Return the foreground/background colour index, respectively.
453
454	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
455
456	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
457
458	Replace the foreground/background colour in the rendition mask with the
459	specified one.
460
461	=item $value = urxvt::GET_CUSTOM $rend
462
463	Return the "custom" value: Every rendition has 5 bits for use by
464	extensions. They can be set and changed as you like and are initially
465	zero.
466
467	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
468
469	Change the custom value.
470		583
471	=back	584	=back
472		585
473	=cut	586	=cut
474		587
…		…
480	use Scalar::Util ();	593	use Scalar::Util ();
481	use List::Util ();	594	use List::Util ();
482		595
483	our $VERSION = 1;	596	our $VERSION = 1;
484	our $TERM;	597	our $TERM;
		598	our @TERM_INIT;
		599	our @TERM_EXT;
485	our @HOOKNAME;	600	our @HOOKNAME;
486	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	601	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
487	our %OPTION;	602	our %OPTION;
488		603
489	our $LIBDIR;	604	our $LIBDIR;
490	our $RESNAME;	605	our $RESNAME;
491	our $RESCLASS;	606	our $RESCLASS;
492	our $RXVTNAME;	607	our $RXVTNAME;
493		608
		609	our $NOCHAR = chr 0xffff;
		610
		611	=head2 Variables in the C<urxvt> Package
		612
		613	=over 4
		614
		615	=item $urxvt::LIBDIR
		616
		617	The rxvt-unicode library directory, where, among other things, the perl
		618	modules and scripts are stored.
		619
		620	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		621
		622	The resource class and name rxvt-unicode uses to look up X resources.
		623
		624	=item $urxvt::RXVTNAME
		625
		626	The basename of the installed binaries, usually C<urxvt>.
		627
		628	=item $urxvt::TERM
		629
		630	The current terminal. This variable stores the current C<urxvt::term>
		631	object, whenever a callback/hook is executing.
		632
		633	=item @urxvt::TERM_INIT
		634
		635	All coderefs in this array will be called as methods of the next newly
		636	created C<urxvt::term> object (during the C<on_init> phase). The array
		637	gets cleared before the codereferences that were in it are being executed,
		638	so coderefs can push themselves onto it again if they so desire.
		639
		640	This complements to the perl-eval commandline option, but gets executed
		641	first.
		642
		643	=item @urxvt::TERM_EXT
		644
		645	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		646	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		647	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		648
		649	=back
		650
		651	=head2 Functions in the C<urxvt> Package
		652
		653	=over 4
		654
		655	=item urxvt::fatal $errormessage
		656
		657	Fatally aborts execution with the given error message. Avoid at all
		658	costs! The only time this is acceptable is when the terminal process
		659	starts up.
		660
		661	=item urxvt::warn $string
		662
		663	Calls C<rxvt_warn> with the given string which should not include a
		664	newline. The module also overwrites the C<warn> builtin with a function
		665	that calls this function.
		666
		667	Using this function has the advantage that its output ends up in the
		668	correct place, e.g. on stderr of the connecting urxvtc client.
		669
		670	Messages have a size limit of 1023 bytes currently.
		671
		672	=item @terms = urxvt::termlist
		673
		674	Returns all urxvt::term objects that exist in this process, regardless of
		675	wether they are started, being destroyed etc., so be careful. Only term
		676	objects that have perl extensions attached will be returned (because there
		677	is no urxvt::term objet associated with others).
		678
		679	=item $time = urxvt::NOW
		680
		681	Returns the "current time" (as per the event loop).
		682
		683	=item urxvt::CurrentTime
		684
		685	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		686	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		687	Button4Mask, Button5Mask, AnyModifier
		688
		689	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		690	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		691	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		692	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		693	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		694	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		695	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		696
		697	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		698	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		699	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		700	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		701	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		702	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		703	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		704
		705	Various constants for use in X calls and event processing.
		706
		707	=back
		708
		709	=head2 RENDITION
		710
		711	Rendition bitsets contain information about colour, font, font styles and
		712	similar information for each screen cell.
		713
		714	The following "macros" deal with changes in rendition sets. You should
		715	never just create a bitset, you should always modify an existing one,
		716	as they contain important information required for correct operation of
		717	rxvt-unicode.
		718
		719	=over 4
		720
		721	=item $rend = urxvt::DEFAULT_RSTYLE
		722
		723	Returns the default rendition, as used when the terminal is starting up or
		724	being reset. Useful as a base to start when creating renditions.
		725
		726	=item $rend = urxvt::OVERLAY_RSTYLE
		727
		728	Return the rendition mask used for overlays by default.
		729
		730	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		731
		732	Return the bit that enabled bold, italic, blink, reverse-video and
		733	underline, respectively. To enable such a style, just logically OR it into
		734	the bitset.
		735
		736	=item $foreground = urxvt::GET_BASEFG $rend
		737
		738	=item $background = urxvt::GET_BASEBG $rend
		739
		740	Return the foreground/background colour index, respectively.
		741
		742	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		743
		744	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		745
		746	Replace the foreground/background colour in the rendition mask with the
		747	specified one.
		748
		749	=item $value = urxvt::GET_CUSTOM $rend
		750
		751	Return the "custom" value: Every rendition has 5 bits for use by
		752	extensions. They can be set and changed as you like and are initially
		753	zero.
		754
		755	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		756
		757	Change the custom value.
		758
		759	=back
		760
		761	=cut
		762
494	BEGIN {	763	BEGIN {
495	urxvt->bootstrap;
496
497	# overwrite perl's warn	764	# overwrite perl's warn
498	*CORE::GLOBAL::warn = sub {	765	*CORE::GLOBAL::warn = sub {
499	my $msg = join "", @_;	766	my $msg = join "", @_;
500	$msg .= "\n"	767	$msg .= "\n"
501	unless $msg =~ /\n$/;	768	unless $msg =~ /\n$/;
502	urxvt::warn ($msg);	769	urxvt::warn ($msg);
503	};	770	};
504
505	delete $ENV{IFS};
506	delete $ENV{CDPATH};
507	delete $ENV{BASH_ENV};
508	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
509	}	771	}
510		772
511	my @hook_count;	773	no warnings 'utf8';
		774
512	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	775	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
513		776
514	sub verbose {	777	sub verbose {
515	my ($level, $msg) = @_;	778	my ($level, $msg) = @_;
516	warn "$msg\n" if $level <= $verbosity;	779	warn "$msg\n" if $level <= $verbosity;
517	}	780	}
518		781
519	my $extension_pkg = "extension0000";
520	my %extension_pkg;	782	my %extension_pkg;
521		783
522	# load a single script into its own package, once only	784	# load a single script into its own package, once only
523	sub extension_package($) {	785	sub extension_package($) {
524	my ($path) = @_;	786	my ($path) = @_;
525		787
526	$extension_pkg{$path} \|\|= do {	788	$extension_pkg{$path} \|\|= do {
527	my $pkg = "urxvt::" . ($extension_pkg++);	789	$path =~ /([^\/\\]+)$/;
		790	my $pkg = $1;
		791	$pkg =~ s/[^[:word:]]/_/g;
		792	$pkg = "urxvt::ext::$pkg";
528		793
529	verbose 3, "loading extension '$path' into package '$pkg'";	794	verbose 3, "loading extension '$path' into package '$pkg'";
530		795
531	open my $fh, "<:raw", $path	796	open my $fh, "<:raw", $path
532	or die "$path: $!";	797	or die "$path: $!";
533		798
534	my $source = untaint	799	my $source =
535	"package $pkg; use strict; use utf8;\n"	800	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
536	. "use base urxvt::term::extension::;\n"
537	. "#line 1 \"$path\"\n{\n"	801	. "#line 1 \"$path\"\n{\n"
538	. (do { local $/; <$fh> })	802	. (do { local $/; <$fh> })
539	. "\n};\n1";	803	. "\n};\n1";
540		804
541	eval $source	805	eval $source
…		…
555	if ($htype == 0) { # INIT	819	if ($htype == 0) { # INIT
556	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	820	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
557		821
558	my %ext_arg;	822	my %ext_arg;
559		823
		824	{
		825	my @init = @TERM_INIT;
		826	@TERM_INIT = ();
		827	$_->($TERM) for @init;
		828	my @pkg = @TERM_EXT;
		829	@TERM_EXT = ();
		830	$TERM->register_package ($_) for @pkg;
		831	}
		832
560	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	833	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
561	if ($_ eq "default") {	834	if ($_ eq "default") {
562	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	835	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
563	} elsif (/^-(.*)$/) {	836	} elsif (/^-(.*)$/) {
564	delete $ext_arg{$1};	837	delete $ext_arg{$1};
565	} elsif (/^([^<]+)<(.*)>$/) {	838	} elsif (/^([^<]+)<(.*)>$/) {
566	push @{ $ext_arg{$1} }, $2;	839	push @{ $ext_arg{$1} }, $2;
567	} else {	840	} else {
…		…
590	if $verbosity >= 10;	863	if $verbosity >= 10;
591		864
592	keys %$cb;	865	keys %$cb;
593		866
594	while (my ($pkg, $cb) = each %$cb) {	867	while (my ($pkg, $cb) = each %$cb) {
595	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	868	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
596	and last;	869	$retval \|\|= $retval_;
597		870
598	if ($@) {	871	if ($@) {
599	$TERM->ungrab; # better to lose the grab than the session	872	$TERM->ungrab; # better to lose the grab than the session
600	warn $@;	873	warn $@;
601	}	874	}
602	}	875	}
		876
		877	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		878	if $verbosity >= 11;
603	}	879	}
604		880
605	if ($htype == 1) { # DESTROY	881	if ($htype == 1) { # DESTROY
606	if (my $hook = delete $TERM->{_hook}) {
607	for my $htype (0..$#$hook) {
608	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
609	or set_should_invoke $htype, 0;
610	}
611	}
612
613	# clear package objects	882	# clear package objects
614	%$_ = () for values %{ $TERM->{_pkg} };	883	%$_ = () for values %{ $TERM->{_pkg} };
615		884
616	# clear package	885	# clear package
617	%$TERM = ();	886	%$TERM = ();
…		…
631	while (my ($name, $cb) = each %hook) {	900	while (my ($name, $cb) = each %hook) {
632	my $htype = $HOOKTYPE{uc $name};	901	my $htype = $HOOKTYPE{uc $name};
633	defined $htype	902	defined $htype
634	or Carp::croak "unsupported hook type '$name'";	903	or Carp::croak "unsupported hook type '$name'";
635		904
		905	$self->set_should_invoke ($htype, +1)
636	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	906	unless exists $self->{term}{_hook}[$htype]{$pkg};
637	$hook_count[$htype]++
638	or urxvt::set_should_invoke $htype, 1;
639	}
640		907
641	$self->{term}{_hook}[$htype]{$pkg} = $cb;	908	$self->{term}{_hook}[$htype]{$pkg} = $cb;
642	}	909	}
643	}	910	}
644		911
…		…
649	for my $name (@hook) {	916	for my $name (@hook) {
650	my $htype = $HOOKTYPE{uc $name};	917	my $htype = $HOOKTYPE{uc $name};
651	defined $htype	918	defined $htype
652	or Carp::croak "unsupported hook type '$name'";	919	or Carp::croak "unsupported hook type '$name'";
653		920
		921	$self->set_should_invoke ($htype, -1)
654	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	922	if delete $self->{term}{_hook}[$htype]{$pkg};
655	--$hook_count[$htype]
656	or urxvt::set_should_invoke $htype, 0;
657	}
658	}	923	}
659	}	924	}
660		925
661	our $AUTOLOAD;	926	our $AUTOLOAD;
662		927
…		…
768	# find on_xxx subs in the package and register them	1033	# find on_xxx subs in the package and register them
769	# as hooks	1034	# as hooks
770	sub register_package {	1035	sub register_package {
771	my ($self, $pkg, $argv) = @_;	1036	my ($self, $pkg, $argv) = @_;
772		1037
		1038	no strict 'refs';
		1039
		1040	urxvt::verbose 6, "register package $pkg to $self";
		1041
		1042	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1043
773	my $proxy = bless {	1044	my $proxy = bless {
774	_pkg => $pkg,	1045	_pkg => $pkg,
775	argv => $argv,	1046	argv => $argv,
776	}, $pkg;	1047	}, $pkg;
777	Scalar::Util::weaken ($proxy->{term} = $self);	1048	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
783	$proxy->enable ($name => $ref);	1054	$proxy->enable ($name => $ref);
784	}	1055	}
785	}	1056	}
786	}	1057	}
787		1058
		1059	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1060
		1061	Creates a new terminal, very similar as if you had started it with system
		1062	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1063	hash which defines the environment of the new terminal.
		1064
		1065	Croaks (and probably outputs an error message) if the new instance
		1066	couldn't be created. Returns C<undef> if the new instance didn't
		1067	initialise perl, and the terminal object otherwise. The C<init> and
		1068	C<start> hooks will be called before this call returns, and are free to
		1069	refer to global data (which is race free).
		1070
		1071	=cut
		1072
		1073	sub new {
		1074	my ($class, $env, @args) = @_;
		1075
		1076	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1077	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1078
		1079	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1080	}
		1081
788	=item $term->destroy	1082	=item $term->destroy
789		1083
790	Destroy the terminal object (close the window, free resources	1084	Destroy the terminal object (close the window, free resources
791	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1085	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
792	watchers (timers, io watchers) are still active.	1086	watchers (timers, io watchers) are still active.
793		1087
		1088	=item $term->exec_async ($cmd[, @args])
		1089
		1090	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1091	("starts") programs in the background. This function takes care of setting
		1092	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1093	be preferred over explicit calls to C<exec> or C<system>.
		1094
		1095	Returns the pid of the subprocess or C<undef> on error.
		1096
		1097	=cut
		1098
		1099	sub exec_async {
		1100	my $self = shift;
		1101
		1102	my $pid = fork;
		1103
		1104	return $pid
		1105	if !defined $pid or $pid;
		1106
		1107	%ENV = %{ $self->env };
		1108
		1109	exec @_;
		1110	urxvt::_exit 255;
		1111	}
		1112
794	=item $isset = $term->option ($optval[, $set])	1113	=item $isset = $term->option ($optval[, $set])
795		1114
796	Returns true if the option specified by C<$optval> is enabled, and	1115	Returns true if the option specified by C<$optval> is enabled, and
797	optionally change it. All option values are stored by name in the hash	1116	optionally change it. All option values are stored by name in the hash
798	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1117	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
800	Here is a a likely non-exhaustive list of option names, please see the	1119	Here is a a likely non-exhaustive list of option names, please see the
801	source file F</src/optinc.h> to see the actual list:	1120	source file F</src/optinc.h> to see the actual list:
802		1121
803	borderLess console cursorBlink cursorUnderline hold iconic insecure	1122	borderLess console cursorBlink cursorUnderline hold iconic insecure
804	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1123	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
805	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1124	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
806	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1125	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
807	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1126	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
808	tripleclickwords utmpInhibit visualBell	1127	transparent tripleclickwords utmpInhibit visualBell
809		1128
810	=item $value = $term->resource ($name[, $newval])	1129	=item $value = $term->resource ($name[, $newval])
811		1130
812	Returns the current resource value associated with a given name and	1131	Returns the current resource value associated with a given name and
813	optionally sets a new value. Setting values is most useful in the C<init>	1132	optionally sets a new value. Setting values is most useful in the C<init>
…		…
830		1149
831	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1150	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
832	borderLess color cursorBlink cursorUnderline cutchars delete_key	1151	borderLess color cursorBlink cursorUnderline cutchars delete_key
833	display_name embed ext_bwidth fade font geometry hold iconName	1152	display_name embed ext_bwidth fade font geometry hold iconName
834	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1153	imFont imLocale inputMethod insecure int_bwidth intensityStyles
835	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1154	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
836	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1155	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
837	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1156	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
838	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1157	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
839	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1158	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
840	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1159	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
841	shade term_name title transparent transparent_all tripleclickwords	1160	secondaryScreen secondaryScroll selectstyle shade term_name title
842	utmpInhibit visualBell	1161	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1162	visualBell
843		1163
844	=cut	1164	=cut
845		1165
846	sub resource($$;$) {	1166	sub resource($$;$) {
847	my ($self, $name) = (shift, shift);	1167	my ($self, $name) = (shift, shift);
848	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1168	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
849	&urxvt::term::_resource	1169	&urxvt::term::_resource
850	}	1170	}
851		1171
		1172	=item $value = $term->x_resource ($pattern)
		1173
		1174	Returns the X-Resource for the given pattern, excluding the program or
		1175	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1176	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1177	resource with that pattern exists.
		1178
		1179	This method should only be called during the C<on_start> hook, as there is
		1180	only one resource database per display, and later invocations might return
		1181	the wrong resources.
		1182
852	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1183	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
853		1184
854	Adds a keymap translation exactly as specified via a resource. See the	1185	Adds a keymap translation exactly as specified via a resource. See the
855	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1186	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
856		1187
…		…
871	=item ($row, $col) = $term->selection_end ([$row, $col])	1202	=item ($row, $col) = $term->selection_end ([$row, $col])
872		1203
873	Return the current values of the selection mark, begin or end positions,	1204	Return the current values of the selection mark, begin or end positions,
874	and optionally set them to new values.	1205	and optionally set them to new values.
875		1206
		1207	=item $term->selection_make ($eventtime[, $rectangular])
		1208
		1209	Tries to make a selection as set by C<selection_beg> and
		1210	C<selection_end>. If C<$rectangular> is true (default: false), a
		1211	rectangular selection will be made. This is the prefered function to make
		1212	a selection.
		1213
876	=item $success = $term->selection_grab ($eventtime)	1214	=item $success = $term->selection_grab ($eventtime)
877		1215
878	Try to request the primary selection from the server (for example, as set	1216	Try to request the primary selection text from the server (for example, as
879	by the next method).	1217	set by the next method). No visual feedback will be given. This function
		1218	is mostly useful from within C<on_sel_grab> hooks.
880		1219
881	=item $oldtext = $term->selection ([$newtext])	1220	=item $oldtext = $term->selection ([$newtext])
882		1221
883	Return the current selection text and optionally replace it by C<$newtext>.	1222	Return the current selection text and optionally replace it by C<$newtext>.
884		1223
…		…
977	Convert the given locale-encoded octets into a perl string.	1316	Convert the given locale-encoded octets into a perl string.
978		1317
979	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1318	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
980		1319
981	XORs the rendition values in the given span with the provided value	1320	XORs the rendition values in the given span with the provided value
982	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1321	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
983	to the selection.	1322	refresh hooks to provide effects similar to the selection.
984		1323
985	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1324	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
986		1325
987	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1326	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
988	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1327	whitespace will additionally be xored with the C<$rstyle2>, which defaults
989	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines	1328	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
990	it instead.	1329	it instead. Both styles I<MUST NOT> contain font styles.
991		1330
992	=item $term->scr_bell	1331	=item $term->scr_bell
993		1332
994	Ring the bell!	1333	Ring the bell!
995		1334
…		…
1002		1341
1003	Normally its not a good idea to use this function, as programs might be	1342	Normally its not a good idea to use this function, as programs might be
1004	confused by changes in cursor position or scrolling. Its useful inside a	1343	confused by changes in cursor position or scrolling. Its useful inside a
1005	C<on_add_lines> hook, though.	1344	C<on_add_lines> hook, though.
1006		1345
		1346	=item $term->scr_change_screen ($screen)
		1347
		1348	Switch to given screen - 0 primary, 1 secondary.
		1349
1007	=item $term->cmd_parse ($octets)	1350	=item $term->cmd_parse ($octets)
1008		1351
1009	Similar to C<scr_add_lines>, but the argument must be in the	1352	Similar to C<scr_add_lines>, but the argument must be in the
1010	locale-specific encoding of the terminal and can contain command sequences	1353	locale-specific encoding of the terminal and can contain command sequences
1011	(escape codes) that will be interpreted.	1354	(escape codes) that will be interpreted.
…		…
1021	Replaces the event mask of the pty watcher by the given event mask. Can	1364	Replaces the event mask of the pty watcher by the given event mask. Can
1022	be used to suppress input and output handling to the pty/tty. See the	1365	be used to suppress input and output handling to the pty/tty. See the
1023	description of C<< urxvt::timer->events >>. Make sure to always restore	1366	description of C<< urxvt::timer->events >>. Make sure to always restore
1024	the previous value.	1367	the previous value.
1025		1368
		1369	=item $fd = $term->pty_fd
		1370
		1371	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1372	is used.
		1373
1026	=item $windowid = $term->parent	1374	=item $windowid = $term->parent
1027		1375
1028	Return the window id of the toplevel window.	1376	Return the window id of the toplevel window.
1029		1377
1030	=item $windowid = $term->vt	1378	=item $windowid = $term->vt
1031		1379
1032	Return the window id of the terminal window.	1380	Return the window id of the terminal window.
1033		1381
		1382	=item $term->vt_emask_add ($x_event_mask)
		1383
		1384	Adds the specified events to the vt event mask. Useful e.g. when you want
		1385	to receive pointer events all the times:
		1386
		1387	$term->vt_emask_add (urxvt::PointerMotionMask);
		1388
1034	=item $window_width = $term->width	1389	=item $window_width = $term->width
1035		1390
1036	=item $window_height = $term->height	1391	=item $window_height = $term->height
1037		1392
1038	=item $font_width = $term->fwidth	1393	=item $font_width = $term->fwidth
…		…
1051		1406
1052	=item $max_scrollback = $term->saveLines	1407	=item $max_scrollback = $term->saveLines
1053		1408
1054	=item $nrow_plus_saveLines = $term->total_rows	1409	=item $nrow_plus_saveLines = $term->total_rows
1055		1410
1056	=item $lines_in_scrollback = $term->nsaved	1411	=item $topmost_scrollback_row = $term->top_row
1057		1412
1058	Return various integers describing terminal characteristics.	1413	Return various integers describing terminal characteristics.
1059		1414
		1415	=item $x_display = $term->display_id
		1416
		1417	Return the DISPLAY used by rxvt-unicode.
		1418
1060	=item $lc_ctype = $term->locale	1419	=item $lc_ctype = $term->locale
1061		1420
1062	Returns the LC_CTYPE category string used by this rxvt-unicode.	1421	Returns the LC_CTYPE category string used by this rxvt-unicode.
1063		1422
1064	=item $x_display = $term->display_id	1423	=item $env = $term->env
1065		1424
1066	Return the DISPLAY used by rxvt-unicode.	1425	Returns a copy of the environment in effect for the terminal as a hashref
		1426	similar to C<\%ENV>.
		1427
		1428	=cut
		1429
		1430	sub env {
		1431	if (my $env = $_[0]->_env) {
		1432	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1433	} else {
		1434	+{ %ENV }
		1435	}
		1436	}
1067		1437
1068	=item $modifiermask = $term->ModLevel3Mask	1438	=item $modifiermask = $term->ModLevel3Mask
1069		1439
1070	=item $modifiermask = $term->ModMetaMask	1440	=item $modifiermask = $term->ModMetaMask
1071		1441
1072	=item $modifiermask = $term->ModNumLockMask	1442	=item $modifiermask = $term->ModNumLockMask
1073		1443
1074	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1444	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1075	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1445	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1076		1446
		1447	=item $screen = $term->current_screen
		1448
		1449	Returns the currently displayed screen (0 primary, 1 secondary).
		1450
		1451	=item $cursor_is_hidden = $term->hidden_cursor
		1452
		1453	Returns wether the cursor is currently hidden or not.
		1454
1077	=item $view_start = $term->view_start ([$newvalue])	1455	=item $view_start = $term->view_start ([$newvalue])
1078		1456
1079	Returns the negative row number of the topmost line. Minimum value is	1457	Returns the row number of the topmost displayed line. Maximum value is
1080	C<0>, which displays the normal terminal contents. Larger values scroll	1458	C<0>, which displays the normal terminal contents. Lower values scroll
1081	this many lines into the scrollback buffer.	1459	this many lines into the scrollback buffer.
1082		1460
1083	=item $term->want_refresh	1461	=item $term->want_refresh
1084		1462
1085	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1463	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1100	line, starting at column C<$start_col> (default C<0>), which is useful	1478	line, starting at column C<$start_col> (default C<0>), which is useful
1101	to replace only parts of a line. The font index in the rendition will	1479	to replace only parts of a line. The font index in the rendition will
1102	automatically be updated.	1480	automatically be updated.
1103		1481
1104	C<$text> is in a special encoding: tabs and wide characters that use more	1482	C<$text> is in a special encoding: tabs and wide characters that use more
1105	than one cell when displayed are padded with urxvt::NOCHAR characters	1483	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1106	(C<chr 65535>). Characters with combining characters and other characters	1484	characters. Characters with combining characters and other characters that
1107	that do not fit into the normal tetx encoding will be replaced with	1485	do not fit into the normal tetx encoding will be replaced with characters
1108	characters in the private use area.	1486	in the private use area.
1109		1487
1110	You have to obey this encoding when changing text. The advantage is	1488	You have to obey this encoding when changing text. The advantage is
1111	that C<substr> and similar functions work on screen cells and not on	1489	that C<substr> and similar functions work on screen cells and not on
1112	characters.	1490	characters.
1113		1491
…		…
1164	Return the row number of the first/last row of the line, respectively.	1542	Return the row number of the first/last row of the line, respectively.
1165		1543
1166	=item $offset = $line->offset_of ($row, $col)	1544	=item $offset = $line->offset_of ($row, $col)
1167		1545
1168	Returns the character offset of the given row\|col pair within the logical	1546	Returns the character offset of the given row\|col pair within the logical
1169	line.	1547	line. Works for rows outside the line, too, and returns corresponding
		1548	offsets outside the string.
1170		1549
1171	=item ($row, $col) = $line->coord_of ($offset)	1550	=item ($row, $col) = $line->coord_of ($offset)
1172		1551
1173	Translates a string offset into terminal coordinates again.	1552	Translates a string offset into terminal coordinates again.
1174		1553
…		…
1259	=item $string = $term->special_decode $text	1638	=item $string = $term->special_decode $text
1260		1639
1261	Converts rxvt-unicodes text reprsentation into a perl string. See	1640	Converts rxvt-unicodes text reprsentation into a perl string. See
1262	C<< $term->ROW_t >> for details.	1641	C<< $term->ROW_t >> for details.
1263		1642
1264	=item $success = $term->grab_button ($button, $modifiermask)	1643	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1265		1644
		1645	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1646
1266	Registers a synchronous button grab. See the XGrabButton manpage.	1647	Register/unregister a synchronous button grab. See the XGrabButton
		1648	manpage.
1267		1649
1268	=item $success = $term->grab ($eventtime[, $sync])	1650	=item $success = $term->grab ($eventtime[, $sync])
1269		1651
1270	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1652	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1271	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1653	synchronous (C<$sync> is true). Also remembers the grab timestampe.
…		…
1286	=item $term->ungrab	1668	=item $term->ungrab
1287		1669
1288	Calls XUngrab for the most recent grab. Is called automatically on	1670	Calls XUngrab for the most recent grab. Is called automatically on
1289	evaluation errors, as it is better to lose the grab in the error case as	1671	evaluation errors, as it is better to lose the grab in the error case as
1290	the session.	1672	the session.
		1673
		1674	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1675
		1676	=item $atom_name = $term->XGetAtomName ($atom)
		1677
		1678	=item @atoms = $term->XListProperties ($window)
		1679
		1680	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1681
		1682	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1683
		1684	=item $term->XDeleteProperty ($window, $property)
		1685
		1686	=item $window = $term->DefaultRootWindow
		1687
		1688	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1689
		1690	=item $term->XMapWindow ($window)
		1691
		1692	=item $term->XUnmapWindow ($window)
		1693
		1694	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1695
		1696	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1697
		1698	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1699
		1700	Various X or X-related functions. The C<$term> object only serves as
		1701	the source of the display, otherwise those functions map more-or-less
		1702	directory onto the X functions of the same name.
1291		1703
1292	=back	1704	=back
1293		1705
1294	=cut	1706	=cut
1295		1707
…		…
1392	sub show {	1804	sub show {
1393	my ($self) = @_;	1805	my ($self) = @_;
1394		1806
1395	local $urxvt::popup::self = $self;	1807	local $urxvt::popup::self = $self;
1396		1808
		1809	my $env = $self->{term}->env;
		1810	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1811	delete $env->{LC_ALL};
1397	local $ENV{LC_ALL} = $self->{term}->locale;	1812	$env->{LC_CTYPE} = $self->{term}->locale;
1398		1813
1399	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1814	urxvt::term->new ($env, "popup",
		1815	"--perl-lib" => "", "--perl-ext-common" => "",
		1816	"-pty-fd" => -1, "-sl" => 0,
		1817	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1400	"--transient-for" => $self->{term}->parent,	1818	"--transient-for" => $self->{term}->parent,
1401	"-display" => $self->{term}->display_id,	1819	"-display" => $self->{term}->display_id,
1402	"-pe" => "urxvt-popup")	1820	"-pe" => "urxvt-popup")
1403	or die "unable to create popup window\n";	1821	or die "unable to create popup window\n";
1404	}	1822	}
1405		1823
1406	sub DESTROY {	1824	sub DESTROY {
1407	my ($self) = @_;	1825	my ($self) = @_;
1408		1826
1409	delete $self->{term}{_destroy}{$self};	1827	delete $self->{term}{_destroy}{$self};
1410	$self->{term}->ungrab;	1828	$self->{term}->ungrab;
1411	}	1829	}
		1830
		1831	=back
		1832
		1833	=cut
		1834
		1835	package urxvt::watcher;
		1836
		1837	@urxvt::timer::ISA = __PACKAGE__;
		1838	@urxvt::iow::ISA = __PACKAGE__;
		1839	@urxvt::pw::ISA = __PACKAGE__;
		1840	@urxvt::iw::ISA = __PACKAGE__;
1412		1841
1413	=head2 The C<urxvt::timer> Class	1842	=head2 The C<urxvt::timer> Class
1414		1843
1415	This class implements timer watchers/events. Time is represented as a	1844	This class implements timer watchers/events. Time is represented as a
1416	fractional number of seconds since the epoch. Example:	1845	fractional number of seconds since the epoch. Example:
…		…
1454	Start the timer.	1883	Start the timer.
1455		1884
1456	=item $timer = $timer->start ($tstamp)	1885	=item $timer = $timer->start ($tstamp)
1457		1886
1458	Set the event trigger time to C<$tstamp> and start the timer.	1887	Set the event trigger time to C<$tstamp> and start the timer.
		1888
		1889	=item $timer = $timer->after ($delay)
		1890
		1891	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1459		1892
1460	=item $timer = $timer->stop	1893	=item $timer = $timer->stop
1461		1894
1462	Stop the timer.	1895	Stop the timer.
1463		1896
…		…
1510		1943
1511	Stop watching for events on the given filehandle.	1944	Stop watching for events on the given filehandle.
1512		1945
1513	=back	1946	=back
1514		1947
		1948	=head2 The C<urxvt::iw> Class
		1949
		1950	This class implements idle watchers, that get called automatically when
		1951	the process is idle. They should return as fast as possible, after doing
		1952	some useful work.
		1953
		1954	=over 4
		1955
		1956	=item $iw = new urxvt::iw
		1957
		1958	Create a new idle watcher object in stopped state.
		1959
		1960	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1961
		1962	Set the callback to be called when the watcher triggers.
		1963
		1964	=item $timer = $timer->start
		1965
		1966	Start the watcher.
		1967
		1968	=item $timer = $timer->stop
		1969
		1970	Stop the watcher.
		1971
		1972	=back
		1973
		1974	=head2 The C<urxvt::pw> Class
		1975
		1976	This class implements process watchers. They create an event whenever a
		1977	process exits, after which they stop automatically.
		1978
		1979	my $pid = fork;
		1980	...
		1981	$term->{pw} = urxvt::pw
		1982	->new
		1983	->start ($pid)
		1984	->cb (sub {
		1985	my ($pw, $exit_status) = @_;
		1986	...
		1987	});
		1988
		1989	=over 4
		1990
		1991	=item $pw = new urxvt::pw
		1992
		1993	Create a new process watcher in stopped state.
		1994
		1995	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1996
		1997	Set the callback to be called when the timer triggers.
		1998
		1999	=item $pw = $timer->start ($pid)
		2000
		2001	Tells the wqtcher to start watching for process C<$pid>.
		2002
		2003	=item $pw = $pw->stop
		2004
		2005	Stop the watcher.
		2006
		2007	=back
		2008
1515	=head1 ENVIRONMENT	2009	=head1 ENVIRONMENT
1516		2010
1517	=head2 URXVT_PERL_VERBOSITY	2011	=head2 URXVT_PERL_VERBOSITY
1518		2012
1519	This variable controls the verbosity level of the perl extension. Higher	2013	This variable controls the verbosity level of the perl extension. Higher
…		…
1523		2017
1524	=item == 0 - fatal messages	2018	=item == 0 - fatal messages
1525		2019
1526	=item >= 3 - script loading and management	2020	=item >= 3 - script loading and management
1527		2021
1528	=item >=10 - all events received	2022	=item >=10 - all called hooks
		2023
		2024	=item >=11 - hook reutrn values
1529		2025
1530	=back	2026	=back
1531		2027
1532	=head1 AUTHOR	2028	=head1 AUTHOR
1533		2029

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.76 by root, Tue Jan 10 19:46:28 2006 UTC vs. Revision 1.131 by root, Sun Jan 29 20:51:28 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.76 by root, Tue Jan 10 19:46:28 2006 UTC vs.
Revision 1.131 by root, Sun Jan 29 20:51:28 2006 UTC