ViewVC Help

View File | Revision Log | Show Annotations | Download File

/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.197 by sf-tpope, Fri Aug 19 23:08:35 2011 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
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
		31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
		33
31	=head1 PREPACKAGED EXTENSIONS	34	=head1 PREPACKAGED EXTENSIONS
32		35
33	This section describes the extensions delivered with this release. You can	36	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
36	You can activate them like this:	39	You can activate them like this:
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
		42
		43	Or by adding them to the resource for extensions loaded by default:
		44
		45	URxvt.perl-ext-common: default,selection-autotransform
39		46
40	=over 4	47	=over 4
41		48
42	=item selection (enabled by default)	49	=item selection (enabled by default)
43		50
…		…
58	URxvt.selection.pattern-1: perl-regex	65	URxvt.selection.pattern-1: perl-regex
59	...	66	...
60		67
61	The index number (0, 1...) must not have any holes, and each regex must	68	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	69	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	70	the match. For example, the following adds a regex that matches everything
64	between two vertical bars:	71	between two vertical bars:
65		72
66	URxvt.selection.pattern-0: \\|([^|]+)\\|	73	URxvt.selection.pattern-0: \\|([^|]+)\\|
		74
		75	Another example: Programs I use often output "absolute path: " at the
		76	beginning of a line when they process multiple files. The following
		77	pattern matches the filename (note, there is a single space at the very
		78	end):
		79
		80	URxvt.selection.pattern-0: ^(/[^:]+):\
67		81
68	You can look at the source of the selection extension to see more	82	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.	83	interesting uses, such as parsing a line from beginning to end.
70		84
71	This extension also offers following bindable keyboard commands:	85	This extension also offers following bindable keyboard commands:
…		…
76		90
77	Rot-13 the selection when activated. Used via keyboard trigger:	91	Rot-13 the selection when activated. Used via keyboard trigger:
78		92
79	URxvt.keysym.C-M-r: perl:selection:rot13	93	URxvt.keysym.C-M-r: perl:selection:rot13
80		94
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	95	=back
99		96
100	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
101		98
102	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at	99	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
103	runtime.	100	runtime.
104		101
		102	Other extensions can extend this popup menu by pushing a code reference
		103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
		104	popup is being displayed.
		105
		106	Its sole argument is the popup menu, which can be modified. It should
		107	either return nothing or a string, the initial boolean value and a code
		108	reference. The string will be used as button text and the code reference
		109	will be called when the toggle changes, with the new boolean value as
		110	first argument.
		111
		112	The following will add an entry C<myoption> that changes
		113	C<< $self->{myoption} >>:
		114
		115	push @{ $self->{term}{option_popup_hook} }, sub {
		116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
		117	};
		118
105	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
106		120
107	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	121	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	122	text into various other formats/action (such as uri unescaping, perl
109	evalution, web-browser starting etc.), depending on content.	123	evaluation, web-browser starting etc.), depending on content.
		124
		125	Other extensions can extend this popup menu by pushing a code reference
		126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
		127	popup is being displayed.
		128
		129	Its sole argument is the popup menu, which can be modified. The selection
		130	is in C<$_>, which can be used to decide whether to add something or not.
		131	It should either return nothing or a string and a code reference. The
		132	string will be used as button text and the code reference will be called
		133	when the button gets activated and should transform C<$_>.
		134
		135	The following will add an entry C<a to b> that transforms all C<a>s in
		136	the selection to C<b>s, but only if the selection currently contains any
		137	C<a>s:
		138
		139	push @{ $self->{term}{selection_popup_hook} }, sub {
		140	/a/ ? ("a to b" => sub { s/a/b/g }
		141	: ()
		142	};
110		143
111	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
112		145
113	Adds regex search functionality to the scrollback buffer, triggered	146	Adds regex search functionality to the scrollback buffer, triggered
114	by a hotkey (default: C<M-s>). While in search mode, normal terminal	147	by a hotkey (default: C<M-s>). While in search mode, normal terminal
…		…
119	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>	152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
120	search upwards/downwards in the scrollback buffer, C<End> jumps to the	153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
121	bottom. C<Escape> leaves search mode and returns to the point where search	154	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	155	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	156	additionally stores the first match in the current line into the primary
124	selection.	157	selection if the C<Shift> modifier is active.
		158
		159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
		160	get a case-sensitive search you can delete this prefix using C<BackSpace>
		161	or simply use an uppercase character which removes the "(?i)" prefix.
		162
		163	See L<perlre> for more info about perl regular expression syntax.
		164
		165	=item readline (enabled by default)
		166
		167	A support package that tries to make editing with readline easier. At
		168	the moment, it reacts to clicking shift-left mouse button by trying to
		169	move the text cursor to this position. It does so by generating as many
		170	cursor-left or cursor-right keypresses as required (this only works
		171	for programs that correctly support wide characters).
		172
		173	To avoid too many false positives, this is only done when:
		174
		175	=over 4
		176
		177	=item - the tty is in ICANON state.
		178
		179	=item - the text cursor is visible.
		180
		181	=item - the primary screen is currently being displayed.
		182
		183	=item - the mouse is on the same (multi-row-) line as the text cursor.
		184
		185	=back
		186
		187	The normal selection mechanism isn't disabled, so quick successive clicks
		188	might interfere with selection creation in harmless ways.
125		189
126	=item selection-autotransform	190	=item selection-autotransform
127		191
128	This selection allows you to do automatic transforms on a selection	192	This selection allows you to do automatic transforms on a selection
129	whenever a selection is made.	193	whenever a selection is made.
…		…
142	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	206	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
143		207
144	And this example matches the same,but replaces it with vi-commands you can	208	And this example matches the same,but replaces it with vi-commands you can
145	paste directly into your (vi :) editor:	209	paste directly into your (vi :) editor:
146		210
147	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	211	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
148		212
149	Of course, this can be modified to suit your needs and your editor :)	213	Of course, this can be modified to suit your needs and your editor :)
150		214
151	To expand the example above to typical perl error messages ("XXX at	215	To expand the example above to typical perl error messages ("XXX at
152	FILENAME line YYY."), you need a slightly more elaborate solution:	216	FILENAME line YYY."), you need a slightly more elaborate solution:
153		217
154	URxvt.selection.pattern-0: ( at .*? line \\d+\\.)	218	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
155	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/	219	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
156		220
157	The first line tells the selection code to treat the unchanging part of	221	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	222	every error message as a selection pattern, and the second line transforms
159	the message into vi commands to load the file.	223	the message into vi commands to load the file.
160		224
161	=item mark-urls	225	=item tabbed
162		226
		227	This transforms the terminal into a tabbar with additional terminals, that
		228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
		229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		230	button per tab.
		231
		232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		233	B<Shift-Right> will switch to the tab left or right of the current one,
		234	while B<Shift-Down> creates a new tab.
		235
		236	The tabbar itself can be configured similarly to a normal terminal, but
		237	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		238	following four resources (shown with defaults):
		239
		240	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		241	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		242	URxvt.tabbed.tab-fg: <colour-index, default 0>
		243	URxvt.tabbed.tab-bg: <colour-index, default 1>
		244
		245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		246	indices.
		247
		248	=item matcher
		249
