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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.82 by root, Thu Jan 12 01:30:53 2006 UTC vs.
Revision 1.139 by root, Sat Jul 1 19:04:43 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 and	241	Uses per-line display filtering (C<on_line_update>) to underline urls and
90	make them clickable. When clicked, the program specified in the resource	242	make them clickable. When middle-clicked, the program specified in the
91	C<urlLauncher> (default C<x-www-browser>) will be started.	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
92		265
93	=item block-graphics-to-ascii	266	=item block-graphics-to-ascii
94		267
95	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,
96	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
97	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/%
98		324
99	=item example-refresh-hooks	325	=item example-refresh-hooks
100		326
101	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
102	window. Illustrates overwriting the refresh callbacks to create your own	328	window. Illustrates overwriting the refresh callbacks to create your own
…		…
142		368
143	=back	369	=back
144		370
145	=head2 Extension Objects	371	=head2 Extension Objects
146		372
147	Very perl extension is a perl class. A separate perl object is created	373	Every perl extension is a perl class. A separate perl object is created
148	for each terminal and each extension and passed as the first parameter to	374	for each terminal and each extension and passed as the first parameter to
149	hooks. So extensions can use their C<$self> object without having to think	375	hooks. So extensions can use their C<$self> object without having to think
150	about other extensions, with the exception of methods and members that	376	about other extensions, with the exception of methods and members that
151	begin with an underscore character C<_>: these are reserved for internal	377	begin with an underscore character C<_>: these are reserved for internal
152	use.	378	use.
…		…
181	called whenever the relevant event happens.	407	called whenever the relevant event happens.
182		408
183	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
184	the in the C<Extension Objects> section.	410	the in the C<Extension Objects> section.
185		411
186	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
187	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
188	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.
189		415
190	I<< When in doubt, return a false value (preferably C<()>). >>	416	I<< When in doubt, return a false value (preferably C<()>). >>
191		417
192	=over 4	418	=over 4
193		419
194	=item on_init $term	420	=item on_init $term
195		421
196	Called after a new terminal object has been initialized, but before	422	Called after a new terminal object has been initialized, but before
197	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
198	call or deliver senseless data, as terminal size and other characteristics	424	call or deliver senseless data, as terminal size and other characteristics
199	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
200	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).
201		438
202	=item on_reset $term	439	=item on_reset $term
203		440
204	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
205	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
206	variables.	443	variables.
207		444
208	=item on_start $term	445	=item on_child_start $term, $pid
209		446
210	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.
211	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>.
212		453
213	=item on_sel_make $term, $eventtime	454	=item on_sel_make $term, $eventtime
214		455
215	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
216	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
…		…
230	=item on_sel_extend $term	471	=item on_sel_extend $term
231		472
232	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
233	click) and is either supposed to return false (normal operation), or	474	click) and is either supposed to return false (normal operation), or
234	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
235	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.
236		479
237	See the F<selection> example extension.	480	See the F<selection> example extension.
238		481
239	=item on_view_change $term, $offset	482	=item on_view_change $term, $offset
240		483
…		…
250		493
251	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,
252	$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
253	number of lines that will be in the scrollback buffer.	496	number of lines that will be in the scrollback buffer.
254		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
255	=item on_osc_seq $term, $string	508	=item on_osc_seq_perl $term, $string
256		509
257	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	510	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
258	operating system command) is processed. Cursor position and other state	511	operating system command) is processed. Cursor position and other state
259	information is up-to-date when this happens. For interoperability, the	512	information is up-to-date when this happens. For interoperability, the
260	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
…		…
301		554
302	=item on_refresh_end $term	555	=item on_refresh_end $term
303		556
304	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>.
305		558
306	=item on_keyboard_command $term, $string	559	=item on_user_command $term, $string
307		560
308	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
309	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>
310	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.
311		579
312	=item on_focus_in $term	580	=item on_focus_in $term
313		581
314	Called whenever the window gets the keyboard focus, before rxvt-unicode	582	Called whenever the window gets the keyboard focus, before rxvt-unicode
315	does focus in processing.	583	does focus in processing.
…		…
317	=item on_focus_out $term	585	=item on_focus_out $term
318		586
319	Called wheneever the window loses keyboard focus, before rxvt-unicode does	587	Called wheneever the window loses keyboard focus, before rxvt-unicode does
320	focus out processing.	588	focus out processing.
321		589
		590	=item on_configure_notify $term, $event
		591
		592	=item on_property_notify $term, $event
		593
