[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.126 by root, Tue Jan 24 19:14:36 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, before doing anything
		376	yet. If this hook returns true, then destruction is skipped, but this is
		377	rarely a good idea.
193		378
194	=item on_reset $term	379	=item on_reset $term
195		380
196	Called after the screen is "reset" for any reason, such as resizing or	381	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	382	control sequences. Here is where you can react on changes to size-related
198	variables.	383	variables.
199		384
200	=item on_start $term	385	=item on_child_start $term, $pid
201		386
202	Called at the very end of initialisation of a new terminal, just before	387	Called just after the child process has been C<fork>ed.
203	returning to the mainloop.	388
		389	=item on_child_exit $term, $status
		390
		391	Called just after the child process has exited. C<$status> is the status
		392	from C<waitpid>.
204		393
205	=item on_sel_make $term, $eventtime	394	=item on_sel_make $term, $eventtime
206		395
207	Called whenever a selection has been made by the user, but before the	396	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	397	selection text is copied, so changes to the beginning, end or type of the
…		…
222	=item on_sel_extend $term	411	=item on_sel_extend $term
223		412
224	Called whenever the user tries to extend the selection (e.g. with a double	413	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	414	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	415	should extend the selection itelf and return true to suppress the built-in
227	processing.	416	processing. This can happen multiple times, as long as the callback
		417	returns true, it will be called on every further click by the user and is
		418	supposed to enlarge the selection more and more, if possible.
228		419
229	See the F<selection> example extension.	420	See the F<selection> example extension.
230		421
231	=item on_view_change $term, $offset	422	=item on_view_change $term, $offset
232		423
…		…
263	can filter/change and output the text yourself by returning a true value	454	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	455	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	456	might be very slow, however, as your hook is called for B<all> text being
266	output.	457	output.
267		458
		459	=item on_tt_write $term, $octets
		460
		461	Called whenever some data is written to the tty/pty and can be used to
		462	suppress or filter tty input.
		463
268	=item on_line_update $term, $row	464	=item on_line_update $term, $row
269		465
270	Called whenever a line was updated or changed. Can be used to filter	466	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	467	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,	468	that are being shown will be filtered, and, due to performance reasons,
…		…
294		490
295	Called whenever the user presses a key combination that has a	491	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>	492	C<perl:string> action bound to it (see description of the B<keysym>
297	resource in the @@RXVT_NAME@@(1) manpage).	493	resource in the @@RXVT_NAME@@(1) manpage).
298		494
		495	=item on_x_event $term, $event
		496
		497	Called on every X event received on the vt window (and possibly other
		498	windows). Should only be used as a last resort. Most event structure
		499	members are not passed.
		500
299	=item on_focus_in $term	501	=item on_focus_in $term
300		502
301	Called whenever the window gets the keyboard focus, before rxvt-unicode	503	Called whenever the window gets the keyboard focus, before rxvt-unicode
302	does focus in processing.	504	does focus in processing.
303		505
304	=item on_focus_out $term	506	=item on_focus_out $term
305		507
306	Called wheneever the window loses keyboard focus, before rxvt-unicode does	508	Called wheneever the window loses keyboard focus, before rxvt-unicode does
307	focus out processing.	509	focus out processing.
308		510
		511	=item on_configure_notify $term, $event
		512
		513	=item on_property_notify $term, $event
		514
309	=item on_key_press $term, $event, $keysym, $octets	515	=item on_key_press $term, $event, $keysym, $octets
310		516
311	=item on_key_release $term, $event, $keysym	517	=item on_key_release $term, $event, $keysym
312		518
313	=item on_button_press $term, $event	519	=item on_button_press $term, $event
…		…
322		528
323	Called whenever the corresponding X event is received for the terminal If	529	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.	530	the hook returns true, then the even will be ignored by rxvt-unicode.
325		531
326	The event is a hash with most values as named by Xlib (see the XEvent	532	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	533	manpage), with the additional members C<row> and C<col>, which are the
328	and column under the mouse cursor.	534	(real, not screen-based) row and column under the mouse cursor.
329		535
330	C<on_key_press> additionally receives the string rxvt-unicode would	536	C<on_key_press> additionally receives the string rxvt-unicode would
331	output, if any, in locale-specific encoding.	537	output, if any, in locale-specific encoding.
332		538
333	subwindow.	539	subwindow.
334		540
335	=back	541	=item on_client_message $term, $event
336		542
337	=head2 Variables in the C<urxvt> Package	543	=item on_wm_protocols $term, $event
338		544
339	=over 4	545	=item on_wm_delete_window $term, $event
340		546
341	=item $urxvt::TERM	547	Called when various types of ClientMessage events are received (all with
342		548	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		549
445	=back	550	=back
446		551
447	=cut	552	=cut
448		553
…		…
454	use Scalar::Util ();	559	use Scalar::Util ();
455	use List::Util ();	560	use List::Util ();
456		561
457	our $VERSION = 1;	562	our $VERSION = 1;
458	our $TERM;	563	our $TERM;
		564	our @TERM_INIT;
		565	our @TERM_EXT;
459	our @HOOKNAME;	566	our @HOOKNAME;
460	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	567	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
461	our %OPTION;	568	our %OPTION;
		569
462	our $LIBDIR;	570	our $LIBDIR;
		571	our $RESNAME;
		572	our $RESCLASS;
		573	our $RXVTNAME;
		574
		575	our $NOCHAR = chr 0xffff;
		576
		577	=head2 Variables in the C<urxvt> Package
		578
		579	=over 4
		580
		581	=item $urxvt::LIBDIR
		582
		583	The rxvt-unicode library directory, where, among other things, the perl
		584	modules and scripts are stored.
		585
		586	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		587
		588	The resource class and name rxvt-unicode uses to look up X resources.
		589
		590	=item $urxvt::RXVTNAME
		591
		592	The basename of the installed binaries, usually C<urxvt>.
		593
		594	=item $urxvt::TERM
		595
		596	The current terminal. This variable stores the current C<urxvt::term>
		597	object, whenever a callback/hook is executing.
		598
		599	=item @urxvt::TERM_INIT
		600
		601	All coderefs in this array will be called as methods of the next newly
		602	created C<urxvt::term> object (during the C<on_init> phase). The array
		603	gets cleared before the codereferences that were in it are being executed,
		604	so coderefs can push themselves onto it again if they so desire.
		605
		606	This complements to the perl-eval commandline option, but gets executed
		607	first.
		608
		609	=item @urxvt::TERM_EXT
		610
		611	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		612	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		613	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		614
		615	=back
		616
		617	=head2 Functions in the C<urxvt> Package
		618
		619	=over 4
		620
		621	=item urxvt::fatal $errormessage
		622
		623	Fatally aborts execution with the given error message. Avoid at all
		624	costs! The only time this is acceptable is when the terminal process
		625	starts up.
		626
		627	=item urxvt::warn $string
		628
		629	Calls C<rxvt_warn> with the given string which should not include a
		630	newline. The module also overwrites the C<warn> builtin with a function
		631	that calls this function.
		632
		633	Using this function has the advantage that its output ends up in the
		634	correct place, e.g. on stderr of the connecting urxvtc client.
		635
		636	Messages have a size limit of 1023 bytes currently.
		637
		638	=item $time = urxvt::NOW
		639
		640	Returns the "current time" (as per the event loop).
		641
		642	=item urxvt::CurrentTime
		643
		644	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		645	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		646	Button4Mask, Button5Mask, AnyModifier
		647
		648	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		649	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		650	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		651	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		652	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		653	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		654	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		655
		656	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		657	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		658	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		659	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		660	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		661	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		662	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		663
		664	Various constants for use in X calls and event processing.
		665
		666	=back
		667
		668	=head2 RENDITION
		669
		670	Rendition bitsets contain information about colour, font, font styles and
		671	similar information for each screen cell.
		672
		673	The following "macros" deal with changes in rendition sets. You should
		674	never just create a bitset, you should always modify an existing one,
		675	as they contain important information required for correct operation of
		676	rxvt-unicode.
		677
		678	=over 4
		679
		680	=item $rend = urxvt::DEFAULT_RSTYLE
		681
		682	Returns the default rendition, as used when the terminal is starting up or
		683	being reset. Useful as a base to start when creating renditions.
		684
		685	=item $rend = urxvt::OVERLAY_RSTYLE
		686
		687	Return the rendition mask used for overlays by default.
		688
		689	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		690
		691	Return the bit that enabled bold, italic, blink, reverse-video and
		692	underline, respectively. To enable such a style, just logically OR it into
		693	the bitset.
		694
		695	=item $foreground = urxvt::GET_BASEFG $rend
		696
		697	=item $background = urxvt::GET_BASEBG $rend
		698
		699	Return the foreground/background colour index, respectively.
		700
		701	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		702
		703	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		704
		705	Replace the foreground/background colour in the rendition mask with the
		706	specified one.
		707
		708	=item $value = urxvt::GET_CUSTOM $rend
		709
		710	Return the "custom" value: Every rendition has 5 bits for use by
		711	extensions. They can be set and changed as you like and are initially
		712	zero.
		713
		714	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		715
		716	Change the custom value.
		717
		718	=back
		719
		720	=cut
463		721
464	BEGIN {	722	BEGIN {
465	urxvt->bootstrap;
466
467	# overwrite perl's warn	723	# overwrite perl's warn
468	*CORE::GLOBAL::warn = sub {	724	*CORE::GLOBAL::warn = sub {
469	my $msg = join "", @_;	725	my $msg = join "", @_;
470	$msg .= "\n"	726	$msg .= "\n"
471	unless $msg =~ /\n$/;	727	unless $msg =~ /\n$/;
472	urxvt::warn ($msg);	728	urxvt::warn ($msg);
473	};	729	};
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	}	730	}
480		731
481	my @hook_count;	732	no warnings 'utf8';
		733
482	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	734	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
483		735
484	sub verbose {	736	sub verbose {
485	my ($level, $msg) = @_;	737	my ($level, $msg) = @_;
486	warn "$msg\n" if $level <= $verbosity;	738	warn "$msg\n" if $level <= $verbosity;
487	}	739	}
488		740
489	my $extension_pkg = "extension0000";
490	my %extension_pkg;	741	my %extension_pkg;
491		742
492	# load a single script into its own package, once only	743	# load a single script into its own package, once only
493	sub extension_package($) {	744	sub extension_package($) {
494	my ($path) = @_;	745	my ($path) = @_;
495		746
496	$extension_pkg{$path} \|\|= do {	747	$extension_pkg{$path} \|\|= do {
497	my $pkg = "urxvt::" . ($extension_pkg++);	748	$path =~ /([^\/\\]+)$/;
		749	my $pkg = $1;
		750	$pkg =~ s/[^[:word:]]/_/g;
		751	$pkg = "urxvt::ext::$pkg";
498		752
499	verbose 3, "loading extension '$path' into package '$pkg'";	753	verbose 3, "loading extension '$path' into package '$pkg'";
500		754
501	open my $fh, "<:raw", $path	755	open my $fh, "<:raw", $path
502	or die "$path: $!";	756	or die "$path: $!";
503		757
504	my $source = untaint	758	my $source =
505	"package $pkg; use strict; use utf8;\n"	759	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
506	. "use base urxvt::term::extension::;\n"
507	. "#line 1 \"$path\"\n{\n"	760	. "#line 1 \"$path\"\n{\n"
508	. (do { local $/; <$fh> })	761	. (do { local $/; <$fh> })
509	. "\n};\n1";	762	. "\n};\n1";
510		763
511	eval $source	764	eval $source
…		…
525	if ($htype == 0) { # INIT	778	if ($htype == 0) { # INIT
526	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	779	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
527		780
528	my %ext_arg;	781	my %ext_arg;
529		782
		783	{
		784	my @init = @TERM_INIT;
		785	@TERM_INIT = ();
		786	$_->($TERM) for @init;
		787	my @pkg = @TERM_EXT;
		788	@TERM_EXT = ();
		789	$TERM->register_package ($_) for @pkg;
		790	}
		791
530	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	792	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
531	if ($_ eq "default") {	793	if ($_ eq "default") {
532	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	794	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
533	} elsif (/^-(.*)$/) {	795	} elsif (/^-(.*)$/) {
534	delete $ext_arg{$1};	796	delete $ext_arg{$1};
535	} elsif (/^([^<]+)<(.*)>$/) {	797	} elsif (/^([^<]+)<(.*)>$/) {
536	push @{ $ext_arg{$1} }, $2;	798	push @{ $ext_arg{$1} }, $2;
537	} else {	799	} else {
…		…
560	if $verbosity >= 10;	822	if $verbosity >= 10;
561		823
562	keys %$cb;	824	keys %$cb;
563		825
564	while (my ($pkg, $cb) = each %$cb) {	826	while (my ($pkg, $cb) = each %$cb) {
565	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	827	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
566	and last;	828	$retval \|\|= $retval_;
567		829
568	if ($@) {	830	if ($@) {
569	$TERM->ungrab; # better to lose the grab than the session	831	$TERM->ungrab; # better to lose the grab than the session
570	warn $@;	832	warn $@;
571	}	833	}
572	}	834	}
		835
		836	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		837	if $verbosity >= 11;
573	}	838	}
574		839
575	if ($htype == 1) { # DESTROY	840	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	841	# clear package objects
584	%$_ = () for values %{ $TERM->{_pkg} };	842	%$_ = () for values %{ $TERM->{_pkg} };
585		843
586	# clear package	844	# clear package
587	%$TERM = ();	845	%$TERM = ();
…		…
601	while (my ($name, $cb) = each %hook) {	859	while (my ($name, $cb) = each %hook) {
602	my $htype = $HOOKTYPE{uc $name};	860	my $htype = $HOOKTYPE{uc $name};
603	defined $htype	861	defined $htype
604	or Carp::croak "unsupported hook type '$name'";	862	or Carp::croak "unsupported hook type '$name'";
605		863
		864	$self->set_should_invoke ($htype, +1)
606	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	865	unless exists $self->{term}{_hook}[$htype]{$pkg};
607	$hook_count[$htype]++
608	or urxvt::set_should_invoke $htype, 1;
609	}
610		866
611	$self->{term}{_hook}[$htype]{$pkg} = $cb;	867	$self->{term}{_hook}[$htype]{$pkg} = $cb;
612	}	868	}
613	}	869	}
614		870
…		…
619	for my $name (@hook) {	875	for my $name (@hook) {
620	my $htype = $HOOKTYPE{uc $name};	876	my $htype = $HOOKTYPE{uc $name};
621	defined $htype	877	defined $htype
622	or Carp::croak "unsupported hook type '$name'";	878	or Carp::croak "unsupported hook type '$name'";
623		879
		880	$self->set_should_invoke ($htype, -1)
624	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	881	if delete $self->{term}{_hook}[$htype]{$pkg};
625	--$hook_count[$htype]
626	or urxvt::set_should_invoke $htype, 0;
627	}
628	}	882	}
629	}	883	}
630		884
631	our $AUTOLOAD;	885	our $AUTOLOAD;
632		886
…		…
663		917
664	=head2 The C<urxvt::anyevent> Class	918	=head2 The C<urxvt::anyevent> Class
665		919
666	The sole purpose of this class is to deliver an interface to the	920	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	921	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	922	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	923	condition variables, but non-blocking condvar use is ok. What this means
670	cannot use blocking APIs, but the non-blocking variant should work.	924	is that you cannot use blocking APIs, but the non-blocking variant should
		925	work.
671		926
672	=cut	927	=cut
673		928
674	our $VERSION = 1;	929	our $VERSION = 1;
675		930
…		…
737	# find on_xxx subs in the package and register them	992	# find on_xxx subs in the package and register them
738	# as hooks	993	# as hooks
739	sub register_package {	994	sub register_package {
740	my ($self, $pkg, $argv) = @_;	995	my ($self, $pkg, $argv) = @_;
741		996
		997	no strict 'refs';
		998
		999	urxvt::verbose 6, "register package $pkg to $self";
		1000
		1001	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1002
742	my $proxy = bless {	1003	my $proxy = bless {
743	_pkg => $pkg,	1004	_pkg => $pkg,
744	argv => $argv,	1005	argv => $argv,
745	}, $pkg;	1006	}, $pkg;
746	Scalar::Util::weaken ($proxy->{term} = $self);	1007	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
752	$proxy->enable ($name => $ref);	1013	$proxy->enable ($name => $ref);
753	}	1014	}
754	}	1015	}
755	}	1016	}
756		1017
		1018	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1019
		1020	Creates a new terminal, very similar as if you had started it with system
		1021	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1022	hash which defines the environment of the new terminal.
		1023
		1024	Croaks (and probably outputs an error message) if the new instance
		1025	couldn't be created. Returns C<undef> if the new instance didn't
		1026	initialise perl, and the terminal object otherwise. The C<init> and
		1027	C<start> hooks will be called during this call.
		1028
		1029	=cut
		1030
		1031	sub new {
		1032	my ($class, $env, @args) = @_;
		1033
		1034	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		1035	}
		1036
