ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.69 by root, Mon Jan 9 22:41:41 2006 UTC vs.
Revision 1.128 by root, Wed Jan 25 00:57:57 2006 UTC

…		…
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
31	=head2 Prepackaged Extensions	31	=head1 PREPACKAGED EXTENSIONS
32		32
33	This section describes the extensiosn delivered with this version. You can	33	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
39		39
		40	Or by adding them to the resource for extensions loaded by default:
		41
		42	URxvt.perl-ext-common: default,automove-background,selection-autotransform
		43
40	=over 4	44	=over 4
41		45
42	=item selection (enabled by default)	46	=item selection (enabled by default)
43		47
44	Intelligent selection. This extension tries to be more intelligent when	48	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	49	when the user extends selections (double-click and further clicks). Right
46	urls and complete shell-quoted arguments, which is very convenient, too,	50	now, it tries to select words, urls and complete shell-quoted
47	if your F<ls> supports C<--quoting-style=shell>.	51	arguments, which is very convenient, too, if your F<ls> supports
		52	C<--quoting-style=shell>.
48		53
49	It also offers the following bindable event:	54	A double-click usually selects the word under the cursor, further clicks
		55	will enlarge the selection.
		56
		57	The selection works by trying to match a number of regexes and displaying
		58	them in increasing order of length. You can add your own regexes by
		59	specifying resources of the form:
		60
		61	URxvt.selection.pattern-0: perl-regex
		62	URxvt.selection.pattern-1: perl-regex
		63	...
		64
		65	The index number (0, 1...) must not have any holes, and each regex must
		66	contain at least one pair of capturing parentheses, which will be used for
		67	the match. For example, the followign adds a regex that matches everything
		68	between two vertical bars:
		69
		70	URxvt.selection.pattern-0: \\|([^|]+)\\|
		71
		72	Another example: Programs I use often output "absolute path: " at the
		73	beginning of a line when they process multiple files. The following
		74	pattern matches the filename (note, there is a single space at the very
		75	end):
		76
		77	URxvt.selection.pattern-0: ^(/[^:]+):\
		78
		79	You can look at the source of the selection extension to see more
		80	interesting uses, such as parsing a line from beginning to end.
		81
		82	This extension also offers following bindable keyboard commands:
50		83
51	=over 4	84	=over 4
52		85
53	=item rot13	86	=item rot13
54		87
…		…
64	runtime.	97	runtime.
65		98
66	=item selection-popup (enabled by default)	99	=item selection-popup (enabled by default)
67		100
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	101	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	102	text into various other formats/action (such as uri unescaping, perl
		103	evaluation, web-browser starting etc.), depending on content.
