[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.128 by root, Wed Jan 25 00:57:57 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.
96		242
		243	=item digital-clock
		244
		245	Displays a digital clock using the built-in overlay.
		246
97	=item example-refresh-hooks	247	=item example-refresh-hooks
98		248
99	Displays a very simple digital clock in the upper right corner of the	249	Displays a very simple digital clock in the upper right corner of the
100	window. Illustrates overwriting the refresh callbacks to create your own	250	window. Illustrates overwriting the refresh callbacks to create your own
101	overlays or changes.	251	overlays or changes.
		252
		253	=item selection-pastebin
		254
		255	This is a little rarely useful extension that Uploads the selection as
		256	textfile to a remote site (or does other things). (The implementation is
		257	not currently secure for use in a multiuser environment as it writes to
		258	F</tmp> directly.).
		259
		260	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		261	i.e.
		262
		263	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		264
		265	Pressing this combination runs a command with C<%> replaced by the name of
		266	the textfile. This command can be set via a resource:
		267
		268	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		269
		270	And the default is likely not useful to anybody but the few people around
		271	here :)
		272
		273	The name of the textfile is the hex encoded md5 sum of the selection, so
		274	the same content should lead to the same filename.
		275
		276	After a successful upload the selection will be replaced by the text given
		277	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		278	for the filename):
		279
		280	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
102		281
103	=back	282	=back
104		283
105	=head1 API DOCUMENTATION	284	=head1 API DOCUMENTATION
106		285
…		…
123	=over 4	302	=over 4
124		303
125	=item $text	304	=item $text
126		305
127	Rxvt-unicodes special way of encoding text, where one "unicode" character	306	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.	307	always represents one screen cell. See L<ROW_t> for a discussion of this format.
129		308
130	=item $string	309	=item $string
131		310
132	A perl text string, with an emphasis on I<text>. It can store all unicode	311	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	312	characters and is to be distinguished with text encoded in a specific
…		…
179	called whenever the relevant event happens.	358	called whenever the relevant event happens.
180		359
181	The first argument passed to them is an extension oject as described in	360	The first argument passed to them is an extension oject as described in
182	the in the C<Extension Objects> section.	361	the in the C<Extension Objects> section.
183		362
184	B<All> of these hooks must return a boolean value. If it is true, then the	363	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	364	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.	365	relevant action might not be carried out by the C++ code.
187		366
188	I<< When in doubt, return a false value (preferably C<()>). >>	367	I<< When in doubt, return a false value (preferably C<()>). >>
189		368
190	=over 4	369	=over 4
191		370
192	=item on_init $term	371	=item on_init $term
193		372
194	Called after a new terminal object has been initialized, but before	373	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	374	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	375	call or deliver senseless data, as terminal size and other characteristics
197	have not yet been determined. You can safely query and change resources,	376	have not yet been determined. You can safely query and change resources
198	though.	377	and options, though. For many purposes the C<on_start> hook is a better
		378	place.
		379
		380	=item on_start $term
		381
		382	Called at the very end of initialisation of a new terminal, just before
		383	trying to map (display) the toplevel and returning to the mainloop.
		384
		385	=item on_destroy $term
		386
		387	Called whenever something tries to destroy terminal, when the terminal is
		388	still fully functional (not for long, though).
199		389
200	=item on_reset $term	390	=item on_reset $term
201		391
202	Called after the screen is "reset" for any reason, such as resizing or	392	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	393	control sequences. Here is where you can react on changes to size-related
204	variables.	394	variables.
205		395
206	=item on_start $term	396	=item on_child_start $term, $pid
207		397
208	Called at the very end of initialisation of a new terminal, just before	398	Called just after the child process has been C<fork>ed.
209	returning to the mainloop.	399
		400	=item on_child_exit $term, $status
		401
		402	Called just after the child process has exited. C<$status> is the status
		403	from C<waitpid>.
