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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.69 by root, Mon Jan 9 22:41:41 2006 UTC vs.
Revision 1.113 by root, Fri Jan 20 10:27:08 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	evalution, 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.
82		166
83	=item mark-urls	167	=item mark-urls
84		168
85	Uses per-line display filtering (C<on_line_update>) to underline urls.	169	Uses per-line display filtering (C<on_line_update>) to underline urls and
		170	make them clickable. When middle-clicked, the program specified in the
		171	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		172	the URL as first argument.
		173
		174	=item automove-background
		175
		176	This is basically a one-line extension that dynamically changes the background pixmap offset
		177	to the window position, in effect creating the same effect as pseudo transparency with
		178	a custom pixmap. No scaling is supported in this mode. Exmaple:
		179
		180	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
86		181
87	=item block-graphics-to-ascii	182	=item block-graphics-to-ascii
88		183
89	A not very useful example of filtering all text output to the terminal,	184	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	185	by replacing all line-drawing characters (U+2500 .. U+259F) by a
91	similar-looking ascii character.	186	similar-looking ascii character.
92		187
		188	=item digital-clock
		189
		190	Displays a digital clock using the built-in overlay.
		191
93	=item example-refresh-hooks	192	=item example-refresh-hooks
94		193
95	Displays a very simple digital clock in the upper right corner of the	194	Displays a very simple digital clock in the upper right corner of the
96	window. Illustrates overwriting the refresh callbacks to create your own	195	window. Illustrates overwriting the refresh callbacks to create your own
97	overlays or changes.	196	overlays or changes.
98		197
		198	=item selection-pastebin
		199
		200	This is a little rarely useful extension that Uploads the selection as
		201	textfile to a remote site (or does other things). (The implementation is
		202	not currently secure for use in a multiuser environment as it writes to
		203	F</tmp> directly.).
		204
		205	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		206	i.e.
		207
		208	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		209
		210	Pressing this combination runs a command with C<%> replaced by the name of
		211	the textfile. This command can be set via a resource:
		212
		213	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		214
		215	And the default is likely not useful to anybody but the few people around
		216	here :)
		217
		218	The name of the textfile is the hex encoded md5 sum of the selection, so
		219	the same content should lead to the same filename.
		220
		221	After a successful upload the selection will be replaced by the text given
		222	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		223	for the filename):
		224
		225	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		226
99	=back	227	=back
		228
		229	=head1 API DOCUMENTATION
100		230
101	=head2 General API Considerations	231	=head2 General API Considerations
102		232
103	All objects (such as terminals, time watchers etc.) are typical	233	All objects (such as terminals, time watchers etc.) are typical
104	reference-to-hash objects. The hash can be used to store anything you	234	reference-to-hash objects. The hash can be used to store anything you
…		…
117	=over 4	247	=over 4
118		248
119	=item $text	249	=item $text
120		250
121	Rxvt-unicodes special way of encoding text, where one "unicode" character	251	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.	252	always represents one screen cell. See L<ROW_t> for a discussion of this format.
123		253
124	=item $string	254	=item $string
125		255
126	A perl text string, with an emphasis on I<text>. It can store all unicode	256	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	257	characters and is to be distinguished with text encoded in a specific
…		…
173	called whenever the relevant event happens.	303	called whenever the relevant event happens.
174		304
175	The first argument passed to them is an extension oject as described in	305	The first argument passed to them is an extension oject as described in
176	the in the C<Extension Objects> section.	306	the in the C<Extension Objects> section.
177		307
178	B<All> of these hooks must return a boolean value. If it is true, then the	308	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	309	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.	310	relevant action might not be carried out by the C++ code.
181		311
182	I<< When in doubt, return a false value (preferably C<()>). >>	312	I<< When in doubt, return a false value (preferably C<()>). >>
183		313
184	=over 4	314	=over 4
185		315
186	=item on_init $term	316	=item on_init $term
187		317
188	Called after a new terminal object has been initialized, but before	318	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	319	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	320	call or deliver senseless data, as terminal size and other characteristics
191	have not yet been determined. You can safely query and change resources,	321	have not yet been determined. You can safely query and change resources
192	though.	322	and options, though. For many purposes the C<on_start> hook is a better
		323	place.
		324
		325	=item on_start $term
		326
		327	Called at the very end of initialisation of a new terminal, just before
		328	trying to map (display) the toplevel and returning to the mainloop.
		329
		330	=item on_destroy $term
		331
		332	Called whenever something tries to destroy terminal, before doing anything
		333	yet. If this hook returns true, then destruction is skipped, but this is
		334	rarely a good idea.
