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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.87 by root, Thu Jan 12 05:37:34 2006 UTC vs.
Revision 1.143 by root, Thu Jul 6 23:48:11 2006 UTC

…		…
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
		39
		40	Or by adding them to the resource for extensions loaded by default:
		41
		42	URxvt.perl-ext-common: default,automove-background,selection-autotransform
39		43
40	=over 4	44	=over 4
41		45
42	=item selection (enabled by default)	46	=item selection (enabled by default)
43		47
…		…
48	C<--quoting-style=shell>.	52	C<--quoting-style=shell>.
49		53
50	A double-click usually selects the word under the cursor, further clicks	54	A double-click usually selects the word under the cursor, further clicks
51	will enlarge the selection.	55	will enlarge the selection.
52		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
53	It also offers the following bindable keyboard command:	82	This extension also offers following bindable keyboard commands:
54		83
55	=over 4	84	=over 4
56		85
57	=item rot13	86	=item rot13
58		87
…		…
65	=item option-popup (enabled by default)	94	=item option-popup (enabled by default)
66		95
67	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
68	runtime.	97	runtime.
69		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
70	=item selection-popup (enabled by default)	116	=item selection-popup (enabled by default)
71		117
72	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
73	text into various other formats/action (such as uri unescaping, perl	119	text into various other formats/action (such as uri unescaping, perl
74	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	};
75		140
76	=item searchable-scrollback<hotkey> (enabled by default)	141	=item searchable-scrollback<hotkey> (enabled by default)
77		142
78	Adds regex search functionality to the scrollback buffer, triggered	143	Adds regex search functionality to the scrollback buffer, triggered
79	by a hotkey (default: C<M-s>). While in search mode, normal terminal	144	by a hotkey (default: C<M-s>). While in search mode, normal terminal
…		…
86	bottom. C<Escape> leaves search mode and returns to the point where search	151	bottom. C<Escape> leaves search mode and returns to the point where search
87	was started, while C<Enter> or C<Return> stay at the current position and	152	was started, while C<Enter> or C<Return> stay at the current position and
88	additionally stores the first match in the current line into the primary	153	additionally stores the first match in the current line into the primary
89	selection.	154	selection.
90		155
91	=item digital-clock	156	The regex defaults to "(?i)", resulting in a case-insensitive search. To
		157	get a case-sensitive search you can delete this prefix using C<BackSpace>
		158	or simply use an uppercase character which removes the "(?i)" prefix.
92		159
93	Displays a digital clock using the built-in overlay.	160	See L<perlre> for more info about perl regular expression syntax.
		161
		162	=item readline (enabled by default)
		163
		164	A support package that tries to make editing with readline easier. At
		165	the moment, it reacts to clicking shift-left mouse button by trying to
		166	move the text cursor to this position. It does so by generating as many
		167	cursor-left or cursor-right keypresses as required (the this only works
		168	for programs that correctly support wide characters).
		169
		170	To avoid too many false positives, this is only done when:
		171
		172	=over 4
		173
		174	=item - the tty is in ICANON state.
		175
		176	=item - the text cursor is visible.
		177
		178	=item - the primary screen is currently being displayed.
		179
		180	=item - the mouse is on the same (multi-row-) line as the text cursor.
		181
		182	=back
		183
		184	The normal selection mechanism isn't disabled, so quick successive clicks
		185	might interfere with selection creation in harmless ways.
		186
		187	=item selection-autotransform
		188
		189	This selection allows you to do automatic transforms on a selection
		190	whenever a selection is made.
		191
		192	It works by specifying perl snippets (most useful is a single C<s///>
		193	operator) that modify C<$_> as resources:
		194
		195	URxvt.selection-autotransform.0: transform
		196	URxvt.selection-autotransform.1: transform
		197	...
		198
		199	For example, the following will transform selections of the form
		200	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		201	$word>:
		202
		203	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		204
		205	And this example matches the same,but replaces it with vi-commands you can
		206	paste directly into your (vi :) editor:
		207
		208	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		209
		210	Of course, this can be modified to suit your needs and your editor :)
		211
		212	To expand the example above to typical perl error messages ("XXX at
		213	FILENAME line YYY."), you need a slightly more elaborate solution:
		214
		215	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		216	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		217
		218	The first line tells the selection code to treat the unchanging part of
		219	every error message as a selection pattern, and the second line transforms
		220	the message into vi commands to load the file.
		221
		222	=item tabbed
		223
		224	This transforms the terminal into a tabbar with additional terminals, that
		225	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		226	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		227	button per tab.
		228
		229	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		230	B<Shift-Right> will switch to the tab left or right of the current one,
		231	while B<Shift-Down> creates a new tab.
		232
		233	The tabbar itself can be configured similarly to a normal terminal, but
		234	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		235	following four resources (shown with defaults):
		236
		237	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		238	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		239	URxvt.tabbed.tab-fg: <colour-index, default 0>
		240	URxvt.tabbed.tab-bg: <colour-index, default 1>
		241
		242	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		243	indices.
94		244
95	=item mark-urls	245	=item mark-urls
96		246
97	Uses per-line display filtering (C<on_line_update>) to underline urls and	247	Uses per-line display filtering (C<on_line_update>) to underline urls and
98	make them clickable. When middle-clicked, the program specified in the	248	make them clickable. When middle-clicked, the program specified in the
99	resource C<urlLauncher> (default C<x-www-browser>) will be started with	249	resource C<urlLauncher> (default C<x-www-browser>) will be started with
100	the URL as first argument.	250	the URL as first argument.
101		251
		252	=item xim-onthespot
		253
		254	This (experimental) perl extension implements OnTheSpot editing. It does
		255	not work perfectly, and some input methods don't seem to work well with
		256	OnTheSpot editing in general, but it seems to work at leats for SCIM and
		257	kinput2.
		258
		259	You enable it by specifying this extension and a preedit style of
		260	C<OnTheSpot>, i.e.:
		261
		262	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		263
		264	=item kuake<hotkey>
		265
		266	A very primitive quake-console-like extension. It was inspired by a
		267	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		268	user presses a global accelerator key (by default C<F10>), the terminal
		269	will show or hide itself. Another press of the accelerator key will hide
		270	or show it again.
		271
		272	Initially, the window will not be shown when using this extension.
		273
		274	This is useful if you need a single terminal thats not using any desktop
		275	space most of the time but is quickly available at the press of a key.
		276
		277	The accelerator key is grabbed regardless of any modifers, so this
		278	extension will actually grab a physical key just for this function.
		279
		280	If you want a quake-like animation, tell your window manager to do so
		281	(fvwm can do it).
		282
		283	=item automove-background
		284
		285	This is basically a very small extension that dynamically changes the
		286	background pixmap offset to the window position, in effect creating the
		287	same effect as pseudo transparency with a custom pixmap. No scaling is
		288	supported in this mode. Exmaple:
		289
		290	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
		291
102	=item block-graphics-to-ascii	292	=item block-graphics-to-ascii
103		293
104	A not very useful example of filtering all text output to the terminal,	294	A not very useful example of filtering all text output to the terminal
105	by replacing all line-drawing characters (U+2500 .. U+259F) by a	295	by replacing all line-drawing characters (U+2500 .. U+259F) by a
106	similar-looking ascii character.	296	similar-looking ascii character.
		297
		298	=item digital-clock
		299
		300	Displays a digital clock using the built-in overlay.
		301
		302	=item remote-clipboard
		303
		304	Somewhat of a misnomer, this extension adds two menu entries to the
		305	selection popup that allows one ti run external commands to store the
		306	selection somewhere and fetch it again.
		307
		308	We use it to implement a "distributed selection mechanism", which just
		309	means that one command uploads the file to a remote server, and another
		310	reads it.
		311
		312	The commands can be set using the C<URxvt.remote-selection.store> and
		313	C<URxvt.remote-selection.fetch> resources. The first should read the
		314	selection to store from STDIN (always in UTF-8), the second should provide
		315	the selection data on STDOUT (also in UTF-8).
		316
		317	The defaults (which are likely useless to you) use rsh and cat:
		318
		319	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		320	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		321
		322	=item selection-pastebin
		323
		324	This is a little rarely useful extension that Uploads the selection as
		325	textfile to a remote site (or does other things). (The implementation is
		326	not currently secure for use in a multiuser environment as it writes to
		327	F</tmp> directly.).
		328
		329	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		330	i.e.
		331
		332	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		333
		334	Pressing this combination runs a command with C<%> replaced by the name of
		335	the textfile. This command can be set via a resource:
		336
		337	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		338
		339	And the default is likely not useful to anybody but the few people around
		340	here :)
		341
		342	The name of the textfile is the hex encoded md5 sum of the selection, so
		343	the same content should lead to the same filename.
		344
		345	After a successful upload the selection will be replaced by the text given
		346	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		347	for the filename):
		348
		349	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