163	Uses per-line display filtering (C<on_line_update>) to underline urls and	250	Uses per-line display filtering (C<on_line_update>) to underline text
164	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
165	resource C<urlLauncher> (default C<x-www-browser>) will be started with	252	mouse button specified in the C<matcher.button> resource (default 2, or
166	the URL as first argument.	253	middle), the program specified in the C<matcher.launcher> resource
		254	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
		255	with the matched text as first argument. The default configuration is
		256	suitable for matching URLs and launching a web browser, like the
		257	former "mark-urls" extension.
		258
		259	The default pattern to match URLs can be overridden with the
		260	C<matcher.pattern.0> resource, and additional patterns can be specified
		261	with numbered patterns, in a manner similar to the "selection" extension.
		262	The launcher can also be overridden on a per-pattern basis.
		263
		264	It is possible to activate the most recently seen match or a list of matches
		265	from the keyboard. Simply bind a keysym to "perl:matcher:last" or
		266	"perl:matcher:list" as seen in the example below.
		267
		268	Example configuration:
		269
		270	URxvt.perl-ext: default,matcher
		271	URxvt.urlLauncher: sensible-browser
		272	URxvt.keysym.C-Delete: perl:matcher:last
		273	URxvt.keysym.M-Delete: perl:matcher:list
		274	URxvt.matcher.button: 1
		275	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		276	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
		277	URxvt.matcher.launcher.2: gvim +$2 $1
		278
		279	=item xim-onthespot
		280
		281	This (experimental) perl extension implements OnTheSpot editing. It does
		282	not work perfectly, and some input methods don't seem to work well with
		283	OnTheSpot editing in general, but it seems to work at least for SCIM and
		284	kinput2.
		285
		286	You enable it by specifying this extension and a preedit style of
		287	C<OnTheSpot>, i.e.:
		288
		289	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		290
		291	=item kuake<hotkey>
		292
		293	A very primitive quake-console-like extension. It was inspired by a
		294	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		295	user presses a global accelerator key (by default C<F10>), the terminal
		296	will show or hide itself. Another press of the accelerator key will hide
		297	or show it again.
		298
		299	Initially, the window will not be shown when using this extension.
		300
		301	This is useful if you need a single terminal that is not using any desktop
		302	space most of the time but is quickly available at the press of a key.
		303
		304	The accelerator key is grabbed regardless of any modifiers, so this
		305	extension will actually grab a physical key just for this function.
		306
		307	If you want a quake-like animation, tell your window manager to do so
		308	(fvwm can do it).
		309
		310	=item overlay-osc
		311
		312	This extension implements some OSC commands to display timed popups on the
		313	screen - useful for status displays from within scripts. You have to read
		314	the sources for more info.
167		315
168	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
169		317
170	A not very useful example of filtering all text output to the terminal,	318	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	319	by replacing all line-drawing characters (U+2500 .. U+259F) by a
172	similar-looking ascii character.	320	similar-looking ascii character.
173		321
174	=item digital-clock	322	=item digital-clock
175		323
176	Displays a digital clock using the built-in overlay.	324	Displays a digital clock using the built-in overlay.
		325
		326	=item remote-clipboard
		327
		328	Somewhat of a misnomer, this extension adds two menu entries to the
		329	selection popup that allows one to run external commands to store the
		330	selection somewhere and fetch it again.
		331
		332	We use it to implement a "distributed selection mechanism", which just
		333	means that one command uploads the file to a remote server, and another
		334	reads it.
		335
		336	The commands can be set using the C<URxvt.remote-selection.store> and
		337	C<URxvt.remote-selection.fetch> resources. The first should read the
		338	selection to store from STDIN (always in UTF-8), the second should provide
		339	the selection data on STDOUT (also in UTF-8).
		340
		341	The defaults (which are likely useless to you) use rsh and cat:
		342
		343	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		344	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		345
		346	=item selection-pastebin
		347
		348	This is a little rarely useful extension that uploads the selection as
		349	textfile to a remote site (or does other things). (The implementation is
		350	not currently secure for use in a multiuser environment as it writes to
		351	F</tmp> directly.).
		352
		353	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		354	i.e.
		355
		356	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		357
		358	Pressing this combination runs a command with C<%> replaced by the name of
		359	the textfile. This command can be set via a resource:
		360
		361	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		362
		363	And the default is likely not useful to anybody but the few people around
		364	here :)
		365
		366	The name of the textfile is the hex encoded md5 sum of the selection, so
		367	the same content should lead to the same filename.
		368
		369	After a successful upload the selection will be replaced by the text given
		370	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		371	for the filename):
		372
		373	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		374
		375	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		376	the double C</> characters as comment start. Use C<\057\057> instead,
		377	which works regardless of whether xrdb is used to parse the resource file
		378	or not.
		379
		380	=item macosx-clipboard and macosx-clipboard-native
		381
		382	These two modules implement an extended clipboard for Mac OS X. They are
		383	used like this:
		384
		385	URxvt.perl-ext-common: default,macosx-clipboard
		386	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		387	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		388
		389	The difference between them is that the native variant requires a
		390	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		391	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		392	simpler etc. etc.
177		393
178	=item example-refresh-hooks	394	=item example-refresh-hooks
179		395
180	Displays a very simple digital clock in the upper right corner of the	396	Displays a very simple digital clock in the upper right corner of the
181	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
182	overlays or changes.	398	overlays or changes.
		399
		400	=item confirm-paste
		401
		402	Displays a confirmation dialog when a paste containing at least a full
		403	line is detected.
183		404
184	=back	405	=back
185		406
186	=head1 API DOCUMENTATION	407	=head1 API DOCUMENTATION
187		408
…		…
203		424
204	=over 4	425	=over 4
205		426
206	=item $text	427	=item $text
207		428
208	Rxvt-unicodes special way of encoding text, where one "unicode" character	429	Rxvt-unicode's special way of encoding text, where one "unicode" character
209	always represents one screen cell. See L<ROW_t> for a discussion of this format.	430	always represents one screen cell. See L<ROW_t> for a discussion of this format.
210		431
211	=item $string	432	=item $string
212		433
213	A perl text string, with an emphasis on I<text>. It can store all unicode	434	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
221		442
222	=back	443	=back
223		444
224	=head2 Extension Objects	445	=head2 Extension Objects
225		446
226	Very perl extension is a perl class. A separate perl object is created	447	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	448	for each terminal, and each terminal has its own set of extension objects,
228	hooks. So extensions can use their C<$self> object without having to think	449	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	450	their C<$self> object without having to think about clashes with other
		451	extensions or other terminals, with the exception of methods and members
230	begin with an underscore character C<_>: these are reserved for internal	452	that begin with an underscore character C<_>: these are reserved for
231	use.	453	internal use.
232		454
233	Although it isn't a C<urxvt::term> object, you can call all methods of the	455	Although it isn't a C<urxvt::term> object, you can call all methods of the
234	C<urxvt::term> class on this object.	456	C<urxvt::term> class on this object.
235		457
236	It has the following methods and data members:	458	It has the following methods and data members:
…		…
257	=head2 Hooks	479	=head2 Hooks
258		480
259	The following subroutines can be declared in extension files, and will be	481	The following subroutines can be declared in extension files, and will be
260	called whenever the relevant event happens.	482	called whenever the relevant event happens.
261		483
262	The first argument passed to them is an extension oject as described in	484	The first argument passed to them is an extension object as described in
263	the in the C<Extension Objects> section.	485	the in the C<Extension Objects> section.
264		486
265	B<All> of these hooks must return a boolean value. If it is true, then the	487	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	488	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.	489	relevant action might not be carried out by the C++ code.
268		490
269	I<< When in doubt, return a false value (preferably C<()>). >>	491	I<< When in doubt, return a false value (preferably C<()>). >>
270		492
271	=over 4	493	=over 4
272		494
273	=item on_init $term	495	=item on_init $term
274		496
275	Called after a new terminal object has been initialized, but before	497	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	498	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	499	call or deliver senseless data, as terminal size and other characteristics
278	have not yet been determined. You can safely query and change resources,	500	have not yet been determined. You can safely query and change resources
279	though.	501	and options, though. For many purposes the C<on_start> hook is a better
		502	place.
		503
		504	=item on_start $term
		505
		506	Called at the very end of initialisation of a new terminal, just before
		507	trying to map (display) the toplevel and returning to the main loop.
		508
		509	=item on_destroy $term
		510
		511	Called whenever something tries to destroy terminal, when the terminal is
		512	still fully functional (not for long, though).
280		513
281	=item on_reset $term	514	=item on_reset $term
282		515
283	Called after the screen is "reset" for any reason, such as resizing or	516	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	517	control sequences. Here is where you can react on changes to size-related
285	variables.	518	variables.
286		519
287	=item on_start $term	520	=item on_child_start $term, $pid
288		521
289	Called at the very end of initialisation of a new terminal, just before	522	Called just after the child process has been C<fork>ed.
290	returning to the mainloop.	523
		524	=item on_child_exit $term, $status
		525
		526	Called just after the child process has exited. C<$status> is the status
		527	from C<waitpid>.
