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.72 by root, Mon Jan 9 23:30:01 2006 UTC vs.
Revision 1.132 by root, Mon Feb 6 05:40:15 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.
		209
		210	The tabbar itself can be configured similarly to a normal terminal, but
		211	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		212	following four resources (shown with defaults):
		213
		214	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		215	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		216	URxvt.tabbed.tab-fg: <colour-index, default 0>
		217	URxvt.tabbed.tab-bg: <colour-index, default 1>
		218
		219	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		220	indices.
82		221
83	=item mark-urls	222	=item mark-urls
84		223
85	Uses per-line display filtering (C<on_line_update>) to underline urls.	224	Uses per-line display filtering (C<on_line_update>) to underline urls and
		225	make them clickable. When middle-clicked, the program specified in the
		226	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		227	the URL as first argument.
		228
		229	=item xim-onthespot
		230
		231	This (experimental) perl extension implements OnTheSpot editing. It does
		232	not work perfectly, and some input methods don't seem to work well with
		233	OnTheSpot editing in general, but it seems to work at leats for SCIM and
		234	kinput2.
		235
		236	You enable it by specifying this extension and a preedit style of
		237	C<OnTheSpot>, i.e.:
		238
		239	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		240
		241	=item automove-background
		242
		243	This is basically a one-line extension that dynamically changes the background pixmap offset
		244	to the window position, in effect creating the same effect as pseudo transparency with
		245	a custom pixmap. No scaling is supported in this mode. Exmaple:
		246
		247	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
86		248
87	=item block-graphics-to-ascii	249	=item block-graphics-to-ascii
88		250
89	A not very useful example of filtering all text output to the terminal,	251	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	252	by replacing all line-drawing characters (U+2500 .. U+259F) by a
91	similar-looking ascii character.	253	similar-looking ascii character.
92		254
		255	=item digital-clock
		256
		257	Displays a digital clock using the built-in overlay.
		258
		259	=item remote-clipboard
		260
		261	Somewhat of a misnomer, this extension adds two menu entries to the
		262	selection popup that allows one ti run external commands to store the
		263	selection somewhere and fetch it again.
		264
		265	We use it to implement a "distributed selection mechanism", which just
		266	means that one command uploads the file to a remote server, and another
		267	reads it.
		268
		269	The commands can be set using the C<URxvt.remote-selection.store> and
		270	C<URxvt.remote-selection.fetch> resources. The first should read the
		271	selection to store from STDIN (always in UTF-8), the second should provide
		272	the selection data on STDOUT (also in UTF-8).
		273
		274	The defaults (which are likely useless to you) use rsh and cat:
		275
		276	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		277	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		278
		279	=item selection-pastebin
		280
		281	This is a little rarely useful extension that Uploads the selection as
		282	textfile to a remote site (or does other things). (The implementation is
		283	not currently secure for use in a multiuser environment as it writes to
		284	F</tmp> directly.).
		285
		286	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		287	i.e.
		288
		289	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		290
		291	Pressing this combination runs a command with C<%> replaced by the name of
		292	the textfile. This command can be set via a resource:
		293
		294	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		295
		296	And the default is likely not useful to anybody but the few people around
		297	here :)
		298
		299	The name of the textfile is the hex encoded md5 sum of the selection, so
		300	the same content should lead to the same filename.
		301
		302	After a successful upload the selection will be replaced by the text given
		303	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		304	for the filename):
		305
		306	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		307
93	=item example-refresh-hooks	308	=item example-refresh-hooks
94		309
95	Displays a very simple digital clock in the upper right corner of the	310	Displays a very simple digital clock in the upper right corner of the
96	window. Illustrates overwriting the refresh callbacks to create your own	311	window. Illustrates overwriting the refresh callbacks to create your own
97	overlays or changes.	312	overlays or changes.
98		313
99	=back	314	=back
		315
		316	=head1 API DOCUMENTATION
100		317
101	=head2 General API Considerations	318	=head2 General API Considerations
102		319
103	All objects (such as terminals, time watchers etc.) are typical	320	All objects (such as terminals, time watchers etc.) are typical
104	reference-to-hash objects. The hash can be used to store anything you	321	reference-to-hash objects. The hash can be used to store anything you
…		…
117	=over 4	334	=over 4
118		335
119	=item $text	336	=item $text
120		337
121	Rxvt-unicodes special way of encoding text, where one "unicode" character	338	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.	339	always represents one screen cell. See L<ROW_t> for a discussion of this format.
123		340
124	=item $string	341	=item $string
125		342
126	A perl text string, with an emphasis on I<text>. It can store all unicode	343	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	344	characters and is to be distinguished with text encoded in a specific
…		…
173	called whenever the relevant event happens.	390	called whenever the relevant event happens.
174		391
175	The first argument passed to them is an extension oject as described in	392	The first argument passed to them is an extension oject as described in
176	the in the C<Extension Objects> section.	393	the in the C<Extension Objects> section.
177		394
178	B<All> of these hooks must return a boolean value. If it is true, then the	395	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	396	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.	397	relevant action might not be carried out by the C++ code.
181		398
182	I<< When in doubt, return a false value (preferably C<()>). >>	399	I<< When in doubt, return a false value (preferably C<()>). >>
183		400
184	=over 4	401	=over 4
185		402
186	=item on_init $term	403	=item on_init $term
187		404
188	Called after a new terminal object has been initialized, but before	405	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	406	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	407	call or deliver senseless data, as terminal size and other characteristics
191	have not yet been determined. You can safely query and change resources,	408	have not yet been determined. You can safely query and change resources
192	though.	409	and options, though. For many purposes the C<on_start> hook is a better
		410	place.
		411
		412	=item on_start $term
		413
		414	Called at the very end of initialisation of a new terminal, just before
		415	trying to map (display) the toplevel and returning to the mainloop.
		416
		417	=item on_destroy $term
		418
		419	Called whenever something tries to destroy terminal, when the terminal is
		420	still fully functional (not for long, though).
193		421
194	=item on_reset $term	422	=item on_reset $term
195		423
196	Called after the screen is "reset" for any reason, such as resizing or	424	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	425	control sequences. Here is where you can react on changes to size-related
198	variables.	426	variables.
199		427
200	=item on_start $term	428	=item on_child_start $term, $pid
201		429
202	Called at the very end of initialisation of a new terminal, just before	430	Called just after the child process has been C<fork>ed.
203	returning to the mainloop.	431
		432	=item on_child_exit $term, $status
		433
		434	Called just after the child process has exited. C<$status> is the status
		435	from C<waitpid>.
