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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.73 by root, Tue Jan 10 04:23:39 2006 UTC vs.
Revision 1.215 by root, Thu Jun 7 16:30:58 2012 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 "vars"' 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	=head2 Prepackaged Extensions	31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
32		33
		34	=head1 PREPACKAGED EXTENSIONS
		35
33	This section describes the extensiosn delivered with this version. 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	Intelligent selection. This extension tries to be more intelligent when	51	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	52	when the user extends selections (double-click and further clicks). Right
46	urls and complete shell-quoted arguments, which is very convenient, too,	53	now, it tries to select words, urls and complete shell-quoted
47	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
49	It also offers the following bindable event:	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
		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.	122	text into various other formats/action (such as uri unescaping, perl
		123	evaluation, web-browser starting etc.), depending on content.
70		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	};
		143
71	=item searchable-scrollback (enabled by default)	144	=item searchable-scrollback<hotkey> (enabled by default)
72		145
73	Adds regex search functionality to the scrollback buffer, triggered by a	146	Adds regex search functionality to the scrollback buffer, triggered
74	hotkey (default: C<M-s>). When in search mode, terminal input/output is	147	by a hotkey (default: C<M-s>). While in search mode, normal terminal
75	suspended, C</> starts an incremental regex search, C<n> searches further,	148	input/output is suspended and a regex is displayed at the bottom of the
76	C<p> jumps to the previous match. C<enter> leaves search mode at the	149	screen.
77	current position and C<escape> returns to the original position.
78		150
79	=item digital-clock	151	Inputting characters appends them to the regex and continues incremental
		152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		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.
80		158
81	Displays a digital clock using the built-in overlay.	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.
82		162
83	=item mark-urls	163	See L<perlre> for more info about perl regular expression syntax.
84		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.
		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
85	Uses per-line display filtering (C<on_line_update>) to underline urls.	250	Uses per-line display filtering (C<on_line_update>) to underline text
		251	matching a certain pattern and make it clickable. When clicked with the
		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 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.
86		315
87	=item block-graphics-to-ascii	316	=item block-graphics-to-ascii
88		317
89	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
90	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
91	similar-looking ascii character.	320	similar-looking ascii character.
		321
		322	=item digital-clock
		323
		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.
92		393
93	=item example-refresh-hooks	394	=item example-refresh-hooks
94		395
95	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
96	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
97	overlays or changes.	398	overlays or changes.
98		399
		400	=item confirm-paste
		401
		402	Displays a confirmation dialog when a paste containing at least a full
		403	line is detected.
		404
		405	=item bell-command
		406
		407	Runs the command specified by the C<URxvt.bell-command> resource when
		408	a bell event occurs. For example, the following pops up a notification
		409	bubble with the text "Beep, Beep" using notify-send:
		410
		411	URxvt.bell-command: notify-send "Beep, Beep"
		412
99	=back	413	=back
		414
		415	=head1 API DOCUMENTATION
100		416
101	=head2 General API Considerations	417	=head2 General API Considerations
102		418
103	All objects (such as terminals, time watchers etc.) are typical	419	All objects (such as terminals, time watchers etc.) are typical
104	reference-to-hash objects. The hash can be used to store anything you	420	reference-to-hash objects. The hash can be used to store anything you
…		…
116		432
117	=over 4	433	=over 4
118		434
119	=item $text	435	=item $text
120		436
121	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
122	always represents one screen cell. See L<row_t> for a discussion of this format.	438	always represents one screen cell. See L<ROW_t> for a discussion of this format.
123		439
124	=item $string	440	=item $string
125		441
126	A perl text string, with an emphasis on I<text>. It can store all unicode	442	A perl text string, with an emphasis on I<text>. It can store all unicode
127	characters and is to be distinguished with text encoded in a specific	443	characters and is to be distinguished with text encoded in a specific
…		…
130	=item $octets	446	=item $octets
131		447
132	Either binary data or - more common - a text string encoded in a	448	Either binary data or - more common - a text string encoded in a
133	locale-specific way.	449	locale-specific way.
134		450
		451	=item $keysym
		452
		453	an integer that is a valid X11 keysym code. You can convert a string
		454	into a keysym and viceversa by using C<XStringToKeysym> and
		455	C<XKeysymToString>.
		456
135	=back	457	=back
136		458
137	=head2 Extension Objects	459	=head2 Extension Objects
138		460
139	Very perl extension is a perl class. A separate perl object is created	461	Every perl extension is a perl class. A separate perl object is created
140	for each terminal and each extension and passed as the first parameter to	462	for each terminal, and each terminal has its own set of extension objects,
141	hooks. So extensions can use their C<$self> object without having to think	463	which are passed as the first parameter to hooks. So extensions can use
142	about other extensions, with the exception of methods and members that	464	their C<$self> object without having to think about clashes with other
		465	extensions or other terminals, with the exception of methods and members
143	begin with an underscore character C<_>: these are reserved for internal	466	that begin with an underscore character C<_>: these are reserved for
144	use.	467	internal use.
145		468
146	Although it isn't a C<urxvt::term> object, you can call all methods of the	469	Although it isn't a C<urxvt::term> object, you can call all methods of the
147	C<urxvt::term> class on this object.	470	C<urxvt::term> class on this object.
148		471
149	It has the following methods and data members:	472	It has the following methods and data members:
…		…
170	=head2 Hooks	493	=head2 Hooks
171		494
172	The following subroutines can be declared in extension files, and will be	495	The following subroutines can be declared in extension files, and will be
173	called whenever the relevant event happens.	496	called whenever the relevant event happens.
174		497
175	The first argument passed to them is an extension oject as described in	498	The first argument passed to them is an extension object as described in
176	the in the C<Extension Objects> section.	499	the in the C<Extension Objects> section.
177		500
178	B<All> of these hooks must return a boolean value. If it is true, then the	501	B<All> of these hooks must return a boolean value. If any of the called
179	event counts as being I<consumed>, and the invocation of other hooks is	502	hooks returns true, then the event counts as being I<consumed>, and the
180	skipped, and the relevant action might not be carried out by the C++ code.	503	relevant action might not be carried out by the C++ code.
181		504
182	I<< When in doubt, return a false value (preferably C<()>). >>	505	I<< When in doubt, return a false value (preferably C<()>). >>
183		506
184	=over 4	507	=over 4
185		508
186	=item on_init $term	509	=item on_init $term
187		510
188	Called after a new terminal object has been initialized, but before	511	Called after a new terminal object has been initialized, but before
189	windows are created or the command gets run. Most methods are unsafe to	512	windows are created or the command gets run. Most methods are unsafe to
190	call or deliver senseless data, as terminal size and other characteristics	513	call or deliver senseless data, as terminal size and other characteristics
191	have not yet been determined. You can safely query and change resources,	514	have not yet been determined. You can safely query and change resources
192	though.	515	and options, though. For many purposes the C<on_start> hook is a better
		516	place.
		517
		518	=item on_start $term
		519
		520	Called at the very end of initialisation of a new terminal, just before
		521	trying to map (display) the toplevel and returning to the main loop.
		522
		523	=item on_destroy $term
		524
		525	Called whenever something tries to destroy terminal, when the terminal is
		526	still fully functional (not for long, though).
193		527
194	=item on_reset $term	528	=item on_reset $term
195		529
196	Called after the screen is "reset" for any reason, such as resizing or	530	Called after the screen is "reset" for any reason, such as resizing or
197	control sequences. Here is where you can react on changes to size-related	531	control sequences. Here is where you can react on changes to size-related
198	variables.	532	variables.
199		533
200	=item on_start $term	534	=item on_child_start $term, $pid
201		535
202	Called at the very end of initialisation of a new terminal, just before	536	Called just after the child process has been C<fork>ed.
203	returning to the mainloop.	537
		538	=item on_child_exit $term, $status
		539
		540	Called just after the child process has exited. C<$status> is the status
		541	from C<waitpid>.
204		542
205	=item on_sel_make $term, $eventtime	543	=item on_sel_make $term, $eventtime
206		544
207	Called whenever a selection has been made by the user, but before the	545	Called whenever a selection has been made by the user, but before the
208	selection text is copied, so changes to the beginning, end or type of the	546	selection text is copied, so changes to the beginning, end or type of the
…		…
215		553
216	Called whenever a selection has been copied, but before the selection is	554	Called whenever a selection has been copied, but before the selection is
217	requested from the server. The selection text can be queried and changed	555	requested from the server. The selection text can be queried and changed
218	by calling C<< $term->selection >>.	556	by calling C<< $term->selection >>.
219		557
220	Returning a true value aborts selection grabbing. It will still be hilighted.	558	Returning a true value aborts selection grabbing. It will still be highlighted.
221		559
222	=item on_sel_extend $term	560	=item on_sel_extend $term
223		561
224	Called whenever the user tries to extend the selection (e.g. with a double	562	Called whenever the user tries to extend the selection (e.g. with a double
225	click) and is either supposed to return false (normal operation), or	563	click) and is either supposed to return false (normal operation), or
226	should extend the selection itelf and return true to suppress the built-in	564	should extend the selection itself and return true to suppress the built-in
227	processing.	565	processing. This can happen multiple times, as long as the callback
		566	returns true, it will be called on every further click by the user and is
		567	supposed to enlarge the selection more and more, if possible.