193		335
194	=item on_reset $term	336	=item on_reset $term
195		337
196	Called after the screen is "reset" for any reason, such as resizing or	338	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	339	control sequences. Here is where you can react on changes to size-related
198	variables.	340	variables.
199		341
200	=item on_start $term	342	=item on_child_start $term, $pid
201		343
202	Called at the very end of initialisation of a new terminal, just before	344	Called just after the child process has been C<fork>ed.
203	returning to the mainloop.	345
		346	=item on_child_exit $term, $status
		347
		348	Called just after the child process has exited. C<$status> is the status
		349	from C<waitpid>.
204		350
205	=item on_sel_make $term, $eventtime	351	=item on_sel_make $term, $eventtime
206		352
207	Called whenever a selection has been made by the user, but before the	353	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	354	selection text is copied, so changes to the beginning, end or type of the
…		…
222	=item on_sel_extend $term	368	=item on_sel_extend $term
223		369
224	Called whenever the user tries to extend the selection (e.g. with a double	370	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	371	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	372	should extend the selection itelf and return true to suppress the built-in
227	processing.	373	processing. This can happen multiple times, as long as the callback
		374	returns true, it will be called on every further click by the user and is
		375	supposed to enlarge the selection more and more, if possible.
228		376
229	See the F<selection> example extension.	377	See the F<selection> example extension.
230		378
231	=item on_view_change $term, $offset	379	=item on_view_change $term, $offset
232		380
…		…
263	can filter/change and output the text yourself by returning a true value	411	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	412	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	413	might be very slow, however, as your hook is called for B<all> text being
266	output.	414	output.
267		415
		416	=item on_tt_write $term, $octets
		417
		418	Called whenever some data is written to the tty/pty and can be used to
		419	suppress or filter tty input.
		420
268	=item on_line_update $term, $row	421	=item on_line_update $term, $row
269		422
270	Called whenever a line was updated or changed. Can be used to filter	423	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	424	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,	425	that are being shown will be filtered, and, due to performance reasons,
…		…
294		447
295	Called whenever the user presses a key combination that has a	448	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>	449	C<perl:string> action bound to it (see description of the B<keysym>
297	resource in the @@RXVT_NAME@@(1) manpage).	450	resource in the @@RXVT_NAME@@(1) manpage).
298		451
		452	=item on_x_event $term, $event
		453
		454	Called on every X event received on the vt window (and possibly other
		455	windows). Should only be used as a last resort. Most event structure
		456	members are not passed.
		457
299	=item on_focus_in $term	458	=item on_focus_in $term
300		459
301	Called whenever the window gets the keyboard focus, before rxvt-unicode	460	Called whenever the window gets the keyboard focus, before rxvt-unicode
302	does focus in processing.	461	does focus in processing.
303		462
304	=item on_focus_out $term	463	=item on_focus_out $term
305		464
306	Called wheneever the window loses keyboard focus, before rxvt-unicode does	465	Called wheneever the window loses keyboard focus, before rxvt-unicode does
307	focus out processing.	466	focus out processing.
		467
		468	=item on_configure_notify $term, $event
308		469
309	=item on_key_press $term, $event, $keysym, $octets	470	=item on_key_press $term, $event, $keysym, $octets
310		471
311	=item on_key_release $term, $event, $keysym	472	=item on_key_release $term, $event, $keysym
312		473
…		…
329		490
330	C<on_key_press> additionally receives the string rxvt-unicode would	491	C<on_key_press> additionally receives the string rxvt-unicode would
331	output, if any, in locale-specific encoding.	492	output, if any, in locale-specific encoding.
332		493
333	subwindow.	494	subwindow.
334
335	=back
336
337	=head2 Variables in the C<urxvt> Package
338
339	=over 4
340
341	=item $urxvt::TERM
342
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		495
445	=back	496	=back
446		497
447	=cut	498	=cut
448		499
…		…
454	use Scalar::Util ();	505	use Scalar::Util ();
455	use List::Util ();	506	use List::Util ();
456		507
457	our $VERSION = 1;	508	our $VERSION = 1;
458	our $TERM;	509	our $TERM;
		510	our @TERM_INIT;
		511	our @TERM_EXT;
459	our @HOOKNAME;	512	our @HOOKNAME;
460	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	513	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
461	our %OPTION;	514	our %OPTION;
		515