70		104
		105	Other extensions can extend this popup menu by pushing a code reference
		106	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		107	popup is displayed.
		108
		109	It's sole argument is the popup menu, which can be modified. The selection
		110	is in C<$_>, which can be used to decide wether to add something or not.
		111	It should either return nothing or a string and a code reference. The
		112	string will be used as button text and the code reference will be called
		113	when the button gets activated and should transform C<$_>.
		114
		115	The following will add an entry C<a to b> that transforms all C<a>s in
		116	the selection to C<b>s, but only if the selection currently contains any
		117	C<a>s:
		118
		119	push @{ $self->{term}{selection_popup_hook} }, sub {
		120	/a/ ? ("a to be" => sub { s/a/b/g }
		121	: ()
		122	};
		123
71	=item searchable-scrollback (enabled by default)	124	=item searchable-scrollback<hotkey> (enabled by default)
72		125
73	Adds regex search functionality to the scrollback buffer, triggered by a	126	Adds regex search functionality to the scrollback buffer, triggered
74	hotkey (default: C<M-s>). When in search mode, terminal input/output is	127	by a hotkey (default: C<M-s>). While in search mode, normal terminal
75	suspended, C</> starts an incremental regex search, C<n> searches further,	128	input/output is suspended and a regex is displayed at the bottom of the
76	C<p> jumps to the previous match. C<enter> leaves search mode at the	129	screen.
77	current position and C<escape> returns to the original position.
78		130
79	=item digital-clock	131	Inputting characters appends them to the regex and continues incremental
		132	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		133	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		134	bottom. C<Escape> leaves search mode and returns to the point where search
		135	was started, while C<Enter> or C<Return> stay at the current position and
		136	additionally stores the first match in the current line into the primary
		137	selection.
80		138
81	Displays a digital clock using the built-in overlay.	139	=item readline (enabled by default)
		140
		141	A support package that tries to make editing with readline easier. At the
		142	moment, it reacts to clicking with the left mouse button by trying to
		143	move the text cursor to this position. It does so by generating as many
		144	cursor-left or cursor-right keypresses as required (the this only works
		145	for programs that correctly support wide characters).
		146
		147	To avoid too many false positives, this is only done when:
		148
		149	=over 4
		150
		151	=item - the tty is in ICANON state.
		152
		153	=item - the text cursor is visible.
		154
		155	=item - the primary screen is currently being displayed.
		156
		157	=item - the mouse is on the same (multi-row-) line as the text cursor.
		158
		159	=back
		160
		161	The normal selection mechanism isn't disabled, so quick successive clicks
		162	might interfere with selection creation in harmless ways.
		163
		164	=item selection-autotransform
		165
		166	This selection allows you to do automatic transforms on a selection
		167	whenever a selection is made.
		168
		169	It works by specifying perl snippets (most useful is a single C<s///>
		170	operator) that modify C<$_> as resources:
		171
		172	URxvt.selection-autotransform.0: transform
		173	URxvt.selection-autotransform.1: transform
		174	...
		175
		176	For example, the following will transform selections of the form
		177	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		178	$word>:
		179
		180	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		181
		182	And this example matches the same,but replaces it with vi-commands you can
		183	paste directly into your (vi :) editor:
		184
		185	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		186
		187	Of course, this can be modified to suit your needs and your editor :)
		188
		189	To expand the example above to typical perl error messages ("XXX at
		190	FILENAME line YYY."), you need a slightly more elaborate solution:
		191
		192	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		193	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		194
		195	The first line tells the selection code to treat the unchanging part of
		196	every error message as a selection pattern, and the second line transforms
		197	the message into vi commands to load the file.
		198
		199	=item tabbed
		200
		201	This transforms the terminal into a tabbar with additional terminals, that
		202	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		203	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		204	button per tab.
		205
		206	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		207	B<Shift-Right> will switch to the tab left or right of the current one,
		208	while B<Shift-Down> creates a new tab.
82		209
83	=item mark-urls	210	=item mark-urls
84		211
85	Uses per-line display filtering (C<on_line_update>) to underline urls.	212	Uses per-line display filtering (C<on_line_update>) to underline urls and
		213	make them clickable. When middle-clicked, the program specified in the
		214	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		215	the URL as first argument.
		216
		217	=item 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
86		236
87	=item block-graphics-to-ascii	237	=item block-graphics-to-ascii
88		238
89	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,
90	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
91	similar-looking ascii character.	241	similar-looking ascii character.
92		242
		243	=item digital-clock
		244
		245	Displays a digital clock using the built-in overlay.
		246
93	=item example-refresh-hooks	247	=item example-refresh-hooks
94		248
95	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
96	window. Illustrates overwriting the refresh callbacks to create your own	250	window. Illustrates overwriting the refresh callbacks to create your own
97	overlays or changes.	251	overlays or changes.
98		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/%
		281
99	=back	282	=back
		283
		284	=head1 API DOCUMENTATION
100		285
101	=head2 General API Considerations	286	=head2 General API Considerations
102		287
103	All objects (such as terminals, time watchers etc.) are typical	288	All objects (such as terminals, time watchers etc.) are typical
104	reference-to-hash objects. The hash can be used to store anything you	289	reference-to-hash objects. The hash can be used to store anything you
…		…
117	=over 4	302	=over 4
118		303
119	=item $text	304	=item $text
120		305
121	Rxvt-unicodes special way of encoding text, where one "unicode" character	306	Rxvt-unicodes special way of encoding text, where one "unicode" character
122	always represents one screen cell. See L<row_t> for a discussion of this format.	307	always represents one screen cell. See L<ROW_t> for a discussion of this format.
123		308
124	=item $string	309	=item $string
125		310
126	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
127	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
…		…
173	called whenever the relevant event happens.	358	called whenever the relevant event happens.
174		359
175	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
176	the in the C<Extension Objects> section.	361	the in the C<Extension Objects> section.
177		362
178	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
179	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
180	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.
181		366
182	I<< When in doubt, return a false value (preferably C<()>). >>	367	I<< When in doubt, return a false value (preferably C<()>). >>
183		368
184	=over 4	369	=over 4
185		370
186	=item on_init $term	371	=item on_init $term
187		372
188	Called after a new terminal object has been initialized, but before	373	Called after a new terminal object has been initialized, but before
189	windows are created or the command gets run. Most methods are unsafe to	374	windows are created or the command gets run. Most methods are unsafe to
190	call or deliver senseless data, as terminal size and other characteristics	375	call or deliver senseless data, as terminal size and other characteristics
191	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
192	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).
193		389
194	=item on_reset $term	390	=item on_reset $term
195		391
196	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
197	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
198	variables.	394	variables.
199		395
200	=item on_start $term	396	=item on_child_start $term, $pid
201		397
202	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.
203	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>.
204		404
205	=item on_sel_make $term, $eventtime	405	=item on_sel_make $term, $eventtime
206		406
207	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
208	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
…		…
222	=item on_sel_extend $term	422	=item on_sel_extend $term
223		423
224	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
225	click) and is either supposed to return false (normal operation), or	425	click) and is either supposed to return false (normal operation), or
226	should extend the selection itelf and return true to suppress the built-in	426	should extend the selection itelf and return true to suppress the built-in
227	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.
228		430
229	See the F<selection> example extension.	431	See the F<selection> example extension.
230		432
231	=item on_view_change $term, $offset	433	=item on_view_change $term, $offset
232		434
…		…
263	can filter/change and output the text yourself by returning a true value	465	can filter/change and output the text yourself by returning a true value
264	and calling C<< $term->scr_add_lines >> yourself. Please note that this	466	and calling C<< $term->scr_add_lines >> yourself. Please note that this
265	might be very slow, however, as your hook is called for B<all> text being	467	might be very slow, however, as your hook is called for B<all> text being
266	output.	468	output.
267		469
		470	=item on_tt_write $term, $octets
		471
		472	Called whenever some data is written to the tty/pty and can be used to
		473	suppress or filter tty input.
		474