228		568
229	See the F<selection> example extension.	569	See the F<selection> example extension.
230		570
231	=item on_view_change $term, $offset	571	=item on_view_change $term, $offset
232		572
233	Called whenever the view offset changes, i..e the user or program	573	Called whenever the view offset changes, i.e. the user or program
234	scrolls. Offset C<0> means display the normal terminal, positive values	574	scrolls. Offset C<0> means display the normal terminal, positive values
235	show this many lines of scrollback.	575	show this many lines of scrollback.
236		576
237	=item on_scroll_back $term, $lines, $saved	577	=item on_scroll_back $term, $lines, $saved
238		578
…		…
242		582
243	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	583	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
244	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	584	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
245	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
246		586
247	=item on_osc_seq $term, $string	587	=item on_osc_seq $term, $op, $args, $resp
		588
		589	Called on every OSC sequence and can be used to suppress it or modify its
		590	behaviour. The default should be to return an empty list. A true value
		591	suppresses execution of the request completely. Make sure you don't get
		592	confused by recursive invocations when you output an OSC sequence within
		593	this callback.
		594
		595	C<on_osc_seq_perl> should be used for new behaviour.
		596
		597	=item on_osc_seq_perl $term, $args, $resp
248		598
249	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
250	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
251	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
252	string should start with the extension name and a colon, to distinguish	602	string should start with the extension name (sans -osc) and a semicolon,
253	it from commands for other extensions, and this might be enforced in the	603	to distinguish it from commands for other extensions, and this might be
254	future.	604	enforced in the future.
		605
		606	For example, C<overlay-osc> uses this:
		607
		608	sub on_osc_seq_perl {
		609	my ($self, $osc, $resp) = @_;
		610
		611	return unless $osc =~ s/^overlay;//;
		612
		613	... process remaining $osc string
		614	}
255		615
256	Be careful not ever to trust (in a security sense) the data you receive,	616	Be careful not ever to trust (in a security sense) the data you receive,
257	as its source can not easily be controleld (e-mail content, messages from	617	as its source can not easily be controlled (e-mail content, messages from
258	other users on the same system etc.).	618	other users on the same system etc.).
		619
		620	For responses, C<$resp> contains the end-of-args separator used by the
		621	sender.
259		622
260	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
261		624
262	Called whenever text is about to be output, with the text as argument. You	625	Called whenever text is about to be output, with the text as argument. You
263	can filter/change and output the text yourself by returning a true value	626	can filter/change and output the text yourself by returning a true value
…		…
268	=item on_tt_write $term, $octets	631	=item on_tt_write $term, $octets
269		632
270	Called whenever some data is written to the tty/pty and can be used to	633	Called whenever some data is written to the tty/pty and can be used to
271	suppress or filter tty input.	634	suppress or filter tty input.
272		635
		636	=item on_tt_paste $term, $octets
		637
		638	Called whenever text is about to be pasted, with the text as argument. You
		639	can filter/change and paste the text yourself by returning a true value
		640	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		641	locale-encoded.
		642
