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.70 by root, Mon Jan 9 23:00:07 2006 UTC vs.
Revision 1.131 by root, Sun Jan 29 20:51:28 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-clipboard
		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,
…		…
288		515
289	=item on_refresh_end $term	516	=item on_refresh_end $term
290		517
291	Called just after the screen gets redrawn. See C<on_refresh_begin>.	518	Called just after the screen gets redrawn. See C<on_refresh_begin>.
292		519
293	=item on_keyboard_command $term, $string	520	=item on_user_command $term, $string
294		521
295	Called whenever the user presses a key combination that has a	522	Called whenever the a user-configured event is being activated (e.g. via
296	C<perl:string> action bound to it (see description of the B<keysym>	523	a C<perl:string> action bound to a key, see description of the B<keysym>
297	resource in the @@RXVT_NAME@@(1) manpage).	524	resource in the @@RXVT_NAME@@(1) manpage).
		525
		526	The event is simply the action string. This interface is assumed to change
		527	slightly in the future.
		528
		529	=item on_x_event $term, $event
		530
		531	Called on every X event received on the vt window (and possibly other
		532	windows). Should only be used as a last resort. Most event structure
		533	members are not passed.
298		534
299	=item on_focus_in $term	535	=item on_focus_in $term
300		536
301	Called whenever the window gets the keyboard focus, before rxvt-unicode	537	Called whenever the window gets the keyboard focus, before rxvt-unicode
302	does focus in processing.	538	does focus in processing.
…		…
304	=item on_focus_out $term	540	=item on_focus_out $term
305		541
306	Called wheneever the window loses keyboard focus, before rxvt-unicode does	542	Called wheneever the window loses keyboard focus, before rxvt-unicode does
307	focus out processing.	543	focus out processing.
308		544
		545	=item on_configure_notify $term, $event
		546
		547	=item on_property_notify $term, $event
		548