210		404
211	=item on_sel_make $term, $eventtime	405	=item on_sel_make $term, $eventtime
212		406
213	Called whenever a selection has been made by the user, but before the	407	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	408	selection text is copied, so changes to the beginning, end or type of the
…		…
228	=item on_sel_extend $term	422	=item on_sel_extend $term
229		423
230	Called whenever the user tries to extend the selection (e.g. with a double	424	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	425	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	426	should extend the selection itelf and return true to suppress the built-in
233	processing.	427	processing. This can happen multiple times, as long as the callback
		428	returns true, it will be called on every further click by the user and is
		429	supposed to enlarge the selection more and more, if possible.
234		430
235	See the F<selection> example extension.	431	See the F<selection> example extension.
236		432
237	=item on_view_change $term, $offset	433	=item on_view_change $term, $offset
238		434
…		…
305		501
306	Called whenever the user presses a key combination that has a	502	Called whenever the user presses a key combination that has a
307	C<perl:string> action bound to it (see description of the B<keysym>	503	C<perl:string> action bound to it (see description of the B<keysym>
308	resource in the @@RXVT_NAME@@(1) manpage).	504	resource in the @@RXVT_NAME@@(1) manpage).
309		505
		506	=item on_x_event $term, $event
		507
		508	Called on every X event received on the vt window (and possibly other
		509	windows). Should only be used as a last resort. Most event structure
		510	members are not passed.
		511
310	=item on_focus_in $term	512	=item on_focus_in $term
311		513
312	Called whenever the window gets the keyboard focus, before rxvt-unicode	514	Called whenever the window gets the keyboard focus, before rxvt-unicode
313	does focus in processing.	515	does focus in processing.
314		516
315	=item on_focus_out $term	517	=item on_focus_out $term
316		518
317	Called wheneever the window loses keyboard focus, before rxvt-unicode does	519	Called wheneever the window loses keyboard focus, before rxvt-unicode does
318	focus out processing.	520	focus out processing.
319		521
		522	=item on_configure_notify $term, $event
		523
		524	=item on_property_notify $term, $event
		525
320	=item on_key_press $term, $event, $keysym, $octets	526	=item on_key_press $term, $event, $keysym, $octets
321		527
322	=item on_key_release $term, $event, $keysym	528	=item on_key_release $term, $event, $keysym
323		529
324	=item on_button_press $term, $event	530	=item on_button_press $term, $event
…		…
333		539
334	Called whenever the corresponding X event is received for the terminal If	540	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.	541	the hook returns true, then the even will be ignored by rxvt-unicode.
336		542
337	The event is a hash with most values as named by Xlib (see the XEvent	543	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	544	manpage), with the additional members C<row> and C<col>, which are the
339	and column under the mouse cursor.	545	(real, not screen-based) row and column under the mouse cursor.
340		546
341	C<on_key_press> additionally receives the string rxvt-unicode would	547	C<on_key_press> additionally receives the string rxvt-unicode would
342	output, if any, in locale-specific encoding.	548	output, if any, in locale-specific encoding.
343		549
344	subwindow.	550	subwindow.
345		551
346	=back	552	=item on_client_message $term, $event
347		553
348	=head2 Variables in the C<urxvt> Package	554	=item on_wm_protocols $term, $event
349		555
350	=over 4	556	=item on_wm_delete_window $term, $event
351		557
352	=item $urxvt::LIBDIR	558	Called when various types of ClientMessage events are received (all with
353		559	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		560
471	=back	561	=back
472		562
473	=cut	563	=cut
474		564
…		…
480	use Scalar::Util ();	570	use Scalar::Util ();
481	use List::Util ();	571	use List::Util ();
482		572
483	our $VERSION = 1;	573	our $VERSION = 1;
484	our $TERM;	574	our $TERM;
		575	our @TERM_INIT;
		576	our @TERM_EXT;
485	our @HOOKNAME;	577	our @HOOKNAME;
486	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	578	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
487	our %OPTION;	579	our %OPTION;
488		580
489	our $LIBDIR;	581	our $LIBDIR;
490	our $RESNAME;	582	our $RESNAME;
491	our $RESCLASS;	583	our $RESCLASS;
492	our $RXVTNAME;	584	our $RXVTNAME;
493		585
		586	our $NOCHAR = chr 0xffff;
		587
		588	=head2 Variables in the C<urxvt> Package
		589
		590	=over 4
		591
		592	=item $urxvt::LIBDIR
		593
		594	The rxvt-unicode library directory, where, among other things, the perl
		595	modules and scripts are stored.
		596
		597	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		598
		599	The resource class and name rxvt-unicode uses to look up X resources.
		600
		601	=item $urxvt::RXVTNAME
		602
		603	The basename of the installed binaries, usually C<urxvt>.
		604
		605	=item $urxvt::TERM
		606
		607	The current terminal. This variable stores the current C<urxvt::term>
		608	object, whenever a callback/hook is executing.
		609
		610	=item @urxvt::TERM_INIT
		611
		612	All coderefs in this array will be called as methods of the next newly
		613	created C<urxvt::term> object (during the C<on_init> phase). The array
		614	gets cleared before the codereferences that were in it are being executed,
		615	so coderefs can push themselves onto it again if they so desire.
		616
		617	This complements to the perl-eval commandline option, but gets executed
		618	first.
		619
		620	=item @urxvt::TERM_EXT
		621
		622	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		623	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		624	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		625
		626	=back
		627
		628	=head2 Functions in the C<urxvt> Package
		629
		630	=over 4
		631
		632	=item urxvt::fatal $errormessage
		633
		634	Fatally aborts execution with the given error message. Avoid at all
		635	costs! The only time this is acceptable is when the terminal process
		636	starts up.
		637
		638	=item urxvt::warn $string
		639
		640	Calls C<rxvt_warn> with the given string which should not include a
		641	newline. The module also overwrites the C<warn> builtin with a function
		642	that calls this function.
		643
		644	Using this function has the advantage that its output ends up in the
		645	correct place, e.g. on stderr of the connecting urxvtc client.
		646
		647	Messages have a size limit of 1023 bytes currently.
		648
		649	=item $time = urxvt::NOW
		650
		651	Returns the "current time" (as per the event loop).
		652
		653	=item urxvt::CurrentTime
		654
		655	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		656	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		657	Button4Mask, Button5Mask, AnyModifier
		658
		659	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		660	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		661	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		662	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		663	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		664	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		665	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		666
		667	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		668	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		669	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		670	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		671	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		672	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		673	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		674
		675	Various constants for use in X calls and event processing.
		676
		677	=back
		678
		679	=head2 RENDITION
		680
		681	Rendition bitsets contain information about colour, font, font styles and
		682	similar information for each screen cell.
		683
		684	The following "macros" deal with changes in rendition sets. You should
		685	never just create a bitset, you should always modify an existing one,
		686	as they contain important information required for correct operation of
		687	rxvt-unicode.
		688
		689	=over 4
		690
		691	=item $rend = urxvt::DEFAULT_RSTYLE
		692
		693	Returns the default rendition, as used when the terminal is starting up or
		694	being reset. Useful as a base to start when creating renditions.
		695
		696	=item $rend = urxvt::OVERLAY_RSTYLE
		697
		698	Return the rendition mask used for overlays by default.
		699
		700	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		701
		702	Return the bit that enabled bold, italic, blink, reverse-video and
		703	underline, respectively. To enable such a style, just logically OR it into
		704	the bitset.
		705
		706	=item $foreground = urxvt::GET_BASEFG $rend
		707
		708	=item $background = urxvt::GET_BASEBG $rend
		709
		710	Return the foreground/background colour index, respectively.
		711
		712	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		713
		714	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		715
		716	Replace the foreground/background colour in the rendition mask with the
		717	specified one.
		718
		719	=item $value = urxvt::GET_CUSTOM $rend
		720
		721	Return the "custom" value: Every rendition has 5 bits for use by
		722	extensions. They can be set and changed as you like and are initially
		723	zero.
		724
		725	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		726
		727	Change the custom value.
		728
		729	=back
		730
		731	=cut
		732
494	BEGIN {	733	BEGIN {
495	urxvt->bootstrap;
496
497	# overwrite perl's warn	734	# overwrite perl's warn
498	*CORE::GLOBAL::warn = sub {	735	*CORE::GLOBAL::warn = sub {
499	my $msg = join "", @_;	736	my $msg = join "", @_;
500	$msg .= "\n"	737	$msg .= "\n"
501	unless $msg =~ /\n$/;	738	unless $msg =~ /\n$/;
502	urxvt::warn ($msg);	739	urxvt::warn ($msg);
503	};	740	};
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	}	741	}
510		742
511	my @hook_count;	743	no warnings 'utf8';
		744
512	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	745	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
513		746
514	sub verbose {	747	sub verbose {
515	my ($level, $msg) = @_;	748	my ($level, $msg) = @_;
516	warn "$msg\n" if $level <= $verbosity;	749	warn "$msg\n" if $level <= $verbosity;
517	}	750	}
518		751
519	my $extension_pkg = "extension0000";
520	my %extension_pkg;	752	my %extension_pkg;
521		753
522	# load a single script into its own package, once only	754	# load a single script into its own package, once only
523	sub extension_package($) {	755	sub extension_package($) {
524	my ($path) = @_;	756	my ($path) = @_;
525		757
526	$extension_pkg{$path} \|\|= do {	758	$extension_pkg{$path} \|\|= do {
527	my $pkg = "urxvt::" . ($extension_pkg++);	759	$path =~ /([^\/\\]+)$/;
		760	my $pkg = $1;
		761	$pkg =~ s/[^[:word:]]/_/g;
		762	$pkg = "urxvt::ext::$pkg";
528		763
529	verbose 3, "loading extension '$path' into package '$pkg'";	764	verbose 3, "loading extension '$path' into package '$pkg'";
530		765
531	open my $fh, "<:raw", $path	766	open my $fh, "<:raw", $path
532	or die "$path: $!";	767	or die "$path: $!";
533		768
534	my $source = untaint	769	my $source =
535	"package $pkg; use strict; use utf8;\n"	770	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
536	. "use base urxvt::term::extension::;\n"
537	. "#line 1 \"$path\"\n{\n"	771	. "#line 1 \"$path\"\n{\n"
538	. (do { local $/; <$fh> })	772	. (do { local $/; <$fh> })
539	. "\n};\n1";	773	. "\n};\n1";
540		774
541	eval $source	775	eval $source
…		…
555	if ($htype == 0) { # INIT	789	if ($htype == 0) { # INIT
556	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	790	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
557		791
558	my %ext_arg;	792	my %ext_arg;
559		793
		794	{
		795	my @init = @TERM_INIT;
		796	@TERM_INIT = ();
		797	$_->($TERM) for @init;
		798	my @pkg = @TERM_EXT;
		799	@TERM_EXT = ();
		800	$TERM->register_package ($_) for @pkg;
		801	}
		802
560	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	803	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
561	if ($_ eq "default") {	804	if ($_ eq "default") {
562	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	805	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
563	} elsif (/^-(.*)$/) {	806	} elsif (/^-(.*)$/) {
564	delete $ext_arg{$1};	807	delete $ext_arg{$1};
565	} elsif (/^([^<]+)<(.*)>$/) {	808	} elsif (/^([^<]+)<(.*)>$/) {
566	push @{ $ext_arg{$1} }, $2;	809	push @{ $ext_arg{$1} }, $2;
567	} else {	810	} else {
…		…
590	if $verbosity >= 10;	833	if $verbosity >= 10;
591		834
592	keys %$cb;	835	keys %$cb;
593		836
594	while (my ($pkg, $cb) = each %$cb) {	837	while (my ($pkg, $cb) = each %$cb) {
595	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	838	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
596	and last;	839	$retval \|\|= $retval_;
597		840
598	if ($@) {	841	if ($@) {
599	$TERM->ungrab; # better to lose the grab than the session	842	$TERM->ungrab; # better to lose the grab than the session
600	warn $@;	843	warn $@;
601	}	844	}
602	}	845	}
		846
		847	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		848	if $verbosity >= 11;
603	}	849	}
604		850
605	if ($htype == 1) { # DESTROY	851	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	852	# clear package objects
614	%$_ = () for values %{ $TERM->{_pkg} };	853	%$_ = () for values %{ $TERM->{_pkg} };
615		854
616	# clear package	855	# clear package
617	%$TERM = ();	856	%$TERM = ();
…		…
631	while (my ($name, $cb) = each %hook) {	870	while (my ($name, $cb) = each %hook) {
632	my $htype = $HOOKTYPE{uc $name};	871	my $htype = $HOOKTYPE{uc $name};
633	defined $htype	872	defined $htype
634	or Carp::croak "unsupported hook type '$name'";	873	or Carp::croak "unsupported hook type '$name'";
635		874
		875	$self->set_should_invoke ($htype, +1)
636	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	876	unless exists $self->{term}{_hook}[$htype]{$pkg};
637	$hook_count[$htype]++
638	or urxvt::set_should_invoke $htype, 1;
639	}
640		877
641	$self->{term}{_hook}[$htype]{$pkg} = $cb;	878	$self->{term}{_hook}[$htype]{$pkg} = $cb;
642	}	879	}
643	}	880	}
644		881
…		…
649	for my $name (@hook) {	886	for my $name (@hook) {
650	my $htype = $HOOKTYPE{uc $name};	887	my $htype = $HOOKTYPE{uc $name};
651	defined $htype	888	defined $htype
652	or Carp::croak "unsupported hook type '$name'";	889	or Carp::croak "unsupported hook type '$name'";
653		890
		891	$self->set_should_invoke ($htype, -1)
654	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	892	if delete $self->{term}{_hook}[$htype]{$pkg};
655	--$hook_count[$htype]
656	or urxvt::set_should_invoke $htype, 0;
657	}
658	}	893	}
659	}	894	}
660		895
661	our $AUTOLOAD;	896	our $AUTOLOAD;
662		897
…		…
768	# find on_xxx subs in the package and register them	1003	# find on_xxx subs in the package and register them
769	# as hooks	1004	# as hooks
770	sub register_package {	1005	sub register_package {
771	my ($self, $pkg, $argv) = @_;	1006	my ($self, $pkg, $argv) = @_;
772		1007
		1008	no strict 'refs';
		1009
		1010	urxvt::verbose 6, "register package $pkg to $self";
		1011
		1012	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1013
773	my $proxy = bless {	1014	my $proxy = bless {
774	_pkg => $pkg,	1015	_pkg => $pkg,
775	argv => $argv,	1016	argv => $argv,
776	}, $pkg;	1017	}, $pkg;
777	Scalar::Util::weaken ($proxy->{term} = $self);	1018	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
783	$proxy->enable ($name => $ref);	1024	$proxy->enable ($name => $ref);
784	}	1025	}
785	}	1026	}
786	}	1027	}
787		1028
		1029	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1030
		1031	Creates a new terminal, very similar as if you had started it with system
		1032	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1033	hash which defines the environment of the new terminal.
		1034
		1035	Croaks (and probably outputs an error message) if the new instance
		1036	couldn't be created. Returns C<undef> if the new instance didn't
		1037	initialise perl, and the terminal object otherwise. The C<init> and
		1038	C<start> hooks will be called during this call.
		1039
		1040	=cut
		1041
		1042	sub new {
		1043	my ($class, $env, @args) = @_;
		1044
		1045	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		1046	}
		1047
