ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

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

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

Diff Legend

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