309	=item on_key_press $term, $event, $keysym, $octets	549	=item on_key_press $term, $event, $keysym, $octets
310		550
311	=item on_key_release $term, $event, $keysym	551	=item on_key_release $term, $event, $keysym
312		552
313	=item on_button_press $term, $event	553	=item on_button_press $term, $event
…		…
322		562
323	Called whenever the corresponding X event is received for the terminal If	563	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.	564	the hook returns true, then the even will be ignored by rxvt-unicode.
325		565
326	The event is a hash with most values as named by Xlib (see the XEvent	566	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	567	manpage), with the additional members C<row> and C<col>, which are the
328	and column under the mouse cursor.	568	(real, not screen-based) row and column under the mouse cursor.
329		569
330	C<on_key_press> additionally receives the string rxvt-unicode would	570	C<on_key_press> additionally receives the string rxvt-unicode would
331	output, if any, in locale-specific encoding.	571	output, if any, in locale-specific encoding.
332		572
333	subwindow.	573	subwindow.
334		574
335	=back	575	=item on_client_message $term, $event
336		576
337	=head2 Variables in the C<urxvt> Package	577	=item on_wm_protocols $term, $event
338		578
339	=over 4	579	=item on_wm_delete_window $term, $event
340		580
341	=item $urxvt::TERM	581	Called when various types of ClientMessage events are received (all with
342		582	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		583
445	=back	584	=back
446		585
447	=cut	586	=cut
448		587
…		…
454	use Scalar::Util ();	593	use Scalar::Util ();
455	use List::Util ();	594	use List::Util ();
456		595
457	our $VERSION = 1;	596	our $VERSION = 1;
458	our $TERM;	597	our $TERM;
		598	our @TERM_INIT;
		599	our @TERM_EXT;
459	our @HOOKNAME;	600	our @HOOKNAME;
460	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	601	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
461	our %OPTION;	602	our %OPTION;
		603
462	our $LIBDIR;	604	our $LIBDIR;
		605	our $RESNAME;
		606	our $RESCLASS;
		607	our $RXVTNAME;
		608
		609	our $NOCHAR = chr 0xffff;
		610
		611	=head2 Variables in the C<urxvt> Package
		612
		613	=over 4
		614
		615	=item $urxvt::LIBDIR
		616
		617	The rxvt-unicode library directory, where, among other things, the perl
		618	modules and scripts are stored.
		619
		620	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		621
		622	The resource class and name rxvt-unicode uses to look up X resources.
		623
		624	=item $urxvt::RXVTNAME
		625
		626	The basename of the installed binaries, usually C<urxvt>.
		627
		628	=item $urxvt::TERM
		629
		630	The current terminal. This variable stores the current C<urxvt::term>
		631	object, whenever a callback/hook is executing.
		632
		633	=item @urxvt::TERM_INIT
		634
		635	All coderefs in this array will be called as methods of the next newly
		636	created C<urxvt::term> object (during the C<on_init> phase). The array
		637	gets cleared before the codereferences that were in it are being executed,
		638	so coderefs can push themselves onto it again if they so desire.
		639
		640	This complements to the perl-eval commandline option, but gets executed
		641	first.
		642
		643	=item @urxvt::TERM_EXT
		644
		645	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		646	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		647	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		648
		649	=back
		650
		651	=head2 Functions in the C<urxvt> Package
		652
		653	=over 4
		654
		655	=item urxvt::fatal $errormessage
		656
		657	Fatally aborts execution with the given error message. Avoid at all
		658	costs! The only time this is acceptable is when the terminal process
		659	starts up.
		660
		661	=item urxvt::warn $string
		662
		663	Calls C<rxvt_warn> with the given string which should not include a
		664	newline. The module also overwrites the C<warn> builtin with a function
		665	that calls this function.
		666
		667	Using this function has the advantage that its output ends up in the
		668	correct place, e.g. on stderr of the connecting urxvtc client.
		669
		670	Messages have a size limit of 1023 bytes currently.
		671
		672	=item @terms = urxvt::termlist
		673
		674	Returns all urxvt::term objects that exist in this process, regardless of
		675	wether they are started, being destroyed etc., so be careful. Only term
		676	objects that have perl extensions attached will be returned (because there
		677	is no urxvt::term objet associated with others).
		678
		679	=item $time = urxvt::NOW
		680
		681	Returns the "current time" (as per the event loop).
		682
		683	=item urxvt::CurrentTime
		684
		685	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		686	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		687	Button4Mask, Button5Mask, AnyModifier
		688
		689	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		690	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		691	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		692	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		693	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		694	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		695	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		696
		697	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		698	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		699	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		700	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		701	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		702	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		703	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		704
		705	Various constants for use in X calls and event processing.
		706
		707	=back
		708
		709	=head2 RENDITION
		710
		711	Rendition bitsets contain information about colour, font, font styles and
		712	similar information for each screen cell.
		713
		714	The following "macros" deal with changes in rendition sets. You should
		715	never just create a bitset, you should always modify an existing one,
		716	as they contain important information required for correct operation of
		717	rxvt-unicode.
		718
		719	=over 4
		720
		721	=item $rend = urxvt::DEFAULT_RSTYLE
		722
		723	Returns the default rendition, as used when the terminal is starting up or
		724	being reset. Useful as a base to start when creating renditions.
		725
		726	=item $rend = urxvt::OVERLAY_RSTYLE
		727
		728	Return the rendition mask used for overlays by default.
		729
		730	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		731
		732	Return the bit that enabled bold, italic, blink, reverse-video and
		733	underline, respectively. To enable such a style, just logically OR it into
		734	the bitset.
		735
		736	=item $foreground = urxvt::GET_BASEFG $rend
		737
		738	=item $background = urxvt::GET_BASEBG $rend
		739
		740	Return the foreground/background colour index, respectively.
		741
		742	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		743
		744	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		745
		746	Replace the foreground/background colour in the rendition mask with the
		747	specified one.
		748
		749	=item $value = urxvt::GET_CUSTOM $rend
		750
		751	Return the "custom" value: Every rendition has 5 bits for use by
		752	extensions. They can be set and changed as you like and are initially
		753	zero.
		754
		755	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		756
		757	Change the custom value.
		758
		759	=back
		760
		761	=cut
463		762
464	BEGIN {	763	BEGIN {
465	urxvt->bootstrap;
466
467	# overwrite perl's warn	764	# overwrite perl's warn
468	*CORE::GLOBAL::warn = sub {	765	*CORE::GLOBAL::warn = sub {
469	my $msg = join "", @_;	766	my $msg = join "", @_;
470	$msg .= "\n"	767	$msg .= "\n"
471	unless $msg =~ /\n$/;	768	unless $msg =~ /\n$/;
472	urxvt::warn ($msg);	769	urxvt::warn ($msg);
473	};	770	};
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	}	771	}
480		772
481	my @hook_count;	773	no warnings 'utf8';
		774
482	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	775	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
483		776
484	sub verbose {	777	sub verbose {
485	my ($level, $msg) = @_;	778	my ($level, $msg) = @_;
486	warn "$msg\n" if $level <= $verbosity;	779	warn "$msg\n" if $level <= $verbosity;
487	}	780	}
488		781
489	my $extension_pkg = "extension0000";
490	my %extension_pkg;	782	my %extension_pkg;
491		783
492	# load a single script into its own package, once only	784	# load a single script into its own package, once only
493	sub extension_package($) {	785	sub extension_package($) {
494	my ($path) = @_;	786	my ($path) = @_;
495		787
496	$extension_pkg{$path} ||= do {	788	$extension_pkg{$path} ||= do {
497	my $pkg = "urxvt::" . ($extension_pkg++);	789	$path =~ /([^\/\\]+)$/;
		790	my $pkg = $1;
		791	$pkg =~ s/[^[:word:]]/_/g;
		792	$pkg = "urxvt::ext::$pkg";
498		793
499	verbose 3, "loading extension '$path' into package '$pkg'";	794	verbose 3, "loading extension '$path' into package '$pkg'";
500		795
501	open my $fh, "<:raw", $path	796	open my $fh, "<:raw", $path
502	or die "$path: $!";	797	or die "$path: $!";
503		798
504	my $source = untaint	799	my $source =
505	"package $pkg; use strict; use utf8;\n"	800	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
506	. "use base urxvt::term::proxy::;\n"
507	. "#line 1 \"$path\"\n{\n"	801	. "#line 1 \"$path\"\n{\n"
508	. (do { local $/; <$fh> })	802	. (do { local $/; <$fh> })
509	. "\n};\n1";	803	. "\n};\n1";
510		804
511	eval $source	805	eval $source
…		…
525	if ($htype == 0) { # INIT	819	if ($htype == 0) { # INIT
526	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	820	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
527		821
528	my %ext_arg;	822	my %ext_arg;
529		823
		824	{
		825	my @init = @TERM_INIT;
		826	@TERM_INIT = ();
		827	$_->($TERM) for @init;
		828	my @pkg = @TERM_EXT;
		829	@TERM_EXT = ();
		830	$TERM->register_package ($_) for @pkg;
		831	}
		832
530	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	833	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
531	if ($_ eq "default") {	834	if ($_ eq "default") {
532	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	835	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
533	} elsif (/^-(.*)$/) {	836	} elsif (/^-(.*)$/) {
534	delete $ext_arg{$1};	837	delete $ext_arg{$1};
535	} elsif (/^([^<]+)<(.*)>$/) {	838	} elsif (/^([^<]+)<(.*)>$/) {
536	push @{ $ext_arg{$1} }, $2;	839	push @{ $ext_arg{$1} }, $2;
537	} else {	840	} else {
…		…
560	if $verbosity >= 10;	863	if $verbosity >= 10;
561		864
562	keys %$cb;	865	keys %$cb;
563		866
564	while (my ($pkg, $cb) = each %$cb) {	867	while (my ($pkg, $cb) = each %$cb) {
565	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	868	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
566	and last;	869	$retval ||= $retval_;
567		870
568	if ($@) {	871	if ($@) {
569	$TERM->ungrab; # better to lose the grab than the session	872	$TERM->ungrab; # better to lose the grab than the session
570	warn $@;	873	warn $@;
571	}	874	}
572	}	875	}
		876
		877	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		878	if $verbosity >= 11;
573	}	879	}
574		880
575	if ($htype == 1) { # DESTROY	881	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	882	# clear package objects
584	%$_ = () for values %{ $TERM->{_pkg} };	883	%$_ = () for values %{ $TERM->{_pkg} };
585		884
586	# clear package	885	# clear package
587	%$TERM = ();	886	%$TERM = ();
588	}	887	}
589		888
590	$retval	889	$retval
591	}	890	}
592		891
593	# urxvt::term::proxy	892	# urxvt::term::extension
594		893
595	package urxvt::term::proxy;	894	package urxvt::term::extension;
596		895
597	sub enable {	896	sub enable {
598	my ($self, %hook) = @_;	897	my ($self, %hook) = @_;
599	my $pkg = $self->{_pkg};	898	my $pkg = $self->{_pkg};
600		899
601	while (my ($name, $cb) = each %hook) {	900	while (my ($name, $cb) = each %hook) {
602	my $htype = $HOOKTYPE{uc $name};	901	my $htype = $HOOKTYPE{uc $name};
603	defined $htype	902	defined $htype
604	or Carp::croak "unsupported hook type '$name'";	903	or Carp::croak "unsupported hook type '$name'";
605		904
		905	$self->set_should_invoke ($htype, +1)
606	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	906	unless exists $self->{term}{_hook}[$htype]{$pkg};
607	$hook_count[$htype]++
608	or urxvt::set_should_invoke $htype, 1;
609	}
610		907
611	$self->{term}{_hook}[$htype]{$pkg} = $cb;	908	$self->{term}{_hook}[$htype]{$pkg} = $cb;
612	}	909	}
613	}	910	}
614		911
…		…
619	for my $name (@hook) {	916	for my $name (@hook) {
620	my $htype = $HOOKTYPE{uc $name};	917	my $htype = $HOOKTYPE{uc $name};
621	defined $htype	918	defined $htype
622	or Carp::croak "unsupported hook type '$name'";	919	or Carp::croak "unsupported hook type '$name'";
623		920
		921	$self->set_should_invoke ($htype, -1)
624	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	922	if delete $self->{term}{_hook}[$htype]{$pkg};
625	--$hook_count[$htype]
626	or urxvt::set_should_invoke $htype, 0;
627	}
628	}	923	}
629	}	924	}
630		925
631	our $AUTOLOAD;	926	our $AUTOLOAD;
632		927
…		…
663		958
664	=head2 The C<urxvt::anyevent> Class	959	=head2 The C<urxvt::anyevent> Class
665		960
666	The sole purpose of this class is to deliver an interface to the	961	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	962	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	963	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	964	condition variables, but non-blocking condvar use is ok. What this means
670	cannot use blocking APIs, but the non-blocking variant should work.	965	is that you cannot use blocking APIs, but the non-blocking variant should
		966	work.