462	our $LIBDIR;	516	our $LIBDIR;
		517	our $RESNAME;
		518	our $RESCLASS;
		519	our $RXVTNAME;
		520
		521	=head2 Variables in the C<urxvt> Package
		522
		523	=over 4
		524
		525	=item $urxvt::LIBDIR
		526
		527	The rxvt-unicode library directory, where, among other things, the perl
		528	modules and scripts are stored.
		529
		530	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		531
		532	The resource class and name rxvt-unicode uses to look up X resources.
		533
		534	=item $urxvt::RXVTNAME
		535
		536	The basename of the installed binaries, usually C<urxvt>.
		537
		538	=item $urxvt::TERM
		539
		540	The current terminal. This variable stores the current C<urxvt::term>
		541	object, whenever a callback/hook is executing.
		542
		543	=item @urxvt::TERM_INIT
		544
		545	All coderefs in this array will be called as methods of the next newly
		546	created C<urxvt::term> object (during the C<on_init> phase). The array
		547	gets cleared before the codereferences that were in it are being executed,
		548	so coderefs can push themselves onto it again if they so desire.
		549
		550	This complements to the perl-eval commandline option, but gets executed
		551	first.
		552
		553	=item @urxvt::TERM_EXT
		554
		555	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		556	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		557	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		558
		559	=back
		560
		561	=head2 Functions in the C<urxvt> Package
		562
		563	=over 4
		564
		565	=item urxvt::fatal $errormessage
		566
		567	Fatally aborts execution with the given error message. Avoid at all
		568	costs! The only time this is acceptable is when the terminal process
		569	starts up.
		570
		571	=item urxvt::warn $string
		572
		573	Calls C<rxvt_warn> with the given string which should not include a
		574	newline. The module also overwrites the C<warn> builtin with a function
		575	that calls this function.
		576
		577	Using this function has the advantage that its output ends up in the
		578	correct place, e.g. on stderr of the connecting urxvtc client.
		579
		580	Messages have a size limit of 1023 bytes currently.
		581
		582	=item $time = urxvt::NOW
		583
		584	Returns the "current time" (as per the event loop).
		585
		586	=item urxvt::CurrentTime
		587
		588	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		589	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		590	Button4Mask, Button5Mask, AnyModifier
		591
		592	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		593	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		594	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		595	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		596	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		597	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		598	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		599
		600	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		601	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		602	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		603	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		604	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		605	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		606	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		607
		608	Various constants for use in X calls and event processing.
		609
		610	=back
		611
		612	=head2 RENDITION
		613
		614	Rendition bitsets contain information about colour, font, font styles and
		615	similar information for each screen cell.
		616
		617	The following "macros" deal with changes in rendition sets. You should
		618	never just create a bitset, you should always modify an existing one,
		619	as they contain important information required for correct operation of
		620	rxvt-unicode.
		621
		622	=over 4
		623
		624	=item $rend = urxvt::DEFAULT_RSTYLE
		625
		626	Returns the default rendition, as used when the terminal is starting up or
		627	being reset. Useful as a base to start when creating renditions.
		628
		629	=item $rend = urxvt::OVERLAY_RSTYLE
		630
		631	Return the rendition mask used for overlays by default.
		632
		633	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		634
		635	Return the bit that enabled bold, italic, blink, reverse-video and
		636	underline, respectively. To enable such a style, just logically OR it into
		637	the bitset.
		638
		639	=item $foreground = urxvt::GET_BASEFG $rend
		640
		641	=item $background = urxvt::GET_BASEBG $rend
		642
		643	Return the foreground/background colour index, respectively.
		644
		645	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		646
		647	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		648
		649	Replace the foreground/background colour in the rendition mask with the
		650	specified one.
		651
		652	=item $value = urxvt::GET_CUSTOM $rend
		653
		654	Return the "custom" value: Every rendition has 5 bits for use by
		655	extensions. They can be set and changed as you like and are initially
		656	zero.
		657
		658	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		659
		660	Change the custom value.
		661
		662	=back
		663
		664	=cut