273	=item on_line_update $term, $row	643	=item on_line_update $term, $row
274		644
275	Called whenever a line was updated or changed. Can be used to filter	645	Called whenever a line was updated or changed. Can be used to filter
276	screen output (e.g. underline urls or other useless stuff). Only lines	646	screen output (e.g. underline urls or other useless stuff). Only lines
277	that are being shown will be filtered, and, due to performance reasons,	647	that are being shown will be filtered, and, due to performance reasons,
…		…
284	later with the already-modified line (e.g. if unrelated parts change), so	654	later with the already-modified line (e.g. if unrelated parts change), so
285	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
286		656
287	=item on_refresh_begin $term	657	=item on_refresh_begin $term
288		658
289	Called just before the screen gets redrawn. Can be used for overlay	659	Called just before the screen gets redrawn. Can be used for overlay or
290	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
291	restoring them in refresh_end. The built-in overlay and selection display	661	restoring them in refresh_end. The built-in overlay and selection display
292	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
293		663
294	=item on_refresh_end $term	664	=item on_refresh_end $term
295		665
296	Called just after the screen gets redrawn. See C<on_refresh_begin>.	666	Called just after the screen gets redrawn. See C<on_refresh_begin>.
297		667
298	=item on_keyboard_command $term, $string	668	=item on_user_command $term, $string
299		669
300	Called whenever the user presses a key combination that has a	670	Called whenever a user-configured event is being activated (e.g. via
301	C<perl:string> action bound to it (see description of the B<keysym>	671	a C<perl:string> action bound to a key, see description of the B<keysym>
302	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
		673
		674	The event is simply the action string. This interface is assumed to change
		675	slightly in the future.
		676
		677	=item on_register_command $term, $keysym, $modifiermask, $string
		678
		679	Called after parsing a keysym resource but before registering the
		680	associated binding. If this hook returns TRUE the binding is not
		681	registered. It can be used to modify a binding by calling
		682	C<register_command>.
		683
		684	=item on_resize_all_windows $term, $new_width, $new_height
		685
		686	Called just after the new window size has been calculated, but before
		687	windows are actually being resized or hints are being set. If this hook
		688	returns TRUE, setting of the window hints is being skipped.
		689
		690	=item on_x_event $term, $event
		691
		692	Called on every X event received on the vt window (and possibly other
		693	windows). Should only be used as a last resort. Most event structure
		694	members are not passed.
		695
		696	=item on_root_event $term, $event
		697
		698	Like C<on_x_event>, but is called for events on the root window.
303		699
304	=item on_focus_in $term	700	=item on_focus_in $term
305		701
306	Called whenever the window gets the keyboard focus, before rxvt-unicode	702	Called whenever the window gets the keyboard focus, before rxvt-unicode
307	does focus in processing.	703	does focus in processing.
308		704
309	=item on_focus_out $term	705	=item on_focus_out $term
310		706
311	Called wheneever the window loses keyboard focus, before rxvt-unicode does	707	Called whenever the window loses keyboard focus, before rxvt-unicode does
312	focus out processing.	708	focus out processing.
313		709
		710	=item on_configure_notify $term, $event
		711
		712	=item on_property_notify $term, $event
		713
314	=item on_key_press $term, $event, $keysym, $octets	714	=item on_key_press $term, $event, $keysym, $octets
315		715
316	=item on_key_release $term, $event, $keysym	716	=item on_key_release $term, $event, $keysym
317		717
318	=item on_button_press $term, $event	718	=item on_button_press $term, $event
…		…
323		723
324	=item on_map_notify $term, $event	724	=item on_map_notify $term, $event
325		725
326	=item on_unmap_notify $term, $event	726	=item on_unmap_notify $term, $event
327		727
328	Called whenever the corresponding X event is received for the terminal If	728	Called whenever the corresponding X event is received for the terminal. If
329	the hook returns true, then the even will be ignored by rxvt-unicode.	729	the hook returns true, then the event will be ignored by rxvt-unicode.
330		730
331	The event is a hash with most values as named by Xlib (see the XEvent	731	The event is a hash with most values as named by Xlib (see the XEvent
332	manpage), with the additional members C<row> and C<col>, which are the row	732	manpage), with the additional members C<row> and C<col>, which are the
333	and column under the mouse cursor.	733	(real, not screen-based) row and column under the mouse cursor.
334		734
335	C<on_key_press> additionally receives the string rxvt-unicode would	735	C<on_key_press> additionally receives the string rxvt-unicode would
336	output, if any, in locale-specific encoding.	736	output, if any, in locale-specific encoding.
337		737
338	subwindow.	738	subwindow.
339		739
		740	=item on_client_message $term, $event
		741
		742	=item on_wm_protocols $term, $event
		743
		744	=item on_wm_delete_window $term, $event
		745
		746	Called when various types of ClientMessage events are received (all with
		747	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		748
		749	=item on_bell $term
		750
		751	Called on receipt of a bell character.
		752
340	=back	753	=back
341		754
		755	=cut
		756
		757	package urxvt;
		758
		759	use utf8;
		760	use strict 'vars';
		761	use Carp ();
		762	use Scalar::Util ();
		763	use List::Util ();
		764
		765	our $VERSION = 1;
		766	our $TERM;
		767	our @TERM_INIT; # should go, prevents async I/O etc.
		768	our @TERM_EXT; # should go, prevents async I/O etc.
		769	our @HOOKNAME;
		770	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		771	our %OPTION;
		772
		773	our $LIBDIR;
		774	our $RESNAME;
		775	our $RESCLASS;
		776	our $RXVTNAME;
		777
		778	our $NOCHAR = chr 0xffff;
		779
342	=head2 Variables in the C<urxvt> Package	780	=head2 Variables in the C<urxvt> Package
343		781
344	=over 4	782	=over 4
		783
		784	=item $urxvt::LIBDIR
		785
		786	The rxvt-unicode library directory, where, among other things, the perl
		787	modules and scripts are stored.
		788
		789	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		790
		791	The resource class and name rxvt-unicode uses to look up X resources.
		792
		793	=item $urxvt::RXVTNAME
		794
		795	The basename of the installed binaries, usually C<urxvt>.
345		796
346	=item $urxvt::TERM	797	=item $urxvt::TERM
347		798
348	The current terminal. This variable stores the current C<urxvt::term>	799	The current terminal. This variable stores the current C<urxvt::term>
349	object, whenever a callback/hook is executing.	800	object, whenever a callback/hook is executing.
350		801
		802	=item @urxvt::TERM_INIT
		803
		804	All code references in this array will be called as methods of the next newly
		805	created C<urxvt::term> object (during the C<on_init> phase). The array
		806	gets cleared before the code references that were in it are being executed,
		807	so references can push themselves onto it again if they so desire.
		808
		809	This complements to the perl-eval command line option, but gets executed
		810	first.
		811
		812	=item @urxvt::TERM_EXT
		813
		814	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		815	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		816	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		817
351	=back	818	=back
352		819
353	=head2 Functions in the C<urxvt> Package	820	=head2 Functions in the C<urxvt> Package
354		821
355	=over 4	822	=over 4
356		823
357	=item $term = new urxvt [arg...]
358
359	Creates a new terminal, very similar as if you had started it with
360	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
361	if the new instance couldn't be created. Returns C<undef> if the new
362	instance didn't initialise perl, and the terminal object otherwise. The
363	C<init> and C<start> hooks will be called during the call.
364
365	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
366		825
367	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
368	costs! The only time this is acceptable is when the terminal process	827	include a trailing newline). Avoid at all costs! The only time this
369	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
370		830
371	=item urxvt::warn $string	831	=item urxvt::warn $string
372		832
373	Calls C<rxvt_warn> with the given string which should not include a	833	Calls C<rxvt_warn> with the given string which should include a trailing
374	newline. The module also overwrites the C<warn> builtin with a function	834	newline. The module also overwrites the C<warn> builtin with a function
375	that calls this function.	835	that calls this function.
376		836
377	Using this function has the advantage that its output ends up in the	837	Using this function has the advantage that its output ends up in the
378	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
379		839
380	=item $is_safe = urxvt::safe	840	Messages have a size limit of 1023 bytes currently.
381		841
382	Returns true when it is safe to do potentially unsafe things, such as	842	=item @terms = urxvt::termlist
383	evaluating perl code specified by the user. This is true when urxvt was	843
384	started setuid or setgid.	844	Returns all urxvt::term objects that exist in this process, regardless of
		845	whether they are started, being destroyed etc., so be careful. Only term
		846	objects that have perl extensions attached will be returned (because there
		847	is no urxvt::term object associated with others).
385		848
386	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
387		850
388	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
389		852
390	=item urxvt::CurrentTime	853	=item urxvt::CurrentTime
391		854
392	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	855	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
393	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	856	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
394	Button4Mask, Button5Mask, AnyModifier	857	Button4Mask, Button5Mask, AnyModifier
		858
		859	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		860	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		861	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		862	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		863	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		864	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		865	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		866
		867	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		868	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		869	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		870	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		871	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		872	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		873	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
395		874
396	Various constants for use in X calls and event processing.	875	Various constants for use in X calls and event processing.
397		876
398	=back	877	=back
399		878
…		…
416		895
417	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
418		897
419	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
420		899
421	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	900	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		901	urxvt::RS_RVid, urxvt::RS_Uline
422		902
423	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
424	underline, respectively. To enable such a style, just logically OR it into	904	underline, respectively. To enable such a style, just logically OR it into
425	the bitset.	905	the bitset.
426		906
…		…
428		908
429	=item $background = urxvt::GET_BASEBG $rend	909	=item $background = urxvt::GET_BASEBG $rend
430		910
431	Return the foreground/background colour index, respectively.	911	Return the foreground/background colour index, respectively.
432		912
433	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	913	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
434		914
435	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	915	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		916
		917	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
436		918
437	Replace the foreground/background colour in the rendition mask with the	919	Replace the foreground/background colour in the rendition mask with the
438	specified one.	920	specified one.
439		921
440	=item $value = urxvt::GET_CUSTOM ($rend)	922	=item $value = urxvt::GET_CUSTOM $rend
441		923
442	Return the "custom" value: Every rendition has 5 bits for use by	924	Return the "custom" value: Every rendition has 5 bits for use by
443	extensions. They can be set and changed as you like and are initially	925	extensions. They can be set and changed as you like and are initially
444	zero.	926	zero.
445		927
446	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	928	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
447		929
448	Change the custom value.	930	Change the custom value.
449		931
450	=back	932	=back
451		933
452	=cut	934	=cut
453		935
454	package urxvt;
455
456	use utf8;
457	use strict;
458	use Carp ();
459	use Scalar::Util ();
460	use List::Util ();
461
462	our $VERSION = 1;
463	our $TERM;
464	our @HOOKNAME;
465	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
466	our %OPTION;
467
468	our $LIBDIR;
469	our $RESNAME;
470	our $RESCLASS;
471	our $RXVTNAME;
472
473	BEGIN {	936	BEGIN {
474	urxvt->bootstrap;
475
476	# overwrite perl's warn	937	# overwrite perl's warn
477	*CORE::GLOBAL::warn = sub {	938	*CORE::GLOBAL::warn = sub {
478	my $msg = join "", @_;	939	my $msg = join "", @_;
479	$msg .= "\n"	940	$msg .= "\n"
480	unless $msg =~ /\n$/;	941	unless $msg =~ /\n$/;
481	urxvt::warn ($msg);	942	urxvt::warn ($msg);
482	};	943	};
483
484	delete $ENV{IFS};
485	delete $ENV{CDPATH};
486	delete $ENV{BASH_ENV};
487	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
488	}	944	}
489		945
490	my @hook_count;	946	no warnings 'utf8';
		947
		948	sub parse_resource {
		949	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		950
		951	$term->scan_meta;
		952
		953	my $r = $term->{meta}{resource};
		954	while (my ($pattern, $v) = each %$r) {
		955	$name =~ y/-/./ if $isarg;
		956
		957	if (
		958	$pattern =~ /\.$/
		959	? $pattern eq substr $name, 0, length $pattern
		960	: $pattern eq $name
		961	) {
		962	$name = "$urxvt::RESCLASS.$name";
		963
		964	push @{ $term->{perl_ext_3} }, $v->[0];
		965
		966	if ($v->[1] eq "boolean") {
		967	$term->put_option_db ($name, $flag ? "true" : "false");
		968	return 1;
		969	} else {
		970	$term->put_option_db ($name, $value);
		971	return 1 + 2;
		972	}
		973	}
		974	}
		975
		976	0
		977	}
		978
		979	sub usage {
		980	my ($term, $usage_type) = @_;
		981
		982	$term->scan_meta;
		983
		984	my $r = $term->{meta}{resource};
		985
		986	for my $pattern (sort keys %$r) {
		987	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		988
		989	$desc .= " (-pe $ext)";
		990
		991	if ($usage_type == 1) {
		992	$pattern =~ y/./-/;
		993	$pattern =~ s/-$/-.../g;
		994
		995	if ($type eq "boolean") {
		996	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		997	} else {
		998	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		999	}
		1000	} else {
		1001	$pattern =~ s/\.$/.*/g;
		1002	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		1003	}
		1004	}
		1005	}
		1006
491	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	1007	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
492		1008
493	sub verbose {	1009	sub verbose {
494	my ($level, $msg) = @_;	1010	my ($level, $msg) = @_;
495	warn "$msg\n" if $level <= $verbosity;	1011	warn "$msg\n" if $level <= $verbosity;
496	}	1012	}
497		1013
498	my $extension_pkg = "extension0000";
499	my %extension_pkg;	1014	my %extension_pkg;
500		1015
501	# load a single script into its own package, once only	1016	# load a single script into its own package, once only
502	sub extension_package($) {	1017	sub extension_package($) {
503	my ($path) = @_;	1018	my ($path) = @_;
504		1019
505	$extension_pkg{$path} \|\|= do {	1020	$extension_pkg{$path} \|\|= do {
506	my $pkg = "urxvt::" . ($extension_pkg++);	1021	$path =~ /([^\/\\]+)$/;
		1022	my $pkg = $1;
		1023	$pkg =~ s/[^[:word:]]/_/g;
		1024	$pkg = "urxvt::ext::$pkg";
507		1025
508	verbose 3, "loading extension '$path' into package '$pkg'";	1026	verbose 3, "loading extension '$path' into package '$pkg'";
509		1027
510	open my $fh, "<:raw", $path	1028	open my $fh, "<:raw", $path
511	or die "$path: $!";	1029	or die "$path: $!";
512		1030
513	my $source = untaint	1031	my $source =
514	"package $pkg; use strict; use utf8;\n"	1032	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
515	. "use base urxvt::term::extension::;\n"
516	. "#line 1 \"$path\"\n{\n"	1033	. "#line 1 \"$path\"\n{\n"
517	. (do { local $/; <$fh> })	1034	. (do { local $/; <$fh> })
518	. "\n};\n1";	1035	. "\n};\n1";
519		1036
520	eval $source	1037	eval $source
…		…
530	sub invoke {	1047	sub invoke {
531	local $TERM = shift;	1048	local $TERM = shift;
532	my $htype = shift;	1049	my $htype = shift;
533		1050
534	if ($htype == 0) { # INIT	1051	if ($htype == 0) { # INIT
535	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1052	my @dirs = $TERM->perl_libdirs;
536		1053
537	my %ext_arg;	1054	my %ext_arg;
538		1055
		1056	{
		1057	my @init = @TERM_INIT;
		1058	@TERM_INIT = ();
		1059	$_->($TERM) for @init;
		1060	my @pkg = @TERM_EXT;
		1061	@TERM_EXT = ();
		1062	$TERM->register_package ($_) for @pkg;
		1063	}
		1064
		1065	for (
		1066	@{ delete $TERM->{perl_ext_3} },
539	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	1067	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		1068	) {
540	if ($_ eq "default") {	1069	if ($_ eq "default") {
541	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	1070	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
542	} elsif (/^-(.*)$/) {	1071	} elsif (/^-(.*)$/) {
543	delete $ext_arg{$1};	1072	delete $ext_arg{$1};
544	} elsif (/^([^<]+)<(.*)>$/) {	1073	} elsif (/^([^<]+)<(.*)>$/) {
545	push @{ $ext_arg{$1} }, $2;	1074	push @{ $ext_arg{$1} }, $2;
546	} else {	1075	} else {
547	$ext_arg{$_} \|\|= [];	1076	$ext_arg{$_} \|\|= [];
548	}	1077	}
549	}	1078	}
550		1079
551	while (my ($ext, $argv) = each %ext_arg) {	1080	for my $ext (sort keys %ext_arg) {
552	my @files = grep -f $_, map "$_/$ext", @dirs;	1081	my @files = grep -f $_, map "$_/$ext", @dirs;
553		1082
554	if (@files) {	1083	if (@files) {
555	$TERM->register_package (extension_package $files[0], $argv);	1084	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
556	} else {	1085	} else {
557	warn "perl extension '$ext' not found in perl library search path\n";	1086	warn "perl extension '$ext' not found in perl library search path\n";
558	}	1087	}
559	}	1088	}
560		1089
…		…
566		1095
567	if (my $cb = $TERM->{_hook}[$htype]) {	1096	if (my $cb = $TERM->{_hook}[$htype]) {
568	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1097	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
569	if $verbosity >= 10;	1098	if $verbosity >= 10;
570		1099
571	keys %$cb;	1100	for my $pkg (keys %$cb) {
572
573	while (my ($pkg, $cb) = each %$cb) {
574	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	1101	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
575	and last;	1102	$retval \|\|= $retval_;
576		1103
577	if ($@) {	1104	if ($@) {
578	$TERM->ungrab; # better to lose the grab than the session	1105	$TERM->ungrab; # better to lose the grab than the session
579	warn $@;	1106	warn $@;
580	}	1107	}
581	}	1108	}
		1109
		1110	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		1111	if $verbosity >= 11;
582	}	1112	}
583		1113
584	if ($htype == 1) { # DESTROY	1114	if ($htype == 1) { # DESTROY
585	if (my $hook = delete $TERM->{_hook}) {
586	for my $htype (0..$#$hook) {
587	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
588	or set_should_invoke $htype, 0;
589	}
590	}
591
592	# clear package objects	1115	# clear package objects
593	%$_ = () for values %{ $TERM->{_pkg} };	1116	%$_ = () for values %{ $TERM->{_pkg} };
594		1117
595	# clear package	1118	# clear package
596	%$TERM = ();	1119	%$TERM = ();
597	}	1120	}
598		1121
599	$retval	1122	$retval
		1123	}
		1124
		1125	sub SET_COLOR($$$) {
		1126	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1127	}
		1128
		1129	sub rend2mask {
		1130	no strict 'refs';
		1131	my ($str, $mask) = (@_, 0);
		1132	my %color = ( fg => undef, bg => undef );
		1133	my @failed;
		1134	for my $spec ( split /\s+/, $str ) {
		1135	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1136	$color{lc($1)} = $2;
		1137	} else {
		1138	my $neg = $spec =~ s/^[-^]//;
		1139	unless ( exists &{"RS_$spec"} ) {
		1140	push @failed, $spec;
		1141	next;
		1142	}
		1143	my $cur = &{"RS_$spec"};
		1144	if ( $neg ) {
		1145	$mask &= ~$cur;
		1146	} else {
		1147	$mask \|= $cur;
		1148	}
		1149	}
		1150	}
		1151	($mask, @color{qw(fg bg)}, \@failed)
600	}	1152	}
601		1153
602	# urxvt::term::extension	1154	# urxvt::term::extension
603		1155
604	package urxvt::term::extension;	1156	package urxvt::term::extension;
…		…
610	while (my ($name, $cb) = each %hook) {	1162	while (my ($name, $cb) = each %hook) {
611	my $htype = $HOOKTYPE{uc $name};	1163	my $htype = $HOOKTYPE{uc $name};
612	defined $htype	1164	defined $htype
613	or Carp::croak "unsupported hook type '$name'";	1165	or Carp::croak "unsupported hook type '$name'";
614		1166
		1167	$self->set_should_invoke ($htype, +1)
615	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	1168	unless exists $self->{term}{_hook}[$htype]{$pkg};
616	$hook_count[$htype]++
617	or urxvt::set_should_invoke $htype, 1;
618	}
619		1169
620	$self->{term}{_hook}[$htype]{$pkg} = $cb;	1170	$self->{term}{_hook}[$htype]{$pkg} = $cb;
621	}	1171	}
622	}	1172	}
623		1173
…		…
628	for my $name (@hook) {	1178	for my $name (@hook) {
629	my $htype = $HOOKTYPE{uc $name};	1179	my $htype = $HOOKTYPE{uc $name};
630	defined $htype	1180	defined $htype
631	or Carp::croak "unsupported hook type '$name'";	1181	or Carp::croak "unsupported hook type '$name'";
632		1182
		1183	$self->set_should_invoke ($htype, -1)
633	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1184	if delete $self->{term}{_hook}[$htype]{$pkg};
634	--$hook_count[$htype]
635	or urxvt::set_should_invoke $htype, 0;
636	}
637	}	1185	}
638	}	1186	}
639		1187
640	our $AUTOLOAD;	1188	our $AUTOLOAD;
641		1189
…		…
672		1220
673	=head2 The C<urxvt::anyevent> Class	1221	=head2 The C<urxvt::anyevent> Class
674		1222
675	The sole purpose of this class is to deliver an interface to the	1223	The sole purpose of this class is to deliver an interface to the
676	C<AnyEvent> module - any module using it will work inside urxvt without	1224	C<AnyEvent> module - any module using it will work inside urxvt without
677	further work. The only exception is that you cannot wait on condition	1225	further programming. The only exception is that you cannot wait on
678	variables, but non-blocking condvar use is ok. What this means is that you	1226	condition variables, but non-blocking condvar use is ok.
679	cannot use blocking APIs, but the non-blocking variant should work.	1227
		1228	In practical terms this means is that you cannot use blocking APIs, but
		1229	the non-blocking variant should work.