671		967
672	=cut	968	=cut
673		969
674	our $VERSION = 1;	970	our $VERSION = 1;
675		971
…		…
737	# find on_xxx subs in the package and register them	1033	# find on_xxx subs in the package and register them
738	# as hooks	1034	# as hooks
739	sub register_package {	1035	sub register_package {
740	my ($self, $pkg, $argv) = @_;	1036	my ($self, $pkg, $argv) = @_;
741		1037
		1038	no strict 'refs';
		1039
		1040	urxvt::verbose 6, "register package $pkg to $self";
		1041
		1042	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1043
742	my $proxy = bless {	1044	my $proxy = bless {
743	_pkg => $pkg,	1045	_pkg => $pkg,
744	argv => $argv,	1046	argv => $argv,
745	}, $pkg;	1047	}, $pkg;
746	Scalar::Util::weaken ($proxy->{term} = $self);	1048	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
752	$proxy->enable ($name => $ref);	1054	$proxy->enable ($name => $ref);
753	}	1055	}
754	}	1056	}
755	}	1057	}
756		1058
		1059	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1060
		1061	Creates a new terminal, very similar as if you had started it with system
		1062	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1063	hash which defines the environment of the new terminal.
		1064
		1065	Croaks (and probably outputs an error message) if the new instance
		1066	couldn't be created. Returns C<undef> if the new instance didn't
		1067	initialise perl, and the terminal object otherwise. The C<init> and
		1068	C<start> hooks will be called before this call returns, and are free to
		1069	refer to global data (which is race free).
		1070
		1071	=cut
		1072
		1073	sub new {
		1074	my ($class, $env, @args) = @_;
		1075
		1076	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1077	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1078
		1079	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1080	}
		1081