204		436
205	=item on_sel_make $term, $eventtime	437	=item on_sel_make $term, $eventtime
206		438
207	Called whenever a selection has been made by the user, but before the	439	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	440	selection text is copied, so changes to the beginning, end or type of the
…		…
222	=item on_sel_extend $term	454	=item on_sel_extend $term
223		455
224	Called whenever the user tries to extend the selection (e.g. with a double	456	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	457	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	458	should extend the selection itelf and return true to suppress the built-in
227	processing.	459	processing. This can happen multiple times, as long as the callback
		460	returns true, it will be called on every further click by the user and is
		461	supposed to enlarge the selection more and more, if possible.
228		462
229	See the F<selection> example extension.	463	See the F<selection> example extension.
230		464
231	=item on_view_change $term, $offset	465	=item on_view_change $term, $offset
232		466
…		…
293		527
294	=item on_refresh_end $term	528	=item on_refresh_end $term
295		529
296	Called just after the screen gets redrawn. See C<on_refresh_begin>.	530	Called just after the screen gets redrawn. See C<on_refresh_begin>.
297		531
298	=item on_keyboard_command $term, $string	532	=item on_user_command $term, $string
299		533
300	Called whenever the user presses a key combination that has a	534	Called whenever the a user-configured event is being activated (e.g. via
301	C<perl:string> action bound to it (see description of the B<keysym>	535	a C<perl:string> action bound to a key, see description of the B<keysym>
302	resource in the @@RXVT_NAME@@(1) manpage).	536	resource in the @@RXVT_NAME@@(1) manpage).
		537
		538	The event is simply the action string. This interface is assumed to change
		539	slightly in the future.
		540
		541	=item on_x_event $term, $event
		542
		543	Called on every X event received on the vt window (and possibly other
		544	windows). Should only be used as a last resort. Most event structure
		545	members are not passed.
303		546
304	=item on_focus_in $term	547	=item on_focus_in $term
305		548
306	Called whenever the window gets the keyboard focus, before rxvt-unicode	549	Called whenever the window gets the keyboard focus, before rxvt-unicode
307	does focus in processing.	550	does focus in processing.
…		…
309	=item on_focus_out $term	552	=item on_focus_out $term
310		553
311	Called wheneever the window loses keyboard focus, before rxvt-unicode does	554	Called wheneever the window loses keyboard focus, before rxvt-unicode does
312	focus out processing.	555	focus out processing.
313		556
		557	=item on_configure_notify $term, $event
		558
		559	=item on_property_notify $term, $event
		560
314	=item on_key_press $term, $event, $keysym, $octets	561	=item on_key_press $term, $event, $keysym, $octets
315		562
316	=item on_key_release $term, $event, $keysym	563	=item on_key_release $term, $event, $keysym
317		564
318	=item on_button_press $term, $event	565	=item on_button_press $term, $event
…		…
327		574
328	Called whenever the corresponding X event is received for the terminal If	575	Called whenever the corresponding X event is received for the terminal If
329	the hook returns true, then the even will be ignored by rxvt-unicode.	576	the hook returns true, then the even will be ignored by rxvt-unicode.
330		577
331	The event is a hash with most values as named by Xlib (see the XEvent	578	The event is a hash with most values as named by Xlib (see the XEvent
332	manpage), with the additional members C<row> and C<col>, which are the row	579	manpage), with the additional members C<row> and C<col>, which are the
333	and column under the mouse cursor.	580	(real, not screen-based) row and column under the mouse cursor.
334		581
335	C<on_key_press> additionally receives the string rxvt-unicode would	582	C<on_key_press> additionally receives the string rxvt-unicode would
336	output, if any, in locale-specific encoding.	583	output, if any, in locale-specific encoding.
337		584
338	subwindow.	585	subwindow.
339		586
340	=back	587	=item on_client_message $term, $event
341		588
342	=head2 Variables in the C<urxvt> Package	589	=item on_wm_protocols $term, $event
343		590
344	=over 4	591	=item on_wm_delete_window $term, $event
345		592
346	=item $urxvt::TERM	593	Called when various types of ClientMessage events are received (all with
347		594	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
348	The current terminal. This variable stores the current C<urxvt::term>
349	object, whenever a callback/hook is executing.
350
351	=back
352
353	=head2 Functions in the C<urxvt> Package
354
355	=over 4
356
357	=item $term = new urxvt [arg...]
358
359	Creates a new terminal, very similar as if you had started it with
360	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
361	if the new instance couldn't be created. Returns C<undef> if the new
362	instance didn't initialise perl, and the terminal object otherwise. The
363	C<init> and C<start> hooks will be called during the call.
364
365	=item urxvt::fatal $errormessage
366
367	Fatally aborts execution with the given error message. Avoid at all
368	costs! The only time this is acceptable is when the terminal process
369	starts up.
370
371	=item urxvt::warn $string
372
373	Calls C<rxvt_warn> with the given string which should not include a
374	newline. The module also overwrites the C<warn> builtin with a function
375	that calls this function.
376
377	Using this function has the advantage that its output ends up in the
378	correct place, e.g. on stderr of the connecting urxvtc client.
379
380	=item $is_safe = urxvt::safe
381
382	Returns true when it is safe to do potentially unsafe things, such as
383	evaluating perl code specified by the user. This is true when urxvt was
384	started setuid or setgid.
385
386	=item $time = urxvt::NOW
387
388	Returns the "current time" (as per the event loop).
389
390	=item urxvt::CurrentTime
391
392	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
393	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
394	Button4Mask, Button5Mask, AnyModifier
395
396	Various constants for use in X calls and event processing.
397
398	=back
399
400	=head2 RENDITION
401
402	Rendition bitsets contain information about colour, font, font styles and
403	similar information for each screen cell.
404
405	The following "macros" deal with changes in rendition sets. You should
406	never just create a bitset, you should always modify an existing one,
407	as they contain important information required for correct operation of
408	rxvt-unicode.
409
410	=over 4
411
412	=item $rend = urxvt::DEFAULT_RSTYLE
413
414	Returns the default rendition, as used when the terminal is starting up or
415	being reset. Useful as a base to start when creating renditions.
416
417	=item $rend = urxvt::OVERLAY_RSTYLE
418
419	Return the rendition mask used for overlays by default.
420
421	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
422
423	Return the bit that enabled bold, italic, blink, reverse-video and
424	underline, respectively. To enable such a style, just logically OR it into
425	the bitset.
426
427	=item $foreground = urxvt::GET_BASEFG $rend
428
429	=item $background = urxvt::GET_BASEBG $rend
430
431	Return the foreground/background colour index, respectively.
432
433	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
434
435	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
436
437	Replace the foreground/background colour in the rendition mask with the
438	specified one.
439
440	=item $value = urxvt::GET_CUSTOM ($rend)
441
442	Return the "custom" value: Every rendition has 5 bits for use by
443	extensions. They can be set and changed as you like and are initially
444	zero.
445
446	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
447
448	Change the custom value.
449		595
450	=back	596	=back
451		597
452	=cut	598	=cut
453		599
…		…
459	use Scalar::Util ();	605	use Scalar::Util ();
460	use List::Util ();	606	use List::Util ();
461		607
462	our $VERSION = 1;	608	our $VERSION = 1;
463	our $TERM;	609	our $TERM;
		610	our @TERM_INIT;
		611	our @TERM_EXT;
464	our @HOOKNAME;	612	our @HOOKNAME;
465	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	613	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
466	our %OPTION;	614	our %OPTION;
		615
467	our $LIBDIR;	616	our $LIBDIR;
		617	our $RESNAME;
		618	our $RESCLASS;
		619	our $RXVTNAME;
		620
		621	our $NOCHAR = chr 0xffff;
		622
		623	=head2 Variables in the C<urxvt> Package
		624
		625	=over 4
		626
		627	=item $urxvt::LIBDIR
		628
		629	The rxvt-unicode library directory, where, among other things, the perl
		630	modules and scripts are stored.
		631
		632	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		633
		634	The resource class and name rxvt-unicode uses to look up X resources.
		635
		636	=item $urxvt::RXVTNAME
		637
		638	The basename of the installed binaries, usually C<urxvt>.
		639
		640	=item $urxvt::TERM
		641
		642	The current terminal. This variable stores the current C<urxvt::term>
		643	object, whenever a callback/hook is executing.
		644
		645	=item @urxvt::TERM_INIT
		646
		647	All coderefs in this array will be called as methods of the next newly
		648	created C<urxvt::term> object (during the C<on_init> phase). The array
		649	gets cleared before the codereferences that were in it are being executed,
		650	so coderefs can push themselves onto it again if they so desire.
		651
		652	This complements to the perl-eval commandline option, but gets executed
		653	first.
		654
		655	=item @urxvt::TERM_EXT
		656
		657	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		658	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		659	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		660
		661	=back
		662
		663	=head2 Functions in the C<urxvt> Package
		664
		665	=over 4
		666
		667	=item urxvt::fatal $errormessage
		668
		669	Fatally aborts execution with the given error message. Avoid at all
		670	costs! The only time this is acceptable is when the terminal process
		671	starts up.
		672
		673	=item urxvt::warn $string
		674
		675	Calls C<rxvt_warn> with the given string which should not include a
		676	newline. The module also overwrites the C<warn> builtin with a function
		677	that calls this function.
		678
		679	Using this function has the advantage that its output ends up in the
		680	correct place, e.g. on stderr of the connecting urxvtc client.
		681
		682	Messages have a size limit of 1023 bytes currently.
		683
		684	=item @terms = urxvt::termlist
		685
		686	Returns all urxvt::term objects that exist in this process, regardless of
		687	wether they are started, being destroyed etc., so be careful. Only term
		688	objects that have perl extensions attached will be returned (because there
		689	is no urxvt::term objet associated with others).
		690
		691	=item $time = urxvt::NOW
		692
		693	Returns the "current time" (as per the event loop).
		694
		695	=item urxvt::CurrentTime
		696
		697	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		698	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		699	Button4Mask, Button5Mask, AnyModifier
		700
		701	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		702	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		703	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		704	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		705	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		706	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		707	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		708
		709	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		710	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		711	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		712	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		713	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		714	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		715	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		716
		717	Various constants for use in X calls and event processing.
		718
		719	=back
		720
		721	=head2 RENDITION
		722
		723	Rendition bitsets contain information about colour, font, font styles and
		724	similar information for each screen cell.
		725
		726	The following "macros" deal with changes in rendition sets. You should
		727	never just create a bitset, you should always modify an existing one,
		728	as they contain important information required for correct operation of
		729	rxvt-unicode.
		730
		731	=over 4
		732
		733	=item $rend = urxvt::DEFAULT_RSTYLE
		734
		735	Returns the default rendition, as used when the terminal is starting up or
		736	being reset. Useful as a base to start when creating renditions.
		737
		738	=item $rend = urxvt::OVERLAY_RSTYLE
		739
		740	Return the rendition mask used for overlays by default.
		741
		742	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		743
		744	Return the bit that enabled bold, italic, blink, reverse-video and
		745	underline, respectively. To enable such a style, just logically OR it into
		746	the bitset.
		747
		748	=item $foreground = urxvt::GET_BASEFG $rend
		749
		750	=item $background = urxvt::GET_BASEBG $rend
		751
		752	Return the foreground/background colour index, respectively.
		753
		754	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		755
		756	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		757
		758	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		759
		760	Replace the foreground/background colour in the rendition mask with the
		761	specified one.
		762
		763	=item $value = urxvt::GET_CUSTOM $rend
		764
		765	Return the "custom" value: Every rendition has 5 bits for use by
		766	extensions. They can be set and changed as you like and are initially
		767	zero.
		768
		769	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		770
		771	Change the custom value.
		772
		773	=back
		774
		775	=cut
468		776
469	BEGIN {	777	BEGIN {
470	urxvt->bootstrap;
471
472	# overwrite perl's warn	778	# overwrite perl's warn
473	*CORE::GLOBAL::warn = sub {	779	*CORE::GLOBAL::warn = sub {
474	my $msg = join "", @_;	780	my $msg = join "", @_;
475	$msg .= "\n"	781	$msg .= "\n"
476	unless $msg =~ /\n$/;	782	unless $msg =~ /\n$/;
477	urxvt::warn ($msg);	783	urxvt::warn ($msg);
478	};	784	};
479
480	delete $ENV{IFS};
481	delete $ENV{CDPATH};
482	delete $ENV{BASH_ENV};
483	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
484	}	785	}
485		786
486	my @hook_count;	787	no warnings 'utf8';
		788
487	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	789	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
488		790
489	sub verbose {	791	sub verbose {
490	my ($level, $msg) = @_;	792	my ($level, $msg) = @_;
491	warn "$msg\n" if $level <= $verbosity;	793	warn "$msg\n" if $level <= $verbosity;
492	}	794	}
493		795
494	my $extension_pkg = "extension0000";
495	my %extension_pkg;	796	my %extension_pkg;
496		797
497	# load a single script into its own package, once only	798	# load a single script into its own package, once only
498	sub extension_package($) {	799	sub extension_package($) {
499	my ($path) = @_;	800	my ($path) = @_;
500		801
501	$extension_pkg{$path} ||= do {	802	$extension_pkg{$path} ||= do {
502	my $pkg = "urxvt::" . ($extension_pkg++);	803	$path =~ /([^\/\\]+)$/;
		804	my $pkg = $1;
		805	$pkg =~ s/[^[:word:]]/_/g;
		806	$pkg = "urxvt::ext::$pkg";
503		807
504	verbose 3, "loading extension '$path' into package '$pkg'";	808	verbose 3, "loading extension '$path' into package '$pkg'";
505		809
506	open my $fh, "<:raw", $path	810	open my $fh, "<:raw", $path
507	or die "$path: $!";	811	or die "$path: $!";
508		812
509	my $source = untaint	813	my $source =
510	"package $pkg; use strict; use utf8;\n"	814	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
511	. "use base urxvt::term::extension::;\n"
512	. "#line 1 \"$path\"\n{\n"	815	. "#line 1 \"$path\"\n{\n"
513	. (do { local $/; <$fh> })	816	. (do { local $/; <$fh> })
514	. "\n};\n1";	817	. "\n};\n1";
515		818
516	eval $source	819	eval $source
…		…
530	if ($htype == 0) { # INIT	833	if ($htype == 0) { # INIT
531	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	834	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
532		835
533	my %ext_arg;	836	my %ext_arg;
534		837
		838	{
		839	my @init = @TERM_INIT;
		840	@TERM_INIT = ();
		841	$_->($TERM) for @init;
		842	my @pkg = @TERM_EXT;
		843	@TERM_EXT = ();
		844	$TERM->register_package ($_) for @pkg;
		845	}
		846
535	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	847	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
536	if ($_ eq "default") {	848	if ($_ eq "default") {
537	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	849	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
538	} elsif (/^-(.*)$/) {	850	} elsif (/^-(.*)$/) {
539	delete $ext_arg{$1};	851	delete $ext_arg{$1};
540	} elsif (/^([^<]+)<(.*)>$/) {	852	} elsif (/^([^<]+)<(.*)>$/) {
541	push @{ $ext_arg{$1} }, $2;	853	push @{ $ext_arg{$1} }, $2;
542	} else {	854	} else {
…		…
565	if $verbosity >= 10;	877	if $verbosity >= 10;
566		878
567	keys %$cb;	879	keys %$cb;
568		880
569	while (my ($pkg, $cb) = each %$cb) {	881	while (my ($pkg, $cb) = each %$cb) {
570	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	882	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
571	and last;	883	$retval ||= $retval_;
572		884
573	if ($@) {	885	if ($@) {
574	$TERM->ungrab; # better to lose the grab than the session	886	$TERM->ungrab; # better to lose the grab than the session
575	warn $@;	887	warn $@;
576	}	888	}
577	}	889	}
		890
		891	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		892	if $verbosity >= 11;
578	}	893	}
579		894
580	if ($htype == 1) { # DESTROY	895	if ($htype == 1) { # DESTROY
581	if (my $hook = delete $TERM->{_hook}) {
582	for my $htype (0..$#$hook) {
583	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
584	or set_should_invoke $htype, 0;
585	}
586	}
587
588	# clear package objects	896	# clear package objects
589	%$_ = () for values %{ $TERM->{_pkg} };	897	%$_ = () for values %{ $TERM->{_pkg} };
590		898
591	# clear package	899	# clear package
592	%$TERM = ();	900	%$TERM = ();
593	}	901	}
594		902
595	$retval	903	$retval
		904	}
		905
		906	sub SET_COLOR($$$) {
		907	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
596	}	908	}
597		909
598	# urxvt::term::extension	910	# urxvt::term::extension
599		911
600	package urxvt::term::extension;	912	package urxvt::term::extension;
…		…
606	while (my ($name, $cb) = each %hook) {	918	while (my ($name, $cb) = each %hook) {
607	my $htype = $HOOKTYPE{uc $name};	919	my $htype = $HOOKTYPE{uc $name};
608	defined $htype	920	defined $htype
609	or Carp::croak "unsupported hook type '$name'";	921	or Carp::croak "unsupported hook type '$name'";
610		922
		923	$self->set_should_invoke ($htype, +1)
611	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	924	unless exists $self->{term}{_hook}[$htype]{$pkg};
612	$hook_count[$htype]++
613	or urxvt::set_should_invoke $htype, 1;
614	}
615		925
616	$self->{term}{_hook}[$htype]{$pkg} = $cb;	926	$self->{term}{_hook}[$htype]{$pkg} = $cb;
617	}	927	}
618	}	928	}
619		929
…		…
624	for my $name (@hook) {	934	for my $name (@hook) {
625	my $htype = $HOOKTYPE{uc $name};	935	my $htype = $HOOKTYPE{uc $name};
626	defined $htype	936	defined $htype
627	or Carp::croak "unsupported hook type '$name'";	937	or Carp::croak "unsupported hook type '$name'";
628		938
		939	$self->set_should_invoke ($htype, -1)
629	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	940	if delete $self->{term}{_hook}[$htype]{$pkg};
630	--$hook_count[$htype]
631	or urxvt::set_should_invoke $htype, 0;
632	}
633	}	941	}
634	}	942	}
635		943
636	our $AUTOLOAD;	944	our $AUTOLOAD;
637		945
…		…
668		976
669	=head2 The C<urxvt::anyevent> Class	977	=head2 The C<urxvt::anyevent> Class
670		978
671	The sole purpose of this class is to deliver an interface to the	979	The sole purpose of this class is to deliver an interface to the
672	C<AnyEvent> module - any module using it will work inside urxvt without	980	C<AnyEvent> module - any module using it will work inside urxvt without
673	further work. The only exception is that you cannot wait on condition	981	further programming. The only exception is that you cannot wait on
674	variables, but non-blocking condvar use is ok. What this means is that you	982	condition variables, but non-blocking condvar use is ok. What this means
675	cannot use blocking APIs, but the non-blocking variant should work.	983	is that you cannot use blocking APIs, but the non-blocking variant should
		984	work.