268	=item on_line_update $term, $row	475	=item on_line_update $term, $row
269		476
270	Called whenever a line was updated or changed. Can be used to filter	477	Called whenever a line was updated or changed. Can be used to filter
271	screen output (e.g. underline urls or other useless stuff). Only lines	478	screen output (e.g. underline urls or other useless stuff). Only lines
272	that are being shown will be filtered, and, due to performance reasons,	479	that are being shown will be filtered, and, due to performance reasons,
…		…
294		501
295	Called whenever the user presses a key combination that has a	502	Called whenever the user presses a key combination that has a
296	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>
297	resource in the @@RXVT_NAME@@(1) manpage).	504	resource in the @@RXVT_NAME@@(1) manpage).
298		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
299	=item on_focus_in $term	512	=item on_focus_in $term
300		513
301	Called whenever the window gets the keyboard focus, before rxvt-unicode	514	Called whenever the window gets the keyboard focus, before rxvt-unicode
302	does focus in processing.	515	does focus in processing.
303		516
304	=item on_focus_out $term	517	=item on_focus_out $term
305		518
306	Called wheneever the window loses keyboard focus, before rxvt-unicode does	519	Called wheneever the window loses keyboard focus, before rxvt-unicode does
307	focus out processing.	520	focus out processing.
308		521
		522	=item on_configure_notify $term, $event
		523
		524	=item on_property_notify $term, $event
		525