291		528
292	=item on_sel_make $term, $eventtime	529	=item on_sel_make $term, $eventtime
293		530
294	Called whenever a selection has been made by the user, but before the	531	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	532	selection text is copied, so changes to the beginning, end or type of the
…		…
302		539
303	Called whenever a selection has been copied, but before the selection is	540	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	541	requested from the server. The selection text can be queried and changed
305	by calling C<< $term->selection >>.	542	by calling C<< $term->selection >>.
306		543
307	Returning a true value aborts selection grabbing. It will still be hilighted.	544	Returning a true value aborts selection grabbing. It will still be highlighted.
308		545
309	=item on_sel_extend $term	546	=item on_sel_extend $term
310		547
311	Called whenever the user tries to extend the selection (e.g. with a double	548	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	549	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	550	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	551	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	552	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.	553	supposed to enlarge the selection more and more, if possible.
317		554
318	See the F<selection> example extension.	555	See the F<selection> example extension.
319		556
320	=item on_view_change $term, $offset	557	=item on_view_change $term, $offset
321		558
322	Called whenever the view offset changes, i..e the user or program	559	Called whenever the view offset changes, i.e. the user or program
323	scrolls. Offset C<0> means display the normal terminal, positive values	560	scrolls. Offset C<0> means display the normal terminal, positive values
324	show this many lines of scrollback.	561	show this many lines of scrollback.
325		562
326	=item on_scroll_back $term, $lines, $saved	563	=item on_scroll_back $term, $lines, $saved
327		564
…		…
331		568
332	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	569	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	570	$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.	571	number of lines that will be in the scrollback buffer.
335		572
336	=item on_osc_seq $term, $string	573	=item on_osc_seq $term, $op, $args, $resp
		574
		575	Called on every OSC sequence and can be used to suppress it or modify its
		576	behaviour. The default should be to return an empty list. A true value
		577	suppresses execution of the request completely. Make sure you don't get
		578	confused by recursive invocations when you output an OSC sequence within
		579	this callback.
		580
		581	C<on_osc_seq_perl> should be used for new behaviour.
		582
		583	=item on_osc_seq_perl $term, $args, $resp
337		584
338	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	585	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
339	operating system command) is processed. Cursor position and other state	586	operating system command) is processed. Cursor position and other state
340	information is up-to-date when this happens. For interoperability, the	587	information is up-to-date when this happens. For interoperability, the
341	string should start with the extension name and a colon, to distinguish	588	string should start with the extension name (sans -osc) and a semicolon,
342	it from commands for other extensions, and this might be enforced in the	589	to distinguish it from commands for other extensions, and this might be
343	future.	590	enforced in the future.
		591
		592	For example, C<overlay-osc> uses this:
		593
		594	sub on_osc_seq_perl {
		595	my ($self, $osc, $resp) = @_;
		596
		597	return unless $osc =~ s/^overlay;//;
		598
		599	... process remaining $osc string
		600	}
344		601
345	Be careful not ever to trust (in a security sense) the data you receive,	602	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	603	as its source can not easily be controlled (e-mail content, messages from
347	other users on the same system etc.).	604	other users on the same system etc.).
		605
		606	For responses, C<$resp> contains the end-of-args separator used by the
		607	sender.
348		608
349	=item on_add_lines $term, $string	609	=item on_add_lines $term, $string
350		610
351	Called whenever text is about to be output, with the text as argument. You	611	Called whenever text is about to be output, with the text as argument. You
352	can filter/change and output the text yourself by returning a true value	612	can filter/change and output the text yourself by returning a true value
…		…
357	=item on_tt_write $term, $octets	617	=item on_tt_write $term, $octets
358		618
359	Called whenever some data is written to the tty/pty and can be used to	619	Called whenever some data is written to the tty/pty and can be used to
360	suppress or filter tty input.	620	suppress or filter tty input.
361		621
		622	=item on_tt_paste $term, $octets
		623
		624	Called whenever text is about to be pasted, with the text as argument. You
		625	can filter/change and paste the text yourself by returning a true value
		626	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		627	locale-encoded.
		628
362	=item on_line_update $term, $row	629	=item on_line_update $term, $row
363		630
364	Called whenever a line was updated or changed. Can be used to filter	631	Called whenever a line was updated or changed. Can be used to filter
365	screen output (e.g. underline urls or other useless stuff). Only lines	632	screen output (e.g. underline urls or other useless stuff). Only lines
366	that are being shown will be filtered, and, due to performance reasons,	633	that are being shown will be filtered, and, due to performance reasons,
…		…
373	later with the already-modified line (e.g. if unrelated parts change), so	640	later with the already-modified line (e.g. if unrelated parts change), so
374	you cannot just toggle rendition bits, but only set them.	641	you cannot just toggle rendition bits, but only set them.
375		642
376	=item on_refresh_begin $term	643	=item on_refresh_begin $term
377		644
378	Called just before the screen gets redrawn. Can be used for overlay	645	Called just before the screen gets redrawn. Can be used for overlay or
379	or similar effects by modify terminal contents in refresh_begin, and	646	similar effects by modifying the terminal contents in refresh_begin, and
380	restoring them in refresh_end. The built-in overlay and selection display	647	restoring them in refresh_end. The built-in overlay and selection display
381	code is run after this hook, and takes precedence.	648	code is run after this hook, and takes precedence.
382		649
383	=item on_refresh_end $term	650	=item on_refresh_end $term
384		651
385	Called just after the screen gets redrawn. See C<on_refresh_begin>.	652	Called just after the screen gets redrawn. See C<on_refresh_begin>.
386		653
387	=item on_keyboard_command $term, $string	654	=item on_user_command $term, $string
388		655
389	Called whenever the user presses a key combination that has a	656	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>	657	a C<perl:string> action bound to a key, see description of the B<keysym>
391	resource in the @@RXVT_NAME@@(1) manpage).	658	resource in the @@RXVT_NAME@@(1) manpage).
		659
		660	The event is simply the action string. This interface is assumed to change
		661	slightly in the future.
		662
		663	=item on_resize_all_windows $term, $new_width, $new_height
		664
		665	Called just after the new window size has been calculated, but before
		666	windows are actually being resized or hints are being set. If this hook
		667	returns TRUE, setting of the window hints is being skipped.
392		668
393	=item on_x_event $term, $event	669	=item on_x_event $term, $event
394		670
395	Called on every X event received on the vt window (and possibly other	671	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	672	windows). Should only be used as a last resort. Most event structure
397	members are not passed.	673	members are not passed.
398		674
		675	=item on_root_event $term, $event
		676
		677	Like C<on_x_event>, but is called for events on the root window.
		678
399	=item on_focus_in $term	679	=item on_focus_in $term
400		680
401	Called whenever the window gets the keyboard focus, before rxvt-unicode	681	Called whenever the window gets the keyboard focus, before rxvt-unicode
402	does focus in processing.	682	does focus in processing.
403		683
404	=item on_focus_out $term	684	=item on_focus_out $term
405		685
406	Called wheneever the window loses keyboard focus, before rxvt-unicode does	686	Called whenever the window loses keyboard focus, before rxvt-unicode does
407	focus out processing.	687	focus out processing.
408		688
		689	=item on_configure_notify $term, $event
		690
		691	=item on_property_notify $term, $event
		692