322	=item on_key_press $term, $event, $keysym, $octets	594	=item on_key_press $term, $event, $keysym, $octets
323		595
324	=item on_key_release $term, $event, $keysym	596	=item on_key_release $term, $event, $keysym
325		597
326	=item on_button_press $term, $event	598	=item on_button_press $term, $event
…		…
335		607
336	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
337	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.
338		610
339	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
340	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
341	and column under the mouse cursor.	613	(real, not screen-based) row and column under the mouse cursor.
342		614
343	C<on_key_press> additionally receives the string rxvt-unicode would	615	C<on_key_press> additionally receives the string rxvt-unicode would
344	output, if any, in locale-specific encoding.	616	output, if any, in locale-specific encoding.
345		617
346	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).
347		628
348	=back	629	=back
349		630
350	=cut	631	=cut
351		632
…		…
357	use Scalar::Util ();	638	use Scalar::Util ();
358	use List::Util ();	639	use List::Util ();
359		640
360	our $VERSION = 1;	641	our $VERSION = 1;
361	our $TERM;	642	our $TERM;
		643	our @TERM_INIT;
		644	our @TERM_EXT;
362	our @HOOKNAME;	645	our @HOOKNAME;
363	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	646	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
364	our %OPTION;	647	our %OPTION;
365		648
366	our $LIBDIR;	649	our $LIBDIR;
367	our $RESNAME;	650	our $RESNAME;
368	our $RESCLASS;	651	our $RESCLASS;
369	our $RXVTNAME;	652	our $RXVTNAME;
370		653
		654	our $NOCHAR = chr 0xffff;
		655
371	=head2 Variables in the C<urxvt> Package	656	=head2 Variables in the C<urxvt> Package
372		657
373	=over 4	658	=over 4
374		659
375	=item $urxvt::LIBDIR	660	=item $urxvt::LIBDIR
…		…
387		672
388	=item $urxvt::TERM	673	=item $urxvt::TERM
389		674
390	The current terminal. This variable stores the current C<urxvt::term>	675	The current terminal. This variable stores the current C<urxvt::term>
391	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>.
392		693
393	=back	694	=back
394		695
395	=head2 Functions in the C<urxvt> Package	696	=head2 Functions in the C<urxvt> Package
396		697
…		…
411	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
412	correct place, e.g. on stderr of the connecting urxvtc client.	713	correct place, e.g. on stderr of the connecting urxvtc client.
413		714
414	Messages have a size limit of 1023 bytes currently.	715	Messages have a size limit of 1023 bytes currently.
415		716
416	=item $is_safe = urxvt::safe	717	=item @terms = urxvt::termlist
417		718
418	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
419	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
420	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).
421		723
422	=item $time = urxvt::NOW	724	=item $time = urxvt::NOW
423		725
424	Returns the "current time" (as per the event loop).	726	Returns the "current time" (as per the event loop).
425		727
426	=item urxvt::CurrentTime	728	=item urxvt::CurrentTime
427		729
428	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	730	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
429	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	731	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
430	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
431		749
432	Various constants for use in X calls and event processing.	750	Various constants for use in X calls and event processing.
433		751
434	=back	752	=back
435		753
…		…
468		786
469	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	787	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
470		788
471	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	789	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
472		790
		791	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		792
473	Replace the foreground/background colour in the rendition mask with the	793	Replace the foreground/background colour in the rendition mask with the
474	specified one.	794	specified one.
475		795
476	=item $value = urxvt::GET_CUSTOM $rend	796	=item $value = urxvt::GET_CUSTOM $rend
477		797
…		…
486	=back	806	=back
487		807
488	=cut	808	=cut
489		809
490	BEGIN {	810	BEGIN {
491	urxvt->bootstrap;
492
493	# overwrite perl's warn	811	# overwrite perl's warn
494	*CORE::GLOBAL::warn = sub {	812	*CORE::GLOBAL::warn = sub {
495	my $msg = join "", @_;	813	my $msg = join "", @_;
496	$msg .= "\n"	814	$msg .= "\n"
497	unless $msg =~ /\n$/;	815	unless $msg =~ /\n$/;
498	urxvt::warn ($msg);	816	urxvt::warn ($msg);
499	};	817	};
500
501	# %ENV is the original startup environment
502	delete $ENV{IFS};
503	delete $ENV{CDPATH};
504	delete $ENV{BASH_ENV};
505	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
506	}	818	}
507		819
508	my @hook_count;	820	no warnings 'utf8';
		821
