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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.77 by root, Wed Jan 11 00:59:58 2006 UTC vs.
Revision 1.136 by root, Mon Feb 20 20:44:22 2006 UTC

…		…
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	(More) intelligent selection. This extension tries to be more intelligent	48	(More) intelligent selection. This extension tries to be more intelligent
45	when the user extends selections (double-click). Right now, it tries to	49	when the user extends selections (double-click and further clicks). Right
46	select urls and complete shell-quoted arguments, which is very convenient,	50	now, it tries to select words, urls and complete shell-quoted
47	too, 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
		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
49	It also offers the following bindable keyboard command:	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
…		…
61	=item option-popup (enabled by default)	94	=item option-popup (enabled by default)
62		95
63	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at	96	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64	runtime.	97	runtime.
65		98
		99	Other extensions can extend this popup menu by pushing a code reference
		100	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
		101	popup is being displayed.
		102
		103	It's sole argument is the popup menu, which can be modified. It should
		104	either return nothing or a string, the initial boolean value and a code
		105	reference. The string will be used as button text and the code reference
		106	will be called when the toggle changes, with the new boolean value as
		107	first argument.
		108
		109	The following will add an entry C<myoption> that changes
		110	C<$self->{myoption}>:
		111
		112	push @{ $self->{term}{option_popup_hook} }, sub {
		113	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
		114	};
		115
66	=item selection-popup (enabled by default)	116	=item selection-popup (enabled by default)
67		117
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	118	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action (such as uri unescaping, perl	119	text into various other formats/action (such as uri unescaping, perl
70	evalution, web-browser starting etc.), depending on content.	120	evaluation, web-browser starting etc.), depending on content.
		121
		122	Other extensions can extend this popup menu by pushing a code reference
		123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
		124	popup is being displayed.
		125
		126	It's sole argument is the popup menu, which can be modified. The selection
		127	is in C<$_>, which can be used to decide wether to add something or not.
		128	It should either return nothing or a string and a code reference. The
		129	string will be used as button text and the code reference will be called
		130	when the button gets activated and should transform C<$_>.
		131
		132	The following will add an entry C<a to b> that transforms all C<a>s in
		133	the selection to C<b>s, but only if the selection currently contains any
		134	C<a>s:
		135
		136	push @{ $self->{term}{selection_popup_hook} }, sub {
		137	/a/ ? ("a to be" => sub { s/a/b/g }
		138	: ()
		139	};
71		140
72	=item searchable-scrollback<hotkey> (enabled by default)	141	=item searchable-scrollback<hotkey> (enabled by default)
73		142
74	Adds regex search functionality to the scrollback buffer, triggered	143	Adds regex search functionality to the scrollback buffer, triggered
75	by a hotkey (default: C<M-s>). When in search mode, normal terminal	144	by a hotkey (default: C<M-s>). While in search mode, normal terminal
76	input/output is suspended.	145	input/output is suspended and a regex is displayed at the bottom of the
		146	screen.
77		147
78	C</> starts an incremental regex search, C<n> searches further, C<p> or	148	Inputting characters appends them to the regex and continues incremental
79	C<N> jump to the previous match, C<G> jumps to the bottom and clears the	149	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
80	history, C<enter> leaves search mode at the current position and C<escape>	150	search upwards/downwards in the scrollback buffer, C<End> jumps to the
81	returns to the original position.	151	bottom. C<Escape> leaves search mode and returns to the point where search
		152	was started, while C<Enter> or C<Return> stay at the current position and
		153	additionally stores the first match in the current line into the primary
		154	selection.
82		155
83	=item digital-clock	156	=item readline (enabled by default)
84		157
85	Displays a digital clock using the built-in overlay.	158	A support package that tries to make editing with readline easier. At
		159	the moment, it reacts to clicking shift-left mouse button by trying to
		160	move the text cursor to this position. It does so by generating as many
		161	cursor-left or cursor-right keypresses as required (the this only works
		162	for programs that correctly support wide characters).
		163
		164	To avoid too many false positives, this is only done when:
		165
		166	=over 4
		167
		168	=item - the tty is in ICANON state.
		169
		170	=item - the text cursor is visible.
		171
		172	=item - the primary screen is currently being displayed.
		173
		174	=item - the mouse is on the same (multi-row-) line as the text cursor.
		175
		176	=back
		177
		178	The normal selection mechanism isn't disabled, so quick successive clicks
		179	might interfere with selection creation in harmless ways.
		180
		181	=item selection-autotransform
		182
		183	This selection allows you to do automatic transforms on a selection
		184	whenever a selection is made.
		185
		186	It works by specifying perl snippets (most useful is a single C<s///>
		187	operator) that modify C<$_> as resources:
		188
		189	URxvt.selection-autotransform.0: transform
		190	URxvt.selection-autotransform.1: transform
		191	...
		192
		193	For example, the following will transform selections of the form
		194	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		195	$word>:
		196
		197	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		198
		199	And this example matches the same,but replaces it with vi-commands you can
		200	paste directly into your (vi :) editor:
		201
		202	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		203
		204	Of course, this can be modified to suit your needs and your editor :)
		205
		206	To expand the example above to typical perl error messages ("XXX at
		207	FILENAME line YYY."), you need a slightly more elaborate solution:
		208
		209	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		210	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		211
		212	The first line tells the selection code to treat the unchanging part of
		213	every error message as a selection pattern, and the second line transforms
		214	the message into vi commands to load the file.
		215
		216	=item tabbed
		217
		218	This transforms the terminal into a tabbar with additional terminals, that
		219	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		220	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		221	button per tab.
		222
		223	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		224	B<Shift-Right> will switch to the tab left or right of the current one,
		225	while B<Shift-Down> creates a new tab.
		226
		227	The tabbar itself can be configured similarly to a normal terminal, but
		228	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		229	following four resources (shown with defaults):
		230
		231	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		232	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		233	URxvt.tabbed.tab-fg: <colour-index, default 0>
		234	URxvt.tabbed.tab-bg: <colour-index, default 1>
		235
		236	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		237	indices.
86		238
87	=item mark-urls	239	=item mark-urls
88		240
89	Uses per-line display filtering (C<on_line_update>) to underline urls.	241	Uses per-line display filtering (C<on_line_update>) to underline urls and
		242	make them clickable. When middle-clicked, the program specified in the
		243	resource C<urlLauncher> (default C<x-www-browser>) will be started with
		244	the URL as first argument.
		245
		246	=item xim-onthespot
		247
		248	This (experimental) perl extension implements OnTheSpot editing. It does
		249	not work perfectly, and some input methods don't seem to work well with
		250	OnTheSpot editing in general, but it seems to work at leats for SCIM and
		251	kinput2.
		252
		253	You enable it by specifying this extension and a preedit style of
		254	C<OnTheSpot>, i.e.:
		255
		256	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		257
		258	=item automove-background
		259
		260	This is basically a one-line extension that dynamically changes the background pixmap offset
		261	to the window position, in effect creating the same effect as pseudo transparency with
		262	a custom pixmap. No scaling is supported in this mode. Exmaple:
		263
		264	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
90		265
91	=item block-graphics-to-ascii	266	=item block-graphics-to-ascii
92		267
93	A not very useful example of filtering all text output to the terminal,	268	A not very useful example of filtering all text output to the terminal,
94	by replacing all line-drawing characters (U+2500 .. U+259F) by a	269	by replacing all line-drawing characters (U+2500 .. U+259F) by a
95	similar-looking ascii character.	270	similar-looking ascii character.
		271
		272	=item digital-clock
		273
		274	Displays a digital clock using the built-in overlay.
		275
		276	=item remote-clipboard
		277
		278	Somewhat of a misnomer, this extension adds two menu entries to the
		279	selection popup that allows one ti run external commands to store the
		280	selection somewhere and fetch it again.
		281
		282	We use it to implement a "distributed selection mechanism", which just
		283	means that one command uploads the file to a remote server, and another
		284	reads it.
		285
		286	The commands can be set using the C<URxvt.remote-selection.store> and
		287	C<URxvt.remote-selection.fetch> resources. The first should read the
		288	selection to store from STDIN (always in UTF-8), the second should provide
		289	the selection data on STDOUT (also in UTF-8).
		290
		291	The defaults (which are likely useless to you) use rsh and cat:
		292
		293	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		294	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		295
		296	=item selection-pastebin
		297
		298	This is a little rarely useful extension that Uploads the selection as
		299	textfile to a remote site (or does other things). (The implementation is
		300	not currently secure for use in a multiuser environment as it writes to
		301	F</tmp> directly.).
		302
		303	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		304	i.e.
		305
		306	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		307
		308	Pressing this combination runs a command with C<%> replaced by the name of
		309	the textfile. This command can be set via a resource:
		310
		311	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		312
		313	And the default is likely not useful to anybody but the few people around
		314	here :)
		315
		316	The name of the textfile is the hex encoded md5 sum of the selection, so
		317	the same content should lead to the same filename.
		318
		319	After a successful upload the selection will be replaced by the text given
		320	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		321	for the filename):
		322
		323	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