757	=item $term->destroy	1037	=item $term->destroy
758		1038
759	Destroy the terminal object (close the window, free resources etc.).	1039	Destroy the terminal object (close the window, free resources
		1040	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1041	watchers (timers, io watchers) are still active.
		1042
		1043	=item $term->exec_async ($cmd[, @args])
		1044
		1045	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1046	("starts") programs in the background. This function takes care of setting
		1047	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1048	be preferred over explicit calls to C<exec> or C<system>.
		1049
		1050	Returns the pid of the subprocess or C<undef> on error.
		1051
		1052	=cut
		1053
		1054	sub exec_async {
		1055	my $self = shift;
		1056
		1057	my $pid = fork;
		1058
		1059	return $pid
		1060	if !defined $pid or $pid;
		1061
		1062	%ENV = %{ $self->env };
		1063
		1064	exec @_;
		1065	urxvt::_exit 255;
		1066	}
760		1067
761	=item $isset = $term->option ($optval[, $set])	1068	=item $isset = $term->option ($optval[, $set])
762		1069
763	Returns true if the option specified by C<$optval> is enabled, and	1070	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	1071	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	1074	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:	1075	source file F</src/optinc.h> to see the actual list:
769		1076
770	borderLess console cursorBlink cursorUnderline hold iconic insecure	1077	borderLess console cursorBlink cursorUnderline hold iconic insecure
771	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1078	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
772	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1079	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
773	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1080	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
774	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1081	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
775	tripleclickwords utmpInhibit visualBell	1082	transparent tripleclickwords utmpInhibit visualBell
776		1083
777	=item $value = $term->resource ($name[, $newval])	1084	=item $value = $term->resource ($name[, $newval])
778		1085
779	Returns the current resource value associated with a given name and	1086	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>	1087	optionally sets a new value. Setting values is most useful in the C<init>
…		…
797		1104
798	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1105	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
799	borderLess color cursorBlink cursorUnderline cutchars delete_key	1106	borderLess color cursorBlink cursorUnderline cutchars delete_key
800	display_name embed ext_bwidth fade font geometry hold iconName	1107	display_name embed ext_bwidth fade font geometry hold iconName
801	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1108	imFont imLocale inputMethod insecure int_bwidth intensityStyles
802	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1109	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
803	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1110	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
804	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1111	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
805	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1112	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
806	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1113	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
807	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1114	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
808	shade term_name title transparent transparent_all tripleclickwords	1115	secondaryScreen secondaryScroll selectstyle shade term_name title
809	utmpInhibit visualBell	1116	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1117	visualBell
810		1118
811	=cut	1119	=cut
812		1120
813	sub resource($$;$) {	1121	sub resource($$;$) {
814	my ($self, $name) = (shift, shift);	1122	my ($self, $name) = (shift, shift);
815	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1123	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
816	&urxvt::term::_resource	1124	&urxvt::term::_resource
817	}	1125	}
818		1126
		1127	=item $value = $term->x_resource ($pattern)
		1128
		1129	Returns the X-Resource for the given pattern, excluding the program or
		1130	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1131	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1132	resource with that pattern exists.
		1133
		1134	This method should only be called during the C<on_start> hook, as there is
		1135	only one resource database per display, and later invocations might return
		1136	the wrong resources.
		1137
819	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1138	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
820		1139
821	Adds a keymap translation exactly as specified via a resource. See the	1140	Adds a keymap translation exactly as specified via a resource. See the
822	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1141	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
823		1142
…		…
838	=item ($row, $col) = $term->selection_end ([$row, $col])	1157	=item ($row, $col) = $term->selection_end ([$row, $col])
839		1158
840	Return the current values of the selection mark, begin or end positions,	1159	Return the current values of the selection mark, begin or end positions,
841	and optionally set them to new values.	1160	and optionally set them to new values.
842		1161
		1162	=item $term->selection_make ($eventtime[, $rectangular])
		1163
		1164	Tries to make a selection as set by C<selection_beg> and
		1165	C<selection_end>. If C<$rectangular> is true (default: false), a
		1166	rectangular selection will be made. This is the prefered function to make
		1167	a selection.
		1168
843	=item $success = $term->selection_grab ($eventtime)	1169	=item $success = $term->selection_grab ($eventtime)
844		1170
845	Try to request the primary selection from the server (for example, as set	1171	Try to request the primary selection text from the server (for example, as
846	by the next method).	1172	set by the next method). No visual feedback will be given. This function
		1173	is mostly useful from within C<on_sel_grab> hooks.
847		1174
848	=item $oldtext = $term->selection ([$newtext])	1175	=item $oldtext = $term->selection ([$newtext])
849		1176
850	Return the current selection text and optionally replace it by C<$newtext>.	1177	Return the current selection text and optionally replace it by C<$newtext>.
851		1178
…		…
944	Convert the given locale-encoded octets into a perl string.	1271	Convert the given locale-encoded octets into a perl string.
945		1272
946	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1273	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
947		1274
948	XORs the rendition values in the given span with the provided value	1275	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	1276	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
950	to the selection.	1277	refresh hooks to provide effects similar to the selection.
951		1278
952	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1279	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
953		1280
954	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1281	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
955	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1282	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	1283	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
957	it instead.	1284	it instead. Both styles I<MUST NOT> contain font styles.
958		1285
959	=item $term->scr_bell	1286	=item $term->scr_bell
960		1287
961	Ring the bell!	1288	Ring the bell!
962		1289
…		…
969		1296
970	Normally its not a good idea to use this function, as programs might be	1297	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	1298	confused by changes in cursor position or scrolling. Its useful inside a
972	C<on_add_lines> hook, though.	1299	C<on_add_lines> hook, though.
973		1300
		1301	=item $term->scr_change_screen ($screen)
		1302
		1303	Switch to given screen - 0 primary, 1 secondary.
		1304
974	=item $term->cmd_parse ($octets)	1305	=item $term->cmd_parse ($octets)
975		1306
976	Similar to C<scr_add_lines>, but the argument must be in the	1307	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	1308	locale-specific encoding of the terminal and can contain command sequences
978	(escape codes) that will be interpreted.	1309	(escape codes) that will be interpreted.
…		…
988	Replaces the event mask of the pty watcher by the given event mask. Can	1319	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	1320	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	1321	description of C<< urxvt::timer->events >>. Make sure to always restore
991	the previous value.	1322	the previous value.
992		1323
		1324	=item $fd = $term->pty_fd
		1325
		1326	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1327	is used.
		1328
993	=item $windowid = $term->parent	1329	=item $windowid = $term->parent
994		1330
995	Return the window id of the toplevel window.	1331	Return the window id of the toplevel window.
996		1332
997	=item $windowid = $term->vt	1333	=item $windowid = $term->vt
998		1334
999	Return the window id of the terminal window.	1335	Return the window id of the terminal window.
1000		1336
		1337	=item $term->vt_emask_add ($x_event_mask)
		1338
		1339	Adds the specified events to the vt event mask. Useful e.g. when you want
		1340	to receive pointer events all the times:
		1341
		1342	$term->vt_emask_add (urxvt::PointerMotionMask);
		1343
1001	=item $window_width = $term->width	1344	=item $window_width = $term->width
1002		1345
1003	=item $window_height = $term->height	1346	=item $window_height = $term->height
1004		1347
1005	=item $font_width = $term->fwidth	1348	=item $font_width = $term->fwidth
…		…
1018		1361
1019	=item $max_scrollback = $term->saveLines	1362	=item $max_scrollback = $term->saveLines
1020		1363
1021	=item $nrow_plus_saveLines = $term->total_rows	1364	=item $nrow_plus_saveLines = $term->total_rows
1022		1365
1023	=item $lines_in_scrollback = $term->nsaved	1366	=item $topmost_scrollback_row = $term->top_row
1024		1367
1025	Return various integers describing terminal characteristics.	1368	Return various integers describing terminal characteristics.
1026		1369
		1370	=item $x_display = $term->display_id
		1371
		1372	Return the DISPLAY used by rxvt-unicode.
		1373
1027	=item $lc_ctype = $term->locale	1374	=item $lc_ctype = $term->locale
1028		1375
1029	Returns the LC_CTYPE category string used by this rxvt-unicode.	1376	Returns the LC_CTYPE category string used by this rxvt-unicode.
1030		1377
1031	=item $x_display = $term->display_id	1378	=item $env = $term->env
1032		1379
1033	Return the DISPLAY used by rxvt-unicode.	1380	Returns a copy of the environment in effect for the terminal as a hashref
		1381	similar to C<\%ENV>.
		1382
		1383	=cut
		1384
		1385	sub env {
		1386	if (my $env = $_[0]->_env) {
		1387	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1388	} else {
		1389	+{ %ENV }
		1390	}
		1391	}
1034		1392
1035	=item $modifiermask = $term->ModLevel3Mask	1393	=item $modifiermask = $term->ModLevel3Mask
1036		1394
1037	=item $modifiermask = $term->ModMetaMask	1395	=item $modifiermask = $term->ModMetaMask
1038		1396
1039	=item $modifiermask = $term->ModNumLockMask	1397	=item $modifiermask = $term->ModNumLockMask
1040		1398
1041	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1399	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.	1400	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1043		1401
		1402	=item $screen = $term->current_screen
		1403
		1404	Returns the currently displayed screen (0 primary, 1 secondary).
		1405
		1406	=item $cursor_is_hidden = $term->hidden_cursor
		1407
		1408	Returns wether the cursor is currently hidden or not.
		1409
1044	=item $view_start = $term->view_start ([$newvalue])	1410	=item $view_start = $term->view_start ([$newvalue])
1045		1411
1046	Returns the negative row number of the topmost line. Minimum value is	1412	Returns the row number of the topmost displayed line. Maximum value is
1047	C<0>, which displays the normal terminal contents. Larger values scroll	1413	C<0>, which displays the normal terminal contents. Lower values scroll
1048	this many lines into the scrollback buffer.	1414	this many lines into the scrollback buffer.
1049		1415
1050	=item $term->want_refresh	1416	=item $term->want_refresh
1051		1417
1052	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1418	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	1433	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	1434	to replace only parts of a line. The font index in the rendition will
1069	automatically be updated.	1435	automatically be updated.
1070		1436
1071	C<$text> is in a special encoding: tabs and wide characters that use more	1437	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	1438	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1073	(C<chr 65535>). Characters with combining characters and other characters	1439	characters. Characters with combining characters and other characters that
1074	that do not fit into the normal tetx encoding will be replaced with	1440	do not fit into the normal tetx encoding will be replaced with characters
1075	characters in the private use area.	1441	in the private use area.
1076		1442
1077	You have to obey this encoding when changing text. The advantage is	1443	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	1444	that C<substr> and similar functions work on screen cells and not on
1079	characters.	1445	characters.
1080		1446
…		…
1131	Return the row number of the first/last row of the line, respectively.	1497	Return the row number of the first/last row of the line, respectively.
1132		1498
1133	=item $offset = $line->offset_of ($row, $col)	1499	=item $offset = $line->offset_of ($row, $col)
1134		1500
1135	Returns the character offset of the given row\|col pair within the logical	1501	Returns the character offset of the given row\|col pair within the logical
1136	line.	1502	line. Works for rows outside the line, too, and returns corresponding
		1503	offsets outside the string.
1137		1504
1138	=item ($row, $col) = $line->coord_of ($offset)	1505	=item ($row, $col) = $line->coord_of ($offset)
1139		1506
1140	Translates a string offset into terminal coordinates again.	1507	Translates a string offset into terminal coordinates again.
1141		1508
…		…
1254		1621
1255	Calls XUngrab for the most recent grab. Is called automatically on	1622	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	1623	evaluation errors, as it is better to lose the grab in the error case as
1257	the session.	1624	the session.
1258		1625
		1626	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1627
		1628	=item $atom_name = $term->XGetAtomName ($atom)
		1629
		1630	=item @atoms = $term->XListProperties ($window)
		1631
		1632	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1633
		1634	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1635
		1636	=item $term->XDeleteProperty ($window, $property)
		1637
		1638	=item $window = $term->DefaultRootWindow
		1639
		1640	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1641
		1642	=item $term->XMapWindow ($window)
		1643
		1644	=item $term->XUnmapWindow ($window)
		1645
		1646	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1647
		1648	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1649
		1650	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1651
		1652	Various X or X-related functions. The C<$term> object only serves as
		1653	the source of the display, otherwise those functions map more-or-less
		1654	directory onto the X functions of the same name.
		1655
1259	=back	1656	=back
1260		1657
1261	=cut	1658	=cut
1262		1659
1263	package urxvt::popup;	1660	package urxvt::popup;
…		…
1277		1674
1278	$item->{render} \|\|= sub { $_[0]{text} };	1675	$item->{render} \|\|= sub { $_[0]{text} };
1279		1676
1280	push @{ $self->{item} }, $item;	1677	push @{ $self->{item} }, $item;
1281	}	1678	}
		1679
		1680	=item $popup->add_title ($title)
		1681
		1682	Adds a non-clickable title to the popup.
		1683
		1684	=cut
		1685
		1686	sub add_title {
		1687	my ($self, $title) = @_;
		1688
		1689	$self->add_item ({
		1690	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1691	text => $title,
		1692	activate => sub { },
		1693	});
		1694	}
		1695
		1696	=item $popup->add_separator ([$sepchr])
		1697
		1698	Creates a separator, optionally using the character given as C<$sepchr>.
		1699
		1700	=cut