680		1230
681	=cut	1231	=cut
682		1232
683	our $VERSION = 1;	1233	our $VERSION = '5.23';
684		1234
685	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1235	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
686	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1236	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
687		1237
688	sub timer {	1238	sub timer {
…		…
690		1240
691	my $cb = $arg{cb};	1241	my $cb = $arg{cb};
692		1242
693	urxvt::timer	1243	urxvt::timer
694	->new	1244	->new
695	->start (urxvt::NOW + $arg{after})	1245	->after ($arg{after}, $arg{interval})
696	->cb (sub {	1246	->cb ($arg{interval} ? $cb : sub {
697	$_[0]->stop; # need to cancel manually	1247	$_[0]->stop; # need to cancel manually
698	$cb->();	1248	$cb->();
699	})	1249	})
700	}	1250	}
701		1251
702	sub io {	1252	sub io {
703	my ($class, %arg) = @_;	1253	my ($class, %arg) = @_;
704		1254
705	my $cb = $arg{cb};	1255	my $cb = $arg{cb};
		1256	my $fd = fileno $arg{fh};
		1257	defined $fd or $fd = $arg{fh};
706		1258
707	bless [$arg{fh}, urxvt::iow	1259	bless [$arg{fh}, urxvt::iow
708	->new	1260	->new
709	->fd (fileno $arg{fh})	1261	->fd ($fd)
710	->events (($arg{poll} =~ /r/ ? 1 : 0)	1262	->events (($arg{poll} =~ /r/ ? 1 : 0)
711	\| ($arg{poll} =~ /w/ ? 2 : 0))	1263	\| ($arg{poll} =~ /w/ ? 2 : 0))
712	->start	1264	->start
713	->cb (sub {	1265	->cb ($cb)
714	$cb->(($_[1] & 1 ? 'r' : '')
715	. ($_[1] & 2 ? 'w' : ''));
716	})],
717	urxvt::anyevent::	1266	], urxvt::anyevent::
		1267	}
		1268
		1269	sub idle {
		1270	my ($class, %arg) = @_;
		1271
		1272	my $cb = $arg{cb};
		1273
		1274	urxvt::iw
		1275	->new
		1276	->start
		1277	->cb ($cb)
		1278	}
		1279
		1280	sub child {
		1281	my ($class, %arg) = @_;
		1282
		1283	my $cb = $arg{cb};
		1284
		1285	urxvt::pw
		1286	->new
		1287	->start ($arg{pid})
		1288	->cb (sub {
		1289	$_[0]->stop; # need to cancel manually
		1290	$cb->($_[0]->rpid, $_[0]->rstatus);
		1291	})
718	}	1292	}
719		1293
720	sub DESTROY {	1294	sub DESTROY {
721	$_[0][1]->stop;	1295	$_[0][1]->stop;
722	}	1296	}
723		1297
724	sub condvar {	1298	# only needed for AnyEvent < 6 compatibility
725	bless \my $flag, urxvt::anyevent::condvar::	1299	sub one_event {
726	}
727
728	sub urxvt::anyevent::condvar::broadcast {
729	${$_[0]}++;
730	}
731
732	sub urxvt::anyevent::condvar::wait {
733	unless (${$_[0]}) {
734	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1300	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
735	}
736	}	1301	}
737		1302
738	package urxvt::term;	1303	package urxvt::term;
739		1304
740	=head2 The C<urxvt::term> Class	1305	=head2 The C<urxvt::term> Class
…		…
745		1310
746	# find on_xxx subs in the package and register them	1311	# find on_xxx subs in the package and register them
747	# as hooks	1312	# as hooks
748	sub register_package {	1313	sub register_package {
749	my ($self, $pkg, $argv) = @_;	1314	my ($self, $pkg, $argv) = @_;
		1315
		1316	no strict 'refs';
		1317
		1318	urxvt::verbose 6, "register package $pkg to $self";
		1319
		1320	@{"$pkg\::ISA"} = urxvt::term::extension::;
750		1321
751	my $proxy = bless {	1322	my $proxy = bless {
752	_pkg => $pkg,	1323	_pkg => $pkg,
753	argv => $argv,	1324	argv => $argv,
754	}, $pkg;	1325	}, $pkg;
…		…
761	$proxy->enable ($name => $ref);	1332	$proxy->enable ($name => $ref);
762	}	1333	}
763	}	1334	}
764	}	1335	}
765		1336
		1337	sub perl_libdirs {
		1338	map { split /:/ }
		1339	$_[0]->resource ("perl_lib"),
		1340	$ENV{URXVT_PERL_LIB},
		1341	"$ENV{HOME}/.urxvt/ext",
		1342	"$LIBDIR/perl"
		1343	}
		1344
		1345	sub scan_meta {
		1346	my ($self) = @_;
		1347	my @libdirs = perl_libdirs $self;
		1348
		1349	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1350
		1351	my %meta;
		1352
		1353	$self->{meta_libdirs} = join "\x00", @libdirs;
		1354	$self->{meta} = \%meta;
		1355
		1356	for my $dir (reverse @libdirs) {
		1357	opendir my $fh, $dir
		1358	or next;
		1359	for my $ext (readdir $fh) {
		1360	$ext ne "."
		1361	and $ext ne ".."
		1362	and open my $fh, "<", "$dir/$ext"
		1363	or next;
		1364
		1365	while (<$fh>) {
		1366	if (/^#:META:X_RESOURCE:(.*)/) {
		1367	my ($pattern, $type, $desc) = split /:/, $1;
		1368	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
		1369	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1370	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1371	} else {
		1372	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1373	}
		1374	} elsif (/^\s*(?:#\|$)/) {
		1375	# skip other comments and empty lines
		1376	} else {
		1377	last; # stop parsing on first non-empty non-comment line
		1378	}
		1379	}
		1380	}
		1381	}
		1382	}
		1383
		1384	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1385
		1386	Creates a new terminal, very similar as if you had started it with system
		1387	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1388	hash which defines the environment of the new terminal.
		1389
		1390	Croaks (and probably outputs an error message) if the new instance
		1391	couldn't be created. Returns C<undef> if the new instance didn't
		1392	initialise perl, and the terminal object otherwise. The C<init> and
		1393	C<start> hooks will be called before this call returns, and are free to
		1394	refer to global data (which is race free).
		1395
		1396	=cut
		1397
		1398	sub new {
		1399	my ($class, $env, @args) = @_;
		1400
		1401	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1402	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1403
		1404	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1405	}
		1406