309	=item on_key_press $term, $event, $keysym, $octets	526	=item on_key_press $term, $event, $keysym, $octets
310		527
311	=item on_key_release $term, $event, $keysym	528	=item on_key_release $term, $event, $keysym
312		529
313	=item on_button_press $term, $event	530	=item on_button_press $term, $event
…		…
322		539
323	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
324	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.
325		542
326	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
327	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
328	and column under the mouse cursor.	545	(real, not screen-based) row and column under the mouse cursor.
329		546
330	C<on_key_press> additionally receives the string rxvt-unicode would	547	C<on_key_press> additionally receives the string rxvt-unicode would
331	output, if any, in locale-specific encoding.	548	output, if any, in locale-specific encoding.
332		549
333	subwindow.	550	subwindow.
334		551
335	=back	552	=item on_client_message $term, $event
336		553
337	=head2 Variables in the C<urxvt> Package	554	=item on_wm_protocols $term, $event
338		555
339	=over 4	556	=item on_wm_delete_window $term, $event
340		557
341	=item $urxvt::TERM	558	Called when various types of ClientMessage events are received (all with
342		559	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
343	The current terminal. This variable stores the current C<urxvt::term>
344	object, whenever a callback/hook is executing.
345
346	=back
347
348	=head2 Functions in the C<urxvt> Package
349
350	=over 4
351
352	=item $term = new urxvt [arg...]
353
354	Creates a new terminal, very similar as if you had started it with
355	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
356	if the new instance couldn't be created. Returns C<undef> if the new
357	instance didn't initialise perl, and the terminal object otherwise. The
358	C<init> and C<start> hooks will be called during the call.
359
360	=item urxvt::fatal $errormessage
361
362	Fatally aborts execution with the given error message. Avoid at all
363	costs! The only time this is acceptable is when the terminal process
364	starts up.
365
366	=item urxvt::warn $string
367
368	Calls C<rxvt_warn> with the given string which should not include a
369	newline. The module also overwrites the C<warn> builtin with a function
370	that calls this function.
371
372	Using this function has the advantage that its output ends up in the
373	correct place, e.g. on stderr of the connecting urxvtc client.
374
375	=item $is_safe = urxvt::safe
376
377	Returns true when it is safe to do potentially unsafe things, such as
378	evaluating perl code specified by the user. This is true when urxvt was
379	started setuid or setgid.
380
381	=item $time = urxvt::NOW
382
383	Returns the "current time" (as per the event loop).
384
385	=item urxvt::CurrentTime
386
387	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
388	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
389	Button4Mask, Button5Mask, AnyModifier
390
391	Various constants for use in X calls and event processing.
392
393	=back
394
395	=head2 RENDITION
396
397	Rendition bitsets contain information about colour, font, font styles and
398	similar information for each screen cell.
399
400	The following "macros" deal with changes in rendition sets. You should
401	never just create a bitset, you should always modify an existing one,
402	as they contain important information required for correct operation of
403	rxvt-unicode.
404
405	=over 4
406
407	=item $rend = urxvt::DEFAULT_RSTYLE
408
409	Returns the default rendition, as used when the terminal is starting up or
410	being reset. Useful as a base to start when creating renditions.
411
412	=item $rend = urxvt::OVERLAY_RSTYLE
413
414	Return the rendition mask used for overlays by default.
415
416	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
417
418	Return the bit that enabled bold, italic, blink, reverse-video and
419	underline, respectively. To enable such a style, just logically OR it into
420	the bitset.
421
422	=item $foreground = urxvt::GET_BASEFG $rend
423
424	=item $background = urxvt::GET_BASEBG $rend
425
426	Return the foreground/background colour index, respectively.
427
428	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
429
430	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
431
432	Replace the foreground/background colour in the rendition mask with the
433	specified one.
434
435	=item $value = urxvt::GET_CUSTOM ($rend)
436
437	Return the "custom" value: Every rendition has 5 bits for use by
438	extensions. They can be set and changed as you like and are initially
439	zero.
440
441	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
442
443	Change the custom value.
444		560
445	=back	561	=back
446		562
447	=cut	563	=cut
448		564
…		…
454	use Scalar::Util ();	570	use Scalar::Util ();
455	use List::Util ();	571	use List::Util ();
456		572
457	our $VERSION = 1;	573	our $VERSION = 1;
458	our $TERM;	574	our $TERM;
		575	our @TERM_INIT;
		576	our @TERM_EXT;
459	our @HOOKNAME;	577	our @HOOKNAME;
460	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	578	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
461	our %OPTION;	579	our %OPTION;
		580
462	our $LIBDIR;	581	our $LIBDIR;
		582	our $RESNAME;
		583	our $RESCLASS;
		584	our $RXVTNAME;
		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
463		732
464	BEGIN {	733	BEGIN {
465	urxvt->bootstrap;
466
467	# overwrite perl's warn	734	# overwrite perl's warn
468	*CORE::GLOBAL::warn = sub {	735	*CORE::GLOBAL::warn = sub {
469	my $msg = join "", @_;	736	my $msg = join "", @_;
470	$msg .= "\n"	737	$msg .= "\n"
471	unless $msg =~ /\n$/;	738	unless $msg =~ /\n$/;
472	urxvt::warn ($msg);	739	urxvt::warn ($msg);
473	};	740	};
474
475	delete $ENV{IFS};
476	delete $ENV{CDPATH};
477	delete $ENV{BASH_ENV};
478	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
479	}	741	}
480		742
481	my @hook_count;	743	no warnings 'utf8';
		744
482	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	745	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
483		746
484	sub verbose {	747	sub verbose {
485	my ($level, $msg) = @_;	748	my ($level, $msg) = @_;
486	warn "$msg\n" if $level <= $verbosity;	749	warn "$msg\n" if $level <= $verbosity;
487	}	750	}
488		751
489	my $extension_pkg = "extension0000";
490	my %extension_pkg;	752	my %extension_pkg;
491		753
492	# load a single script into its own package, once only	754	# load a single script into its own package, once only
493	sub extension_package($) {	755	sub extension_package($) {
494	my ($path) = @_;	756	my ($path) = @_;
495		757
496	$extension_pkg{$path} ||= do {	758	$extension_pkg{$path} ||= do {
497	my $pkg = "urxvt::" . ($extension_pkg++);	759	$path =~ /([^\/\\]+)$/;
		760	my $pkg = $1;
		761	$pkg =~ s/[^[:word:]]/_/g;
		762	$pkg = "urxvt::ext::$pkg";
498		763
499	verbose 3, "loading extension '$path' into package '$pkg'";	764	verbose 3, "loading extension '$path' into package '$pkg'";
500		765
501	open my $fh, "<:raw", $path	766	open my $fh, "<:raw", $path
502	or die "$path: $!";	767	or die "$path: $!";
503		768
504	my $source = untaint	769	my $source =
505	"package $pkg; use strict; use utf8;\n"	770	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
506	. "use base urxvt::term::proxy::;\n"
507	. "#line 1 \"$path\"\n{\n"	771	. "#line 1 \"$path\"\n{\n"
508	. (do { local $/; <$fh> })	772	. (do { local $/; <$fh> })
509	. "\n};\n1";	773	. "\n};\n1";
510		774
511	eval $source	775	eval $source
…		…
525	if ($htype == 0) { # INIT	789	if ($htype == 0) { # INIT
526	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	790	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
527		791
528	my %ext_arg;	792	my %ext_arg;
529		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
530	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	803	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
531	if ($_ eq "default") {	804	if ($_ eq "default") {
532	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	805	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
533	} elsif (/^-(.*)$/) {	806	} elsif (/^-(.*)$/) {
534	delete $ext_arg{$1};	807	delete $ext_arg{$1};
535	} elsif (/^([^<]+)<(.*)>$/) {	808	} elsif (/^([^<]+)<(.*)>$/) {
536	push @{ $ext_arg{$1} }, $2;	809	push @{ $ext_arg{$1} }, $2;
537	} else {	810	} else {
…		…
560	if $verbosity >= 10;	833	if $verbosity >= 10;
561		834
562	keys %$cb;	835	keys %$cb;
563		836
564	while (my ($pkg, $cb) = each %$cb) {	837	while (my ($pkg, $cb) = each %$cb) {
565	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	838	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
566	and last;	839	$retval ||= $retval_;
567		840
568	if ($@) {	841	if ($@) {
569	$TERM->ungrab; # better to lose the grab than the session	842	$TERM->ungrab; # better to lose the grab than the session
570	warn $@;	843	warn $@;
571	}	844	}
572	}	845	}
		846
		847	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		848	if $verbosity >= 11;
573	}	849	}
574		850
575	if ($htype == 1) { # DESTROY	851	if ($htype == 1) { # DESTROY
576	if (my $hook = delete $TERM->{_hook}) {
577	for my $htype (0..$#$hook) {
578	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
579	or set_should_invoke $htype, 0;
580	}
581	}
582
583	# clear package objects	852	# clear package objects
584	%$_ = () for values %{ $TERM->{_pkg} };	853	%$_ = () for values %{ $TERM->{_pkg} };
585		854
586	# clear package	855	# clear package
587	%$TERM = ();	856	%$TERM = ();
588	}	857	}
589		858
590	$retval	859	$retval
591	}	860	}
592		861
593	# urxvt::term::proxy	862	# urxvt::term::extension
594		863
595	package urxvt::term::proxy;	864	package urxvt::term::extension;
596		865
597	sub enable {	866	sub enable {
598	my ($self, %hook) = @_;	867	my ($self, %hook) = @_;
599	my $pkg = $self->{_pkg};	868	my $pkg = $self->{_pkg};
600		869
601	while (my ($name, $cb) = each %hook) {	870	while (my ($name, $cb) = each %hook) {
602	my $htype = $HOOKTYPE{uc $name};	871	my $htype = $HOOKTYPE{uc $name};
603	defined $htype	872	defined $htype
604	or Carp::croak "unsupported hook type '$name'";	873	or Carp::croak "unsupported hook type '$name'";
605		874
		875	$self->set_should_invoke ($htype, +1)
606	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	876	unless exists $self->{term}{_hook}[$htype]{$pkg};
607	$hook_count[$htype]++
608	or urxvt::set_should_invoke $htype, 1;
609	}
610		877
611	$self->{term}{_hook}[$htype]{$pkg} = $cb;	878	$self->{term}{_hook}[$htype]{$pkg} = $cb;
612	}	879	}
613	}	880	}
614		881
…		…
619	for my $name (@hook) {	886	for my $name (@hook) {
620	my $htype = $HOOKTYPE{uc $name};	887	my $htype = $HOOKTYPE{uc $name};
621	defined $htype	888	defined $htype
622	or Carp::croak "unsupported hook type '$name'";	889	or Carp::croak "unsupported hook type '$name'";
623		890
		891	$self->set_should_invoke ($htype, -1)
624	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	892	if delete $self->{term}{_hook}[$htype]{$pkg};
625	--$hook_count[$htype]
626	or urxvt::set_should_invoke $htype, 0;
627	}
628	}	893	}
629	}	894	}
630		895
631	our $AUTOLOAD;	896	our $AUTOLOAD;
632		897
…		…
663		928
664	=head2 The C<urxvt::anyevent> Class	929	=head2 The C<urxvt::anyevent> Class
665		930
666	The sole purpose of this class is to deliver an interface to the	931	The sole purpose of this class is to deliver an interface to the
667	C<AnyEvent> module - any module using it will work inside urxvt without	932	C<AnyEvent> module - any module using it will work inside urxvt without
668	further work. The only exception is that you cannot wait on condition	933	further programming. The only exception is that you cannot wait on
669	variables, but non-blocking condvar use is ok. What this means is that you	934	condition variables, but non-blocking condvar use is ok. What this means
670	cannot use blocking APIs, but the non-blocking variant should work.	935	is that you cannot use blocking APIs, but the non-blocking variant should
		936	work.
