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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.95 by elmex, Tue Jan 17 13:19:45 2006 UTC vs.
Revision 1.146 by root, Thu Aug 17 21:56:11 2006 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
…		…
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
…		…
58	URxvt.selection.pattern-1: perl-regex	62	URxvt.selection.pattern-1: perl-regex
59	...	63	...
60		64
61	The index number (0, 1...) must not have any holes, and each regex must	65	The index number (0, 1...) must not have any holes, and each regex must
62	contain at least one pair of capturing parentheses, which will be used for	66	contain at least one pair of capturing parentheses, which will be used for
63	the match. For example, the followign adds a regex that matches everything	67	the match. For example, the following adds a regex that matches everything
64	between two vertical bars:	68	between two vertical bars:
65		69
66	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|	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: ^(/[^:]+):\
67		78
68	You can look at the source of the selection extension to see more	79	You can look at the source of the selection extension to see more
69	interesting uses, such as parsing a line from beginning to end.	80	interesting uses, such as parsing a line from beginning to end.
70		81
71	This extension also offers following bindable keyboard commands:	82	This extension also offers following bindable keyboard commands:
…		…
76		87
77	Rot-13 the selection when activated. Used via keyboard trigger:	88	Rot-13 the selection when activated. Used via keyboard trigger:
78		89
79	URxvt.keysym.C-M-r: perl:selection:rot13	90	URxvt.keysym.C-M-r: perl:selection:rot13
80		91
81	=item remote-pastebin
82
83	Upload the selection as textfile to a remote site.
84
85	URxvt.keysym.C-M-e: perl:selection:remote-pastebin
86
87	To set the command to upload the file set this resource:
88
89	URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
90
91	The % is the placeholder for the textfile. The name of the textfile is the hex encoded
92	md5 sum of the selection.
93	After an successful upload the selection will be replaced by the following url
94	(the % is the placeholder for the filename):
95
96	URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/%
97
98	=back	92	=back
99		93
100	=item option-popup (enabled by default)	94	=item option-popup (enabled by default)
101		95
102	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
103	runtime.	97	runtime.
104		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
105	=item selection-popup (enabled by default)	116	=item selection-popup (enabled by default)
106		117
107	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
108	text into various other formats/action (such as uri unescaping, perl	119	text into various other formats/action (such as uri unescaping, perl
109	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 whether 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	};
110		140
111	=item searchable-scrollback<hotkey> (enabled by default)	141	=item searchable-scrollback<hotkey> (enabled by default)
112		142
113	Adds regex search functionality to the scrollback buffer, triggered	143	Adds regex search functionality to the scrollback buffer, triggered
114	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
…		…
121	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
122	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
123	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
124	selection.	154	selection.
125		155
		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.
		159
		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
126	=item selection-autotransform	187	=item selection-autotransform
127		188
128	This selection allows you to do automatic transforms on a selection	189	This selection allows you to do automatic transforms on a selection
129	whenever a selection is made.	190	whenever a selection is made.
130		191
…		…
142	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	203	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
143		204
144	And this example matches the same,but replaces it with vi-commands you can	205	And this example matches the same,but replaces it with vi-commands you can
145	paste directly into your (vi :) editor:	206	paste directly into your (vi :) editor:
146		207
147	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	208	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
148		209
149	Of course, this can be modified to suit your needs and your editor :)	210	Of course, this can be modified to suit your needs and your editor :)
150		211
151	To expand the example above to typical perl error messages ("XXX at	212	To expand the example above to typical perl error messages ("XXX at
152	FILENAME line YYY."), you need a slightly more elaborate solution:	213	FILENAME line YYY."), you need a slightly more elaborate solution:
153		214
154	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	215	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
155	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/	216	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
156		217
157	The first line tells the selection code to treat the unchanging part of	218	The first line tells the selection code to treat the unchanging part of
158	every error message as a selection pattern, and the second line transforms	219	every error message as a selection pattern, and the second line transforms
159	the message into vi commands to load the file.	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 referred 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.
160		244
161	=item mark-urls	245	=item mark-urls
162		246
163	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
164	make them clickable. When middle-clicked, the program specified in the	248	make them clickable. When middle-clicked, the program specified in the
165	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
166	the URL as first argument.	250	the URL as first argument.
167		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 modifiers, 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. Example:
		289
		290	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
		291
168	=item block-graphics-to-ascii	292	=item block-graphics-to-ascii
169		293
170	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
171	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
172	similar-looking ascii character.	296	similar-looking ascii character.
173		297
174	=item digital-clock	298	=item digital-clock
175		299
176	Displays a digital clock using the built-in overlay.	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/%
		350
		351	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		352	the double C</> characters as comment start. Use C<\057\057> instead,
		353	which works regardless of wether xrdb is used to parse the resource file
		354	or not.
177		355
178	=item example-refresh-hooks	356	=item example-refresh-hooks
179		357
180	Displays a very simple digital clock in the upper right corner of the	358	Displays a very simple digital clock in the upper right corner of the
181	window. Illustrates overwriting the refresh callbacks to create your own	359	window. Illustrates overwriting the refresh callbacks to create your own
…		…
221		399
222	=back	400	=back
223		401
224	=head2 Extension Objects	402	=head2 Extension Objects
225		403
226	Very perl extension is a perl class. A separate perl object is created	404	Every perl extension is a perl class. A separate perl object is created
227	for each terminal and each extension and passed as the first parameter to	405	for each terminal, and each terminal has its own set of extenion objects,
228	hooks. So extensions can use their C<$self> object without having to think	406	which are passed as the first parameter to hooks. So extensions can use
229	about other extensions, with the exception of methods and members that	407	their C<$self> object without having to think about clashes with other
		408	extensions or other terminals, with the exception of methods and members