409	=item on_key_press $term, $event, $keysym, $octets	693	=item on_key_press $term, $event, $keysym, $octets
410		694
411	=item on_key_release $term, $event, $keysym	695	=item on_key_release $term, $event, $keysym
412		696
413	=item on_button_press $term, $event	697	=item on_button_press $term, $event
…		…
418		702
419	=item on_map_notify $term, $event	703	=item on_map_notify $term, $event
420		704
421	=item on_unmap_notify $term, $event	705	=item on_unmap_notify $term, $event
422		706
423	Called whenever the corresponding X event is received for the terminal If	707	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.	708	the hook returns true, then the event will be ignored by rxvt-unicode.
425		709
426	The event is a hash with most values as named by Xlib (see the XEvent	710	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	711	manpage), with the additional members C<row> and C<col>, which are the
428	and column under the mouse cursor.	712	(real, not screen-based) row and column under the mouse cursor.
429		713
430	C<on_key_press> additionally receives the string rxvt-unicode would	714	C<on_key_press> additionally receives the string rxvt-unicode would
431	output, if any, in locale-specific encoding.	715	output, if any, in locale-specific encoding.
432		716
433	subwindow.	717	subwindow.
		718
		719	=item on_client_message $term, $event
		720
		721	=item on_wm_protocols $term, $event
		722
		723	=item on_wm_delete_window $term, $event
		724
		725	Called when various types of ClientMessage events are received (all with
		726	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		727
		728	=item on_bell $term
		729
		730	Called on receipt of a bell character.
434		731
435	=back	732	=back
436		733
437	=cut	734	=cut
438		735
…		…
444	use Scalar::Util ();	741	use Scalar::Util ();
445	use List::Util ();	742	use List::Util ();
446		743
447	our $VERSION = 1;	744	our $VERSION = 1;
448	our $TERM;	745	our $TERM;
		746	our @TERM_INIT;
		747	our @TERM_EXT;
449	our @HOOKNAME;	748	our @HOOKNAME;
450	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	749	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
451	our %OPTION;	750	our %OPTION;
452		751
453	our $LIBDIR;	752	our $LIBDIR;
454	our $RESNAME;	753	our $RESNAME;
455	our $RESCLASS;	754	our $RESCLASS;
456	our $RXVTNAME;	755	our $RXVTNAME;
457		756
		757	our $NOCHAR = chr 0xffff;
		758
458	=head2 Variables in the C<urxvt> Package	759	=head2 Variables in the C<urxvt> Package
459		760
460	=over 4	761	=over 4
461		762
462	=item $urxvt::LIBDIR	763	=item $urxvt::LIBDIR
…		…
475	=item $urxvt::TERM	776	=item $urxvt::TERM
476		777
477	The current terminal. This variable stores the current C<urxvt::term>	778	The current terminal. This variable stores the current C<urxvt::term>
478	object, whenever a callback/hook is executing.	779	object, whenever a callback/hook is executing.
479		780
		781	=item @urxvt::TERM_INIT
		782
		783	All code references in this array will be called as methods of the next newly
		784	created C<urxvt::term> object (during the C<on_init> phase). The array
		785	gets cleared before the code references that were in it are being executed,
		786	so references can push themselves onto it again if they so desire.
		787
		788	This complements to the perl-eval command line option, but gets executed
		789	first.
		790
		791	=item @urxvt::TERM_EXT
		792
		793	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		794	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		795	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		796
480	=back	797	=back
481		798
482	=head2 Functions in the C<urxvt> Package	799	=head2 Functions in the C<urxvt> Package
483		800
484	=over 4	801	=over 4
485		802
486	=item urxvt::fatal $errormessage	803	=item urxvt::fatal $errormessage
487		804
488	Fatally aborts execution with the given error message. Avoid at all	805	Fatally aborts execution with the given error message (which should
489	costs! The only time this is acceptable is when the terminal process	806	include a trailing newline). Avoid at all costs! The only time this
490	starts up.	807	is acceptable (and useful) is in the init hook, where it prevents the
		808	terminal from starting up.
491		809
492	=item urxvt::warn $string	810	=item urxvt::warn $string
493		811
494	Calls C<rxvt_warn> with the given string which should not include a	812	Calls C<rxvt_warn> with the given string which should include a trailing
495	newline. The module also overwrites the C<warn> builtin with a function	813	newline. The module also overwrites the C<warn> builtin with a function
496	that calls this function.	814	that calls this function.
497		815
498	Using this function has the advantage that its output ends up in the	816	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.	817	correct place, e.g. on stderr of the connecting urxvtc client.
500		818
501	Messages have a size limit of 1023 bytes currently.	819	Messages have a size limit of 1023 bytes currently.
502		820
503	=item $is_safe = urxvt::safe	821	=item @terms = urxvt::termlist
504		822
505	Returns true when it is safe to do potentially unsafe things, such as	823	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	824	whether they are started, being destroyed etc., so be careful. Only term
507	started setuid or setgid.	825	objects that have perl extensions attached will be returned (because there
		826	is no urxvt::term object associated with others).
508		827
509	=item $time = urxvt::NOW	828	=item $time = urxvt::NOW
510		829
511	Returns the "current time" (as per the event loop).	830	Returns the "current time" (as per the event loop).
512		831
…		…
555		874
556	=item $rend = urxvt::OVERLAY_RSTYLE	875	=item $rend = urxvt::OVERLAY_RSTYLE
557		876
558	Return the rendition mask used for overlays by default.	877	Return the rendition mask used for overlays by default.
559		878
560	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	879	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		880	urxvt::RS_RVid, urxvt::RS_Uline
561		881
562	Return the bit that enabled bold, italic, blink, reverse-video and	882	Return the bit that enabled bold, italic, blink, reverse-video and
563	underline, respectively. To enable such a style, just logically OR it into	883	underline, respectively. To enable such a style, just logically OR it into
564	the bitset.	884	the bitset.
565		885
…		…
571		891
572	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	892	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
573		893
574	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	894	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
575		895
		896	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		897
576	Replace the foreground/background colour in the rendition mask with the	898	Replace the foreground/background colour in the rendition mask with the
577	specified one.	899	specified one.
578		900
579	=item $value = urxvt::GET_CUSTOM $rend	901	=item $value = urxvt::GET_CUSTOM $rend
580		902
…		…
589	=back	911	=back
590		912
591	=cut	913	=cut
592		914
593	BEGIN {	915	BEGIN {
594	urxvt->bootstrap;
595
596	# overwrite perl's warn	916	# overwrite perl's warn
597	*CORE::GLOBAL::warn = sub {	917	*CORE::GLOBAL::warn = sub {
598	my $msg = join "", @_;	918	my $msg = join "", @_;
599	$msg .= "\n"	919	$msg .= "\n"
600	unless $msg =~ /\n$/;	920	unless $msg =~ /\n$/;
601	urxvt::warn ($msg);	921	urxvt::warn ($msg);
602	};	922	};
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	}	923	}
		924
		925	no warnings 'utf8';
610		926
611	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	927	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
612		928
613	sub verbose {	929	sub verbose {
614	my ($level, $msg) = @_;	930	my ($level, $msg) = @_;
615	warn "$msg\n" if $level <= $verbosity;	931	warn "$msg\n" if $level <= $verbosity;
616	}	932	}
617		933
618	my $extension_pkg = "extension0000";
619	my %extension_pkg;	934	my %extension_pkg;
620		935
621	# load a single script into its own package, once only	936	# load a single script into its own package, once only
622	sub extension_package($) {	937	sub extension_package($) {
623	my ($path) = @_;	938	my ($path) = @_;
624		939
625	$extension_pkg{$path} ||= do {	940	$extension_pkg{$path} ||= do {
626	my $pkg = "urxvt::" . ($extension_pkg++);	941	$path =~ /([^\/\\]+)$/;
		942	my $pkg = $1;
		943	$pkg =~ s/[^[:word:]]/_/g;
		944	$pkg = "urxvt::ext::$pkg";
627		945
628	verbose 3, "loading extension '$path' into package '$pkg'";	946	verbose 3, "loading extension '$path' into package '$pkg'";
629		947
630	open my $fh, "<:raw", $path	948	open my $fh, "<:raw", $path
631	or die "$path: $!";	949	or die "$path: $!";
632		950
633	my $source = untaint	951	my $source =
634	"package $pkg; use strict; use utf8;\n"	952	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
635	. "use base urxvt::term::extension::;\n"
636	. "#line 1 \"$path\"\n{\n"	953	. "#line 1 \"$path\"\n{\n"
637	. (do { local $/; <$fh> })	954	. (do { local $/; <$fh> })
638	. "\n};\n1";	955	. "\n};\n1";
639		956
640	eval $source	957	eval $source
…		…
651	local $TERM = shift;	968	local $TERM = shift;
652	my $htype = shift;	969	my $htype = shift;
653		970
654	if ($htype == 0) { # INIT	971	if ($htype == 0) { # INIT
655	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	972	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
656		973
657	my %ext_arg;	974	my %ext_arg;
658		975
		976	{
		977	my @init = @TERM_INIT;
		978	@TERM_INIT = ();
		979	$_->($TERM) for @init;
		980	my @pkg = @TERM_EXT;
		981	@TERM_EXT = ();
		982	$TERM->register_package ($_) for @pkg;
		983	}
		984
659	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	985	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
660	if ($_ eq "default") {	986	if ($_ eq "default") {
661	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	987	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
662	} elsif (/^-(.*)$/) {	988	} elsif (/^-(.*)$/) {
663	delete $ext_arg{$1};	989	delete $ext_arg{$1};
664	} elsif (/^([^<]+)<(.*)>$/) {	990	} elsif (/^([^<]+)<(.*)>$/) {
665	push @{ $ext_arg{$1} }, $2;	991	push @{ $ext_arg{$1} }, $2;
666	} else {	992	} else {
667	$ext_arg{$_} ||= [];	993	$ext_arg{$_} ||= [];
668	}	994	}
669	}	995	}
670		996
671	while (my ($ext, $argv) = each %ext_arg) {	997	for my $ext (sort keys %ext_arg) {
672	my @files = grep -f $_, map "$_/$ext", @dirs;	998	my @files = grep -f $_, map "$_/$ext", @dirs;
673		999
674	if (@files) {	1000	if (@files) {
675	$TERM->register_package (extension_package $files[0], $argv);	1001	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
676	} else {	1002	} else {
677	warn "perl extension '$ext' not found in perl library search path\n";	1003	warn "perl extension '$ext' not found in perl library search path\n";
678	}	1004	}
679	}	1005	}
680		1006
…		…
686		1012
687	if (my $cb = $TERM->{_hook}[$htype]) {	1013	if (my $cb = $TERM->{_hook}[$htype]) {
688	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1014	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
689	if $verbosity >= 10;	1015	if $verbosity >= 10;
690		1016
691	keys %$cb;	1017	for my $pkg (keys %$cb) {
692
693	while (my ($pkg, $cb) = each %$cb) {
694	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	1018	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
695	and last;	1019	$retval ||= $retval_;
696		1020
697	if ($@) {	1021	if ($@) {
698	$TERM->ungrab; # better to lose the grab than the session	1022	$TERM->ungrab; # better to lose the grab than the session
699	warn $@;	1023	warn $@;
700	}	1024	}
…		…
713	}	1037	}
714		1038
715	$retval	1039	$retval
716	}	1040	}
717		1041
718	sub exec_async(@) {	1042	sub SET_COLOR($$$) {
719	my $pid = fork;	1043	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1044	}
720		1045
721	return	1046	sub rend2mask {
722	if !defined $pid or $pid;	1047	no strict 'refs';
723		1048	my ($str, $mask) = (@_, 0);
724	%ENV = %{ $TERM->env };	1049	my %color = ( fg => undef, bg => undef );
725		1050	my @failed;
726	exec @_;	1051	for my $spec ( split /\s+/, $str ) {
727	_exit 255;	1052	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1053	$color{lc($1)} = $2;
		1054	} else {
		1055	my $neg = $spec =~ s/^[-^]//;
		1056	unless ( exists &{"RS_$spec"} ) {
		1057	push @failed, $spec;
		1058	next;
		1059	}
		1060	my $cur = &{"RS_$spec"};
		1061	if ( $neg ) {
		1062	$mask &= ~$cur;
		1063	} else {
		1064	$mask |= $cur;
		1065	}
		1066	}
		1067	}
		1068	($mask, @color{qw(fg bg)}, \@failed)
728	}	1069	}
729		1070
730	# urxvt::term::extension	1071	# urxvt::term::extension
731		1072
732	package urxvt::term::extension;	1073	package urxvt::term::extension;
…		…
803	is that you cannot use blocking APIs, but the non-blocking variant should	1144	is that you cannot use blocking APIs, but the non-blocking variant should
804	work.	1145	work.
805		1146
806	=cut	1147	=cut
807		1148
808	our $VERSION = 1;	1149	our $VERSION = '5.23';
809		1150
810	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1151	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
811	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1152	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
812		1153
813	sub timer {	1154	sub timer {
…		…
815		1156
816	my $cb = $arg{cb};	1157	my $cb = $arg{cb};
817		1158
818	urxvt::timer	1159	urxvt::timer
819	->new	1160	->new
820	->start (urxvt::NOW + $arg{after})	1161	->after ($arg{after}, $arg{interval})
821	->cb (sub {	1162	->cb ($arg{interval} ? $cb : sub {
822	$_[0]->stop; # need to cancel manually	1163	$_[0]->stop; # need to cancel manually
823	$cb->();	1164	$cb->();
824	})	1165	})
825	}	1166	}
826		1167
827	sub io {	1168	sub io {
828	my ($class, %arg) = @_;	1169	my ($class, %arg) = @_;
829		1170
830	my $cb = $arg{cb};	1171	my $cb = $arg{cb};
		1172	my $fd = fileno $arg{fh};
		1173	defined $fd or $fd = $arg{fh};
831		1174
832	bless [$arg{fh}, urxvt::iow	1175	bless [$arg{fh}, urxvt::iow
833	->new	1176	->new
834	->fd (fileno $arg{fh})	1177	->fd ($fd)
835	->events (($arg{poll} =~ /r/ ? 1 : 0)	1178	->events (($arg{poll} =~ /r/ ? 1 : 0)
836	| ($arg{poll} =~ /w/ ? 2 : 0))	1179	| ($arg{poll} =~ /w/ ? 2 : 0))
837	->start	1180	->start
838	->cb (sub {	1181	->cb ($cb)
839	$cb->(($_[1] & 1 ? 'r' : '')
840	. ($_[1] & 2 ? 'w' : ''));
841	})],
842	urxvt::anyevent::	1182	], urxvt::anyevent::
		1183	}
		1184
		1185	sub idle {
		1186	my ($class, %arg) = @_;
		1187
		1188	my $cb = $arg{cb};
		1189
		1190	urxvt::iw
		1191	->new
		1192	->start
		1193	->cb ($cb)
		1194	}
		1195
		1196	sub child {
		1197	my ($class, %arg) = @_;
		1198
		1199	my $cb = $arg{cb};
		1200
		1201	urxvt::pw
		1202	->new
		1203	->start ($arg{pid})
		1204	->cb (sub {
		1205	$_[0]->stop; # need to cancel manually
		1206	$cb->($_[0]->rpid, $_[0]->rstatus);
		1207	})
843	}	1208	}
844		1209
845	sub DESTROY {	1210	sub DESTROY {
846	$_[0][1]->stop;	1211	$_[0][1]->stop;
847	}	1212	}
848		1213
849	sub condvar {	1214	sub one_event {
850	bless \my $flag, urxvt::anyevent::condvar::
851	}
852
853	sub urxvt::anyevent::condvar::broadcast {
854	${$_[0]}++;
855	}
856
857	sub urxvt::anyevent::condvar::wait {
858	unless (${$_[0]}) {
859	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1215	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
860	}
861	}	1216	}
862		1217
863	package urxvt::term;	1218	package urxvt::term;
864		1219
865	=head2 The C<urxvt::term> Class	1220	=head2 The C<urxvt::term> Class
…		…
870		1225
871	# find on_xxx subs in the package and register them	1226	# find on_xxx subs in the package and register them
872	# as hooks	1227	# as hooks
873	sub register_package {	1228	sub register_package {
874	my ($self, $pkg, $argv) = @_;	1229	my ($self, $pkg, $argv) = @_;
		1230
		1231	no strict 'refs';
		1232
		1233	urxvt::verbose 6, "register package $pkg to $self";
		1234
		1235	@{"$pkg\::ISA"} = urxvt::term::extension::;
875		1236
876	my $proxy = bless {	1237	my $proxy = bless {
877	_pkg => $pkg,	1238	_pkg => $pkg,
878	argv => $argv,	1239	argv => $argv,
879	}, $pkg;	1240	}, $pkg;
…		…
895	hash which defines the environment of the new terminal.	1256	hash which defines the environment of the new terminal.
896		1257
897	Croaks (and probably outputs an error message) if the new instance	1258	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	1259	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	1260	initialise perl, and the terminal object otherwise. The C<init> and
900	C<start> hooks will be called during this call.	1261	C<start> hooks will be called before this call returns, and are free to
		1262	refer to global data (which is race free).
901		1263
902	=cut	1264	=cut
903		1265
904	sub new {	1266	sub new {
905	my ($class, $env, @args) = @_;	1267	my ($class, $env, @args) = @_;
906		1268
		1269	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1270	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1271
907	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1272	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
908	}	1273	}
909		1274
910	=item $term->destroy	1275	=item $term->destroy
911		1276
912	Destroy the terminal object (close the window, free resources	1277	Destroy the terminal object (close the window, free resources
913	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1278	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
914	watchers (timers, io watchers) are still active.	1279	watchers (timers, io watchers) are still active.
915		1280
		1281	=item $term->exec_async ($cmd[, @args])
		1282
		1283	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1284	("starts") programs in the background. This function takes care of setting
		1285	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1286	be preferred over explicit calls to C<exec> or C<system>.
		1287
		1288	Returns the pid of the subprocess or C<undef> on error.
		1289
		1290	=cut
		1291
		1292	sub exec_async {
		1293	my $self = shift;
		1294
		1295	my $pid = fork;
		1296
		1297	return $pid
		1298	if !defined $pid or $pid;
		1299
		1300	%ENV = %{ $self->env };
		1301
		1302	exec @_;
		1303	urxvt::_exit 255;
		1304	}
		1305
916	=item $isset = $term->option ($optval[, $set])	1306	=item $isset = $term->option ($optval[, $set])
917		1307
918	Returns true if the option specified by C<$optval> is enabled, and	1308	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	1309	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.	1310	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
921		1311
922	Here is a a likely non-exhaustive list of option names, please see the	1312	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:	1313	source file F</src/optinc.h> to see the actual list:
924		1314
925	borderLess console cursorBlink cursorUnderline hold iconic insecure	1315	borderLess buffered console cursorBlink cursorUnderline hold iconic
926	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1316	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1317	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
927	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1318	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
928	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1319	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
929	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1320	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
930	tripleclickwords utmpInhibit visualBell	1321	urgentOnBell utmpInhibit visualBell
931		1322
932	=item $value = $term->resource ($name[, $newval])	1323	=item $value = $term->resource ($name[, $newval])
933		1324
934	Returns the current resource value associated with a given name and	1325	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>	1326	optionally sets a new value. Setting values is most useful in the C<init>
…		…
944	likely change).	1335	likely change).
945		1336
946	Please note that resource strings will currently only be freed when the	1337	Please note that resource strings will currently only be freed when the
947	terminal is destroyed, so changing options frequently will eat memory.	1338	terminal is destroyed, so changing options frequently will eat memory.
948		1339
949	Here is a a likely non-exhaustive list of resource names, not all of which	1340	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>	1341	are supported in every build, please see the source file F</src/rsinc.h>
951	to see the actual list:	1342	to see the actual list:
952		1343
953	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1344	answerbackstring backgroundPixmap backspace_key blendtype blurradius
954	borderLess color cursorBlink cursorUnderline cutchars delete_key	1345	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
955	display_name embed ext_bwidth fade font geometry hold iconName	1346	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
956	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1347	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1348	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
957	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1349	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
958	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1350	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
959	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1351	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
960	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1352	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
961	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1353	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
962	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1354	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
963	shade term_name title transparent transparent_all tripleclickwords	1355	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1356	term_name title transient_for transparent tripleclickwords urgentOnBell
964	utmpInhibit visualBell	1357	utmpInhibit visualBell
965		1358
966	=cut	1359	=cut
967		1360
968	sub resource($$;$) {	1361	sub resource($$;$) {
969	my ($self, $name) = (shift, shift);	1362	my ($self, $name) = (shift, shift);
970	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1363	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
971	&urxvt::term::_resource	1364	goto &urxvt::term::_resource
972	}	1365	}
973		1366
974	=item $value = $term->x_resource ($pattern)	1367	=item $value = $term->x_resource ($pattern)
975		1368
976	Returns the X-Resource for the given pattern, excluding the program or	1369	Returns the X-Resource for the given pattern, excluding the program or
…		…
1001		1394
1002	=item ($row, $col) = $term->selection_beg ([$row, $col])	1395	=item ($row, $col) = $term->selection_beg ([$row, $col])
1003		1396
1004	=item ($row, $col) = $term->selection_end ([$row, $col])	1397	=item ($row, $col) = $term->selection_end ([$row, $col])
1005		1398
1006	Return the current values of the selection mark, begin or end positions,	1399	Return the current values of the selection mark, begin or end positions.
1007	and optionally set them to new values.	1400
		1401	When arguments are given, then the selection coordinates are set to
		1402	C<$row> and C<$col>, and the selection screen is set to the current
		1403	screen.
		1404
		1405	=item $screen = $term->selection_screen ([$screen])
		1406
		1407	Returns the current selection screen, and then optionally sets it.
1008		1408
1009	=item $term->selection_make ($eventtime[, $rectangular])	1409	=item $term->selection_make ($eventtime[, $rectangular])
1010		1410
1011	Tries to make a selection as set by C<selection_beg> and	1411	Tries to make a selection as set by C<selection_beg> and
1012	C<selection_end>. If C<$rectangular> is true (default: false), a	1412	C<selection_end>. If C<$rectangular> is true (default: false), a
1013	rectangular selection will be made. This is the prefered function to make	1413	rectangular selection will be made. This is the preferred function to make
1014	a selection.	1414	a selection.
1015		1415
1016	=item $success = $term->selection_grab ($eventtime)	1416	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1017		1417
1018	Try to request the primary selection text from the server (for example, as	1418	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1419	true) selection from the server. The corresponding text can be set
1019	set by the next method). No visual feedback will be given. This function	1420	with the next method. No visual feedback will be given. This function
1020	is mostly useful from within C<on_sel_grab> hooks.	1421	is mostly useful from within C<on_sel_grab> hooks.
1021		1422
1022	=item $oldtext = $term->selection ([$newtext])	1423	=item $oldtext = $term->selection ([$newtext, $clipboard])
1023		1424
1024	Return the current selection text and optionally replace it by C<$newtext>.	1425	Return the current selection (clipboard if C<$clipboard> is true) text
		1426	and optionally replace it by C<$newtext>.
		1427
		1428	=item $term->selection_clear ([$clipboard])
		1429
		1430	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1025		1431
1026	=item $term->overlay_simple ($x, $y, $text)	1432	=item $term->overlay_simple ($x, $y, $text)
1027		1433
1028	Create a simple multi-line overlay box. See the next method for details.	1434	Create a simple multi-line overlay box. See the next method for details.
1029		1435
…		…
1059		1465
1060	The methods currently supported on C<urxvt::overlay> objects are:	1466	The methods currently supported on C<urxvt::overlay> objects are:
1061		1467
1062	=over 4	1468	=over 4
1063		1469
1064	=item $overlay->set ($x, $y, $text, $rend)	1470	=item $overlay->set ($x, $y, $text[, $rend])
1065		1471
1066	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1472	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1067	text in rxvt-unicode's special encoding and an array of rendition values	1473	text in rxvt-unicode's special encoding and an array of rendition values
1068	at a specific position inside the overlay.	1474	at a specific position inside the overlay.
		1475
		1476	If C<$rend> is missing, then the rendition will not be changed.
1069		1477
1070	=item $overlay->hide	1478	=item $overlay->hide
1071		1479
1072	If visible, hide the overlay, but do not destroy it.	1480	If visible, hide the overlay, but do not destroy it.
1073		1481
…		…
1143		1551
1144	Normally its not a good idea to use this function, as programs might be	1552	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	1553	confused by changes in cursor position or scrolling. Its useful inside a
1146	C<on_add_lines> hook, though.	1554	C<on_add_lines> hook, though.
1147		1555
		1556	=item $term->scr_change_screen ($screen)
		1557
		1558	Switch to given screen - 0 primary, 1 secondary.
		1559
1148	=item $term->cmd_parse ($octets)	1560	=item $term->cmd_parse ($octets)
1149		1561
1150	Similar to C<scr_add_lines>, but the argument must be in the	1562	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	1563	locale-specific encoding of the terminal and can contain command sequences
1152	(escape codes) that will be interpreted.	1564	(escape codes) that will be interpreted.
1153		1565
1154	=item $term->tt_write ($octets)	1566	=item $term->tt_write ($octets)
1155		1567
1156	Write the octets given in C<$data> to the tty (i.e. as program input). To	1568	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1157	pass characters instead of octets, you should convert your strings first	1569	pass characters instead of octets, you should convert your strings first
1158	to the locale-specific encoding using C<< $term->locale_encode >>.	1570	to the locale-specific encoding using C<< $term->locale_encode >>.
		1571
		1572	=item $term->tt_paste ($octets)
		1573
		1574	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1575	CR and bracketing the data with control sequences if bracketed paste mode
		1576	is set.
1159		1577
1160	=item $old_events = $term->pty_ev_events ([$new_events])	1578	=item $old_events = $term->pty_ev_events ([$new_events])
1161		1579
1162	Replaces the event mask of the pty watcher by the given event mask. Can	1580	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	1581	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	1582	description of C<< urxvt::timer->events >>. Make sure to always restore
1165	the previous value.	1583	the previous value.
1166		1584
		1585	=item $fd = $term->pty_fd
		1586
		1587	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1588	is used.
		1589
1167	=item $windowid = $term->parent	1590	=item $windowid = $term->parent
1168		1591
1169	Return the window id of the toplevel window.	1592	Return the window id of the toplevel window.
1170		1593
1171	=item $windowid = $term->vt	1594	=item $windowid = $term->vt
…		…
1177	Adds the specified events to the vt event mask. Useful e.g. when you want	1600	Adds the specified events to the vt event mask. Useful e.g. when you want
1178	to receive pointer events all the times:	1601	to receive pointer events all the times:
1179		1602
1180	$term->vt_emask_add (urxvt::PointerMotionMask);	1603	$term->vt_emask_add (urxvt::PointerMotionMask);
1181		1604
		1605	=item $term->focus_in
		1606
		1607	=item $term->focus_out
		1608
		1609	=item $term->key_press ($state, $keycode[, $time])
		1610
		1611	=item $term->key_release ($state, $keycode[, $time])
		1612
		1613	Deliver various fake events to to terminal.
		1614
1182	=item $window_width = $term->width	1615	=item $window_width = $term->width
1183		1616
1184	=item $window_height = $term->height	1617	=item $window_height = $term->height
1185		1618
1186	=item $font_width = $term->fwidth	1619	=item $font_width = $term->fwidth
…		…
1216	=item $env = $term->env	1649	=item $env = $term->env
1217		1650
1218	Returns a copy of the environment in effect for the terminal as a hashref	1651	Returns a copy of the environment in effect for the terminal as a hashref
1219	similar to C<\%ENV>.	1652	similar to C<\%ENV>.
1220		1653
		1654	=item @envv = $term->envv
		1655
		1656	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1657
		1658	=item @argv = $term->argv
		1659
		1660	Return the argument vector as this terminal, similar to @ARGV, but
		1661	includes the program name as first element.
		1662
1221	=cut	1663	=cut
1222		1664
1223	sub env {	1665	sub env {
1224	if (my $env = $_[0]->_env) {
1225	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1666	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1226	} else {
1227	+{ %ENV }
1228	}
1229	}	1667	}
1230		1668
1231	=item $modifiermask = $term->ModLevel3Mask	1669	=item $modifiermask = $term->ModLevel3Mask
1232		1670
1233	=item $modifiermask = $term->ModMetaMask	1671	=item $modifiermask = $term->ModMetaMask
1234		1672
1235	=item $modifiermask = $term->ModNumLockMask	1673	=item $modifiermask = $term->ModNumLockMask
1236		1674
1237	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1675	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.	1676	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1677
		1678	=item $screen = $term->current_screen
		1679
		1680	Returns the currently displayed screen (0 primary, 1 secondary).
		1681
		1682	=item $cursor_is_hidden = $term->hidden_cursor
		1683
		1684	Returns whether the cursor is currently hidden or not.
1239		1685
1240	=item $view_start = $term->view_start ([$newvalue])	1686	=item $view_start = $term->view_start ([$newvalue])
1241		1687
1242	Returns the row number of the topmost displayed line. Maximum value is	1688	Returns the row number of the topmost displayed line. Maximum value is
1243	C<0>, which displays the normal terminal contents. Lower values scroll	1689	C<0>, which displays the normal terminal contents. Lower values scroll
…		…
1251		1697
1252	Used after changing terminal contents to display them.	1698	Used after changing terminal contents to display them.
1253		1699
1254	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1700	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1255		1701
1256	Returns the text of the entire row with number C<$row_number>. Row C<0>	1702	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1257	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1703	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1258	terminal line. The scrollback buffer starts at line C<-1> and extends to
1259	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1704	terminal line. Nothing will be returned if a nonexistent line
1260	is requested.	1705	is requested.
1261		1706
1262	If C<$new_text> is specified, it will replace characters in the current	1707	If C<$new_text> is specified, it will replace characters in the current
1263	line, starting at column C<$start_col> (default C<0>), which is useful	1708	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	1709	to replace only parts of a line. The font index in the rendition will
1265	automatically be updated.	1710	automatically be updated.
1266		1711
1267	C<$text> is in a special encoding: tabs and wide characters that use more	1712	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	1713	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1269	(C<chr 65535>). Characters with combining characters and other characters	1714	characters. Characters with combining characters and other characters that
1270	that do not fit into the normal tetx encoding will be replaced with	1715	do not fit into the normal text encoding will be replaced with characters
1271	characters in the private use area.	1716	in the private use area.
1272		1717
1273	You have to obey this encoding when changing text. The advantage is	1718	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	1719	that C<substr> and similar functions work on screen cells and not on
1275	characters.	1720	characters.
1276		1721
…		…
1420	where one character corresponds to one screen cell. See	1865	where one character corresponds to one screen cell. See
1421	C<< $term->ROW_t >> for details.	1866	C<< $term->ROW_t >> for details.
1422		1867
1423	=item $string = $term->special_decode $text	1868	=item $string = $term->special_decode $text
1424		1869
1425	Converts rxvt-unicodes text reprsentation into a perl string. See	1870	Converts rxvt-unicodes text representation into a perl string. See
1426	C<< $term->ROW_t >> for details.	1871	C<< $term->ROW_t >> for details.
1427		1872
1428	=item $success = $term->grab_button ($button, $modifiermask)	1873	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1429		1874
		1875	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1876
1430	Registers a synchronous button grab. See the XGrabButton manpage.	1877	Register/unregister a synchronous button grab. See the XGrabButton
		1878	manpage.
1431		1879
1432	=item $success = $term->grab ($eventtime[, $sync])	1880	=item $success = $term->grab ($eventtime[, $sync])
1433		1881
1434	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1882	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1435	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1883	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1436		1884
1437	=item $term->allow_events_async	1885	=item $term->allow_events_async
1438		1886
1439	Calls XAllowEvents with AsyncBoth for the most recent grab.	1887	Calls XAllowEvents with AsyncBoth for the most recent grab.
1440		1888
…		…
1447	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1895	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1448	recent grab.	1896	recent grab.
1449		1897
1450	=item $term->ungrab	1898	=item $term->ungrab
1451		1899
1452	Calls XUngrab for the most recent grab. Is called automatically on	1900	Calls XUngrabPointer and XUngrabKeyboard 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	1901	evaluation errors, as it is better to lose the grab in the error case as
1454	the session.	1902	the session.
		1903
		1904	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1905
		1906	=item $atom_name = $term->XGetAtomName ($atom)
		1907
		1908	=item @atoms = $term->XListProperties ($window)
		1909
		1910	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1911
		1912	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1913
		1914	=item $term->XDeleteProperty ($window, $property)
		1915
		1916	=item $window = $term->DefaultRootWindow
		1917
		1918	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1919
		1920	=item $term->XMapWindow ($window)
		1921
		1922	=item $term->XUnmapWindow ($window)
		1923
		1924	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1925
		1926	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1927
		1928	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1929
		1930	Various X or X-related functions. The C<$term> object only serves as
		1931	the source of the display, otherwise those functions map more-or-less
		1932	directly onto the X functions of the same name.
1455		1933
1456	=back	1934	=back
1457		1935
1458	=cut	1936	=cut
1459		1937
…		…
1523	my ($self, $text, $cb) = @_;	2001	my ($self, $text, $cb) = @_;
1524		2002
1525	$self->add_item ({ type => "button", text => $text, activate => $cb});	2003	$self->add_item ({ type => "button", text => $text, activate => $cb});
1526	}	2004	}
1527		2005
1528	=item $popup->add_toggle ($text, $cb, $initial_value)	2006	=item $popup->add_toggle ($text, $initial_value, $cb)
1529		2007
1530	Adds a toggle/checkbox item to the popup. Teh callback gets called	2008	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	2009	whenever it gets toggled, with a boolean indicating its new value as its
1532	argument.	2010	first argument.
1533		2011
1534	=cut	2012	=cut
1535		2013
1536	sub add_toggle {	2014	sub add_toggle {
1537	my ($self, $text, $cb, $value) = @_;	2015	my ($self, $text, $value, $cb) = @_;
1538		2016
1539	my $item; $item = {	2017	my $item; $item = {
1540	type => "button",	2018	type => "button",
1541	text => " $text",	2019	text => " $text",
1542	value => $value,	2020	value => $value,
…		…
1561	my $env = $self->{term}->env;	2039	my $env = $self->{term}->env;
1562	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2040	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1563	delete $env->{LC_ALL};	2041	delete $env->{LC_ALL};
1564	$env->{LC_CTYPE} = $self->{term}->locale;	2042	$env->{LC_CTYPE} = $self->{term}->locale;
1565		2043
1566	urxvt::term->new ($env, $self->{term}->resource ("name"),	2044	my $term = urxvt::term->new (
1567	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	2045	$env, "popup",
		2046	"--perl-lib" => "", "--perl-ext-common" => "",
		2047	"-pty-fd" => -1, "-sl" => 0,
		2048	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1568	"--transient-for" => $self->{term}->parent,	2049	"--transient-for" => $self->{term}->parent,
1569	"-display" => $self->{term}->display_id,	2050	"-display" => $self->{term}->display_id,
1570	"-pe" => "urxvt-popup")	2051	"-pe" => "urxvt-popup",
1571	or die "unable to create popup window\n";	2052	) or die "unable to create popup window\n";
		2053
		2054	unless (delete $term->{urxvt_popup_init_done}) {
		2055	$term->ungrab;
		2056	$term->destroy;
		2057	die "unable to initialise popup window\n";
		2058	}
1572	}	2059	}
1573		2060
1574	sub DESTROY {	2061	sub DESTROY {
1575	my ($self) = @_;	2062	my ($self) = @_;
1576		2063
1577	delete $self->{term}{_destroy}{$self};	2064	delete $self->{term}{_destroy}{$self};
1578	$self->{term}->ungrab;	2065	$self->{term}->ungrab;
1579	}	2066	}
1580		2067
1581	=back	2068	=back
		2069
		2070	=cut
		2071
		2072	package urxvt::watcher;
1582		2073
1583	=head2 The C<urxvt::timer> Class	2074	=head2 The C<urxvt::timer> Class
1584		2075
1585	This class implements timer watchers/events. Time is represented as a	2076	This class implements timer watchers/events. Time is represented as a
1586	fractional number of seconds since the epoch. Example:	2077	fractional number of seconds since the epoch. Example:
…		…
1590	->new	2081	->new
1591	->interval (1)	2082	->interval (1)
1592	->cb (sub {	2083	->cb (sub {
1593	$term->{overlay}->set (0, 0,	2084	$term->{overlay}->set (0, 0,
1594	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2085	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1595	});	2086	});
1596		2087
1597	=over 4	2088	=over 4
1598		2089
1599	=item $timer = new urxvt::timer	2090	=item $timer = new urxvt::timer
1600		2091
…		…
1603		2094
1604	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2095	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1605		2096
1606	Set the callback to be called when the timer triggers.	2097	Set the callback to be called when the timer triggers.
1607		2098
1608	=item $tstamp = $timer->at
1609
1610	Return the time this watcher will fire next.
1611
1612	=item $timer = $timer->set ($tstamp)	2099	=item $timer = $timer->set ($tstamp[, $interval])
1613		2100
1614	Set the time the event is generated to $tstamp.	2101	Set the time the event is generated to $tstamp (and optionally specifies a
		2102	new $interval).
1615		2103
1616	=item $timer = $timer->interval ($interval)	2104	=item $timer = $timer->interval ($interval)
1617		2105
1618	Normally (and when C<$interval> is C<0>), the timer will automatically	2106	By default (and when C<$interval> is C<0>), the timer will automatically
1619	stop after it has fired once. If C<$interval> is non-zero, then the timer	2107	stop after it has fired once. If C<$interval> is non-zero, then the timer
1620	is automatically rescheduled at the given intervals.	2108	is automatically rescheduled at the given intervals.
1621		2109
1622	=item $timer = $timer->start	2110	=item $timer = $timer->start
1623		2111
1624	Start the timer.	2112	Start the timer.
1625		2113
1626	=item $timer = $timer->start ($tstamp)	2114	=item $timer = $timer->start ($tstamp[, $interval])
1627		2115
1628	Set the event trigger time to C<$tstamp> and start the timer.	2116	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2117	also replaces the interval.
		2118
		2119	=item $timer = $timer->after ($delay[, $interval])
		2120
		2121	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1629		2122
1630	=item $timer = $timer->stop	2123	=item $timer = $timer->stop
1631		2124
1632	Stop the timer.	2125	Stop the timer.
1633		2126
…		…
1639		2132
1640	$term->{socket} = ...	2133	$term->{socket} = ...
1641	$term->{iow} = urxvt::iow	2134	$term->{iow} = urxvt::iow
1642	->new	2135	->new
1643	->fd (fileno $term->{socket})	2136	->fd (fileno $term->{socket})
1644	->events (urxvt::EVENT_READ)	2137	->events (urxvt::EV_READ)
1645	->start	2138	->start
1646	->cb (sub {	2139	->cb (sub {
1647	my ($iow, $revents) = @_;	2140	my ($iow, $revents) = @_;
1648	# $revents must be 1 here, no need to check	2141	# $revents must be 1 here, no need to check
1649	sysread $term->{socket}, my $buf, 8192	2142	sysread $term->{socket}, my $buf, 8192
…		…
1662	Set the callback to be called when io events are triggered. C<$reventmask>	2155	Set the callback to be called when io events are triggered. C<$reventmask>
1663	is a bitset as described in the C<events> method.	2156	is a bitset as described in the C<events> method.
1664		2157
1665	=item $iow = $iow->fd ($fd)	2158	=item $iow = $iow->fd ($fd)
1666		2159
1667	Set the filedescriptor (not handle) to watch.	2160	Set the file descriptor (not handle) to watch.
1668		2161
1669	=item $iow = $iow->events ($eventmask)	2162	=item $iow = $iow->events ($eventmask)
1670		2163
1671	Set the event mask to watch. The only allowed values are	2164	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	2165	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1673	together, or C<urxvt::EVENT_NONE>.	2166	together, or C<urxvt::EV_NONE>.
1674		2167
1675	=item $iow = $iow->start	2168	=item $iow = $iow->start
1676		2169
1677	Start watching for requested events on the given handle.	2170	Start watching for requested events on the given handle.
1678		2171
1679	=item $iow = $iow->stop	2172	=item $iow = $iow->stop
1680		2173
1681	Stop watching for events on the given filehandle.	2174	Stop watching for events on the given file handle.
		2175
		2176	=back
		2177
		2178	=head2 The C<urxvt::iw> Class
		2179
		2180	This class implements idle watchers, that get called automatically when
		2181	the process is idle. They should return as fast as possible, after doing
		2182	some useful work.
		2183
		2184	=over 4
		2185
		2186	=item $iw = new urxvt::iw
		2187
		2188	Create a new idle watcher object in stopped state.
		2189
		2190	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2191
		2192	Set the callback to be called when the watcher triggers.
		2193
		2194	=item $timer = $timer->start
		2195
		2196	Start the watcher.
		2197
		2198	=item $timer = $timer->stop
		2199
		2200	Stop the watcher.
		2201
		2202	=back
		2203
		2204	=head2 The C<urxvt::pw> Class
		2205
		2206	This class implements process watchers. They create an event whenever a
		2207	process exits, after which they stop automatically.
		2208
		2209	my $pid = fork;
		2210	...
		2211	$term->{pw} = urxvt::pw
		2212	->new
		2213	->start ($pid)
		2214	->cb (sub {
		2215	my ($pw, $exit_status) = @_;
		2216	...
		2217	});
		2218
		2219	=over 4
		2220
		2221	=item $pw = new urxvt::pw
		2222
		2223	Create a new process watcher in stopped state.
		2224
		2225	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2226
		2227	Set the callback to be called when the timer triggers.
		2228
		2229	=item $pw = $timer->start ($pid)
		2230
		2231	Tells the watcher to start watching for process C<$pid>.
		2232
		2233	=item $pw = $pw->stop
		2234
		2235	Stop the watcher.
1682		2236
1683	=back	2237	=back
1684		2238
1685	=head1 ENVIRONMENT	2239	=head1 ENVIRONMENT
1686		2240
…		…
1695		2249
1696	=item >= 3 - script loading and management	2250	=item >= 3 - script loading and management
1697		2251
1698	=item >=10 - all called hooks	2252	=item >=10 - all called hooks
1699		2253
1700	=item >=11 - hook reutrn values	2254	=item >=11 - hook return values
1701		2255
1702	=back	2256	=back
1703		2257
1704	=head1 AUTHOR	2258	=head1 AUTHOR
1705		2259
1706	Marc Lehmann <pcg@goof.com>	2260	Marc Lehmann <schmorp@schmorp.de>
1707	http://software.schmorp.de/pkg/rxvt-unicode	2261	http://software.schmorp.de/pkg/rxvt-unicode
1708		2262
1709	=cut	2263	=cut
1710		2264
1711	1	2265	1
		2266
		2267	# vim: sw=3:

Diff Legend

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