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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.85 by root, Thu Jan 12 03:32:56 2006 UTC vs.
Revision 1.182 by sf-exg, Wed Feb 17 08:27:56 2010 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>
39		42
		43	Or by adding them to the resource for extensions loaded by default:
		44
		45	URxvt.perl-ext-common: default,selection-autotransform
		46
40	=over 4	47	=over 4
41		48
42	=item selection (enabled by default)	49	=item selection (enabled by default)
43		50
44	(More) intelligent selection. This extension tries to be more intelligent	51	(More) intelligent selection. This extension tries to be more intelligent
45	when the user extends selections (double-click). Right now, it tries to	52	when the user extends selections (double-click and further clicks). Right
46	select urls and complete shell-quoted arguments, which is very convenient,	53	now, it tries to select words, urls and complete shell-quoted
47	too, if your F<ls> supports C<--quoting-style=shell>.	54	arguments, which is very convenient, too, if your F<ls> supports
		55	C<--quoting-style=shell>.
48		56
		57	A double-click usually selects the word under the cursor, further clicks
		58	will enlarge the selection.
		59
		60	The selection works by trying to match a number of regexes and displaying
		61	them in increasing order of length. You can add your own regexes by
		62	specifying resources of the form:
		63
		64	URxvt.selection.pattern-0: perl-regex
		65	URxvt.selection.pattern-1: perl-regex
		66	...
		67
		68	The index number (0, 1...) must not have any holes, and each regex must
		69	contain at least one pair of capturing parentheses, which will be used for
		70	the match. For example, the following adds a regex that matches everything
		71	between two vertical bars:
		72
		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: ^(/[^:]+):\
		81
		82	You can look at the source of the selection extension to see more
		83	interesting uses, such as parsing a line from beginning to end.
		84
49	It also offers the following bindable keyboard command:	85	This extension also offers following bindable keyboard commands:
50		86
51	=over 4	87	=over 4
52		88
53	=item rot13	89	=item rot13
54		90
…		…
61	=item option-popup (enabled by default)	97	=item option-popup (enabled by default)
62		98
63	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
64	runtime.	100	runtime.
65		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
66	=item selection-popup (enabled by default)	119	=item selection-popup (enabled by default)
67		120
68	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
69	text into various other formats/action (such as uri unescaping, perl	122	text into various other formats/action (such as uri unescaping, perl
70	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	};
71		143
72	=item searchable-scrollback<hotkey> (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
73		145
74	Adds regex search functionality to the scrollback buffer, triggered	146	Adds regex search functionality to the scrollback buffer, triggered
75	by a hotkey (default: C<M-s>). When in search mode, normal terminal	147	by a hotkey (default: C<M-s>). While in search mode, normal terminal
76	input/output is suspended.	148	input/output is suspended and a regex is displayed at the bottom of the
		149	screen.
77		150
78	C</> starts an incremental regex search, C<n> searches further, C<p> or	151	Inputting characters appends them to the regex and continues incremental
79	C<N> jump to the previous match, C<G> jumps to the bottom and clears the	152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
80	history, C<enter> leaves search mode at the current position and C<escape>	153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
81	returns to the original position.	154	bottom. C<Escape> leaves search mode and returns to the point where search
		155	was started, while C<Enter> or C<Return> stay at the current position and
		156	additionally stores the first match in the current line into the primary
		157	selection if the C<Shift> modifier is active.
82		158
83	=item digital-clock	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.
84		162
85	Displays a digital clock using the built-in overlay.	163	See L<perlre> for more info about perl regular expression syntax.
86		164
87	=item mark-urls	165	=item readline (enabled by default)
88		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.
		189
		190	=item selection-autotransform
		191
		192	This selection allows you to do automatic transforms on a selection
		193	whenever a selection is made.
		194
		195	It works by specifying perl snippets (most useful is a single C<s///>
		196	operator) that modify C<$_> as resources:
		197
		198	URxvt.selection-autotransform.0: transform
		199	URxvt.selection-autotransform.1: transform
		200	...
		201
		202	For example, the following will transform selections of the form
		203	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		204	$word>:
		205
		206	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		207
		208	And this example matches the same,but replaces it with vi-commands you can
		209	paste directly into your (vi :) editor:
		210
		211	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		212
		213	Of course, this can be modified to suit your needs and your editor :)
		214
		215	To expand the example above to typical perl error messages ("XXX at
		216	FILENAME line YYY."), you need a slightly more elaborate solution:
		217
		218	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		219	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		220
		221	The first line tells the selection code to treat the unchanging part of
		222	every error message as a selection pattern, and the second line transforms
		223	the message into vi commands to load the file.
		224
		225	=item tabbed
		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
89	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
90	make them clickable. When middle-clicked, the program specified in the	251	matching a certain pattern and make it clickable. When clicked with the
91	resource C<urlLauncher> (default C<x-www-browser>) will be started.	252	mouse button specified in the C<matcher.button> resource (default 2, or
		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 from the keyboard.
		265	Simply bind a keysym to "perl:matcher" as seen in the example below.
		266
		267	Example configuration:
		268
		269	URxvt.perl-ext: default,matcher
		270	URxvt.urlLauncher: sensible-browser
		271	URxvt.keysym.C-Delete: perl:matcher
		272	URxvt.matcher.button: 1
		273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:\|$)
		275	URxvt.matcher.launcher.2: gvim +$2 $1
		276
		277	=item xim-onthespot
		278
		279	This (experimental) perl extension implements OnTheSpot editing. It does
		280	not work perfectly, and some input methods don't seem to work well with
		281	OnTheSpot editing in general, but it seems to work at least for SCIM and
		282	kinput2.
		283
		284	You enable it by specifying this extension and a preedit style of
		285	C<OnTheSpot>, i.e.:
		286
		287	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		288
		289	=item kuake<hotkey>
		290
		291	A very primitive quake-console-like extension. It was inspired by a
		292	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		293	user presses a global accelerator key (by default C<F10>), the terminal
		294	will show or hide itself. Another press of the accelerator key will hide
		295	or show it again.
		296
		297	Initially, the window will not be shown when using this extension.
		298
		299	This is useful if you need a single terminal that is not using any desktop
		300	space most of the time but is quickly available at the press of a key.
		301
		302	The accelerator key is grabbed regardless of any modifiers, so this
		303	extension will actually grab a physical key just for this function.
		304
		305	If you want a quake-like animation, tell your window manager to do so
		306	(fvwm can do it).
		307
		308	=item overlay-osc
		309
		310	This extension implements some OSC commands to display timed popups on the
		311	screen - useful for status displays from within scripts. You have to read
		312	the sources for more info.
92		313
93	=item block-graphics-to-ascii	314	=item block-graphics-to-ascii
94		315
95	A not very useful example of filtering all text output to the terminal,	316	A not very useful example of filtering all text output to the terminal
96	by replacing all line-drawing characters (U+2500 .. U+259F) by a	317	by replacing all line-drawing characters (U+2500 .. U+259F) by a
97	similar-looking ascii character.	318	similar-looking ascii character.
		319
		320	=item digital-clock
		321
		322	Displays a digital clock using the built-in overlay.
		323
		324	=item remote-clipboard
		325
		326	Somewhat of a misnomer, this extension adds two menu entries to the
		327	selection popup that allows one to run external commands to store the
		328	selection somewhere and fetch it again.
		329
		330	We use it to implement a "distributed selection mechanism", which just
		331	means that one command uploads the file to a remote server, and another
		332	reads it.
		333
		334	The commands can be set using the C<URxvt.remote-selection.store> and
		335	C<URxvt.remote-selection.fetch> resources. The first should read the
		336	selection to store from STDIN (always in UTF-8), the second should provide
		337	the selection data on STDOUT (also in UTF-8).
		338
		339	The defaults (which are likely useless to you) use rsh and cat:
		340
		341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		343
		344	=item selection-pastebin
		345
		346	This is a little rarely useful extension that uploads the selection as
		347	textfile to a remote site (or does other things). (The implementation is
		348	not currently secure for use in a multiuser environment as it writes to
		349	F</tmp> directly.).
		350
		351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		352	i.e.
		353
		354	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		355
		356	Pressing this combination runs a command with C<%> replaced by the name of
		357	the textfile. This command can be set via a resource:
		358
		359	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		360
		361	And the default is likely not useful to anybody but the few people around
		362	here :)
		363
		364	The name of the textfile is the hex encoded md5 sum of the selection, so
		365	the same content should lead to the same filename.
		366
		367	After a successful upload the selection will be replaced by the text given
		368	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		369	for the filename):
		370
		371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		372
		373	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		374	the double C</> characters as comment start. Use C<\057\057> instead,
		375	which works regardless of wether xrdb is used to parse the resource file
		376	or not.
		377
		378	=item macosx-clipboard and macosx-clipboard-native
		379
		380	These two modules implement an extended clipboard for Mac OS X. They are
		381	used like this:
		382
		383	URxvt.perl-ext-common: default,macosx-clipboard
		384	URxvt.keysym.M-c: perl:macosx-clipboard:copy
		385	URxvt.keysym.M-v: perl:macosx-clipboard:paste
		386
		387	The difference between them is that the native variant requires a
		388	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		390	simpler etc. etc.
