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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.70 by root, Mon Jan 9 23:00:07 2006 UTC vs.
Revision 1.118 by root, Fri Jan 20 18:50:49 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	You can look at the source of the selection extension to see more
		73	interesting uses, such as parsing a line from beginning to end.
		74
		75	This extension also offers following bindable keyboard commands:
50		76
51	=over 4	77	=over 4
52		78
53	=item rot13	79	=item rot13
54		80
…		…
64	runtime.	90	runtime.
65		91
66	=item selection-popup (enabled by default)	92	=item selection-popup (enabled by default)
67		93
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	94	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	95	text into various other formats/action (such as uri unescaping, perl
		96	evaluation, web-browser starting etc.), depending on content.
70		97
		98	Other extensions can extend this popup menu by pushing a code reference
		99	onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
		100	popup is displayed.
		101
		102	It's sole argument is the popup menu, which can be modified. The selection
		103	is in C<$_>, which can be used to decide wether to add something or not.
		104	It should either return nothing or a string and a code reference. The
		105	string will be used as button text and the code reference will be called
		106	when the button gets activated and should transform C<$_>.
		107
		108	The following will add an entry C<a to b> that transforms all C<a>s in
		109	the selection to C<b>s, but only if the selection currently contains any
		110	C<a>s:
		111
		112	push @{ $self->{term}{selection_popup_hook} }, sub {
		113	/a/ ? ("a to be" => sub { s/a/b/g }
		114	: ()
		115	};
		116
71	=item searchable-scrollback (enabled by default)	117	=item searchable-scrollback<hotkey> (enabled by default)
72		118
73	Adds regex search functionality to the scrollback buffer, triggered by a	119	Adds regex search functionality to the scrollback buffer, triggered
74	hotkey (default: C<M-s>). When in search mode, terminal input/output is	120	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,	121	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	122	screen.
77	current position and C<escape> returns to the original position.
78		123
79	=item digital-clock	124	Inputting characters appends them to the regex and continues incremental
		125	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		126	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		127	bottom. C<Escape> leaves search mode and returns to the point where search
		128	was started, while C<Enter> or C<Return> stay at the current position and
		129	additionally stores the first match in the current line into the primary
		130	selection.
80		131
81	Displays a digital clock using the built-in overlay.	132	=item selection-autotransform
		133
		134	This selection allows you to do automatic transforms on a selection
		135	whenever a selection is made.
		136
		137	It works by specifying perl snippets (most useful is a single C<s///>
		138	operator) that modify C<$_> as resources:
		139
		140	URxvt.selection-autotransform.0: transform
		141	URxvt.selection-autotransform.1: transform
		142	...
		143
		144	For example, the following will transform selections of the form
		145	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		146	$word>:
		147
		148	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		149
		150	And this example matches the same,but replaces it with vi-commands you can
		151	paste directly into your (vi :) editor:
		152
		153	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		154
		155	Of course, this can be modified to suit your needs and your editor :)
		156
		157	To expand the example above to typical perl error messages ("XXX at
		158	FILENAME line YYY."), you need a slightly more elaborate solution:
		159
		160	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		161	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		162
		163	The first line tells the selection code to treat the unchanging part of
		164	every error message as a selection pattern, and the second line transforms
		165	the message into vi commands to load the file.
		166
		167	=item tabbed
		168
		169	This transforms the terminal into a tabbar with additional terminals, that
		170	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		171	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		172	button per tab.
		173
		174	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		175	B<Shift-Right> will switch to the tab left or right of the current one,
		176	while B<Shift-Down> creates a new tab.
82		177
83	=item mark-urls	178	=item mark-urls
84		179
85	Uses per-line display filtering (C<on_line_update>) to underline urls.	180	Uses per-line display filtering (C<on_line_update>) to underline urls and
		181	make them clickable. When middle-clicked, the program specified in the
		182	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		183	the URL as first argument.
		184
		185	=item automove-background
		186
		187	This is basically a one-line extension that dynamically changes the background pixmap offset
		188	to the window position, in effect creating the same effect as pseudo transparency with
		189	a custom pixmap. No scaling is supported in this mode. Exmaple:
		190
		191	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
86		192
87	=item block-graphics-to-ascii	193	=item block-graphics-to-ascii
88		194
89	A not very useful example of filtering all text output to the terminal,	195	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	196	by replacing all line-drawing characters (U+2500 .. U+259F) by a
91	similar-looking ascii character.	197	similar-looking ascii character.
92		198
		199	=item digital-clock
		200
		201	Displays a digital clock using the built-in overlay.
		202
93	=item example-refresh-hooks	203	=item example-refresh-hooks
94		204
95	Displays a very simple digital clock in the upper right corner of the	205	Displays a very simple digital clock in the upper right corner of the
96	window. Illustrates overwriting the refresh callbacks to create your own	206	window. Illustrates overwriting the refresh callbacks to create your own
97	overlays or changes.	207	overlays or changes.
98		208
		209	=item selection-pastebin
		210
		211	This is a little rarely useful extension that Uploads the selection as
		212	textfile to a remote site (or does other things). (The implementation is
		213	not currently secure for use in a multiuser environment as it writes to
		214	F</tmp> directly.).
		215
		216	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		217	i.e.
		218
		219	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		220
		221	Pressing this combination runs a command with C<%> replaced by the name of
		222	the textfile. This command can be set via a resource:
		223
		224	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		225
		226	And the default is likely not useful to anybody but the few people around
		227	here :)
		228
		229	The name of the textfile is the hex encoded md5 sum of the selection, so
		230	the same content should lead to the same filename.
		231
		232	After a successful upload the selection will be replaced by the text given
		233	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		234	for the filename):
		235
		236	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		237