676		985
677	=cut	986	=cut
678		987
679	our $VERSION = 1;	988	our $VERSION = 1;
680		989
…		…
742	# find on_xxx subs in the package and register them	1051	# find on_xxx subs in the package and register them
743	# as hooks	1052	# as hooks
744	sub register_package {	1053	sub register_package {
745	my ($self, $pkg, $argv) = @_;	1054	my ($self, $pkg, $argv) = @_;
746		1055
		1056	no strict 'refs';
		1057
		1058	urxvt::verbose 6, "register package $pkg to $self";
		1059
		1060	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1061
747	my $proxy = bless {	1062	my $proxy = bless {
748	_pkg => $pkg,	1063	_pkg => $pkg,
749	argv => $argv,	1064	argv => $argv,
750	}, $pkg;	1065	}, $pkg;
751	Scalar::Util::weaken ($proxy->{term} = $self);	1066	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
757	$proxy->enable ($name => $ref);	1072	$proxy->enable ($name => $ref);
758	}	1073	}
759	}	1074	}
760	}	1075	}
761		1076
		1077	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1078
		1079	Creates a new terminal, very similar as if you had started it with system
		1080	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1081	hash which defines the environment of the new terminal.
		1082
		1083	Croaks (and probably outputs an error message) if the new instance
		1084	couldn't be created. Returns C<undef> if the new instance didn't
		1085	initialise perl, and the terminal object otherwise. The C<init> and
		1086	C<start> hooks will be called before this call returns, and are free to
		1087	refer to global data (which is race free).
		1088
		1089	=cut
		1090
		1091	sub new {
		1092	my ($class, $env, @args) = @_;
		1093
		1094	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1095	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1096
		1097	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1098	}
		1099