757	=item $term->destroy	1082	=item $term->destroy
758		1083
759	Destroy the terminal object (close the window, free resources etc.).	1084	Destroy the terminal object (close the window, free resources
		1085	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1086	watchers (timers, io watchers) are still active.
		1087
		1088	=item $term->exec_async ($cmd[, @args])
		1089
		1090	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1091	("starts") programs in the background. This function takes care of setting
		1092	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1093	be preferred over explicit calls to C<exec> or C<system>.
		1094
		1095	Returns the pid of the subprocess or C<undef> on error.
		1096
		1097	=cut
		1098
		1099	sub exec_async {
		1100	my $self = shift;
		1101
		1102	my $pid = fork;
		1103
		1104	return $pid
		1105	if !defined $pid or $pid;
		1106
		1107	%ENV = %{ $self->env };
		1108
		1109	exec @_;
		1110	urxvt::_exit 255;
		1111	}
760		1112
761	=item $isset = $term->option ($optval[, $set])	1113	=item $isset = $term->option ($optval[, $set])
762		1114
763	Returns true if the option specified by C<$optval> is enabled, and	1115	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	1116	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	1119	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:	1120	source file F</src/optinc.h> to see the actual list:
769		1121
770	borderLess console cursorBlink cursorUnderline hold iconic insecure	1122	borderLess console cursorBlink cursorUnderline hold iconic insecure
771	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1123	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
772	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1124	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
773	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1125	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
774	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1126	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
775	tripleclickwords utmpInhibit visualBell	1127	transparent tripleclickwords utmpInhibit visualBell
776		1128
777	=item $value = $term->resource ($name[, $newval])	1129	=item $value = $term->resource ($name[, $newval])
778		1130
779	Returns the current resource value associated with a given name and	1131	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>	1132	optionally sets a new value. Setting values is most useful in the C<init>
…		…
797		1149
798	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1150	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
799	borderLess color cursorBlink cursorUnderline cutchars delete_key	1151	borderLess color cursorBlink cursorUnderline cutchars delete_key
800	display_name embed ext_bwidth fade font geometry hold iconName	1152	display_name embed ext_bwidth fade font geometry hold iconName
801	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1153	imFont imLocale inputMethod insecure int_bwidth intensityStyles
802	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1154	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
803	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1155	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
804	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1156	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
805	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1157	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
806	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1158	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
807	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1159	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
808	shade term_name title transparent transparent_all tripleclickwords	1160	secondaryScreen secondaryScroll selectstyle shade term_name title
809	utmpInhibit visualBell	1161	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1162	visualBell
810		1163
811	=cut	1164	=cut
812		1165
813	sub resource($$;$) {	1166	sub resource($$;$) {
814	my ($self, $name) = (shift, shift);	1167	my ($self, $name) = (shift, shift);
815	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1168	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
816	&urxvt::term::_resource	1169	&urxvt::term::_resource
817	}	1170	}
818		1171
		1172	=item $value = $term->x_resource ($pattern)
		1173
		1174	Returns the X-Resource for the given pattern, excluding the program or
		1175	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1176	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1177	resource with that pattern exists.
		1178
		1179	This method should only be called during the C<on_start> hook, as there is
		1180	only one resource database per display, and later invocations might return
		1181	the wrong resources.
		1182
819	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1183	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
820		1184
821	Adds a keymap translation exactly as specified via a resource. See the	1185	Adds a keymap translation exactly as specified via a resource. See the
822	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1186	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
823		1187
…		…
838	=item ($row, $col) = $term->selection_end ([$row, $col])	1202	=item ($row, $col) = $term->selection_end ([$row, $col])
839		1203
840	Return the current values of the selection mark, begin or end positions,	1204	Return the current values of the selection mark, begin or end positions,
841	and optionally set them to new values.	1205	and optionally set them to new values.
842		1206
		1207	=item $term->selection_make ($eventtime[, $rectangular])
		1208
		1209	Tries to make a selection as set by C<selection_beg> and
		1210	C<selection_end>. If C<$rectangular> is true (default: false), a
		1211	rectangular selection will be made. This is the prefered function to make
		1212	a selection.
		1213
843	=item $success = $term->selection_grab ($eventtime)	1214	=item $success = $term->selection_grab ($eventtime)
844		1215
845	Try to request the primary selection from the server (for example, as set	1216	Try to request the primary selection text from the server (for example, as
846	by the next method).	1217	set by the next method). No visual feedback will be given. This function
		1218	is mostly useful from within C<on_sel_grab> hooks.
847		1219
848	=item $oldtext = $term->selection ([$newtext])	1220	=item $oldtext = $term->selection ([$newtext])
849		1221
850	Return the current selection text and optionally replace it by C<$newtext>.	1222	Return the current selection text and optionally replace it by C<$newtext>.
851		1223
…		…
944	Convert the given locale-encoded octets into a perl string.	1316	Convert the given locale-encoded octets into a perl string.
945		1317
946	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1318	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
947		1319
948	XORs the rendition values in the given span with the provided value	1320	XORs the rendition values in the given span with the provided value
949	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1321	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
950	to the selection.	1322	refresh hooks to provide effects similar to the selection.
951		1323
952	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1324	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
953		1325
954	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1326	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
955	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1327	whitespace will additionally be xored with the C<$rstyle2>, which defaults
956	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines	1328	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
957	it instead.	1329	it instead. Both styles I<MUST NOT> contain font styles.
958		1330
959	=item $term->scr_bell	1331	=item $term->scr_bell
960		1332
961	Ring the bell!	1333	Ring the bell!
962		1334
…		…
969		1341
970	Normally its not a good idea to use this function, as programs might be	1342	Normally its not a good idea to use this function, as programs might be
971	confused by changes in cursor position or scrolling. Its useful inside a	1343	confused by changes in cursor position or scrolling. Its useful inside a
972	C<on_add_lines> hook, though.	1344	C<on_add_lines> hook, though.
973		1345
		1346	=item $term->scr_change_screen ($screen)
		1347
		1348	Switch to given screen - 0 primary, 1 secondary.
		1349
974	=item $term->cmd_parse ($octets)	1350	=item $term->cmd_parse ($octets)
975		1351
976	Similar to C<scr_add_lines>, but the argument must be in the	1352	Similar to C<scr_add_lines>, but the argument must be in the
977	locale-specific encoding of the terminal and can contain command sequences	1353	locale-specific encoding of the terminal and can contain command sequences
978	(escape codes) that will be interpreted.	1354	(escape codes) that will be interpreted.
…		…
988	Replaces the event mask of the pty watcher by the given event mask. Can	1364	Replaces the event mask of the pty watcher by the given event mask. Can
989	be used to suppress input and output handling to the pty/tty. See the	1365	be used to suppress input and output handling to the pty/tty. See the
990	description of C<< urxvt::timer->events >>. Make sure to always restore	1366	description of C<< urxvt::timer->events >>. Make sure to always restore
991	the previous value.	1367	the previous value.
992		1368
		1369	=item $fd = $term->pty_fd
		1370
		1371	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1372	is used.
		1373
993	=item $windowid = $term->parent	1374	=item $windowid = $term->parent
994		1375
995	Return the window id of the toplevel window.	1376	Return the window id of the toplevel window.
996		1377
997	=item $windowid = $term->vt	1378	=item $windowid = $term->vt
998		1379
999	Return the window id of the terminal window.	1380	Return the window id of the terminal window.
1000		1381
		1382	=item $term->vt_emask_add ($x_event_mask)
		1383
		1384	Adds the specified events to the vt event mask. Useful e.g. when you want
		1385	to receive pointer events all the times:
		1386
		1387	$term->vt_emask_add (urxvt::PointerMotionMask);
		1388
1001	=item $window_width = $term->width	1389	=item $window_width = $term->width
1002		1390
1003	=item $window_height = $term->height	1391	=item $window_height = $term->height
1004		1392
1005	=item $font_width = $term->fwidth	1393	=item $font_width = $term->fwidth
…		…
1018		1406
1019	=item $max_scrollback = $term->saveLines	1407	=item $max_scrollback = $term->saveLines
1020		1408
1021	=item $nrow_plus_saveLines = $term->total_rows	1409	=item $nrow_plus_saveLines = $term->total_rows
1022		1410
1023	=item $lines_in_scrollback = $term->nsaved	1411	=item $topmost_scrollback_row = $term->top_row
1024		1412
1025	Return various integers describing terminal characteristics.	1413	Return various integers describing terminal characteristics.
1026		1414
		1415	=item $x_display = $term->display_id
		1416
		1417	Return the DISPLAY used by rxvt-unicode.
		1418
1027	=item $lc_ctype = $term->locale	1419	=item $lc_ctype = $term->locale
1028		1420
1029	Returns the LC_CTYPE category string used by this rxvt-unicode.	1421	Returns the LC_CTYPE category string used by this rxvt-unicode.
1030		1422
1031	=item $x_display = $term->display_id	1423	=item $env = $term->env
1032		1424
1033	Return the DISPLAY used by rxvt-unicode.	1425	Returns a copy of the environment in effect for the terminal as a hashref
		1426	similar to C<\%ENV>.
		1427
		1428	=cut
		1429
		1430	sub env {
		1431	if (my $env = $_[0]->_env) {
		1432	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1433	} else {
		1434	+{ %ENV }
		1435	}
		1436	}
1034		1437
1035	=item $modifiermask = $term->ModLevel3Mask	1438	=item $modifiermask = $term->ModLevel3Mask
1036		1439
1037	=item $modifiermask = $term->ModMetaMask	1440	=item $modifiermask = $term->ModMetaMask
1038		1441
1039	=item $modifiermask = $term->ModNumLockMask	1442	=item $modifiermask = $term->ModNumLockMask
1040		1443
1041	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1444	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1042	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1445	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1043		1446
		1447	=item $screen = $term->current_screen
		1448
		1449	Returns the currently displayed screen (0 primary, 1 secondary).
		1450
		1451	=item $cursor_is_hidden = $term->hidden_cursor
		1452
		1453	Returns wether the cursor is currently hidden or not.
		1454
1044	=item $view_start = $term->view_start ([$newvalue])	1455	=item $view_start = $term->view_start ([$newvalue])
1045		1456
1046	Returns the negative row number of the topmost line. Minimum value is	1457	Returns the row number of the topmost displayed line. Maximum value is
1047	C<0>, which displays the normal terminal contents. Larger values scroll	1458	C<0>, which displays the normal terminal contents. Lower values scroll
1048	this many lines into the scrollback buffer.	1459	this many lines into the scrollback buffer.
1049		1460
1050	=item $term->want_refresh	1461	=item $term->want_refresh
1051		1462
1052	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1463	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1067	line, starting at column C<$start_col> (default C<0>), which is useful	1478	line, starting at column C<$start_col> (default C<0>), which is useful
1068	to replace only parts of a line. The font index in the rendition will	1479	to replace only parts of a line. The font index in the rendition will
1069	automatically be updated.	1480	automatically be updated.
1070		1481
1071	C<$text> is in a special encoding: tabs and wide characters that use more	1482	C<$text> is in a special encoding: tabs and wide characters that use more
1072	than one cell when displayed are padded with urxvt::NOCHAR characters	1483	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1073	(C<chr 65535>). Characters with combining characters and other characters	1484	characters. Characters with combining characters and other characters that
1074	that do not fit into the normal tetx encoding will be replaced with	1485	do not fit into the normal tetx encoding will be replaced with characters
1075	characters in the private use area.	1486	in the private use area.
1076		1487
1077	You have to obey this encoding when changing text. The advantage is	1488	You have to obey this encoding when changing text. The advantage is
1078	that C<substr> and similar functions work on screen cells and not on	1489	that C<substr> and similar functions work on screen cells and not on
1079	characters.	1490	characters.
1080		1491
…		…
1131	Return the row number of the first/last row of the line, respectively.	1542	Return the row number of the first/last row of the line, respectively.
1132		1543
1133	=item $offset = $line->offset_of ($row, $col)	1544	=item $offset = $line->offset_of ($row, $col)
1134		1545
1135	Returns the character offset of the given row|col pair within the logical	1546	Returns the character offset of the given row|col pair within the logical
1136	line.	1547	line. Works for rows outside the line, too, and returns corresponding
		1548	offsets outside the string.
1137		1549
1138	=item ($row, $col) = $line->coord_of ($offset)	1550	=item ($row, $col) = $line->coord_of ($offset)
1139		1551
1140	Translates a string offset into terminal coordinates again.	1552	Translates a string offset into terminal coordinates again.
1141		1553
…		…
1226	=item $string = $term->special_decode $text	1638	=item $string = $term->special_decode $text
1227		1639
1228	Converts rxvt-unicodes text reprsentation into a perl string. See	1640	Converts rxvt-unicodes text reprsentation into a perl string. See
1229	C<< $term->ROW_t >> for details.	1641	C<< $term->ROW_t >> for details.
1230		1642
1231	=item $success = $term->grab_button ($button, $modifiermask)	1643	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1232		1644
		1645	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1646
1233	Registers a synchronous button grab. See the XGrabButton manpage.	1647	Register/unregister a synchronous button grab. See the XGrabButton
		1648	manpage.
1234		1649
1235	=item $success = $term->grab ($eventtime[, $sync])	1650	=item $success = $term->grab ($eventtime[, $sync])
1236		1651
1237	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1652	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1238	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1653	synchronous (C<$sync> is true). Also remembers the grab timestampe.
…		…
1254		1669
1255	Calls XUngrab for the most recent grab. Is called automatically on	1670	Calls XUngrab for the most recent grab. Is called automatically on
1256	evaluation errors, as it is better to lose the grab in the error case as	1671	evaluation errors, as it is better to lose the grab in the error case as
1257	the session.	1672	the session.
1258		1673
		1674	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1675
		1676	=item $atom_name = $term->XGetAtomName ($atom)
		1677
		1678	=item @atoms = $term->XListProperties ($window)
		1679
		1680	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1681
		1682	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1683
		1684	=item $term->XDeleteProperty ($window, $property)
		1685
		1686	=item $window = $term->DefaultRootWindow
		1687
		1688	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1689
		1690	=item $term->XMapWindow ($window)
		1691
		1692	=item $term->XUnmapWindow ($window)
		1693
		1694	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1695
		1696	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1697
		1698	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1699
		1700	Various X or X-related functions. The C<$term> object only serves as
		1701	the source of the display, otherwise those functions map more-or-less
		1702	directory onto the X functions of the same name.
		1703
1259	=back	1704	=back
1260		1705
1261	=cut	1706	=cut
1262		1707
1263	package urxvt::popup;	1708	package urxvt::popup;
…		…
1277		1722
1278	$item->{render} ||= sub { $_[0]{text} };	1723	$item->{render} ||= sub { $_[0]{text} };
1279		1724
1280	push @{ $self->{item} }, $item;	1725	push @{ $self->{item} }, $item;
1281	}	1726	}
		1727
		1728	=item $popup->add_title ($title)
		1729
		1730	Adds a non-clickable title to the popup.
		1731
		1732	=cut
		1733
		1734	sub add_title {
		1735	my ($self, $title) = @_;
		1736
		1737	$self->add_item ({
		1738	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1739	text => $title,
		1740	activate => sub { },
		1741	});
		1742	}
		1743
		1744	=item $popup->add_separator ([$sepchr])
		1745
		1746	Creates a separator, optionally using the character given as C<$sepchr>.
		1747
		1748	=cut