96		324
97	=item example-refresh-hooks	325	=item example-refresh-hooks
98		326
99	Displays a very simple digital clock in the upper right corner of the	327	Displays a very simple digital clock in the upper right corner of the
100	window. Illustrates overwriting the refresh callbacks to create your own	328	window. Illustrates overwriting the refresh callbacks to create your own
…		…
123	=over 4	351	=over 4
124		352
125	=item $text	353	=item $text
126		354
127	Rxvt-unicodes special way of encoding text, where one "unicode" character	355	Rxvt-unicodes special way of encoding text, where one "unicode" character
128	always represents one screen cell. See L<row_t> for a discussion of this format.	356	always represents one screen cell. See L<ROW_t> for a discussion of this format.
129		357
130	=item $string	358	=item $string
131		359
132	A perl text string, with an emphasis on I<text>. It can store all unicode	360	A perl text string, with an emphasis on I<text>. It can store all unicode
133	characters and is to be distinguished with text encoded in a specific	361	characters and is to be distinguished with text encoded in a specific
…		…
179	called whenever the relevant event happens.	407	called whenever the relevant event happens.
180		408
181	The first argument passed to them is an extension oject as described in	409	The first argument passed to them is an extension oject as described in
182	the in the C<Extension Objects> section.	410	the in the C<Extension Objects> section.
183		411
184	B<All> of these hooks must return a boolean value. If it is true, then the	412	B<All> of these hooks must return a boolean value. If any of the called
185	event counts as being I<consumed>, and the invocation of other hooks is	413	hooks returns true, then the event counts as being I<consumed>, and the
186	skipped, and the relevant action might not be carried out by the C++ code.	414	relevant action might not be carried out by the C++ code.
187		415
188	I<< When in doubt, return a false value (preferably C<()>). >>	416	I<< When in doubt, return a false value (preferably C<()>). >>
189		417
190	=over 4	418	=over 4
191		419
192	=item on_init $term	420	=item on_init $term
193		421
194	Called after a new terminal object has been initialized, but before	422	Called after a new terminal object has been initialized, but before
195	windows are created or the command gets run. Most methods are unsafe to	423	windows are created or the command gets run. Most methods are unsafe to
196	call or deliver senseless data, as terminal size and other characteristics	424	call or deliver senseless data, as terminal size and other characteristics
197	have not yet been determined. You can safely query and change resources,	425	have not yet been determined. You can safely query and change resources
198	though.	426	and options, though. For many purposes the C<on_start> hook is a better
		427	place.
		428
		429	=item on_start $term
		430
		431	Called at the very end of initialisation of a new terminal, just before
		432	trying to map (display) the toplevel and returning to the mainloop.
		433
		434	=item on_destroy $term
		435
		436	Called whenever something tries to destroy terminal, when the terminal is
		437	still fully functional (not for long, though).
199		438
200	=item on_reset $term	439	=item on_reset $term
201		440
202	Called after the screen is "reset" for any reason, such as resizing or	441	Called after the screen is "reset" for any reason, such as resizing or
203	control sequences. Here is where you can react on changes to size-related	442	control sequences. Here is where you can react on changes to size-related
204	variables.	443	variables.
205		444
206	=item on_start $term	445	=item on_child_start $term, $pid
207		446
208	Called at the very end of initialisation of a new terminal, just before	447	Called just after the child process has been C<fork>ed.
209	returning to the mainloop.	448
		449	=item on_child_exit $term, $status
		450
		451	Called just after the child process has exited. C<$status> is the status
		452	from C<waitpid>.
210		453
211	=item on_sel_make $term, $eventtime	454	=item on_sel_make $term, $eventtime
212		455
213	Called whenever a selection has been made by the user, but before the	456	Called whenever a selection has been made by the user, but before the
214	selection text is copied, so changes to the beginning, end or type of the	457	selection text is copied, so changes to the beginning, end or type of the
…		…
228	=item on_sel_extend $term	471	=item on_sel_extend $term
229		472
230	Called whenever the user tries to extend the selection (e.g. with a double	473	Called whenever the user tries to extend the selection (e.g. with a double
231	click) and is either supposed to return false (normal operation), or	474	click) and is either supposed to return false (normal operation), or
232	should extend the selection itelf and return true to suppress the built-in	475	should extend the selection itelf and return true to suppress the built-in
233	processing.	476	processing. This can happen multiple times, as long as the callback
		477	returns true, it will be called on every further click by the user and is
		478	supposed to enlarge the selection more and more, if possible.
