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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.78 by root, Wed Jan 11 01:01:52 2006 UTC vs.
Revision 1.137 by root, Sat Mar 4 20:17:52 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
…		…
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
…		…
248		493
249	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	494	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
250	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	495	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
251	number of lines that will be in the scrollback buffer.	496	number of lines that will be in the scrollback buffer.
252		497
		498	=item on_osc_seq $term, $op, $args
		499
		500	Called on every OSC sequence and can be used to suppress it or modify its
		501	behaviour. The default should be to return an empty list. A true value
		502	suppresses execution of the request completely. Make sure you don't get
		503	confused by recursive invocations when you output an osc sequence within
		504	this callback.
		505
		506	C<on_osc_seq_perl> should be used for new behaviour.
		507
253	=item on_osc_seq $term, $string	508	=item on_osc_seq_perl $term, $string
254		509
255	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	510	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
256	operating system command) is processed. Cursor position and other state	511	operating system command) is processed. Cursor position and other state
257	information is up-to-date when this happens. For interoperability, the	512	information is up-to-date when this happens. For interoperability, the
258	string should start with the extension name and a colon, to distinguish	513	string should start with the extension name and a colon, to distinguish
…		…
299		554
300	=item on_refresh_end $term	555	=item on_refresh_end $term
301		556
302	Called just after the screen gets redrawn. See C<on_refresh_begin>.	557	Called just after the screen gets redrawn. See C<on_refresh_begin>.
303		558
304	=item on_keyboard_command $term, $string	559	=item on_user_command $term, $string
305		560
306	Called whenever the user presses a key combination that has a	561	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>	562	a C<perl:string> action bound to a key, see description of the B<keysym>
308	resource in the @@RXVT_NAME@@(1) manpage).	563	resource in the @@RXVT_NAME@@(1) manpage).
		564
		565	The event is simply the action string. This interface is assumed to change
		566	slightly in the future.
		567
		568	=item on_resize_all_windows $tern, $new_width, $new_height
		569
		570	Called just after the new window size has been calculcated, but before
		571	windows are actually being resized or hints are being set. If this hook
		572	returns TRUE, setting of the window hints is being skipped.
		573
		574	=item on_x_event $term, $event
		575
		576	Called on every X event received on the vt window (and possibly other
		577	windows). Should only be used as a last resort. Most event structure
		578	members are not passed.
309		579
310	=item on_focus_in $term	580	=item on_focus_in $term
311		581
312	Called whenever the window gets the keyboard focus, before rxvt-unicode	582	Called whenever the window gets the keyboard focus, before rxvt-unicode
313	does focus in processing.	583	does focus in processing.
…		…
315	=item on_focus_out $term	585	=item on_focus_out $term
316		586
317	Called wheneever the window loses keyboard focus, before rxvt-unicode does	587	Called wheneever the window loses keyboard focus, before rxvt-unicode does
318	focus out processing.	588	focus out processing.
319		589
		590	=item on_configure_notify $term, $event
		591
		592	=item on_property_notify $term, $event
		593