1282		1749
1283	sub add_separator {	1750	sub add_separator {
1284	my ($self, $sep) = @_;	1751	my ($self, $sep) = @_;
1285		1752
1286	$sep ||= "=";	1753	$sep ||= "=";
…		…
1291	render => sub { $sep x $self->{term}->ncol },	1758	render => sub { $sep x $self->{term}->ncol },
1292	activate => sub { },	1759	activate => sub { },
1293	});	1760	});
1294	}	1761	}
1295		1762
1296	sub add_title {	1763	=item $popup->add_button ($text, $cb)
1297	my ($self, $title) = @_;
1298		1764
1299	$self->add_item ({	1765	Adds a clickable button to the popup. C<$cb> is called whenever it is
1300	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1766	selected.
1301	text => $title,	1767
1302	activate => sub { },	1768	=cut
1303	});
1304	}
1305		1769
1306	sub add_button {	1770	sub add_button {
1307	my ($self, $text, $cb) = @_;	1771	my ($self, $text, $cb) = @_;
1308		1772
1309	$self->add_item ({ type => "button", text => $text, activate => $cb});	1773	$self->add_item ({ type => "button", text => $text, activate => $cb});
1310	}	1774	}
		1775
		1776	=item $popup->add_toggle ($text, $cb, $initial_value)
		1777
		1778	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1779	whenever it gets toggled, with a boolean indicating its value as its first
		1780	argument.
		1781
		1782	=cut