509	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	822	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
510		823
511	sub verbose {	824	sub verbose {
512	my ($level, $msg) = @_;	825	my ($level, $msg) = @_;
513	warn "$msg\n" if $level <= $verbosity;	826	warn "$msg\n" if $level <= $verbosity;
514	}	827	}
515		828
516	my $extension_pkg = "extension0000";
517	my %extension_pkg;	829	my %extension_pkg;
518		830
519	# load a single script into its own package, once only	831	# load a single script into its own package, once only
520	sub extension_package($) {	832	sub extension_package($) {
521	my ($path) = @_;	833	my ($path) = @_;
522		834
523	$extension_pkg{$path} \|\|= do {	835	$extension_pkg{$path} \|\|= do {
524	my $pkg = "urxvt::" . ($extension_pkg++);	836	$path =~ /([^\/\\]+)$/;
		837	my $pkg = $1;
		838	$pkg =~ s/[^[:word:]]/_/g;
		839	$pkg = "urxvt::ext::$pkg";
525		840
526	verbose 3, "loading extension '$path' into package '$pkg'";	841	verbose 3, "loading extension '$path' into package '$pkg'";
527		842
528	open my $fh, "<:raw", $path	843	open my $fh, "<:raw", $path
529	or die "$path: $!";	844	or die "$path: $!";
530		845
531	my $source = untaint	846	my $source =
532	"package $pkg; use strict; use utf8;\n"	847	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
533	. "use base urxvt::term::extension::;\n"
534	. "#line 1 \"$path\"\n{\n"	848	. "#line 1 \"$path\"\n{\n"
535	. (do { local $/; <$fh> })	849	. (do { local $/; <$fh> })
536	. "\n};\n1";	850	. "\n};\n1";
537		851
538	eval $source	852	eval $source
…		…
552	if ($htype == 0) { # INIT	866	if ($htype == 0) { # INIT
553	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	867	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
554		868
555	my %ext_arg;	869	my %ext_arg;
556		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
557	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	880	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
558	if ($_ eq "default") {	881	if ($_ eq "default") {
559	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	882	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
560	} elsif (/^-(.*)$/) {	883	} elsif (/^-(.*)$/) {
561	delete $ext_arg{$1};	884	delete $ext_arg{$1};
562	} elsif (/^([^<]+)<(.*)>$/) {	885	} elsif (/^([^<]+)<(.*)>$/) {
563	push @{ $ext_arg{$1} }, $2;	886	push @{ $ext_arg{$1} }, $2;
564	} else {	887	} else {
565	$ext_arg{$_} \|\|= [];	888	$ext_arg{$_} \|\|= [];
566	}	889	}
567	}	890	}
568		891
569	while (my ($ext, $argv) = each %ext_arg) {	892	for my $ext (sort keys %ext_arg) {
570	my @files = grep -f $_, map "$_/$ext", @dirs;	893	my @files = grep -f $_, map "$_/$ext", @dirs;
571		894
572	if (@files) {	895	if (@files) {
573	$TERM->register_package (extension_package $files[0], $argv);	896	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
574	} else {	897	} else {
575	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";
576	}	899	}
577	}	900	}
578		901
…		…
584		907
585	if (my $cb = $TERM->{_hook}[$htype]) {	908	if (my $cb = $TERM->{_hook}[$htype]) {
586	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	909	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
587	if $verbosity >= 10;	910	if $verbosity >= 10;
588		911
589	keys %$cb;	912	for my $pkg (keys %$cb) {
590
591	while (my ($pkg, $cb) = each %$cb) {
592	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	913	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
593	and last;	914	$retval \|\|= $retval_;
594		915
595	if ($@) {	916	if ($@) {
596	$TERM->ungrab; # better to lose the grab than the session	917	$TERM->ungrab; # better to lose the grab than the session
597	warn $@;	918	warn $@;
598	}	919	}
599	}	920	}
		921
		922	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		923	if $verbosity >= 11;
600	}	924	}
601		925
602	if ($htype == 1) { # DESTROY	926	if ($htype == 1) { # DESTROY
603	if (my $hook = delete $TERM->{_hook}) {
604	for my $htype (0..$#$hook) {
605	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
606	or set_should_invoke $htype, 0;
607	}
608	}
609
610	# clear package objects	927	# clear package objects
611	%$_ = () for values %{ $TERM->{_pkg} };	928	%$_ = () for values %{ $TERM->{_pkg} };
612		929
613	# clear package	930	# clear package
614	%$TERM = ();	931	%$TERM = ();
615	}	932	}
616		933
617	$retval	934	$retval
		935	}
		936
		937	sub SET_COLOR($$$) {
		938	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
618	}	939	}
619		940
620	# urxvt::term::extension	941	# urxvt::term::extension
621		942
622	package urxvt::term::extension;	943	package urxvt::term::extension;
…		…
628	while (my ($name, $cb) = each %hook) {	949	while (my ($name, $cb) = each %hook) {
629	my $htype = $HOOKTYPE{uc $name};	950	my $htype = $HOOKTYPE{uc $name};
630	defined $htype	951	defined $htype
631	or Carp::croak "unsupported hook type '$name'";	952	or Carp::croak "unsupported hook type '$name'";
632		953
		954	$self->set_should_invoke ($htype, +1)
633	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	955	unless exists $self->{term}{_hook}[$htype]{$pkg};
634	$hook_count[$htype]++
635	or urxvt::set_should_invoke $htype, 1;
636	}
637		956
638	$self->{term}{_hook}[$htype]{$pkg} = $cb;	957	$self->{term}{_hook}[$htype]{$pkg} = $cb;
639	}	958	}
640	}	959	}
641		960
…		…
646	for my $name (@hook) {	965	for my $name (@hook) {
647	my $htype = $HOOKTYPE{uc $name};	966	my $htype = $HOOKTYPE{uc $name};
648	defined $htype	967	defined $htype
649	or Carp::croak "unsupported hook type '$name'";	968	or Carp::croak "unsupported hook type '$name'";
650		969
		970	$self->set_should_invoke ($htype, -1)
651	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	971	if delete $self->{term}{_hook}[$htype]{$pkg};
652	--$hook_count[$htype]
653	or urxvt::set_should_invoke $htype, 0;
654	}
655	}	972	}
656	}	973	}
657		974
658	our $AUTOLOAD;	975	our $AUTOLOAD;
659		976
…		…
765	# find on_xxx subs in the package and register them	1082	# find on_xxx subs in the package and register them
766	# as hooks	1083	# as hooks
767	sub register_package {	1084	sub register_package {
768	my ($self, $pkg, $argv) = @_;	1085	my ($self, $pkg, $argv) = @_;
769		1086
		1087	no strict 'refs';
		1088
		1089	urxvt::verbose 6, "register package $pkg to $self";
		1090
		1091	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1092
770	my $proxy = bless {	1093	my $proxy = bless {
771	_pkg => $pkg,	1094	_pkg => $pkg,
772	argv => $argv,	1095	argv => $argv,
773	}, $pkg;	1096	}, $pkg;
774	Scalar::Util::weaken ($proxy->{term} = $self);	1097	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
789	hash which defines the environment of the new terminal.	1112	hash which defines the environment of the new terminal.
790		1113
791	Croaks (and probably outputs an error message) if the new instance	1114	Croaks (and probably outputs an error message) if the new instance
792	couldn't be created. Returns C<undef> if the new instance didn't	1115	couldn't be created. Returns C<undef> if the new instance didn't
793	initialise perl, and the terminal object otherwise. The C<init> and	1116	initialise perl, and the terminal object otherwise. The C<init> and
794	C<start> hooks will be called during this call.	1117	C<start> hooks will be called before this call returns, and are free to
		1118	refer to global data (which is race free).
795		1119
796	=cut	1120	=cut
797		1121
798	sub new {	1122	sub new {
799	my ($class, $env, @args) = @_;	1123	my ($class, $env, @args) = @_;
800		1124
		1125	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1126	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1127
801	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1128	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
802	}	1129	}
803		1130
804	=item $term->destroy	1131	=item $term->destroy
805		1132
806	Destroy the terminal object (close the window, free resources	1133	Destroy the terminal object (close the window, free resources
807	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1134	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
808	watchers (timers, io watchers) are still active.	1135	watchers (timers, io watchers) are still active.
809		1136
		1137	=item $term->exec_async ($cmd[, @args])
		1138
		1139	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1140	("starts") programs in the background. This function takes care of setting
		1141	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1142	be preferred over explicit calls to C<exec> or C<system>.
		1143
		1144	Returns the pid of the subprocess or C<undef> on error.
		1145
		1146	=cut
		1147
		1148	sub exec_async {
		1149	my $self = shift;
		1150
		1151	my $pid = fork;
		1152
		1153	return $pid
		1154	if !defined $pid or $pid;
		1155
		1156	%ENV = %{ $self->env };
		1157
		1158	exec @_;
		1159	urxvt::_exit 255;
		1160	}
		1161
810	=item $isset = $term->option ($optval[, $set])	1162	=item $isset = $term->option ($optval[, $set])
811		1163
812	Returns true if the option specified by C<$optval> is enabled, and	1164	Returns true if the option specified by C<$optval> is enabled, and
813	optionally change it. All option values are stored by name in the hash	1165	optionally change it. All option values are stored by name in the hash
814	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1166	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
816	Here is a a likely non-exhaustive list of option names, please see the	1168	Here is a a likely non-exhaustive list of option names, please see the
817	source file F</src/optinc.h> to see the actual list:	1169	source file F</src/optinc.h> to see the actual list:
818		1170
819	borderLess console cursorBlink cursorUnderline hold iconic insecure	1171	borderLess console cursorBlink cursorUnderline hold iconic insecure
820	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1172	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
821	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1173	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
822	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1174	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
823	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1175	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
824	tripleclickwords utmpInhibit visualBell	1176	transparent tripleclickwords utmpInhibit visualBell
825		1177
826	=item $value = $term->resource ($name[, $newval])	1178	=item $value = $term->resource ($name[, $newval])
827		1179
828	Returns the current resource value associated with a given name and	1180	Returns the current resource value associated with a given name and
829	optionally sets a new value. Setting values is most useful in the C<init>	1181	optionally sets a new value. Setting values is most useful in the C<init>
…		…
846		1198
847	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1199	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
848	borderLess color cursorBlink cursorUnderline cutchars delete_key	1200	borderLess color cursorBlink cursorUnderline cutchars delete_key
849	display_name embed ext_bwidth fade font geometry hold iconName	1201	display_name embed ext_bwidth fade font geometry hold iconName
850	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1202	imFont imLocale inputMethod insecure int_bwidth intensityStyles
851	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1203	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
852	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1204	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
853	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1205	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
854	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1206	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
855	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1207	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
856	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1208	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
857	shade term_name title transparent transparent_all tripleclickwords	1209	secondaryScreen secondaryScroll selectstyle shade term_name title
858	utmpInhibit visualBell	1210	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1211	visualBell
859		1212
860	=cut	1213	=cut
861		1214
862	sub resource($$;$) {	1215	sub resource($$;$) {
863	my ($self, $name) = (shift, shift);	1216	my ($self, $name) = (shift, shift);
…		…
898	=item ($row, $col) = $term->selection_end ([$row, $col])	1251	=item ($row, $col) = $term->selection_end ([$row, $col])
899		1252
900	Return the current values of the selection mark, begin or end positions,	1253	Return the current values of the selection mark, begin or end positions,
901	and optionally set them to new values.	1254	and optionally set them to new values.
902		1255
		1256	=item $term->selection_make ($eventtime[, $rectangular])
		1257
		1258	Tries to make a selection as set by C<selection_beg> and
		1259	C<selection_end>. If C<$rectangular> is true (default: false), a
		1260	rectangular selection will be made. This is the prefered function to make
		1261	a selection.
		1262
903	=item $success = $term->selection_grab ($eventtime)	1263	=item $success = $term->selection_grab ($eventtime)
904		1264
905	Try to request the primary selection from the server (for example, as set	1265	Try to request the primary selection text from the server (for example, as
906	by the next method).	1266	set by the next method). No visual feedback will be given. This function
		1267	is mostly useful from within C<on_sel_grab> hooks.
907		1268
908	=item $oldtext = $term->selection ([$newtext])	1269	=item $oldtext = $term->selection ([$newtext])
909		1270
910	Return the current selection text and optionally replace it by C<$newtext>.	1271	Return the current selection text and optionally replace it by C<$newtext>.
911		1272
…		…
1004	Convert the given locale-encoded octets into a perl string.	1365	Convert the given locale-encoded octets into a perl string.
1005		1366
1006	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1367	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1007		1368
1008	XORs the rendition values in the given span with the provided value	1369	XORs the rendition values in the given span with the provided value
1009	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1370	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1010	to the selection.	1371	refresh hooks to provide effects similar to the selection.
1011		1372
1012	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1373	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1013		1374
1014	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1375	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1015	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1376	whitespace will additionally be xored with the C<$rstyle2>, which defaults
1016	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines	1377	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
1017	it instead.	1378	it instead. Both styles I<MUST NOT> contain font styles.
1018		1379
1019	=item $term->scr_bell	1380	=item $term->scr_bell
1020		1381
1021	Ring the bell!	1382	Ring the bell!
1022		1383
…		…
1029		1390
1030	Normally its not a good idea to use this function, as programs might be	1391	Normally its not a good idea to use this function, as programs might be
1031	confused by changes in cursor position or scrolling. Its useful inside a	1392	confused by changes in cursor position or scrolling. Its useful inside a
1032	C<on_add_lines> hook, though.	1393	C<on_add_lines> hook, though.
1033		1394
		1395	=item $term->scr_change_screen ($screen)
		1396
		1397	Switch to given screen - 0 primary, 1 secondary.
		1398
1034	=item $term->cmd_parse ($octets)	1399	=item $term->cmd_parse ($octets)
1035		1400
1036	Similar to C<scr_add_lines>, but the argument must be in the	1401	Similar to C<scr_add_lines>, but the argument must be in the
1037	locale-specific encoding of the terminal and can contain command sequences	1402	locale-specific encoding of the terminal and can contain command sequences
1038	(escape codes) that will be interpreted.	1403	(escape codes) that will be interpreted.
…		…
1048	Replaces the event mask of the pty watcher by the given event mask. Can	1413	Replaces the event mask of the pty watcher by the given event mask. Can
1049	be used to suppress input and output handling to the pty/tty. See the	1414	be used to suppress input and output handling to the pty/tty. See the
1050	description of C<< urxvt::timer->events >>. Make sure to always restore	1415	description of C<< urxvt::timer->events >>. Make sure to always restore
1051	the previous value.	1416	the previous value.
1052		1417
		1418	=item $fd = $term->pty_fd
		1419
		1420	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1421	is used.
		1422
1053	=item $windowid = $term->parent	1423	=item $windowid = $term->parent
1054		1424
1055	Return the window id of the toplevel window.	1425	Return the window id of the toplevel window.
1056		1426
1057	=item $windowid = $term->vt	1427	=item $windowid = $term->vt
1058		1428
1059	Return the window id of the terminal window.	1429	Return the window id of the terminal window.
1060		1430
		1431	=item $term->vt_emask_add ($x_event_mask)
		1432
		1433	Adds the specified events to the vt event mask. Useful e.g. when you want
		1434	to receive pointer events all the times:
		1435
		1436	$term->vt_emask_add (urxvt::PointerMotionMask);
		1437
		1438	=item $term->focus_in
		1439
		1440	=item $term->focus_out
		1441
		1442	=item $term->key_press ($state, $keycode[, $time])
		1443
		1444	=item $term->key_release ($state, $keycode[, $time])
		1445
		1446	Deliver various fake events to to terminal.
		1447
1061	=item $window_width = $term->width	1448	=item $window_width = $term->width
1062		1449
1063	=item $window_height = $term->height	1450	=item $window_height = $term->height
1064		1451
1065	=item $font_width = $term->fwidth	1452	=item $font_width = $term->fwidth
…		…
1078		1465
1079	=item $max_scrollback = $term->saveLines	1466	=item $max_scrollback = $term->saveLines
1080		1467
1081	=item $nrow_plus_saveLines = $term->total_rows	1468	=item $nrow_plus_saveLines = $term->total_rows
1082		1469
1083	=item $lines_in_scrollback = $term->nsaved	1470	=item $topmost_scrollback_row = $term->top_row
1084		1471
1085	Return various integers describing terminal characteristics.	1472	Return various integers describing terminal characteristics.
1086		1473
1087	=item $x_display = $term->display_id	1474	=item $x_display = $term->display_id
1088		1475
…		…
1095	=item $env = $term->env	1482	=item $env = $term->env
1096		1483
1097	Returns a copy of the environment in effect for the terminal as a hashref	1484	Returns a copy of the environment in effect for the terminal as a hashref
1098	similar to C<\%ENV>.	1485	similar to C<\%ENV>.
1099		1486
		1487	=item @envv = $term->envv
		1488
		1489	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1490
		1491	=item @argv = $term->argv
		1492
		1493	Return the argument vector as this terminal, similar to @ARGV, but
		1494	includes the program name as first element.
		1495
1100	=cut	1496	=cut
1101		1497
1102	sub env {	1498	sub env {
1103	if (my $env = $_[0]->_env) {
1104	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1499	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1105	} else {
1106	+{ %ENV }
1107	}
1108	}	1500	}
1109		1501
1110	=item $modifiermask = $term->ModLevel3Mask	1502	=item $modifiermask = $term->ModLevel3Mask
1111		1503
1112	=item $modifiermask = $term->ModMetaMask	1504	=item $modifiermask = $term->ModMetaMask
…		…
1114	=item $modifiermask = $term->ModNumLockMask	1506	=item $modifiermask = $term->ModNumLockMask
1115		1507
1116	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1508	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1117	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1509	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1118		1510
		1511	=item $screen = $term->current_screen
		1512
		1513	Returns the currently displayed screen (0 primary, 1 secondary).
		1514
		1515	=item $cursor_is_hidden = $term->hidden_cursor
		1516
		1517	Returns wether the cursor is currently hidden or not.
		1518
1119	=item $view_start = $term->view_start ([$newvalue])	1519	=item $view_start = $term->view_start ([$newvalue])
1120		1520
1121	Returns the negative row number of the topmost line. Minimum value is	1521	Returns the row number of the topmost displayed line. Maximum value is
1122	C<0>, which displays the normal terminal contents. Larger values scroll	1522	C<0>, which displays the normal terminal contents. Lower values scroll
1123	this many lines into the scrollback buffer.	1523	this many lines into the scrollback buffer.
1124		1524
1125	=item $term->want_refresh	1525	=item $term->want_refresh
1126		1526
1127	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1527	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1142	line, starting at column C<$start_col> (default C<0>), which is useful	1542	line, starting at column C<$start_col> (default C<0>), which is useful
1143	to replace only parts of a line. The font index in the rendition will	1543	to replace only parts of a line. The font index in the rendition will
1144	automatically be updated.	1544	automatically be updated.
1145		1545
1146	C<$text> is in a special encoding: tabs and wide characters that use more	1546	C<$text> is in a special encoding: tabs and wide characters that use more
1147	than one cell when displayed are padded with urxvt::NOCHAR characters	1547	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1148	(C<chr 65535>). Characters with combining characters and other characters	1548	characters. Characters with combining characters and other characters that
1149	that do not fit into the normal tetx encoding will be replaced with	1549	do not fit into the normal tetx encoding will be replaced with characters
1150	characters in the private use area.	1550	in the private use area.
1151		1551
1152	You have to obey this encoding when changing text. The advantage is	1552	You have to obey this encoding when changing text. The advantage is
1153	that C<substr> and similar functions work on screen cells and not on	1553	that C<substr> and similar functions work on screen cells and not on
1154	characters.	1554	characters.
1155		1555
…		…
1206	Return the row number of the first/last row of the line, respectively.	1606	Return the row number of the first/last row of the line, respectively.
1207		1607
1208	=item $offset = $line->offset_of ($row, $col)	1608	=item $offset = $line->offset_of ($row, $col)
1209		1609
1210	Returns the character offset of the given row\|col pair within the logical	1610	Returns the character offset of the given row\|col pair within the logical
1211	line.	1611	line. Works for rows outside the line, too, and returns corresponding
		1612	offsets outside the string.
1212		1613
1213	=item ($row, $col) = $line->coord_of ($offset)	1614	=item ($row, $col) = $line->coord_of ($offset)
1214		1615
1215	Translates a string offset into terminal coordinates again.	1616	Translates a string offset into terminal coordinates again.
1216		1617
…		…
1301	=item $string = $term->special_decode $text	1702	=item $string = $term->special_decode $text
1302		1703
1303	Converts rxvt-unicodes text reprsentation into a perl string. See	1704	Converts rxvt-unicodes text reprsentation into a perl string. See
1304	C<< $term->ROW_t >> for details.	1705	C<< $term->ROW_t >> for details.
1305		1706
1306	=item $success = $term->grab_button ($button, $modifiermask)	1707	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1307		1708
		1709	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1710
1308	Registers a synchronous button grab. See the XGrabButton manpage.	1711	Register/unregister a synchronous button grab. See the XGrabButton
		1712	manpage.
1309		1713
1310	=item $success = $term->grab ($eventtime[, $sync])	1714	=item $success = $term->grab ($eventtime[, $sync])
1311		1715
1312	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1716	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1313	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1717	synchronous (C<$sync> is true). Also remembers the grab timestampe.
…		…
1328	=item $term->ungrab	1732	=item $term->ungrab
1329		1733
1330	Calls XUngrab for the most recent grab. Is called automatically on	1734	Calls XUngrab for the most recent grab. Is called automatically on
1331	evaluation errors, as it is better to lose the grab in the error case as	1735	evaluation errors, as it is better to lose the grab in the error case as
1332	the session.	1736	the session.
		1737
		1738	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1739
		1740	=item $atom_name = $term->XGetAtomName ($atom)
		1741
		1742	=item @atoms = $term->XListProperties ($window)
		1743
		1744	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1745
		1746	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1747
		1748	=item $term->XDeleteProperty ($window, $property)
		1749
		1750	=item $window = $term->DefaultRootWindow
		1751
		1752	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1753
		1754	=item $term->XMapWindow ($window)
		1755
		1756	=item $term->XUnmapWindow ($window)
		1757
		1758	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1759
		1760	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1761
		1762	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1763
		1764	Various X or X-related functions. The C<$term> object only serves as
		1765	the source of the display, otherwise those functions map more-or-less
		1766	directory onto the X functions of the same name.
1333		1767
1334	=back	1768	=back
1335		1769
1336	=cut	1770	=cut
1337		1771
…		…
1401	my ($self, $text, $cb) = @_;	1835	my ($self, $text, $cb) = @_;
1402		1836
1403	$self->add_item ({ type => "button", text => $text, activate => $cb});	1837	$self->add_item ({ type => "button", text => $text, activate => $cb});
1404	}	1838	}
1405		1839
1406	=item $popup->add_toggle ($text, $cb, $initial_value)	1840	=item $popup->add_toggle ($text, $initial_value, $cb)
1407		1841
1408	Adds a toggle/checkbox item to the popup. Teh callback gets called	1842	Adds a toggle/checkbox item to the popup. The callback gets called
1409	whenever it gets toggled, with a boolean indicating its value as its first	1843	whenever it gets toggled, with a boolean indicating its new value as its
1410	argument.	1844	first argument.
1411		1845
1412	=cut	1846	=cut
1413		1847
1414	sub add_toggle {	1848	sub add_toggle {
1415	my ($self, $text, $cb, $value) = @_;	1849	my ($self, $text, $value, $cb) = @_;
1416		1850
1417	my $item; $item = {	1851	my $item; $item = {
1418	type => "button",	1852	type => "button",
1419	text => " $text",	1853	text => " $text",
1420	value => $value,	1854	value => $value,
…		…
1439	my $env = $self->{term}->env;	1873	my $env = $self->{term}->env;
1440	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1874	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1441	delete $env->{LC_ALL};	1875	delete $env->{LC_ALL};
1442	$env->{LC_CTYPE} = $self->{term}->locale;	1876	$env->{LC_CTYPE} = $self->{term}->locale;
1443		1877
1444	urxvt::term->new ($env, $self->{term}->resource ("name"),	1878	urxvt::term->new ($env, "popup",
1445	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1879	"--perl-lib" => "", "--perl-ext-common" => "",
		1880	"-pty-fd" => -1, "-sl" => 0,
		1881	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1446	"--transient-for" => $self->{term}->parent,	1882	"--transient-for" => $self->{term}->parent,
1447	"-display" => $self->{term}->display_id,	1883	"-display" => $self->{term}->display_id,
1448	"-pe" => "urxvt-popup")	1884	"-pe" => "urxvt-popup")
1449	or die "unable to create popup window\n";	1885	or die "unable to create popup window\n";
1450	}	1886	}
…		…
1455	delete $self->{term}{_destroy}{$self};	1891	delete $self->{term}{_destroy}{$self};
1456	$self->{term}->ungrab;	1892	$self->{term}->ungrab;
1457	}	1893	}
1458		1894
1459	=back	1895	=back
		1896
		1897	=cut
		1898
		1899	package urxvt::watcher;
		1900
		1901	@urxvt::timer::ISA = __PACKAGE__;
		1902	@urxvt::iow::ISA = __PACKAGE__;
		1903	@urxvt::pw::ISA = __PACKAGE__;
		1904	@urxvt::iw::ISA = __PACKAGE__;
1460		1905
1461	=head2 The C<urxvt::timer> Class	1906	=head2 The C<urxvt::timer> Class
1462		1907
1463	This class implements timer watchers/events. Time is represented as a	1908	This class implements timer watchers/events. Time is represented as a
1464	fractional number of seconds since the epoch. Example:	1909	fractional number of seconds since the epoch. Example:
…		…
1502	Start the timer.	1947	Start the timer.
1503		1948
1504	=item $timer = $timer->start ($tstamp)	1949	=item $timer = $timer->start ($tstamp)
1505		1950
1506	Set the event trigger time to C<$tstamp> and start the timer.	1951	Set the event trigger time to C<$tstamp> and start the timer.
		1952
		1953	=item $timer = $timer->after ($delay)
		1954
		1955	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1507		1956
1508	=item $timer = $timer->stop	1957	=item $timer = $timer->stop
1509		1958
1510	Stop the timer.	1959	Stop the timer.
1511		1960
…		…
1558		2007
1559	Stop watching for events on the given filehandle.	2008	Stop watching for events on the given filehandle.
1560		2009
1561	=back	2010	=back
1562		2011
		2012	=head2 The C<urxvt::iw> Class
		2013
		2014	This class implements idle watchers, that get called automatically when
		2015	the process is idle. They should return as fast as possible, after doing
		2016	some useful work.
		2017
		2018	=over 4
		2019
		2020	=item $iw = new urxvt::iw
		2021
		2022	Create a new idle watcher object in stopped state.
		2023
		2024	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2025
		2026	Set the callback to be called when the watcher triggers.
		2027
		2028	=item $timer = $timer->start
		2029
		2030	Start the watcher.
		2031
		2032	=item $timer = $timer->stop
		2033
		2034	Stop the watcher.
		2035
		2036	=back
		2037
		2038	=head2 The C<urxvt::pw> Class
		2039
		2040	This class implements process watchers. They create an event whenever a
		2041	process exits, after which they stop automatically.
		2042
		2043	my $pid = fork;
		2044	...
		2045	$term->{pw} = urxvt::pw
		2046	->new
		2047	->start ($pid)
		2048	->cb (sub {
		2049	my ($pw, $exit_status) = @_;
		2050	...
		2051	});
		2052
		2053	=over 4
		2054
		2055	=item $pw = new urxvt::pw
		2056
		2057	Create a new process watcher in stopped state.
		2058
		2059	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2060
		2061	Set the callback to be called when the timer triggers.
		2062
		2063	=item $pw = $timer->start ($pid)
		2064
		2065	Tells the wqtcher to start watching for process C<$pid>.
		2066
		2067	=item $pw = $pw->stop
		2068
		2069	Stop the watcher.
		2070
		2071	=back
		2072
1563	=head1 ENVIRONMENT	2073	=head1 ENVIRONMENT
1564		2074
1565	=head2 URXVT_PERL_VERBOSITY	2075	=head2 URXVT_PERL_VERBOSITY
1566		2076
1567	This variable controls the verbosity level of the perl extension. Higher	2077	This variable controls the verbosity level of the perl extension. Higher
…		…
1571		2081
1572	=item == 0 - fatal messages	2082	=item == 0 - fatal messages
1573		2083
1574	=item >= 3 - script loading and management	2084	=item >= 3 - script loading and management
1575		2085
1576	=item >=10 - all events received	2086	=item >=10 - all called hooks
		2087
		2088	=item >=11 - hook reutrn values
1577		2089
1578	=back	2090	=back
1579		2091
1580	=head1 AUTHOR	2092	=head1 AUTHOR
1581		2093

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.82 by root, Thu Jan 12 01:30:53 2006 UTC vs. Revision 1.139 by root, Sat Jul 1 19:04:43 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.82 by root, Thu Jan 12 01:30:53 2006 UTC vs.
Revision 1.139 by root, Sat Jul 1 19:04:43 2006 UTC