99	=back	238	=back
		239
		240	=head1 API DOCUMENTATION
100		241
101	=head2 General API Considerations	242	=head2 General API Considerations
102		243
103	All objects (such as terminals, time watchers etc.) are typical	244	All objects (such as terminals, time watchers etc.) are typical
104	reference-to-hash objects. The hash can be used to store anything you	245	reference-to-hash objects. The hash can be used to store anything you
…		…
117	=over 4	258	=over 4
118		259
119	=item $text	260	=item $text
120		261
121	Rxvt-unicodes special way of encoding text, where one "unicode" character	262	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.	263	always represents one screen cell. See L<ROW_t> for a discussion of this format.
123		264
124	=item $string	265	=item $string
125		266
126	A perl text string, with an emphasis on I<text>. It can store all unicode	267	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	268	characters and is to be distinguished with text encoded in a specific
…		…
173	called whenever the relevant event happens.	314	called whenever the relevant event happens.
174		315
175	The first argument passed to them is an extension oject as described in	316	The first argument passed to them is an extension oject as described in
176	the in the C<Extension Objects> section.	317	the in the C<Extension Objects> section.
177		318
178	B<All> of these hooks must return a boolean value. If it is true, then the	319	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	320	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.	321	relevant action might not be carried out by the C++ code.
181		322
182	I<< When in doubt, return a false value (preferably C<()>). >>	323	I<< When in doubt, return a false value (preferably C<()>). >>
183		324
184	=over 4	325	=over 4
185		326
186	=item on_init $term	327	=item on_init $term
187		328
188	Called after a new terminal object has been initialized, but before	329	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	330	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	331	call or deliver senseless data, as terminal size and other characteristics
191	have not yet been determined. You can safely query and change resources,	332	have not yet been determined. You can safely query and change resources
192	though.	333	and options, though. For many purposes the C<on_start> hook is a better
		334	place.
		335
		336	=item on_start $term
		337
		338	Called at the very end of initialisation of a new terminal, just before
		339	trying to map (display) the toplevel and returning to the mainloop.
		340
		341	=item on_destroy $term
		342
		343	Called whenever something tries to destroy terminal, before doing anything
		344	yet. If this hook returns true, then destruction is skipped, but this is
		345	rarely a good idea.
193		346
194	=item on_reset $term	347	=item on_reset $term
195		348
196	Called after the screen is "reset" for any reason, such as resizing or	349	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	350	control sequences. Here is where you can react on changes to size-related
198	variables.	351	variables.
199		352
200	=item on_start $term	353	=item on_child_start $term, $pid
201		354
202	Called at the very end of initialisation of a new terminal, just before	355	Called just after the child process has been C<fork>ed.
203	returning to the mainloop.	356
		357	=item on_child_exit $term, $status
		358
		359	Called just after the child process has exited. C<$status> is the status
		360	from C<waitpid>.
204		361
205	=item on_sel_make $term, $eventtime	362	=item on_sel_make $term, $eventtime
206		363
207	Called whenever a selection has been made by the user, but before the	364	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	365	selection text is copied, so changes to the beginning, end or type of the
…		…
222	=item on_sel_extend $term	379	=item on_sel_extend $term
223		380
224	Called whenever the user tries to extend the selection (e.g. with a double	381	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	382	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	383	should extend the selection itelf and return true to suppress the built-in
227	processing.	384	processing. This can happen multiple times, as long as the callback
		385	returns true, it will be called on every further click by the user and is
		386	supposed to enlarge the selection more and more, if possible.
228		387
229	See the F<selection> example extension.	388	See the F<selection> example extension.
230		389
231	=item on_view_change $term, $offset	390	=item on_view_change $term, $offset
232		391
…		…
263	can filter/change and output the text yourself by returning a true value	422	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	423	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	424	might be very slow, however, as your hook is called for B<all> text being
266	output.	425	output.
267		426
		427	=item on_tt_write $term, $octets
		428
		429	Called whenever some data is written to the tty/pty and can be used to
		430	suppress or filter tty input.
		431
268	=item on_line_update $term, $row	432	=item on_line_update $term, $row
269		433
270	Called whenever a line was updated or changed. Can be used to filter	434	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	435	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,	436	that are being shown will be filtered, and, due to performance reasons,
…		…
294		458
295	Called whenever the user presses a key combination that has a	459	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>	460	C<perl:string> action bound to it (see description of the B<keysym>
297	resource in the @@RXVT_NAME@@(1) manpage).	461	resource in the @@RXVT_NAME@@(1) manpage).
298		462
		463	=item on_x_event $term, $event
		464
		465	Called on every X event received on the vt window (and possibly other
		466	windows). Should only be used as a last resort. Most event structure
		467	members are not passed.
		468
299	=item on_focus_in $term	469	=item on_focus_in $term
300		470
301	Called whenever the window gets the keyboard focus, before rxvt-unicode	471	Called whenever the window gets the keyboard focus, before rxvt-unicode
302	does focus in processing.	472	does focus in processing.
303		473
304	=item on_focus_out $term	474	=item on_focus_out $term
305		475
306	Called wheneever the window loses keyboard focus, before rxvt-unicode does	476	Called wheneever the window loses keyboard focus, before rxvt-unicode does
307	focus out processing.	477	focus out processing.
		478
		479	=item on_configure_notify $term, $event
		480
		481	=item on_property_notify $term, $event