1311		1783
1312	sub add_toggle {	1784	sub add_toggle {
1313	my ($self, $text, $cb, $value) = @_;	1785	my ($self, $text, $cb, $value) = @_;
1314		1786
1315	my $item; $item = {	1787	my $item; $item = {
1316	type => "button",	1788	type => "button",
1317	text => " $text",	1789	text => " $text",
1318	value => $value,	1790	value => $value,
1319	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1791	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1320	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1792	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1321	};	1793	};
1322		1794
1323	$self->add_item ($item);	1795	$self->add_item ($item);
1324	}	1796	}
		1797
		1798	=item $popup->show
		1799
		1800	Displays the popup (which is initially hidden).
		1801
		1802	=cut
1325		1803
1326	sub show {	1804	sub show {
1327	my ($self) = @_;	1805	my ($self) = @_;
1328		1806
1329	local $urxvt::popup::self = $self;	1807	local $urxvt::popup::self = $self;
1330		1808
		1809	my $env = $self->{term}->env;
		1810	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1811	delete $env->{LC_ALL};
1331	local $ENV{LC_ALL} = $self->{term}->locale;	1812	$env->{LC_CTYPE} = $self->{term}->locale;
1332		1813
1333	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1814	urxvt::term->new ($env, "popup",
		1815	"--perl-lib" => "", "--perl-ext-common" => "",
		1816	"-pty-fd" => -1, "-sl" => 0,
		1817	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1334	"--transient-for" => $self->{term}->parent,	1818	"--transient-for" => $self->{term}->parent,
1335	"-display" => $self->{term}->display_id,	1819	"-display" => $self->{term}->display_id,
1336	"-pe" => "urxvt-popup")	1820	"-pe" => "urxvt-popup")
1337	or die "unable to create popup window\n";	1821	or die "unable to create popup window\n";
1338	}	1822	}
1339		1823
1340	sub DESTROY {	1824	sub DESTROY {
1341	my ($self) = @_;	1825	my ($self) = @_;
1342		1826
1343	delete $self->{term}{_destroy}{$self};	1827	delete $self->{term}{_destroy}{$self};
1344	$self->{term}->ungrab;	1828	$self->{term}->ungrab;
1345	}	1829	}
		1830
		1831	=back
		1832
		1833	=cut
		1834
		1835	package urxvt::watcher;
		1836
		1837	@urxvt::timer::ISA = __PACKAGE__;
		1838	@urxvt::iow::ISA = __PACKAGE__;
		1839	@urxvt::pw::ISA = __PACKAGE__;
		1840	@urxvt::iw::ISA = __PACKAGE__;