671		937
672	=cut	938	=cut
673		939
674	our $VERSION = 1;	940	our $VERSION = 1;
675		941
…		…
737	# find on_xxx subs in the package and register them	1003	# find on_xxx subs in the package and register them
738	# as hooks	1004	# as hooks
739	sub register_package {	1005	sub register_package {
740	my ($self, $pkg, $argv) = @_;	1006	my ($self, $pkg, $argv) = @_;
741		1007
		1008	no strict 'refs';
		1009
		1010	urxvt::verbose 6, "register package $pkg to $self";
		1011
		1012	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1013
742	my $proxy = bless {	1014	my $proxy = bless {
743	_pkg => $pkg,	1015	_pkg => $pkg,
744	argv => $argv,	1016	argv => $argv,
745	}, $pkg;	1017	}, $pkg;
746	Scalar::Util::weaken ($proxy->{term} = $self);	1018	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
752	$proxy->enable ($name => $ref);	1024	$proxy->enable ($name => $ref);
753	}	1025	}
754	}	1026	}
755	}	1027	}
756		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
757	=item $term->destroy	1048	=item $term->destroy
758		1049
759	Destroy the terminal object (close the window, free resources etc.).	1050	Destroy the terminal object (close the window, free resources
		1051	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1052	watchers (timers, io watchers) are still active.
		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	}