308		482
309	=item on_key_press $term, $event, $keysym, $octets	483	=item on_key_press $term, $event, $keysym, $octets
310		484
311	=item on_key_release $term, $event, $keysym	485	=item on_key_release $term, $event, $keysym
312		486
…		…
330	C<on_key_press> additionally receives the string rxvt-unicode would	504	C<on_key_press> additionally receives the string rxvt-unicode would
331	output, if any, in locale-specific encoding.	505	output, if any, in locale-specific encoding.
332		506
333	subwindow.	507	subwindow.
334		508
335	=back	509	=item on_client_message $term, $event
336		510
337	=head2 Variables in the C<urxvt> Package	511	=item on_wm_protocols $term, $event
338		512
339	=over 4	513	=item on_wm_delete_window $term, $event
340		514
341	=item $urxvt::TERM	515	Called when various types of ClientMessage events are received (all with
342		516	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		517
445	=back	518	=back
446		519
447	=cut	520	=cut
448		521
…		…
454	use Scalar::Util ();	527	use Scalar::Util ();
455	use List::Util ();	528	use List::Util ();
456		529
457	our $VERSION = 1;	530	our $VERSION = 1;
458	our $TERM;	531	our $TERM;
		532	our @TERM_INIT;
		533	our @TERM_EXT;
459	our @HOOKNAME;	534	our @HOOKNAME;
460	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	535	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
461	our %OPTION;	536	our %OPTION;
		537
462	our $LIBDIR;	538	our $LIBDIR;
		539	our $RESNAME;
		540	our $RESCLASS;
		541	our $RXVTNAME;
		542
		543	=head2 Variables in the C<urxvt> Package
		544
		545	=over 4
		546
		547	=item $urxvt::LIBDIR
		548
		549	The rxvt-unicode library directory, where, among other things, the perl
		550	modules and scripts are stored.
		551
		552	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		553
		554	The resource class and name rxvt-unicode uses to look up X resources.
		555
		556	=item $urxvt::RXVTNAME
		557
		558	The basename of the installed binaries, usually C<urxvt>.
		559
		560	=item $urxvt::TERM
		561
		562	The current terminal. This variable stores the current C<urxvt::term>
		563	object, whenever a callback/hook is executing.
		564
		565	=item @urxvt::TERM_INIT
		566
		567	All coderefs in this array will be called as methods of the next newly
		568	created C<urxvt::term> object (during the C<on_init> phase). The array
		569	gets cleared before the codereferences that were in it are being executed,
		570	so coderefs can push themselves onto it again if they so desire.
		571
		572	This complements to the perl-eval commandline option, but gets executed
		573	first.
		574
		575	=item @urxvt::TERM_EXT
		576
		577	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		578	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		579	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		580
		581	=back
		582
		583	=head2 Functions in the C<urxvt> Package
		584
		585	=over 4
		586
		587	=item urxvt::fatal $errormessage
		588
		589	Fatally aborts execution with the given error message. Avoid at all
		590	costs! The only time this is acceptable is when the terminal process
		591	starts up.
		592
		593	=item urxvt::warn $string
		594
		595	Calls C<rxvt_warn> with the given string which should not include a
		596	newline. The module also overwrites the C<warn> builtin with a function
		597	that calls this function.
		598
		599	Using this function has the advantage that its output ends up in the
		600	correct place, e.g. on stderr of the connecting urxvtc client.
		601
		602	Messages have a size limit of 1023 bytes currently.
		603
		604	=item $time = urxvt::NOW
		605
		606	Returns the "current time" (as per the event loop).
		607
		608	=item urxvt::CurrentTime
		609
		610	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		611	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		612	Button4Mask, Button5Mask, AnyModifier
		613
		614	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		615	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		616	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		617	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		618	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		619	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		620	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		621
		622	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		623	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		624	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		625	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		626	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		627	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		628	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		629
		630	Various constants for use in X calls and event processing.
		631
		632	=back
		633
		634	=head2 RENDITION
		635
		636	Rendition bitsets contain information about colour, font, font styles and
		637	similar information for each screen cell.
		638
		639	The following "macros" deal with changes in rendition sets. You should
		640	never just create a bitset, you should always modify an existing one,
		641	as they contain important information required for correct operation of
		642	rxvt-unicode.
		643
		644	=over 4
		645
		646	=item $rend = urxvt::DEFAULT_RSTYLE
		647
		648	Returns the default rendition, as used when the terminal is starting up or
		649	being reset. Useful as a base to start when creating renditions.
		650
		651	=item $rend = urxvt::OVERLAY_RSTYLE
		652
		653	Return the rendition mask used for overlays by default.
		654
		655	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		656
		657	Return the bit that enabled bold, italic, blink, reverse-video and
		658	underline, respectively. To enable such a style, just logically OR it into
		659	the bitset.
		660
		661	=item $foreground = urxvt::GET_BASEFG $rend
		662
		663	=item $background = urxvt::GET_BASEBG $rend
		664
		665	Return the foreground/background colour index, respectively.
		666
		667	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		668
		669	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		670
		671	Replace the foreground/background colour in the rendition mask with the
		672	specified one.
		673
		674	=item $value = urxvt::GET_CUSTOM $rend
		675
		676	Return the "custom" value: Every rendition has 5 bits for use by
		677	extensions. They can be set and changed as you like and are initially
		678	zero.
		679
		680	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		681
		682	Change the custom value.
		683
		684	=back
		685
		686	=cut
463		687
464	BEGIN {	688	BEGIN {
465	urxvt->bootstrap;
466
467	# overwrite perl's warn	689	# overwrite perl's warn
468	*CORE::GLOBAL::warn = sub {	690	*CORE::GLOBAL::warn = sub {
469	my $msg = join "", @_;	691	my $msg = join "", @_;
470	$msg .= "\n"	692	$msg .= "\n"
471	unless $msg =~ /\n$/;	693	unless $msg =~ /\n$/;
472	urxvt::warn ($msg);	694	urxvt::warn ($msg);
473	};	695	};
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	}	696	}
480		697
481	my @hook_count;
482	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	698	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
483		699
484	sub verbose {	700	sub verbose {
485	my ($level, $msg) = @_;	701	my ($level, $msg) = @_;
486	warn "$msg\n" if $level <= $verbosity;	702	warn "$msg\n" if $level <= $verbosity;
487	}	703	}
488		704
489	my $extension_pkg = "extension0000";
490	my %extension_pkg;	705	my %extension_pkg;
491		706
492	# load a single script into its own package, once only	707	# load a single script into its own package, once only
493	sub extension_package($) {	708	sub extension_package($) {
494	my ($path) = @_;	709	my ($path) = @_;
495		710
496	$extension_pkg{$path} \|\|= do {	711	$extension_pkg{$path} \|\|= do {
497	my $pkg = "urxvt::" . ($extension_pkg++);	712	$path =~ /([^\/\\]+)$/;
		713	my $pkg = $1;
		714	$pkg =~ s/[^[:word:]]/_/g;
		715	$pkg = "urxvt::ext::$pkg";
498		716
499	verbose 3, "loading extension '$path' into package '$pkg'";	717	verbose 3, "loading extension '$path' into package '$pkg'";
500		718
501	open my $fh, "<:raw", $path	719	open my $fh, "<:raw", $path
502	or die "$path: $!";	720	or die "$path: $!";
503		721
504	my $source = untaint	722	my $source =
505	"package $pkg; use strict; use utf8;\n"	723	"package $pkg; use strict; use utf8;\n"
506	. "use base urxvt::term::proxy::;\n"
507	. "#line 1 \"$path\"\n{\n"	724	. "#line 1 \"$path\"\n{\n"
508	. (do { local $/; <$fh> })	725	. (do { local $/; <$fh> })
509	. "\n};\n1";	726	. "\n};\n1";
510		727
511	eval $source	728	eval $source
…		…
525	if ($htype == 0) { # INIT	742	if ($htype == 0) { # INIT
526	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	743	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
527		744
528	my %ext_arg;	745	my %ext_arg;
529		746
		747	{
		748	my @init = @TERM_INIT;
		749	@TERM_INIT = ();
		750	$_->($TERM) for @init;
		751	my @pkg = @TERM_EXT;
		752	@TERM_EXT = ();
		753	$TERM->register_package ($_) for @pkg;
		754	}
		755
530	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	756	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
531	if ($_ eq "default") {	757	if ($_ eq "default") {
532	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	758	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
533	} elsif (/^-(.*)$/) {	759	} elsif (/^-(.*)$/) {
534	delete $ext_arg{$1};	760	delete $ext_arg{$1};
535	} elsif (/^([^<]+)<(.*)>$/) {	761	} elsif (/^([^<]+)<(.*)>$/) {
…		…
560	if $verbosity >= 10;	786	if $verbosity >= 10;
561		787
562	keys %$cb;	788	keys %$cb;
563		789
564	while (my ($pkg, $cb) = each %$cb) {	790	while (my ($pkg, $cb) = each %$cb) {
565	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	791	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
566	and last;	792	$retval \|\|= $retval_;
567		793
568	if ($@) {	794	if ($@) {
569	$TERM->ungrab; # better to lose the grab than the session	795	$TERM->ungrab; # better to lose the grab than the session
570	warn $@;	796	warn $@;
571	}	797	}
572	}	798	}
		799
		800	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		801	if $verbosity >= 11;
573	}	802	}
574		803
575	if ($htype == 1) { # DESTROY	804	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	805	# clear package objects
584	%$_ = () for values %{ $TERM->{_pkg} };	806	%$_ = () for values %{ $TERM->{_pkg} };
585		807
586	# clear package	808	# clear package
587	%$TERM = ();	809	%$TERM = ();
588	}	810	}
589		811
590	$retval	812	$retval
591	}	813	}
592		814
593	# urxvt::term::proxy	815	# urxvt::term::extension
594		816
595	package urxvt::term::proxy;	817	package urxvt::term::extension;
596		818
597	sub enable {	819	sub enable {
598	my ($self, %hook) = @_;	820	my ($self, %hook) = @_;
599	my $pkg = $self->{_pkg};	821	my $pkg = $self->{_pkg};
600		822
601	while (my ($name, $cb) = each %hook) {	823	while (my ($name, $cb) = each %hook) {
602	my $htype = $HOOKTYPE{uc $name};	824	my $htype = $HOOKTYPE{uc $name};
603	defined $htype	825	defined $htype
604	or Carp::croak "unsupported hook type '$name'";	826	or Carp::croak "unsupported hook type '$name'";
605		827
		828	$self->set_should_invoke ($htype, +1)
606	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	829	unless exists $self->{term}{_hook}[$htype]{$pkg};
607	$hook_count[$htype]++
608	or urxvt::set_should_invoke $htype, 1;
609	}
610		830
611	$self->{term}{_hook}[$htype]{$pkg} = $cb;	831	$self->{term}{_hook}[$htype]{$pkg} = $cb;
612	}	832	}
613	}	833	}
614		834
…		…
619	for my $name (@hook) {	839	for my $name (@hook) {
620	my $htype = $HOOKTYPE{uc $name};	840	my $htype = $HOOKTYPE{uc $name};
621	defined $htype	841	defined $htype
622	or Carp::croak "unsupported hook type '$name'";	842	or Carp::croak "unsupported hook type '$name'";
623		843
		844	$self->set_should_invoke ($htype, -1)
624	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	845	if delete $self->{term}{_hook}[$htype]{$pkg};
625	--$hook_count[$htype]
626	or urxvt::set_should_invoke $htype, 0;
627	}
628	}	846	}
629	}	847	}
630		848
631	our $AUTOLOAD;	849	our $AUTOLOAD;
632		850
…		…
663		881
664	=head2 The C<urxvt::anyevent> Class	882	=head2 The C<urxvt::anyevent> Class
665		883
666	The sole purpose of this class is to deliver an interface to the	884	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	885	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	886	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	887	condition variables, but non-blocking condvar use is ok. What this means
670	cannot use blocking APIs, but the non-blocking variant should work.	888	is that you cannot use blocking APIs, but the non-blocking variant should
		889	work.