234		479
235	See the F<selection> example extension.	480	See the F<selection> example extension.
236		481
237	=item on_view_change $term, $offset	482	=item on_view_change $term, $offset
238		483
…		…
299		544
300	=item on_refresh_end $term	545	=item on_refresh_end $term
301		546
302	Called just after the screen gets redrawn. See C<on_refresh_begin>.	547	Called just after the screen gets redrawn. See C<on_refresh_begin>.
303		548
304	=item on_keyboard_command $term, $string	549	=item on_user_command $term, $string
305		550
306	Called whenever the user presses a key combination that has a	551	Called whenever the a user-configured event is being activated (e.g. via
307	C<perl:string> action bound to it (see description of the B<keysym>	552	a C<perl:string> action bound to a key, see description of the B<keysym>
308	resource in the @@RXVT_NAME@@(1) manpage).	553	resource in the @@RXVT_NAME@@(1) manpage).
		554
		555	The event is simply the action string. This interface is assumed to change
		556	slightly in the future.
		557
		558	=item on_resize_all_windows $tern, $new_width, $new_height
		559
		560	Called just after the new window size has been calculcated, but before
		561	windows are actually being resized or hints are being set. If this hook
		562	returns TRUE, setting of the window hints is being skipped.
		563
		564	=item on_x_event $term, $event
		565
		566	Called on every X event received on the vt window (and possibly other
		567	windows). Should only be used as a last resort. Most event structure
		568	members are not passed.
309		569
310	=item on_focus_in $term	570	=item on_focus_in $term
311		571
312	Called whenever the window gets the keyboard focus, before rxvt-unicode	572	Called whenever the window gets the keyboard focus, before rxvt-unicode
313	does focus in processing.	573	does focus in processing.
…		…
315	=item on_focus_out $term	575	=item on_focus_out $term
316		576
317	Called wheneever the window loses keyboard focus, before rxvt-unicode does	577	Called wheneever the window loses keyboard focus, before rxvt-unicode does
318	focus out processing.	578	focus out processing.
319		579
		580	=item on_configure_notify $term, $event
		581
		582	=item on_property_notify $term, $event
		583