230	begin with an underscore character C<_>: these are reserved for internal	409	that begin with an underscore character C<_>: these are reserved for
231	use.	410	internal use.
232		411
233	Although it isn't a C<urxvt::term> object, you can call all methods of the	412	Although it isn't a C<urxvt::term> object, you can call all methods of the
234	C<urxvt::term> class on this object.	413	C<urxvt::term> class on this object.
235		414
236	It has the following methods and data members:	415	It has the following methods and data members:
…		…
257	=head2 Hooks	436	=head2 Hooks
258		437
259	The following subroutines can be declared in extension files, and will be	438	The following subroutines can be declared in extension files, and will be
260	called whenever the relevant event happens.	439	called whenever the relevant event happens.
261		440
262	The first argument passed to them is an extension oject as described in	441	The first argument passed to them is an extension object as described in
263	the in the C<Extension Objects> section.	442	the in the C<Extension Objects> section.
264		443
265	B<All> of these hooks must return a boolean value. If it is true, then the	444	B<All> of these hooks must return a boolean value. If any of the called
266	event counts as being I<consumed>, and the invocation of other hooks is	445	hooks returns true, then the event counts as being I<consumed>, and the
267	skipped, and the relevant action might not be carried out by the C++ code.	446	relevant action might not be carried out by the C++ code.
268		447
269	I<< When in doubt, return a false value (preferably C<()>). >>	448	I<< When in doubt, return a false value (preferably C<()>). >>
270		449
271	=over 4	450	=over 4
272		451
273	=item on_init $term	452	=item on_init $term
274		453
275	Called after a new terminal object has been initialized, but before	454	Called after a new terminal object has been initialized, but before
276	windows are created or the command gets run. Most methods are unsafe to	455	windows are created or the command gets run. Most methods are unsafe to
277	call or deliver senseless data, as terminal size and other characteristics	456	call or deliver senseless data, as terminal size and other characteristics
278	have not yet been determined. You can safely query and change resources,	457	have not yet been determined. You can safely query and change resources
279	though.	458	and options, though. For many purposes the C<on_start> hook is a better
		459	place.
		460
		461	=item on_start $term
		462
		463	Called at the very end of initialisation of a new terminal, just before
		464	trying to map (display) the toplevel and returning to the main loop.
		465
		466	=item on_destroy $term
		467
		468	Called whenever something tries to destroy terminal, when the terminal is
		469	still fully functional (not for long, though).
280		470
281	=item on_reset $term	471	=item on_reset $term
282		472
283	Called after the screen is "reset" for any reason, such as resizing or	473	Called after the screen is "reset" for any reason, such as resizing or
284	control sequences. Here is where you can react on changes to size-related	474	control sequences. Here is where you can react on changes to size-related
285	variables.	475	variables.
286		476
287	=item on_start $term	477	=item on_child_start $term, $pid
288		478
289	Called at the very end of initialisation of a new terminal, just before	479	Called just after the child process has been C<fork>ed.
290	returning to the mainloop.	480
		481	=item on_child_exit $term, $status
		482
		483	Called just after the child process has exited. C<$status> is the status
		484	from C<waitpid>.
291		485
292	=item on_sel_make $term, $eventtime	486	=item on_sel_make $term, $eventtime
293		487
294	Called whenever a selection has been made by the user, but before the	488	Called whenever a selection has been made by the user, but before the
295	selection text is copied, so changes to the beginning, end or type of the	489	selection text is copied, so changes to the beginning, end or type of the
…		…
302		496
303	Called whenever a selection has been copied, but before the selection is	497	Called whenever a selection has been copied, but before the selection is
304	requested from the server. The selection text can be queried and changed	498	requested from the server. The selection text can be queried and changed
305	by calling C<< $term->selection >>.	499	by calling C<< $term->selection >>.
306		500
307	Returning a true value aborts selection grabbing. It will still be hilighted.	501	Returning a true value aborts selection grabbing. It will still be highlighted.
308		502
309	=item on_sel_extend $term	503	=item on_sel_extend $term
310		504
311	Called whenever the user tries to extend the selection (e.g. with a double	505	Called whenever the user tries to extend the selection (e.g. with a double
312	click) and is either supposed to return false (normal operation), or	506	click) and is either supposed to return false (normal operation), or
313	should extend the selection itelf and return true to suppress the built-in	507	should extend the selection itself and return true to suppress the built-in
314	processing. This can happen multiple times, as long as the callback	508	processing. This can happen multiple times, as long as the callback
315	returns true, it will be called on every further click by the user and is	509	returns true, it will be called on every further click by the user and is
316	supposed to enlarge the selection more and more, if possible.	510	supposed to enlarge the selection more and more, if possible.
317		511
318	See the F<selection> example extension.	512	See the F<selection> example extension.
319		513
320	=item on_view_change $term, $offset	514	=item on_view_change $term, $offset
321		515
322	Called whenever the view offset changes, i..e the user or program	516	Called whenever the view offset changes, i.e. the user or program
323	scrolls. Offset C<0> means display the normal terminal, positive values	517	scrolls. Offset C<0> means display the normal terminal, positive values
324	show this many lines of scrollback.	518	show this many lines of scrollback.
325		519
326	=item on_scroll_back $term, $lines, $saved	520	=item on_scroll_back $term, $lines, $saved
327		521
…		…
331		525
332	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	526	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
333	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	527	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
334	number of lines that will be in the scrollback buffer.	528	number of lines that will be in the scrollback buffer.
335		529
		530	=item on_osc_seq $term, $op, $args
		531
		532	Called on every OSC sequence and can be used to suppress it or modify its
		533	behaviour. The default should be to return an empty list. A true value
		534	suppresses execution of the request completely. Make sure you don't get
		535	confused by recursive invocations when you output an osc sequence within
		536	this callback.
		537
		538	C<on_osc_seq_perl> should be used for new behaviour.
		539