463		665
464	BEGIN {	666	BEGIN {
465	urxvt->bootstrap;
466
467	# overwrite perl's warn	667	# overwrite perl's warn
468	*CORE::GLOBAL::warn = sub {	668	*CORE::GLOBAL::warn = sub {
469	my $msg = join "", @_;	669	my $msg = join "", @_;
470	$msg .= "\n"	670	$msg .= "\n"
471	unless $msg =~ /\n$/;	671	unless $msg =~ /\n$/;
472	urxvt::warn ($msg);	672	urxvt::warn ($msg);
473	};	673	};
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	}	674	}
480		675
481	my @hook_count;
482	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	676	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
483		677
484	sub verbose {	678	sub verbose {
485	my ($level, $msg) = @_;	679	my ($level, $msg) = @_;
486	warn "$msg\n" if $level <= $verbosity;	680	warn "$msg\n" if $level <= $verbosity;
487	}	681	}
488		682
489	my $extension_pkg = "extension0000";
490	my %extension_pkg;	683	my %extension_pkg;
491		684
492	# load a single script into its own package, once only	685	# load a single script into its own package, once only
493	sub extension_package($) {	686	sub extension_package($) {
494	my ($path) = @_;	687	my ($path) = @_;
495		688
496	$extension_pkg{$path} \|\|= do {	689	$extension_pkg{$path} \|\|= do {
497	my $pkg = "urxvt::" . ($extension_pkg++);	690	$path =~ /([^\/\\]+)$/;
		691	my $pkg = $1;
		692	$pkg =~ s/[^[:word:]]/_/g;
		693	$pkg = "urxvt::ext::$pkg";
498		694
499	verbose 3, "loading extension '$path' into package '$pkg'";	695	verbose 3, "loading extension '$path' into package '$pkg'";
500		696
501	open my $fh, "<:raw", $path	697	open my $fh, "<:raw", $path
502	or die "$path: $!";	698	or die "$path: $!";
503		699
504	my $source = untaint	700	my $source =
505	"package $pkg; use strict; use utf8;\n"	701	"package $pkg; use strict; use utf8;\n"
506	. "use base urxvt::term::proxy::;\n"
507	. "#line 1 \"$path\"\n{\n"	702	. "#line 1 \"$path\"\n{\n"
508	. (do { local $/; <$fh> })	703	. (do { local $/; <$fh> })
509	. "\n};\n1";	704	. "\n};\n1";
510		705
511	eval $source	706	eval $source
…		…
525	if ($htype == 0) { # INIT	720	if ($htype == 0) { # INIT
526	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	721	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
527		722
528	my %ext_arg;	723	my %ext_arg;
529		724
		725	{
		726	my @init = @TERM_INIT;
		727	@TERM_INIT = ();
		728	$_->($TERM) for @init;
		729	my @pkg = @TERM_EXT;
		730	@TERM_EXT = ();
		731	$TERM->register_package ($_) for @pkg;
		732	}
		733
530	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	734	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
531	if ($_ eq "default") {	735	if ($_ eq "default") {
532	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	736	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);
533	} elsif (/^-(.*)$/) {	737	} elsif (/^-(.*)$/) {
534	delete $ext_arg{$1};	738	delete $ext_arg{$1};
535	} elsif (/^([^<]+)<(.*)>$/) {	739	} elsif (/^([^<]+)<(.*)>$/) {
…		…
560	if $verbosity >= 10;	764	if $verbosity >= 10;
561		765
562	keys %$cb;	766	keys %$cb;
563		767
564	while (my ($pkg, $cb) = each %$cb) {	768	while (my ($pkg, $cb) = each %$cb) {
565	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	769	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
566	and last;	770	$retval \|\|= $retval_;
567		771
568	if ($@) {	772	if ($@) {
569	$TERM->ungrab; # better to lose the grab than the session	773	$TERM->ungrab; # better to lose the grab than the session
570	warn $@;	774	warn $@;
571	}	775	}
572	}	776	}
		777
		778	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		779	if $verbosity >= 11;
573	}	780	}
574		781
575	if ($htype == 1) { # DESTROY	782	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	783	# clear package objects
584	%$_ = () for values %{ $TERM->{_pkg} };	784	%$_ = () for values %{ $TERM->{_pkg} };
585		785
586	# clear package	786	# clear package
587	%$TERM = ();	787	%$TERM = ();
588	}	788	}
589		789
590	$retval	790	$retval
591	}	791	}
592		792
593	# urxvt::term::proxy	793	# urxvt::term::extension
594		794
595	package urxvt::term::proxy;	795	package urxvt::term::extension;
596		796
597	sub enable {	797	sub enable {
598	my ($self, %hook) = @_;	798	my ($self, %hook) = @_;
599	my $pkg = $self->{_pkg};	799	my $pkg = $self->{_pkg};
600		800
601	while (my ($name, $cb) = each %hook) {	801	while (my ($name, $cb) = each %hook) {
602	my $htype = $HOOKTYPE{uc $name};	802	my $htype = $HOOKTYPE{uc $name};
603	defined $htype	803	defined $htype
604	or Carp::croak "unsupported hook type '$name'";	804	or Carp::croak "unsupported hook type '$name'";
605		805
		806	$self->set_should_invoke ($htype, +1)
606	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	807	unless exists $self->{term}{_hook}[$htype]{$pkg};
607	$hook_count[$htype]++
608	or urxvt::set_should_invoke $htype, 1;
609	}
610		808
611	$self->{term}{_hook}[$htype]{$pkg} = $cb;	809	$self->{term}{_hook}[$htype]{$pkg} = $cb;
612	}	810	}
613	}	811	}
614		812
…		…
619	for my $name (@hook) {	817	for my $name (@hook) {
620	my $htype = $HOOKTYPE{uc $name};	818	my $htype = $HOOKTYPE{uc $name};
621	defined $htype	819	defined $htype
622	or Carp::croak "unsupported hook type '$name'";	820	or Carp::croak "unsupported hook type '$name'";
623		821
		822	$self->set_should_invoke ($htype, -1)
624	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	823	if delete $self->{term}{_hook}[$htype]{$pkg};
625	--$hook_count[$htype]
626	or urxvt::set_should_invoke $htype, 0;
627	}
628	}	824	}
629	}	825	}
630		826
631	our $AUTOLOAD;	827	our $AUTOLOAD;
632		828
…		…
663		859
664	=head2 The C<urxvt::anyevent> Class	860	=head2 The C<urxvt::anyevent> Class
665		861
666	The sole purpose of this class is to deliver an interface to the	862	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	863	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	864	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	865	condition variables, but non-blocking condvar use is ok. What this means
670	cannot use blocking APIs, but the non-blocking variant should work.	866	is that you cannot use blocking APIs, but the non-blocking variant should
		867	work.