107		350
108	=item example-refresh-hooks	351	=item example-refresh-hooks
109		352
110	Displays a very simple digital clock in the upper right corner of the	353	Displays a very simple digital clock in the upper right corner of the
111	window. Illustrates overwriting the refresh callbacks to create your own	354	window. Illustrates overwriting the refresh callbacks to create your own
…		…
151		394
152	=back	395	=back
153		396
154	=head2 Extension Objects	397	=head2 Extension Objects
155		398
156	Very perl extension is a perl class. A separate perl object is created	399	Every perl extension is a perl class. A separate perl object is created
157	for each terminal and each extension and passed as the first parameter to	400	for each terminal and each extension and passed as the first parameter to
158	hooks. So extensions can use their C<$self> object without having to think	401	hooks. So extensions can use their C<$self> object without having to think
159	about other extensions, with the exception of methods and members that	402	about other extensions, with the exception of methods and members that
160	begin with an underscore character C<_>: these are reserved for internal	403	begin with an underscore character C<_>: these are reserved for internal
161	use.	404	use.
…		…
190	called whenever the relevant event happens.	433	called whenever the relevant event happens.
191		434
192	The first argument passed to them is an extension oject as described in	435	The first argument passed to them is an extension oject as described in
193	the in the C<Extension Objects> section.	436	the in the C<Extension Objects> section.
194		437
195	B<All> of these hooks must return a boolean value. If it is true, then the	438	B<All> of these hooks must return a boolean value. If any of the called
196	event counts as being I<consumed>, and the invocation of other hooks is	439	hooks returns true, then the event counts as being I<consumed>, and the
197	skipped, and the relevant action might not be carried out by the C++ code.	440	relevant action might not be carried out by the C++ code.
198		441
199	I<< When in doubt, return a false value (preferably C<()>). >>	442	I<< When in doubt, return a false value (preferably C<()>). >>
200		443
201	=over 4	444	=over 4
202		445
203	=item on_init $term	446	=item on_init $term
204		447
205	Called after a new terminal object has been initialized, but before	448	Called after a new terminal object has been initialized, but before
206	windows are created or the command gets run. Most methods are unsafe to	449	windows are created or the command gets run. Most methods are unsafe to
207	call or deliver senseless data, as terminal size and other characteristics	450	call or deliver senseless data, as terminal size and other characteristics
208	have not yet been determined. You can safely query and change resources,	451	have not yet been determined. You can safely query and change resources
209	though.	452	and options, though. For many purposes the C<on_start> hook is a better
		453	place.
		454
		455	=item on_start $term
		456
		457	Called at the very end of initialisation of a new terminal, just before
		458	trying to map (display) the toplevel and returning to the mainloop.
		459
		460	=item on_destroy $term
		461
		462	Called whenever something tries to destroy terminal, when the terminal is
		463	still fully functional (not for long, though).
210		464
211	=item on_reset $term	465	=item on_reset $term
212		466
213	Called after the screen is "reset" for any reason, such as resizing or	467	Called after the screen is "reset" for any reason, such as resizing or
214	control sequences. Here is where you can react on changes to size-related	468	control sequences. Here is where you can react on changes to size-related
215	variables.	469	variables.
216		470
217	=item on_start $term	471	=item on_child_start $term, $pid
218		472
219	Called at the very end of initialisation of a new terminal, just before	473	Called just after the child process has been C<fork>ed.
220	returning to the mainloop.	474
		475	=item on_child_exit $term, $status
		476
		477	Called just after the child process has exited. C<$status> is the status
		478	from C<waitpid>.