671		890
672	=cut	891	=cut
673		892
674	our $VERSION = 1;	893	our $VERSION = 1;
675		894
…		…
737	# find on_xxx subs in the package and register them	956	# find on_xxx subs in the package and register them
738	# as hooks	957	# as hooks
739	sub register_package {	958	sub register_package {
740	my ($self, $pkg, $argv) = @_;	959	my ($self, $pkg, $argv) = @_;
741		960
		961	no strict 'refs';
		962
		963	urxvt::verbose 6, "register package $pkg to $self";
		964
		965	@{"$pkg\::ISA"} = urxvt::term::extension::;
		966
742	my $proxy = bless {	967	my $proxy = bless {
743	_pkg => $pkg,	968	_pkg => $pkg,
744	argv => $argv,	969	argv => $argv,
745	}, $pkg;	970	}, $pkg;
746	Scalar::Util::weaken ($proxy->{term} = $self);	971	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
752	$proxy->enable ($name => $ref);	977	$proxy->enable ($name => $ref);
753	}	978	}
754	}	979	}
755	}	980	}
756		981
		982	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		983
		984	Creates a new terminal, very similar as if you had started it with system
		985	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		986	hash which defines the environment of the new terminal.
		987
		988	Croaks (and probably outputs an error message) if the new instance
		989	couldn't be created. Returns C<undef> if the new instance didn't
		990	initialise perl, and the terminal object otherwise. The C<init> and
		991	C<start> hooks will be called during this call.
		992
		993	=cut
		994
		995	sub new {
		996	my ($class, $env, @args) = @_;
		997
		998	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		999	}
		1000