1282		1701
1283	sub add_separator {	1702	sub add_separator {
1284	my ($self, $sep) = @_;	1703	my ($self, $sep) = @_;
1285		1704
1286	$sep \|\|= "=";	1705	$sep \|\|= "=";
…		…
1291	render => sub { $sep x $self->{term}->ncol },	1710	render => sub { $sep x $self->{term}->ncol },
1292	activate => sub { },	1711	activate => sub { },
1293	});	1712	});
1294	}	1713	}
1295		1714
1296	sub add_title {	1715	=item $popup->add_button ($text, $cb)
1297	my ($self, $title) = @_;
1298		1716
1299	$self->add_item ({	1717	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" },	1718	selected.
1301	text => $title,	1719
1302	activate => sub { },	1720	=cut
1303	});
1304	}
1305		1721
1306	sub add_button {	1722	sub add_button {
1307	my ($self, $text, $cb) = @_;	1723	my ($self, $text, $cb) = @_;
1308		1724
1309	$self->add_item ({ type => "button", text => $text, activate => $cb});	1725	$self->add_item ({ type => "button", text => $text, activate => $cb});
1310	}	1726	}
		1727
		1728	=item $popup->add_toggle ($text, $cb, $initial_value)
		1729
		1730	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1731	whenever it gets toggled, with a boolean indicating its value as its first
		1732	argument.
		1733
		1734	=cut