766	=item $term->destroy	1407	=item $term->destroy
767		1408
768	Destroy the terminal object (close the window, free resources etc.).	1409	Destroy the terminal object (close the window, free resources
		1410	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1411	watchers (timers, io watchers) are still active.
		1412
		1413	=item $term->exec_async ($cmd[, @args])
		1414
		1415	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1416	("starts") programs in the background. This function takes care of setting
		1417	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1418	be preferred over explicit calls to C<exec> or C<system>.
		1419
		1420	Returns the pid of the subprocess or C<undef> on error.
		1421
		1422	=cut
		1423
		1424	sub exec_async {
		1425	my $self = shift;
		1426
		1427	my $pid = fork;
		1428
		1429	return $pid
		1430	if !defined $pid or $pid;
		1431
		1432	%ENV = %{ $self->env };
		1433
		1434	exec @_;
		1435	urxvt::_exit 255;
		1436	}
769		1437
770	=item $isset = $term->option ($optval[, $set])	1438	=item $isset = $term->option ($optval[, $set])
771		1439
772	Returns true if the option specified by C<$optval> is enabled, and	1440	Returns true if the option specified by C<$optval> is enabled, and
773	optionally change it. All option values are stored by name in the hash	1441	optionally change it. All option values are stored by name in the hash
774	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1442	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
775		1443
776	Here is a a likely non-exhaustive list of option names, please see the	1444	Here is a likely non-exhaustive list of option names, please see the
777	source file F</src/optinc.h> to see the actual list:	1445	source file F</src/optinc.h> to see the actual list:
778		1446
779	borderLess console cursorBlink cursorUnderline hold iconic insecure	1447	borderLess buffered console cursorBlink cursorUnderline hold iconic
780	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1448	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1449	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
781	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1450	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
782	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1451	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
783	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1452	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
784	tripleclickwords utmpInhibit visualBell	1453	urgentOnBell utmpInhibit visualBell
785		1454
786	=item $value = $term->resource ($name[, $newval])	1455	=item $value = $term->resource ($name[, $newval])
787		1456
788	Returns the current resource value associated with a given name and	1457	Returns the current resource value associated with a given name and
789	optionally sets a new value. Setting values is most useful in the C<init>	1458	optionally sets a new value. Setting values is most useful in the C<init>
…		…
798	likely change).	1467	likely change).
799		1468
800	Please note that resource strings will currently only be freed when the	1469	Please note that resource strings will currently only be freed when the
801	terminal is destroyed, so changing options frequently will eat memory.	1470	terminal is destroyed, so changing options frequently will eat memory.
802		1471
803	Here is a a likely non-exhaustive list of resource names, not all of which	1472	Here is a likely non-exhaustive list of resource names, not all of which
804	are supported in every build, please see the source file F</src/rsinc.h>	1473	are supported in every build, please see the source file F</src/rsinc.h>
805	to see the actual list:	1474	to see the actual list:
806		1475
807	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1476	answerbackstring backgroundPixmap backspace_key blendtype blurradius
808	borderLess color cursorBlink cursorUnderline cutchars delete_key	1477	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
809	display_name embed ext_bwidth fade font geometry hold iconName	1478	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
810	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1479	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1480	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
811	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1481	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
812	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1482	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
813	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1483	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
814	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1484	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
815	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1485	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
816	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1486	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
817	shade term_name title transparent transparent_all tripleclickwords	1487	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1488	term_name title transient_for transparent tripleclickwords urgentOnBell
818	utmpInhibit visualBell	1489	utmpInhibit visualBell
819		1490
820	=cut	1491	=cut
821		1492
822	sub resource($$;$) {	1493	sub resource($$;$) {
823	my ($self, $name) = (shift, shift);	1494	my ($self, $name) = (shift, shift);
824	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1495	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
825	&urxvt::term::_resource	1496	goto &urxvt::term::_resource
826	}	1497	}
827		1498
828	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1499	=item $value = $term->x_resource ($pattern)
829		1500
		1501	Returns the X-Resource for the given pattern, excluding the program or
		1502	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1503	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1504	resource with that pattern exists.
		1505
		1506	This method should only be called during the C<on_start> hook, as there is
		1507	only one resource database per display, and later invocations might return
		1508	the wrong resources.
		1509
		1510	=item $value = $term->x_resource_boolean ($pattern)
		1511
		1512	Like C<x_resource>, above, but interprets the string value as a boolean
		1513	and returns C<1> for true values, C<0> for false values and C<undef> if
		1514	the resource or option isn't specified.
		1515
		1516	You should always use this method to parse boolean resources.
		1517
		1518	=cut
		1519
		1520	sub x_resource_boolean {
		1521	my $res = &x_resource;
		1522
		1523	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
		1524	}
		1525
		1526	=item $success = $term->parse_keysym ($key, $octets)
		1527
830	Adds a keymap translation exactly as specified via a resource. See the	1528	Adds a key binding exactly as specified via a resource. See the
831	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1529	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1530
		1531	=item $term->register_command ($keysym, $modifiermask, $string)
		1532
		1533	Adds a key binding. This is a lower level api compared to
		1534	C<parse_keysym>, as it expects a parsed key description, and can be
		1535	used only inside either the C<on_init> hook, to add a binding, or the
		1536	C<on_register_command> hook, to modify a parsed binding.