320	=item on_key_press $term, $event, $keysym, $octets	584	=item on_key_press $term, $event, $keysym, $octets
321		585
322	=item on_key_release $term, $event, $keysym	586	=item on_key_release $term, $event, $keysym
323		587
324	=item on_button_press $term, $event	588	=item on_button_press $term, $event
…		…
333		597
334	Called whenever the corresponding X event is received for the terminal If	598	Called whenever the corresponding X event is received for the terminal If
335	the hook returns true, then the even will be ignored by rxvt-unicode.	599	the hook returns true, then the even will be ignored by rxvt-unicode.
336		600
337	The event is a hash with most values as named by Xlib (see the XEvent	601	The event is a hash with most values as named by Xlib (see the XEvent
338	manpage), with the additional members C<row> and C<col>, which are the row	602	manpage), with the additional members C<row> and C<col>, which are the
339	and column under the mouse cursor.	603	(real, not screen-based) row and column under the mouse cursor.
340		604
341	C<on_key_press> additionally receives the string rxvt-unicode would	605	C<on_key_press> additionally receives the string rxvt-unicode would
342	output, if any, in locale-specific encoding.	606	output, if any, in locale-specific encoding.
343		607
344	subwindow.	608	subwindow.
		609
		610	=item on_client_message $term, $event
		611
		612	=item on_wm_protocols $term, $event
		613
		614	=item on_wm_delete_window $term, $event
		615
		616	Called when various types of ClientMessage events are received (all with
		617	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
345		618
346	=back	619	=back
347		620
348	=cut	621	=cut
349		622
…		…
355	use Scalar::Util ();	628	use Scalar::Util ();
356	use List::Util ();	629	use List::Util ();
357		630
358	our $VERSION = 1;	631	our $VERSION = 1;
359	our $TERM;	632	our $TERM;
		633	our @TERM_INIT;
		634	our @TERM_EXT;
360	our @HOOKNAME;	635	our @HOOKNAME;
361	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	636	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
362	our %OPTION;	637	our %OPTION;
363		638
364	our $LIBDIR;	639	our $LIBDIR;
365	our $RESNAME;	640	our $RESNAME;
366	our $RESCLASS;	641	our $RESCLASS;
367	our $RXVTNAME;	642	our $RXVTNAME;
368		643
		644	our $NOCHAR = chr 0xffff;
		645
369	=head2 Variables in the C<urxvt> Package	646	=head2 Variables in the C<urxvt> Package
370		647
371	=over 4	648	=over 4
372		649
373	=item $urxvt::LIBDIR	650	=item $urxvt::LIBDIR
…		…
386	=item $urxvt::TERM	663	=item $urxvt::TERM
387		664
388	The current terminal. This variable stores the current C<urxvt::term>	665	The current terminal. This variable stores the current C<urxvt::term>
389	object, whenever a callback/hook is executing.	666	object, whenever a callback/hook is executing.
390		667
391	=item	668	=item @urxvt::TERM_INIT
		669
		670	All coderefs in this array will be called as methods of the next newly
		671	created C<urxvt::term> object (during the C<on_init> phase). The array
		672	gets cleared before the codereferences that were in it are being executed,
		673	so coderefs can push themselves onto it again if they so desire.
		674
		675	This complements to the perl-eval commandline option, but gets executed
		676	first.
		677
		678	=item @urxvt::TERM_EXT
		679
		680	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		681	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		682	but before other extensions. Gets cleared just like C<@TERM_INIT>.
392		683
393	=back	684	=back
394		685
395	=head2 Functions in the C<urxvt> Package	686	=head2 Functions in the C<urxvt> Package
396		687
…		…
411	Using this function has the advantage that its output ends up in the	702	Using this function has the advantage that its output ends up in the
412	correct place, e.g. on stderr of the connecting urxvtc client.	703	correct place, e.g. on stderr of the connecting urxvtc client.
413		704
414	Messages have a size limit of 1023 bytes currently.	705	Messages have a size limit of 1023 bytes currently.
415		706
416	=item $is_safe = urxvt::safe	707	=item @terms = urxvt::termlist
417		708
418	Returns true when it is safe to do potentially unsafe things, such as	709	Returns all urxvt::term objects that exist in this process, regardless of
419	evaluating perl code specified by the user. This is true when urxvt was	710	wether they are started, being destroyed etc., so be careful. Only term
420	started setuid or setgid.	711	objects that have perl extensions attached will be returned (because there
		712	is no urxvt::term objet associated with others).
421		713
422	=item $time = urxvt::NOW	714	=item $time = urxvt::NOW
423		715
424	Returns the "current time" (as per the event loop).	716	Returns the "current time" (as per the event loop).
425		717
426	=item urxvt::CurrentTime	718	=item urxvt::CurrentTime
427		719
428	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	720	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
429	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	721	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
430	Button4Mask, Button5Mask, AnyModifier	722	Button4Mask, Button5Mask, AnyModifier
		723
		724	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		725	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		726	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		727	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		728	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		729	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		730	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		731
		732	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		733	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		734	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		735	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		736	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		737	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		738	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
431		739
432	Various constants for use in X calls and event processing.	740	Various constants for use in X calls and event processing.
433		741
434	=back	742	=back
435		743
…		…
468		776
469	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	777	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
470		778
471	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	779	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
472		780
		781	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		782
473	Replace the foreground/background colour in the rendition mask with the	783	Replace the foreground/background colour in the rendition mask with the
474	specified one.	784	specified one.
475		785
476	=item $value = urxvt::GET_CUSTOM $rend	786	=item $value = urxvt::GET_CUSTOM $rend
477		787
…		…
486	=back	796	=back
487		797
488	=cut	798	=cut
489		799
490	BEGIN {	800	BEGIN {
491	urxvt->bootstrap;
492
493	# overwrite perl's warn	801	# overwrite perl's warn
494	*CORE::GLOBAL::warn = sub {	802	*CORE::GLOBAL::warn = sub {
495	my $msg = join "", @_;	803	my $msg = join "", @_;
496	$msg .= "\n"	804	$msg .= "\n"
497	unless $msg =~ /\n$/;	805	unless $msg =~ /\n$/;
498	urxvt::warn ($msg);	806	urxvt::warn ($msg);
499	};	807	};
500
501	delete $ENV{IFS};
502	delete $ENV{CDPATH};
503	delete $ENV{BASH_ENV};
504	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
505	}	808	}
506		809
507	my @hook_count;	810	no warnings 'utf8';
		811
508	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	812	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
509		813
510	sub verbose {	814	sub verbose {
511	my ($level, $msg) = @_;	815	my ($level, $msg) = @_;
512	warn "$msg\n" if $level <= $verbosity;	816	warn "$msg\n" if $level <= $verbosity;
513	}	817	}
514		818
515	my $extension_pkg = "extension0000";
516	my %extension_pkg;	819	my %extension_pkg;
517		820
518	# load a single script into its own package, once only	821	# load a single script into its own package, once only
519	sub extension_package($) {	822	sub extension_package($) {
520	my ($path) = @_;	823	my ($path) = @_;
521		824
522	$extension_pkg{$path} \|\|= do {	825	$extension_pkg{$path} \|\|= do {
523	my $pkg = "urxvt::" . ($extension_pkg++);	826	$path =~ /([^\/\\]+)$/;
		827	my $pkg = $1;
		828	$pkg =~ s/[^[:word:]]/_/g;
		829	$pkg = "urxvt::ext::$pkg";
524		830
525	verbose 3, "loading extension '$path' into package '$pkg'";	831	verbose 3, "loading extension '$path' into package '$pkg'";
526		832
527	open my $fh, "<:raw", $path	833	open my $fh, "<:raw", $path
528	or die "$path: $!";	834	or die "$path: $!";
529		835
530	my $source = untaint	836	my $source =
531	"package $pkg; use strict; use utf8;\n"	837	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
532	. "use base urxvt::term::extension::;\n"
533	. "#line 1 \"$path\"\n{\n"	838	. "#line 1 \"$path\"\n{\n"
534	. (do { local $/; <$fh> })	839	. (do { local $/; <$fh> })
535	. "\n};\n1";	840	. "\n};\n1";
536		841
537	eval $source	842	eval $source
…		…
551	if ($htype == 0) { # INIT	856	if ($htype == 0) { # INIT
552	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	857	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
553		858
554	my %ext_arg;	859	my %ext_arg;
555		860
		861	{
		862	my @init = @TERM_INIT;
		863	@TERM_INIT = ();
		864	$_->($TERM) for @init;
		865	my @pkg = @TERM_EXT;
		866	@TERM_EXT = ();
		867	$TERM->register_package ($_) for @pkg;
		868	}
		869
556	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	870	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
557	if ($_ eq "default") {	871	if ($_ eq "default") {
558	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	872	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
559	} elsif (/^-(.*)$/) {	873	} elsif (/^-(.*)$/) {
560	delete $ext_arg{$1};	874	delete $ext_arg{$1};
561	} elsif (/^([^<]+)<(.*)>$/) {	875	} elsif (/^([^<]+)<(.*)>$/) {
562	push @{ $ext_arg{$1} }, $2;	876	push @{ $ext_arg{$1} }, $2;
563	} else {	877	} else {
564	$ext_arg{$_} \|\|= [];	878	$ext_arg{$_} \|\|= [];
565	}	879	}
566	}	880	}
567		881
568	while (my ($ext, $argv) = each %ext_arg) {	882	for my $ext (sort keys %ext_arg) {
569	my @files = grep -f $_, map "$_/$ext", @dirs;	883	my @files = grep -f $_, map "$_/$ext", @dirs;
570		884
571	if (@files) {	885	if (@files) {
572	$TERM->register_package (extension_package $files[0], $argv);	886	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
573	} else {	887	} else {
574	warn "perl extension '$ext' not found in perl library search path\n";	888	warn "perl extension '$ext' not found in perl library search path\n";
575	}	889	}
576	}	890	}
577		891
…		…
586	if $verbosity >= 10;	900	if $verbosity >= 10;
587		901
588	keys %$cb;	902	keys %$cb;
589		903
590	while (my ($pkg, $cb) = each %$cb) {	904	while (my ($pkg, $cb) = each %$cb) {
591	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	905	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
592	and last;	906	$retval \|\|= $retval_;
593		907
594	if ($@) {	908	if ($@) {
595	$TERM->ungrab; # better to lose the grab than the session	909	$TERM->ungrab; # better to lose the grab than the session
596	warn $@;	910	warn $@;
597	}	911	}
598	}	912	}
		913
		914	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		915	if $verbosity >= 11;
599	}	916	}
600		917
601	if ($htype == 1) { # DESTROY	918	if ($htype == 1) { # DESTROY
602	if (my $hook = delete $TERM->{_hook}) {
603	for my $htype (0..$#$hook) {
604	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
605	or set_should_invoke $htype, 0;
606	}
607	}
608
609	# clear package objects	919	# clear package objects
610	%$_ = () for values %{ $TERM->{_pkg} };	920	%$_ = () for values %{ $TERM->{_pkg} };
611		921
612	# clear package	922	# clear package
613	%$TERM = ();	923	%$TERM = ();
614	}	924	}
615		925
616	$retval	926	$retval
		927	}
		928
		929	sub SET_COLOR($$$) {
		930	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
617	}	931	}
618		932
619	# urxvt::term::extension	933	# urxvt::term::extension
620		934
621	package urxvt::term::extension;	935	package urxvt::term::extension;
…		…
627	while (my ($name, $cb) = each %hook) {	941	while (my ($name, $cb) = each %hook) {
628	my $htype = $HOOKTYPE{uc $name};	942	my $htype = $HOOKTYPE{uc $name};
629	defined $htype	943	defined $htype
630	or Carp::croak "unsupported hook type '$name'";	944	or Carp::croak "unsupported hook type '$name'";
631		945
		946	$self->set_should_invoke ($htype, +1)
632	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	947	unless exists $self->{term}{_hook}[$htype]{$pkg};
633	$hook_count[$htype]++
634	or urxvt::set_should_invoke $htype, 1;
635	}
636		948
637	$self->{term}{_hook}[$htype]{$pkg} = $cb;	949	$self->{term}{_hook}[$htype]{$pkg} = $cb;
638	}	950	}
639	}	951	}
640		952
…		…
645	for my $name (@hook) {	957	for my $name (@hook) {
646	my $htype = $HOOKTYPE{uc $name};	958	my $htype = $HOOKTYPE{uc $name};
647	defined $htype	959	defined $htype
648	or Carp::croak "unsupported hook type '$name'";	960	or Carp::croak "unsupported hook type '$name'";
649		961
		962	$self->set_should_invoke ($htype, -1)
650	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	963	if delete $self->{term}{_hook}[$htype]{$pkg};
651	--$hook_count[$htype]
652	or urxvt::set_should_invoke $htype, 0;
653	}
654	}	964	}
655	}	965	}
656		966
657	our $AUTOLOAD;	967	our $AUTOLOAD;
658		968
…		…
764	# find on_xxx subs in the package and register them	1074	# find on_xxx subs in the package and register them
765	# as hooks	1075	# as hooks
766	sub register_package {	1076	sub register_package {
767	my ($self, $pkg, $argv) = @_;	1077	my ($self, $pkg, $argv) = @_;
768		1078
		1079	no strict 'refs';
		1080
		1081	urxvt::verbose 6, "register package $pkg to $self";
		1082
		1083	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1084
769	my $proxy = bless {	1085	my $proxy = bless {
770	_pkg => $pkg,	1086	_pkg => $pkg,
771	argv => $argv,	1087	argv => $argv,
772	}, $pkg;	1088	}, $pkg;
773	Scalar::Util::weaken ($proxy->{term} = $self);	1089	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
782	}	1098	}
783		1099
784	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]	1100	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
785		1101
786	Creates a new terminal, very similar as if you had started it with system	1102	Creates a new terminal, very similar as if you had started it with system
787	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a %ENV>-like	1103	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
788	C<hash which defines the environment of the new terminal.	1104	hash which defines the environment of the new terminal.
789		1105
790	Croaks (and probably outputs an error message) if the new instance	1106	Croaks (and probably outputs an error message) if the new instance
791	couldn't be created. Returns C<undef> if the new instance didn't	1107	couldn't be created. Returns C<undef> if the new instance didn't
792	initialise perl, and the terminal object otherwise. The C<init> and	1108	initialise perl, and the terminal object otherwise. The C<init> and
793	C<start> hooks will be called during this call.	1109	C<start> hooks will be called before this call returns, and are free to
		1110	refer to global data (which is race free).