757	=item $term->destroy	1001	=item $term->destroy
758		1002
759	Destroy the terminal object (close the window, free resources etc.).	1003	Destroy the terminal object (close the window, free resources
		1004	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1005	watchers (timers, io watchers) are still active.
		1006
		1007	=item $term->exec_async ($cmd[, @args])
		1008
		1009	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1010	("starts") programs in the background. This function takes care of setting
		1011	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1012	be preferred over explicit calls to C<exec> or C<system>.
		1013
		1014	Returns the pid of the subprocess or C<undef> on error.
		1015
		1016	=cut
		1017
		1018	sub exec_async {
		1019	my $self = shift;
		1020
		1021	my $pid = fork;
		1022
		1023	return $pid
		1024	if !defined $pid or $pid;
		1025
		1026	%ENV = %{ $self->env };
		1027
		1028	exec @_;
		1029	urxvt::_exit 255;
		1030	}
760		1031
761	=item $isset = $term->option ($optval[, $set])	1032	=item $isset = $term->option ($optval[, $set])
762		1033
763	Returns true if the option specified by C<$optval> is enabled, and	1034	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	1035	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	1038	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:	1039	source file F</src/optinc.h> to see the actual list:
769		1040
770	borderLess console cursorBlink cursorUnderline hold iconic insecure	1041	borderLess console cursorBlink cursorUnderline hold iconic insecure
771	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1042	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
772	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1043	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
773	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1044	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
774	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1045	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
775	tripleclickwords utmpInhibit visualBell	1046	transparent tripleclickwords utmpInhibit visualBell
776		1047
777	=item $value = $term->resource ($name[, $newval])	1048	=item $value = $term->resource ($name[, $newval])
778		1049
779	Returns the current resource value associated with a given name and	1050	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>	1051	optionally sets a new value. Setting values is most useful in the C<init>
…		…
797		1068
798	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1069	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
799	borderLess color cursorBlink cursorUnderline cutchars delete_key	1070	borderLess color cursorBlink cursorUnderline cutchars delete_key
800	display_name embed ext_bwidth fade font geometry hold iconName	1071	display_name embed ext_bwidth fade font geometry hold iconName
801	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1072	imFont imLocale inputMethod insecure int_bwidth intensityStyles
802	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1073	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
803	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1074	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
804	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1075	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
805	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1076	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
806	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1077	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
807	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1078	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
808	shade term_name title transparent transparent_all tripleclickwords	1079	secondaryScreen secondaryScroll selectstyle shade term_name title
809	utmpInhibit visualBell	1080	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1081	visualBell
810		1082
811	=cut	1083	=cut
812		1084
813	sub resource($$;$) {	1085	sub resource($$;$) {
814	my ($self, $name) = (shift, shift);	1086	my ($self, $name) = (shift, shift);
815	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1087	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
816	&urxvt::term::_resource	1088	&urxvt::term::_resource
817	}	1089	}
818		1090
		1091	=item $value = $term->x_resource ($pattern)
		1092
		1093	Returns the X-Resource for the given pattern, excluding the program or
		1094	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1095	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1096	resource with that pattern exists.
		1097
		1098	This method should only be called during the C<on_start> hook, as there is
		1099	only one resource database per display, and later invocations might return
		1100	the wrong resources.
		1101
819	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1102	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
820		1103
821	Adds a keymap translation exactly as specified via a resource. See the	1104	Adds a keymap translation exactly as specified via a resource. See the
822	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1105	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
823		1106
…		…
838	=item ($row, $col) = $term->selection_end ([$row, $col])	1121	=item ($row, $col) = $term->selection_end ([$row, $col])
839		1122
840	Return the current values of the selection mark, begin or end positions,	1123	Return the current values of the selection mark, begin or end positions,
841	and optionally set them to new values.	1124	and optionally set them to new values.
842		1125
		1126	=item $term->selection_make ($eventtime[, $rectangular])
		1127
		1128	Tries to make a selection as set by C<selection_beg> and
		1129	C<selection_end>. If C<$rectangular> is true (default: false), a
		1130	rectangular selection will be made. This is the prefered function to make
		1131	a selection.
		1132
843	=item $success = $term->selection_grab ($eventtime)	1133	=item $success = $term->selection_grab ($eventtime)
844		1134
845	Try to request the primary selection from the server (for example, as set	1135	Try to request the primary selection text from the server (for example, as
846	by the next method).	1136	set by the next method). No visual feedback will be given. This function
		1137	is mostly useful from within C<on_sel_grab> hooks.
847		1138
848	=item $oldtext = $term->selection ([$newtext])	1139	=item $oldtext = $term->selection ([$newtext])
849		1140
850	Return the current selection text and optionally replace it by C<$newtext>.	1141	Return the current selection text and optionally replace it by C<$newtext>.
851		1142
…		…
944	Convert the given locale-encoded octets into a perl string.	1235	Convert the given locale-encoded octets into a perl string.
945		1236
946	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1237	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
947		1238
948	XORs the rendition values in the given span with the provided value	1239	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	1240	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
950	to the selection.	1241	refresh hooks to provide effects similar to the selection.
951		1242
952	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1243	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
953		1244
954	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1245	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
955	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1246	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	1247	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
957	it instead.	1248	it instead. Both styles I<MUST NOT> contain font styles.
958		1249
959	=item $term->scr_bell	1250	=item $term->scr_bell
960		1251
961	Ring the bell!	1252	Ring the bell!
962		1253
…		…
996		1287
997	=item $windowid = $term->vt	1288	=item $windowid = $term->vt
998		1289
999	Return the window id of the terminal window.	1290	Return the window id of the terminal window.
1000		1291
		1292	=item $term->vt_emask_add ($x_event_mask)
		1293
		1294	Adds the specified events to the vt event mask. Useful e.g. when you want
		1295	to receive pointer events all the times:
		1296
		1297	$term->vt_emask_add (urxvt::PointerMotionMask);
		1298
1001	=item $window_width = $term->width	1299	=item $window_width = $term->width
1002		1300
1003	=item $window_height = $term->height	1301	=item $window_height = $term->height
1004		1302
1005	=item $font_width = $term->fwidth	1303	=item $font_width = $term->fwidth
…		…
1018		1316
1019	=item $max_scrollback = $term->saveLines	1317	=item $max_scrollback = $term->saveLines
1020		1318
1021	=item $nrow_plus_saveLines = $term->total_rows	1319	=item $nrow_plus_saveLines = $term->total_rows
1022		1320
1023	=item $lines_in_scrollback = $term->nsaved	1321	=item $topmost_scrollback_row = $term->top_row
1024		1322
1025	Return various integers describing terminal characteristics.	1323	Return various integers describing terminal characteristics.
1026		1324
		1325	=item $x_display = $term->display_id
		1326
		1327	Return the DISPLAY used by rxvt-unicode.
		1328
1027	=item $lc_ctype = $term->locale	1329	=item $lc_ctype = $term->locale
1028		1330
1029	Returns the LC_CTYPE category string used by this rxvt-unicode.	1331	Returns the LC_CTYPE category string used by this rxvt-unicode.
1030		1332
1031	=item $x_display = $term->display_id	1333	=item $env = $term->env
1032		1334
1033	Return the DISPLAY used by rxvt-unicode.	1335	Returns a copy of the environment in effect for the terminal as a hashref
		1336	similar to C<\%ENV>.
		1337
		1338	=cut
		1339
		1340	sub env {
		1341	if (my $env = $_[0]->_env) {
		1342	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1343	} else {
		1344	+{ %ENV }
		1345	}
		1346	}
1034		1347
1035	=item $modifiermask = $term->ModLevel3Mask	1348	=item $modifiermask = $term->ModLevel3Mask
1036		1349
1037	=item $modifiermask = $term->ModMetaMask	1350	=item $modifiermask = $term->ModMetaMask
1038		1351
…		…
1041	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1354	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.	1355	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1043		1356
1044	=item $view_start = $term->view_start ([$newvalue])	1357	=item $view_start = $term->view_start ([$newvalue])
1045		1358
1046	Returns the negative row number of the topmost line. Minimum value is	1359	Returns the row number of the topmost displayed line. Maximum value is
1047	C<0>, which displays the normal terminal contents. Larger values scroll	1360	C<0>, which displays the normal terminal contents. Lower values scroll
1048	this many lines into the scrollback buffer.	1361	this many lines into the scrollback buffer.
1049		1362
1050	=item $term->want_refresh	1363	=item $term->want_refresh
1051		1364
1052	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1365	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1131	Return the row number of the first/last row of the line, respectively.	1444	Return the row number of the first/last row of the line, respectively.
1132		1445
1133	=item $offset = $line->offset_of ($row, $col)	1446	=item $offset = $line->offset_of ($row, $col)
1134		1447
1135	Returns the character offset of the given row\|col pair within the logical	1448	Returns the character offset of the given row\|col pair within the logical
1136	line.	1449	line. Works for rows outside the line, too, and returns corresponding
		1450	offsets outside the string.
1137		1451
1138	=item ($row, $col) = $line->coord_of ($offset)	1452	=item ($row, $col) = $line->coord_of ($offset)
1139		1453
1140	Translates a string offset into terminal coordinates again.	1454	Translates a string offset into terminal coordinates again.
1141		1455
…		…
1278	$item->{render} \|\|= sub { $_[0]{text} };	1592	$item->{render} \|\|= sub { $_[0]{text} };
1279		1593
1280	push @{ $self->{item} }, $item;	1594	push @{ $self->{item} }, $item;
1281	}	1595	}
1282		1596
		1597	=item $popup->add_title ($title)
		1598
		1599	Adds a non-clickable title to the popup.
		1600
		1601	=cut
		1602
		1603	sub add_title {
		1604	my ($self, $title) = @_;
		1605
		1606	$self->add_item ({
		1607	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1608	text => $title,
		1609	activate => sub { },
		1610	});
		1611	}
		1612
		1613	=item $popup->add_separator ([$sepchr])
		1614
		1615	Creates a separator, optionally using the character given as C<$sepchr>.
		1616
		1617	=cut
		1618