98		391
99	=item example-refresh-hooks	392	=item example-refresh-hooks
100		393
101	Displays a very simple digital clock in the upper right corner of the	394	Displays a very simple digital clock in the upper right corner of the
102	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
…		…
124		417
125	=over 4	418	=over 4
126		419
127	=item $text	420	=item $text
128		421
129	Rxvt-unicodes special way of encoding text, where one "unicode" character	422	Rxvt-unicode's special way of encoding text, where one "unicode" character
130	always represents one screen cell. See L<ROW_t> for a discussion of this format.	423	always represents one screen cell. See L<ROW_t> for a discussion of this format.
131		424
132	=item $string	425	=item $string
133		426
134	A perl text string, with an emphasis on I<text>. It can store all unicode	427	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
142		435
143	=back	436	=back
144		437
145	=head2 Extension Objects	438	=head2 Extension Objects
146		439
147	Very perl extension is a perl class. A separate perl object is created	440	Every perl extension is a perl class. A separate perl object is created
148	for each terminal and each extension and passed as the first parameter to	441	for each terminal, and each terminal has its own set of extenion objects,
149	hooks. So extensions can use their C<$self> object without having to think	442	which are passed as the first parameter to hooks. So extensions can use
150	about other extensions, with the exception of methods and members that	443	their C<$self> object without having to think about clashes with other
		444	extensions or other terminals, with the exception of methods and members
151	begin with an underscore character C<_>: these are reserved for internal	445	that begin with an underscore character C<_>: these are reserved for
152	use.	446	internal use.
153		447
154	Although it isn't a C<urxvt::term> object, you can call all methods of the	448	Although it isn't a C<urxvt::term> object, you can call all methods of the
155	C<urxvt::term> class on this object.	449	C<urxvt::term> class on this object.
156		450
157	It has the following methods and data members:	451	It has the following methods and data members:
…		…
178	=head2 Hooks	472	=head2 Hooks
179		473
180	The following subroutines can be declared in extension files, and will be	474	The following subroutines can be declared in extension files, and will be
181	called whenever the relevant event happens.	475	called whenever the relevant event happens.
182		476
183	The first argument passed to them is an extension oject as described in	477	The first argument passed to them is an extension object as described in
184	the in the C<Extension Objects> section.	478	the in the C<Extension Objects> section.
185		479
186	B<All> of these hooks must return a boolean value. If it is true, then the	480	B<All> of these hooks must return a boolean value. If any of the called
187	event counts as being I<consumed>, and the invocation of other hooks is	481	hooks returns true, then the event counts as being I<consumed>, and the
188	skipped, and the relevant action might not be carried out by the C++ code.	482	relevant action might not be carried out by the C++ code.
189		483
190	I<< When in doubt, return a false value (preferably C<()>). >>	484	I<< When in doubt, return a false value (preferably C<()>). >>
191		485
192	=over 4	486	=over 4
193		487
194	=item on_init $term	488	=item on_init $term
195		489
196	Called after a new terminal object has been initialized, but before	490	Called after a new terminal object has been initialized, but before
197	windows are created or the command gets run. Most methods are unsafe to	491	windows are created or the command gets run. Most methods are unsafe to
198	call or deliver senseless data, as terminal size and other characteristics	492	call or deliver senseless data, as terminal size and other characteristics
199	have not yet been determined. You can safely query and change resources,	493	have not yet been determined. You can safely query and change resources
200	though.	494	and options, though. For many purposes the C<on_start> hook is a better
		495	place.
		496
		497	=item on_start $term
		498
		499	Called at the very end of initialisation of a new terminal, just before
		500	trying to map (display) the toplevel and returning to the main loop.
		501
		502	=item on_destroy $term
		503
		504	Called whenever something tries to destroy terminal, when the terminal is
		505	still fully functional (not for long, though).
201		506
202	=item on_reset $term	507	=item on_reset $term
203		508
204	Called after the screen is "reset" for any reason, such as resizing or	509	Called after the screen is "reset" for any reason, such as resizing or
205	control sequences. Here is where you can react on changes to size-related	510	control sequences. Here is where you can react on changes to size-related
206	variables.	511	variables.
207		512
208	=item on_start $term	513	=item on_child_start $term, $pid
209		514
210	Called at the very end of initialisation of a new terminal, just before	515	Called just after the child process has been C<fork>ed.
211	returning to the mainloop.	516
		517	=item on_child_exit $term, $status
		518
		519	Called just after the child process has exited. C<$status> is the status
		520	from C<waitpid>.
212		521
213	=item on_sel_make $term, $eventtime	522	=item on_sel_make $term, $eventtime
214		523
215	Called whenever a selection has been made by the user, but before the	524	Called whenever a selection has been made by the user, but before the
216	selection text is copied, so changes to the beginning, end or type of the	525	selection text is copied, so changes to the beginning, end or type of the
…		…
223		532
224	Called whenever a selection has been copied, but before the selection is	533	Called whenever a selection has been copied, but before the selection is
225	requested from the server. The selection text can be queried and changed	534	requested from the server. The selection text can be queried and changed
226	by calling C<< $term->selection >>.	535	by calling C<< $term->selection >>.
227		536
228	Returning a true value aborts selection grabbing. It will still be hilighted.	537	Returning a true value aborts selection grabbing. It will still be highlighted.
229		538
230	=item on_sel_extend $term	539	=item on_sel_extend $term
231		540
232	Called whenever the user tries to extend the selection (e.g. with a double	541	Called whenever the user tries to extend the selection (e.g. with a double
233	click) and is either supposed to return false (normal operation), or	542	click) and is either supposed to return false (normal operation), or
234	should extend the selection itelf and return true to suppress the built-in	543	should extend the selection itself and return true to suppress the built-in
235	processing. This can happen multiple times, as long as the callback	544	processing. This can happen multiple times, as long as the callback
236	returns true, it will be called on every further click by the user and is	545	returns true, it will be called on every further click by the user and is
237	supposed to enlarge the selection more and more, if possible.	546	supposed to enlarge the selection more and more, if possible.
238		547
239	See the F<selection> example extension.	548	See the F<selection> example extension.
240		549
241	=item on_view_change $term, $offset	550	=item on_view_change $term, $offset
242		551
243	Called whenever the view offset changes, i..e the user or program	552	Called whenever the view offset changes, i.e. the user or program
244	scrolls. Offset C<0> means display the normal terminal, positive values	553	scrolls. Offset C<0> means display the normal terminal, positive values
245	show this many lines of scrollback.	554	show this many lines of scrollback.
246		555
247	=item on_scroll_back $term, $lines, $saved	556	=item on_scroll_back $term, $lines, $saved
248		557
…		…
252		561
253	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	562	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
254	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	563	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
255	number of lines that will be in the scrollback buffer.	564	number of lines that will be in the scrollback buffer.
256		565
257	=item on_osc_seq $term, $string	566	=item on_osc_seq $term, $op, $args, $resp
		567
		568	Called on every OSC sequence and can be used to suppress it or modify its
		569	behaviour. The default should be to return an empty list. A true value
		570	suppresses execution of the request completely. Make sure you don't get
		571	confused by recursive invocations when you output an OSC sequence within
		572	this callback.
		573
		574	C<on_osc_seq_perl> should be used for new behaviour.
		575
		576	=item on_osc_seq_perl $term, $args, $resp
258		577
259	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	578	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
260	operating system command) is processed. Cursor position and other state	579	operating system command) is processed. Cursor position and other state
261	information is up-to-date when this happens. For interoperability, the	580	information is up-to-date when this happens. For interoperability, the
262	string should start with the extension name and a colon, to distinguish	581	string should start with the extension name (sans -osc) and a semicolon,
263	it from commands for other extensions, and this might be enforced in the	582	to distinguish it from commands for other extensions, and this might be
264	future.	583	enforced in the future.
		584
		585	For example, C<overlay-osc> uses this:
		586
		587	sub on_osc_seq_perl {
		588	my ($self, $osc, $resp) = @_;
		589
		590	return unless $osc =~ s/^overlay;//;
		591
		592	... process remaining $osc string
		593	}