1311		1735
1312	sub add_toggle {	1736	sub add_toggle {
1313	my ($self, $text, $cb, $value) = @_;	1737	my ($self, $text, $cb, $value) = @_;
1314		1738
1315	my $item; $item = {	1739	my $item; $item = {
1316	type => "button",	1740	type => "button",
1317	text => " $text",	1741	text => " $text",
1318	value => $value,	1742	value => $value,
1319	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1743	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1320	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1744	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1321	};	1745	};
1322		1746
1323	$self->add_item ($item);	1747	$self->add_item ($item);
1324	}	1748	}
		1749
		1750	=item $popup->show
		1751
		1752	Displays the popup (which is initially hidden).
		1753
		1754	=cut
1325		1755
1326	sub show {	1756	sub show {
1327	my ($self) = @_;	1757	my ($self) = @_;
1328		1758
1329	local $urxvt::popup::self = $self;	1759	local $urxvt::popup::self = $self;
1330		1760
		1761	my $env = $self->{term}->env;
		1762	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1763	delete $env->{LC_ALL};
1331	local $ENV{LC_ALL} = $self->{term}->locale;	1764	$env->{LC_CTYPE} = $self->{term}->locale;
1332		1765
1333	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1766	urxvt::term->new ($env, "popup",
		1767	"--perl-lib" => "", "--perl-ext-common" => "",
		1768	"-pty-fd" => -1, "-sl" => 0,
		1769	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1334	"--transient-for" => $self->{term}->parent,	1770	"--transient-for" => $self->{term}->parent,
1335	"-display" => $self->{term}->display_id,	1771	"-display" => $self->{term}->display_id,
1336	"-pe" => "urxvt-popup")	1772	"-pe" => "urxvt-popup")
1337	or die "unable to create popup window\n";	1773	or die "unable to create popup window\n";
1338	}	1774	}
1339		1775
1340	sub DESTROY {	1776	sub DESTROY {
1341	my ($self) = @_;	1777	my ($self) = @_;
1342		1778
1343	delete $self->{term}{_destroy}{$self};	1779	delete $self->{term}{_destroy}{$self};
1344	$self->{term}->ungrab;	1780	$self->{term}->ungrab;
1345	}	1781	}
		1782
		1783	=back
		1784
		1785	=cut
		1786
		1787	package urxvt::watcher;
		1788
		1789	@urxvt::timer::ISA = __PACKAGE__;
		1790	@urxvt::iow::ISA = __PACKAGE__;
		1791	@urxvt::pw::ISA = __PACKAGE__;
		1792	@urxvt::iw::ISA = __PACKAGE__;