320	=item on_key_press $term, $event, $keysym, $octets	594	=item on_key_press $term, $event, $keysym, $octets
321		595
322	=item on_key_release $term, $event, $keysym	596	=item on_key_release $term, $event, $keysym
323		597
324	=item on_button_press $term, $event	598	=item on_button_press $term, $event
…		…
333		607
334	Called whenever the corresponding X event is received for the terminal If	608	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.	609	the hook returns true, then the even will be ignored by rxvt-unicode.
336		610
337	The event is a hash with most values as named by Xlib (see the XEvent	611	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	612	manpage), with the additional members C<row> and C<col>, which are the
339	and column under the mouse cursor.	613	(real, not screen-based) row and column under the mouse cursor.
340		614
341	C<on_key_press> additionally receives the string rxvt-unicode would	615	C<on_key_press> additionally receives the string rxvt-unicode would
342	output, if any, in locale-specific encoding.	616	output, if any, in locale-specific encoding.
343		617
344	subwindow.	618	subwindow.
		619
		620	=item on_client_message $term, $event
		621
		622	=item on_wm_protocols $term, $event
		623
		624	=item on_wm_delete_window $term, $event
		625
		626	Called when various types of ClientMessage events are received (all with
		627	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
345		628
346	=back	629	=back
347		630
348	=cut	631	=cut
349		632
…		…
355	use Scalar::Util ();	638	use Scalar::Util ();
356	use List::Util ();	639	use List::Util ();
357		640
358	our $VERSION = 1;	641	our $VERSION = 1;
359	our $TERM;	642	our $TERM;
		643	our @TERM_INIT;
		644	our @TERM_EXT;
360	our @HOOKNAME;	645	our @HOOKNAME;
361	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	646	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
362	our %OPTION;	647	our %OPTION;
363		648
364	our $LIBDIR;	649	our $LIBDIR;
365	our $RESNAME;	650	our $RESNAME;
366	our $RESCLASS;	651	our $RESCLASS;
367	our $RXVTNAME;	652	our $RXVTNAME;
368		653
		654	our $NOCHAR = chr 0xffff;
		655
369	=head2 Variables in the C<urxvt> Package	656	=head2 Variables in the C<urxvt> Package
370		657
371	=over 4	658	=over 4
372		659
373	=item $urxvt::LIBDIR	660	=item $urxvt::LIBDIR
…		…
385		672
386	=item $urxvt::TERM	673	=item $urxvt::TERM
387		674
388	The current terminal. This variable stores the current C<urxvt::term>	675	The current terminal. This variable stores the current C<urxvt::term>
389	object, whenever a callback/hook is executing.	676	object, whenever a callback/hook is executing.
		677
		678	=item @urxvt::TERM_INIT
		679
		680	All coderefs in this array will be called as methods of the next newly
		681	created C<urxvt::term> object (during the C<on_init> phase). The array
		682	gets cleared before the codereferences that were in it are being executed,
		683	so coderefs can push themselves onto it again if they so desire.
		684
		685	This complements to the perl-eval commandline option, but gets executed
		686	first.
		687
		688	=item @urxvt::TERM_EXT
		689
		690	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		691	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		692	but before other extensions. Gets cleared just like C<@TERM_INIT>.
390		693
391	=back	694	=back
392		695
393	=head2 Functions in the C<urxvt> Package	696	=head2 Functions in the C<urxvt> Package
394		697
…		…
409	Using this function has the advantage that its output ends up in the	712	Using this function has the advantage that its output ends up in the
410	correct place, e.g. on stderr of the connecting urxvtc client.	713	correct place, e.g. on stderr of the connecting urxvtc client.
411		714
412	Messages have a size limit of 1023 bytes currently.	715	Messages have a size limit of 1023 bytes currently.
413		716
414	=item $is_safe = urxvt::safe	717	=item @terms = urxvt::termlist
415		718
416	Returns true when it is safe to do potentially unsafe things, such as	719	Returns all urxvt::term objects that exist in this process, regardless of
417	evaluating perl code specified by the user. This is true when urxvt was	720	wether they are started, being destroyed etc., so be careful. Only term
418	started setuid or setgid.	721	objects that have perl extensions attached will be returned (because there
		722	is no urxvt::term objet associated with others).
419		723
420	=item $time = urxvt::NOW	724	=item $time = urxvt::NOW
421		725
422	Returns the "current time" (as per the event loop).	726	Returns the "current time" (as per the event loop).
423		727
424	=item urxvt::CurrentTime	728	=item urxvt::CurrentTime
425		729
426	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	730	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
427	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	731	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
428	Button4Mask, Button5Mask, AnyModifier	732	Button4Mask, Button5Mask, AnyModifier
		733
		734	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		735	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		736	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		737	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		738	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		739	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		740	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		741
		742	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		743	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		744	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		745	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		746	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		747	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		748	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
429		749
430	Various constants for use in X calls and event processing.	750	Various constants for use in X calls and event processing.
431		751
432	=back	752	=back
433		753
…		…
466		786
467	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	787	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
468		788
469	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	789	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
470		790
		791	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		792
471	Replace the foreground/background colour in the rendition mask with the	793	Replace the foreground/background colour in the rendition mask with the
472	specified one.	794	specified one.
473		795
474	=item $value = urxvt::GET_CUSTOM $rend	796	=item $value = urxvt::GET_CUSTOM $rend
475		797
…		…
484	=back	806	=back
485		807
486	=cut	808	=cut
487		809
488	BEGIN {	810	BEGIN {
489	urxvt->bootstrap;
490
491	# overwrite perl's warn	811	# overwrite perl's warn
492	*CORE::GLOBAL::warn = sub {	812	*CORE::GLOBAL::warn = sub {
493	my $msg = join "", @_;	813	my $msg = join "", @_;
494	$msg .= "\n"	814	$msg .= "\n"
495	unless $msg =~ /\n$/;	815	unless $msg =~ /\n$/;
496	urxvt::warn ($msg);	816	urxvt::warn ($msg);
497	};	817	};
498
499	delete $ENV{IFS};
500	delete $ENV{CDPATH};
501	delete $ENV{BASH_ENV};
502	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
503	}	818	}
504		819
505	my @hook_count;	820	no warnings 'utf8';
		821
506	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	822	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
507		823
508	sub verbose {	824	sub verbose {
509	my ($level, $msg) = @_;	825	my ($level, $msg) = @_;
510	warn "$msg\n" if $level <= $verbosity;	826	warn "$msg\n" if $level <= $verbosity;
511	}	827	}
512		828
513	my $extension_pkg = "extension0000";
514	my %extension_pkg;	829	my %extension_pkg;
515		830
516	# load a single script into its own package, once only	831	# load a single script into its own package, once only
517	sub extension_package($) {	832	sub extension_package($) {
518	my ($path) = @_;	833	my ($path) = @_;
519		834
520	$extension_pkg{$path} \|\|= do {	835	$extension_pkg{$path} \|\|= do {
521	my $pkg = "urxvt::" . ($extension_pkg++);	836	$path =~ /([^\/\\]+)$/;
		837	my $pkg = $1;
		838	$pkg =~ s/[^[:word:]]/_/g;
		839	$pkg = "urxvt::ext::$pkg";
522		840
523	verbose 3, "loading extension '$path' into package '$pkg'";	841	verbose 3, "loading extension '$path' into package '$pkg'";
524		842
525	open my $fh, "<:raw", $path	843	open my $fh, "<:raw", $path
526	or die "$path: $!";	844	or die "$path: $!";
527		845
528	my $source = untaint	846	my $source =
529	"package $pkg; use strict; use utf8;\n"	847	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
530	. "use base urxvt::term::extension::;\n"
531	. "#line 1 \"$path\"\n{\n"	848	. "#line 1 \"$path\"\n{\n"
532	. (do { local $/; <$fh> })	849	. (do { local $/; <$fh> })
533	. "\n};\n1";	850	. "\n};\n1";
534		851
535	eval $source	852	eval $source
…		…
549	if ($htype == 0) { # INIT	866	if ($htype == 0) { # INIT
550	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	867	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
551		868
552	my %ext_arg;	869	my %ext_arg;
553		870
		871	{
		872	my @init = @TERM_INIT;
		873	@TERM_INIT = ();
		874	$_->($TERM) for @init;
		875	my @pkg = @TERM_EXT;
		876	@TERM_EXT = ();
		877	$TERM->register_package ($_) for @pkg;
		878	}
		879
554	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	880	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
555	if ($_ eq "default") {	881	if ($_ eq "default") {
556	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	882	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
557	} elsif (/^-(.*)$/) {	883	} elsif (/^-(.*)$/) {
558	delete $ext_arg{$1};	884	delete $ext_arg{$1};
559	} elsif (/^([^<]+)<(.*)>$/) {	885	} elsif (/^([^<]+)<(.*)>$/) {
560	push @{ $ext_arg{$1} }, $2;	886	push @{ $ext_arg{$1} }, $2;
561	} else {	887	} else {
562	$ext_arg{$_} \|\|= [];	888	$ext_arg{$_} \|\|= [];
563	}	889	}
564	}	890	}
565		891
566	while (my ($ext, $argv) = each %ext_arg) {	892	for my $ext (sort keys %ext_arg) {
567	my @files = grep -f $_, map "$_/$ext", @dirs;	893	my @files = grep -f $_, map "$_/$ext", @dirs;
568		894
569	if (@files) {	895	if (@files) {
570	$TERM->register_package (extension_package $files[0], $argv);	896	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
571	} else {	897	} else {
572	warn "perl extension '$ext' not found in perl library search path\n";	898	warn "perl extension '$ext' not found in perl library search path\n";
573	}	899	}
574	}	900	}
575		901
…		…
584	if $verbosity >= 10;	910	if $verbosity >= 10;
585		911
586	keys %$cb;	912	keys %$cb;
587		913
588	while (my ($pkg, $cb) = each %$cb) {	914	while (my ($pkg, $cb) = each %$cb) {
589	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	915	my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
590	and last;	916	$retval \|\|= $retval_;
591		917
592	if ($@) {	918	if ($@) {
593	$TERM->ungrab; # better to lose the grab than the session	919	$TERM->ungrab; # better to lose the grab than the session
594	warn $@;	920	warn $@;
595	}	921	}
596	}	922	}
		923
		924	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		925	if $verbosity >= 11;
597	}	926	}
598		927
599	if ($htype == 1) { # DESTROY	928	if ($htype == 1) { # DESTROY
600	if (my $hook = delete $TERM->{_hook}) {
601	for my $htype (0..$#$hook) {
602	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
603	or set_should_invoke $htype, 0;
604	}
605	}
606
607	# clear package objects	929	# clear package objects
608	%$_ = () for values %{ $TERM->{_pkg} };	930	%$_ = () for values %{ $TERM->{_pkg} };
609		931
610	# clear package	932	# clear package
611	%$TERM = ();	933	%$TERM = ();
612	}	934	}
613		935
614	$retval	936	$retval
		937	}
		938
		939	sub SET_COLOR($$$) {
		940	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
615	}	941	}
616		942
617	# urxvt::term::extension	943	# urxvt::term::extension
618		944
619	package urxvt::term::extension;	945	package urxvt::term::extension;
…		…
625	while (my ($name, $cb) = each %hook) {	951	while (my ($name, $cb) = each %hook) {
626	my $htype = $HOOKTYPE{uc $name};	952	my $htype = $HOOKTYPE{uc $name};
627	defined $htype	953	defined $htype
628	or Carp::croak "unsupported hook type '$name'";	954	or Carp::croak "unsupported hook type '$name'";
629		955
		956	$self->set_should_invoke ($htype, +1)
630	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	957	unless exists $self->{term}{_hook}[$htype]{$pkg};
631	$hook_count[$htype]++
632	or urxvt::set_should_invoke $htype, 1;
633	}
634		958
635	$self->{term}{_hook}[$htype]{$pkg} = $cb;	959	$self->{term}{_hook}[$htype]{$pkg} = $cb;
636	}	960	}
637	}	961	}
638		962
…		…
643	for my $name (@hook) {	967	for my $name (@hook) {
644	my $htype = $HOOKTYPE{uc $name};	968	my $htype = $HOOKTYPE{uc $name};
645	defined $htype	969	defined $htype
646	or Carp::croak "unsupported hook type '$name'";	970	or Carp::croak "unsupported hook type '$name'";
647		971
		972	$self->set_should_invoke ($htype, -1)
648	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	973	if delete $self->{term}{_hook}[$htype]{$pkg};
649	--$hook_count[$htype]
650	or urxvt::set_should_invoke $htype, 0;
651	}
652	}	974	}
653	}	975	}
654		976
655	our $AUTOLOAD;	977	our $AUTOLOAD;
656		978
…		…
762	# find on_xxx subs in the package and register them	1084	# find on_xxx subs in the package and register them
763	# as hooks	1085	# as hooks
764	sub register_package {	1086	sub register_package {
765	my ($self, $pkg, $argv) = @_;	1087	my ($self, $pkg, $argv) = @_;
766		1088
		1089	no strict 'refs';
		1090
		1091	urxvt::verbose 6, "register package $pkg to $self";
		1092
		1093	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1094
767	my $proxy = bless {	1095	my $proxy = bless {
768	_pkg => $pkg,	1096	_pkg => $pkg,
769	argv => $argv,	1097	argv => $argv,
770	}, $pkg;	1098	}, $pkg;
771	Scalar::Util::weaken ($proxy->{term} = $self);	1099	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
786	hash which defines the environment of the new terminal.	1114	hash which defines the environment of the new terminal.
787		1115
788	Croaks (and probably outputs an error message) if the new instance	1116	Croaks (and probably outputs an error message) if the new instance
789	couldn't be created. Returns C<undef> if the new instance didn't	1117	couldn't be created. Returns C<undef> if the new instance didn't
790	initialise perl, and the terminal object otherwise. The C<init> and	1118	initialise perl, and the terminal object otherwise. The C<init> and
791	C<start> hooks will be called during this call.	1119	C<start> hooks will be called before this call returns, and are free to
		1120	refer to global data (which is race free).
792		1121
793	=cut	1122	=cut
794		1123
795	sub new {	1124	sub new {
796	my ($class, $env, @args) = @_;	1125	my ($class, $env, @args) = @_;
797		1126
		1127	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1128	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1129
798	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1130	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
799	}	1131	}
800		1132
801	=item $term->destroy	1133	=item $term->destroy
802		1134
803	Destroy the terminal object (close the window, free resources	1135	Destroy the terminal object (close the window, free resources
804	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1136	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
805	watchers (timers, io watchers) are still active.	1137	watchers (timers, io watchers) are still active.
806		1138
		1139	=item $term->exec_async ($cmd[, @args])
		1140
		1141	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1142	("starts") programs in the background. This function takes care of setting
		1143	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1144	be preferred over explicit calls to C<exec> or C<system>.
		1145
		1146	Returns the pid of the subprocess or C<undef> on error.
		1147
		1148	=cut
		1149
		1150	sub exec_async {
		1151	my $self = shift;
		1152
		1153	my $pid = fork;
		1154
		1155	return $pid
		1156	if !defined $pid or $pid;
		1157
		1158	%ENV = %{ $self->env };
		1159
		1160	exec @_;
		1161	urxvt::_exit 255;
		1162	}
		1163
807	=item $isset = $term->option ($optval[, $set])	1164	=item $isset = $term->option ($optval[, $set])
808		1165
809	Returns true if the option specified by C<$optval> is enabled, and	1166	Returns true if the option specified by C<$optval> is enabled, and
810	optionally change it. All option values are stored by name in the hash	1167	optionally change it. All option values are stored by name in the hash
811	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1168	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
813	Here is a a likely non-exhaustive list of option names, please see the	1170	Here is a a likely non-exhaustive list of option names, please see the
814	source file F</src/optinc.h> to see the actual list:	1171	source file F</src/optinc.h> to see the actual list:
815		1172
816	borderLess console cursorBlink cursorUnderline hold iconic insecure	1173	borderLess console cursorBlink cursorUnderline hold iconic insecure
817	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1174	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
818	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1175	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
819	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1176	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
820	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1177	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
821	tripleclickwords utmpInhibit visualBell	1178	transparent tripleclickwords utmpInhibit visualBell
822		1179
823	=item $value = $term->resource ($name[, $newval])	1180	=item $value = $term->resource ($name[, $newval])
824		1181
825	Returns the current resource value associated with a given name and	1182	Returns the current resource value associated with a given name and
826	optionally sets a new value. Setting values is most useful in the C<init>	1183	optionally sets a new value. Setting values is most useful in the C<init>
…		…
843		1200
844	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1201	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
845	borderLess color cursorBlink cursorUnderline cutchars delete_key	1202	borderLess color cursorBlink cursorUnderline cutchars delete_key
846	display_name embed ext_bwidth fade font geometry hold iconName	1203	display_name embed ext_bwidth fade font geometry hold iconName
847	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1204	imFont imLocale inputMethod insecure int_bwidth intensityStyles
848	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1205	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
849	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1206	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
850	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1207	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
851	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1208	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
852	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1209	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
853	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1210	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
854	shade term_name title transparent transparent_all tripleclickwords	1211	secondaryScreen secondaryScroll selectstyle shade term_name title
855	utmpInhibit visualBell	1212	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1213	visualBell
856		1214
857	=cut	1215	=cut
858		1216
859	sub resource($$;$) {	1217	sub resource($$;$) {
860	my ($self, $name) = (shift, shift);	1218	my ($self, $name) = (shift, shift);
861	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1219	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
862	&urxvt::term::_resource	1220	&urxvt::term::_resource
863	}	1221	}
864		1222
		1223	=item $value = $term->x_resource ($pattern)
		1224
		1225	Returns the X-Resource for the given pattern, excluding the program or
		1226	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1227	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1228	resource with that pattern exists.
		1229
		1230	This method should only be called during the C<on_start> hook, as there is
		1231	only one resource database per display, and later invocations might return
		1232	the wrong resources.
		1233
865	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1234	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
866		1235
867	Adds a keymap translation exactly as specified via a resource. See the	1236	Adds a keymap translation exactly as specified via a resource. See the
868	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1237	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
869		1238
…		…
884	=item ($row, $col) = $term->selection_end ([$row, $col])	1253	=item ($row, $col) = $term->selection_end ([$row, $col])
885		1254
886	Return the current values of the selection mark, begin or end positions,	1255	Return the current values of the selection mark, begin or end positions,
887	and optionally set them to new values.	1256	and optionally set them to new values.
888		1257
		1258	=item $term->selection_make ($eventtime[, $rectangular])
		1259
		1260	Tries to make a selection as set by C<selection_beg> and
		1261	C<selection_end>. If C<$rectangular> is true (default: false), a
		1262	rectangular selection will be made. This is the prefered function to make
		1263	a selection.
		1264
889	=item $success = $term->selection_grab ($eventtime)	1265	=item $success = $term->selection_grab ($eventtime)
890		1266
891	Try to request the primary selection from the server (for example, as set	1267	Try to request the primary selection text from the server (for example, as
892	by the next method).	1268	set by the next method). No visual feedback will be given. This function
		1269	is mostly useful from within C<on_sel_grab> hooks.
893		1270
894	=item $oldtext = $term->selection ([$newtext])	1271	=item $oldtext = $term->selection ([$newtext])
895		1272
896	Return the current selection text and optionally replace it by C<$newtext>.	1273	Return the current selection text and optionally replace it by C<$newtext>.
897		1274
…		…
990	Convert the given locale-encoded octets into a perl string.	1367	Convert the given locale-encoded octets into a perl string.
991		1368
992	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1369	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
993		1370
994	XORs the rendition values in the given span with the provided value	1371	XORs the rendition values in the given span with the provided value
995	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1372	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
996	to the selection.	1373	refresh hooks to provide effects similar to the selection.
997		1374
998	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1375	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
999		1376
1000	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1377	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1001	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1378	whitespace will additionally be xored with the C<$rstyle2>, which defaults
1002	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines	1379	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
1003	it instead.	1380	it instead. Both styles I<MUST NOT> contain font styles.
1004		1381
1005	=item $term->scr_bell	1382	=item $term->scr_bell
1006		1383
1007	Ring the bell!	1384	Ring the bell!
1008		1385
…		…
1015		1392
1016	Normally its not a good idea to use this function, as programs might be	1393	Normally its not a good idea to use this function, as programs might be
1017	confused by changes in cursor position or scrolling. Its useful inside a	1394	confused by changes in cursor position or scrolling. Its useful inside a
1018	C<on_add_lines> hook, though.	1395	C<on_add_lines> hook, though.
1019		1396
		1397	=item $term->scr_change_screen ($screen)
		1398
		1399	Switch to given screen - 0 primary, 1 secondary.
		1400
1020	=item $term->cmd_parse ($octets)	1401	=item $term->cmd_parse ($octets)
1021		1402
1022	Similar to C<scr_add_lines>, but the argument must be in the	1403	Similar to C<scr_add_lines>, but the argument must be in the
1023	locale-specific encoding of the terminal and can contain command sequences	1404	locale-specific encoding of the terminal and can contain command sequences
1024	(escape codes) that will be interpreted.	1405	(escape codes) that will be interpreted.
…		…
1034	Replaces the event mask of the pty watcher by the given event mask. Can	1415	Replaces the event mask of the pty watcher by the given event mask. Can
1035	be used to suppress input and output handling to the pty/tty. See the	1416	be used to suppress input and output handling to the pty/tty. See the
1036	description of C<< urxvt::timer->events >>. Make sure to always restore	1417	description of C<< urxvt::timer->events >>. Make sure to always restore
1037	the previous value.	1418	the previous value.
1038		1419
		1420	=item $fd = $term->pty_fd
		1421
		1422	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1423	is used.
		1424
1039	=item $windowid = $term->parent	1425	=item $windowid = $term->parent
1040		1426
1041	Return the window id of the toplevel window.	1427	Return the window id of the toplevel window.
1042		1428
1043	=item $windowid = $term->vt	1429	=item $windowid = $term->vt
1044		1430
1045	Return the window id of the terminal window.	1431	Return the window id of the terminal window.
1046		1432
		1433	=item $term->vt_emask_add ($x_event_mask)
		1434
		1435	Adds the specified events to the vt event mask. Useful e.g. when you want
		1436	to receive pointer events all the times:
		1437
		1438	$term->vt_emask_add (urxvt::PointerMotionMask);
		1439
		1440	=item $term->focus_in
		1441
		1442	=item $term->focus_out
		1443
		1444	=item $term->key_press ($state, $keycode[, $time])
		1445
		1446	=item $term->key_release ($state, $keycode[, $time])
		1447
		1448	Deliver various fake events to to terminal.
		1449
1047	=item $window_width = $term->width	1450	=item $window_width = $term->width
1048		1451
1049	=item $window_height = $term->height	1452	=item $window_height = $term->height
1050		1453
1051	=item $font_width = $term->fwidth	1454	=item $font_width = $term->fwidth
…		…
1064		1467
1065	=item $max_scrollback = $term->saveLines	1468	=item $max_scrollback = $term->saveLines
1066		1469
1067	=item $nrow_plus_saveLines = $term->total_rows	1470	=item $nrow_plus_saveLines = $term->total_rows
1068		1471
1069	=item $lines_in_scrollback = $term->nsaved	1472	=item $topmost_scrollback_row = $term->top_row
1070		1473
1071	Return various integers describing terminal characteristics.	1474	Return various integers describing terminal characteristics.
1072		1475
1073	=item $x_display = $term->display_id	1476	=item $x_display = $term->display_id
1074		1477
…		…
1081	=item $env = $term->env	1484	=item $env = $term->env
1082		1485
1083	Returns a copy of the environment in effect for the terminal as a hashref	1486	Returns a copy of the environment in effect for the terminal as a hashref
1084	similar to C<\%ENV>.	1487	similar to C<\%ENV>.
1085		1488
		1489	=item @envv = $term->envv
		1490
		1491	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1492
		1493	=item @argv = $term->argv
		1494
		1495	Return the argument vector as this terminal, similar to @ARGV, but
		1496	includes the program name as first element.
		1497
1086	=cut	1498	=cut
1087		1499
1088	sub env {	1500	sub env {
1089	if (my $env = $_[0]->_env) {
1090	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1501	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1091	} else {
1092	+{ %ENV }
1093	}
1094	}	1502	}
1095		1503
1096	=item $modifiermask = $term->ModLevel3Mask	1504	=item $modifiermask = $term->ModLevel3Mask
1097		1505
1098	=item $modifiermask = $term->ModMetaMask	1506	=item $modifiermask = $term->ModMetaMask
…		…
1100	=item $modifiermask = $term->ModNumLockMask	1508	=item $modifiermask = $term->ModNumLockMask
1101		1509
1102	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1510	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1103	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1511	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1104		1512
		1513	=item $screen = $term->current_screen
		1514
		1515	Returns the currently displayed screen (0 primary, 1 secondary).
		1516
		1517	=item $cursor_is_hidden = $term->hidden_cursor
		1518
		1519	Returns wether the cursor is currently hidden or not.
		1520
1105	=item $view_start = $term->view_start ([$newvalue])	1521	=item $view_start = $term->view_start ([$newvalue])
1106		1522
1107	Returns the negative row number of the topmost line. Minimum value is	1523	Returns the row number of the topmost displayed line. Maximum value is
1108	C<0>, which displays the normal terminal contents. Larger values scroll	1524	C<0>, which displays the normal terminal contents. Lower values scroll
1109	this many lines into the scrollback buffer.	1525	this many lines into the scrollback buffer.
1110		1526
1111	=item $term->want_refresh	1527	=item $term->want_refresh
1112		1528
1113	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1529	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1128	line, starting at column C<$start_col> (default C<0>), which is useful	1544	line, starting at column C<$start_col> (default C<0>), which is useful
1129	to replace only parts of a line. The font index in the rendition will	1545	to replace only parts of a line. The font index in the rendition will
1130	automatically be updated.	1546	automatically be updated.
1131		1547
1132	C<$text> is in a special encoding: tabs and wide characters that use more	1548	C<$text> is in a special encoding: tabs and wide characters that use more
1133	than one cell when displayed are padded with urxvt::NOCHAR characters	1549	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1134	(C<chr 65535>). Characters with combining characters and other characters	1550	characters. Characters with combining characters and other characters that
1135	that do not fit into the normal tetx encoding will be replaced with	1551	do not fit into the normal tetx encoding will be replaced with characters
1136	characters in the private use area.	1552	in the private use area.
1137		1553
1138	You have to obey this encoding when changing text. The advantage is	1554	You have to obey this encoding when changing text. The advantage is
1139	that C<substr> and similar functions work on screen cells and not on	1555	that C<substr> and similar functions work on screen cells and not on
1140	characters.	1556	characters.
1141		1557
…		…
1192	Return the row number of the first/last row of the line, respectively.	1608	Return the row number of the first/last row of the line, respectively.
1193		1609
1194	=item $offset = $line->offset_of ($row, $col)	1610	=item $offset = $line->offset_of ($row, $col)
1195		1611
1196	Returns the character offset of the given row\|col pair within the logical	1612	Returns the character offset of the given row\|col pair within the logical
1197	line.	1613	line. Works for rows outside the line, too, and returns corresponding
		1614	offsets outside the string.
1198		1615
1199	=item ($row, $col) = $line->coord_of ($offset)	1616	=item ($row, $col) = $line->coord_of ($offset)
1200		1617
1201	Translates a string offset into terminal coordinates again.	1618	Translates a string offset into terminal coordinates again.
1202		1619
…		…
1287	=item $string = $term->special_decode $text	1704	=item $string = $term->special_decode $text
1288		1705
1289	Converts rxvt-unicodes text reprsentation into a perl string. See	1706	Converts rxvt-unicodes text reprsentation into a perl string. See
1290	C<< $term->ROW_t >> for details.	1707	C<< $term->ROW_t >> for details.
1291		1708
1292	=item $success = $term->grab_button ($button, $modifiermask)	1709	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1293		1710
		1711	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1712
1294	Registers a synchronous button grab. See the XGrabButton manpage.	1713	Register/unregister a synchronous button grab. See the XGrabButton
		1714	manpage.
1295		1715
1296	=item $success = $term->grab ($eventtime[, $sync])	1716	=item $success = $term->grab ($eventtime[, $sync])
1297		1717
1298	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1718	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1299	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1719	synchronous (C<$sync> is true). Also remembers the grab timestampe.
…		…
1314	=item $term->ungrab	1734	=item $term->ungrab
1315		1735
1316	Calls XUngrab for the most recent grab. Is called automatically on	1736	Calls XUngrab for the most recent grab. Is called automatically on
1317	evaluation errors, as it is better to lose the grab in the error case as	1737	evaluation errors, as it is better to lose the grab in the error case as
1318	the session.	1738	the session.
		1739
		1740	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1741
		1742	=item $atom_name = $term->XGetAtomName ($atom)
		1743
		1744	=item @atoms = $term->XListProperties ($window)
		1745
		1746	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1747
		1748	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1749
		1750	=item $term->XDeleteProperty ($window, $property)
		1751
		1752	=item $window = $term->DefaultRootWindow
		1753
		1754	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1755
		1756	=item $term->XMapWindow ($window)
		1757
		1758	=item $term->XUnmapWindow ($window)
		1759
		1760	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1761
		1762	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1763
		1764	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1765
		1766	Various X or X-related functions. The C<$term> object only serves as
		1767	the source of the display, otherwise those functions map more-or-less
		1768	directory onto the X functions of the same name.
1319		1769
1320	=back	1770	=back
1321		1771
1322	=cut	1772	=cut
1323		1773
…		…
1387	my ($self, $text, $cb) = @_;	1837	my ($self, $text, $cb) = @_;
1388		1838
1389	$self->add_item ({ type => "button", text => $text, activate => $cb});	1839	$self->add_item ({ type => "button", text => $text, activate => $cb});
1390	}	1840	}
1391		1841
1392	=item $popup->add_toggle ($text, $cb, $initial_value)	1842	=item $popup->add_toggle ($text, $initial_value, $cb)
1393		1843
1394	Adds a toggle/checkbox item to the popup. Teh callback gets called	1844	Adds a toggle/checkbox item to the popup. The callback gets called
1395	whenever it gets toggled, with a boolean indicating its value as its first	1845	whenever it gets toggled, with a boolean indicating its new value as its
1396	argument.	1846	first argument.
1397		1847
1398	=cut	1848	=cut
1399		1849
1400	sub add_toggle {	1850	sub add_toggle {
1401	my ($self, $text, $cb, $value) = @_;	1851	my ($self, $text, $value, $cb) = @_;
1402		1852
1403	my $item; $item = {	1853	my $item; $item = {
1404	type => "button",	1854	type => "button",
1405	text => " $text",	1855	text => " $text",
1406	value => $value,	1856	value => $value,
…		…
1425	my $env = $self->{term}->env;	1875	my $env = $self->{term}->env;
1426	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1876	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1427	delete $env->{LC_ALL};	1877	delete $env->{LC_ALL};
1428	$env->{LC_CTYPE} = $self->{term}->locale;	1878	$env->{LC_CTYPE} = $self->{term}->locale;
1429		1879
1430	urxvt::term->new ($env, $self->{term}->resource ("name"),	1880	urxvt::term->new ($env, "popup",
1431	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1881	"--perl-lib" => "", "--perl-ext-common" => "",
		1882	"-pty-fd" => -1, "-sl" => 0,
		1883	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1432	"--transient-for" => $self->{term}->parent,	1884	"--transient-for" => $self->{term}->parent,
1433	"-display" => $self->{term}->display_id,	1885	"-display" => $self->{term}->display_id,
1434	"-pe" => "urxvt-popup")	1886	"-pe" => "urxvt-popup")
1435	or die "unable to create popup window\n";	1887	or die "unable to create popup window\n";
1436	}	1888	}
…		…
1441	delete $self->{term}{_destroy}{$self};	1893	delete $self->{term}{_destroy}{$self};
1442	$self->{term}->ungrab;	1894	$self->{term}->ungrab;
1443	}	1895	}
1444		1896
1445	=back	1897	=back
		1898
		1899	=cut
		1900
		1901	package urxvt::watcher;
		1902
		1903	@urxvt::timer::ISA = __PACKAGE__;
		1904	@urxvt::iow::ISA = __PACKAGE__;
		1905	@urxvt::pw::ISA = __PACKAGE__;
		1906	@urxvt::iw::ISA = __PACKAGE__;
1446		1907
1447	=head2 The C<urxvt::timer> Class	1908	=head2 The C<urxvt::timer> Class
1448		1909
1449	This class implements timer watchers/events. Time is represented as a	1910	This class implements timer watchers/events. Time is represented as a
1450	fractional number of seconds since the epoch. Example:	1911	fractional number of seconds since the epoch. Example:
…		…
1488	Start the timer.	1949	Start the timer.
1489		1950
1490	=item $timer = $timer->start ($tstamp)	1951	=item $timer = $timer->start ($tstamp)
1491		1952
1492	Set the event trigger time to C<$tstamp> and start the timer.	1953	Set the event trigger time to C<$tstamp> and start the timer.
		1954
		1955	=item $timer = $timer->after ($delay)
		1956
		1957	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1493		1958
1494	=item $timer = $timer->stop	1959	=item $timer = $timer->stop
1495		1960
1496	Stop the timer.	1961	Stop the timer.
1497		1962
…		…
1544		2009
1545	Stop watching for events on the given filehandle.	2010	Stop watching for events on the given filehandle.
1546		2011
1547	=back	2012	=back
1548		2013
		2014	=head2 The C<urxvt::iw> Class
		2015
		2016	This class implements idle watchers, that get called automatically when
		2017	the process is idle. They should return as fast as possible, after doing
		2018	some useful work.
		2019
		2020	=over 4
		2021
		2022	=item $iw = new urxvt::iw
		2023
		2024	Create a new idle watcher object in stopped state.
		2025
		2026	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2027
		2028	Set the callback to be called when the watcher triggers.
		2029
		2030	=item $timer = $timer->start
		2031
		2032	Start the watcher.
		2033
		2034	=item $timer = $timer->stop
		2035
		2036	Stop the watcher.
		2037
		2038	=back
		2039
		2040	=head2 The C<urxvt::pw> Class
		2041
		2042	This class implements process watchers. They create an event whenever a
		2043	process exits, after which they stop automatically.
		2044
		2045	my $pid = fork;
		2046	...
		2047	$term->{pw} = urxvt::pw
		2048	->new
		2049	->start ($pid)
		2050	->cb (sub {
		2051	my ($pw, $exit_status) = @_;
		2052	...
		2053	});
		2054
		2055	=over 4
		2056
		2057	=item $pw = new urxvt::pw
		2058
		2059	Create a new process watcher in stopped state.
		2060
		2061	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2062
		2063	Set the callback to be called when the timer triggers.
		2064
		2065	=item $pw = $timer->start ($pid)
		2066
		2067	Tells the wqtcher to start watching for process C<$pid>.
		2068
		2069	=item $pw = $pw->stop
		2070
		2071	Stop the watcher.
		2072
		2073	=back
		2074
1549	=head1 ENVIRONMENT	2075	=head1 ENVIRONMENT
1550		2076
1551	=head2 URXVT_PERL_VERBOSITY	2077	=head2 URXVT_PERL_VERBOSITY
1552		2078
1553	This variable controls the verbosity level of the perl extension. Higher	2079	This variable controls the verbosity level of the perl extension. Higher
…		…
1557		2083
1558	=item == 0 - fatal messages	2084	=item == 0 - fatal messages
1559		2085
1560	=item >= 3 - script loading and management	2086	=item >= 3 - script loading and management
1561		2087
1562	=item >=10 - all events received	2088	=item >=10 - all called hooks
		2089
		2090	=item >=11 - hook reutrn values
1563		2091
1564	=back	2092	=back
1565		2093
1566	=head1 AUTHOR	2094	=head1 AUTHOR
1567		2095

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.78 by root, Wed Jan 11 01:01:52 2006 UTC vs. Revision 1.137 by root, Sat Mar 4 20:17:52 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.78 by root, Wed Jan 11 01:01:52 2006 UTC vs.
Revision 1.137 by root, Sat Mar 4 20:17:52 2006 UTC