760		1078
761	=item $isset = $term->option ($optval[, $set])	1079	=item $isset = $term->option ($optval[, $set])
762		1080
763	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
764	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
…		…
767	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
768	source file F</src/optinc.h> to see the actual list:	1086	source file F</src/optinc.h> to see the actual list:
769		1087
770	borderLess console cursorBlink cursorUnderline hold iconic insecure	1088	borderLess console cursorBlink cursorUnderline hold iconic insecure
771	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1089	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
772	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1090	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
773	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1091	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
774	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1092	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
775	tripleclickwords utmpInhibit visualBell	1093	transparent tripleclickwords utmpInhibit visualBell
776		1094
777	=item $value = $term->resource ($name[, $newval])	1095	=item $value = $term->resource ($name[, $newval])
778		1096
779	Returns the current resource value associated with a given name and	1097	Returns the current resource value associated with a given name and
780	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>
…		…
797		1115
798	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1116	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
799	borderLess color cursorBlink cursorUnderline cutchars delete_key	1117	borderLess color cursorBlink cursorUnderline cutchars delete_key
800	display_name embed ext_bwidth fade font geometry hold iconName	1118	display_name embed ext_bwidth fade font geometry hold iconName
801	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1119	imFont imLocale inputMethod insecure int_bwidth intensityStyles
802	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1120	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
803	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1121	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
804	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1122	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
805	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1123	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
806	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1124	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
807	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1125	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
808	shade term_name title transparent transparent_all tripleclickwords	1126	secondaryScreen secondaryScroll selectstyle shade term_name title
809	utmpInhibit visualBell	1127	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1128	visualBell
810		1129
811	=cut	1130	=cut
812		1131
813	sub resource($$;$) {	1132	sub resource($$;$) {
814	my ($self, $name) = (shift, shift);	1133	my ($self, $name) = (shift, shift);
815	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1134	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
816	&urxvt::term::_resource	1135	&urxvt::term::_resource
817	}	1136	}
818		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
819	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1149	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
820		1150
821	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
822	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1152	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
823		1153
…		…
838	=item ($row, $col) = $term->selection_end ([$row, $col])	1168	=item ($row, $col) = $term->selection_end ([$row, $col])
839		1169
840	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,
841	and optionally set them to new values.	1171	and optionally set them to new values.
842		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
843	=item $success = $term->selection_grab ($eventtime)	1180	=item $success = $term->selection_grab ($eventtime)
844		1181
845	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
846	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.
847		1185
848	=item $oldtext = $term->selection ([$newtext])	1186	=item $oldtext = $term->selection ([$newtext])
849		1187
850	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>.
851		1189
…		…
941		1279
942	=item $string = $term->locale_decode ($octets)	1280	=item $string = $term->locale_decode ($octets)
943		1281
944	Convert the given locale-encoded octets into a perl string.	1282	Convert the given locale-encoded octets into a perl string.
945		1283
		1284	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1285
		1286	XORs the rendition values in the given span with the provided value
		1287	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1288	refresh hooks to provide effects similar to the selection.
		1289
		1290	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1291
		1292	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1293	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1294	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
		1295	it instead. Both styles I<MUST NOT> contain font styles.
		1296
946	=item $term->scr_bell	1297	=item $term->scr_bell
947		1298
948	Ring the bell!	1299	Ring the bell!
949		1300
950	=item $term->scr_add_lines ($string)	1301	=item $term->scr_add_lines ($string)
…		…
956		1307
957	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
958	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
959	C<on_add_lines> hook, though.	1310	C<on_add_lines> hook, though.
960		1311
		1312	=item $term->scr_change_screen ($screen)
		1313
		1314	Switch to given screen - 0 primary, 1 secondary.
		1315