671		868
672	=cut	869	=cut
673		870
674	our $VERSION = 1;	871	our $VERSION = 1;
675		872
…		…
737	# find on_xxx subs in the package and register them	934	# find on_xxx subs in the package and register them
738	# as hooks	935	# as hooks
739	sub register_package {	936	sub register_package {
740	my ($self, $pkg, $argv) = @_;	937	my ($self, $pkg, $argv) = @_;
741		938
		939	no strict 'refs';
		940
		941	urxvt::verbose 6, "register package $pkg to $self";
		942
		943	@{"$pkg\::ISA"} = urxvt::term::extension::;
		944
742	my $proxy = bless {	945	my $proxy = bless {
743	_pkg => $pkg,	946	_pkg => $pkg,
744	argv => $argv,	947	argv => $argv,
745	}, $pkg;	948	}, $pkg;
746	Scalar::Util::weaken ($proxy->{term} = $self);	949	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
752	$proxy->enable ($name => $ref);	955	$proxy->enable ($name => $ref);
753	}	956	}
754	}	957	}
755	}	958	}
756		959
		960	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		961
		962	Creates a new terminal, very similar as if you had started it with system
		963	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		964	hash which defines the environment of the new terminal.
		965
		966	Croaks (and probably outputs an error message) if the new instance
		967	couldn't be created. Returns C<undef> if the new instance didn't
		968	initialise perl, and the terminal object otherwise. The C<init> and
		969	C<start> hooks will be called during this call.
		970
		971	=cut
		972
		973	sub new {
		974	my ($class, $env, @args) = @_;
		975
		976	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		977	}
		978