762	=item $term->destroy	1100	=item $term->destroy
763		1101
764	Destroy the terminal object (close the window, free resources etc.).	1102	Destroy the terminal object (close the window, free resources
		1103	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1104	watchers (timers, io watchers) are still active.
		1105
		1106	=item $term->exec_async ($cmd[, @args])
		1107
		1108	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1109	("starts") programs in the background. This function takes care of setting
		1110	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1111	be preferred over explicit calls to C<exec> or C<system>.
		1112
		1113	Returns the pid of the subprocess or C<undef> on error.
		1114
		1115	=cut
		1116
		1117	sub exec_async {
		1118	my $self = shift;
		1119
		1120	my $pid = fork;
		1121
		1122	return $pid
		1123	if !defined $pid or $pid;
		1124
		1125	%ENV = %{ $self->env };
		1126
		1127	exec @_;
		1128	urxvt::_exit 255;
		1129	}
765		1130
766	=item $isset = $term->option ($optval[, $set])	1131	=item $isset = $term->option ($optval[, $set])
767		1132
768	Returns true if the option specified by C<$optval> is enabled, and	1133	Returns true if the option specified by C<$optval> is enabled, and
769	optionally change it. All option values are stored by name in the hash	1134	optionally change it. All option values are stored by name in the hash
…		…
772	Here is a a likely non-exhaustive list of option names, please see the	1137	Here is a a likely non-exhaustive list of option names, please see the
773	source file F</src/optinc.h> to see the actual list:	1138	source file F</src/optinc.h> to see the actual list:
774		1139
775	borderLess console cursorBlink cursorUnderline hold iconic insecure	1140	borderLess console cursorBlink cursorUnderline hold iconic insecure
776	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1141	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
777	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1142	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
778	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1143	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
779	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1144	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
780	tripleclickwords utmpInhibit visualBell	1145	transparent tripleclickwords utmpInhibit visualBell
781		1146
782	=item $value = $term->resource ($name[, $newval])	1147	=item $value = $term->resource ($name[, $newval])
783		1148
784	Returns the current resource value associated with a given name and	1149	Returns the current resource value associated with a given name and
785	optionally sets a new value. Setting values is most useful in the C<init>	1150	optionally sets a new value. Setting values is most useful in the C<init>
…		…
802		1167
803	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1168	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
804	borderLess color cursorBlink cursorUnderline cutchars delete_key	1169	borderLess color cursorBlink cursorUnderline cutchars delete_key
805	display_name embed ext_bwidth fade font geometry hold iconName	1170	display_name embed ext_bwidth fade font geometry hold iconName
806	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1171	imFont imLocale inputMethod insecure int_bwidth intensityStyles
807	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1172	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
808	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1173	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
809	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1174	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
810	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1175	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
811	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1176	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
812	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1177	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
813	shade term_name title transparent transparent_all tripleclickwords	1178	secondaryScreen secondaryScroll selectstyle shade term_name title
814	utmpInhibit visualBell	1179	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1180	visualBell
815		1181
816	=cut	1182	=cut
817		1183
818	sub resource($$;$) {	1184	sub resource($$;$) {
819	my ($self, $name) = (shift, shift);	1185	my ($self, $name) = (shift, shift);
820	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1186	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
821	&urxvt::term::_resource	1187	&urxvt::term::_resource
822	}	1188	}
823		1189
		1190	=item $value = $term->x_resource ($pattern)
		1191
		1192	Returns the X-Resource for the given pattern, excluding the program or
		1193	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1194	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1195	resource with that pattern exists.
		1196
		1197	This method should only be called during the C<on_start> hook, as there is
		1198	only one resource database per display, and later invocations might return
		1199	the wrong resources.
		1200
824	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1201	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
825		1202
826	Adds a keymap translation exactly as specified via a resource. See the	1203	Adds a keymap translation exactly as specified via a resource. See the
827	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1204	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
828		1205
…		…
843	=item ($row, $col) = $term->selection_end ([$row, $col])	1220	=item ($row, $col) = $term->selection_end ([$row, $col])
844		1221
845	Return the current values of the selection mark, begin or end positions,	1222	Return the current values of the selection mark, begin or end positions,
846	and optionally set them to new values.	1223	and optionally set them to new values.
847		1224
		1225	=item $term->selection_make ($eventtime[, $rectangular])
		1226
		1227	Tries to make a selection as set by C<selection_beg> and
		1228	C<selection_end>. If C<$rectangular> is true (default: false), a
		1229	rectangular selection will be made. This is the prefered function to make
		1230	a selection.
		1231
848	=item $success = $term->selection_grab ($eventtime)	1232	=item $success = $term->selection_grab ($eventtime)
849		1233
850	Try to request the primary selection from the server (for example, as set	1234	Try to request the primary selection text from the server (for example, as
851	by the next method).	1235	set by the next method). No visual feedback will be given. This function
		1236	is mostly useful from within C<on_sel_grab> hooks.
852		1237
853	=item $oldtext = $term->selection ([$newtext])	1238	=item $oldtext = $term->selection ([$newtext])
854		1239
855	Return the current selection text and optionally replace it by C<$newtext>.	1240	Return the current selection text and optionally replace it by C<$newtext>.
856		1241
…		…
949	Convert the given locale-encoded octets into a perl string.	1334	Convert the given locale-encoded octets into a perl string.
950		1335
951	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1336	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
952		1337
953	XORs the rendition values in the given span with the provided value	1338	XORs the rendition values in the given span with the provided value
954	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1339	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
955	to the selection.	1340	refresh hooks to provide effects similar to the selection.
956		1341
957	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1342	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
958		1343
959	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1344	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
960	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1345	whitespace will additionally be xored with the C<$rstyle2>, which defaults
961	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines	1346	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
962	it instead.	1347	it instead. Both styles I<MUST NOT> contain font styles.
963		1348
964	=item $term->scr_bell	1349	=item $term->scr_bell
965		1350
966	Ring the bell!	1351	Ring the bell!
967		1352
…		…
974		1359
975	Normally its not a good idea to use this function, as programs might be	1360	Normally its not a good idea to use this function, as programs might be
976	confused by changes in cursor position or scrolling. Its useful inside a	1361	confused by changes in cursor position or scrolling. Its useful inside a
977	C<on_add_lines> hook, though.	1362	C<on_add_lines> hook, though.
978		1363
		1364	=item $term->scr_change_screen ($screen)
		1365
		1366	Switch to given screen - 0 primary, 1 secondary.
		1367
979	=item $term->cmd_parse ($octets)	1368	=item $term->cmd_parse ($octets)
980		1369
981	Similar to C<scr_add_lines>, but the argument must be in the	1370	Similar to C<scr_add_lines>, but the argument must be in the
982	locale-specific encoding of the terminal and can contain command sequences	1371	locale-specific encoding of the terminal and can contain command sequences
983	(escape codes) that will be interpreted.	1372	(escape codes) that will be interpreted.
…		…
993	Replaces the event mask of the pty watcher by the given event mask. Can	1382	Replaces the event mask of the pty watcher by the given event mask. Can
994	be used to suppress input and output handling to the pty/tty. See the	1383	be used to suppress input and output handling to the pty/tty. See the
995	description of C<< urxvt::timer->events >>. Make sure to always restore	1384	description of C<< urxvt::timer->events >>. Make sure to always restore
996	the previous value.	1385	the previous value.
997		1386
		1387	=item $fd = $term->pty_fd
		1388
		1389	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1390	is used.
		1391
998	=item $windowid = $term->parent	1392	=item $windowid = $term->parent
999		1393
1000	Return the window id of the toplevel window.	1394	Return the window id of the toplevel window.
1001		1395
1002	=item $windowid = $term->vt	1396	=item $windowid = $term->vt
1003		1397
1004	Return the window id of the terminal window.	1398	Return the window id of the terminal window.
1005		1399
		1400	=item $term->vt_emask_add ($x_event_mask)
		1401
		1402	Adds the specified events to the vt event mask. Useful e.g. when you want
		1403	to receive pointer events all the times:
		1404
		1405	$term->vt_emask_add (urxvt::PointerMotionMask);
		1406
		1407	=item $term->focus_in
		1408
		1409	=item $term->focus_out
		1410
		1411	=item $term->key_press ($state, $keycode[, $time])
		1412
		1413	=item $term->key_release ($state, $keycode[, $time])
		1414
		1415	Deliver various fake events to to terminal.
		1416
1006	=item $window_width = $term->width	1417	=item $window_width = $term->width
1007		1418
1008	=item $window_height = $term->height	1419	=item $window_height = $term->height
1009		1420
1010	=item $font_width = $term->fwidth	1421	=item $font_width = $term->fwidth
…		…
1023		1434
1024	=item $max_scrollback = $term->saveLines	1435	=item $max_scrollback = $term->saveLines
1025		1436
1026	=item $nrow_plus_saveLines = $term->total_rows	1437	=item $nrow_plus_saveLines = $term->total_rows
1027		1438
1028	=item $lines_in_scrollback = $term->nsaved	1439	=item $topmost_scrollback_row = $term->top_row
1029		1440
1030	Return various integers describing terminal characteristics.	1441	Return various integers describing terminal characteristics.
1031		1442
		1443	=item $x_display = $term->display_id
		1444
		1445	Return the DISPLAY used by rxvt-unicode.
		1446
1032	=item $lc_ctype = $term->locale	1447	=item $lc_ctype = $term->locale
1033		1448
1034	Returns the LC_CTYPE category string used by this rxvt-unicode.	1449	Returns the LC_CTYPE category string used by this rxvt-unicode.
1035		1450
1036	=item $x_display = $term->display_id	1451	=item $env = $term->env
1037		1452
1038	Return the DISPLAY used by rxvt-unicode.	1453	Returns a copy of the environment in effect for the terminal as a hashref
		1454	similar to C<\%ENV>.
		1455
		1456	=cut
		1457
		1458	sub env {
		1459	if (my $env = $_[0]->_env) {
		1460	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1461	} else {
		1462	+{ %ENV }
		1463	}
		1464	}
1039		1465
1040	=item $modifiermask = $term->ModLevel3Mask	1466	=item $modifiermask = $term->ModLevel3Mask
1041		1467
1042	=item $modifiermask = $term->ModMetaMask	1468	=item $modifiermask = $term->ModMetaMask
1043		1469
1044	=item $modifiermask = $term->ModNumLockMask	1470	=item $modifiermask = $term->ModNumLockMask
1045		1471
1046	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1472	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1047	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1473	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1048		1474
		1475	=item $screen = $term->current_screen
		1476
		1477	Returns the currently displayed screen (0 primary, 1 secondary).
		1478
		1479	=item $cursor_is_hidden = $term->hidden_cursor
		1480
		1481	Returns wether the cursor is currently hidden or not.
		1482
1049	=item $view_start = $term->view_start ([$newvalue])	1483	=item $view_start = $term->view_start ([$newvalue])
1050		1484
1051	Returns the negative row number of the topmost line. Minimum value is	1485	Returns the row number of the topmost displayed line. Maximum value is
1052	C<0>, which displays the normal terminal contents. Larger values scroll	1486	C<0>, which displays the normal terminal contents. Lower values scroll
1053	this many lines into the scrollback buffer.	1487	this many lines into the scrollback buffer.
1054		1488
1055	=item $term->want_refresh	1489	=item $term->want_refresh
1056		1490
1057	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1491	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1072	line, starting at column C<$start_col> (default C<0>), which is useful	1506	line, starting at column C<$start_col> (default C<0>), which is useful
1073	to replace only parts of a line. The font index in the rendition will	1507	to replace only parts of a line. The font index in the rendition will
1074	automatically be updated.	1508	automatically be updated.
1075		1509
1076	C<$text> is in a special encoding: tabs and wide characters that use more	1510	C<$text> is in a special encoding: tabs and wide characters that use more
1077	than one cell when displayed are padded with urxvt::NOCHAR characters	1511	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1078	(C<chr 65535>). Characters with combining characters and other characters	1512	characters. Characters with combining characters and other characters that
1079	that do not fit into the normal tetx encoding will be replaced with	1513	do not fit into the normal tetx encoding will be replaced with characters
1080	characters in the private use area.	1514	in the private use area.
1081		1515
1082	You have to obey this encoding when changing text. The advantage is	1516	You have to obey this encoding when changing text. The advantage is
1083	that C<substr> and similar functions work on screen cells and not on	1517	that C<substr> and similar functions work on screen cells and not on
1084	characters.	1518	characters.
1085		1519
…		…
1136	Return the row number of the first/last row of the line, respectively.	1570	Return the row number of the first/last row of the line, respectively.
1137		1571
1138	=item $offset = $line->offset_of ($row, $col)	1572	=item $offset = $line->offset_of ($row, $col)
1139		1573
1140	Returns the character offset of the given row|col pair within the logical	1574	Returns the character offset of the given row|col pair within the logical
1141	line.	1575	line. Works for rows outside the line, too, and returns corresponding
		1576	offsets outside the string.
1142		1577
1143	=item ($row, $col) = $line->coord_of ($offset)	1578	=item ($row, $col) = $line->coord_of ($offset)
1144		1579
1145	Translates a string offset into terminal coordinates again.	1580	Translates a string offset into terminal coordinates again.
1146		1581
…		…
1231	=item $string = $term->special_decode $text	1666	=item $string = $term->special_decode $text
1232		1667
1233	Converts rxvt-unicodes text reprsentation into a perl string. See	1668	Converts rxvt-unicodes text reprsentation into a perl string. See
1234	C<< $term->ROW_t >> for details.	1669	C<< $term->ROW_t >> for details.
1235		1670
1236	=item $success = $term->grab_button ($button, $modifiermask)	1671	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1237		1672
		1673	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1674
1238	Registers a synchronous button grab. See the XGrabButton manpage.	1675	Register/unregister a synchronous button grab. See the XGrabButton
		1676	manpage.
1239		1677
1240	=item $success = $term->grab ($eventtime[, $sync])	1678	=item $success = $term->grab ($eventtime[, $sync])
1241		1679
1242	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1680	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1243	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1681	synchronous (C<$sync> is true). Also remembers the grab timestampe.
…		…
1259		1697
1260	Calls XUngrab for the most recent grab. Is called automatically on	1698	Calls XUngrab for the most recent grab. Is called automatically on
1261	evaluation errors, as it is better to lose the grab in the error case as	1699	evaluation errors, as it is better to lose the grab in the error case as
1262	the session.	1700	the session.
1263		1701
		1702	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1703
		1704	=item $atom_name = $term->XGetAtomName ($atom)
		1705
		1706	=item @atoms = $term->XListProperties ($window)
		1707
		1708	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1709
		1710	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1711
		1712	=item $term->XDeleteProperty ($window, $property)
		1713
		1714	=item $window = $term->DefaultRootWindow
		1715
		1716	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1717
		1718	=item $term->XMapWindow ($window)
		1719
		1720	=item $term->XUnmapWindow ($window)
		1721
		1722	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1723
		1724	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1725
		1726	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1727
		1728	Various X or X-related functions. The C<$term> object only serves as
		1729	the source of the display, otherwise those functions map more-or-less
		1730	directory onto the X functions of the same name.
		1731
1264	=back	1732	=back
1265		1733
1266	=cut	1734	=cut
1267		1735
1268	package urxvt::popup;	1736	package urxvt::popup;
…		…
1282		1750
1283	$item->{render} ||= sub { $_[0]{text} };	1751	$item->{render} ||= sub { $_[0]{text} };
1284		1752
1285	push @{ $self->{item} }, $item;	1753	push @{ $self->{item} }, $item;
1286	}	1754	}
		1755
		1756	=item $popup->add_title ($title)
		1757
		1758	Adds a non-clickable title to the popup.
		1759
		1760	=cut
		1761
		1762	sub add_title {
		1763	my ($self, $title) = @_;
		1764
		1765	$self->add_item ({
		1766	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1767	text => $title,
		1768	activate => sub { },
		1769	});
		1770	}
		1771
		1772	=item $popup->add_separator ([$sepchr])
		1773
		1774	Creates a separator, optionally using the character given as C<$sepchr>.
		1775
		1776	=cut