961	=item $term->cmd_parse ($octets)	1316	=item $term->cmd_parse ($octets)
962		1317
963	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
964	locale-specific encoding of the terminal and can contain command sequences	1319	locale-specific encoding of the terminal and can contain command sequences
965	(escape codes) that will be interpreted.	1320	(escape codes) that will be interpreted.
…		…
975	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
976	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
977	description of C<< urxvt::timer->events >>. Make sure to always restore	1332	description of C<< urxvt::timer->events >>. Make sure to always restore
978	the previous value.	1333	the previous value.
979		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
980	=item $windowid = $term->parent	1340	=item $windowid = $term->parent
981		1341
982	Return the window id of the toplevel window.	1342	Return the window id of the toplevel window.
983		1343
984	=item $windowid = $term->vt	1344	=item $windowid = $term->vt
985		1345
986	Return the window id of the terminal window.	1346	Return the window id of the terminal window.
987		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
988	=item $window_width = $term->width	1355	=item $window_width = $term->width
989		1356
990	=item $window_height = $term->height	1357	=item $window_height = $term->height
991		1358
992	=item $font_width = $term->fwidth	1359	=item $font_width = $term->fwidth
…		…
1005		1372
1006	=item $max_scrollback = $term->saveLines	1373	=item $max_scrollback = $term->saveLines
1007		1374
1008	=item $nrow_plus_saveLines = $term->total_rows	1375	=item $nrow_plus_saveLines = $term->total_rows
1009		1376
1010	=item $lines_in_scrollback = $term->nsaved	1377	=item $topmost_scrollback_row = $term->top_row
1011		1378
1012	Return various integers describing terminal characteristics.	1379	Return various integers describing terminal characteristics.
1013		1380
		1381	=item $x_display = $term->display_id
		1382
		1383	Return the DISPLAY used by rxvt-unicode.
		1384
1014	=item $lc_ctype = $term->locale	1385	=item $lc_ctype = $term->locale
1015		1386
1016	Returns the LC_CTYPE category string used by this rxvt-unicode.	1387	Returns the LC_CTYPE category string used by this rxvt-unicode.
1017		1388
1018	=item $x_display = $term->display_id	1389	=item $env = $term->env
1019		1390
1020	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	}
1021		1403
1022	=item $modifiermask = $term->ModLevel3Mask	1404	=item $modifiermask = $term->ModLevel3Mask
1023		1405
1024	=item $modifiermask = $term->ModMetaMask	1406	=item $modifiermask = $term->ModMetaMask
1025		1407
1026	=item $modifiermask = $term->ModNumLockMask	1408	=item $modifiermask = $term->ModNumLockMask
1027		1409
1028	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
1029	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.
1030		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
1031	=item $view_start = $term->view_start ([$newvalue])	1421	=item $view_start = $term->view_start ([$newvalue])
1032		1422
1033	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
1034	C<0>, which displays the normal terminal contents. Larger values scroll	1424	C<0>, which displays the normal terminal contents. Lower values scroll
1035	this many lines into the scrollback buffer.	1425	this many lines into the scrollback buffer.
1036		1426
1037	=item $term->want_refresh	1427	=item $term->want_refresh
1038		1428
1039	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1429	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1054	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
1055	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
1056	automatically be updated.	1446	automatically be updated.
1057		1447
1058	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
1059	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)
1060	(C<chr 65535>). Characters with combining characters and other characters	1450	characters. Characters with combining characters and other characters that
1061	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
1062	characters in the private use area.	1452	in the private use area.
1063		1453
1064	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
1065	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
1066	characters.	1456	characters.
1067		1457
…		…
1118	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.
1119		1509
1120	=item $offset = $line->offset_of ($row, $col)	1510	=item $offset = $line->offset_of ($row, $col)
1121		1511
1122	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
1123	line.	1513	line. Works for rows outside the line, too, and returns corresponding
		1514	offsets outside the string.
1124		1515
1125	=item ($row, $col) = $line->coord_of ($offset)	1516	=item ($row, $col) = $line->coord_of ($offset)
1126		1517
1127	Translates a string offset into terminal coordinates again.	1518	Translates a string offset into terminal coordinates again.
1128		1519
…		…
1241		1632
1242	Calls XUngrab for the most recent grab. Is called automatically on	1633	Calls XUngrab for the most recent grab. Is called automatically on
1243	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
1244	the session.	1635	the session.
1245		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
1246	=back	1667	=back
1247		1668
1248	=cut	1669	=cut
1249		1670
1250	package urxvt::popup;	1671	package urxvt::popup;
…		…
1264		1685
1265	$item->{render} ||= sub { $_[0]{text} };	1686	$item->{render} ||= sub { $_[0]{text} };
1266		1687
1267	push @{ $self->{item} }, $item;	1688	push @{ $self->{item} }, $item;
1268	}	1689	}
		1690
		1691	=item $popup->add_title ($title)
		1692
		1693	Adds a non-clickable title to the popup.
		1694
		1695	=cut
		1696
		1697	sub add_title {
		1698	my ($self, $title) = @_;
		1699
		1700	$self->add_item ({
		1701	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1702	text => $title,
		1703	activate => sub { },
		1704	});
		1705	}
		1706
		1707	=item $popup->add_separator ([$sepchr])
		1708
		1709	Creates a separator, optionally using the character given as C<$sepchr>.
		1710
		1711	=cut