832		1537
833	=item $rend = $term->rstyle ([$new_rstyle])	1538	=item $rend = $term->rstyle ([$new_rstyle])
834		1539
835	Return and optionally change the current rendition. Text that is output by	1540	Return and optionally change the current rendition. Text that is output by
836	the terminal application will use this style.	1541	the terminal application will use this style.
…		…
844		1549
845	=item ($row, $col) = $term->selection_beg ([$row, $col])	1550	=item ($row, $col) = $term->selection_beg ([$row, $col])
846		1551
847	=item ($row, $col) = $term->selection_end ([$row, $col])	1552	=item ($row, $col) = $term->selection_end ([$row, $col])
848		1553
849	Return the current values of the selection mark, begin or end positions,	1554	Return the current values of the selection mark, begin or end positions.
850	and optionally set them to new values.
851		1555
		1556	When arguments are given, then the selection coordinates are set to
		1557	C<$row> and C<$col>, and the selection screen is set to the current
		1558	screen.
		1559
		1560	=item $screen = $term->selection_screen ([$screen])
		1561
		1562	Returns the current selection screen, and then optionally sets it.
		1563
		1564	=item $term->selection_make ($eventtime[, $rectangular])
		1565
		1566	Tries to make a selection as set by C<selection_beg> and
		1567	C<selection_end>. If C<$rectangular> is true (default: false), a
		1568	rectangular selection will be made. This is the preferred function to make
		1569	a selection.
		1570
852	=item $success = $term->selection_grab ($eventtime)	1571	=item $success = $term->selection_grab ($eventtime[, $clipboard])
853		1572
854	Try to request the primary selection from the server (for example, as set	1573	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
855	by the next method).	1574	true) selection from the server. The corresponding text can be set
		1575	with the next method. No visual feedback will be given. This function
		1576	is mostly useful from within C<on_sel_grab> hooks.
856		1577
857	=item $oldtext = $term->selection ([$newtext])	1578	=item $oldtext = $term->selection ([$newtext, $clipboard])
858		1579
859	Return the current selection text and optionally replace it by C<$newtext>.	1580	Return the current selection (clipboard if C<$clipboard> is true) text
		1581	and optionally replace it by C<$newtext>.
		1582
		1583	=item $term->selection_clear ([$clipboard])
		1584
		1585	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
860		1586
861	=item $term->overlay_simple ($x, $y, $text)	1587	=item $term->overlay_simple ($x, $y, $text)
862		1588
863	Create a simple multi-line overlay box. See the next method for details.	1589	Create a simple multi-line overlay box. See the next method for details.
864		1590
…		…
894		1620
895	The methods currently supported on C<urxvt::overlay> objects are:	1621	The methods currently supported on C<urxvt::overlay> objects are:
896		1622
897	=over 4	1623	=over 4
898		1624
899	=item $overlay->set ($x, $y, $text, $rend)	1625	=item $overlay->set ($x, $y, $text[, $rend])
900		1626
901	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1627	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
902	text in rxvt-unicode's special encoding and an array of rendition values	1628	text in rxvt-unicode's special encoding and an array of rendition values
903	at a specific position inside the overlay.	1629	at a specific position inside the overlay.
		1630
		1631	If C<$rend> is missing, then the rendition will not be changed.
904		1632
905	=item $overlay->hide	1633	=item $overlay->hide
906		1634
907	If visible, hide the overlay, but do not destroy it.	1635	If visible, hide the overlay, but do not destroy it.
908		1636
…		…
953	Convert the given locale-encoded octets into a perl string.	1681	Convert the given locale-encoded octets into a perl string.
954		1682
955	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1683	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
956		1684
957	XORs the rendition values in the given span with the provided value	1685	XORs the rendition values in the given span with the provided value
958	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1686	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
959	to the selection.	1687	refresh hooks to provide effects similar to the selection.
960		1688
961	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1689	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
962		1690
963	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1691	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
964	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1692	whitespace will additionally be xored with the C<$rstyle2>, which defaults
965	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines	1693	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
966	it instead.	1694	it instead. Both styles I<MUST NOT> contain font styles.
967		1695
968	=item $term->scr_bell	1696	=item $term->scr_bell
969		1697
970	Ring the bell!	1698	Ring the bell!
971		1699
…		…
978		1706
979	Normally its not a good idea to use this function, as programs might be	1707	Normally its not a good idea to use this function, as programs might be
980	confused by changes in cursor position or scrolling. Its useful inside a	1708	confused by changes in cursor position or scrolling. Its useful inside a
981	C<on_add_lines> hook, though.	1709	C<on_add_lines> hook, though.
982		1710
		1711	=item $term->scr_change_screen ($screen)
		1712
		1713	Switch to given screen - 0 primary, 1 secondary.
		1714
983	=item $term->cmd_parse ($octets)	1715	=item $term->cmd_parse ($octets)
984		1716
985	Similar to C<scr_add_lines>, but the argument must be in the	1717	Similar to C<scr_add_lines>, but the argument must be in the
986	locale-specific encoding of the terminal and can contain command sequences	1718	locale-specific encoding of the terminal and can contain command sequences
987	(escape codes) that will be interpreted.	1719	(escape codes) that will be interpreted.
988		1720
989	=item $term->tt_write ($octets)	1721	=item $term->tt_write ($octets)
990		1722
991	Write the octets given in C<$data> to the tty (i.e. as program input). To	1723	Write the octets given in C<$octets> to the tty (i.e. as program input). To
992	pass characters instead of octets, you should convert your strings first	1724	pass characters instead of octets, you should convert your strings first
993	to the locale-specific encoding using C<< $term->locale_encode >>.	1725	to the locale-specific encoding using C<< $term->locale_encode >>.
		1726
		1727	=item $term->tt_paste ($octets)
		1728
		1729	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1730	CR and bracketing the data with control sequences if bracketed paste mode
		1731	is set.
994		1732
995	=item $old_events = $term->pty_ev_events ([$new_events])	1733	=item $old_events = $term->pty_ev_events ([$new_events])
996		1734
997	Replaces the event mask of the pty watcher by the given event mask. Can	1735	Replaces the event mask of the pty watcher by the given event mask. Can
998	be used to suppress input and output handling to the pty/tty. See the	1736	be used to suppress input and output handling to the pty/tty. See the
999	description of C<< urxvt::timer->events >>. Make sure to always restore	1737	description of C<< urxvt::timer->events >>. Make sure to always restore
1000	the previous value.	1738	the previous value.
1001		1739
		1740	=item $fd = $term->pty_fd
		1741
		1742	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1743	is used.
		1744
1002	=item $windowid = $term->parent	1745	=item $windowid = $term->parent
1003		1746
1004	Return the window id of the toplevel window.	1747	Return the window id of the toplevel window.
1005		1748
1006	=item $windowid = $term->vt	1749	=item $windowid = $term->vt
1007		1750
1008	Return the window id of the terminal window.	1751	Return the window id of the terminal window.
1009		1752
		1753	=item $term->vt_emask_add ($x_event_mask)
		1754
		1755	Adds the specified events to the vt event mask. Useful e.g. when you want
		1756	to receive pointer events all the times:
		1757
		1758	$term->vt_emask_add (urxvt::PointerMotionMask);
		1759
		1760	=item $term->set_urgency ($set)
		1761
		1762	Enable/disable the urgency hint on the toplevel window.
		1763
		1764	=item $term->focus_in
		1765
		1766	=item $term->focus_out
		1767
		1768	=item $term->key_press ($state, $keycode[, $time])
		1769
		1770	=item $term->key_release ($state, $keycode[, $time])
		1771
		1772	Deliver various fake events to to terminal.
		1773
1010	=item $window_width = $term->width	1774	=item $window_width = $term->width
1011		1775
1012	=item $window_height = $term->height	1776	=item $window_height = $term->height
1013		1777
1014	=item $font_width = $term->fwidth	1778	=item $font_width = $term->fwidth
…		…
1027		1791
1028	=item $max_scrollback = $term->saveLines	1792	=item $max_scrollback = $term->saveLines
1029		1793
1030	=item $nrow_plus_saveLines = $term->total_rows	1794	=item $nrow_plus_saveLines = $term->total_rows
1031		1795
1032	=item $lines_in_scrollback = $term->nsaved	1796	=item $topmost_scrollback_row = $term->top_row
1033		1797
1034	Return various integers describing terminal characteristics.	1798	Return various integers describing terminal characteristics.
1035		1799
		1800	=item $x_display = $term->display_id
		1801
		1802	Return the DISPLAY used by rxvt-unicode.
		1803
1036	=item $lc_ctype = $term->locale	1804	=item $lc_ctype = $term->locale
1037		1805
1038	Returns the LC_CTYPE category string used by this rxvt-unicode.	1806	Returns the LC_CTYPE category string used by this rxvt-unicode.
1039		1807
1040	=item $x_display = $term->display_id	1808	=item $env = $term->env
1041		1809
1042	Return the DISPLAY used by rxvt-unicode.	1810	Returns a copy of the environment in effect for the terminal as a hashref
		1811	similar to C<\%ENV>.
		1812
		1813	=item @envv = $term->envv
		1814
		1815	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1816
		1817	=item @argv = $term->argv
		1818
		1819	Return the argument vector as this terminal, similar to @ARGV, but
		1820	includes the program name as first element.
		1821
		1822	=cut
		1823
		1824	sub env {
		1825	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
		1826	}
1043		1827
1044	=item $modifiermask = $term->ModLevel3Mask	1828	=item $modifiermask = $term->ModLevel3Mask
1045		1829
1046	=item $modifiermask = $term->ModMetaMask	1830	=item $modifiermask = $term->ModMetaMask
1047		1831
1048	=item $modifiermask = $term->ModNumLockMask	1832	=item $modifiermask = $term->ModNumLockMask
1049		1833
1050	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1834	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1051	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1835	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1052		1836
		1837	=item $screen = $term->current_screen
		1838
		1839	Returns the currently displayed screen (0 primary, 1 secondary).
		1840
		1841	=item $cursor_is_hidden = $term->hidden_cursor
		1842
		1843	Returns whether the cursor is currently hidden or not.
		1844