794		1111
795	=cut	1112	=cut
796		1113
797	sub new {	1114	sub new {
798	my ($class, $env, @args) = @_;	1115	my ($class, $env, @args) = @_;
799		1116
		1117	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1118	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1119
800	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1120	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
801	}	1121	}
802		1122
803	=item $term->destroy	1123	=item $term->destroy
804		1124
805	Destroy the terminal object (close the window, free resources	1125	Destroy the terminal object (close the window, free resources
806	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1126	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
807	watchers (timers, io watchers) are still active.	1127	watchers (timers, io watchers) are still active.
808		1128
		1129	=item $term->exec_async ($cmd[, @args])
		1130
		1131	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1132	("starts") programs in the background. This function takes care of setting
		1133	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1134	be preferred over explicit calls to C<exec> or C<system>.
		1135
		1136	Returns the pid of the subprocess or C<undef> on error.
		1137
		1138	=cut
		1139
		1140	sub exec_async {
		1141	my $self = shift;
		1142
		1143	my $pid = fork;
		1144
		1145	return $pid
		1146	if !defined $pid or $pid;
		1147
		1148	%ENV = %{ $self->env };
		1149
		1150	exec @_;
		1151	urxvt::_exit 255;
		1152	}
		1153
809	=item $isset = $term->option ($optval[, $set])	1154	=item $isset = $term->option ($optval[, $set])
810		1155
811	Returns true if the option specified by C<$optval> is enabled, and	1156	Returns true if the option specified by C<$optval> is enabled, and
812	optionally change it. All option values are stored by name in the hash	1157	optionally change it. All option values are stored by name in the hash
813	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1158	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
815	Here is a a likely non-exhaustive list of option names, please see the	1160	Here is a a likely non-exhaustive list of option names, please see the
816	source file F</src/optinc.h> to see the actual list:	1161	source file F</src/optinc.h> to see the actual list:
817		1162
818	borderLess console cursorBlink cursorUnderline hold iconic insecure	1163	borderLess console cursorBlink cursorUnderline hold iconic insecure
819	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1164	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
820	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1165	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
821	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1166	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
822	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1167	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
823	tripleclickwords utmpInhibit visualBell	1168	transparent tripleclickwords utmpInhibit visualBell
824		1169
825	=item $value = $term->resource ($name[, $newval])	1170	=item $value = $term->resource ($name[, $newval])
826		1171
827	Returns the current resource value associated with a given name and	1172	Returns the current resource value associated with a given name and
828	optionally sets a new value. Setting values is most useful in the C<init>	1173	optionally sets a new value. Setting values is most useful in the C<init>
…		…
845		1190
846	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1191	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
847	borderLess color cursorBlink cursorUnderline cutchars delete_key	1192	borderLess color cursorBlink cursorUnderline cutchars delete_key
848	display_name embed ext_bwidth fade font geometry hold iconName	1193	display_name embed ext_bwidth fade font geometry hold iconName
849	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1194	imFont imLocale inputMethod insecure int_bwidth intensityStyles
850	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1195	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
851	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1196	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
852	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1197	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
853	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1198	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
854	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1199	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
855	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1200	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
856	shade term_name title transparent transparent_all tripleclickwords	1201	secondaryScreen secondaryScroll selectstyle shade term_name title
857	utmpInhibit visualBell	1202	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1203	visualBell
858		1204
859	=cut	1205	=cut
860		1206
861	sub resource($$;$) {	1207	sub resource($$;$) {
862	my ($self, $name) = (shift, shift);	1208	my ($self, $name) = (shift, shift);
863	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1209	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
864	&urxvt::term::_resource	1210	&urxvt::term::_resource
865	}	1211	}
866		1212
		1213	=item $value = $term->x_resource ($pattern)
		1214
		1215	Returns the X-Resource for the given pattern, excluding the program or
		1216	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1217	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1218	resource with that pattern exists.
		1219
		1220	This method should only be called during the C<on_start> hook, as there is
		1221	only one resource database per display, and later invocations might return
		1222	the wrong resources.
		1223
867	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1224	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
868		1225
869	Adds a keymap translation exactly as specified via a resource. See the	1226	Adds a keymap translation exactly as specified via a resource. See the
870	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1227	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
871		1228
…		…
886	=item ($row, $col) = $term->selection_end ([$row, $col])	1243	=item ($row, $col) = $term->selection_end ([$row, $col])
887		1244
888	Return the current values of the selection mark, begin or end positions,	1245	Return the current values of the selection mark, begin or end positions,
889	and optionally set them to new values.	1246	and optionally set them to new values.
890		1247
		1248	=item $term->selection_make ($eventtime[, $rectangular])
		1249
		1250	Tries to make a selection as set by C<selection_beg> and
		1251	C<selection_end>. If C<$rectangular> is true (default: false), a
		1252	rectangular selection will be made. This is the prefered function to make
		1253	a selection.
		1254
891	=item $success = $term->selection_grab ($eventtime)	1255	=item $success = $term->selection_grab ($eventtime)
892		1256
893	Try to request the primary selection from the server (for example, as set	1257	Try to request the primary selection text from the server (for example, as
894	by the next method).	1258	set by the next method). No visual feedback will be given. This function
		1259	is mostly useful from within C<on_sel_grab> hooks.
895		1260
896	=item $oldtext = $term->selection ([$newtext])	1261	=item $oldtext = $term->selection ([$newtext])
897		1262
898	Return the current selection text and optionally replace it by C<$newtext>.	1263	Return the current selection text and optionally replace it by C<$newtext>.
899		1264
…		…
992	Convert the given locale-encoded octets into a perl string.	1357	Convert the given locale-encoded octets into a perl string.
993		1358
994	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1359	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
995		1360
996	XORs the rendition values in the given span with the provided value	1361	XORs the rendition values in the given span with the provided value
997	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1362	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
998	to the selection.	1363	refresh hooks to provide effects similar to the selection.
999		1364
1000	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1365	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1001		1366
1002	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1367	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1003	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1368	whitespace will additionally be xored with the C<$rstyle2>, which defaults
1004	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines	1369	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
1005	it instead.	1370	it instead. Both styles I<MUST NOT> contain font styles.
1006		1371
1007	=item $term->scr_bell	1372	=item $term->scr_bell
1008		1373
1009	Ring the bell!	1374	Ring the bell!
1010		1375
…		…
1017		1382
1018	Normally its not a good idea to use this function, as programs might be	1383	Normally its not a good idea to use this function, as programs might be
1019	confused by changes in cursor position or scrolling. Its useful inside a	1384	confused by changes in cursor position or scrolling. Its useful inside a
1020	C<on_add_lines> hook, though.	1385	C<on_add_lines> hook, though.
1021		1386
		1387	=item $term->scr_change_screen ($screen)
		1388
		1389	Switch to given screen - 0 primary, 1 secondary.
		1390
1022	=item $term->cmd_parse ($octets)	1391	=item $term->cmd_parse ($octets)
1023		1392
1024	Similar to C<scr_add_lines>, but the argument must be in the	1393	Similar to C<scr_add_lines>, but the argument must be in the
1025	locale-specific encoding of the terminal and can contain command sequences	1394	locale-specific encoding of the terminal and can contain command sequences
1026	(escape codes) that will be interpreted.	1395	(escape codes) that will be interpreted.
…		…
1036	Replaces the event mask of the pty watcher by the given event mask. Can	1405	Replaces the event mask of the pty watcher by the given event mask. Can
1037	be used to suppress input and output handling to the pty/tty. See the	1406	be used to suppress input and output handling to the pty/tty. See the
1038	description of C<< urxvt::timer->events >>. Make sure to always restore	1407	description of C<< urxvt::timer->events >>. Make sure to always restore
1039	the previous value.	1408	the previous value.
1040		1409
		1410	=item $fd = $term->pty_fd
		1411
		1412	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1413	is used.
		1414
1041	=item $windowid = $term->parent	1415	=item $windowid = $term->parent
1042		1416
1043	Return the window id of the toplevel window.	1417	Return the window id of the toplevel window.
1044		1418
1045	=item $windowid = $term->vt	1419	=item $windowid = $term->vt
1046		1420
1047	Return the window id of the terminal window.	1421	Return the window id of the terminal window.
1048		1422
		1423	=item $term->vt_emask_add ($x_event_mask)
		1424
		1425	Adds the specified events to the vt event mask. Useful e.g. when you want
		1426	to receive pointer events all the times:
		1427
		1428	$term->vt_emask_add (urxvt::PointerMotionMask);
		1429
		1430	=item $term->focus_in
		1431
		1432	=item $term->focus_out
		1433
		1434	=item $term->key_press ($state, $keycode[, $time])
		1435
		1436	=item $term->key_release ($state, $keycode[, $time])
		1437
		1438	Deliver various fake events to to terminal.
		1439
1049	=item $window_width = $term->width	1440	=item $window_width = $term->width
1050		1441
1051	=item $window_height = $term->height	1442	=item $window_height = $term->height
1052		1443
1053	=item $font_width = $term->fwidth	1444	=item $font_width = $term->fwidth
…		…
1066		1457
1067	=item $max_scrollback = $term->saveLines	1458	=item $max_scrollback = $term->saveLines
1068		1459
1069	=item $nrow_plus_saveLines = $term->total_rows	1460	=item $nrow_plus_saveLines = $term->total_rows
1070		1461
1071	=item $lines_in_scrollback = $term->nsaved	1462	=item $topmost_scrollback_row = $term->top_row
1072		1463
1073	Return various integers describing terminal characteristics.	1464	Return various integers describing terminal characteristics.
1074		1465
1075	=item $x_display = $term->display_id	1466	=item $x_display = $term->display_id
1076		1467
…		…
1083	=item $env = $term->env	1474	=item $env = $term->env
1084		1475
1085	Returns a copy of the environment in effect for the terminal as a hashref	1476	Returns a copy of the environment in effect for the terminal as a hashref
1086	similar to C<\%ENV>.	1477	similar to C<\%ENV>.
1087		1478
		1479	=item @envv = $term->envv
		1480
		1481	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1482
		1483	=item @argv = $term->argv
		1484
		1485	Return the argument vector as this terminal, similar to @ARGV, but
		1486	includes the program name as first element.
		1487
1088	=cut	1488	=cut
1089		1489
1090	sub env {	1490	sub env {
1091	if (my $env = $_[0]->_env) {
1092	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1491	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1093	} else {
1094	+{ %ENV }
1095	}
1096	}	1492	}
1097		1493
1098	=item $modifiermask = $term->ModLevel3Mask	1494	=item $modifiermask = $term->ModLevel3Mask
1099		1495
1100	=item $modifiermask = $term->ModMetaMask	1496	=item $modifiermask = $term->ModMetaMask
…		…
1102	=item $modifiermask = $term->ModNumLockMask	1498	=item $modifiermask = $term->ModNumLockMask
1103		1499
1104	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1500	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1105	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1501	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1106		1502
		1503	=item $screen = $term->current_screen
		1504
		1505	Returns the currently displayed screen (0 primary, 1 secondary).
		1506
		1507	=item $cursor_is_hidden = $term->hidden_cursor
		1508
		1509	Returns wether the cursor is currently hidden or not.
		1510
1107	=item $view_start = $term->view_start ([$newvalue])	1511	=item $view_start = $term->view_start ([$newvalue])
1108		1512
1109	Returns the negative row number of the topmost line. Minimum value is	1513	Returns the row number of the topmost displayed line. Maximum value is
1110	C<0>, which displays the normal terminal contents. Larger values scroll	1514	C<0>, which displays the normal terminal contents. Lower values scroll
1111	this many lines into the scrollback buffer.	1515	this many lines into the scrollback buffer.
1112		1516
1113	=item $term->want_refresh	1517	=item $term->want_refresh
1114		1518
1115	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1519	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1130	line, starting at column C<$start_col> (default C<0>), which is useful	1534	line, starting at column C<$start_col> (default C<0>), which is useful
1131	to replace only parts of a line. The font index in the rendition will	1535	to replace only parts of a line. The font index in the rendition will
1132	automatically be updated.	1536	automatically be updated.
1133		1537
1134	C<$text> is in a special encoding: tabs and wide characters that use more	1538	C<$text> is in a special encoding: tabs and wide characters that use more
1135	than one cell when displayed are padded with urxvt::NOCHAR characters	1539	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1136	(C<chr 65535>). Characters with combining characters and other characters	1540	characters. Characters with combining characters and other characters that
1137	that do not fit into the normal tetx encoding will be replaced with	1541	do not fit into the normal tetx encoding will be replaced with characters
1138	characters in the private use area.	1542	in the private use area.
1139		1543
1140	You have to obey this encoding when changing text. The advantage is	1544	You have to obey this encoding when changing text. The advantage is
1141	that C<substr> and similar functions work on screen cells and not on	1545	that C<substr> and similar functions work on screen cells and not on
1142	characters.	1546	characters.
1143		1547
…		…
1194	Return the row number of the first/last row of the line, respectively.	1598	Return the row number of the first/last row of the line, respectively.
1195		1599
1196	=item $offset = $line->offset_of ($row, $col)	1600	=item $offset = $line->offset_of ($row, $col)
1197		1601
1198	Returns the character offset of the given row\|col pair within the logical	1602	Returns the character offset of the given row\|col pair within the logical
1199	line.	1603	line. Works for rows outside the line, too, and returns corresponding
		1604	offsets outside the string.
1200		1605
1201	=item ($row, $col) = $line->coord_of ($offset)	1606	=item ($row, $col) = $line->coord_of ($offset)
1202		1607
1203	Translates a string offset into terminal coordinates again.	1608	Translates a string offset into terminal coordinates again.
1204		1609
…		…
1289	=item $string = $term->special_decode $text	1694	=item $string = $term->special_decode $text
1290		1695
1291	Converts rxvt-unicodes text reprsentation into a perl string. See	1696	Converts rxvt-unicodes text reprsentation into a perl string. See
1292	C<< $term->ROW_t >> for details.	1697	C<< $term->ROW_t >> for details.
1293		1698
1294	=item $success = $term->grab_button ($button, $modifiermask)	1699	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1295		1700
		1701	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1702
1296	Registers a synchronous button grab. See the XGrabButton manpage.	1703	Register/unregister a synchronous button grab. See the XGrabButton
		1704	manpage.
1297		1705
1298	=item $success = $term->grab ($eventtime[, $sync])	1706	=item $success = $term->grab ($eventtime[, $sync])
1299		1707
1300	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1708	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1301	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1709	synchronous (C<$sync> is true). Also remembers the grab timestampe.
…		…
1316	=item $term->ungrab	1724	=item $term->ungrab
1317		1725
1318	Calls XUngrab for the most recent grab. Is called automatically on	1726	Calls XUngrab for the most recent grab. Is called automatically on
1319	evaluation errors, as it is better to lose the grab in the error case as	1727	evaluation errors, as it is better to lose the grab in the error case as
1320	the session.	1728	the session.
		1729
		1730	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1731
		1732	=item $atom_name = $term->XGetAtomName ($atom)
		1733
		1734	=item @atoms = $term->XListProperties ($window)
		1735
		1736	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1737
		1738	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1739
		1740	=item $term->XDeleteProperty ($window, $property)
		1741
		1742	=item $window = $term->DefaultRootWindow
		1743
		1744	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1745
		1746	=item $term->XMapWindow ($window)
		1747
		1748	=item $term->XUnmapWindow ($window)
		1749
		1750	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1751
		1752	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1753
		1754	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1755
		1756	Various X or X-related functions. The C<$term> object only serves as
		1757	the source of the display, otherwise those functions map more-or-less
		1758	directory onto the X functions of the same name.
1321		1759
1322	=back	1760	=back
1323		1761
1324	=cut	1762	=cut
1325		1763
…		…
1389	my ($self, $text, $cb) = @_;	1827	my ($self, $text, $cb) = @_;
1390		1828
1391	$self->add_item ({ type => "button", text => $text, activate => $cb});	1829	$self->add_item ({ type => "button", text => $text, activate => $cb});
1392	}	1830	}
1393		1831
1394	=item $popup->add_toggle ($text, $cb, $initial_value)	1832	=item $popup->add_toggle ($text, $initial_value, $cb)
1395		1833
1396	Adds a toggle/checkbox item to the popup. Teh callback gets called	1834	Adds a toggle/checkbox item to the popup. The callback gets called
1397	whenever it gets toggled, with a boolean indicating its value as its first	1835	whenever it gets toggled, with a boolean indicating its new value as its
1398	argument.	1836	first argument.
1399		1837
1400	=cut	1838	=cut
1401		1839
1402	sub add_toggle {	1840	sub add_toggle {
1403	my ($self, $text, $cb, $value) = @_;	1841	my ($self, $text, $value, $cb) = @_;
1404		1842
1405	my $item; $item = {	1843	my $item; $item = {
1406	type => "button",	1844	type => "button",
1407	text => " $text",	1845	text => " $text",
1408	value => $value,	1846	value => $value,
…		…
1427	my $env = $self->{term}->env;	1865	my $env = $self->{term}->env;
1428	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1866	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1429	delete $env->{LC_ALL};	1867	delete $env->{LC_ALL};
1430	$env->{LC_CTYPE} = $self->{term}->locale;	1868	$env->{LC_CTYPE} = $self->{term}->locale;
1431		1869
1432	urxvt::term->new ($env, $self->{term}->resource ("name"),	1870	urxvt::term->new ($env, "popup",
1433	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1871	"--perl-lib" => "", "--perl-ext-common" => "",
		1872	"-pty-fd" => -1, "-sl" => 0,
		1873	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1434	"--transient-for" => $self->{term}->parent,	1874	"--transient-for" => $self->{term}->parent,
1435	"-display" => $self->{term}->display_id,	1875	"-display" => $self->{term}->display_id,
1436	"-pe" => "urxvt-popup")	1876	"-pe" => "urxvt-popup")
1437	or die "unable to create popup window\n";	1877	or die "unable to create popup window\n";
1438	}	1878	}
…		…
1441	my ($self) = @_;	1881	my ($self) = @_;
1442		1882
1443	delete $self->{term}{_destroy}{$self};	1883	delete $self->{term}{_destroy}{$self};
1444	$self->{term}->ungrab;	1884	$self->{term}->ungrab;
1445	}	1885	}
		1886
		1887	=back
		1888
		1889	=cut
		1890
		1891	package urxvt::watcher;
		1892
		1893	@urxvt::timer::ISA = __PACKAGE__;
		1894	@urxvt::iow::ISA = __PACKAGE__;
		1895	@urxvt::pw::ISA = __PACKAGE__;
		1896	@urxvt::iw::ISA = __PACKAGE__;