1269		1712
1270	sub add_separator {	1713	sub add_separator {
1271	my ($self, $sep) = @_;	1714	my ($self, $sep) = @_;
1272		1715
1273	$sep ||= "=";	1716	$sep ||= "=";
…		…
1278	render => sub { $sep x $self->{term}->ncol },	1721	render => sub { $sep x $self->{term}->ncol },
1279	activate => sub { },	1722	activate => sub { },
1280	});	1723	});
1281	}	1724	}
1282		1725
1283	sub add_title {	1726	=item $popup->add_button ($text, $cb)
1284	my ($self, $title) = @_;
1285		1727
1286	$self->add_item ({	1728	Adds a clickable button to the popup. C<$cb> is called whenever it is
1287	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1729	selected.
1288	text => $title,	1730
1289	activate => sub { },	1731	=cut
1290	});
1291	}
1292		1732
1293	sub add_button {	1733	sub add_button {
1294	my ($self, $text, $cb) = @_;	1734	my ($self, $text, $cb) = @_;
1295		1735
1296	$self->add_item ({ type => "button", text => $text, activate => $cb});	1736	$self->add_item ({ type => "button", text => $text, activate => $cb});
1297	}	1737	}
		1738
		1739	=item $popup->add_toggle ($text, $cb, $initial_value)
		1740
		1741	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1742	whenever it gets toggled, with a boolean indicating its value as its first
		1743	argument.
		1744
		1745	=cut
1298		1746
1299	sub add_toggle {	1747	sub add_toggle {
1300	my ($self, $text, $cb, $value) = @_;	1748	my ($self, $text, $cb, $value) = @_;
1301		1749
1302	my $item; $item = {	1750	my $item; $item = {
1303	type => "button",	1751	type => "button",
1304	text => " $text",	1752	text => " $text",
1305	value => $value,	1753	value => $value,
1306	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1754	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1307	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1755	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1308	};	1756	};
1309		1757
1310	$self->add_item ($item);	1758	$self->add_item ($item);
1311	}	1759	}
		1760
		1761	=item $popup->show
		1762
		1763	Displays the popup (which is initially hidden).
		1764
		1765	=cut
1312		1766
1313	sub show {	1767	sub show {
1314	my ($self) = @_;	1768	my ($self) = @_;
1315		1769
1316	local $urxvt::popup::self = $self;	1770	local $urxvt::popup::self = $self;
1317		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};
1318	local $ENV{LC_ALL} = $self->{term}->locale;	1775	$env->{LC_CTYPE} = $self->{term}->locale;
1319		1776
1320	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",
1321	"--transient-for" => $self->{term}->parent,	1781	"--transient-for" => $self->{term}->parent,
1322	"-display" => $self->{term}->display_id,	1782	"-display" => $self->{term}->display_id,
1323	"-pe" => "urxvt-popup")	1783	"-pe" => "urxvt-popup")
1324	or die "unable to create popup window\n";	1784	or die "unable to create popup window\n";
1325	}	1785	}
1326		1786
1327	sub DESTROY {	1787	sub DESTROY {
1328	my ($self) = @_;	1788	my ($self) = @_;
1329		1789
1330	delete $self->{term}{_destroy}{$self};	1790	delete $self->{term}{_destroy}{$self};
1331	$self->{term}->ungrab;	1791	$self->{term}->ungrab;
1332	}	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__;
1333		1804
1334	=head2 The C<urxvt::timer> Class	1805	=head2 The C<urxvt::timer> Class
1335		1806
1336	This class implements timer watchers/events. Time is represented as a	1807	This class implements timer watchers/events. Time is represented as a
1337	fractional number of seconds since the epoch. Example:	1808	fractional number of seconds since the epoch. Example:
…		…
1375	Start the timer.	1846	Start the timer.
1376		1847
1377	=item $timer = $timer->start ($tstamp)	1848	=item $timer = $timer->start ($tstamp)
1378		1849
1379	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>.
1380		1855
1381	=item $timer = $timer->stop	1856	=item $timer = $timer->stop
1382		1857
1383	Stop the timer.	1858	Stop the timer.
1384		1859
…		…
1431		1906
1432	Stop watching for events on the given filehandle.	1907	Stop watching for events on the given filehandle.
1433		1908
1434	=back	1909	=back
1435		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
1436	=head1 ENVIRONMENT	1972	=head1 ENVIRONMENT
1437		1973
1438	=head2 URXVT_PERL_VERBOSITY	1974	=head2 URXVT_PERL_VERBOSITY
1439		1975
1440	This variable controls the verbosity level of the perl extension. Higher	1976	This variable controls the verbosity level of the perl extension. Higher
…		…
1444		1980
1445	=item == 0 - fatal messages	1981	=item == 0 - fatal messages
1446		1982
1447	=item >= 3 - script loading and management	1983	=item >= 3 - script loading and management
1448		1984
1449	=item >=10 - all events received	1985	=item >=10 - all called hooks
		1986
		1987	=item >=11 - hook reutrn values
1450		1988
1451	=back	1989	=back
1452		1990
1453	=head1 AUTHOR	1991	=head1 AUTHOR
1454		1992

Diff Legend

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