221		479
222	=item on_sel_make $term, $eventtime	480	=item on_sel_make $term, $eventtime
223		481
224	Called whenever a selection has been made by the user, but before the	482	Called whenever a selection has been made by the user, but before the
225	selection text is copied, so changes to the beginning, end or type of the	483	selection text is copied, so changes to the beginning, end or type of the
…		…
261		519
262	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	520	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
263	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	521	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
264	number of lines that will be in the scrollback buffer.	522	number of lines that will be in the scrollback buffer.
265		523
		524	=item on_osc_seq $term, $op, $args
		525
		526	Called on every OSC sequence and can be used to suppress it or modify its
		527	behaviour. The default should be to return an empty list. A true value
		528	suppresses execution of the request completely. Make sure you don't get
		529	confused by recursive invocations when you output an osc sequence within
		530	this callback.
		531
		532	C<on_osc_seq_perl> should be used for new behaviour.
		533
266	=item on_osc_seq $term, $string	534	=item on_osc_seq_perl $term, $string
267		535
268	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	536	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
269	operating system command) is processed. Cursor position and other state	537	operating system command) is processed. Cursor position and other state
270	information is up-to-date when this happens. For interoperability, the	538	information is up-to-date when this happens. For interoperability, the
271	string should start with the extension name and a colon, to distinguish	539	string should start with the extension name and a colon, to distinguish
…		…
312		580
313	=item on_refresh_end $term	581	=item on_refresh_end $term
314		582
315	Called just after the screen gets redrawn. See C<on_refresh_begin>.	583	Called just after the screen gets redrawn. See C<on_refresh_begin>.
316		584
317	=item on_keyboard_command $term, $string	585	=item on_user_command $term, $string
318		586
319	Called whenever the user presses a key combination that has a	587	Called whenever the a user-configured event is being activated (e.g. via
320	C<perl:string> action bound to it (see description of the B<keysym>	588	a C<perl:string> action bound to a key, see description of the B<keysym>
321	resource in the @@RXVT_NAME@@(1) manpage).	589	resource in the @@RXVT_NAME@@(1) manpage).
		590
		591	The event is simply the action string. This interface is assumed to change
		592	slightly in the future.
		593
		594	=item on_resize_all_windows $tern, $new_width, $new_height
		595
		596	Called just after the new window size has been calculcated, but before
		597	windows are actually being resized or hints are being set. If this hook
		598	returns TRUE, setting of the window hints is being skipped.
		599
		600	=item on_x_event $term, $event
		601
		602	Called on every X event received on the vt window (and possibly other
		603	windows). Should only be used as a last resort. Most event structure
		604	members are not passed.
		605
		606	=item on_root_event $term, $event
		607
		608	Like C<on_x_event>, but is called for events on the root window.
322		609
323	=item on_focus_in $term	610	=item on_focus_in $term
324		611
325	Called whenever the window gets the keyboard focus, before rxvt-unicode	612	Called whenever the window gets the keyboard focus, before rxvt-unicode
326	does focus in processing.	613	does focus in processing.
…		…
328	=item on_focus_out $term	615	=item on_focus_out $term
329		616
330	Called wheneever the window loses keyboard focus, before rxvt-unicode does	617	Called wheneever the window loses keyboard focus, before rxvt-unicode does
331	focus out processing.	618	focus out processing.
332		619
		620	=item on_configure_notify $term, $event
		621
		622	=item on_property_notify $term, $event
		623