1346		1793
1347	=head2 The C<urxvt::timer> Class	1794	=head2 The C<urxvt::timer> Class
1348		1795
1349	This class implements timer watchers/events. Time is represented as a	1796	This class implements timer watchers/events. Time is represented as a
1350	fractional number of seconds since the epoch. Example:	1797	fractional number of seconds since the epoch. Example:
…		…
1388	Start the timer.	1835	Start the timer.
1389		1836
1390	=item $timer = $timer->start ($tstamp)	1837	=item $timer = $timer->start ($tstamp)
1391		1838
1392	Set the event trigger time to C<$tstamp> and start the timer.	1839	Set the event trigger time to C<$tstamp> and start the timer.
		1840
		1841	=item $timer = $timer->after ($delay)
		1842
		1843	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1393		1844
1394	=item $timer = $timer->stop	1845	=item $timer = $timer->stop
1395		1846
1396	Stop the timer.	1847	Stop the timer.
1397		1848
…		…
1444		1895
1445	Stop watching for events on the given filehandle.	1896	Stop watching for events on the given filehandle.
1446		1897
1447	=back	1898	=back
1448		1899
		1900	=head2 The C<urxvt::iw> Class
		1901
		1902	This class implements idle watchers, that get called automatically when
		1903	the process is idle. They should return as fast as possible, after doing
		1904	some useful work.
		1905
		1906	=over 4
		1907
		1908	=item $iw = new urxvt::iw
		1909
		1910	Create a new idle watcher object in stopped state.
		1911
		1912	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1913
		1914	Set the callback to be called when the watcher triggers.
		1915
		1916	=item $timer = $timer->start
		1917
		1918	Start the watcher.
		1919
		1920	=item $timer = $timer->stop
		1921
		1922	Stop the watcher.
		1923
		1924	=back
		1925
		1926	=head2 The C<urxvt::pw> Class
		1927
		1928	This class implements process watchers. They create an event whenever a
		1929	process exits, after which they stop automatically.
		1930
		1931	my $pid = fork;
		1932	...
		1933	$term->{pw} = urxvt::pw
		1934	->new
		1935	->start ($pid)
		1936	->cb (sub {
		1937	my ($pw, $exit_status) = @_;
		1938	...
		1939	});
		1940
		1941	=over 4
		1942
		1943	=item $pw = new urxvt::pw
		1944
		1945	Create a new process watcher in stopped state.
		1946
		1947	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1948
		1949	Set the callback to be called when the timer triggers.
		1950
		1951	=item $pw = $timer->start ($pid)
		1952
		1953	Tells the wqtcher to start watching for process C<$pid>.
		1954
		1955	=item $pw = $pw->stop
		1956
		1957	Stop the watcher.
		1958
		1959	=back
		1960
1449	=head1 ENVIRONMENT	1961	=head1 ENVIRONMENT
1450		1962
1451	=head2 URXVT_PERL_VERBOSITY	1963	=head2 URXVT_PERL_VERBOSITY
1452		1964
1453	This variable controls the verbosity level of the perl extension. Higher	1965	This variable controls the verbosity level of the perl extension. Higher
…		…
1457		1969
1458	=item == 0 - fatal messages	1970	=item == 0 - fatal messages
1459		1971
1460	=item >= 3 - script loading and management	1972	=item >= 3 - script loading and management
1461		1973
1462	=item >=10 - all events received	1974	=item >=10 - all called hooks
		1975
		1976	=item >=11 - hook reutrn values
1463		1977
1464	=back	1978	=back
1465		1979
1466	=head1 AUTHOR	1980	=head1 AUTHOR
1467		1981

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.126 by root, Tue Jan 24 19:14:36 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.126 by root, Tue Jan 24 19:14:36 2006 UTC