265		594
266	Be careful not ever to trust (in a security sense) the data you receive,	595	Be careful not ever to trust (in a security sense) the data you receive,
267	as its source can not easily be controleld (e-mail content, messages from	596	as its source can not easily be controlled (e-mail content, messages from
268	other users on the same system etc.).	597	other users on the same system etc.).
		598
		599	For responses, C<$resp> contains the end-of-args separator used by the
		600	sender.
269		601
270	=item on_add_lines $term, $string	602	=item on_add_lines $term, $string
271		603
272	Called whenever text is about to be output, with the text as argument. You	604	Called whenever text is about to be output, with the text as argument. You
273	can filter/change and output the text yourself by returning a true value	605	can filter/change and output the text yourself by returning a true value
…		…
294	later with the already-modified line (e.g. if unrelated parts change), so	626	later with the already-modified line (e.g. if unrelated parts change), so
295	you cannot just toggle rendition bits, but only set them.	627	you cannot just toggle rendition bits, but only set them.
296		628
297	=item on_refresh_begin $term	629	=item on_refresh_begin $term
298		630
299	Called just before the screen gets redrawn. Can be used for overlay	631	Called just before the screen gets redrawn. Can be used for overlay or
300	or similar effects by modify terminal contents in refresh_begin, and	632	similar effects by modifying the terminal contents in refresh_begin, and
301	restoring them in refresh_end. The built-in overlay and selection display	633	restoring them in refresh_end. The built-in overlay and selection display
302	code is run after this hook, and takes precedence.	634	code is run after this hook, and takes precedence.
303		635
304	=item on_refresh_end $term	636	=item on_refresh_end $term
305		637
306	Called just after the screen gets redrawn. See C<on_refresh_begin>.	638	Called just after the screen gets redrawn. See C<on_refresh_begin>.
307		639
308	=item on_keyboard_command $term, $string	640	=item on_user_command $term, $string
309		641
310	Called whenever the user presses a key combination that has a	642	Called whenever a user-configured event is being activated (e.g. via
311	C<perl:string> action bound to it (see description of the B<keysym>	643	a C<perl:string> action bound to a key, see description of the B<keysym>
312	resource in the @@RXVT_NAME@@(1) manpage).	644	resource in the @@RXVT_NAME@@(1) manpage).
		645
		646	The event is simply the action string. This interface is assumed to change
		647	slightly in the future.
		648
		649	=item on_resize_all_windows $tern, $new_width, $new_height
		650
		651	Called just after the new window size has been calculated, but before
		652	windows are actually being resized or hints are being set. If this hook
		653	returns TRUE, setting of the window hints is being skipped.
		654
		655	=item on_x_event $term, $event
		656
		657	Called on every X event received on the vt window (and possibly other
		658	windows). Should only be used as a last resort. Most event structure
		659	members are not passed.
		660
		661	=item on_root_event $term, $event
		662
		663	Like C<on_x_event>, but is called for events on the root window.
313		664
314	=item on_focus_in $term	665	=item on_focus_in $term
315		666
316	Called whenever the window gets the keyboard focus, before rxvt-unicode	667	Called whenever the window gets the keyboard focus, before rxvt-unicode
317	does focus in processing.	668	does focus in processing.
318		669
319	=item on_focus_out $term	670	=item on_focus_out $term
320		671
321	Called wheneever the window loses keyboard focus, before rxvt-unicode does	672	Called whenever the window loses keyboard focus, before rxvt-unicode does
322	focus out processing.	673	focus out processing.
323		674
		675	=item on_configure_notify $term, $event
		676
		677	=item on_property_notify $term, $event
		678