333	=item on_key_press $term, $event, $keysym, $octets	624	=item on_key_press $term, $event, $keysym, $octets
334		625
335	=item on_key_release $term, $event, $keysym	626	=item on_key_release $term, $event, $keysym
336		627
337	=item on_button_press $term, $event	628	=item on_button_press $term, $event
…		…
346		637
347	Called whenever the corresponding X event is received for the terminal If	638	Called whenever the corresponding X event is received for the terminal If
348	the hook returns true, then the even will be ignored by rxvt-unicode.	639	the hook returns true, then the even will be ignored by rxvt-unicode.
349		640
350	The event is a hash with most values as named by Xlib (see the XEvent	641	The event is a hash with most values as named by Xlib (see the XEvent
351	manpage), with the additional members C<row> and C<col>, which are the row	642	manpage), with the additional members C<row> and C<col>, which are the
352	and column under the mouse cursor.	643	(real, not screen-based) row and column under the mouse cursor.
353		644
354	C<on_key_press> additionally receives the string rxvt-unicode would	645	C<on_key_press> additionally receives the string rxvt-unicode would
355	output, if any, in locale-specific encoding.	646	output, if any, in locale-specific encoding.
356		647
357	subwindow.	648	subwindow.
		649
		650	=item on_client_message $term, $event
		651
		652	=item on_wm_protocols $term, $event
		653
		654	=item on_wm_delete_window $term, $event
		655
		656	Called when various types of ClientMessage events are received (all with
		657	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
358		658
359	=back	659	=back
360		660
361	=cut	661	=cut
362		662
…		…
368	use Scalar::Util ();	668	use Scalar::Util ();
369	use List::Util ();	669	use List::Util ();
370		670
371	our $VERSION = 1;	671	our $VERSION = 1;
372	our $TERM;	672	our $TERM;
		673	our @TERM_INIT;
		674	our @TERM_EXT;
373	our @HOOKNAME;	675	our @HOOKNAME;
374	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	676	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
375	our %OPTION;	677	our %OPTION;
376		678
377	our $LIBDIR;	679	our $LIBDIR;
378	our $RESNAME;	680	our $RESNAME;
379	our $RESCLASS;	681	our $RESCLASS;
380	our $RXVTNAME;	682	our $RXVTNAME;
381		683
		684	our $NOCHAR = chr 0xffff;
		685
382	=head2 Variables in the C<urxvt> Package	686	=head2 Variables in the C<urxvt> Package
383		687
384	=over 4	688	=over 4
385		689
386	=item $urxvt::LIBDIR	690	=item $urxvt::LIBDIR
…		…
398		702
399	=item $urxvt::TERM	703	=item $urxvt::TERM
400		704
401	The current terminal. This variable stores the current C<urxvt::term>	705	The current terminal. This variable stores the current C<urxvt::term>
402	object, whenever a callback/hook is executing.	706	object, whenever a callback/hook is executing.
		707
		708	=item @urxvt::TERM_INIT
		709
		710	All coderefs in this array will be called as methods of the next newly
		711	created C<urxvt::term> object (during the C<on_init> phase). The array
		712	gets cleared before the codereferences that were in it are being executed,
		713	so coderefs can push themselves onto it again if they so desire.
		714
		715	This complements to the perl-eval commandline option, but gets executed
		716	first.
		717
		718	=item @urxvt::TERM_EXT
		719
		720	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		721	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		722	but before other extensions. Gets cleared just like C<@TERM_INIT>.
403		723
404	=back	724	=back
405		725
406	=head2 Functions in the C<urxvt> Package	726	=head2 Functions in the C<urxvt> Package
407		727
…		…
422	Using this function has the advantage that its output ends up in the	742	Using this function has the advantage that its output ends up in the
423	correct place, e.g. on stderr of the connecting urxvtc client.	743	correct place, e.g. on stderr of the connecting urxvtc client.
424		744
425	Messages have a size limit of 1023 bytes currently.	745	Messages have a size limit of 1023 bytes currently.
426		746
427	=item $is_safe = urxvt::safe	747	=item @terms = urxvt::termlist
428		748
429	Returns true when it is safe to do potentially unsafe things, such as	749	Returns all urxvt::term objects that exist in this process, regardless of
430	evaluating perl code specified by the user. This is true when urxvt was	750	wether they are started, being destroyed etc., so be careful. Only term
431	started setuid or setgid.	751	objects that have perl extensions attached will be returned (because there
		752	is no urxvt::term objet associated with others).
432		753
433	=item $time = urxvt::NOW	754	=item $time = urxvt::NOW
434		755
435	Returns the "current time" (as per the event loop).	756	Returns the "current time" (as per the event loop).
436		757
437	=item urxvt::CurrentTime	758	=item urxvt::CurrentTime
438		759
439	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	760	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
440	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	761	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
441	Button4Mask, Button5Mask, AnyModifier	762	Button4Mask, Button5Mask, AnyModifier
		763
		764	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		765	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		766	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		767	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		768	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		769	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		770	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		771
		772	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		773	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		774	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		775	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		776	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		777	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		778	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
442		779
443	Various constants for use in X calls and event processing.	780	Various constants for use in X calls and event processing.
444		781
445	=back	782	=back
446		783
…		…
479		816
480	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	817	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
481		818
482	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	819	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
483		820
		821	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		822
484	Replace the foreground/background colour in the rendition mask with the	823	Replace the foreground/background colour in the rendition mask with the
485	specified one.	824	specified one.
486		825
487	=item $value = urxvt::GET_CUSTOM $rend	826	=item $value = urxvt::GET_CUSTOM $rend
488		827
…		…
497	=back	836	=back
498		837
499	=cut	838	=cut
500		839
501	BEGIN {	840	BEGIN {
502	urxvt->bootstrap;
503
504	# overwrite perl's warn	841	# overwrite perl's warn
505	*CORE::GLOBAL::warn = sub {	842	*CORE::GLOBAL::warn = sub {
506	my $msg = join "", @_;	843	my $msg = join "", @_;
507	$msg .= "\n"	844	$msg .= "\n"
508	unless $msg =~ /\n$/;	845	unless $msg =~ /\n$/;
509	urxvt::warn ($msg);	846	urxvt::warn ($msg);
510	};	847	};
511
512	# %ENV is the original startup environment
513	delete $ENV{IFS};
514	delete $ENV{CDPATH};
515	delete $ENV{BASH_ENV};
516	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
517	}	848	}
518		849
519	my @hook_count;	850	no warnings 'utf8';
		851
520	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	852	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
521		853
522	sub verbose {	854	sub verbose {
523	my ($level, $msg) = @_;	855	my ($level, $msg) = @_;
524	warn "$msg\n" if $level <= $verbosity;	856	warn "$msg\n" if $level <= $verbosity;
525	}	857	}
526		858
527	my $extension_pkg = "extension0000";
528	my %extension_pkg;	859	my %extension_pkg;
529		860
530	# load a single script into its own package, once only	861	# load a single script into its own package, once only
531	sub extension_package($) {	862	sub extension_package($) {
532	my ($path) = @_;	863	my ($path) = @_;
533		864
534	$extension_pkg{$path} \|\|= do {	865	$extension_pkg{$path} \|\|= do {
535	my $pkg = "urxvt::" . ($extension_pkg++);	866	$path =~ /([^\/\\]+)$/;
		867	my $pkg = $1;
		868	$pkg =~ s/[^[:word:]]/_/g;
		869	$pkg = "urxvt::ext::$pkg";
536		870
537	verbose 3, "loading extension '$path' into package '$pkg'";	871	verbose 3, "loading extension '$path' into package '$pkg'";
538		872
539	open my $fh, "<:raw", $path	873	open my $fh, "<:raw", $path
540	or die "$path: $!";	874	or die "$path: $!";
541		875
542	my $source = untaint	876	my $source =
543	"package $pkg; use strict; use utf8;\n"	877	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
544	. "use base urxvt::term::extension::;\n"
545	. "#line 1 \"$path\"\n{\n"	878	. "#line 1 \"$path\"\n{\n"
546	. (do { local $/; <$fh> })	879	. (do { local $/; <$fh> })
547	. "\n};\n1";	880	. "\n};\n1";
548		881
549	eval $source	882	eval $source
…		…
563	if ($htype == 0) { # INIT	896	if ($htype == 0) { # INIT
564	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	897	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
565		898
566	my %ext_arg;	899	my %ext_arg;
567		900
		901	{
		902	my @init = @TERM_INIT;
		903	@TERM_INIT = ();
		904	$_->($TERM) for @init;
		905	my @pkg = @TERM_EXT;
		906	@TERM_EXT = ();
		907	$TERM->register_package ($_) for @pkg;
		908	}
		909
568	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	910	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
569	if ($_ eq "default") {	911	if ($_ eq "default") {
570	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	912	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
571	} elsif (/^-(.*)$/) {	913	} elsif (/^-(.*)$/) {
572	delete $ext_arg{$1};	914	delete $ext_arg{$1};
573	} elsif (/^([^<]+)<(.*)>$/) {	915	} elsif (/^([^<]+)<(.*)>$/) {
574	push @{ $ext_arg{$1} }, $2;	916	push @{ $ext_arg{$1} }, $2;
575	} else {	917	} else {
576	$ext_arg{$_} \|\|= [];	918	$ext_arg{$_} \|\|= [];
577	}	919	}
578	}	920	}
579		921
580	while (my ($ext, $argv) = each %ext_arg) {	922	for my $ext (sort keys %ext_arg) {
581	my @files = grep -f $_, map "$_/$ext", @dirs;	923	my @files = grep -f $_, map "$_/$ext", @dirs;
582		924
583	if (@files) {	925	if (@files) {
584	$TERM->register_package (extension_package $files[0], $argv);	926	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
585	} else {	927	} else {
586	warn "perl extension '$ext' not found in perl library search path\n";	928	warn "perl extension '$ext' not found in perl library search path\n";
587	}	929	}
588	}	930	}
589		931
…		…
595		937
596	if (my $cb = $TERM->{_hook}[$htype]) {	938	if (my $cb = $TERM->{_hook}[$htype]) {
597	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	939	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
598	if $verbosity >= 10;	940	if $verbosity >= 10;
599		941
600	keys %$cb;	942	for my $pkg (keys %$cb) {
601
602	while (my ($pkg, $cb) = each %$cb) {
603	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	943	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
604	and last;	944	$retval \|\|= $retval_;
605		945
606	if ($@) {	946	if ($@) {
607	$TERM->ungrab; # better to lose the grab than the session	947	$TERM->ungrab; # better to lose the grab than the session
608	warn $@;	948	warn $@;
609	}	949	}
…		…
612	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	952	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
613	if $verbosity >= 11;	953	if $verbosity >= 11;
614	}	954	}
615		955
616	if ($htype == 1) { # DESTROY	956	if ($htype == 1) { # DESTROY
617	if (my $hook = delete $TERM->{_hook}) {
618	for my $htype (0..$#$hook) {
619	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
620	or set_should_invoke $htype, 0;
621	}
622	}
623
624	# clear package objects	957	# clear package objects
625	%$_ = () for values %{ $TERM->{_pkg} };	958	%$_ = () for values %{ $TERM->{_pkg} };
626		959
627	# clear package	960	# clear package
628	%$TERM = ();	961	%$TERM = ();
629	}	962	}
630		963
631	$retval	964	$retval
632	}	965	}
633		966
634	sub exec_async(@) {	967	sub SET_COLOR($$$) {
635	my $pid = fork;	968	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
636
637	return
638	if !defined $pid or $pid;
639
640	%ENV = %{ $TERM->env };
641
642	exec @_;
643	_exit 255;
644	}	969	}
645		970
646	# urxvt::term::extension	971	# urxvt::term::extension
647		972
648	package urxvt::term::extension;	973	package urxvt::term::extension;
…		…
654	while (my ($name, $cb) = each %hook) {	979	while (my ($name, $cb) = each %hook) {
655	my $htype = $HOOKTYPE{uc $name};	980	my $htype = $HOOKTYPE{uc $name};
656	defined $htype	981	defined $htype
657	or Carp::croak "unsupported hook type '$name'";	982	or Carp::croak "unsupported hook type '$name'";
658		983
		984	$self->set_should_invoke ($htype, +1)
659	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	985	unless exists $self->{term}{_hook}[$htype]{$pkg};
660	$hook_count[$htype]++
661	or urxvt::set_should_invoke $htype, 1;
662	}
663		986
664	$self->{term}{_hook}[$htype]{$pkg} = $cb;	987	$self->{term}{_hook}[$htype]{$pkg} = $cb;
665	}	988	}
666	}	989	}
667		990
…		…
672	for my $name (@hook) {	995	for my $name (@hook) {
673	my $htype = $HOOKTYPE{uc $name};	996	my $htype = $HOOKTYPE{uc $name};
674	defined $htype	997	defined $htype
675	or Carp::croak "unsupported hook type '$name'";	998	or Carp::croak "unsupported hook type '$name'";
676		999
		1000	$self->set_should_invoke ($htype, -1)
677	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1001	if delete $self->{term}{_hook}[$htype]{$pkg};
678	--$hook_count[$htype]
679	or urxvt::set_should_invoke $htype, 0;
680	}
681	}	1002	}
682	}	1003	}
683		1004
684	our $AUTOLOAD;	1005	our $AUTOLOAD;
685		1006
…		…
791	# find on_xxx subs in the package and register them	1112	# find on_xxx subs in the package and register them
792	# as hooks	1113	# as hooks
793	sub register_package {	1114	sub register_package {
794	my ($self, $pkg, $argv) = @_;	1115	my ($self, $pkg, $argv) = @_;
795		1116
		1117	no strict 'refs';
		1118
		1119	urxvt::verbose 6, "register package $pkg to $self";
		1120
		1121	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1122
796	my $proxy = bless {	1123	my $proxy = bless {
797	_pkg => $pkg,	1124	_pkg => $pkg,
798	argv => $argv,	1125	argv => $argv,
799	}, $pkg;	1126	}, $pkg;
800	Scalar::Util::weaken ($proxy->{term} = $self);	1127	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
815	hash which defines the environment of the new terminal.	1142	hash which defines the environment of the new terminal.
816		1143
817	Croaks (and probably outputs an error message) if the new instance	1144	Croaks (and probably outputs an error message) if the new instance
818	couldn't be created. Returns C<undef> if the new instance didn't	1145	couldn't be created. Returns C<undef> if the new instance didn't
819	initialise perl, and the terminal object otherwise. The C<init> and	1146	initialise perl, and the terminal object otherwise. The C<init> and
820	C<start> hooks will be called during this call.	1147	C<start> hooks will be called before this call returns, and are free to
		1148	refer to global data (which is race free).
821		1149
822	=cut	1150	=cut
823		1151
824	sub new {	1152	sub new {
825	my ($class, $env, @args) = @_;	1153	my ($class, $env, @args) = @_;
826		1154
		1155	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1156	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1157
827	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1158	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
828	}	1159	}
829		1160
830	=item $term->destroy	1161	=item $term->destroy
831		1162
832	Destroy the terminal object (close the window, free resources	1163	Destroy the terminal object (close the window, free resources
833	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1164	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
834	watchers (timers, io watchers) are still active.	1165	watchers (timers, io watchers) are still active.
835		1166
		1167	=item $term->exec_async ($cmd[, @args])
		1168
		1169	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1170	("starts") programs in the background. This function takes care of setting
		1171	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1172	be preferred over explicit calls to C<exec> or C<system>.
		1173
		1174	Returns the pid of the subprocess or C<undef> on error.
		1175
		1176	=cut
		1177
		1178	sub exec_async {
		1179	my $self = shift;
		1180
		1181	my $pid = fork;
		1182
		1183	return $pid
		1184	if !defined $pid or $pid;
		1185
		1186	%ENV = %{ $self->env };
		1187
		1188	exec @_;
		1189	urxvt::_exit 255;
		1190	}
		1191
836	=item $isset = $term->option ($optval[, $set])	1192	=item $isset = $term->option ($optval[, $set])
837		1193
838	Returns true if the option specified by C<$optval> is enabled, and	1194	Returns true if the option specified by C<$optval> is enabled, and
839	optionally change it. All option values are stored by name in the hash	1195	optionally change it. All option values are stored by name in the hash
840	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1196	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
842	Here is a a likely non-exhaustive list of option names, please see the	1198	Here is a a likely non-exhaustive list of option names, please see the
843	source file F</src/optinc.h> to see the actual list:	1199	source file F</src/optinc.h> to see the actual list:
844		1200
845	borderLess console cursorBlink cursorUnderline hold iconic insecure	1201	borderLess console cursorBlink cursorUnderline hold iconic insecure
846	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1202	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
847	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1203	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
848	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1204	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
849	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1205	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
850	tripleclickwords utmpInhibit visualBell	1206	transparent tripleclickwords utmpInhibit visualBell
851		1207
852	=item $value = $term->resource ($name[, $newval])	1208	=item $value = $term->resource ($name[, $newval])
853		1209
854	Returns the current resource value associated with a given name and	1210	Returns the current resource value associated with a given name and
855	optionally sets a new value. Setting values is most useful in the C<init>	1211	optionally sets a new value. Setting values is most useful in the C<init>
…		…
872		1228
873	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1229	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
874	borderLess color cursorBlink cursorUnderline cutchars delete_key	1230	borderLess color cursorBlink cursorUnderline cutchars delete_key
875	display_name embed ext_bwidth fade font geometry hold iconName	1231	display_name embed ext_bwidth fade font geometry hold iconName
876	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1232	imFont imLocale inputMethod insecure int_bwidth intensityStyles
877	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1233	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
878	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1234	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
879	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1235	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
880	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1236	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
881	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1237	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
882	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1238	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
883	shade term_name title transparent transparent_all tripleclickwords	1239	secondaryScreen secondaryScroll selectstyle shade term_name title
884	utmpInhibit visualBell	1240	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1241	visualBell
885		1242
886	=cut	1243	=cut
887		1244
888	sub resource($$;$) {	1245	sub resource($$;$) {
889	my ($self, $name) = (shift, shift);	1246	my ($self, $name) = (shift, shift);
…		…
1063		1420
1064	Normally its not a good idea to use this function, as programs might be	1421	Normally its not a good idea to use this function, as programs might be
1065	confused by changes in cursor position or scrolling. Its useful inside a	1422	confused by changes in cursor position or scrolling. Its useful inside a
1066	C<on_add_lines> hook, though.	1423	C<on_add_lines> hook, though.
1067		1424
		1425	=item $term->scr_change_screen ($screen)
		1426
		1427	Switch to given screen - 0 primary, 1 secondary.
		1428
1068	=item $term->cmd_parse ($octets)	1429	=item $term->cmd_parse ($octets)
1069		1430
1070	Similar to C<scr_add_lines>, but the argument must be in the	1431	Similar to C<scr_add_lines>, but the argument must be in the
1071	locale-specific encoding of the terminal and can contain command sequences	1432	locale-specific encoding of the terminal and can contain command sequences
1072	(escape codes) that will be interpreted.	1433	(escape codes) that will be interpreted.
…		…
1082	Replaces the event mask of the pty watcher by the given event mask. Can	1443	Replaces the event mask of the pty watcher by the given event mask. Can
1083	be used to suppress input and output handling to the pty/tty. See the	1444	be used to suppress input and output handling to the pty/tty. See the
1084	description of C<< urxvt::timer->events >>. Make sure to always restore	1445	description of C<< urxvt::timer->events >>. Make sure to always restore
1085	the previous value.	1446	the previous value.
1086		1447
		1448	=item $fd = $term->pty_fd
		1449
		1450	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1451	is used.
		1452
1087	=item $windowid = $term->parent	1453	=item $windowid = $term->parent
1088		1454
1089	Return the window id of the toplevel window.	1455	Return the window id of the toplevel window.
1090		1456
1091	=item $windowid = $term->vt	1457	=item $windowid = $term->vt
1092		1458
1093	Return the window id of the terminal window.	1459	Return the window id of the terminal window.
1094		1460
		1461	=item $term->vt_emask_add ($x_event_mask)
		1462
		1463	Adds the specified events to the vt event mask. Useful e.g. when you want
		1464	to receive pointer events all the times:
		1465
		1466	$term->vt_emask_add (urxvt::PointerMotionMask);
		1467
		1468	=item $term->focus_in
		1469
		1470	=item $term->focus_out
		1471
		1472	=item $term->key_press ($state, $keycode[, $time])
		1473
		1474	=item $term->key_release ($state, $keycode[, $time])
		1475
		1476	Deliver various fake events to to terminal.
		1477
1095	=item $window_width = $term->width	1478	=item $window_width = $term->width
1096		1479
1097	=item $window_height = $term->height	1480	=item $window_height = $term->height
1098		1481
1099	=item $font_width = $term->fwidth	1482	=item $font_width = $term->fwidth
…		…
1112		1495
1113	=item $max_scrollback = $term->saveLines	1496	=item $max_scrollback = $term->saveLines
1114		1497
1115	=item $nrow_plus_saveLines = $term->total_rows	1498	=item $nrow_plus_saveLines = $term->total_rows
1116		1499
1117	=item $lines_in_scrollback = $term->nsaved	1500	=item $topmost_scrollback_row = $term->top_row
1118		1501
1119	Return various integers describing terminal characteristics.	1502	Return various integers describing terminal characteristics.
1120		1503
1121	=item $x_display = $term->display_id	1504	=item $x_display = $term->display_id
1122		1505
…		…
1129	=item $env = $term->env	1512	=item $env = $term->env
1130		1513
1131	Returns a copy of the environment in effect for the terminal as a hashref	1514	Returns a copy of the environment in effect for the terminal as a hashref
1132	similar to C<\%ENV>.	1515	similar to C<\%ENV>.
1133		1516
		1517	=item @envv = $term->envv
		1518
		1519	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1520
		1521	=item @argv = $term->argv
		1522
		1523	Return the argument vector as this terminal, similar to @ARGV, but
		1524	includes the program name as first element.
		1525
1134	=cut	1526	=cut
1135		1527
1136	sub env {	1528	sub env {
1137	if (my $env = $_[0]->_env) {
1138	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1529	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1139	} else {
1140	+{ %ENV }
1141	}
1142	}	1530	}
1143		1531
1144	=item $modifiermask = $term->ModLevel3Mask	1532	=item $modifiermask = $term->ModLevel3Mask
1145		1533
1146	=item $modifiermask = $term->ModMetaMask	1534	=item $modifiermask = $term->ModMetaMask
…		…
1148	=item $modifiermask = $term->ModNumLockMask	1536	=item $modifiermask = $term->ModNumLockMask
1149		1537
1150	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1538	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1151	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1539	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1152		1540
		1541	=item $screen = $term->current_screen
		1542
		1543	Returns the currently displayed screen (0 primary, 1 secondary).
		1544
		1545	=item $cursor_is_hidden = $term->hidden_cursor
		1546
		1547	Returns wether the cursor is currently hidden or not.
		1548
1153	=item $view_start = $term->view_start ([$newvalue])	1549	=item $view_start = $term->view_start ([$newvalue])
1154		1550
1155	Returns the negative row number of the topmost line. Minimum value is	1551	Returns the row number of the topmost displayed line. Maximum value is
1156	C<0>, which displays the normal terminal contents. Larger values scroll	1552	C<0>, which displays the normal terminal contents. Lower values scroll
1157	this many lines into the scrollback buffer.	1553	this many lines into the scrollback buffer.
1158		1554
1159	=item $term->want_refresh	1555	=item $term->want_refresh
1160		1556
1161	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1557	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1176	line, starting at column C<$start_col> (default C<0>), which is useful	1572	line, starting at column C<$start_col> (default C<0>), which is useful
1177	to replace only parts of a line. The font index in the rendition will	1573	to replace only parts of a line. The font index in the rendition will
1178	automatically be updated.	1574	automatically be updated.
1179		1575
1180	C<$text> is in a special encoding: tabs and wide characters that use more	1576	C<$text> is in a special encoding: tabs and wide characters that use more
1181	than one cell when displayed are padded with urxvt::NOCHAR characters	1577	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1182	(C<chr 65535>). Characters with combining characters and other characters	1578	characters. Characters with combining characters and other characters that
1183	that do not fit into the normal tetx encoding will be replaced with	1579	do not fit into the normal tetx encoding will be replaced with characters
1184	characters in the private use area.	1580	in the private use area.
1185		1581
1186	You have to obey this encoding when changing text. The advantage is	1582	You have to obey this encoding when changing text. The advantage is
1187	that C<substr> and similar functions work on screen cells and not on	1583	that C<substr> and similar functions work on screen cells and not on
1188	characters.	1584	characters.
1189		1585
…		…
1336	=item $string = $term->special_decode $text	1732	=item $string = $term->special_decode $text
1337		1733
1338	Converts rxvt-unicodes text reprsentation into a perl string. See	1734	Converts rxvt-unicodes text reprsentation into a perl string. See
1339	C<< $term->ROW_t >> for details.	1735	C<< $term->ROW_t >> for details.
1340		1736
1341	=item $success = $term->grab_button ($button, $modifiermask)	1737	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1342		1738
		1739	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1740
1343	Registers a synchronous button grab. See the XGrabButton manpage.	1741	Register/unregister a synchronous button grab. See the XGrabButton
		1742	manpage.
1344		1743
1345	=item $success = $term->grab ($eventtime[, $sync])	1744	=item $success = $term->grab ($eventtime[, $sync])
1346		1745
1347	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1746	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1348	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1747	synchronous (C<$sync> is true). Also remembers the grab timestampe.
…		…
1363	=item $term->ungrab	1762	=item $term->ungrab
1364		1763
1365	Calls XUngrab for the most recent grab. Is called automatically on	1764	Calls XUngrab for the most recent grab. Is called automatically on
1366	evaluation errors, as it is better to lose the grab in the error case as	1765	evaluation errors, as it is better to lose the grab in the error case as
1367	the session.	1766	the session.
		1767
		1768	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1769
		1770	=item $atom_name = $term->XGetAtomName ($atom)
		1771
		1772	=item @atoms = $term->XListProperties ($window)
		1773
		1774	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1775
		1776	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1777
		1778	=item $term->XDeleteProperty ($window, $property)
		1779
		1780	=item $window = $term->DefaultRootWindow
		1781
		1782	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1783
		1784	=item $term->XMapWindow ($window)
		1785
		1786	=item $term->XUnmapWindow ($window)
		1787
		1788	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1789
		1790	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1791
		1792	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1793
		1794	Various X or X-related functions. The C<$term> object only serves as
		1795	the source of the display, otherwise those functions map more-or-less
		1796	directory onto the X functions of the same name.
1368		1797
1369	=back	1798	=back
1370		1799
1371	=cut	1800	=cut
1372		1801
…		…
1436	my ($self, $text, $cb) = @_;	1865	my ($self, $text, $cb) = @_;
1437		1866
1438	$self->add_item ({ type => "button", text => $text, activate => $cb});	1867	$self->add_item ({ type => "button", text => $text, activate => $cb});
1439	}	1868	}
1440		1869
1441	=item $popup->add_toggle ($text, $cb, $initial_value)	1870	=item $popup->add_toggle ($text, $initial_value, $cb)
1442		1871
1443	Adds a toggle/checkbox item to the popup. Teh callback gets called	1872	Adds a toggle/checkbox item to the popup. The callback gets called
1444	whenever it gets toggled, with a boolean indicating its value as its first	1873	whenever it gets toggled, with a boolean indicating its new value as its
1445	argument.	1874	first argument.
1446		1875
1447	=cut	1876	=cut
1448		1877
1449	sub add_toggle {	1878	sub add_toggle {
1450	my ($self, $text, $cb, $value) = @_;	1879	my ($self, $text, $value, $cb) = @_;
1451		1880
1452	my $item; $item = {	1881	my $item; $item = {
1453	type => "button",	1882	type => "button",
1454	text => " $text",	1883	text => " $text",
1455	value => $value,	1884	value => $value,
…		…
1474	my $env = $self->{term}->env;	1903	my $env = $self->{term}->env;
1475	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1904	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1476	delete $env->{LC_ALL};	1905	delete $env->{LC_ALL};
1477	$env->{LC_CTYPE} = $self->{term}->locale;	1906	$env->{LC_CTYPE} = $self->{term}->locale;
1478		1907
1479	urxvt::term->new ($env, $self->{term}->resource ("name"),	1908	urxvt::term->new ($env, "popup",
1480	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1909	"--perl-lib" => "", "--perl-ext-common" => "",
		1910	"-pty-fd" => -1, "-sl" => 0,
		1911	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1481	"--transient-for" => $self->{term}->parent,	1912	"--transient-for" => $self->{term}->parent,
1482	"-display" => $self->{term}->display_id,	1913	"-display" => $self->{term}->display_id,
1483	"-pe" => "urxvt-popup")	1914	"-pe" => "urxvt-popup")
1484	or die "unable to create popup window\n";	1915	or die "unable to create popup window\n";
1485	}	1916	}
…		…
1490	delete $self->{term}{_destroy}{$self};	1921	delete $self->{term}{_destroy}{$self};
1491	$self->{term}->ungrab;	1922	$self->{term}->ungrab;
1492	}	1923	}
1493		1924
1494	=back	1925	=back
		1926
		1927	=cut
		1928
		1929	package urxvt::watcher;
		1930
		1931	@urxvt::timer::ISA = __PACKAGE__;
		1932	@urxvt::iow::ISA = __PACKAGE__;
		1933	@urxvt::pw::ISA = __PACKAGE__;
		1934	@urxvt::iw::ISA = __PACKAGE__;
1495		1935
1496	=head2 The C<urxvt::timer> Class	1936	=head2 The C<urxvt::timer> Class
1497		1937
1498	This class implements timer watchers/events. Time is represented as a	1938	This class implements timer watchers/events. Time is represented as a
1499	fractional number of seconds since the epoch. Example:	1939	fractional number of seconds since the epoch. Example:
…		…
1537	Start the timer.	1977	Start the timer.
1538		1978
1539	=item $timer = $timer->start ($tstamp)	1979	=item $timer = $timer->start ($tstamp)
1540		1980
1541	Set the event trigger time to C<$tstamp> and start the timer.	1981	Set the event trigger time to C<$tstamp> and start the timer.
		1982
		1983	=item $timer = $timer->after ($delay)
		1984
		1985	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1542		1986
1543	=item $timer = $timer->stop	1987	=item $timer = $timer->stop
1544		1988
1545	Stop the timer.	1989	Stop the timer.
1546		1990
…		…
1593		2037
1594	Stop watching for events on the given filehandle.	2038	Stop watching for events on the given filehandle.
1595		2039
1596	=back	2040	=back
1597		2041
		2042	=head2 The C<urxvt::iw> Class
		2043
		2044	This class implements idle watchers, that get called automatically when
		2045	the process is idle. They should return as fast as possible, after doing
		2046	some useful work.
		2047
		2048	=over 4
		2049
		2050	=item $iw = new urxvt::iw
		2051
		2052	Create a new idle watcher object in stopped state.
		2053
		2054	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2055
		2056	Set the callback to be called when the watcher triggers.
		2057
		2058	=item $timer = $timer->start
		2059
		2060	Start the watcher.
		2061
		2062	=item $timer = $timer->stop
		2063
		2064	Stop the watcher.
		2065
		2066	=back
		2067
		2068	=head2 The C<urxvt::pw> Class
		2069
		2070	This class implements process watchers. They create an event whenever a
		2071	process exits, after which they stop automatically.
		2072
		2073	my $pid = fork;
		2074	...
		2075	$term->{pw} = urxvt::pw
		2076	->new
		2077	->start ($pid)
		2078	->cb (sub {
		2079	my ($pw, $exit_status) = @_;
		2080	...
		2081	});
		2082
		2083	=over 4
		2084
		2085	=item $pw = new urxvt::pw
		2086
		2087	Create a new process watcher in stopped state.
		2088
		2089	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2090
		2091	Set the callback to be called when the timer triggers.
		2092
		2093	=item $pw = $timer->start ($pid)
		2094
		2095	Tells the wqtcher to start watching for process C<$pid>.
		2096
		2097	=item $pw = $pw->stop
		2098
		2099	Stop the watcher.
		2100
		2101	=back
		2102
1598	=head1 ENVIRONMENT	2103	=head1 ENVIRONMENT
1599		2104
1600	=head2 URXVT_PERL_VERBOSITY	2105	=head2 URXVT_PERL_VERBOSITY
1601		2106
1602	This variable controls the verbosity level of the perl extension. Higher	2107	This variable controls the verbosity level of the perl extension. Higher

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.87 by root, Thu Jan 12 05:37:34 2006 UTC vs. Revision 1.143 by root, Thu Jul 6 23:48:11 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.87 by root, Thu Jan 12 05:37:34 2006 UTC vs.
Revision 1.143 by root, Thu Jul 6 23:48:11 2006 UTC