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

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

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

Diff Legend

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

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

Diff Legend

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