336	=item on_osc_seq $term, $string	540	=item on_osc_seq_perl $term, $string
337		541
338	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	542	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
339	operating system command) is processed. Cursor position and other state	543	operating system command) is processed. Cursor position and other state
340	information is up-to-date when this happens. For interoperability, the	544	information is up-to-date when this happens. For interoperability, the
341	string should start with the extension name and a colon, to distinguish	545	string should start with the extension name and a colon, to distinguish
342	it from commands for other extensions, and this might be enforced in the	546	it from commands for other extensions, and this might be enforced in the
343	future.	547	future.
344		548
345	Be careful not ever to trust (in a security sense) the data you receive,	549	Be careful not ever to trust (in a security sense) the data you receive,
346	as its source can not easily be controleld (e-mail content, messages from	550	as its source can not easily be controlled (e-mail content, messages from
347	other users on the same system etc.).	551	other users on the same system etc.).
348		552
349	=item on_add_lines $term, $string	553	=item on_add_lines $term, $string
350		554
351	Called whenever text is about to be output, with the text as argument. You	555	Called whenever text is about to be output, with the text as argument. You
…		…
382		586
383	=item on_refresh_end $term	587	=item on_refresh_end $term
384		588
385	Called just after the screen gets redrawn. See C<on_refresh_begin>.	589	Called just after the screen gets redrawn. See C<on_refresh_begin>.
386		590
387	=item on_keyboard_command $term, $string	591	=item on_user_command $term, $string
388		592
389	Called whenever the user presses a key combination that has a	593	Called whenever a user-configured event is being activated (e.g. via
390	C<perl:string> action bound to it (see description of the B<keysym>	594	a C<perl:string> action bound to a key, see description of the B<keysym>
391	resource in the @@RXVT_NAME@@(1) manpage).	595	resource in the @@RXVT_NAME@@(1) manpage).
		596
		597	The event is simply the action string. This interface is assumed to change
		598	slightly in the future.
		599
		600	=item on_resize_all_windows $tern, $new_width, $new_height
		601
		602	Called just after the new window size has been calculated, but before
		603	windows are actually being resized or hints are being set. If this hook
		604	returns TRUE, setting of the window hints is being skipped.
392		605
393	=item on_x_event $term, $event	606	=item on_x_event $term, $event
394		607
395	Called on every X event received on the vt window (and possibly other	608	Called on every X event received on the vt window (and possibly other
396	windows). Should only be used as a last resort. Most event structure	609	windows). Should only be used as a last resort. Most event structure
397	members are not passed.	610	members are not passed.
398		611
		612	=item on_root_event $term, $event
		613
		614	Like C<on_x_event>, but is called for events on the root window.
		615
399	=item on_focus_in $term	616	=item on_focus_in $term
400		617
401	Called whenever the window gets the keyboard focus, before rxvt-unicode	618	Called whenever the window gets the keyboard focus, before rxvt-unicode
402	does focus in processing.	619	does focus in processing.
403		620
404	=item on_focus_out $term	621	=item on_focus_out $term
405		622
406	Called wheneever the window loses keyboard focus, before rxvt-unicode does	623	Called whenever the window loses keyboard focus, before rxvt-unicode does
407	focus out processing.	624	focus out processing.
		625
		626	=item on_configure_notify $term, $event
		627
		628	=item on_property_notify $term, $event