1053	=item $view_start = $term->view_start ([$newvalue])	1845	=item $view_start = $term->view_start ([$newvalue])
1054		1846
1055	Returns the negative row number of the topmost line. Minimum value is	1847	Returns the row number of the topmost displayed line. Maximum value is
1056	C<0>, which displays the normal terminal contents. Larger values scroll	1848	C<0>, which displays the normal terminal contents. Lower values scroll
1057	this many lines into the scrollback buffer.	1849	this many lines into the scrollback buffer.
1058		1850
1059	=item $term->want_refresh	1851	=item $term->want_refresh
1060		1852
1061	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1853	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1064		1856
1065	Used after changing terminal contents to display them.	1857	Used after changing terminal contents to display them.
1066		1858
1067	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1859	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1068		1860
1069	Returns the text of the entire row with number C<$row_number>. Row C<0>	1861	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1070	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1862	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1071	terminal line. The scrollback buffer starts at line C<-1> and extends to
1072	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1863	terminal line. Nothing will be returned if a nonexistent line
1073	is requested.	1864	is requested.
1074		1865
1075	If C<$new_text> is specified, it will replace characters in the current	1866	If C<$new_text> is specified, it will replace characters in the current
1076	line, starting at column C<$start_col> (default C<0>), which is useful	1867	line, starting at column C<$start_col> (default C<0>), which is useful
1077	to replace only parts of a line. The font index in the rendition will	1868	to replace only parts of a line. The font index in the rendition will
1078	automatically be updated.	1869	automatically be updated.
1079		1870
1080	C<$text> is in a special encoding: tabs and wide characters that use more	1871	C<$text> is in a special encoding: tabs and wide characters that use more
1081	than one cell when displayed are padded with urxvt::NOCHAR characters	1872	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1082	(C<chr 65535>). Characters with combining characters and other characters	1873	characters. Characters with combining characters and other characters that
1083	that do not fit into the normal tetx encoding will be replaced with	1874	do not fit into the normal text encoding will be replaced with characters
1084	characters in the private use area.	1875	in the private use area.
1085		1876
1086	You have to obey this encoding when changing text. The advantage is	1877	You have to obey this encoding when changing text. The advantage is
1087	that C<substr> and similar functions work on screen cells and not on	1878	that C<substr> and similar functions work on screen cells and not on
1088	characters.	1879	characters.
1089		1880
…		…
1140	Return the row number of the first/last row of the line, respectively.	1931	Return the row number of the first/last row of the line, respectively.
1141		1932
1142	=item $offset = $line->offset_of ($row, $col)	1933	=item $offset = $line->offset_of ($row, $col)
1143		1934
1144	Returns the character offset of the given row\|col pair within the logical	1935	Returns the character offset of the given row\|col pair within the logical
1145	line.	1936	line. Works for rows outside the line, too, and returns corresponding
		1937	offsets outside the string.
1146		1938
1147	=item ($row, $col) = $line->coord_of ($offset)	1939	=item ($row, $col) = $line->coord_of ($offset)
1148		1940
1149	Translates a string offset into terminal coordinates again.	1941	Translates a string offset into terminal coordinates again.
1150		1942
…		…
1232	where one character corresponds to one screen cell. See	2024	where one character corresponds to one screen cell. See
1233	C<< $term->ROW_t >> for details.	2025	C<< $term->ROW_t >> for details.
1234		2026
1235	=item $string = $term->special_decode $text	2027	=item $string = $term->special_decode $text
1236		2028
1237	Converts rxvt-unicodes text reprsentation into a perl string. See	2029	Converts rxvt-unicodes text representation into a perl string. See
1238	C<< $term->ROW_t >> for details.	2030	C<< $term->ROW_t >> for details.
1239		2031
1240	=item $success = $term->grab_button ($button, $modifiermask)	2032	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1241		2033
		2034	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		2035
1242	Registers a synchronous button grab. See the XGrabButton manpage.	2036	Register/unregister a synchronous button grab. See the XGrabButton
		2037	manpage.
1243		2038
1244	=item $success = $term->grab ($eventtime[, $sync])	2039	=item $success = $term->grab ($eventtime[, $sync])
1245		2040
1246	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	2041	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1247	synchronous (C<$sync> is true). Also remembers the grab timestampe.	2042	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1248		2043
1249	=item $term->allow_events_async	2044	=item $term->allow_events_async
1250		2045
1251	Calls XAllowEvents with AsyncBoth for the most recent grab.	2046	Calls XAllowEvents with AsyncBoth for the most recent grab.
1252		2047
…		…
1259	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	2054	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1260	recent grab.	2055	recent grab.
1261		2056
1262	=item $term->ungrab	2057	=item $term->ungrab
1263		2058
1264	Calls XUngrab for the most recent grab. Is called automatically on	2059	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1265	evaluation errors, as it is better to lose the grab in the error case as	2060	evaluation errors, as it is better to lose the grab in the error case as
1266	the session.	2061	the session.
		2062
		2063	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		2064
		2065	=item $atom_name = $term->XGetAtomName ($atom)
		2066
		2067	=item @atoms = $term->XListProperties ($window)
		2068
		2069	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		2070
		2071	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		2072
		2073	=item $term->XDeleteProperty ($window, $property)
		2074
		2075	=item $window = $term->DefaultRootWindow
		2076
		2077	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		2078
		2079	=item $term->XMapWindow ($window)
		2080
		2081	=item $term->XUnmapWindow ($window)
		2082
		2083	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		2084
		2085	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		2086
		2087	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2088
		2089	=item $keysym = $term->XStringToKeysym ($string)
		2090
		2091	=item $string = $term->XKeysymToString ($keysym)
		2092
		2093	Various X or X-related functions. The C<$term> object only serves as
		2094	the source of the display, otherwise those functions map more-or-less
		2095	directly onto the X functions of the same name.
1267		2096
1268	=back	2097	=back
1269		2098
1270	=cut	2099	=cut
1271		2100
…		…
1286		2115
1287	$item->{render} \|\|= sub { $_[0]{text} };	2116	$item->{render} \|\|= sub { $_[0]{text} };
1288		2117
1289	push @{ $self->{item} }, $item;	2118	push @{ $self->{item} }, $item;
1290	}	2119	}
		2120
		2121	=item $popup->add_title ($title)
		2122
		2123	Adds a non-clickable title to the popup.
		2124
		2125	=cut
		2126
		2127	sub add_title {
		2128	my ($self, $title) = @_;
		2129
		2130	$self->add_item ({
		2131	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		2132	text => $title,
		2133	activate => sub { },
		2134	});
		2135	}
		2136
		2137	=item $popup->add_separator ([$sepchr])
		2138
		2139	Creates a separator, optionally using the character given as C<$sepchr>.
		2140
		2141	=cut
1291		2142
1292	sub add_separator {	2143	sub add_separator {
1293	my ($self, $sep) = @_;	2144	my ($self, $sep) = @_;
1294		2145
1295	$sep \|\|= "=";	2146	$sep \|\|= "=";
…		…
1300	render => sub { $sep x $self->{term}->ncol },	2151	render => sub { $sep x $self->{term}->ncol },
1301	activate => sub { },	2152	activate => sub { },
1302	});	2153	});
1303	}	2154	}
1304		2155
1305	sub add_title {	2156	=item $popup->add_button ($text, $cb)
1306	my ($self, $title) = @_;
1307		2157
1308	$self->add_item ({	2158	Adds a clickable button to the popup. C<$cb> is called whenever it is
1309	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	2159	selected.
1310	text => $title,	2160
1311	activate => sub { },	2161	=cut
1312	});
1313	}
1314		2162
1315	sub add_button {	2163	sub add_button {
1316	my ($self, $text, $cb) = @_;	2164	my ($self, $text, $cb) = @_;
1317		2165
1318	$self->add_item ({ type => "button", text => $text, activate => $cb});	2166	$self->add_item ({ type => "button", text => $text, activate => $cb});
1319	}	2167	}
1320		2168
		2169	=item $popup->add_toggle ($text, $initial_value, $cb)
		2170
		2171	Adds a toggle/checkbox item to the popup. The callback gets called
		2172	whenever it gets toggled, with a boolean indicating its new value as its
		2173	first argument.
		2174
		2175	=cut
		2176
1321	sub add_toggle {	2177	sub add_toggle {
1322	my ($self, $text, $cb, $value) = @_;	2178	my ($self, $text, $value, $cb) = @_;
1323		2179
1324	my $item; $item = {	2180	my $item; $item = {
1325	type => "button",	2181	type => "button",
1326	text => " $text",	2182	text => " $text",
1327	value => $value,	2183	value => $value,
1328	render => sub { ($_[0]{value} ? "* " : " ") . $text },	2184	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1329	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	2185	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1330	};	2186	};
1331		2187
1332	$self->add_item ($item);	2188	$self->add_item ($item);
1333	}	2189	}
		2190
		2191	=item $popup->show
		2192
		2193	Displays the popup (which is initially hidden).
		2194
		2195	=cut