1446		1897
1447	=head2 The C<urxvt::timer> Class	1898	=head2 The C<urxvt::timer> Class
1448		1899
1449	This class implements timer watchers/events. Time is represented as a	1900	This class implements timer watchers/events. Time is represented as a
1450	fractional number of seconds since the epoch. Example:	1901	fractional number of seconds since the epoch. Example:
…		…
1488	Start the timer.	1939	Start the timer.
1489		1940
1490	=item $timer = $timer->start ($tstamp)	1941	=item $timer = $timer->start ($tstamp)
1491		1942
1492	Set the event trigger time to C<$tstamp> and start the timer.	1943	Set the event trigger time to C<$tstamp> and start the timer.
		1944
		1945	=item $timer = $timer->after ($delay)
		1946
		1947	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1493		1948
1494	=item $timer = $timer->stop	1949	=item $timer = $timer->stop
1495		1950
1496	Stop the timer.	1951	Stop the timer.
1497		1952
…		…
1544		1999
1545	Stop watching for events on the given filehandle.	2000	Stop watching for events on the given filehandle.
1546		2001
1547	=back	2002	=back
1548		2003
		2004	=head2 The C<urxvt::iw> Class
		2005
		2006	This class implements idle watchers, that get called automatically when
		2007	the process is idle. They should return as fast as possible, after doing
		2008	some useful work.
		2009
		2010	=over 4
		2011
		2012	=item $iw = new urxvt::iw
		2013
		2014	Create a new idle watcher object in stopped state.
		2015
		2016	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2017
		2018	Set the callback to be called when the watcher triggers.
		2019
		2020	=item $timer = $timer->start
		2021
		2022	Start the watcher.
		2023
		2024	=item $timer = $timer->stop
		2025
		2026	Stop the watcher.
		2027
		2028	=back
		2029
		2030	=head2 The C<urxvt::pw> Class
		2031
		2032	This class implements process watchers. They create an event whenever a
		2033	process exits, after which they stop automatically.
		2034
		2035	my $pid = fork;
		2036	...
		2037	$term->{pw} = urxvt::pw
		2038	->new
		2039	->start ($pid)
		2040	->cb (sub {
		2041	my ($pw, $exit_status) = @_;
		2042	...
		2043	});
		2044
		2045	=over 4
		2046
		2047	=item $pw = new urxvt::pw
		2048
		2049	Create a new process watcher in stopped state.
		2050
		2051	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2052
		2053	Set the callback to be called when the timer triggers.
		2054
		2055	=item $pw = $timer->start ($pid)
		2056
		2057	Tells the wqtcher to start watching for process C<$pid>.
		2058
		2059	=item $pw = $pw->stop
		2060
		2061	Stop the watcher.
		2062
		2063	=back
		2064
1549	=head1 ENVIRONMENT	2065	=head1 ENVIRONMENT
1550		2066
1551	=head2 URXVT_PERL_VERBOSITY	2067	=head2 URXVT_PERL_VERBOSITY
1552		2068
1553	This variable controls the verbosity level of the perl extension. Higher	2069	This variable controls the verbosity level of the perl extension. Higher
…		…
1557		2073
1558	=item == 0 - fatal messages	2074	=item == 0 - fatal messages
1559		2075
1560	=item >= 3 - script loading and management	2076	=item >= 3 - script loading and management
1561		2077
1562	=item >=10 - all events received	2078	=item >=10 - all called hooks
		2079
		2080	=item >=11 - hook reutrn values
1563		2081
1564	=back	2082	=back
1565		2083
1566	=head1 AUTHOR	2084	=head1 AUTHOR
1567		2085

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.77 by root, Wed Jan 11 00:59:58 2006 UTC vs. Revision 1.136 by root, Mon Feb 20 20:44:22 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.77 by root, Wed Jan 11 00:59:58 2006 UTC vs.
Revision 1.136 by root, Mon Feb 20 20:44:22 2006 UTC