1287		1777
1288	sub add_separator {	1778	sub add_separator {
1289	my ($self, $sep) = @_;	1779	my ($self, $sep) = @_;
1290		1780
1291	$sep ||= "=";	1781	$sep ||= "=";
…		…
1296	render => sub { $sep x $self->{term}->ncol },	1786	render => sub { $sep x $self->{term}->ncol },
1297	activate => sub { },	1787	activate => sub { },
1298	});	1788	});
1299	}	1789	}
1300		1790
1301	sub add_title {	1791	=item $popup->add_button ($text, $cb)
1302	my ($self, $title) = @_;
1303		1792
1304	$self->add_item ({	1793	Adds a clickable button to the popup. C<$cb> is called whenever it is
1305	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1794	selected.
1306	text => $title,	1795
1307	activate => sub { },	1796	=cut
1308	});
1309	}
1310		1797
1311	sub add_button {	1798	sub add_button {
1312	my ($self, $text, $cb) = @_;	1799	my ($self, $text, $cb) = @_;
1313		1800
1314	$self->add_item ({ type => "button", text => $text, activate => $cb});	1801	$self->add_item ({ type => "button", text => $text, activate => $cb});
1315	}	1802	}
		1803
		1804	=item $popup->add_toggle ($text, $cb, $initial_value)
		1805
		1806	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1807	whenever it gets toggled, with a boolean indicating its value as its first
		1808	argument.
		1809
		1810	=cut
