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

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.140 by root, Mon Jul 3 19:10:09 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.140 by root, Mon Jul 3 19:10:09 2006 UTC