1334		2196
1335	sub show {	2197	sub show {
1336	my ($self) = @_;	2198	my ($self) = @_;
1337		2199
1338	local $urxvt::popup::self = $self;	2200	local $urxvt::popup::self = $self;
1339		2201
		2202	my $env = $self->{term}->env;
		2203	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		2204	delete $env->{LC_ALL};
1340	local $ENV{LC_ALL} = $self->{term}->locale;	2205	$env->{LC_CTYPE} = $self->{term}->locale;
1341		2206
1342	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	2207	my $term = urxvt::term->new (
		2208	$env, "popup",
		2209	"--perl-lib" => "", "--perl-ext-common" => "",
		2210	"-pty-fd" => -1, "-sl" => 0,
		2211	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1343	"--transient-for" => $self->{term}->parent,	2212	"--transient-for" => $self->{term}->parent,
1344	"-display" => $self->{term}->display_id,	2213	"-display" => $self->{term}->display_id,
1345	"-pe" => "urxvt-popup")	2214	"-pe" => "urxvt-popup",
1346	or die "unable to create popup window\n";	2215	) or die "unable to create popup window\n";
		2216
		2217	unless (delete $term->{urxvt_popup_init_done}) {
		2218	$term->ungrab;
		2219	$term->destroy;
		2220	die "unable to initialise popup window\n";
		2221	}
1347	}	2222	}
1348		2223
1349	sub DESTROY {	2224	sub DESTROY {
1350	my ($self) = @_;	2225	my ($self) = @_;
1351		2226
1352	delete $self->{term}{_destroy}{$self};	2227	delete $self->{term}{_destroy}{$self};
1353	$self->{term}->ungrab;	2228	$self->{term}->ungrab;
1354	}	2229	}
		2230
		2231	=back
		2232
		2233	=cut
		2234
		2235	package urxvt::watcher;
1355		2236
1356	=head2 The C<urxvt::timer> Class	2237	=head2 The C<urxvt::timer> Class
1357		2238
1358	This class implements timer watchers/events. Time is represented as a	2239	This class implements timer watchers/events. Time is represented as a
1359	fractional number of seconds since the epoch. Example:	2240	fractional number of seconds since the epoch. Example:
…		…
1363	->new	2244	->new
1364	->interval (1)	2245	->interval (1)
1365	->cb (sub {	2246	->cb (sub {
1366	$term->{overlay}->set (0, 0,	2247	$term->{overlay}->set (0, 0,
1367	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2248	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1368	});	2249	});
1369		2250
1370	=over 4	2251	=over 4
1371		2252
1372	=item $timer = new urxvt::timer	2253	=item $timer = new urxvt::timer
1373		2254
…		…
1376		2257
1377	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2258	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1378		2259
1379	Set the callback to be called when the timer triggers.	2260	Set the callback to be called when the timer triggers.
1380		2261
1381	=item $tstamp = $timer->at
1382
1383	Return the time this watcher will fire next.
1384
1385	=item $timer = $timer->set ($tstamp)	2262	=item $timer = $timer->set ($tstamp[, $interval])
1386		2263
1387	Set the time the event is generated to $tstamp.	2264	Set the time the event is generated to $tstamp (and optionally specifies a
		2265	new $interval).
1388		2266
1389	=item $timer = $timer->interval ($interval)	2267	=item $timer = $timer->interval ($interval)
1390		2268
1391	Normally (and when C<$interval> is C<0>), the timer will automatically	2269	By default (and when C<$interval> is C<0>), the timer will automatically
1392	stop after it has fired once. If C<$interval> is non-zero, then the timer	2270	stop after it has fired once. If C<$interval> is non-zero, then the timer
1393	is automatically rescheduled at the given intervals.	2271	is automatically rescheduled at the given intervals.
1394		2272
1395	=item $timer = $timer->start	2273	=item $timer = $timer->start
1396		2274
1397	Start the timer.	2275	Start the timer.
1398		2276
1399	=item $timer = $timer->start ($tstamp)	2277	=item $timer = $timer->start ($tstamp[, $interval])
1400		2278
1401	Set the event trigger time to C<$tstamp> and start the timer.	2279	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2280	also replaces the interval.
		2281
		2282	=item $timer = $timer->after ($delay[, $interval])
		2283
		2284	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1402		2285
1403	=item $timer = $timer->stop	2286	=item $timer = $timer->stop
1404		2287
1405	Stop the timer.	2288	Stop the timer.
1406		2289
…		…
1412		2295
1413	$term->{socket} = ...	2296	$term->{socket} = ...
1414	$term->{iow} = urxvt::iow	2297	$term->{iow} = urxvt::iow
1415	->new	2298	->new
1416	->fd (fileno $term->{socket})	2299	->fd (fileno $term->{socket})
1417	->events (urxvt::EVENT_READ)	2300	->events (urxvt::EV_READ)
1418	->start	2301	->start
1419	->cb (sub {	2302	->cb (sub {
1420	my ($iow, $revents) = @_;	2303	my ($iow, $revents) = @_;
1421	# $revents must be 1 here, no need to check	2304	# $revents must be 1 here, no need to check
1422	sysread $term->{socket}, my $buf, 8192	2305	sysread $term->{socket}, my $buf, 8192
…		…
1435	Set the callback to be called when io events are triggered. C<$reventmask>	2318	Set the callback to be called when io events are triggered. C<$reventmask>
1436	is a bitset as described in the C<events> method.	2319	is a bitset as described in the C<events> method.
1437		2320
1438	=item $iow = $iow->fd ($fd)	2321	=item $iow = $iow->fd ($fd)
1439		2322
1440	Set the filedescriptor (not handle) to watch.	2323	Set the file descriptor (not handle) to watch.
1441		2324
1442	=item $iow = $iow->events ($eventmask)	2325	=item $iow = $iow->events ($eventmask)
1443		2326
1444	Set the event mask to watch. The only allowed values are	2327	Set the event mask to watch. The only allowed values are
1445	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2328	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1446	together, or C<urxvt::EVENT_NONE>.	2329	together, or C<urxvt::EV_NONE>.
1447		2330
1448	=item $iow = $iow->start	2331	=item $iow = $iow->start
1449		2332
1450	Start watching for requested events on the given handle.	2333	Start watching for requested events on the given handle.
1451		2334
1452	=item $iow = $iow->stop	2335	=item $iow = $iow->stop
1453		2336
1454	Stop watching for events on the given filehandle.	2337	Stop watching for events on the given file handle.
		2338
		2339	=back
		2340
		2341	=head2 The C<urxvt::iw> Class
		2342
		2343	This class implements idle watchers, that get called automatically when
		2344	the process is idle. They should return as fast as possible, after doing
		2345	some useful work.
		2346
		2347	=over 4
		2348
		2349	=item $iw = new urxvt::iw
		2350
		2351	Create a new idle watcher object in stopped state.
		2352
		2353	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2354
		2355	Set the callback to be called when the watcher triggers.
		2356
		2357	=item $timer = $timer->start
		2358
		2359	Start the watcher.
		2360
		2361	=item $timer = $timer->stop
		2362
		2363	Stop the watcher.
		2364
		2365	=back
		2366
		2367	=head2 The C<urxvt::pw> Class
		2368
		2369	This class implements process watchers. They create an event whenever a
		2370	process exits, after which they stop automatically.
		2371
		2372	my $pid = fork;
		2373	...
		2374	$term->{pw} = urxvt::pw
		2375	->new
		2376	->start ($pid)
		2377	->cb (sub {
		2378	my ($pw, $exit_status) = @_;
		2379	...
		2380	});
		2381
		2382	=over 4
		2383
		2384	=item $pw = new urxvt::pw
		2385
		2386	Create a new process watcher in stopped state.
		2387
		2388	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2389
		2390	Set the callback to be called when the timer triggers.
		2391
		2392	=item $pw = $timer->start ($pid)
		2393
		2394	Tells the watcher to start watching for process C<$pid>.
		2395
		2396	=item $pw = $pw->stop
		2397
		2398	Stop the watcher.
1455		2399
1456	=back	2400	=back
1457		2401
1458	=head1 ENVIRONMENT	2402	=head1 ENVIRONMENT
1459		2403
…		…
1466		2410
1467	=item == 0 - fatal messages	2411	=item == 0 - fatal messages
1468		2412
1469	=item >= 3 - script loading and management	2413	=item >= 3 - script loading and management
1470		2414
1471	=item >=10 - all events received	2415	=item >=10 - all called hooks
		2416
		2417	=item >=11 - hook return values
1472		2418
1473	=back	2419	=back
1474		2420
1475	=head1 AUTHOR	2421	=head1 AUTHOR
1476		2422
1477	Marc Lehmann <pcg@goof.com>	2423	Marc Lehmann <schmorp@schmorp.de>
1478	http://software.schmorp.de/pkg/rxvt-unicode	2424	http://software.schmorp.de/pkg/rxvt-unicode
1479		2425
1480	=cut	2426	=cut
1481		2427
1482	1	2428	1
		2429
		2430	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.73 by root, Tue Jan 10 04:23:39 2006 UTC vs. Revision 1.215 by root, Thu Jun 7 16:30:58 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.73 by root, Tue Jan 10 04:23:39 2006 UTC vs.
Revision 1.215 by root, Thu Jun 7 16:30:58 2012 UTC