757	=item $term->destroy	979	=item $term->destroy
758		980
759	Destroy the terminal object (close the window, free resources etc.).	981	Destroy the terminal object (close the window, free resources
		982	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		983	watchers (timers, io watchers) are still active.
		984
		985	=item $term->exec_async ($cmd[, @args])
		986
		987	Works like the combination of the C<fork>/C<exec> builtins, which executes
		988	("starts") programs in the background. This function takes care of setting
		989	the user environment before exec'ing the command (e.g. C<PATH>) and should
		990	be preferred over explicit calls to C<exec> or C<system>.
		991
		992	Returns the pid of the subprocess or C<undef> on error.
		993
		994	=cut
		995
		996	sub exec_async {
		997	my $self = shift;
		998
		999	my $pid = fork;
		1000
		1001	return $pid
		1002	if !defined $pid or $pid;
		1003
		1004	%ENV = %{ $self->env };
		1005
		1006	exec @_;
		1007	urxvt::_exit 255;
		1008	}
760		1009
761	=item $isset = $term->option ($optval[, $set])	1010	=item $isset = $term->option ($optval[, $set])
762		1011
763	Returns true if the option specified by C<$optval> is enabled, and	1012	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	1013	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	1016	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:	1017	source file F</src/optinc.h> to see the actual list:
769		1018
770	borderLess console cursorBlink cursorUnderline hold iconic insecure	1019	borderLess console cursorBlink cursorUnderline hold iconic insecure
771	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1020	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
772	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1021	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
773	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1022	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
774	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1023	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
775	tripleclickwords utmpInhibit visualBell	1024	transparent tripleclickwords utmpInhibit visualBell
776		1025
777	=item $value = $term->resource ($name[, $newval])	1026	=item $value = $term->resource ($name[, $newval])
778		1027
779	Returns the current resource value associated with a given name and	1028	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>	1029	optionally sets a new value. Setting values is most useful in the C<init>
…		…
797		1046
798	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1047	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
799	borderLess color cursorBlink cursorUnderline cutchars delete_key	1048	borderLess color cursorBlink cursorUnderline cutchars delete_key
800	display_name embed ext_bwidth fade font geometry hold iconName	1049	display_name embed ext_bwidth fade font geometry hold iconName
801	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1050	imFont imLocale inputMethod insecure int_bwidth intensityStyles
802	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1051	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
803	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1052	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
804	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1053	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
805	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1054	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
806	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1055	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
807	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1056	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
808	shade term_name title transparent transparent_all tripleclickwords	1057	secondaryScreen secondaryScroll selectstyle shade term_name title
809	utmpInhibit visualBell	1058	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1059	visualBell
810		1060
811	=cut	1061	=cut
812		1062
813	sub resource($$;$) {	1063	sub resource($$;$) {
814	my ($self, $name) = (shift, shift);	1064	my ($self, $name) = (shift, shift);
815	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1065	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
816	&urxvt::term::_resource	1066	&urxvt::term::_resource
817	}	1067	}
818		1068
		1069	=item $value = $term->x_resource ($pattern)
		1070
		1071	Returns the X-Resource for the given pattern, excluding the program or
		1072	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1073	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1074	resource with that pattern exists.
		1075
		1076	This method should only be called during the C<on_start> hook, as there is
		1077	only one resource database per display, and later invocations might return
		1078	the wrong resources.
		1079
819	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1080	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
820		1081
821	Adds a keymap translation exactly as specified via a resource. See the	1082	Adds a keymap translation exactly as specified via a resource. See the
822	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1083	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
823		1084
…		…
838	=item ($row, $col) = $term->selection_end ([$row, $col])	1099	=item ($row, $col) = $term->selection_end ([$row, $col])
839		1100
840	Return the current values of the selection mark, begin or end positions,	1101	Return the current values of the selection mark, begin or end positions,
841	and optionally set them to new values.	1102	and optionally set them to new values.
842		1103
		1104	=item $term->selection_make ($eventtime[, $rectangular])
		1105
		1106	Tries to make a selection as set by C<selection_beg> and
		1107	C<selection_end>. If C<$rectangular> is true (default: false), a
		1108	rectangular selection will be made. This is the prefered function to make
		1109	a selection.
		1110
843	=item $success = $term->selection_grab ($eventtime)	1111	=item $success = $term->selection_grab ($eventtime)
844		1112
845	Try to request the primary selection from the server (for example, as set	1113	Try to request the primary selection text from the server (for example, as
846	by the next method).	1114	set by the next method). No visual feedback will be given. This function
		1115	is mostly useful from within C<on_sel_grab> hooks.
847		1116
848	=item $oldtext = $term->selection ([$newtext])	1117	=item $oldtext = $term->selection ([$newtext])
849		1118
850	Return the current selection text and optionally replace it by C<$newtext>.	1119	Return the current selection text and optionally replace it by C<$newtext>.
851		1120
…		…
941		1210
942	=item $string = $term->locale_decode ($octets)	1211	=item $string = $term->locale_decode ($octets)
943		1212
944	Convert the given locale-encoded octets into a perl string.	1213	Convert the given locale-encoded octets into a perl string.
945		1214
		1215	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1216
		1217	XORs the rendition values in the given span with the provided value
		1218	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1219	refresh hooks to provide effects similar to the selection.
		1220
		1221	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1222
		1223	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1224	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1225	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1226	it instead. Both styles I<MUST NOT> contain font styles.
		1227
946	=item $term->scr_bell	1228	=item $term->scr_bell
947		1229
948	Ring the bell!	1230	Ring the bell!
949		1231
950	=item $term->scr_add_lines ($string)	1232	=item $term->scr_add_lines ($string)
…		…
983		1265
984	=item $windowid = $term->vt	1266	=item $windowid = $term->vt
985		1267
986	Return the window id of the terminal window.	1268	Return the window id of the terminal window.
987		1269
		1270	=item $term->vt_emask_add ($x_event_mask)
		1271
		1272	Adds the specified events to the vt event mask. Useful e.g. when you want
		1273	to receive pointer events all the times:
		1274
		1275	$term->vt_emask_add (urxvt::PointerMotionMask);
		1276
988	=item $window_width = $term->width	1277	=item $window_width = $term->width
989		1278
990	=item $window_height = $term->height	1279	=item $window_height = $term->height
991		1280
992	=item $font_width = $term->fwidth	1281	=item $font_width = $term->fwidth
…		…
1005		1294
1006	=item $max_scrollback = $term->saveLines	1295	=item $max_scrollback = $term->saveLines
1007		1296
1008	=item $nrow_plus_saveLines = $term->total_rows	1297	=item $nrow_plus_saveLines = $term->total_rows
1009		1298
1010	=item $lines_in_scrollback = $term->nsaved	1299	=item $topmost_scrollback_row = $term->top_row
1011		1300
1012	Return various integers describing terminal characteristics.	1301	Return various integers describing terminal characteristics.
1013		1302
		1303	=item $x_display = $term->display_id
		1304
		1305	Return the DISPLAY used by rxvt-unicode.
		1306
1014	=item $lc_ctype = $term->locale	1307	=item $lc_ctype = $term->locale
1015		1308
1016	Returns the LC_CTYPE category string used by this rxvt-unicode.	1309	Returns the LC_CTYPE category string used by this rxvt-unicode.
1017		1310
1018	=item $x_display = $term->display_id	1311	=item $env = $term->env
1019		1312
1020	Return the DISPLAY used by rxvt-unicode.	1313	Returns a copy of the environment in effect for the terminal as a hashref
		1314	similar to C<\%ENV>.
		1315
		1316	=cut
		1317
		1318	sub env {
		1319	if (my $env = $_[0]->_env) {
		1320	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1321	} else {
		1322	+{ %ENV }
		1323	}
		1324	}
1021		1325
1022	=item $modifiermask = $term->ModLevel3Mask	1326	=item $modifiermask = $term->ModLevel3Mask
1023		1327
1024	=item $modifiermask = $term->ModMetaMask	1328	=item $modifiermask = $term->ModMetaMask
1025		1329
…		…
1028	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1332	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1029	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1333	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1030		1334
1031	=item $view_start = $term->view_start ([$newvalue])	1335	=item $view_start = $term->view_start ([$newvalue])
1032		1336
1033	Returns the negative row number of the topmost line. Minimum value is	1337	Returns the row number of the topmost displayed line. Maximum value is
1034	C<0>, which displays the normal terminal contents. Larger values scroll	1338	C<0>, which displays the normal terminal contents. Lower values scroll
1035	this many lines into the scrollback buffer.	1339	this many lines into the scrollback buffer.
1036		1340
1037	=item $term->want_refresh	1341	=item $term->want_refresh
1038		1342
1039	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1343	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1118	Return the row number of the first/last row of the line, respectively.	1422	Return the row number of the first/last row of the line, respectively.
1119		1423
1120	=item $offset = $line->offset_of ($row, $col)	1424	=item $offset = $line->offset_of ($row, $col)
1121		1425
1122	Returns the character offset of the given row\|col pair within the logical	1426	Returns the character offset of the given row\|col pair within the logical
1123	line.	1427	line. Works for rows outside the line, too, and returns corresponding
		1428	offsets outside the string.
1124		1429
1125	=item ($row, $col) = $line->coord_of ($offset)	1430	=item ($row, $col) = $line->coord_of ($offset)
1126		1431
1127	Translates a string offset into terminal coordinates again.	1432	Translates a string offset into terminal coordinates again.
1128		1433
…		…
1265	$item->{render} \|\|= sub { $_[0]{text} };	1570	$item->{render} \|\|= sub { $_[0]{text} };
1266		1571
1267	push @{ $self->{item} }, $item;	1572	push @{ $self->{item} }, $item;
1268	}	1573	}
1269		1574
		1575	=item $popup->add_title ($title)
		1576
		1577	Adds a non-clickable title to the popup.
		1578
		1579	=cut
		1580
		1581	sub add_title {
		1582	my ($self, $title) = @_;
		1583
		1584	$self->add_item ({
		1585	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1586	text => $title,
		1587	activate => sub { },
		1588	});
		1589	}
		1590
		1591	=item $popup->add_separator ([$sepchr])
		1592
		1593	Creates a separator, optionally using the character given as C<$sepchr>.
		1594
		1595	=cut
		1596