1316		1811
1317	sub add_toggle {	1812	sub add_toggle {
1318	my ($self, $text, $cb, $value) = @_;	1813	my ($self, $text, $cb, $value) = @_;
1319		1814
1320	my $item; $item = {	1815	my $item; $item = {
1321	type => "button",	1816	type => "button",
1322	text => " $text",	1817	text => " $text",
1323	value => $value,	1818	value => $value,
1324	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1819	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1325	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1820	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1326	};	1821	};
1327		1822
1328	$self->add_item ($item);	1823	$self->add_item ($item);
1329	}	1824	}
		1825
		1826	=item $popup->show
		1827
		1828	Displays the popup (which is initially hidden).
		1829
		1830	=cut
1330		1831
1331	sub show {	1832	sub show {
1332	my ($self) = @_;	1833	my ($self) = @_;
1333		1834
1334	local $urxvt::popup::self = $self;	1835	local $urxvt::popup::self = $self;
1335		1836
		1837	my $env = $self->{term}->env;
		1838	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1839	delete $env->{LC_ALL};
1336	local $ENV{LC_ALL} = $self->{term}->locale;	1840	$env->{LC_CTYPE} = $self->{term}->locale;
1337		1841
1338	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1842	urxvt::term->new ($env, "popup",
		1843	"--perl-lib" => "", "--perl-ext-common" => "",
		1844	"-pty-fd" => -1, "-sl" => 0,
		1845	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1339	"--transient-for" => $self->{term}->parent,	1846	"--transient-for" => $self->{term}->parent,
1340	"-display" => $self->{term}->display_id,	1847	"-display" => $self->{term}->display_id,
1341	"-pe" => "urxvt-popup")	1848	"-pe" => "urxvt-popup")
1342	or die "unable to create popup window\n";	1849	or die "unable to create popup window\n";
1343	}	1850	}
1344		1851
1345	sub DESTROY {	1852	sub DESTROY {
1346	my ($self) = @_;	1853	my ($self) = @_;
1347		1854
1348	delete $self->{term}{_destroy}{$self};	1855	delete $self->{term}{_destroy}{$self};
1349	$self->{term}->ungrab;	1856	$self->{term}->ungrab;
1350	}	1857	}
		1858
		1859	=back
		1860
		1861	=cut
		1862
		1863	package urxvt::watcher;
		1864
		1865	@urxvt::timer::ISA = __PACKAGE__;
		1866	@urxvt::iow::ISA = __PACKAGE__;
		1867	@urxvt::pw::ISA = __PACKAGE__;
		1868	@urxvt::iw::ISA = __PACKAGE__;