408		629
409	=item on_key_press $term, $event, $keysym, $octets	630	=item on_key_press $term, $event, $keysym, $octets
410		631
411	=item on_key_release $term, $event, $keysym	632	=item on_key_release $term, $event, $keysym
412		633
…		…
422		643
423	Called whenever the corresponding X event is received for the terminal If	644	Called whenever the corresponding X event is received for the terminal If
424	the hook returns true, then the even will be ignored by rxvt-unicode.	645	the hook returns true, then the even will be ignored by rxvt-unicode.
425		646
426	The event is a hash with most values as named by Xlib (see the XEvent	647	The event is a hash with most values as named by Xlib (see the XEvent
427	manpage), with the additional members C<row> and C<col>, which are the row	648	manpage), with the additional members C<row> and C<col>, which are the
428	and column under the mouse cursor.	649	(real, not screen-based) row and column under the mouse cursor.
429		650
430	C<on_key_press> additionally receives the string rxvt-unicode would	651	C<on_key_press> additionally receives the string rxvt-unicode would
431	output, if any, in locale-specific encoding.	652	output, if any, in locale-specific encoding.
432		653
433	subwindow.	654	subwindow.
		655
		656	=item on_client_message $term, $event
		657
		658	=item on_wm_protocols $term, $event
		659
		660	=item on_wm_delete_window $term, $event
		661
		662	Called when various types of ClientMessage events are received (all with
		663	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
434		664
435	=back	665	=back
436		666
437	=cut	667	=cut
438		668
…		…
444	use Scalar::Util ();	674	use Scalar::Util ();
445	use List::Util ();	675	use List::Util ();
446		676
447	our $VERSION = 1;	677	our $VERSION = 1;
448	our $TERM;	678	our $TERM;
		679	our @TERM_INIT;
		680	our @TERM_EXT;
449	our @HOOKNAME;	681	our @HOOKNAME;
450	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	682	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
451	our %OPTION;	683	our %OPTION;
452		684
453	our $LIBDIR;	685	our $LIBDIR;
454	our $RESNAME;	686	our $RESNAME;
455	our $RESCLASS;	687	our $RESCLASS;
456	our $RXVTNAME;	688	our $RXVTNAME;
457		689
		690	our $NOCHAR = chr 0xffff;
		691
458	=head2 Variables in the C<urxvt> Package	692	=head2 Variables in the C<urxvt> Package
459		693
460	=over 4	694	=over 4
461		695
462	=item $urxvt::LIBDIR	696	=item $urxvt::LIBDIR
…		…
474		708
475	=item $urxvt::TERM	709	=item $urxvt::TERM
476		710
477	The current terminal. This variable stores the current C<urxvt::term>	711	The current terminal. This variable stores the current C<urxvt::term>
478	object, whenever a callback/hook is executing.	712	object, whenever a callback/hook is executing.
		713
		714	=item @urxvt::TERM_INIT
		715
		716	All code references in this array will be called as methods of the next newly
		717	created C<urxvt::term> object (during the C<on_init> phase). The array
		718	gets cleared before the code references that were in it are being executed,
		719	so references can push themselves onto it again if they so desire.
		720
		721	This complements to the perl-eval command line option, but gets executed
		722	first.
		723
		724	=item @urxvt::TERM_EXT
		725
		726	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		727	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		728	but before other extensions. Gets cleared just like C<@TERM_INIT>.
479		729
480	=back	730	=back
481		731
482	=head2 Functions in the C<urxvt> Package	732	=head2 Functions in the C<urxvt> Package
483		733
…		…
498	Using this function has the advantage that its output ends up in the	748	Using this function has the advantage that its output ends up in the
499	correct place, e.g. on stderr of the connecting urxvtc client.	749	correct place, e.g. on stderr of the connecting urxvtc client.
500		750
501	Messages have a size limit of 1023 bytes currently.	751	Messages have a size limit of 1023 bytes currently.
502		752
503	=item $is_safe = urxvt::safe	753	=item @terms = urxvt::termlist
504		754
505	Returns true when it is safe to do potentially unsafe things, such as	755	Returns all urxvt::term objects that exist in this process, regardless of
506	evaluating perl code specified by the user. This is true when urxvt was	756	whether they are started, being destroyed etc., so be careful. Only term
507	started setuid or setgid.	757	objects that have perl extensions attached will be returned (because there
		758	is no urxvt::term objet associated with others).
508		759
509	=item $time = urxvt::NOW	760	=item $time = urxvt::NOW
510		761
511	Returns the "current time" (as per the event loop).	762	Returns the "current time" (as per the event loop).
512		763
…		…
571		822
572	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	823	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
573		824
574	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	825	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
575		826
		827	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		828
576	Replace the foreground/background colour in the rendition mask with the	829	Replace the foreground/background colour in the rendition mask with the
577	specified one.	830	specified one.
578		831
579	=item $value = urxvt::GET_CUSTOM $rend	832	=item $value = urxvt::GET_CUSTOM $rend
580		833
…		…
589	=back	842	=back
590		843
591	=cut	844	=cut
592		845
593	BEGIN {	846	BEGIN {
594	urxvt->bootstrap;
595
596	# overwrite perl's warn	847	# overwrite perl's warn
597	*CORE::GLOBAL::warn = sub {	848	*CORE::GLOBAL::warn = sub {
598	my $msg = join "", @_;	849	my $msg = join "", @_;
599	$msg .= "\n"	850	$msg .= "\n"
600	unless $msg =~ /\n$/;	851	unless $msg =~ /\n$/;
601	urxvt::warn ($msg);	852	urxvt::warn ($msg);
602	};	853	};
603
604	# %ENV is the original startup environment
605	delete $ENV{IFS};
606	delete $ENV{CDPATH};
607	delete $ENV{BASH_ENV};
608	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
609	}	854	}
		855
		856	no warnings 'utf8';
610		857
611	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	858	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
612		859
613	sub verbose {	860	sub verbose {
614	my ($level, $msg) = @_;	861	my ($level, $msg) = @_;
615	warn "$msg\n" if $level <= $verbosity;	862	warn "$msg\n" if $level <= $verbosity;
616	}	863	}
617		864
618	my $extension_pkg = "extension0000";
619	my %extension_pkg;	865	my %extension_pkg;
620		866
621	# load a single script into its own package, once only	867	# load a single script into its own package, once only
622	sub extension_package($) {	868	sub extension_package($) {
623	my ($path) = @_;	869	my ($path) = @_;
624		870
625	$extension_pkg{$path} \|\|= do {	871	$extension_pkg{$path} \|\|= do {
626	my $pkg = "urxvt::" . ($extension_pkg++);	872	$path =~ /([^\/\\]+)$/;
		873	my $pkg = $1;
		874	$pkg =~ s/[^[:word:]]/_/g;
		875	$pkg = "urxvt::ext::$pkg";
627		876
628	verbose 3, "loading extension '$path' into package '$pkg'";	877	verbose 3, "loading extension '$path' into package '$pkg'";
629		878
630	open my $fh, "<:raw", $path	879	open my $fh, "<:raw", $path
631	or die "$path: $!";	880	or die "$path: $!";
632		881
633	my $source = untaint	882	my $source =
634	"package $pkg; use strict; use utf8;\n"	883	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
635	. "use base urxvt::term::extension::;\n"
636	. "#line 1 \"$path\"\n{\n"	884	. "#line 1 \"$path\"\n{\n"
637	. (do { local $/; <$fh> })	885	. (do { local $/; <$fh> })
638	. "\n};\n1";	886	. "\n};\n1";
639		887
640	eval $source	888	eval $source
…		…
654	if ($htype == 0) { # INIT	902	if ($htype == 0) { # INIT
655	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	903	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
656		904
657	my %ext_arg;	905	my %ext_arg;
658		906
		907	{
		908	my @init = @TERM_INIT;
		909	@TERM_INIT = ();
		910	$_->($TERM) for @init;
		911	my @pkg = @TERM_EXT;
		912	@TERM_EXT = ();
		913	$TERM->register_package ($_) for @pkg;
		914	}
		915
659	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	916	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
660	if ($_ eq "default") {	917	if ($_ eq "default") {
661	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	918	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
662	} elsif (/^-(.*)$/) {	919	} elsif (/^-(.*)$/) {
663	delete $ext_arg{$1};	920	delete $ext_arg{$1};
664	} elsif (/^([^<]+)<(.*)>$/) {	921	} elsif (/^([^<]+)<(.*)>$/) {
665	push @{ $ext_arg{$1} }, $2;	922	push @{ $ext_arg{$1} }, $2;
666	} else {	923	} else {
667	$ext_arg{$_} \|\|= [];	924	$ext_arg{$_} \|\|= [];
668	}	925	}
669	}	926	}
670		927
671	while (my ($ext, $argv) = each %ext_arg) {	928	for my $ext (sort keys %ext_arg) {
672	my @files = grep -f $_, map "$_/$ext", @dirs;	929	my @files = grep -f $_, map "$_/$ext", @dirs;
673		930
674	if (@files) {	931	if (@files) {
675	$TERM->register_package (extension_package $files[0], $argv);	932	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
676	} else {	933	} else {
677	warn "perl extension '$ext' not found in perl library search path\n";	934	warn "perl extension '$ext' not found in perl library search path\n";
678	}	935	}
679	}	936	}
680		937
…		…
686		943
687	if (my $cb = $TERM->{_hook}[$htype]) {	944	if (my $cb = $TERM->{_hook}[$htype]) {
688	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	945	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
689	if $verbosity >= 10;	946	if $verbosity >= 10;
690		947
691	keys %$cb;	948	for my $pkg (keys %$cb) {
692
693	while (my ($pkg, $cb) = each %$cb) {
694	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	949	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
695	and last;	950	$retval \|\|= $retval_;
696		951
697	if ($@) {	952	if ($@) {
698	$TERM->ungrab; # better to lose the grab than the session	953	$TERM->ungrab; # better to lose the grab than the session
699	warn $@;	954	warn $@;
700	}	955	}
…		…
713	}	968	}
714		969
715	$retval	970	$retval
716	}	971	}
717		972
718	sub exec_async(@) {	973	sub SET_COLOR($$$) {
719	my $pid = fork;	974	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
720
721	return
722	if !defined $pid or $pid;
723
724	%ENV = %{ $TERM->env };
725
726	exec @_;
727	_exit 255;
728	}	975	}
729		976
730	# urxvt::term::extension	977	# urxvt::term::extension
731		978
732	package urxvt::term::extension;	979	package urxvt::term::extension;
…		…
871	# find on_xxx subs in the package and register them	1118	# find on_xxx subs in the package and register them
872	# as hooks	1119	# as hooks
873	sub register_package {	1120	sub register_package {
874	my ($self, $pkg, $argv) = @_;	1121	my ($self, $pkg, $argv) = @_;
875		1122
		1123	no strict 'refs';
		1124
		1125	urxvt::verbose 6, "register package $pkg to $self";
		1126
		1127	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1128
876	my $proxy = bless {	1129	my $proxy = bless {
877	_pkg => $pkg,	1130	_pkg => $pkg,
878	argv => $argv,	1131	argv => $argv,
879	}, $pkg;	1132	}, $pkg;
880	Scalar::Util::weaken ($proxy->{term} = $self);	1133	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
895	hash which defines the environment of the new terminal.	1148	hash which defines the environment of the new terminal.
896		1149
897	Croaks (and probably outputs an error message) if the new instance	1150	Croaks (and probably outputs an error message) if the new instance
898	couldn't be created. Returns C<undef> if the new instance didn't	1151	couldn't be created. Returns C<undef> if the new instance didn't
899	initialise perl, and the terminal object otherwise. The C<init> and	1152	initialise perl, and the terminal object otherwise. The C<init> and
900	C<start> hooks will be called during this call.	1153	C<start> hooks will be called before this call returns, and are free to
		1154	refer to global data (which is race free).
901		1155
902	=cut	1156	=cut
903		1157
904	sub new {	1158	sub new {
905	my ($class, $env, @args) = @_;	1159	my ($class, $env, @args) = @_;
906		1160
		1161	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1162	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1163
907	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1164	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
908	}	1165	}
909		1166
910	=item $term->destroy	1167	=item $term->destroy
911		1168
912	Destroy the terminal object (close the window, free resources	1169	Destroy the terminal object (close the window, free resources
913	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1170	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
914	watchers (timers, io watchers) are still active.	1171	watchers (timers, io watchers) are still active.
915		1172
		1173	=item $term->exec_async ($cmd[, @args])
		1174
		1175	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1176	("starts") programs in the background. This function takes care of setting
		1177	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1178	be preferred over explicit calls to C<exec> or C<system>.
		1179
		1180	Returns the pid of the subprocess or C<undef> on error.
		1181
		1182	=cut
		1183
		1184	sub exec_async {
		1185	my $self = shift;
		1186
		1187	my $pid = fork;
		1188
		1189	return $pid
		1190	if !defined $pid or $pid;
		1191
		1192	%ENV = %{ $self->env };
		1193
		1194	exec @_;
		1195	urxvt::_exit 255;
		1196	}
		1197
916	=item $isset = $term->option ($optval[, $set])	1198	=item $isset = $term->option ($optval[, $set])
917		1199
918	Returns true if the option specified by C<$optval> is enabled, and	1200	Returns true if the option specified by C<$optval> is enabled, and
919	optionally change it. All option values are stored by name in the hash	1201	optionally change it. All option values are stored by name in the hash
920	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1202	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
921		1203
922	Here is a a likely non-exhaustive list of option names, please see the	1204	Here is a likely non-exhaustive list of option names, please see the
923	source file F</src/optinc.h> to see the actual list:	1205	source file F</src/optinc.h> to see the actual list:
924		1206
925	borderLess console cursorBlink cursorUnderline hold iconic insecure	1207	borderLess console cursorBlink cursorUnderline hold iconic insecure
926	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1208	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
927	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1209	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
928	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1210	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
929	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1211	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
930	tripleclickwords utmpInhibit visualBell	1212	transparent tripleclickwords utmpInhibit visualBell
931		1213
932	=item $value = $term->resource ($name[, $newval])	1214	=item $value = $term->resource ($name[, $newval])
933		1215
934	Returns the current resource value associated with a given name and	1216	Returns the current resource value associated with a given name and
935	optionally sets a new value. Setting values is most useful in the C<init>	1217	optionally sets a new value. Setting values is most useful in the C<init>
…		…
944	likely change).	1226	likely change).
945		1227
946	Please note that resource strings will currently only be freed when the	1228	Please note that resource strings will currently only be freed when the
947	terminal is destroyed, so changing options frequently will eat memory.	1229	terminal is destroyed, so changing options frequently will eat memory.
948		1230
949	Here is a a likely non-exhaustive list of resource names, not all of which	1231	Here is a likely non-exhaustive list of resource names, not all of which
950	are supported in every build, please see the source file F</src/rsinc.h>	1232	are supported in every build, please see the source file F</src/rsinc.h>
951	to see the actual list:	1233	to see the actual list:
952		1234
953	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1235	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
954	borderLess color cursorBlink cursorUnderline cutchars delete_key	1236	borderLess color cursorBlink cursorUnderline cutchars delete_key
955	display_name embed ext_bwidth fade font geometry hold iconName	1237	display_name embed ext_bwidth fade font geometry hold iconName
956	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1238	imFont imLocale inputMethod insecure int_bwidth intensityStyles
957	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1239	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
958	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1240	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
959	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1241	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
960	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1242	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
961	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1243	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
962	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1244	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
963	shade term_name title transparent transparent_all tripleclickwords	1245	secondaryScreen secondaryScroll selectstyle shade term_name title
964	utmpInhibit visualBell	1246	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1247	visualBell
965		1248
966	=cut	1249	=cut
967		1250
968	sub resource($$;$) {	1251	sub resource($$;$) {
969	my ($self, $name) = (shift, shift);	1252	my ($self, $name) = (shift, shift);
…		…
1143		1426
1144	Normally its not a good idea to use this function, as programs might be	1427	Normally its not a good idea to use this function, as programs might be
1145	confused by changes in cursor position or scrolling. Its useful inside a	1428	confused by changes in cursor position or scrolling. Its useful inside a
1146	C<on_add_lines> hook, though.	1429	C<on_add_lines> hook, though.
1147		1430
		1431	=item $term->scr_change_screen ($screen)
		1432
		1433	Switch to given screen - 0 primary, 1 secondary.
		1434
1148	=item $term->cmd_parse ($octets)	1435	=item $term->cmd_parse ($octets)
1149		1436
1150	Similar to C<scr_add_lines>, but the argument must be in the	1437	Similar to C<scr_add_lines>, but the argument must be in the
1151	locale-specific encoding of the terminal and can contain command sequences	1438	locale-specific encoding of the terminal and can contain command sequences
1152	(escape codes) that will be interpreted.	1439	(escape codes) that will be interpreted.
…		…
1162	Replaces the event mask of the pty watcher by the given event mask. Can	1449	Replaces the event mask of the pty watcher by the given event mask. Can
1163	be used to suppress input and output handling to the pty/tty. See the	1450	be used to suppress input and output handling to the pty/tty. See the
1164	description of C<< urxvt::timer->events >>. Make sure to always restore	1451	description of C<< urxvt::timer->events >>. Make sure to always restore
1165	the previous value.	1452	the previous value.
1166		1453
		1454	=item $fd = $term->pty_fd
		1455
		1456	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1457	is used.
		1458
1167	=item $windowid = $term->parent	1459	=item $windowid = $term->parent
1168		1460
1169	Return the window id of the toplevel window.	1461	Return the window id of the toplevel window.
1170		1462
1171	=item $windowid = $term->vt	1463	=item $windowid = $term->vt
…		…
1177	Adds the specified events to the vt event mask. Useful e.g. when you want	1469	Adds the specified events to the vt event mask. Useful e.g. when you want
1178	to receive pointer events all the times:	1470	to receive pointer events all the times:
1179		1471
1180	$term->vt_emask_add (urxvt::PointerMotionMask);	1472	$term->vt_emask_add (urxvt::PointerMotionMask);
1181		1473
		1474	=item $term->focus_in
		1475
		1476	=item $term->focus_out
		1477
		1478	=item $term->key_press ($state, $keycode[, $time])
		1479
		1480	=item $term->key_release ($state, $keycode[, $time])
		1481
		1482	Deliver various fake events to to terminal.
		1483
1182	=item $window_width = $term->width	1484	=item $window_width = $term->width
1183		1485
1184	=item $window_height = $term->height	1486	=item $window_height = $term->height
1185		1487
1186	=item $font_width = $term->fwidth	1488	=item $font_width = $term->fwidth
…		…
1216	=item $env = $term->env	1518	=item $env = $term->env
1217		1519
1218	Returns a copy of the environment in effect for the terminal as a hashref	1520	Returns a copy of the environment in effect for the terminal as a hashref
1219	similar to C<\%ENV>.	1521	similar to C<\%ENV>.
1220		1522
		1523	=item @envv = $term->envv
		1524
		1525	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1526
		1527	=item @argv = $term->argv
		1528
		1529	Return the argument vector as this terminal, similar to @ARGV, but
		1530	includes the program name as first element.
		1531
1221	=cut	1532	=cut
1222		1533
1223	sub env {	1534	sub env {
1224	if (my $env = $_[0]->_env) {
1225	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1535	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1226	} else {
1227	+{ %ENV }
1228	}
1229	}	1536	}
1230		1537
1231	=item $modifiermask = $term->ModLevel3Mask	1538	=item $modifiermask = $term->ModLevel3Mask
1232		1539
1233	=item $modifiermask = $term->ModMetaMask	1540	=item $modifiermask = $term->ModMetaMask
1234		1541
1235	=item $modifiermask = $term->ModNumLockMask	1542	=item $modifiermask = $term->ModNumLockMask
1236		1543
1237	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1544	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1238	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1545	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1546
		1547	=item $screen = $term->current_screen
		1548
		1549	Returns the currently displayed screen (0 primary, 1 secondary).
		1550
		1551	=item $cursor_is_hidden = $term->hidden_cursor
		1552
		1553	Returns whether the cursor is currently hidden or not.
1239		1554
1240	=item $view_start = $term->view_start ([$newvalue])	1555	=item $view_start = $term->view_start ([$newvalue])
1241		1556
1242	Returns the row number of the topmost displayed line. Maximum value is	1557	Returns the row number of the topmost displayed line. Maximum value is
1243	C<0>, which displays the normal terminal contents. Lower values scroll	1558	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1263	line, starting at column C<$start_col> (default C<0>), which is useful	1578	line, starting at column C<$start_col> (default C<0>), which is useful
1264	to replace only parts of a line. The font index in the rendition will	1579	to replace only parts of a line. The font index in the rendition will
1265	automatically be updated.	1580	automatically be updated.
1266		1581
1267	C<$text> is in a special encoding: tabs and wide characters that use more	1582	C<$text> is in a special encoding: tabs and wide characters that use more
1268	than one cell when displayed are padded with urxvt::NOCHAR characters	1583	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1269	(C<chr 65535>). Characters with combining characters and other characters	1584	characters. Characters with combining characters and other characters that
1270	that do not fit into the normal tetx encoding will be replaced with	1585	do not fit into the normal tetx encoding will be replaced with characters
1271	characters in the private use area.	1586	in the private use area.
1272		1587
1273	You have to obey this encoding when changing text. The advantage is	1588	You have to obey this encoding when changing text. The advantage is
1274	that C<substr> and similar functions work on screen cells and not on	1589	that C<substr> and similar functions work on screen cells and not on
1275	characters.	1590	characters.
1276		1591
…		…
1420	where one character corresponds to one screen cell. See	1735	where one character corresponds to one screen cell. See
1421	C<< $term->ROW_t >> for details.	1736	C<< $term->ROW_t >> for details.
1422		1737
1423	=item $string = $term->special_decode $text	1738	=item $string = $term->special_decode $text
1424		1739
1425	Converts rxvt-unicodes text reprsentation into a perl string. See	1740	Converts rxvt-unicodes text representation into a perl string. See
1426	C<< $term->ROW_t >> for details.	1741	C<< $term->ROW_t >> for details.
1427		1742
1428	=item $success = $term->grab_button ($button, $modifiermask)	1743	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1429		1744
		1745	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1746
1430	Registers a synchronous button grab. See the XGrabButton manpage.	1747	Register/unregister a synchronous button grab. See the XGrabButton
		1748	manpage.
1431		1749
1432	=item $success = $term->grab ($eventtime[, $sync])	1750	=item $success = $term->grab ($eventtime[, $sync])
1433		1751
1434	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1752	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1435	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1753	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1436		1754
1437	=item $term->allow_events_async	1755	=item $term->allow_events_async
1438		1756
1439	Calls XAllowEvents with AsyncBoth for the most recent grab.	1757	Calls XAllowEvents with AsyncBoth for the most recent grab.
1440		1758
…		…
1450	=item $term->ungrab	1768	=item $term->ungrab
1451		1769
1452	Calls XUngrab for the most recent grab. Is called automatically on	1770	Calls XUngrab for the most recent grab. Is called automatically on
1453	evaluation errors, as it is better to lose the grab in the error case as	1771	evaluation errors, as it is better to lose the grab in the error case as
1454	the session.	1772	the session.
		1773
		1774	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1775
		1776	=item $atom_name = $term->XGetAtomName ($atom)
		1777
		1778	=item @atoms = $term->XListProperties ($window)
		1779
		1780	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1781
		1782	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1783
		1784	=item $term->XDeleteProperty ($window, $property)
		1785
		1786	=item $window = $term->DefaultRootWindow
		1787
		1788	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1789
		1790	=item $term->XMapWindow ($window)
		1791
		1792	=item $term->XUnmapWindow ($window)
		1793
		1794	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1795
		1796	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1797
		1798	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1799
		1800	Various X or X-related functions. The C<$term> object only serves as
		1801	the source of the display, otherwise those functions map more-or-less
		1802	directory onto the X functions of the same name.
1455		1803
1456	=back	1804	=back
1457		1805
1458	=cut	1806	=cut
1459		1807
…		…
1523	my ($self, $text, $cb) = @_;	1871	my ($self, $text, $cb) = @_;
1524		1872
1525	$self->add_item ({ type => "button", text => $text, activate => $cb});	1873	$self->add_item ({ type => "button", text => $text, activate => $cb});
1526	}	1874	}
1527		1875
1528	=item $popup->add_toggle ($text, $cb, $initial_value)	1876	=item $popup->add_toggle ($text, $initial_value, $cb)
1529		1877
1530	Adds a toggle/checkbox item to the popup. Teh callback gets called	1878	Adds a toggle/checkbox item to the popup. The callback gets called
1531	whenever it gets toggled, with a boolean indicating its value as its first	1879	whenever it gets toggled, with a boolean indicating its new value as its
1532	argument.	1880	first argument.
1533		1881
1534	=cut	1882	=cut
1535		1883
1536	sub add_toggle {	1884	sub add_toggle {
1537	my ($self, $text, $cb, $value) = @_;	1885	my ($self, $text, $value, $cb) = @_;
1538		1886
1539	my $item; $item = {	1887	my $item; $item = {
1540	type => "button",	1888	type => "button",
1541	text => " $text",	1889	text => " $text",
1542	value => $value,	1890	value => $value,
…		…
1561	my $env = $self->{term}->env;	1909	my $env = $self->{term}->env;
1562	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1910	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1563	delete $env->{LC_ALL};	1911	delete $env->{LC_ALL};
1564	$env->{LC_CTYPE} = $self->{term}->locale;	1912	$env->{LC_CTYPE} = $self->{term}->locale;
1565		1913
1566	urxvt::term->new ($env, $self->{term}->resource ("name"),	1914	urxvt::term->new ($env, "popup",
1567	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1915	"--perl-lib" => "", "--perl-ext-common" => "",
		1916	"-pty-fd" => -1, "-sl" => 0,
		1917	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1568	"--transient-for" => $self->{term}->parent,	1918	"--transient-for" => $self->{term}->parent,
1569	"-display" => $self->{term}->display_id,	1919	"-display" => $self->{term}->display_id,
1570	"-pe" => "urxvt-popup")	1920	"-pe" => "urxvt-popup")
1571	or die "unable to create popup window\n";	1921	or die "unable to create popup window\n";
1572	}	1922	}
…		…
1577	delete $self->{term}{_destroy}{$self};	1927	delete $self->{term}{_destroy}{$self};
1578	$self->{term}->ungrab;	1928	$self->{term}->ungrab;
1579	}	1929	}
1580		1930
1581	=back	1931	=back
		1932
		1933	=cut
		1934
		1935	package urxvt::watcher;
		1936
		1937	@urxvt::timer::ISA = __PACKAGE__;
		1938	@urxvt::iow::ISA = __PACKAGE__;
		1939	@urxvt::pw::ISA = __PACKAGE__;
		1940	@urxvt::iw::ISA = __PACKAGE__;
1582		1941
1583	=head2 The C<urxvt::timer> Class	1942	=head2 The C<urxvt::timer> Class
1584		1943
1585	This class implements timer watchers/events. Time is represented as a	1944	This class implements timer watchers/events. Time is represented as a
1586	fractional number of seconds since the epoch. Example:	1945	fractional number of seconds since the epoch. Example:
…		…
1624	Start the timer.	1983	Start the timer.
1625		1984
1626	=item $timer = $timer->start ($tstamp)	1985	=item $timer = $timer->start ($tstamp)
1627		1986
1628	Set the event trigger time to C<$tstamp> and start the timer.	1987	Set the event trigger time to C<$tstamp> and start the timer.
		1988
		1989	=item $timer = $timer->after ($delay)
		1990
		1991	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1629		1992
1630	=item $timer = $timer->stop	1993	=item $timer = $timer->stop
1631		1994
1632	Stop the timer.	1995	Stop the timer.
1633		1996
…		…
1662	Set the callback to be called when io events are triggered. C<$reventmask>	2025	Set the callback to be called when io events are triggered. C<$reventmask>
1663	is a bitset as described in the C<events> method.	2026	is a bitset as described in the C<events> method.
1664		2027
1665	=item $iow = $iow->fd ($fd)	2028	=item $iow = $iow->fd ($fd)
1666		2029
1667	Set the filedescriptor (not handle) to watch.	2030	Set the file descriptor (not handle) to watch.
1668		2031
1669	=item $iow = $iow->events ($eventmask)	2032	=item $iow = $iow->events ($eventmask)
1670		2033
1671	Set the event mask to watch. The only allowed values are	2034	Set the event mask to watch. The only allowed values are
1672	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2035	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
…		…
1676		2039
1677	Start watching for requested events on the given handle.	2040	Start watching for requested events on the given handle.
1678		2041
1679	=item $iow = $iow->stop	2042	=item $iow = $iow->stop
1680		2043
1681	Stop watching for events on the given filehandle.	2044	Stop watching for events on the given file handle.
		2045
		2046	=back
		2047
		2048	=head2 The C<urxvt::iw> Class
		2049
		2050	This class implements idle watchers, that get called automatically when
		2051	the process is idle. They should return as fast as possible, after doing
		2052	some useful work.
		2053
		2054	=over 4
		2055
		2056	=item $iw = new urxvt::iw
		2057
		2058	Create a new idle watcher object in stopped state.
		2059
		2060	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2061
		2062	Set the callback to be called when the watcher triggers.
		2063
		2064	=item $timer = $timer->start
		2065
		2066	Start the watcher.
		2067
		2068	=item $timer = $timer->stop
		2069
		2070	Stop the watcher.
		2071
		2072	=back
		2073
		2074	=head2 The C<urxvt::pw> Class
		2075
		2076	This class implements process watchers. They create an event whenever a
		2077	process exits, after which they stop automatically.
		2078
		2079	my $pid = fork;
		2080	...
		2081	$term->{pw} = urxvt::pw
		2082	->new
		2083	->start ($pid)
		2084	->cb (sub {
		2085	my ($pw, $exit_status) = @_;
		2086	...
		2087	});
		2088
		2089	=over 4
		2090
		2091	=item $pw = new urxvt::pw
		2092
		2093	Create a new process watcher in stopped state.
		2094
		2095	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2096
		2097	Set the callback to be called when the timer triggers.
		2098
		2099	=item $pw = $timer->start ($pid)
		2100
		2101	Tells the watcher to start watching for process C<$pid>.
		2102
		2103	=item $pw = $pw->stop
		2104
		2105	Stop the watcher.
1682		2106
1683	=back	2107	=back
1684		2108
1685	=head1 ENVIRONMENT	2109	=head1 ENVIRONMENT
1686		2110
…		…
1695		2119
1696	=item >= 3 - script loading and management	2120	=item >= 3 - script loading and management
1697		2121
1698	=item >=10 - all called hooks	2122	=item >=10 - all called hooks
1699		2123
1700	=item >=11 - hook reutrn values	2124	=item >=11 - hook return values
1701		2125
1702	=back	2126	=back
1703		2127
1704	=head1 AUTHOR	2128	=head1 AUTHOR
1705		2129

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.95 by elmex, Tue Jan 17 13:19:45 2006 UTC vs. Revision 1.146 by root, Thu Aug 17 21:56:11 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.95 by elmex, Tue Jan 17 13:19:45 2006 UTC vs.
Revision 1.146 by root, Thu Aug 17 21:56:11 2006 UTC