788	=item $term->destroy	1048	=item $term->destroy
789		1049
790	Destroy the terminal object (close the window, free resources	1050	Destroy the terminal object (close the window, free resources
791	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1051	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
792	watchers (timers, io watchers) are still active.	1052	watchers (timers, io watchers) are still active.
793		1053
		1054	=item $term->exec_async ($cmd[, @args])
		1055
		1056	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1057	("starts") programs in the background. This function takes care of setting
		1058	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1059	be preferred over explicit calls to C<exec> or C<system>.
		1060
		1061	Returns the pid of the subprocess or C<undef> on error.
		1062
		1063	=cut
		1064
		1065	sub exec_async {
		1066	my $self = shift;
		1067
		1068	my $pid = fork;
		1069
		1070	return $pid
		1071	if !defined $pid or $pid;
		1072
		1073	%ENV = %{ $self->env };
		1074
		1075	exec @_;
		1076	urxvt::_exit 255;
		1077	}
		1078
794	=item $isset = $term->option ($optval[, $set])	1079	=item $isset = $term->option ($optval[, $set])
795		1080
796	Returns true if the option specified by C<$optval> is enabled, and	1081	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	1082	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.	1083	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	1085	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:	1086	source file F</src/optinc.h> to see the actual list:
802		1087
803	borderLess console cursorBlink cursorUnderline hold iconic insecure	1088	borderLess console cursorBlink cursorUnderline hold iconic insecure
804	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1089	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
805	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1090	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
806	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1091	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
807	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1092	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
808	tripleclickwords utmpInhibit visualBell	1093	transparent tripleclickwords utmpInhibit visualBell
809		1094
810	=item $value = $term->resource ($name[, $newval])	1095	=item $value = $term->resource ($name[, $newval])
811		1096
812	Returns the current resource value associated with a given name and	1097	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>	1098	optionally sets a new value. Setting values is most useful in the C<init>
…		…
830		1115
831	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1116	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
832	borderLess color cursorBlink cursorUnderline cutchars delete_key	1117	borderLess color cursorBlink cursorUnderline cutchars delete_key
833	display_name embed ext_bwidth fade font geometry hold iconName	1118	display_name embed ext_bwidth fade font geometry hold iconName
834	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1119	imFont imLocale inputMethod insecure int_bwidth intensityStyles
835	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1120	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
836	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1121	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
837	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1122	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
838	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1123	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
839	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1124	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
840	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1125	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
841	shade term_name title transparent transparent_all tripleclickwords	1126	secondaryScreen secondaryScroll selectstyle shade term_name title
842	utmpInhibit visualBell	1127	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1128	visualBell
843		1129
844	=cut	1130	=cut
845		1131
846	sub resource($$;$) {	1132	sub resource($$;$) {
847	my ($self, $name) = (shift, shift);	1133	my ($self, $name) = (shift, shift);
848	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1134	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
849	&urxvt::term::_resource	1135	&urxvt::term::_resource
850	}	1136	}
851		1137
		1138	=item $value = $term->x_resource ($pattern)
		1139
		1140	Returns the X-Resource for the given pattern, excluding the program or
		1141	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1142	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1143	resource with that pattern exists.
		1144
		1145	This method should only be called during the C<on_start> hook, as there is
		1146	only one resource database per display, and later invocations might return
		1147	the wrong resources.
		1148
852	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1149	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
853		1150
854	Adds a keymap translation exactly as specified via a resource. See the	1151	Adds a keymap translation exactly as specified via a resource. See the
855	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1152	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
856		1153
…		…
871	=item ($row, $col) = $term->selection_end ([$row, $col])	1168	=item ($row, $col) = $term->selection_end ([$row, $col])
872		1169
873	Return the current values of the selection mark, begin or end positions,	1170	Return the current values of the selection mark, begin or end positions,
874	and optionally set them to new values.	1171	and optionally set them to new values.
875		1172
		1173	=item $term->selection_make ($eventtime[, $rectangular])
		1174
		1175	Tries to make a selection as set by C<selection_beg> and
		1176	C<selection_end>. If C<$rectangular> is true (default: false), a
		1177	rectangular selection will be made. This is the prefered function to make
		1178	a selection.
		1179
876	=item $success = $term->selection_grab ($eventtime)	1180	=item $success = $term->selection_grab ($eventtime)
877		1181
878	Try to request the primary selection from the server (for example, as set	1182	Try to request the primary selection text from the server (for example, as
879	by the next method).	1183	set by the next method). No visual feedback will be given. This function
		1184	is mostly useful from within C<on_sel_grab> hooks.
880		1185
881	=item $oldtext = $term->selection ([$newtext])	1186	=item $oldtext = $term->selection ([$newtext])
882		1187
883	Return the current selection text and optionally replace it by C<$newtext>.	1188	Return the current selection text and optionally replace it by C<$newtext>.
884		1189
…		…
977	Convert the given locale-encoded octets into a perl string.	1282	Convert the given locale-encoded octets into a perl string.
978		1283
979	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1284	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
980		1285
981	XORs the rendition values in the given span with the provided value	1286	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	1287	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
983	to the selection.	1288	refresh hooks to provide effects similar to the selection.
984		1289
985	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1290	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
986		1291
987	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1292	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
988	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1293	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	1294	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
990	it instead.	1295	it instead. Both styles I<MUST NOT> contain font styles.
991		1296
992	=item $term->scr_bell	1297	=item $term->scr_bell
993		1298
994	Ring the bell!	1299	Ring the bell!
995		1300
…		…
1002		1307
1003	Normally its not a good idea to use this function, as programs might be	1308	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	1309	confused by changes in cursor position or scrolling. Its useful inside a
1005	C<on_add_lines> hook, though.	1310	C<on_add_lines> hook, though.
1006		1311
		1312	=item $term->scr_change_screen ($screen)
		1313
		1314	Switch to given screen - 0 primary, 1 secondary.
		1315
1007	=item $term->cmd_parse ($octets)	1316	=item $term->cmd_parse ($octets)
1008		1317
1009	Similar to C<scr_add_lines>, but the argument must be in the	1318	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	1319	locale-specific encoding of the terminal and can contain command sequences
1011	(escape codes) that will be interpreted.	1320	(escape codes) that will be interpreted.
…		…
1021	Replaces the event mask of the pty watcher by the given event mask. Can	1330	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	1331	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	1332	description of C<< urxvt::timer->events >>. Make sure to always restore
1024	the previous value.	1333	the previous value.
1025		1334
		1335	=item $fd = $term->pty_fd
		1336
		1337	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1338	is used.
		1339
1026	=item $windowid = $term->parent	1340	=item $windowid = $term->parent
1027		1341
1028	Return the window id of the toplevel window.	1342	Return the window id of the toplevel window.
1029		1343
1030	=item $windowid = $term->vt	1344	=item $windowid = $term->vt
1031		1345
1032	Return the window id of the terminal window.	1346	Return the window id of the terminal window.
1033		1347
		1348	=item $term->vt_emask_add ($x_event_mask)
		1349
		1350	Adds the specified events to the vt event mask. Useful e.g. when you want
		1351	to receive pointer events all the times:
		1352
		1353	$term->vt_emask_add (urxvt::PointerMotionMask);
		1354
1034	=item $window_width = $term->width	1355	=item $window_width = $term->width
1035		1356
1036	=item $window_height = $term->height	1357	=item $window_height = $term->height
1037		1358
1038	=item $font_width = $term->fwidth	1359	=item $font_width = $term->fwidth
…		…
1051		1372
1052	=item $max_scrollback = $term->saveLines	1373	=item $max_scrollback = $term->saveLines
1053		1374
1054	=item $nrow_plus_saveLines = $term->total_rows	1375	=item $nrow_plus_saveLines = $term->total_rows
1055		1376
1056	=item $lines_in_scrollback = $term->nsaved	1377	=item $topmost_scrollback_row = $term->top_row
1057		1378
1058	Return various integers describing terminal characteristics.	1379	Return various integers describing terminal characteristics.
1059		1380
		1381	=item $x_display = $term->display_id
		1382
		1383	Return the DISPLAY used by rxvt-unicode.
		1384
1060	=item $lc_ctype = $term->locale	1385	=item $lc_ctype = $term->locale
1061		1386
1062	Returns the LC_CTYPE category string used by this rxvt-unicode.	1387	Returns the LC_CTYPE category string used by this rxvt-unicode.
1063		1388
1064	=item $x_display = $term->display_id	1389	=item $env = $term->env
1065		1390
1066	Return the DISPLAY used by rxvt-unicode.	1391	Returns a copy of the environment in effect for the terminal as a hashref
		1392	similar to C<\%ENV>.
		1393
		1394	=cut
		1395
		1396	sub env {
		1397	if (my $env = $_[0]->_env) {
		1398	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1399	} else {
		1400	+{ %ENV }
		1401	}
		1402	}
1067		1403
1068	=item $modifiermask = $term->ModLevel3Mask	1404	=item $modifiermask = $term->ModLevel3Mask
1069		1405
1070	=item $modifiermask = $term->ModMetaMask	1406	=item $modifiermask = $term->ModMetaMask
1071		1407
1072	=item $modifiermask = $term->ModNumLockMask	1408	=item $modifiermask = $term->ModNumLockMask
1073		1409
1074	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1410	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.	1411	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1076		1412
		1413	=item $screen = $term->current_screen
		1414
		1415	Returns the currently displayed screen (0 primary, 1 secondary).
		1416
		1417	=item $cursor_is_hidden = $term->hidden_cursor
		1418
		1419	Returns wether the cursor is currently hidden or not.
		1420
1077	=item $view_start = $term->view_start ([$newvalue])	1421	=item $view_start = $term->view_start ([$newvalue])
1078		1422
1079	Returns the negative row number of the topmost line. Minimum value is	1423	Returns the row number of the topmost displayed line. Maximum value is
1080	C<0>, which displays the normal terminal contents. Larger values scroll	1424	C<0>, which displays the normal terminal contents. Lower values scroll
1081	this many lines into the scrollback buffer.	1425	this many lines into the scrollback buffer.
1082		1426
1083	=item $term->want_refresh	1427	=item $term->want_refresh
1084		1428
1085	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1429	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	1444	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	1445	to replace only parts of a line. The font index in the rendition will
1102	automatically be updated.	1446	automatically be updated.
1103		1447
1104	C<$text> is in a special encoding: tabs and wide characters that use more	1448	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	1449	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1106	(C<chr 65535>). Characters with combining characters and other characters	1450	characters. Characters with combining characters and other characters that
1107	that do not fit into the normal tetx encoding will be replaced with	1451	do not fit into the normal tetx encoding will be replaced with characters
1108	characters in the private use area.	1452	in the private use area.
1109		1453
1110	You have to obey this encoding when changing text. The advantage is	1454	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	1455	that C<substr> and similar functions work on screen cells and not on
1112	characters.	1456	characters.
1113		1457
…		…
1164	Return the row number of the first/last row of the line, respectively.	1508	Return the row number of the first/last row of the line, respectively.
1165		1509
1166	=item $offset = $line->offset_of ($row, $col)	1510	=item $offset = $line->offset_of ($row, $col)
1167		1511
1168	Returns the character offset of the given row\|col pair within the logical	1512	Returns the character offset of the given row\|col pair within the logical
1169	line.	1513	line. Works for rows outside the line, too, and returns corresponding
		1514	offsets outside the string.
1170		1515
1171	=item ($row, $col) = $line->coord_of ($offset)	1516	=item ($row, $col) = $line->coord_of ($offset)
1172		1517
1173	Translates a string offset into terminal coordinates again.	1518	Translates a string offset into terminal coordinates again.
1174		1519
…		…
1287		1632
1288	Calls XUngrab for the most recent grab. Is called automatically on	1633	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	1634	evaluation errors, as it is better to lose the grab in the error case as
1290	the session.	1635	the session.
1291		1636
		1637	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1638
		1639	=item $atom_name = $term->XGetAtomName ($atom)
		1640
		1641	=item @atoms = $term->XListProperties ($window)
		1642
		1643	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1644
		1645	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1646
		1647	=item $term->XDeleteProperty ($window, $property)
		1648
		1649	=item $window = $term->DefaultRootWindow
		1650
		1651	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1652
		1653	=item $term->XMapWindow ($window)
		1654
		1655	=item $term->XUnmapWindow ($window)
		1656
		1657	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1658
		1659	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1660
		1661	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1662
		1663	Various X or X-related functions. The C<$term> object only serves as
		1664	the source of the display, otherwise those functions map more-or-less
		1665	directory onto the X functions of the same name.
		1666
1292	=back	1667	=back
1293		1668
1294	=cut	1669	=cut
1295		1670
1296	package urxvt::popup;	1671	package urxvt::popup;
…		…
1392	sub show {	1767	sub show {
1393	my ($self) = @_;	1768	my ($self) = @_;
1394		1769
1395	local $urxvt::popup::self = $self;	1770	local $urxvt::popup::self = $self;
1396		1771
		1772	my $env = $self->{term}->env;
		1773	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1774	delete $env->{LC_ALL};
1397	local $ENV{LC_ALL} = $self->{term}->locale;	1775	$env->{LC_CTYPE} = $self->{term}->locale;
1398		1776
1399	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1777	urxvt::term->new ($env, "popup",
		1778	"--perl-lib" => "", "--perl-ext-common" => "",
		1779	"-pty-fd" => -1, "-sl" => 0,
		1780	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1400	"--transient-for" => $self->{term}->parent,	1781	"--transient-for" => $self->{term}->parent,
1401	"-display" => $self->{term}->display_id,	1782	"-display" => $self->{term}->display_id,
1402	"-pe" => "urxvt-popup")	1783	"-pe" => "urxvt-popup")
1403	or die "unable to create popup window\n";	1784	or die "unable to create popup window\n";
1404	}	1785	}
1405		1786
1406	sub DESTROY {	1787	sub DESTROY {
1407	my ($self) = @_;	1788	my ($self) = @_;
1408		1789
1409	delete $self->{term}{_destroy}{$self};	1790	delete $self->{term}{_destroy}{$self};
1410	$self->{term}->ungrab;	1791	$self->{term}->ungrab;
1411	}	1792	}
		1793
		1794	=back
		1795
		1796	=cut
		1797
		1798	package urxvt::watcher;
		1799
		1800	@urxvt::timer::ISA = __PACKAGE__;
		1801	@urxvt::iow::ISA = __PACKAGE__;
		1802	@urxvt::pw::ISA = __PACKAGE__;
		1803	@urxvt::iw::ISA = __PACKAGE__;
1412		1804
1413	=head2 The C<urxvt::timer> Class	1805	=head2 The C<urxvt::timer> Class
1414		1806
1415	This class implements timer watchers/events. Time is represented as a	1807	This class implements timer watchers/events. Time is represented as a
1416	fractional number of seconds since the epoch. Example:	1808	fractional number of seconds since the epoch. Example:
…		…
1454	Start the timer.	1846	Start the timer.
1455		1847
1456	=item $timer = $timer->start ($tstamp)	1848	=item $timer = $timer->start ($tstamp)
1457		1849
1458	Set the event trigger time to C<$tstamp> and start the timer.	1850	Set the event trigger time to C<$tstamp> and start the timer.
		1851
		1852	=item $timer = $timer->after ($delay)
		1853
		1854	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1459		1855
1460	=item $timer = $timer->stop	1856	=item $timer = $timer->stop
1461		1857
1462	Stop the timer.	1858	Stop the timer.
1463		1859
…		…
1510		1906
1511	Stop watching for events on the given filehandle.	1907	Stop watching for events on the given filehandle.
1512		1908
1513	=back	1909	=back
1514		1910
		1911	=head2 The C<urxvt::iw> Class
		1912
		1913	This class implements idle watchers, that get called automatically when
		1914	the process is idle. They should return as fast as possible, after doing
		1915	some useful work.
		1916
		1917	=over 4
		1918
		1919	=item $iw = new urxvt::iw
		1920
		1921	Create a new idle watcher object in stopped state.
		1922
		1923	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1924
		1925	Set the callback to be called when the watcher triggers.
		1926
		1927	=item $timer = $timer->start
		1928
		1929	Start the watcher.
		1930
		1931	=item $timer = $timer->stop
		1932
		1933	Stop the watcher.
		1934
		1935	=back
		1936
		1937	=head2 The C<urxvt::pw> Class
		1938
		1939	This class implements process watchers. They create an event whenever a
		1940	process exits, after which they stop automatically.
		1941
		1942	my $pid = fork;
		1943	...
		1944	$term->{pw} = urxvt::pw
		1945	->new
		1946	->start ($pid)
		1947	->cb (sub {
		1948	my ($pw, $exit_status) = @_;
		1949	...
		1950	});
		1951
		1952	=over 4
		1953
		1954	=item $pw = new urxvt::pw
		1955
		1956	Create a new process watcher in stopped state.
		1957
		1958	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1959
		1960	Set the callback to be called when the timer triggers.
		1961
		1962	=item $pw = $timer->start ($pid)
		1963
		1964	Tells the wqtcher to start watching for process C<$pid>.
		1965
		1966	=item $pw = $pw->stop
		1967
		1968	Stop the watcher.
		1969
		1970	=back
		1971
1515	=head1 ENVIRONMENT	1972	=head1 ENVIRONMENT
1516		1973
1517	=head2 URXVT_PERL_VERBOSITY	1974	=head2 URXVT_PERL_VERBOSITY
1518		1975
1519	This variable controls the verbosity level of the perl extension. Higher	1976	This variable controls the verbosity level of the perl extension. Higher
…		…
1523		1980
1524	=item == 0 - fatal messages	1981	=item == 0 - fatal messages
1525		1982
1526	=item >= 3 - script loading and management	1983	=item >= 3 - script loading and management
1527		1984
1528	=item >=10 - all events received	1985	=item >=10 - all called hooks
		1986
		1987	=item >=11 - hook reutrn values
1529		1988
1530	=back	1989	=back
1531		1990
1532	=head1 AUTHOR	1991	=head1 AUTHOR
1533		1992

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.128 by root, Wed Jan 25 00:57:57 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.128 by root, Wed Jan 25 00:57:57 2006 UTC