1283	sub add_separator {	1619	sub add_separator {
1284	my ($self, $sep) = @_;	1620	my ($self, $sep) = @_;
1285		1621
1286	$sep \|\|= "=";	1622	$sep \|\|= "=";
1287		1623
…		…
1291	render => sub { $sep x $self->{term}->ncol },	1627	render => sub { $sep x $self->{term}->ncol },
1292	activate => sub { },	1628	activate => sub { },
1293	});	1629	});
1294	}	1630	}
1295		1631
1296	sub add_title {	1632	=item $popup->add_button ($text, $cb)
1297	my ($self, $title) = @_;
1298		1633
1299	$self->add_item ({	1634	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" },	1635	selected.
1301	text => $title,	1636
1302	activate => sub { },	1637	=cut
1303	});
1304	}
1305		1638
1306	sub add_button {	1639	sub add_button {
1307	my ($self, $text, $cb) = @_;	1640	my ($self, $text, $cb) = @_;
1308		1641
1309	$self->add_item ({ type => "button", text => $text, activate => $cb});	1642	$self->add_item ({ type => "button", text => $text, activate => $cb});
1310	}	1643	}
		1644
		1645	=item $popup->add_toggle ($text, $cb, $initial_value)
		1646
		1647	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1648	whenever it gets toggled, with a boolean indicating its value as its first
		1649	argument.
		1650
		1651	=cut