1270	sub add_separator {	1597	sub add_separator {
1271	my ($self, $sep) = @_;	1598	my ($self, $sep) = @_;
1272		1599
1273	$sep \|\|= "=";	1600	$sep \|\|= "=";
1274		1601
…		…
1278	render => sub { $sep x $self->{term}->ncol },	1605	render => sub { $sep x $self->{term}->ncol },
1279	activate => sub { },	1606	activate => sub { },
1280	});	1607	});
1281	}	1608	}
1282		1609
1283	sub add_title {	1610	=item $popup->add_button ($text, $cb)
1284	my ($self, $title) = @_;
1285		1611
1286	$self->add_item ({	1612	Adds a clickable button to the popup. C<$cb> is called whenever it is
1287	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1613	selected.
1288	text => $title,	1614
1289	activate => sub { },	1615	=cut
1290	});
1291	}
1292		1616
1293	sub add_button {	1617	sub add_button {
1294	my ($self, $text, $cb) = @_;	1618	my ($self, $text, $cb) = @_;
1295		1619
1296	$self->add_item ({ type => "button", text => $text, activate => $cb});	1620	$self->add_item ({ type => "button", text => $text, activate => $cb});
1297	}	1621	}
		1622
		1623	=item $popup->add_toggle ($text, $cb, $initial_value)
		1624
		1625	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1626	whenever it gets toggled, with a boolean indicating its value as its first
		1627	argument.
		1628
		1629	=cut