1351		1869
1352	=head2 The C<urxvt::timer> Class	1870	=head2 The C<urxvt::timer> Class
1353		1871
1354	This class implements timer watchers/events. Time is represented as a	1872	This class implements timer watchers/events. Time is represented as a
1355	fractional number of seconds since the epoch. Example:	1873	fractional number of seconds since the epoch. Example:
…		…
1393	Start the timer.	1911	Start the timer.
1394		1912
1395	=item $timer = $timer->start ($tstamp)	1913	=item $timer = $timer->start ($tstamp)
1396		1914
1397	Set the event trigger time to C<$tstamp> and start the timer.	1915	Set the event trigger time to C<$tstamp> and start the timer.
		1916
		1917	=item $timer = $timer->after ($delay)
		1918
		1919	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1398		1920
1399	=item $timer = $timer->stop	1921	=item $timer = $timer->stop
1400		1922
1401	Stop the timer.	1923	Stop the timer.
1402		1924
…		…
1449		1971
1450	Stop watching for events on the given filehandle.	1972	Stop watching for events on the given filehandle.
1451		1973
1452	=back	1974	=back
1453		1975
		1976	=head2 The C<urxvt::iw> Class
		1977
		1978	This class implements idle watchers, that get called automatically when
		1979	the process is idle. They should return as fast as possible, after doing
		1980	some useful work.
		1981
		1982	=over 4
		1983
		1984	=item $iw = new urxvt::iw
		1985
		1986	Create a new idle watcher object in stopped state.
		1987
		1988	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1989
		1990	Set the callback to be called when the watcher triggers.
		1991
		1992	=item $timer = $timer->start
		1993
		1994	Start the watcher.
		1995
		1996	=item $timer = $timer->stop
		1997
		1998	Stop the watcher.
		1999
		2000	=back
		2001
		2002	=head2 The C<urxvt::pw> Class
		2003
		2004	This class implements process watchers. They create an event whenever a
		2005	process exits, after which they stop automatically.
		2006
		2007	my $pid = fork;
		2008	...
		2009	$term->{pw} = urxvt::pw
		2010	->new
		2011	->start ($pid)
		2012	->cb (sub {
		2013	my ($pw, $exit_status) = @_;
		2014	...
		2015	});
		2016
		2017	=over 4
		2018
		2019	=item $pw = new urxvt::pw
		2020
		2021	Create a new process watcher in stopped state.
		2022
		2023	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2024
		2025	Set the callback to be called when the timer triggers.
		2026
		2027	=item $pw = $timer->start ($pid)
		2028
		2029	Tells the wqtcher to start watching for process C<$pid>.
		2030
		2031	=item $pw = $pw->stop
		2032
		2033	Stop the watcher.
		2034
		2035	=back
		2036
1454	=head1 ENVIRONMENT	2037	=head1 ENVIRONMENT
1455		2038
1456	=head2 URXVT_PERL_VERBOSITY	2039	=head2 URXVT_PERL_VERBOSITY
1457		2040
1458	This variable controls the verbosity level of the perl extension. Higher	2041	This variable controls the verbosity level of the perl extension. Higher
…		…
1462		2045
1463	=item == 0 - fatal messages	2046	=item == 0 - fatal messages
1464		2047
1465	=item >= 3 - script loading and management	2048	=item >= 3 - script loading and management
1466		2049
1467	=item >=10 - all events received	2050	=item >=10 - all called hooks
		2051
		2052	=item >=11 - hook reutrn values
1468		2053
1469	=back	2054	=back
1470		2055
1471	=head1 AUTHOR	2056	=head1 AUTHOR
1472		2057

Diff Legend

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