1311		1652
1312	sub add_toggle {	1653	sub add_toggle {
1313	my ($self, $text, $cb, $value) = @_;	1654	my ($self, $text, $cb, $value) = @_;
1314		1655
1315	my $item; $item = {	1656	my $item; $item = {
1316	type => "button",	1657	type => "button",
1317	text => " $text",	1658	text => " $text",
1318	value => $value,	1659	value => $value,
1319	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1660	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1320	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1661	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1321	};	1662	};
1322		1663
1323	$self->add_item ($item);	1664	$self->add_item ($item);
1324	}	1665	}
		1666
		1667	=item $popup->show
		1668
		1669	Displays the popup (which is initially hidden).
		1670
		1671	=cut
1325		1672
1326	sub show {	1673	sub show {
1327	my ($self) = @_;	1674	my ($self) = @_;
1328		1675
1329	local $urxvt::popup::self = $self;	1676	local $urxvt::popup::self = $self;
1330		1677
		1678	my $env = $self->{term}->env;
		1679	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1680	delete $env->{LC_ALL};
1331	local $ENV{LC_ALL} = $self->{term}->locale;	1681	$env->{LC_CTYPE} = $self->{term}->locale;
1332		1682
1333	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1683	urxvt::term->new ($env, "popup",
		1684	"--perl-lib" => "", "--perl-ext-common" => "",
		1685	"-pty-fd" => -1, "-sl" => 0,
		1686	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1334	"--transient-for" => $self->{term}->parent,	1687	"--transient-for" => $self->{term}->parent,
1335	"-display" => $self->{term}->display_id,	1688	"-display" => $self->{term}->display_id,
1336	"-pe" => "urxvt-popup")	1689	"-pe" => "urxvt-popup")
1337	or die "unable to create popup window\n";	1690	or die "unable to create popup window\n";
1338	}	1691	}
1339		1692
1340	sub DESTROY {	1693	sub DESTROY {
1341	my ($self) = @_;	1694	my ($self) = @_;
1342		1695
1343	delete $self->{term}{_destroy}{$self};	1696	delete $self->{term}{_destroy}{$self};
1344	$self->{term}->ungrab;	1697	$self->{term}->ungrab;
1345	}	1698	}
		1699
		1700	=back
		1701
		1702	=cut
		1703
		1704	package urxvt::watcher;
		1705
		1706	@urxvt::timer::ISA = __PACKAGE__;
		1707	@urxvt::iow::ISA = __PACKAGE__;
		1708	@urxvt::pw::ISA = __PACKAGE__;
		1709	@urxvt::iw::ISA = __PACKAGE__;