324	=item on_key_press $term, $event, $keysym, $octets	679	=item on_key_press $term, $event, $keysym, $octets
325		680
326	=item on_key_release $term, $event, $keysym	681	=item on_key_release $term, $event, $keysym
327		682
328	=item on_button_press $term, $event	683	=item on_button_press $term, $event
…		…
333		688
334	=item on_map_notify $term, $event	689	=item on_map_notify $term, $event
335		690
336	=item on_unmap_notify $term, $event	691	=item on_unmap_notify $term, $event
337		692
338	Called whenever the corresponding X event is received for the terminal If	693	Called whenever the corresponding X event is received for the terminal. If
339	the hook returns true, then the even will be ignored by rxvt-unicode.	694	the hook returns true, then the event will be ignored by rxvt-unicode.
340		695
341	The event is a hash with most values as named by Xlib (see the XEvent	696	The event is a hash with most values as named by Xlib (see the XEvent
342	manpage), with the additional members C<row> and C<col>, which are the row	697	manpage), with the additional members C<row> and C<col>, which are the
343	and column under the mouse cursor.	698	(real, not screen-based) row and column under the mouse cursor.
344		699
345	C<on_key_press> additionally receives the string rxvt-unicode would	700	C<on_key_press> additionally receives the string rxvt-unicode would
346	output, if any, in locale-specific encoding.	701	output, if any, in locale-specific encoding.
347		702
348	subwindow.	703	subwindow.
		704
		705	=item on_client_message $term, $event
		706
		707	=item on_wm_protocols $term, $event
		708
		709	=item on_wm_delete_window $term, $event
		710
		711	Called when various types of ClientMessage events are received (all with
		712	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		713
		714	=item on_bell $term
		715
		716	Called on receipt of a bell character.
349		717
350	=back	718	=back
351		719
352	=cut	720	=cut
353		721
…		…
359	use Scalar::Util ();	727	use Scalar::Util ();
360	use List::Util ();	728	use List::Util ();
361		729
362	our $VERSION = 1;	730	our $VERSION = 1;
363	our $TERM;	731	our $TERM;
		732	our @TERM_INIT;
		733	our @TERM_EXT;
364	our @HOOKNAME;	734	our @HOOKNAME;
365	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	735	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
366	our %OPTION;	736	our %OPTION;
367		737
368	our $LIBDIR;	738	our $LIBDIR;
369	our $RESNAME;	739	our $RESNAME;
370	our $RESCLASS;	740	our $RESCLASS;
371	our $RXVTNAME;	741	our $RXVTNAME;
372		742
		743	our $NOCHAR = chr 0xffff;
		744
373	=head2 Variables in the C<urxvt> Package	745	=head2 Variables in the C<urxvt> Package
374		746
375	=over 4	747	=over 4
376		748
377	=item $urxvt::LIBDIR	749	=item $urxvt::LIBDIR
…		…
389		761
390	=item $urxvt::TERM	762	=item $urxvt::TERM
391		763
392	The current terminal. This variable stores the current C<urxvt::term>	764	The current terminal. This variable stores the current C<urxvt::term>
393	object, whenever a callback/hook is executing.	765	object, whenever a callback/hook is executing.
		766
		767	=item @urxvt::TERM_INIT
		768
		769	All code references in this array will be called as methods of the next newly
		770	created C<urxvt::term> object (during the C<on_init> phase). The array
		771	gets cleared before the code references that were in it are being executed,
		772	so references can push themselves onto it again if they so desire.
		773
		774	This complements to the perl-eval command line option, but gets executed
		775	first.
		776
		777	=item @urxvt::TERM_EXT
		778
		779	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		780	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		781	but before other extensions. Gets cleared just like C<@TERM_INIT>.
394		782
395	=back	783	=back
396		784
397	=head2 Functions in the C<urxvt> Package	785	=head2 Functions in the C<urxvt> Package
398		786
…		…
413	Using this function has the advantage that its output ends up in the	801	Using this function has the advantage that its output ends up in the
414	correct place, e.g. on stderr of the connecting urxvtc client.	802	correct place, e.g. on stderr of the connecting urxvtc client.
415		803
416	Messages have a size limit of 1023 bytes currently.	804	Messages have a size limit of 1023 bytes currently.
417		805
418	=item $is_safe = urxvt::safe	806	=item @terms = urxvt::termlist
419		807
420	Returns true when it is safe to do potentially unsafe things, such as	808	Returns all urxvt::term objects that exist in this process, regardless of
421	evaluating perl code specified by the user. This is true when urxvt was	809	whether they are started, being destroyed etc., so be careful. Only term
422	started setuid or setgid.	810	objects that have perl extensions attached will be returned (because there
		811	is no urxvt::term objet associated with others).
423		812
424	=item $time = urxvt::NOW	813	=item $time = urxvt::NOW
425		814
426	Returns the "current time" (as per the event loop).	815	Returns the "current time" (as per the event loop).
427		816
428	=item urxvt::CurrentTime	817	=item urxvt::CurrentTime
429		818
430	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	819	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
431	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	820	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
432	Button4Mask, Button5Mask, AnyModifier	821	Button4Mask, Button5Mask, AnyModifier
		822
		823	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		824	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		825	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		826	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		827	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		828	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		829	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		830
		831	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		832	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		833	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		834	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		835	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		836	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		837	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
433		838
434	Various constants for use in X calls and event processing.	839	Various constants for use in X calls and event processing.
435		840
436	=back	841	=back
437		842
…		…
470		875
471	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	876	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
472		877
473	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	878	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
474		879
		880	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		881
475	Replace the foreground/background colour in the rendition mask with the	882	Replace the foreground/background colour in the rendition mask with the
476	specified one.	883	specified one.
477		884
478	=item $value = urxvt::GET_CUSTOM $rend	885	=item $value = urxvt::GET_CUSTOM $rend
479		886
…		…
488	=back	895	=back
489		896
490	=cut	897	=cut
491		898
492	BEGIN {	899	BEGIN {
493	urxvt->bootstrap;
494
495	# overwrite perl's warn	900	# overwrite perl's warn
496	*CORE::GLOBAL::warn = sub {	901	*CORE::GLOBAL::warn = sub {
497	my $msg = join "", @_;	902	my $msg = join "", @_;
498	$msg .= "\n"	903	$msg .= "\n"
499	unless $msg =~ /\n$/;	904	unless $msg =~ /\n$/;
500	urxvt::warn ($msg);	905	urxvt::warn ($msg);
501	};	906	};
502
503	# %ENV is the original startup environment
504	delete $ENV{IFS};
505	delete $ENV{CDPATH};
506	delete $ENV{BASH_ENV};
507	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
508	}	907	}
509		908
510	my @hook_count;	909	no warnings 'utf8';
		910
511	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	911	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
512		912
513	sub verbose {	913	sub verbose {
514	my ($level, $msg) = @_;	914	my ($level, $msg) = @_;
515	warn "$msg\n" if $level <= $verbosity;	915	warn "$msg\n" if $level <= $verbosity;
516	}	916	}
517		917
518	my $extension_pkg = "extension0000";
519	my %extension_pkg;	918	my %extension_pkg;
520		919
521	# load a single script into its own package, once only	920	# load a single script into its own package, once only
522	sub extension_package($) {	921	sub extension_package($) {
523	my ($path) = @_;	922	my ($path) = @_;
524		923
525	$extension_pkg{$path} \|\|= do {	924	$extension_pkg{$path} \|\|= do {
526	my $pkg = "urxvt::" . ($extension_pkg++);	925	$path =~ /([^\/\\]+)$/;
		926	my $pkg = $1;
		927	$pkg =~ s/[^[:word:]]/_/g;
		928	$pkg = "urxvt::ext::$pkg";
527		929
528	verbose 3, "loading extension '$path' into package '$pkg'";	930	verbose 3, "loading extension '$path' into package '$pkg'";
529		931
530	open my $fh, "<:raw", $path	932	open my $fh, "<:raw", $path
531	or die "$path: $!";	933	or die "$path: $!";
532		934
533	my $source = untaint	935	my $source =
534	"package $pkg; use strict; use utf8;\n"	936	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
535	. "use base urxvt::term::extension::;\n"
536	. "#line 1 \"$path\"\n{\n"	937	. "#line 1 \"$path\"\n{\n"
537	. (do { local $/; <$fh> })	938	. (do { local $/; <$fh> })
538	. "\n};\n1";	939	. "\n};\n1";
539		940
540	eval $source	941	eval $source
…		…
551	local $TERM = shift;	952	local $TERM = shift;
552	my $htype = shift;	953	my $htype = shift;
553		954
554	if ($htype == 0) { # INIT	955	if ($htype == 0) { # INIT
555	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	956	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
556		957
557	my %ext_arg;	958	my %ext_arg;
558		959
		960	{
		961	my @init = @TERM_INIT;
		962	@TERM_INIT = ();
		963	$_->($TERM) for @init;
		964	my @pkg = @TERM_EXT;
		965	@TERM_EXT = ();
		966	$TERM->register_package ($_) for @pkg;
		967	}
		968
559	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	969	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
560	if ($_ eq "default") {	970	if ($_ eq "default") {
561	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	971	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
562	} elsif (/^-(.*)$/) {	972	} elsif (/^-(.*)$/) {
563	delete $ext_arg{$1};	973	delete $ext_arg{$1};
564	} elsif (/^([^<]+)<(.*)>$/) {	974	} elsif (/^([^<]+)<(.*)>$/) {
565	push @{ $ext_arg{$1} }, $2;	975	push @{ $ext_arg{$1} }, $2;
566	} else {	976	} else {
567	$ext_arg{$_} \|\|= [];	977	$ext_arg{$_} \|\|= [];
568	}	978	}
569	}	979	}
570		980
571	while (my ($ext, $argv) = each %ext_arg) {	981	for my $ext (sort keys %ext_arg) {
572	my @files = grep -f $_, map "$_/$ext", @dirs;	982	my @files = grep -f $_, map "$_/$ext", @dirs;
573		983
574	if (@files) {	984	if (@files) {
575	$TERM->register_package (extension_package $files[0], $argv);	985	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
576	} else {	986	} else {
577	warn "perl extension '$ext' not found in perl library search path\n";	987	warn "perl extension '$ext' not found in perl library search path\n";
578	}	988	}
579	}	989	}
580		990
…		…
586		996
587	if (my $cb = $TERM->{_hook}[$htype]) {	997	if (my $cb = $TERM->{_hook}[$htype]) {
588	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	998	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
589	if $verbosity >= 10;	999	if $verbosity >= 10;
590		1000
591	keys %$cb;	1001	for my $pkg (keys %$cb) {
592
593	while (my ($pkg, $cb) = each %$cb) {
594	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	1002	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
595	and last;	1003	$retval \|\|= $retval_;
596		1004
597	if ($@) {	1005	if ($@) {
598	$TERM->ungrab; # better to lose the grab than the session	1006	$TERM->ungrab; # better to lose the grab than the session
599	warn $@;	1007	warn $@;
600	}	1008	}
…		…
603	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	1011	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
604	if $verbosity >= 11;	1012	if $verbosity >= 11;
605	}	1013	}
606		1014
607	if ($htype == 1) { # DESTROY	1015	if ($htype == 1) { # DESTROY
608	if (my $hook = delete $TERM->{_hook}) {
609	for my $htype (0..$#$hook) {
610	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
611	or set_should_invoke $htype, 0;
612	}
613	}
614
615	# clear package objects	1016	# clear package objects
616	%$_ = () for values %{ $TERM->{_pkg} };	1017	%$_ = () for values %{ $TERM->{_pkg} };
617		1018
618	# clear package	1019	# clear package
619	%$TERM = ();	1020	%$TERM = ();
620	}	1021	}
621		1022
622	$retval	1023	$retval
623	}	1024	}
624		1025
625	sub exec_async(@) {	1026	sub SET_COLOR($$$) {
626	my $pid = fork;	1027	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1028	}
627		1029
628	return	1030	sub rend2mask {
629	if !defined $pid or $pid;	1031	no strict 'refs';
630		1032	my ($str, $mask) = (@_, 0);
631	%ENV = %{ $TERM->env };	1033	my %color = ( fg => undef, bg => undef );
632		1034	my @failed;
633	exec @_;	1035	for my $spec ( split /\s+/, $str ) {
634	_exit 255;	1036	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1037	$color{lc($1)} = $2;
		1038	} else {
		1039	my $neg = $spec =~ s/^[-^]//;
		1040	unless ( exists &{"RS_$spec"} ) {
		1041	push @failed, $spec;
		1042	next;
		1043	}
		1044	my $cur = &{"RS_$spec"};
		1045	if ( $neg ) {
		1046	$mask &= ~$cur;
		1047	} else {
		1048	$mask \|= $cur;
		1049	}
		1050	}
		1051	}
		1052	($mask, @color{qw(fg bg)}, \@failed)
635	}	1053	}
636		1054
637	# urxvt::term::extension	1055	# urxvt::term::extension
638		1056
639	package urxvt::term::extension;	1057	package urxvt::term::extension;
…		…
645	while (my ($name, $cb) = each %hook) {	1063	while (my ($name, $cb) = each %hook) {
646	my $htype = $HOOKTYPE{uc $name};	1064	my $htype = $HOOKTYPE{uc $name};
647	defined $htype	1065	defined $htype
648	or Carp::croak "unsupported hook type '$name'";	1066	or Carp::croak "unsupported hook type '$name'";
649		1067
		1068	$self->set_should_invoke ($htype, +1)
650	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	1069	unless exists $self->{term}{_hook}[$htype]{$pkg};
651	$hook_count[$htype]++
652	or urxvt::set_should_invoke $htype, 1;
653	}
654		1070
655	$self->{term}{_hook}[$htype]{$pkg} = $cb;	1071	$self->{term}{_hook}[$htype]{$pkg} = $cb;
656	}	1072	}
657	}	1073	}
658		1074
…		…
663	for my $name (@hook) {	1079	for my $name (@hook) {
664	my $htype = $HOOKTYPE{uc $name};	1080	my $htype = $HOOKTYPE{uc $name};
665	defined $htype	1081	defined $htype
666	or Carp::croak "unsupported hook type '$name'";	1082	or Carp::croak "unsupported hook type '$name'";
667		1083
		1084	$self->set_should_invoke ($htype, -1)
668	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1085	if delete $self->{term}{_hook}[$htype]{$pkg};
669	--$hook_count[$htype]
670	or urxvt::set_should_invoke $htype, 0;
671	}
672	}	1086	}
673	}	1087	}
674		1088
675	our $AUTOLOAD;	1089	our $AUTOLOAD;
676		1090
…		…
714	is that you cannot use blocking APIs, but the non-blocking variant should	1128	is that you cannot use blocking APIs, but the non-blocking variant should
715	work.	1129	work.
716		1130
717	=cut	1131	=cut
718		1132
719	our $VERSION = 1;	1133	our $VERSION = '5.23';
720		1134
721	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1135	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
722	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1136	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
723		1137
724	sub timer {	1138	sub timer {
…		…
726		1140
727	my $cb = $arg{cb};	1141	my $cb = $arg{cb};
728		1142
729	urxvt::timer	1143	urxvt::timer
730	->new	1144	->new
731	->start (urxvt::NOW + $arg{after})	1145	->after ($arg{after}, $arg{interval})
732	->cb (sub {	1146	->cb ($arg{interval} ? $cb : sub {
733	$_[0]->stop; # need to cancel manually	1147	$_[0]->stop; # need to cancel manually
734	$cb->();	1148	$cb->();
735	})	1149	})
736	}	1150	}
737		1151
738	sub io {	1152	sub io {
739	my ($class, %arg) = @_;	1153	my ($class, %arg) = @_;
740		1154
741	my $cb = $arg{cb};	1155	my $cb = $arg{cb};
		1156	my $fd = fileno $arg{fh};
		1157	defined $fd or $fd = $arg{fh};
742		1158
743	bless [$arg{fh}, urxvt::iow	1159	bless [$arg{fh}, urxvt::iow
744	->new	1160	->new
745	->fd (fileno $arg{fh})	1161	->fd ($fd)
746	->events (($arg{poll} =~ /r/ ? 1 : 0)	1162	->events (($arg{poll} =~ /r/ ? 1 : 0)
747	\| ($arg{poll} =~ /w/ ? 2 : 0))	1163	\| ($arg{poll} =~ /w/ ? 2 : 0))
748	->start	1164	->start
749	->cb (sub {	1165	->cb ($cb)
750	$cb->(($_[1] & 1 ? 'r' : '')
751	. ($_[1] & 2 ? 'w' : ''));
752	})],
753	urxvt::anyevent::	1166	], urxvt::anyevent::
		1167	}
		1168
		1169	sub idle {
		1170	my ($class, %arg) = @_;
		1171
		1172	my $cb = $arg{cb};
		1173
		1174	urxvt::iw
		1175	->new
		1176	->start
		1177	->cb ($cb)
		1178	}
		1179
		1180	sub child {
		1181	my ($class, %arg) = @_;
		1182
		1183	my $cb = $arg{cb};
		1184
		1185	urxvt::pw
		1186	->new
		1187	->start ($arg{pid})
		1188	->cb (sub {
		1189	$_[0]->stop; # need to cancel manually
		1190	$cb->($_[0]->rpid, $_[0]->rstatus);
		1191	})
754	}	1192	}
755		1193
756	sub DESTROY {	1194	sub DESTROY {
757	$_[0][1]->stop;	1195	$_[0][1]->stop;
758	}	1196	}
759		1197
760	sub condvar {	1198	sub one_event {
761	bless \my $flag, urxvt::anyevent::condvar::
762	}
763
764	sub urxvt::anyevent::condvar::broadcast {
765	${$_[0]}++;
766	}
767
768	sub urxvt::anyevent::condvar::wait {
769	unless (${$_[0]}) {
770	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1199	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
771	}
772	}	1200	}
773		1201
774	package urxvt::term;	1202	package urxvt::term;
775		1203
776	=head2 The C<urxvt::term> Class	1204	=head2 The C<urxvt::term> Class
…		…
781		1209
782	# find on_xxx subs in the package and register them	1210	# find on_xxx subs in the package and register them
783	# as hooks	1211	# as hooks
784	sub register_package {	1212	sub register_package {
785	my ($self, $pkg, $argv) = @_;	1213	my ($self, $pkg, $argv) = @_;
		1214
		1215	no strict 'refs';
		1216
		1217	urxvt::verbose 6, "register package $pkg to $self";
		1218
		1219	@{"$pkg\::ISA"} = urxvt::term::extension::;
786		1220
787	my $proxy = bless {	1221	my $proxy = bless {
788	_pkg => $pkg,	1222	_pkg => $pkg,
789	argv => $argv,	1223	argv => $argv,
790	}, $pkg;	1224	}, $pkg;
…		…
806	hash which defines the environment of the new terminal.	1240	hash which defines the environment of the new terminal.
807		1241
808	Croaks (and probably outputs an error message) if the new instance	1242	Croaks (and probably outputs an error message) if the new instance
809	couldn't be created. Returns C<undef> if the new instance didn't	1243	couldn't be created. Returns C<undef> if the new instance didn't
810	initialise perl, and the terminal object otherwise. The C<init> and	1244	initialise perl, and the terminal object otherwise. The C<init> and
811	C<start> hooks will be called during this call.	1245	C<start> hooks will be called before this call returns, and are free to
		1246	refer to global data (which is race free).
812		1247
813	=cut	1248	=cut
814		1249
815	sub new {	1250	sub new {
816	my ($class, $env, @args) = @_;	1251	my ($class, $env, @args) = @_;
817		1252
		1253	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1254	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1255
818	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1256	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
819	}	1257	}
820		1258
821	=item $term->destroy	1259	=item $term->destroy
822		1260
823	Destroy the terminal object (close the window, free resources	1261	Destroy the terminal object (close the window, free resources
824	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1262	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
825	watchers (timers, io watchers) are still active.	1263	watchers (timers, io watchers) are still active.
826		1264
		1265	=item $term->exec_async ($cmd[, @args])
		1266
		1267	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1268	("starts") programs in the background. This function takes care of setting
		1269	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1270	be preferred over explicit calls to C<exec> or C<system>.
		1271
		1272	Returns the pid of the subprocess or C<undef> on error.
		1273
		1274	=cut
		1275
		1276	sub exec_async {
		1277	my $self = shift;
		1278
		1279	my $pid = fork;
		1280
		1281	return $pid
		1282	if !defined $pid or $pid;
		1283
		1284	%ENV = %{ $self->env };
		1285
		1286	exec @_;
		1287	urxvt::_exit 255;
		1288	}
		1289
827	=item $isset = $term->option ($optval[, $set])	1290	=item $isset = $term->option ($optval[, $set])
828		1291
829	Returns true if the option specified by C<$optval> is enabled, and	1292	Returns true if the option specified by C<$optval> is enabled, and
830	optionally change it. All option values are stored by name in the hash	1293	optionally change it. All option values are stored by name in the hash
831	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1294	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
832		1295
833	Here is a a likely non-exhaustive list of option names, please see the	1296	Here is a likely non-exhaustive list of option names, please see the
834	source file F</src/optinc.h> to see the actual list:	1297	source file F</src/optinc.h> to see the actual list:
835		1298
836	borderLess console cursorBlink cursorUnderline hold iconic insecure	1299	borderLess console cursorBlink cursorUnderline hold iconic insecure
837	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1300	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
838	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1301	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
839	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1302	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
840	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1303	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
841	tripleclickwords utmpInhibit visualBell	1304	transparent tripleclickwords utmpInhibit visualBell
842		1305
843	=item $value = $term->resource ($name[, $newval])	1306	=item $value = $term->resource ($name[, $newval])
844		1307
845	Returns the current resource value associated with a given name and	1308	Returns the current resource value associated with a given name and
846	optionally sets a new value. Setting values is most useful in the C<init>	1309	optionally sets a new value. Setting values is most useful in the C<init>
…		…
855	likely change).	1318	likely change).
856		1319
857	Please note that resource strings will currently only be freed when the	1320	Please note that resource strings will currently only be freed when the
858	terminal is destroyed, so changing options frequently will eat memory.	1321	terminal is destroyed, so changing options frequently will eat memory.
859		1322
860	Here is a a likely non-exhaustive list of resource names, not all of which	1323	Here is a likely non-exhaustive list of resource names, not all of which
861	are supported in every build, please see the source file F</src/rsinc.h>	1324	are supported in every build, please see the source file F</src/rsinc.h>
862	to see the actual list:	1325	to see the actual list:
863		1326
864	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1327	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
865	borderLess color cursorBlink cursorUnderline cutchars delete_key	1328	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
866	display_name embed ext_bwidth fade font geometry hold iconName	1329	display_name embed ext_bwidth fade font geometry hold iconName
867	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1330	imFont imLocale inputMethod insecure int_bwidth intensityStyles
868	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1331	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
869	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1332	modifier mouseWheelScrollPage name override_redirect pastableTabs path
870	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1333	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
871	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1334	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
872	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1335	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
873	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1336	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
874	shade term_name title transparent transparent_all tripleclickwords	1337	secondaryScreen secondaryScroll shade term_name title
875	utmpInhibit visualBell	1338	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1339	visualBell
876		1340
877	=cut	1341	=cut
878		1342
879	sub resource($$;$) {	1343	sub resource($$;$) {
880	my ($self, $name) = (shift, shift);	1344	my ($self, $name) = (shift, shift);
881	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1345	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
882	&urxvt::term::_resource	1346	goto &urxvt::term::_resource
883	}	1347	}
884		1348
885	=item $value = $term->x_resource ($pattern)	1349	=item $value = $term->x_resource ($pattern)
886		1350
887	Returns the X-Resource for the given pattern, excluding the program or	1351	Returns the X-Resource for the given pattern, excluding the program or
…		…
912		1376
913	=item ($row, $col) = $term->selection_beg ([$row, $col])	1377	=item ($row, $col) = $term->selection_beg ([$row, $col])
914		1378
915	=item ($row, $col) = $term->selection_end ([$row, $col])	1379	=item ($row, $col) = $term->selection_end ([$row, $col])
916		1380
917	Return the current values of the selection mark, begin or end positions,	1381	Return the current values of the selection mark, begin or end positions.
918	and optionally set them to new values.	1382
		1383	When arguments are given, then the selection coordinates are set to
		1384	C<$row> and C<$col>, and the selection screen is set to the current
		1385	screen.
		1386
		1387	=item $screen = $term->selection_screen ([$screen])
		1388
		1389	Returns the current selection screen, and then optionally sets it.
		1390
		1391	=item $term->selection_make ($eventtime[, $rectangular])
		1392
		1393	Tries to make a selection as set by C<selection_beg> and
		1394	C<selection_end>. If C<$rectangular> is true (default: false), a
		1395	rectangular selection will be made. This is the prefered function to make
		1396	a selection.
919		1397
920	=item $success = $term->selection_grab ($eventtime)	1398	=item $success = $term->selection_grab ($eventtime)
921		1399
922	Try to request the primary selection from the server (for example, as set	1400	Try to request the primary selection text from the server (for example, as
923	by the next method).	1401	set by the next method). No visual feedback will be given. This function
		1402	is mostly useful from within C<on_sel_grab> hooks.
924		1403
925	=item $oldtext = $term->selection ([$newtext])	1404	=item $oldtext = $term->selection ([$newtext])
926		1405
927	Return the current selection text and optionally replace it by C<$newtext>.	1406	Return the current selection text and optionally replace it by C<$newtext>.
928		1407
…		…
962		1441
963	The methods currently supported on C<urxvt::overlay> objects are:	1442	The methods currently supported on C<urxvt::overlay> objects are:
964		1443
965	=over 4	1444	=over 4
966		1445
967	=item $overlay->set ($x, $y, $text, $rend)	1446	=item $overlay->set ($x, $y, $text[, $rend])
968		1447
969	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1448	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
970	text in rxvt-unicode's special encoding and an array of rendition values	1449	text in rxvt-unicode's special encoding and an array of rendition values
971	at a specific position inside the overlay.	1450	at a specific position inside the overlay.
		1451
		1452	If C<$rend> is missing, then the rendition will not be changed.
972		1453
973	=item $overlay->hide	1454	=item $overlay->hide
974		1455
975	If visible, hide the overlay, but do not destroy it.	1456	If visible, hide the overlay, but do not destroy it.
976		1457
…		…
1021	Convert the given locale-encoded octets into a perl string.	1502	Convert the given locale-encoded octets into a perl string.
1022		1503
1023	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1504	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1024		1505
1025	XORs the rendition values in the given span with the provided value	1506	XORs the rendition values in the given span with the provided value
1026	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1507	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1027	to the selection.	1508	refresh hooks to provide effects similar to the selection.
1028		1509
1029	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1510	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1030		1511
1031	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1512	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1032	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1513	whitespace will additionally be xored with the C<$rstyle2>, which defaults
1033	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines	1514	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
1034	it instead.	1515	it instead. Both styles I<MUST NOT> contain font styles.
1035		1516
1036	=item $term->scr_bell	1517	=item $term->scr_bell
1037		1518
1038	Ring the bell!	1519	Ring the bell!
1039		1520
…		…
1046		1527
1047	Normally its not a good idea to use this function, as programs might be	1528	Normally its not a good idea to use this function, as programs might be
1048	confused by changes in cursor position or scrolling. Its useful inside a	1529	confused by changes in cursor position or scrolling. Its useful inside a
1049	C<on_add_lines> hook, though.	1530	C<on_add_lines> hook, though.
1050		1531
		1532	=item $term->scr_change_screen ($screen)
		1533
		1534	Switch to given screen - 0 primary, 1 secondary.
		1535
1051	=item $term->cmd_parse ($octets)	1536	=item $term->cmd_parse ($octets)
1052		1537
1053	Similar to C<scr_add_lines>, but the argument must be in the	1538	Similar to C<scr_add_lines>, but the argument must be in the
1054	locale-specific encoding of the terminal and can contain command sequences	1539	locale-specific encoding of the terminal and can contain command sequences
1055	(escape codes) that will be interpreted.	1540	(escape codes) that will be interpreted.
…		…
1065	Replaces the event mask of the pty watcher by the given event mask. Can	1550	Replaces the event mask of the pty watcher by the given event mask. Can
1066	be used to suppress input and output handling to the pty/tty. See the	1551	be used to suppress input and output handling to the pty/tty. See the
1067	description of C<< urxvt::timer->events >>. Make sure to always restore	1552	description of C<< urxvt::timer->events >>. Make sure to always restore
1068	the previous value.	1553	the previous value.
1069		1554
		1555	=item $fd = $term->pty_fd
		1556
		1557	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1558	is used.
		1559
1070	=item $windowid = $term->parent	1560	=item $windowid = $term->parent
1071		1561
1072	Return the window id of the toplevel window.	1562	Return the window id of the toplevel window.
1073		1563
1074	=item $windowid = $term->vt	1564	=item $windowid = $term->vt
1075		1565
1076	Return the window id of the terminal window.	1566	Return the window id of the terminal window.
1077		1567
		1568	=item $term->vt_emask_add ($x_event_mask)
		1569
		1570	Adds the specified events to the vt event mask. Useful e.g. when you want
		1571	to receive pointer events all the times:
		1572
		1573	$term->vt_emask_add (urxvt::PointerMotionMask);
		1574
		1575	=item $term->focus_in
		1576
		1577	=item $term->focus_out
		1578
		1579	=item $term->key_press ($state, $keycode[, $time])
		1580
		1581	=item $term->key_release ($state, $keycode[, $time])
		1582
		1583	Deliver various fake events to to terminal.
		1584
1078	=item $window_width = $term->width	1585	=item $window_width = $term->width
1079		1586
1080	=item $window_height = $term->height	1587	=item $window_height = $term->height
1081		1588
1082	=item $font_width = $term->fwidth	1589	=item $font_width = $term->fwidth
…		…
1095		1602
1096	=item $max_scrollback = $term->saveLines	1603	=item $max_scrollback = $term->saveLines
1097		1604
1098	=item $nrow_plus_saveLines = $term->total_rows	1605	=item $nrow_plus_saveLines = $term->total_rows
1099		1606
1100	=item $lines_in_scrollback = $term->nsaved	1607	=item $topmost_scrollback_row = $term->top_row
1101		1608
1102	Return various integers describing terminal characteristics.	1609	Return various integers describing terminal characteristics.
1103		1610
1104	=item $x_display = $term->display_id	1611	=item $x_display = $term->display_id
1105		1612
…		…
1112	=item $env = $term->env	1619	=item $env = $term->env
1113		1620
1114	Returns a copy of the environment in effect for the terminal as a hashref	1621	Returns a copy of the environment in effect for the terminal as a hashref
1115	similar to C<\%ENV>.	1622	similar to C<\%ENV>.
1116		1623
		1624	=item @envv = $term->envv
		1625
		1626	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1627
		1628	=item @argv = $term->argv
		1629
		1630	Return the argument vector as this terminal, similar to @ARGV, but
		1631	includes the program name as first element.
		1632
1117	=cut	1633	=cut
1118		1634
1119	sub env {	1635	sub env {
1120	if (my $env = $_[0]->_env) {
1121	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1636	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1122	} else {
1123	+{ %ENV }
1124	}
1125	}	1637	}
1126		1638
1127	=item $modifiermask = $term->ModLevel3Mask	1639	=item $modifiermask = $term->ModLevel3Mask
1128		1640
1129	=item $modifiermask = $term->ModMetaMask	1641	=item $modifiermask = $term->ModMetaMask
…		…
1131	=item $modifiermask = $term->ModNumLockMask	1643	=item $modifiermask = $term->ModNumLockMask
1132		1644
1133	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1645	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1134	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1646	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1135		1647
		1648	=item $screen = $term->current_screen
		1649
		1650	Returns the currently displayed screen (0 primary, 1 secondary).
		1651
		1652	=item $cursor_is_hidden = $term->hidden_cursor
		1653
		1654	Returns whether the cursor is currently hidden or not.
		1655
1136	=item $view_start = $term->view_start ([$newvalue])	1656	=item $view_start = $term->view_start ([$newvalue])
1137		1657
1138	Returns the negative row number of the topmost line. Minimum value is	1658	Returns the row number of the topmost displayed line. Maximum value is
1139	C<0>, which displays the normal terminal contents. Larger values scroll	1659	C<0>, which displays the normal terminal contents. Lower values scroll
1140	this many lines into the scrollback buffer.	1660	this many lines into the scrollback buffer.
1141		1661
1142	=item $term->want_refresh	1662	=item $term->want_refresh
1143		1663
1144	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1664	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1147		1667
1148	Used after changing terminal contents to display them.	1668	Used after changing terminal contents to display them.
1149		1669
1150	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1670	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1151		1671
1152	Returns the text of the entire row with number C<$row_number>. Row C<0>	1672	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1153	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1673	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1154	terminal line. The scrollback buffer starts at line C<-1> and extends to
1155	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1674	terminal line. Nothing will be returned if a nonexistent line
1156	is requested.	1675	is requested.
1157		1676
1158	If C<$new_text> is specified, it will replace characters in the current	1677	If C<$new_text> is specified, it will replace characters in the current
1159	line, starting at column C<$start_col> (default C<0>), which is useful	1678	line, starting at column C<$start_col> (default C<0>), which is useful
1160	to replace only parts of a line. The font index in the rendition will	1679	to replace only parts of a line. The font index in the rendition will
1161	automatically be updated.	1680	automatically be updated.
1162		1681
1163	C<$text> is in a special encoding: tabs and wide characters that use more	1682	C<$text> is in a special encoding: tabs and wide characters that use more
1164	than one cell when displayed are padded with urxvt::NOCHAR characters	1683	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1165	(C<chr 65535>). Characters with combining characters and other characters	1684	characters. Characters with combining characters and other characters that
1166	that do not fit into the normal tetx encoding will be replaced with	1685	do not fit into the normal text encoding will be replaced with characters
1167	characters in the private use area.	1686	in the private use area.
1168		1687
1169	You have to obey this encoding when changing text. The advantage is	1688	You have to obey this encoding when changing text. The advantage is
1170	that C<substr> and similar functions work on screen cells and not on	1689	that C<substr> and similar functions work on screen cells and not on
1171	characters.	1690	characters.
1172		1691
…		…
1316	where one character corresponds to one screen cell. See	1835	where one character corresponds to one screen cell. See
1317	C<< $term->ROW_t >> for details.	1836	C<< $term->ROW_t >> for details.
1318		1837
1319	=item $string = $term->special_decode $text	1838	=item $string = $term->special_decode $text
1320		1839
1321	Converts rxvt-unicodes text reprsentation into a perl string. See	1840	Converts rxvt-unicodes text representation into a perl string. See
1322	C<< $term->ROW_t >> for details.	1841	C<< $term->ROW_t >> for details.
1323		1842
1324	=item $success = $term->grab_button ($button, $modifiermask)	1843	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1325		1844
		1845	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1846
1326	Registers a synchronous button grab. See the XGrabButton manpage.	1847	Register/unregister a synchronous button grab. See the XGrabButton
		1848	manpage.
1327		1849
1328	=item $success = $term->grab ($eventtime[, $sync])	1850	=item $success = $term->grab ($eventtime[, $sync])
1329		1851
1330	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1852	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1331	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1853	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1332		1854
1333	=item $term->allow_events_async	1855	=item $term->allow_events_async
1334		1856
1335	Calls XAllowEvents with AsyncBoth for the most recent grab.	1857	Calls XAllowEvents with AsyncBoth for the most recent grab.
1336		1858
…		…
1343	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1865	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1344	recent grab.	1866	recent grab.
1345		1867
1346	=item $term->ungrab	1868	=item $term->ungrab
1347		1869
1348	Calls XUngrab for the most recent grab. Is called automatically on	1870	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1349	evaluation errors, as it is better to lose the grab in the error case as	1871	evaluation errors, as it is better to lose the grab in the error case as
1350	the session.	1872	the session.
		1873
		1874	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1875
		1876	=item $atom_name = $term->XGetAtomName ($atom)
		1877
		1878	=item @atoms = $term->XListProperties ($window)
		1879
		1880	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1881
		1882	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1883
		1884	=item $term->XDeleteProperty ($window, $property)
		1885
		1886	=item $window = $term->DefaultRootWindow
		1887
		1888	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1889
		1890	=item $term->XMapWindow ($window)
		1891
		1892	=item $term->XUnmapWindow ($window)
		1893
		1894	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1895
		1896	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1897
		1898	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1899
		1900	Various X or X-related functions. The C<$term> object only serves as
		1901	the source of the display, otherwise those functions map more-or-less
		1902	directly onto the X functions of the same name.
1351		1903
1352	=back	1904	=back
1353		1905
1354	=cut	1906	=cut
1355		1907
…		…
1419	my ($self, $text, $cb) = @_;	1971	my ($self, $text, $cb) = @_;
1420		1972
1421	$self->add_item ({ type => "button", text => $text, activate => $cb});	1973	$self->add_item ({ type => "button", text => $text, activate => $cb});
1422	}	1974	}
1423		1975
1424	=item $popup->add_toggle ($text, $cb, $initial_value)	1976	=item $popup->add_toggle ($text, $initial_value, $cb)
1425		1977
1426	Adds a toggle/checkbox item to the popup. Teh callback gets called	1978	Adds a toggle/checkbox item to the popup. The callback gets called
1427	whenever it gets toggled, with a boolean indicating its value as its first	1979	whenever it gets toggled, with a boolean indicating its new value as its
1428	argument.	1980	first argument.
1429		1981
1430	=cut	1982	=cut
1431		1983
1432	sub add_toggle {	1984	sub add_toggle {
1433	my ($self, $text, $cb, $value) = @_;	1985	my ($self, $text, $value, $cb) = @_;
1434		1986
1435	my $item; $item = {	1987	my $item; $item = {
1436	type => "button",	1988	type => "button",
1437	text => " $text",	1989	text => " $text",
1438	value => $value,	1990	value => $value,
…		…
1457	my $env = $self->{term}->env;	2009	my $env = $self->{term}->env;
1458	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	2010	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1459	delete $env->{LC_ALL};	2011	delete $env->{LC_ALL};
1460	$env->{LC_CTYPE} = $self->{term}->locale;	2012	$env->{LC_CTYPE} = $self->{term}->locale;
1461		2013
1462	urxvt::term->new ($env, $self->{term}->resource ("name"),	2014	my $term = urxvt::term->new (
1463	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	2015	$env, "popup",
		2016	"--perl-lib" => "", "--perl-ext-common" => "",
		2017	"-pty-fd" => -1, "-sl" => 0,
		2018	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1464	"--transient-for" => $self->{term}->parent,	2019	"--transient-for" => $self->{term}->parent,
1465	"-display" => $self->{term}->display_id,	2020	"-display" => $self->{term}->display_id,
1466	"-pe" => "urxvt-popup")	2021	"-pe" => "urxvt-popup",
1467	or die "unable to create popup window\n";	2022	) or die "unable to create popup window\n";
		2023
		2024	unless (delete $term->{urxvt_popup_init_done}) {
		2025	$term->ungrab;
		2026	$term->destroy;
		2027	die "unable to initialise popup window\n";
		2028	}
1468	}	2029	}
1469		2030
1470	sub DESTROY {	2031	sub DESTROY {
1471	my ($self) = @_;	2032	my ($self) = @_;
1472		2033
1473	delete $self->{term}{_destroy}{$self};	2034	delete $self->{term}{_destroy}{$self};
1474	$self->{term}->ungrab;	2035	$self->{term}->ungrab;
1475	}	2036	}
1476		2037
1477	=back	2038	=back
		2039
		2040	=cut
		2041
		2042	package urxvt::watcher;
1478		2043
1479	=head2 The C<urxvt::timer> Class	2044	=head2 The C<urxvt::timer> Class
1480		2045
1481	This class implements timer watchers/events. Time is represented as a	2046	This class implements timer watchers/events. Time is represented as a
1482	fractional number of seconds since the epoch. Example:	2047	fractional number of seconds since the epoch. Example:
…		…
1486	->new	2051	->new
1487	->interval (1)	2052	->interval (1)
1488	->cb (sub {	2053	->cb (sub {
1489	$term->{overlay}->set (0, 0,	2054	$term->{overlay}->set (0, 0,
1490	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2055	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1491	});	2056	});
1492		2057
1493	=over 4	2058	=over 4
1494		2059
1495	=item $timer = new urxvt::timer	2060	=item $timer = new urxvt::timer
1496		2061
…		…
1499		2064
1500	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2065	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1501		2066
1502	Set the callback to be called when the timer triggers.	2067	Set the callback to be called when the timer triggers.
1503		2068
1504	=item $tstamp = $timer->at
1505
1506	Return the time this watcher will fire next.
1507
1508	=item $timer = $timer->set ($tstamp)	2069	=item $timer = $timer->set ($tstamp[, $interval])
1509		2070
1510	Set the time the event is generated to $tstamp.	2071	Set the time the event is generated to $tstamp (and optionally specifies a
		2072	new $interval).
1511		2073
1512	=item $timer = $timer->interval ($interval)	2074	=item $timer = $timer->interval ($interval)
1513		2075
1514	Normally (and when C<$interval> is C<0>), the timer will automatically	2076	By default (and when C<$interval> is C<0>), the timer will automatically
1515	stop after it has fired once. If C<$interval> is non-zero, then the timer	2077	stop after it has fired once. If C<$interval> is non-zero, then the timer
1516	is automatically rescheduled at the given intervals.	2078	is automatically rescheduled at the given intervals.
1517		2079
1518	=item $timer = $timer->start	2080	=item $timer = $timer->start
1519		2081
1520	Start the timer.	2082	Start the timer.
1521		2083
1522	=item $timer = $timer->start ($tstamp)	2084	=item $timer = $timer->start ($tstamp[, $interval])
1523		2085
1524	Set the event trigger time to C<$tstamp> and start the timer.	2086	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2087	also replaces the interval.
		2088
		2089	=item $timer = $timer->after ($delay[, $interval])
		2090
		2091	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1525		2092
1526	=item $timer = $timer->stop	2093	=item $timer = $timer->stop
1527		2094
1528	Stop the timer.	2095	Stop the timer.
1529		2096
…		…
1535		2102
1536	$term->{socket} = ...	2103	$term->{socket} = ...
1537	$term->{iow} = urxvt::iow	2104	$term->{iow} = urxvt::iow
1538	->new	2105	->new
1539	->fd (fileno $term->{socket})	2106	->fd (fileno $term->{socket})
1540	->events (urxvt::EVENT_READ)	2107	->events (urxvt::EV_READ)
1541	->start	2108	->start
1542	->cb (sub {	2109	->cb (sub {
1543	my ($iow, $revents) = @_;	2110	my ($iow, $revents) = @_;
1544	# $revents must be 1 here, no need to check	2111	# $revents must be 1 here, no need to check
1545	sysread $term->{socket}, my $buf, 8192	2112	sysread $term->{socket}, my $buf, 8192
…		…
1558	Set the callback to be called when io events are triggered. C<$reventmask>	2125	Set the callback to be called when io events are triggered. C<$reventmask>
1559	is a bitset as described in the C<events> method.	2126	is a bitset as described in the C<events> method.
1560		2127
1561	=item $iow = $iow->fd ($fd)	2128	=item $iow = $iow->fd ($fd)
1562		2129
1563	Set the filedescriptor (not handle) to watch.	2130	Set the file descriptor (not handle) to watch.
1564		2131
1565	=item $iow = $iow->events ($eventmask)	2132	=item $iow = $iow->events ($eventmask)
1566		2133
1567	Set the event mask to watch. The only allowed values are	2134	Set the event mask to watch. The only allowed values are
1568	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2135	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1569	together, or C<urxvt::EVENT_NONE>.	2136	together, or C<urxvt::EV_NONE>.
1570		2137
1571	=item $iow = $iow->start	2138	=item $iow = $iow->start
1572		2139
1573	Start watching for requested events on the given handle.	2140	Start watching for requested events on the given handle.
1574		2141
1575	=item $iow = $iow->stop	2142	=item $iow = $iow->stop
1576		2143
1577	Stop watching for events on the given filehandle.	2144	Stop watching for events on the given file handle.
		2145
		2146	=back
		2147
		2148	=head2 The C<urxvt::iw> Class
		2149
		2150	This class implements idle watchers, that get called automatically when
		2151	the process is idle. They should return as fast as possible, after doing
		2152	some useful work.
		2153
		2154	=over 4
		2155
		2156	=item $iw = new urxvt::iw
		2157
		2158	Create a new idle watcher object in stopped state.
		2159
		2160	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2161
		2162	Set the callback to be called when the watcher triggers.
		2163
		2164	=item $timer = $timer->start
		2165
		2166	Start the watcher.
		2167
		2168	=item $timer = $timer->stop
		2169
		2170	Stop the watcher.
		2171
		2172	=back
		2173
		2174	=head2 The C<urxvt::pw> Class
		2175
		2176	This class implements process watchers. They create an event whenever a
		2177	process exits, after which they stop automatically.
		2178
		2179	my $pid = fork;
		2180	...
		2181	$term->{pw} = urxvt::pw
		2182	->new
		2183	->start ($pid)
		2184	->cb (sub {
		2185	my ($pw, $exit_status) = @_;
		2186	...
		2187	});
		2188
		2189	=over 4
		2190
		2191	=item $pw = new urxvt::pw
		2192
		2193	Create a new process watcher in stopped state.
		2194
		2195	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2196
		2197	Set the callback to be called when the timer triggers.
		2198
		2199	=item $pw = $timer->start ($pid)
		2200
		2201	Tells the watcher to start watching for process C<$pid>.
		2202
		2203	=item $pw = $pw->stop
		2204
		2205	Stop the watcher.
1578		2206
1579	=back	2207	=back
1580		2208
1581	=head1 ENVIRONMENT	2209	=head1 ENVIRONMENT
1582		2210
…		…
1591		2219
1592	=item >= 3 - script loading and management	2220	=item >= 3 - script loading and management
1593		2221
1594	=item >=10 - all called hooks	2222	=item >=10 - all called hooks
1595		2223
1596	=item >=11 - hook reutrn values	2224	=item >=11 - hook return values
1597		2225
1598	=back	2226	=back
1599		2227
1600	=head1 AUTHOR	2228	=head1 AUTHOR
1601		2229
…		…
1603	http://software.schmorp.de/pkg/rxvt-unicode	2231	http://software.schmorp.de/pkg/rxvt-unicode
1604		2232
1605	=cut	2233	=cut
1606		2234
1607	1	2235	1
		2236
		2237	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.85 by root, Thu Jan 12 03:32:56 2006 UTC vs. Revision 1.182 by sf-exg, Wed Feb 17 08:27:56 2010 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.85 by root, Thu Jan 12 03:32:56 2006 UTC vs.
Revision 1.182 by sf-exg, Wed Feb 17 08:27:56 2010 UTC