1346		1841
1347	=head2 The C<urxvt::timer> Class	1842	=head2 The C<urxvt::timer> Class
1348		1843
1349	This class implements timer watchers/events. Time is represented as a	1844	This class implements timer watchers/events. Time is represented as a
1350	fractional number of seconds since the epoch. Example:	1845	fractional number of seconds since the epoch. Example:
…		…
1388	Start the timer.	1883	Start the timer.
1389		1884
1390	=item $timer = $timer->start ($tstamp)	1885	=item $timer = $timer->start ($tstamp)
1391		1886
1392	Set the event trigger time to C<$tstamp> and start the timer.	1887	Set the event trigger time to C<$tstamp> and start the timer.
		1888
		1889	=item $timer = $timer->after ($delay)
		1890
		1891	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1393		1892
1394	=item $timer = $timer->stop	1893	=item $timer = $timer->stop
1395		1894
1396	Stop the timer.	1895	Stop the timer.
1397		1896
…		…
1444		1943
1445	Stop watching for events on the given filehandle.	1944	Stop watching for events on the given filehandle.
1446		1945
1447	=back	1946	=back
1448		1947
		1948	=head2 The C<urxvt::iw> Class
		1949
		1950	This class implements idle watchers, that get called automatically when
		1951	the process is idle. They should return as fast as possible, after doing
		1952	some useful work.
		1953
		1954	=over 4
		1955
		1956	=item $iw = new urxvt::iw
		1957
		1958	Create a new idle watcher object in stopped state.
		1959
		1960	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		1961
		1962	Set the callback to be called when the watcher triggers.
		1963
		1964	=item $timer = $timer->start
		1965
		1966	Start the watcher.
		1967
		1968	=item $timer = $timer->stop
		1969
		1970	Stop the watcher.
		1971
		1972	=back
		1973
		1974	=head2 The C<urxvt::pw> Class
		1975
		1976	This class implements process watchers. They create an event whenever a
		1977	process exits, after which they stop automatically.
		1978
		1979	my $pid = fork;
		1980	...
		1981	$term->{pw} = urxvt::pw
		1982	->new
		1983	->start ($pid)
		1984	->cb (sub {
		1985	my ($pw, $exit_status) = @_;
		1986	...
		1987	});
		1988
		1989	=over 4
		1990
		1991	=item $pw = new urxvt::pw
		1992
		1993	Create a new process watcher in stopped state.
		1994
		1995	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		1996
		1997	Set the callback to be called when the timer triggers.
		1998
		1999	=item $pw = $timer->start ($pid)
		2000
		2001	Tells the wqtcher to start watching for process C<$pid>.
		2002
		2003	=item $pw = $pw->stop
		2004
		2005	Stop the watcher.
		2006
		2007	=back
		2008
1449	=head1 ENVIRONMENT	2009	=head1 ENVIRONMENT
1450		2010
1451	=head2 URXVT_PERL_VERBOSITY	2011	=head2 URXVT_PERL_VERBOSITY
1452		2012
1453	This variable controls the verbosity level of the perl extension. Higher	2013	This variable controls the verbosity level of the perl extension. Higher
…		…
1457		2017
1458	=item == 0 - fatal messages	2018	=item == 0 - fatal messages
1459		2019
1460	=item >= 3 - script loading and management	2020	=item >= 3 - script loading and management
1461		2021
1462	=item >=10 - all events received	2022	=item >=10 - all called hooks
		2023
		2024	=item >=11 - hook reutrn values
1463		2025
1464	=back	2026	=back
1465		2027
1466	=head1 AUTHOR	2028	=head1 AUTHOR
1467		2029

Diff Legend

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