1346		1710
1347	=head2 The C<urxvt::timer> Class	1711	=head2 The C<urxvt::timer> Class
1348		1712
1349	This class implements timer watchers/events. Time is represented as a	1713	This class implements timer watchers/events. Time is represented as a
1350	fractional number of seconds since the epoch. Example:	1714	fractional number of seconds since the epoch. Example:
…		…
1388	Start the timer.	1752	Start the timer.
1389		1753
1390	=item $timer = $timer->start ($tstamp)	1754	=item $timer = $timer->start ($tstamp)
1391		1755
1392	Set the event trigger time to C<$tstamp> and start the timer.	1756	Set the event trigger time to C<$tstamp> and start the timer.
		1757
		1758	=item $timer = $timer->after ($delay)
		1759
		1760	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1393		1761
1394	=item $timer = $timer->stop	1762	=item $timer = $timer->stop
1395		1763
1396	Stop the timer.	1764	Stop the timer.
1397		1765
…		…
1444		1812
1445	Stop watching for events on the given filehandle.	1813	Stop watching for events on the given filehandle.
1446		1814
1447	=back	1815	=back
1448		1816
		1817	=head2 The C<urxvt::iw> Class
		1818
		1819	This class implements idle watchers, that get called automatically when
		1820	the process is idle. They should return as fast as possible, after doing
		1821	some useful work.
		1822
		1823	=over 4
		1824
		1825	=item $iw = new urxvt::iw
		1826
		1827	Create a new idle watcher object in stopped state.
		1828
		1829	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1830
		1831	Set the callback to be called when the watcher triggers.
		1832
		1833	=item $timer = $timer->start
		1834
		1835	Start the watcher.
		1836
		1837	=item $timer = $timer->stop
		1838
		1839	Stop the watcher.
		1840
		1841	=back
		1842
		1843	=head2 The C<urxvt::pw> Class
		1844
		1845	This class implements process watchers. They create an event whenever a
		1846	process exits, after which they stop automatically.
		1847
		1848	my $pid = fork;
		1849	...
		1850	$term->{pw} = urxvt::pw
		1851	->new
		1852	->start ($pid)
		1853	->cb (sub {
		1854	my ($pw, $exit_status) = @_;
		1855	...
		1856	});
		1857
		1858	=over 4
		1859
		1860	=item $pw = new urxvt::pw
		1861
		1862	Create a new process watcher in stopped state.
		1863
		1864	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1865
		1866	Set the callback to be called when the timer triggers.
		1867
		1868	=item $pw = $timer->start ($pid)
		1869
		1870	Tells the wqtcher to start watching for process C<$pid>.
		1871
		1872	=item $pw = $pw->stop
		1873
		1874	Stop the watcher.
		1875
		1876	=back
		1877
1449	=head1 ENVIRONMENT	1878	=head1 ENVIRONMENT
1450		1879
1451	=head2 URXVT_PERL_VERBOSITY	1880	=head2 URXVT_PERL_VERBOSITY
1452		1881
1453	This variable controls the verbosity level of the perl extension. Higher	1882	This variable controls the verbosity level of the perl extension. Higher
…		…
1457		1886
1458	=item == 0 - fatal messages	1887	=item == 0 - fatal messages
1459		1888
1460	=item >= 3 - script loading and management	1889	=item >= 3 - script loading and management
1461		1890
1462	=item >=10 - all events received	1891	=item >=10 - all called hooks
		1892
		1893	=item >=11 - hook reutrn values
1463		1894
1464	=back	1895	=back
1465		1896
1466	=head1 AUTHOR	1897	=head1 AUTHOR
1467		1898

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.70 by root, Mon Jan 9 23:00:07 2006 UTC vs. Revision 1.118 by root, Fri Jan 20 18:50:49 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.70 by root, Mon Jan 9 23:00:07 2006 UTC vs.
Revision 1.118 by root, Fri Jan 20 18:50:49 2006 UTC