1298		1630
1299	sub add_toggle {	1631	sub add_toggle {
1300	my ($self, $text, $cb, $value) = @_;	1632	my ($self, $text, $cb, $value) = @_;
1301		1633
1302	my $item; $item = {	1634	my $item; $item = {
1303	type => "button",	1635	type => "button",
1304	text => " $text",	1636	text => " $text",
1305	value => $value,	1637	value => $value,
1306	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1638	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1307	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1639	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1308	};	1640	};
1309		1641
1310	$self->add_item ($item);	1642	$self->add_item ($item);
1311	}	1643	}
		1644
		1645	=item $popup->show
		1646
		1647	Displays the popup (which is initially hidden).
		1648
		1649	=cut
1312		1650
1313	sub show {	1651	sub show {
1314	my ($self) = @_;	1652	my ($self) = @_;
1315		1653
1316	local $urxvt::popup::self = $self;	1654	local $urxvt::popup::self = $self;
1317		1655
		1656	my $env = $self->{term}->env;
		1657	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1658	delete $env->{LC_ALL};
1318	local $ENV{LC_ALL} = $self->{term}->locale;	1659	$env->{LC_CTYPE} = $self->{term}->locale;
1319		1660
1320	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1661	urxvt::term->new ($env, "popup",
		1662	"--perl-lib" => "", "--perl-ext-common" => "",
		1663	"-pty-fd" => -1, "-sl" => 0,
		1664	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1321	"--transient-for" => $self->{term}->parent,	1665	"--transient-for" => $self->{term}->parent,
1322	"-display" => $self->{term}->display_id,	1666	"-display" => $self->{term}->display_id,
1323	"-pe" => "urxvt-popup")	1667	"-pe" => "urxvt-popup")
1324	or die "unable to create popup window\n";	1668	or die "unable to create popup window\n";
1325	}	1669	}
1326		1670
1327	sub DESTROY {	1671	sub DESTROY {
1328	my ($self) = @_;	1672	my ($self) = @_;
1329		1673
1330	delete $self->{term}{_destroy}{$self};	1674	delete $self->{term}{_destroy}{$self};
1331	$self->{term}->ungrab;	1675	$self->{term}->ungrab;
1332	}	1676	}
		1677
		1678	=back
		1679
		1680	=cut
		1681
		1682	package urxvt::watcher;
		1683
		1684	@urxvt::timer::ISA = __PACKAGE__;
		1685	@urxvt::iow::ISA = __PACKAGE__;
		1686	@urxvt::pw::ISA = __PACKAGE__;
		1687	@urxvt::iw::ISA = __PACKAGE__;
1333		1688
1334	=head2 The C<urxvt::timer> Class	1689	=head2 The C<urxvt::timer> Class
1335		1690
1336	This class implements timer watchers/events. Time is represented as a	1691	This class implements timer watchers/events. Time is represented as a
1337	fractional number of seconds since the epoch. Example:	1692	fractional number of seconds since the epoch. Example:
…		…
1375	Start the timer.	1730	Start the timer.
1376		1731
1377	=item $timer = $timer->start ($tstamp)	1732	=item $timer = $timer->start ($tstamp)
1378		1733
1379	Set the event trigger time to C<$tstamp> and start the timer.	1734	Set the event trigger time to C<$tstamp> and start the timer.
		1735
		1736	=item $timer = $timer->after ($delay)
		1737
		1738	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1380		1739
1381	=item $timer = $timer->stop	1740	=item $timer = $timer->stop
1382		1741
1383	Stop the timer.	1742	Stop the timer.
1384		1743
…		…
1444		1803
1445	=item == 0 - fatal messages	1804	=item == 0 - fatal messages
1446		1805
1447	=item >= 3 - script loading and management	1806	=item >= 3 - script loading and management
1448		1807
1449	=item >=10 - all events received	1808	=item >=10 - all called hooks
		1809
		1810	=item >=11 - hook reutrn values
1450		1811
1451	=back	1812	=back
1452		1813
1453	=head1 AUTHOR	1814	=head1 AUTHOR
1454		1815

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.69 by root, Mon Jan 9 22:41:41 2006 UTC vs. Revision 1.113 by root, Fri Jan 20 10:27:08 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.69 by root, Mon Jan 9 22:41:41 2006 UTC vs.
Revision 1.113 by root, Fri Jan 20 10:27:08 2006 UTC