ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.72 by root, Mon Jan 9 23:30:01 2006 UTC vs.
Revision 1.160 by ayin, Fri Nov 16 10:06:40 2007 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
31	=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 (the 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 from the keyboard.
		265	Simply bind a keysym to "perl:matcher" as seen in the example below.
		266
		267	Example configuration:
		268
		269	URxvt.perl-ext: default,matcher
		270	URxvt.urlLauncher: sensible-browser
		271	URxvt.keysym.C-Delete: perl:matcher
		272	URxvt.matcher.button: 1
		273	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		274	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
		275	URxvt.matcher.launcher.2: gvim +$2 $1
		276
		277	=item xim-onthespot
		278
		279	This (experimental) perl extension implements OnTheSpot editing. It does
		280	not work perfectly, and some input methods don't seem to work well with
		281	OnTheSpot editing in general, but it seems to work at least for SCIM and
		282	kinput2.
		283
		284	You enable it by specifying this extension and a preedit style of
		285	C<OnTheSpot>, i.e.:
		286
		287	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		288
		289	=item kuake<hotkey>
		290
		291	A very primitive quake-console-like extension. It was inspired by a
		292	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		293	user presses a global accelerator key (by default C<F10>), the terminal
		294	will show or hide itself. Another press of the accelerator key will hide
		295	or show it again.
		296
		297	Initially, the window will not be shown when using this extension.
		298
		299	This is useful if you need a single terminal that is not using any desktop
		300	space most of the time but is quickly available at the press of a key.
		301
		302	The accelerator key is grabbed regardless of any modifiers, so this
		303	extension will actually grab a physical key just for this function.
		304
		305	If you want a quake-like animation, tell your window manager to do so
		306	(fvwm can do it).
86		307
87	=item block-graphics-to-ascii	308	=item block-graphics-to-ascii
88		309
89	A not very useful example of filtering all text output to the terminal,	310	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	311	by replacing all line-drawing characters (U+2500 .. U+259F) by a
91	similar-looking ascii character.	312	similar-looking ascii character.
		313
		314	=item digital-clock
		315
		316	Displays a digital clock using the built-in overlay.
		317
		318	=item remote-clipboard
		319
		320	Somewhat of a misnomer, this extension adds two menu entries to the
		321	selection popup that allows one to run external commands to store the
		322	selection somewhere and fetch it again.
		323
		324	We use it to implement a "distributed selection mechanism", which just
		325	means that one command uploads the file to a remote server, and another
		326	reads it.
		327
		328	The commands can be set using the C<URxvt.remote-selection.store> and
		329	C<URxvt.remote-selection.fetch> resources. The first should read the
		330	selection to store from STDIN (always in UTF-8), the second should provide
		331	the selection data on STDOUT (also in UTF-8).
		332
		333	The defaults (which are likely useless to you) use rsh and cat:
		334
		335	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		336	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		337
		338	=item selection-pastebin
		339
		340	This is a little rarely useful extension that Uploads the selection as
		341	textfile to a remote site (or does other things). (The implementation is
		342	not currently secure for use in a multiuser environment as it writes to
		343	F</tmp> directly.).
		344
		345	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		346	i.e.
		347
		348	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		349
		350	Pressing this combination runs a command with C<%> replaced by the name of
		351	the textfile. This command can be set via a resource:
		352
		353	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		354
		355	And the default is likely not useful to anybody but the few people around
		356	here :)
		357
		358	The name of the textfile is the hex encoded md5 sum of the selection, so
		359	the same content should lead to the same filename.
		360
		361	After a successful upload the selection will be replaced by the text given
		362	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		363	for the filename):
		364
		365	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		366
		367	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		368	the double C</> characters as comment start. Use C<\057\057> instead,
		369	which works regardless of wether xrdb is used to parse the resource file
		370	or not.
92		371
93	=item example-refresh-hooks	372	=item example-refresh-hooks
94		373
95	Displays a very simple digital clock in the upper right corner of the	374	Displays a very simple digital clock in the upper right corner of the
96	window. Illustrates overwriting the refresh callbacks to create your own	375	window. Illustrates overwriting the refresh callbacks to create your own
97	overlays or changes.	376	overlays or changes.
98		377
99	=back	378	=back
		379
		380	=head1 API DOCUMENTATION
100		381
101	=head2 General API Considerations	382	=head2 General API Considerations
102		383
103	All objects (such as terminals, time watchers etc.) are typical	384	All objects (such as terminals, time watchers etc.) are typical
104	reference-to-hash objects. The hash can be used to store anything you	385	reference-to-hash objects. The hash can be used to store anything you
…		…
117	=over 4	398	=over 4
118		399
119	=item $text	400	=item $text
120		401
121	Rxvt-unicodes special way of encoding text, where one "unicode" character	402	Rxvt-unicodes 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.	403	always represents one screen cell. See L<ROW_t> for a discussion of this format.
123		404
124	=item $string	405	=item $string
125		406
126	A perl text string, with an emphasis on I<text>. It can store all unicode	407	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	408	characters and is to be distinguished with text encoded in a specific
…		…
134		415
135	=back	416	=back
136		417
137	=head2 Extension Objects	418	=head2 Extension Objects
138		419
139	Very perl extension is a perl class. A separate perl object is created	420	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	421	for each terminal, and each terminal has its own set of extenion objects,
141	hooks. So extensions can use their C<$self> object without having to think	422	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	423	their C<$self> object without having to think about clashes with other
		424	extensions or other terminals, with the exception of methods and members
143	begin with an underscore character C<_>: these are reserved for internal	425	that begin with an underscore character C<_>: these are reserved for
144	use.	426	internal use.
145		427
146	Although it isn't a C<urxvt::term> object, you can call all methods of the	428	Although it isn't a C<urxvt::term> object, you can call all methods of the
147	C<urxvt::term> class on this object.	429	C<urxvt::term> class on this object.
148		430
149	It has the following methods and data members:	431	It has the following methods and data members:
…		…
170	=head2 Hooks	452	=head2 Hooks
171		453
172	The following subroutines can be declared in extension files, and will be	454	The following subroutines can be declared in extension files, and will be
173	called whenever the relevant event happens.	455	called whenever the relevant event happens.
174		456
175	The first argument passed to them is an extension oject as described in	457	The first argument passed to them is an extension object as described in
176	the in the C<Extension Objects> section.	458	the in the C<Extension Objects> section.
177		459
178	B<All> of these hooks must return a boolean value. If it is true, then the	460	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	461	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.	462	relevant action might not be carried out by the C++ code.
181		463
182	I<< When in doubt, return a false value (preferably C<()>). >>	464	I<< When in doubt, return a false value (preferably C<()>). >>
183		465
184	=over 4	466	=over 4
185		467
186	=item on_init $term	468	=item on_init $term
187		469
188	Called after a new terminal object has been initialized, but before	470	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	471	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	472	call or deliver senseless data, as terminal size and other characteristics
191	have not yet been determined. You can safely query and change resources,	473	have not yet been determined. You can safely query and change resources
192	though.	474	and options, though. For many purposes the C<on_start> hook is a better
		475	place.
		476
		477	=item on_start $term
		478
		479	Called at the very end of initialisation of a new terminal, just before
		480	trying to map (display) the toplevel and returning to the main loop.
		481
		482	=item on_destroy $term
		483
		484	Called whenever something tries to destroy terminal, when the terminal is
		485	still fully functional (not for long, though).
193		486
194	=item on_reset $term	487	=item on_reset $term
195		488
196	Called after the screen is "reset" for any reason, such as resizing or	489	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	490	control sequences. Here is where you can react on changes to size-related
198	variables.	491	variables.
199		492
200	=item on_start $term	493	=item on_child_start $term, $pid
201		494
202	Called at the very end of initialisation of a new terminal, just before	495	Called just after the child process has been C<fork>ed.
203	returning to the mainloop.	496
		497	=item on_child_exit $term, $status
		498
		499	Called just after the child process has exited. C<$status> is the status
		500	from C<waitpid>.
204		501
205	=item on_sel_make $term, $eventtime	502	=item on_sel_make $term, $eventtime
206		503
207	Called whenever a selection has been made by the user, but before the	504	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	505	selection text is copied, so changes to the beginning, end or type of the
…		…
215		512
216	Called whenever a selection has been copied, but before the selection is	513	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	514	requested from the server. The selection text can be queried and changed
218	by calling C<< $term->selection >>.	515	by calling C<< $term->selection >>.
219		516
220	Returning a true value aborts selection grabbing. It will still be hilighted.	517	Returning a true value aborts selection grabbing. It will still be highlighted.
221		518
222	=item on_sel_extend $term	519	=item on_sel_extend $term
223		520
224	Called whenever the user tries to extend the selection (e.g. with a double	521	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	522	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	523	should extend the selection itself and return true to suppress the built-in
227	processing.	524	processing. This can happen multiple times, as long as the callback
		525	returns true, it will be called on every further click by the user and is
		526	supposed to enlarge the selection more and more, if possible.
228		527
229	See the F<selection> example extension.	528	See the F<selection> example extension.
230		529
231	=item on_view_change $term, $offset	530	=item on_view_change $term, $offset
232		531
233	Called whenever the view offset changes, i..e the user or program	532	Called whenever the view offset changes, i.e. the user or program
234	scrolls. Offset C<0> means display the normal terminal, positive values	533	scrolls. Offset C<0> means display the normal terminal, positive values
235	show this many lines of scrollback.	534	show this many lines of scrollback.
236		535
237	=item on_scroll_back $term, $lines, $saved	536	=item on_scroll_back $term, $lines, $saved
238		537
…		…
242		541
243	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	542	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	543	$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.	544	number of lines that will be in the scrollback buffer.
246		545
		546	=item on_osc_seq $term, $op, $args
		547
		548	Called on every OSC sequence and can be used to suppress it or modify its
		549	behaviour. The default should be to return an empty list. A true value
		550	suppresses execution of the request completely. Make sure you don't get
		551	confused by recursive invocations when you output an osc sequence within
		552	this callback.
		553
		554	C<on_osc_seq_perl> should be used for new behaviour.
		555
247	=item on_osc_seq $term, $string	556	=item on_osc_seq_perl $term, $string
248		557
249	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	558	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
250	operating system command) is processed. Cursor position and other state	559	operating system command) is processed. Cursor position and other state
251	information is up-to-date when this happens. For interoperability, the	560	information is up-to-date when this happens. For interoperability, the
252	string should start with the extension name and a colon, to distinguish	561	string should start with the extension name and a colon, to distinguish
253	it from commands for other extensions, and this might be enforced in the	562	it from commands for other extensions, and this might be enforced in the
254	future.	563	future.
255		564
256	Be careful not ever to trust (in a security sense) the data you receive,	565	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	566	as its source can not easily be controlled (e-mail content, messages from
258	other users on the same system etc.).	567	other users on the same system etc.).
259		568
260	=item on_add_lines $term, $string	569	=item on_add_lines $term, $string
261		570
262	Called whenever text is about to be output, with the text as argument. You	571	Called whenever text is about to be output, with the text as argument. You
…		…
293		602
294	=item on_refresh_end $term	603	=item on_refresh_end $term
295		604
296	Called just after the screen gets redrawn. See C<on_refresh_begin>.	605	Called just after the screen gets redrawn. See C<on_refresh_begin>.
297		606
298	=item on_keyboard_command $term, $string	607	=item on_user_command $term, $string
299		608
300	Called whenever the user presses a key combination that has a	609	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>	610	a C<perl:string> action bound to a key, see description of the B<keysym>
302	resource in the @@RXVT_NAME@@(1) manpage).	611	resource in the @@RXVT_NAME@@(1) manpage).
		612
		613	The event is simply the action string. This interface is assumed to change
		614	slightly in the future.
		615
		616	=item on_resize_all_windows $tern, $new_width, $new_height
		617
		618	Called just after the new window size has been calculated, but before
		619	windows are actually being resized or hints are being set. If this hook
		620	returns TRUE, setting of the window hints is being skipped.
		621
		622	=item on_x_event $term, $event
		623
		624	Called on every X event received on the vt window (and possibly other
		625	windows). Should only be used as a last resort. Most event structure
		626	members are not passed.
		627
		628	=item on_root_event $term, $event
		629
		630	Like C<on_x_event>, but is called for events on the root window.
303		631
304	=item on_focus_in $term	632	=item on_focus_in $term
305		633
306	Called whenever the window gets the keyboard focus, before rxvt-unicode	634	Called whenever the window gets the keyboard focus, before rxvt-unicode
307	does focus in processing.	635	does focus in processing.
308		636
309	=item on_focus_out $term	637	=item on_focus_out $term
310		638
311	Called wheneever the window loses keyboard focus, before rxvt-unicode does	639	Called whenever the window loses keyboard focus, before rxvt-unicode does
312	focus out processing.	640	focus out processing.
		641
		642	=item on_configure_notify $term, $event
		643
		644	=item on_property_notify $term, $event
313		645
314	=item on_key_press $term, $event, $keysym, $octets	646	=item on_key_press $term, $event, $keysym, $octets
315		647
316	=item on_key_release $term, $event, $keysym	648	=item on_key_release $term, $event, $keysym
317		649
…		…
327		659
328	Called whenever the corresponding X event is received for the terminal If	660	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.	661	the hook returns true, then the even will be ignored by rxvt-unicode.
330		662
331	The event is a hash with most values as named by Xlib (see the XEvent	663	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	664	manpage), with the additional members C<row> and C<col>, which are the
333	and column under the mouse cursor.	665	(real, not screen-based) row and column under the mouse cursor.
334		666
335	C<on_key_press> additionally receives the string rxvt-unicode would	667	C<on_key_press> additionally receives the string rxvt-unicode would
336	output, if any, in locale-specific encoding.	668	output, if any, in locale-specific encoding.
337		669
338	subwindow.	670	subwindow.
339		671
340	=back	672	=item on_client_message $term, $event
341		673
342	=head2 Variables in the C<urxvt> Package	674	=item on_wm_protocols $term, $event
343		675
344	=over 4	676	=item on_wm_delete_window $term, $event
345		677
346	=item $urxvt::TERM	678	Called when various types of ClientMessage events are received (all with
347		679	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
348	The current terminal. This variable stores the current C<urxvt::term>
349	object, whenever a callback/hook is executing.
350
351	=back
352
353	=head2 Functions in the C<urxvt> Package
354
355	=over 4
356
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
366
367	Fatally aborts execution with the given error message. Avoid at all
368	costs! The only time this is acceptable is when the terminal process
369	starts up.
370
371	=item urxvt::warn $string
372
373	Calls C<rxvt_warn> with the given string which should not include a
374	newline. The module also overwrites the C<warn> builtin with a function
375	that calls this function.
376
377	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.
379
380	=item $is_safe = urxvt::safe
381
382	Returns true when it is safe to do potentially unsafe things, such as
383	evaluating perl code specified by the user. This is true when urxvt was
384	started setuid or setgid.
385
386	=item $time = urxvt::NOW
387
388	Returns the "current time" (as per the event loop).
389
390	=item urxvt::CurrentTime
391
392	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
393	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
394	Button4Mask, Button5Mask, AnyModifier
395
396	Various constants for use in X calls and event processing.
397
398	=back
399
400	=head2 RENDITION
401
402	Rendition bitsets contain information about colour, font, font styles and
403	similar information for each screen cell.
404
405	The following "macros" deal with changes in rendition sets. You should
406	never just create a bitset, you should always modify an existing one,
407	as they contain important information required for correct operation of
408	rxvt-unicode.
409
410	=over 4
411
412	=item $rend = urxvt::DEFAULT_RSTYLE
413
414	Returns the default rendition, as used when the terminal is starting up or
415	being reset. Useful as a base to start when creating renditions.
416
417	=item $rend = urxvt::OVERLAY_RSTYLE
418
419	Return the rendition mask used for overlays by default.
420
421	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
422
423	Return the bit that enabled bold, italic, blink, reverse-video and
424	underline, respectively. To enable such a style, just logically OR it into
425	the bitset.
426
427	=item $foreground = urxvt::GET_BASEFG $rend
428
429	=item $background = urxvt::GET_BASEBG $rend
430
431	Return the foreground/background colour index, respectively.
432
433	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
434
435	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
436
437	Replace the foreground/background colour in the rendition mask with the
438	specified one.
439
440	=item $value = urxvt::GET_CUSTOM ($rend)
441
442	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
444	zero.
445
446	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
447
448	Change the custom value.
449		680
450	=back	681	=back
451		682
452	=cut	683	=cut
453		684
…		…
459	use Scalar::Util ();	690	use Scalar::Util ();
460	use List::Util ();	691	use List::Util ();
461		692
462	our $VERSION = 1;	693	our $VERSION = 1;
463	our $TERM;	694	our $TERM;
		695	our @TERM_INIT;
		696	our @TERM_EXT;
464	our @HOOKNAME;	697	our @HOOKNAME;
465	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	698	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
466	our %OPTION;	699	our %OPTION;
		700
467	our $LIBDIR;	701	our $LIBDIR;
		702	our $RESNAME;
		703	our $RESCLASS;
		704	our $RXVTNAME;
		705
		706	our $NOCHAR = chr 0xffff;
		707
		708	=head2 Variables in the C<urxvt> Package
		709
		710	=over 4
		711
		712	=item $urxvt::LIBDIR
		713
		714	The rxvt-unicode library directory, where, among other things, the perl
		715	modules and scripts are stored.
		716
		717	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		718
		719	The resource class and name rxvt-unicode uses to look up X resources.
		720
		721	=item $urxvt::RXVTNAME
		722
		723	The basename of the installed binaries, usually C<urxvt>.
		724
		725	=item $urxvt::TERM
		726
		727	The current terminal. This variable stores the current C<urxvt::term>
		728	object, whenever a callback/hook is executing.
		729
		730	=item @urxvt::TERM_INIT
		731
		732	All code references in this array will be called as methods of the next newly
		733	created C<urxvt::term> object (during the C<on_init> phase). The array
		734	gets cleared before the code references that were in it are being executed,
		735	so references can push themselves onto it again if they so desire.
		736
		737	This complements to the perl-eval command line option, but gets executed
		738	first.
		739
		740	=item @urxvt::TERM_EXT
		741
		742	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		743	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		744	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		745
		746	=back
		747
		748	=head2 Functions in the C<urxvt> Package
		749
		750	=over 4
		751
		752	=item urxvt::fatal $errormessage
		753
		754	Fatally aborts execution with the given error message. Avoid at all
		755	costs! The only time this is acceptable is when the terminal process
		756	starts up.
		757
		758	=item urxvt::warn $string
		759
		760	Calls C<rxvt_warn> with the given string which should not include a
		761	newline. The module also overwrites the C<warn> builtin with a function
		762	that calls this function.
		763
		764	Using this function has the advantage that its output ends up in the
		765	correct place, e.g. on stderr of the connecting urxvtc client.
		766
		767	Messages have a size limit of 1023 bytes currently.
		768
		769	=item @terms = urxvt::termlist
		770
		771	Returns all urxvt::term objects that exist in this process, regardless of
		772	whether they are started, being destroyed etc., so be careful. Only term
		773	objects that have perl extensions attached will be returned (because there
		774	is no urxvt::term objet associated with others).
		775
		776	=item $time = urxvt::NOW
		777
		778	Returns the "current time" (as per the event loop).
		779
		780	=item urxvt::CurrentTime
		781
		782	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		783	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		784	Button4Mask, Button5Mask, AnyModifier
		785
		786	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		787	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		788	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		789	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		790	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		791	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		792	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		793
		794	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		795	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		796	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		797	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		798	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		799	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		800	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		801
		802	Various constants for use in X calls and event processing.
		803
		804	=back
		805
		806	=head2 RENDITION
		807
		808	Rendition bitsets contain information about colour, font, font styles and
		809	similar information for each screen cell.
		810
		811	The following "macros" deal with changes in rendition sets. You should
		812	never just create a bitset, you should always modify an existing one,
		813	as they contain important information required for correct operation of
		814	rxvt-unicode.
		815
		816	=over 4
		817
		818	=item $rend = urxvt::DEFAULT_RSTYLE
		819
		820	Returns the default rendition, as used when the terminal is starting up or
		821	being reset. Useful as a base to start when creating renditions.
		822
		823	=item $rend = urxvt::OVERLAY_RSTYLE
		824
		825	Return the rendition mask used for overlays by default.
		826
		827	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		828
		829	Return the bit that enabled bold, italic, blink, reverse-video and
		830	underline, respectively. To enable such a style, just logically OR it into
		831	the bitset.
		832
		833	=item $foreground = urxvt::GET_BASEFG $rend
		834
		835	=item $background = urxvt::GET_BASEBG $rend
		836
		837	Return the foreground/background colour index, respectively.
		838
		839	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		840
		841	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		842
		843	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		844
		845	Replace the foreground/background colour in the rendition mask with the
		846	specified one.
		847
		848	=item $value = urxvt::GET_CUSTOM $rend
		849
		850	Return the "custom" value: Every rendition has 5 bits for use by
		851	extensions. They can be set and changed as you like and are initially
		852	zero.
		853
		854	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		855
		856	Change the custom value.
		857
		858	=back
		859
		860	=cut
468		861
469	BEGIN {	862	BEGIN {
470	urxvt->bootstrap;
471
472	# overwrite perl's warn	863	# overwrite perl's warn
473	*CORE::GLOBAL::warn = sub {	864	*CORE::GLOBAL::warn = sub {
474	my $msg = join "", @_;	865	my $msg = join "", @_;
475	$msg .= "\n"	866	$msg .= "\n"
476	unless $msg =~ /\n$/;	867	unless $msg =~ /\n$/;
477	urxvt::warn ($msg);	868	urxvt::warn ($msg);
478	};	869	};
479
480	delete $ENV{IFS};
481	delete $ENV{CDPATH};
482	delete $ENV{BASH_ENV};
483	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
484	}	870	}
485		871
486	my @hook_count;	872	no warnings 'utf8';
		873
487	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	874	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
488		875
489	sub verbose {	876	sub verbose {
490	my ($level, $msg) = @_;	877	my ($level, $msg) = @_;
491	warn "$msg\n" if $level <= $verbosity;	878	warn "$msg\n" if $level <= $verbosity;
492	}	879	}
493		880
494	my $extension_pkg = "extension0000";
495	my %extension_pkg;	881	my %extension_pkg;
496		882
497	# load a single script into its own package, once only	883	# load a single script into its own package, once only
498	sub extension_package($) {	884	sub extension_package($) {
499	my ($path) = @_;	885	my ($path) = @_;
500		886
501	$extension_pkg{$path} ||= do {	887	$extension_pkg{$path} ||= do {
502	my $pkg = "urxvt::" . ($extension_pkg++);	888	$path =~ /([^\/\\]+)$/;
		889	my $pkg = $1;
		890	$pkg =~ s/[^[:word:]]/_/g;
		891	$pkg = "urxvt::ext::$pkg";
503		892
504	verbose 3, "loading extension '$path' into package '$pkg'";	893	verbose 3, "loading extension '$path' into package '$pkg'";
505		894
506	open my $fh, "<:raw", $path	895	open my $fh, "<:raw", $path
507	or die "$path: $!";	896	or die "$path: $!";
508		897
509	my $source = untaint	898	my $source =
510	"package $pkg; use strict; use utf8;\n"	899	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
511	. "use base urxvt::term::extension::;\n"
512	. "#line 1 \"$path\"\n{\n"	900	. "#line 1 \"$path\"\n{\n"
513	. (do { local $/; <$fh> })	901	. (do { local $/; <$fh> })
514	. "\n};\n1";	902	. "\n};\n1";
515		903
516	eval $source	904	eval $source
…		…
527	local $TERM = shift;	915	local $TERM = shift;
528	my $htype = shift;	916	my $htype = shift;
529		917
530	if ($htype == 0) { # INIT	918	if ($htype == 0) { # INIT
531	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	919	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
532		920
533	my %ext_arg;	921	my %ext_arg;
534		922
		923	{
		924	my @init = @TERM_INIT;
		925	@TERM_INIT = ();
		926	$_->($TERM) for @init;
		927	my @pkg = @TERM_EXT;
		928	@TERM_EXT = ();
		929	$TERM->register_package ($_) for @pkg;
		930	}
		931
535	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	932	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
536	if ($_ eq "default") {	933	if ($_ eq "default") {
537	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	934	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
538	} elsif (/^-(.*)$/) {	935	} elsif (/^-(.*)$/) {
539	delete $ext_arg{$1};	936	delete $ext_arg{$1};
540	} elsif (/^([^<]+)<(.*)>$/) {	937	} elsif (/^([^<]+)<(.*)>$/) {
541	push @{ $ext_arg{$1} }, $2;	938	push @{ $ext_arg{$1} }, $2;
542	} else {	939	} else {
543	$ext_arg{$_} ||= [];	940	$ext_arg{$_} ||= [];
544	}	941	}
545	}	942	}
546		943
547	while (my ($ext, $argv) = each %ext_arg) {	944	for my $ext (sort keys %ext_arg) {
548	my @files = grep -f $_, map "$_/$ext", @dirs;	945	my @files = grep -f $_, map "$_/$ext", @dirs;
549		946
550	if (@files) {	947	if (@files) {
551	$TERM->register_package (extension_package $files[0], $argv);	948	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
552	} else {	949	} else {
553	warn "perl extension '$ext' not found in perl library search path\n";	950	warn "perl extension '$ext' not found in perl library search path\n";
554	}	951	}
555	}	952	}
556		953
…		…
562		959
563	if (my $cb = $TERM->{_hook}[$htype]) {	960	if (my $cb = $TERM->{_hook}[$htype]) {
564	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	961	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
565	if $verbosity >= 10;	962	if $verbosity >= 10;
566		963
567	keys %$cb;	964	for my $pkg (keys %$cb) {
568
569	while (my ($pkg, $cb) = each %$cb) {
570	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	965	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
571	and last;	966	$retval ||= $retval_;
572		967
573	if ($@) {	968	if ($@) {
574	$TERM->ungrab; # better to lose the grab than the session	969	$TERM->ungrab; # better to lose the grab than the session
575	warn $@;	970	warn $@;
576	}	971	}
577	}	972	}
		973
		974	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		975	if $verbosity >= 11;
578	}	976	}
579		977
580	if ($htype == 1) { # DESTROY	978	if ($htype == 1) { # DESTROY
581	if (my $hook = delete $TERM->{_hook}) {
582	for my $htype (0..$#$hook) {
583	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
584	or set_should_invoke $htype, 0;
585	}
586	}
587
588	# clear package objects	979	# clear package objects
589	%$_ = () for values %{ $TERM->{_pkg} };	980	%$_ = () for values %{ $TERM->{_pkg} };
590		981
591	# clear package	982	# clear package
592	%$TERM = ();	983	%$TERM = ();
593	}	984	}
594		985
595	$retval	986	$retval
		987	}
		988
		989	sub SET_COLOR($$$) {
		990	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		991	}
		992
		993	sub rend2mask {
		994	no strict 'refs';
		995	my ($str, $mask) = (@_, 0);
		996	my %color = ( fg => undef, bg => undef );
		997	my @failed;
		998	for my $spec ( split /\s+/, $str ) {
		999	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1000	$color{lc($1)} = $2;
		1001	} else {
		1002	my $neg = $spec =~ s/^[-^]//;
		1003	unless ( exists &{"RS_$spec"} ) {
		1004	push @failed, $spec;
		1005	next;
		1006	}
		1007	my $cur = &{"RS_$spec"};
		1008	if ( $neg ) {
		1009	$mask &= ~$cur;
		1010	} else {
		1011	$mask |= $cur;
		1012	}
		1013	}
		1014	}
		1015	($mask, @color{qw(fg bg)}, \@failed)
596	}	1016	}
597		1017
598	# urxvt::term::extension	1018	# urxvt::term::extension
599		1019
600	package urxvt::term::extension;	1020	package urxvt::term::extension;
…		…
606	while (my ($name, $cb) = each %hook) {	1026	while (my ($name, $cb) = each %hook) {
607	my $htype = $HOOKTYPE{uc $name};	1027	my $htype = $HOOKTYPE{uc $name};
608	defined $htype	1028	defined $htype
609	or Carp::croak "unsupported hook type '$name'";	1029	or Carp::croak "unsupported hook type '$name'";
610		1030
		1031	$self->set_should_invoke ($htype, +1)
611	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	1032	unless exists $self->{term}{_hook}[$htype]{$pkg};
612	$hook_count[$htype]++
613	or urxvt::set_should_invoke $htype, 1;
614	}
615		1033
616	$self->{term}{_hook}[$htype]{$pkg} = $cb;	1034	$self->{term}{_hook}[$htype]{$pkg} = $cb;
617	}	1035	}
618	}	1036	}
619		1037
…		…
624	for my $name (@hook) {	1042	for my $name (@hook) {
625	my $htype = $HOOKTYPE{uc $name};	1043	my $htype = $HOOKTYPE{uc $name};
626	defined $htype	1044	defined $htype
627	or Carp::croak "unsupported hook type '$name'";	1045	or Carp::croak "unsupported hook type '$name'";
628		1046
		1047	$self->set_should_invoke ($htype, -1)
629	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1048	if delete $self->{term}{_hook}[$htype]{$pkg};
630	--$hook_count[$htype]
631	or urxvt::set_should_invoke $htype, 0;
632	}
633	}	1049	}
634	}	1050	}
635		1051
636	our $AUTOLOAD;	1052	our $AUTOLOAD;
637		1053
…		…
668		1084
669	=head2 The C<urxvt::anyevent> Class	1085	=head2 The C<urxvt::anyevent> Class
670		1086
671	The sole purpose of this class is to deliver an interface to the	1087	The sole purpose of this class is to deliver an interface to the
672	C<AnyEvent> module - any module using it will work inside urxvt without	1088	C<AnyEvent> module - any module using it will work inside urxvt without
673	further work. The only exception is that you cannot wait on condition	1089	further programming. The only exception is that you cannot wait on
674	variables, but non-blocking condvar use is ok. What this means is that you	1090	condition variables, but non-blocking condvar use is ok. What this means
675	cannot use blocking APIs, but the non-blocking variant should work.	1091	is that you cannot use blocking APIs, but the non-blocking variant should
		1092	work.
676		1093
677	=cut	1094	=cut
678		1095
679	our $VERSION = 1;	1096	our $VERSION = 1;
680		1097
…		…
716	sub DESTROY {	1133	sub DESTROY {
717	$_[0][1]->stop;	1134	$_[0][1]->stop;
718	}	1135	}
719		1136
720	sub condvar {	1137	sub condvar {
721	bless \my $flag, urxvt::anyevent::condvar::	1138	bless \my $flag, urxvt::anyevent::
722	}	1139	}
723		1140
724	sub urxvt::anyevent::condvar::broadcast {	1141	sub broadcast {
725	${$_[0]}++;	1142	${$_[0]}++;
726	}	1143	}
727		1144
728	sub urxvt::anyevent::condvar::wait {	1145	sub wait {
729	unless (${$_[0]}) {	1146	unless (${$_[0]}) {
730	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1147	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
731	}	1148	}
		1149	}
		1150
		1151	sub one_event {
		1152	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
732	}	1153	}
733		1154
734	package urxvt::term;	1155	package urxvt::term;
735		1156
736	=head2 The C<urxvt::term> Class	1157	=head2 The C<urxvt::term> Class
…		…
741		1162
742	# find on_xxx subs in the package and register them	1163	# find on_xxx subs in the package and register them
743	# as hooks	1164	# as hooks
744	sub register_package {	1165	sub register_package {
745	my ($self, $pkg, $argv) = @_;	1166	my ($self, $pkg, $argv) = @_;
		1167
		1168	no strict 'refs';
		1169
		1170	urxvt::verbose 6, "register package $pkg to $self";
		1171
		1172	@{"$pkg\::ISA"} = urxvt::term::extension::;
746		1173
747	my $proxy = bless {	1174	my $proxy = bless {
748	_pkg => $pkg,	1175	_pkg => $pkg,
749	argv => $argv,	1176	argv => $argv,
750	}, $pkg;	1177	}, $pkg;
…		…
757	$proxy->enable ($name => $ref);	1184	$proxy->enable ($name => $ref);
758	}	1185	}
759	}	1186	}
760	}	1187	}
761		1188
		1189	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1190
		1191	Creates a new terminal, very similar as if you had started it with system
		1192	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1193	hash which defines the environment of the new terminal.
		1194
		1195	Croaks (and probably outputs an error message) if the new instance
		1196	couldn't be created. Returns C<undef> if the new instance didn't
		1197	initialise perl, and the terminal object otherwise. The C<init> and
		1198	C<start> hooks will be called before this call returns, and are free to
		1199	refer to global data (which is race free).
		1200
		1201	=cut
		1202
		1203	sub new {
		1204	my ($class, $env, @args) = @_;
		1205
		1206	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1207	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1208
		1209	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1210	}
		1211
762	=item $term->destroy	1212	=item $term->destroy
763		1213
764	Destroy the terminal object (close the window, free resources etc.).	1214	Destroy the terminal object (close the window, free resources
		1215	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1216	watchers (timers, io watchers) are still active.
		1217
		1218	=item $term->exec_async ($cmd[, @args])
		1219
		1220	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1221	("starts") programs in the background. This function takes care of setting
		1222	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1223	be preferred over explicit calls to C<exec> or C<system>.
		1224
		1225	Returns the pid of the subprocess or C<undef> on error.
		1226
		1227	=cut
		1228
		1229	sub exec_async {
		1230	my $self = shift;
		1231
		1232	my $pid = fork;
		1233
		1234	return $pid
		1235	if !defined $pid or $pid;
		1236
		1237	%ENV = %{ $self->env };
		1238
		1239	exec @_;
		1240	urxvt::_exit 255;
		1241	}
765		1242
766	=item $isset = $term->option ($optval[, $set])	1243	=item $isset = $term->option ($optval[, $set])
767		1244
768	Returns true if the option specified by C<$optval> is enabled, and	1245	Returns true if the option specified by C<$optval> is enabled, and
769	optionally change it. All option values are stored by name in the hash	1246	optionally change it. All option values are stored by name in the hash
770	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1247	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
771		1248
772	Here is a a likely non-exhaustive list of option names, please see the	1249	Here is a likely non-exhaustive list of option names, please see the
773	source file F</src/optinc.h> to see the actual list:	1250	source file F</src/optinc.h> to see the actual list:
774		1251
775	borderLess console cursorBlink cursorUnderline hold iconic insecure	1252	borderLess console cursorBlink cursorUnderline hold iconic insecure
776	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1253	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
777	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1254	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
778	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1255	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
779	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1256	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
780	tripleclickwords utmpInhibit visualBell	1257	transparent tripleclickwords utmpInhibit visualBell
781		1258
782	=item $value = $term->resource ($name[, $newval])	1259	=item $value = $term->resource ($name[, $newval])
783		1260
784	Returns the current resource value associated with a given name and	1261	Returns the current resource value associated with a given name and
785	optionally sets a new value. Setting values is most useful in the C<init>	1262	optionally sets a new value. Setting values is most useful in the C<init>
…		…
794	likely change).	1271	likely change).
795		1272
796	Please note that resource strings will currently only be freed when the	1273	Please note that resource strings will currently only be freed when the
797	terminal is destroyed, so changing options frequently will eat memory.	1274	terminal is destroyed, so changing options frequently will eat memory.
798		1275
799	Here is a a likely non-exhaustive list of resource names, not all of which	1276	Here is a likely non-exhaustive list of resource names, not all of which
800	are supported in every build, please see the source file F</src/rsinc.h>	1277	are supported in every build, please see the source file F</src/rsinc.h>
801	to see the actual list:	1278	to see the actual list:
802		1279
803	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1280	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
804	borderLess color cursorBlink cursorUnderline cutchars delete_key	1281	borderLess color cursorBlink cursorUnderline cutchars delete_key
805	display_name embed ext_bwidth fade font geometry hold iconName	1282	display_name embed ext_bwidth fade font geometry hold iconName
806	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1283	imFont imLocale inputMethod insecure int_bwidth intensityStyles
807	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1284	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
808	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1285	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
809	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1286	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
810	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1287	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
811	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1288	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
812	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1289	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
813	shade term_name title transparent transparent_all tripleclickwords	1290	secondaryScreen secondaryScroll selectstyle shade term_name title
814	utmpInhibit visualBell	1291	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1292	visualBell
815		1293
816	=cut	1294	=cut
817		1295
818	sub resource($$;$) {	1296	sub resource($$;$) {
819	my ($self, $name) = (shift, shift);	1297	my ($self, $name) = (shift, shift);
820	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1298	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
821	&urxvt::term::_resource	1299	&urxvt::term::_resource
822	}	1300	}
823		1301
		1302	=item $value = $term->x_resource ($pattern)
		1303
		1304	Returns the X-Resource for the given pattern, excluding the program or
		1305	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1306	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1307	resource with that pattern exists.
		1308
		1309	This method should only be called during the C<on_start> hook, as there is
		1310	only one resource database per display, and later invocations might return
		1311	the wrong resources.
		1312
824	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1313	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
825		1314
826	Adds a keymap translation exactly as specified via a resource. See the	1315	Adds a keymap translation exactly as specified via a resource. See the
827	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1316	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
828		1317
…		…
843	=item ($row, $col) = $term->selection_end ([$row, $col])	1332	=item ($row, $col) = $term->selection_end ([$row, $col])
844		1333
845	Return the current values of the selection mark, begin or end positions,	1334	Return the current values of the selection mark, begin or end positions,
846	and optionally set them to new values.	1335	and optionally set them to new values.
847		1336
		1337	=item $term->selection_make ($eventtime[, $rectangular])
		1338
		1339	Tries to make a selection as set by C<selection_beg> and
		1340	C<selection_end>. If C<$rectangular> is true (default: false), a
		1341	rectangular selection will be made. This is the prefered function to make
		1342	a selection.
		1343
848	=item $success = $term->selection_grab ($eventtime)	1344	=item $success = $term->selection_grab ($eventtime)
849		1345
850	Try to request the primary selection from the server (for example, as set	1346	Try to request the primary selection text from the server (for example, as
851	by the next method).	1347	set by the next method). No visual feedback will be given. This function
		1348	is mostly useful from within C<on_sel_grab> hooks.
852		1349
853	=item $oldtext = $term->selection ([$newtext])	1350	=item $oldtext = $term->selection ([$newtext])
854		1351
855	Return the current selection text and optionally replace it by C<$newtext>.	1352	Return the current selection text and optionally replace it by C<$newtext>.
856		1353
…		…
949	Convert the given locale-encoded octets into a perl string.	1446	Convert the given locale-encoded octets into a perl string.
950		1447
951	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1448	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
952		1449
953	XORs the rendition values in the given span with the provided value	1450	XORs the rendition values in the given span with the provided value
954	(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar	1451	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
955	to the selection.	1452	refresh hooks to provide effects similar to the selection.
956		1453
957	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1454	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
958		1455
959	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1456	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
960	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1457	whitespace will additionally be xored with the C<$rstyle2>, which defaults
961	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines	1458	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
962	it instead.	1459	it instead. Both styles I<MUST NOT> contain font styles.
963		1460
964	=item $term->scr_bell	1461	=item $term->scr_bell
965		1462
966	Ring the bell!	1463	Ring the bell!
967		1464
…		…
974		1471
975	Normally its not a good idea to use this function, as programs might be	1472	Normally its not a good idea to use this function, as programs might be
976	confused by changes in cursor position or scrolling. Its useful inside a	1473	confused by changes in cursor position or scrolling. Its useful inside a
977	C<on_add_lines> hook, though.	1474	C<on_add_lines> hook, though.
978		1475
		1476	=item $term->scr_change_screen ($screen)
		1477
		1478	Switch to given screen - 0 primary, 1 secondary.
		1479
979	=item $term->cmd_parse ($octets)	1480	=item $term->cmd_parse ($octets)
980		1481
981	Similar to C<scr_add_lines>, but the argument must be in the	1482	Similar to C<scr_add_lines>, but the argument must be in the
982	locale-specific encoding of the terminal and can contain command sequences	1483	locale-specific encoding of the terminal and can contain command sequences
983	(escape codes) that will be interpreted.	1484	(escape codes) that will be interpreted.
…		…
993	Replaces the event mask of the pty watcher by the given event mask. Can	1494	Replaces the event mask of the pty watcher by the given event mask. Can
994	be used to suppress input and output handling to the pty/tty. See the	1495	be used to suppress input and output handling to the pty/tty. See the
995	description of C<< urxvt::timer->events >>. Make sure to always restore	1496	description of C<< urxvt::timer->events >>. Make sure to always restore
996	the previous value.	1497	the previous value.
997		1498
		1499	=item $fd = $term->pty_fd
		1500
		1501	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1502	is used.
		1503
998	=item $windowid = $term->parent	1504	=item $windowid = $term->parent
999		1505
1000	Return the window id of the toplevel window.	1506	Return the window id of the toplevel window.
1001		1507
1002	=item $windowid = $term->vt	1508	=item $windowid = $term->vt
1003		1509
1004	Return the window id of the terminal window.	1510	Return the window id of the terminal window.
1005		1511
		1512	=item $term->vt_emask_add ($x_event_mask)
		1513
		1514	Adds the specified events to the vt event mask. Useful e.g. when you want
		1515	to receive pointer events all the times:
		1516
		1517	$term->vt_emask_add (urxvt::PointerMotionMask);
		1518
		1519	=item $term->focus_in
		1520
		1521	=item $term->focus_out
		1522
		1523	=item $term->key_press ($state, $keycode[, $time])
		1524
		1525	=item $term->key_release ($state, $keycode[, $time])
		1526
		1527	Deliver various fake events to to terminal.
		1528
1006	=item $window_width = $term->width	1529	=item $window_width = $term->width
1007		1530
1008	=item $window_height = $term->height	1531	=item $window_height = $term->height
1009		1532
1010	=item $font_width = $term->fwidth	1533	=item $font_width = $term->fwidth
…		…
1023		1546
1024	=item $max_scrollback = $term->saveLines	1547	=item $max_scrollback = $term->saveLines
1025		1548
1026	=item $nrow_plus_saveLines = $term->total_rows	1549	=item $nrow_plus_saveLines = $term->total_rows
1027		1550
1028	=item $lines_in_scrollback = $term->nsaved	1551	=item $topmost_scrollback_row = $term->top_row
1029		1552
1030	Return various integers describing terminal characteristics.	1553	Return various integers describing terminal characteristics.
1031		1554
		1555	=item $x_display = $term->display_id
		1556
		1557	Return the DISPLAY used by rxvt-unicode.
		1558
1032	=item $lc_ctype = $term->locale	1559	=item $lc_ctype = $term->locale
1033		1560
1034	Returns the LC_CTYPE category string used by this rxvt-unicode.	1561	Returns the LC_CTYPE category string used by this rxvt-unicode.
1035		1562
1036	=item $x_display = $term->display_id	1563	=item $env = $term->env
1037		1564
1038	Return the DISPLAY used by rxvt-unicode.	1565	Returns a copy of the environment in effect for the terminal as a hashref
		1566	similar to C<\%ENV>.
		1567
		1568	=item @envv = $term->envv
		1569
		1570	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1571
		1572	=item @argv = $term->argv
		1573
		1574	Return the argument vector as this terminal, similar to @ARGV, but
		1575	includes the program name as first element.
		1576
		1577	=cut
		1578
		1579	sub env {
		1580	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
		1581	}
1039		1582
1040	=item $modifiermask = $term->ModLevel3Mask	1583	=item $modifiermask = $term->ModLevel3Mask
1041		1584
1042	=item $modifiermask = $term->ModMetaMask	1585	=item $modifiermask = $term->ModMetaMask
1043		1586
1044	=item $modifiermask = $term->ModNumLockMask	1587	=item $modifiermask = $term->ModNumLockMask
1045		1588
1046	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1589	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1047	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1590	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1048		1591
		1592	=item $screen = $term->current_screen
		1593
		1594	Returns the currently displayed screen (0 primary, 1 secondary).
		1595
		1596	=item $cursor_is_hidden = $term->hidden_cursor
		1597
		1598	Returns whether the cursor is currently hidden or not.
		1599
1049	=item $view_start = $term->view_start ([$newvalue])	1600	=item $view_start = $term->view_start ([$newvalue])
1050		1601
1051	Returns the negative row number of the topmost line. Minimum value is	1602	Returns the row number of the topmost displayed line. Maximum value is
1052	C<0>, which displays the normal terminal contents. Larger values scroll	1603	C<0>, which displays the normal terminal contents. Lower values scroll
1053	this many lines into the scrollback buffer.	1604	this many lines into the scrollback buffer.
1054		1605
1055	=item $term->want_refresh	1606	=item $term->want_refresh
1056		1607
1057	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1608	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1072	line, starting at column C<$start_col> (default C<0>), which is useful	1623	line, starting at column C<$start_col> (default C<0>), which is useful
1073	to replace only parts of a line. The font index in the rendition will	1624	to replace only parts of a line. The font index in the rendition will
1074	automatically be updated.	1625	automatically be updated.
1075		1626
1076	C<$text> is in a special encoding: tabs and wide characters that use more	1627	C<$text> is in a special encoding: tabs and wide characters that use more
1077	than one cell when displayed are padded with urxvt::NOCHAR characters	1628	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1078	(C<chr 65535>). Characters with combining characters and other characters	1629	characters. Characters with combining characters and other characters that
1079	that do not fit into the normal tetx encoding will be replaced with	1630	do not fit into the normal tetx encoding will be replaced with characters
1080	characters in the private use area.	1631	in the private use area.
1081		1632
1082	You have to obey this encoding when changing text. The advantage is	1633	You have to obey this encoding when changing text. The advantage is
1083	that C<substr> and similar functions work on screen cells and not on	1634	that C<substr> and similar functions work on screen cells and not on
1084	characters.	1635	characters.
1085		1636
…		…
1136	Return the row number of the first/last row of the line, respectively.	1687	Return the row number of the first/last row of the line, respectively.
1137		1688
1138	=item $offset = $line->offset_of ($row, $col)	1689	=item $offset = $line->offset_of ($row, $col)
1139		1690
1140	Returns the character offset of the given row|col pair within the logical	1691	Returns the character offset of the given row|col pair within the logical
1141	line.	1692	line. Works for rows outside the line, too, and returns corresponding
		1693	offsets outside the string.
1142		1694
1143	=item ($row, $col) = $line->coord_of ($offset)	1695	=item ($row, $col) = $line->coord_of ($offset)
1144		1696
1145	Translates a string offset into terminal coordinates again.	1697	Translates a string offset into terminal coordinates again.
1146		1698
…		…
1228	where one character corresponds to one screen cell. See	1780	where one character corresponds to one screen cell. See
1229	C<< $term->ROW_t >> for details.	1781	C<< $term->ROW_t >> for details.
1230		1782
1231	=item $string = $term->special_decode $text	1783	=item $string = $term->special_decode $text
1232		1784
1233	Converts rxvt-unicodes text reprsentation into a perl string. See	1785	Converts rxvt-unicodes text representation into a perl string. See
1234	C<< $term->ROW_t >> for details.	1786	C<< $term->ROW_t >> for details.
1235		1787
1236	=item $success = $term->grab_button ($button, $modifiermask)	1788	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1237		1789
		1790	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1791
1238	Registers a synchronous button grab. See the XGrabButton manpage.	1792	Register/unregister a synchronous button grab. See the XGrabButton
		1793	manpage.
1239		1794
1240	=item $success = $term->grab ($eventtime[, $sync])	1795	=item $success = $term->grab ($eventtime[, $sync])
1241		1796
1242	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1797	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1243	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1798	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1244		1799
1245	=item $term->allow_events_async	1800	=item $term->allow_events_async
1246		1801
1247	Calls XAllowEvents with AsyncBoth for the most recent grab.	1802	Calls XAllowEvents with AsyncBoth for the most recent grab.
1248		1803
…		…
1259		1814
1260	Calls XUngrab for the most recent grab. Is called automatically on	1815	Calls XUngrab for the most recent grab. Is called automatically on
1261	evaluation errors, as it is better to lose the grab in the error case as	1816	evaluation errors, as it is better to lose the grab in the error case as
1262	the session.	1817	the session.
1263		1818
		1819	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1820
		1821	=item $atom_name = $term->XGetAtomName ($atom)
		1822
		1823	=item @atoms = $term->XListProperties ($window)
		1824
		1825	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1826
		1827	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1828
		1829	=item $term->XDeleteProperty ($window, $property)
		1830
		1831	=item $window = $term->DefaultRootWindow
		1832
		1833	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1834
		1835	=item $term->XMapWindow ($window)
		1836
		1837	=item $term->XUnmapWindow ($window)
		1838
		1839	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1840
		1841	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1842
		1843	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1844
		1845	Various X or X-related functions. The C<$term> object only serves as
		1846	the source of the display, otherwise those functions map more-or-less
		1847	directory onto the X functions of the same name.
		1848
1264	=back	1849	=back
1265		1850
1266	=cut	1851	=cut
1267		1852
1268	package urxvt::popup;	1853	package urxvt::popup;
…		…
1282		1867
1283	$item->{render} ||= sub { $_[0]{text} };	1868	$item->{render} ||= sub { $_[0]{text} };
1284		1869
1285	push @{ $self->{item} }, $item;	1870	push @{ $self->{item} }, $item;
1286	}	1871	}
		1872
		1873	=item $popup->add_title ($title)
		1874
		1875	Adds a non-clickable title to the popup.
		1876
		1877	=cut
		1878
		1879	sub add_title {
		1880	my ($self, $title) = @_;
		1881
		1882	$self->add_item ({
		1883	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1884	text => $title,
		1885	activate => sub { },
		1886	});
		1887	}
		1888
		1889	=item $popup->add_separator ([$sepchr])
		1890
		1891	Creates a separator, optionally using the character given as C<$sepchr>.
		1892
		1893	=cut
1287		1894
1288	sub add_separator {	1895	sub add_separator {
1289	my ($self, $sep) = @_;	1896	my ($self, $sep) = @_;
1290		1897
1291	$sep ||= "=";	1898	$sep ||= "=";
…		…
1296	render => sub { $sep x $self->{term}->ncol },	1903	render => sub { $sep x $self->{term}->ncol },
1297	activate => sub { },	1904	activate => sub { },
1298	});	1905	});
1299	}	1906	}
1300		1907
1301	sub add_title {	1908	=item $popup->add_button ($text, $cb)
1302	my ($self, $title) = @_;
1303		1909
1304	$self->add_item ({	1910	Adds a clickable button to the popup. C<$cb> is called whenever it is
1305	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1911	selected.
1306	text => $title,	1912
1307	activate => sub { },	1913	=cut
1308	});
1309	}
1310		1914
1311	sub add_button {	1915	sub add_button {
1312	my ($self, $text, $cb) = @_;	1916	my ($self, $text, $cb) = @_;
1313		1917
1314	$self->add_item ({ type => "button", text => $text, activate => $cb});	1918	$self->add_item ({ type => "button", text => $text, activate => $cb});
1315	}	1919	}
1316		1920
		1921	=item $popup->add_toggle ($text, $initial_value, $cb)
		1922
		1923	Adds a toggle/checkbox item to the popup. The callback gets called
		1924	whenever it gets toggled, with a boolean indicating its new value as its
		1925	first argument.
		1926
		1927	=cut
		1928
1317	sub add_toggle {	1929	sub add_toggle {
1318	my ($self, $text, $cb, $value) = @_;	1930	my ($self, $text, $value, $cb) = @_;
1319		1931
1320	my $item; $item = {	1932	my $item; $item = {
1321	type => "button",	1933	type => "button",
1322	text => " $text",	1934	text => " $text",
1323	value => $value,	1935	value => $value,
1324	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1936	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1325	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1937	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1326	};	1938	};
1327		1939
1328	$self->add_item ($item);	1940	$self->add_item ($item);
1329	}	1941	}
		1942
		1943	=item $popup->show
		1944
		1945	Displays the popup (which is initially hidden).
		1946
		1947	=cut
1330		1948
1331	sub show {	1949	sub show {
1332	my ($self) = @_;	1950	my ($self) = @_;
1333		1951
1334	local $urxvt::popup::self = $self;	1952	local $urxvt::popup::self = $self;
1335		1953
		1954	my $env = $self->{term}->env;
		1955	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1956	delete $env->{LC_ALL};
1336	local $ENV{LC_ALL} = $self->{term}->locale;	1957	$env->{LC_CTYPE} = $self->{term}->locale;
1337		1958
1338	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1959	urxvt::term->new ($env, "popup",
		1960	"--perl-lib" => "", "--perl-ext-common" => "",
		1961	"-pty-fd" => -1, "-sl" => 0,
		1962	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1339	"--transient-for" => $self->{term}->parent,	1963	"--transient-for" => $self->{term}->parent,
1340	"-display" => $self->{term}->display_id,	1964	"-display" => $self->{term}->display_id,
1341	"-pe" => "urxvt-popup")	1965	"-pe" => "urxvt-popup")
1342	or die "unable to create popup window\n";	1966	or die "unable to create popup window\n";
1343	}	1967	}
1344		1968
1345	sub DESTROY {	1969	sub DESTROY {
1346	my ($self) = @_;	1970	my ($self) = @_;
1347		1971
1348	delete $self->{term}{_destroy}{$self};	1972	delete $self->{term}{_destroy}{$self};
1349	$self->{term}->ungrab;	1973	$self->{term}->ungrab;
1350	}	1974	}
		1975
		1976	=back
		1977
		1978	=cut
		1979
		1980	package urxvt::watcher;
1351		1981
1352	=head2 The C<urxvt::timer> Class	1982	=head2 The C<urxvt::timer> Class
1353		1983
1354	This class implements timer watchers/events. Time is represented as a	1984	This class implements timer watchers/events. Time is represented as a
1355	fractional number of seconds since the epoch. Example:	1985	fractional number of seconds since the epoch. Example:
…		…
1359	->new	1989	->new
1360	->interval (1)	1990	->interval (1)
1361	->cb (sub {	1991	->cb (sub {
1362	$term->{overlay}->set (0, 0,	1992	$term->{overlay}->set (0, 0,
1363	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	1993	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1364	});	1994	});
1365		1995
1366	=over 4	1996	=over 4
1367		1997
1368	=item $timer = new urxvt::timer	1998	=item $timer = new urxvt::timer
1369		1999
…		…
1393	Start the timer.	2023	Start the timer.
1394		2024
1395	=item $timer = $timer->start ($tstamp)	2025	=item $timer = $timer->start ($tstamp)
1396		2026
1397	Set the event trigger time to C<$tstamp> and start the timer.	2027	Set the event trigger time to C<$tstamp> and start the timer.
		2028
		2029	=item $timer = $timer->after ($delay)
		2030
		2031	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1398		2032
1399	=item $timer = $timer->stop	2033	=item $timer = $timer->stop
1400		2034
1401	Stop the timer.	2035	Stop the timer.
1402		2036
…		…
1408		2042
1409	$term->{socket} = ...	2043	$term->{socket} = ...
1410	$term->{iow} = urxvt::iow	2044	$term->{iow} = urxvt::iow
1411	->new	2045	->new
1412	->fd (fileno $term->{socket})	2046	->fd (fileno $term->{socket})
1413	->events (urxvt::EVENT_READ)	2047	->events (urxvt::EV_READ)
1414	->start	2048	->start
1415	->cb (sub {	2049	->cb (sub {
1416	my ($iow, $revents) = @_;	2050	my ($iow, $revents) = @_;
1417	# $revents must be 1 here, no need to check	2051	# $revents must be 1 here, no need to check
1418	sysread $term->{socket}, my $buf, 8192	2052	sysread $term->{socket}, my $buf, 8192
…		…
1431	Set the callback to be called when io events are triggered. C<$reventmask>	2065	Set the callback to be called when io events are triggered. C<$reventmask>
1432	is a bitset as described in the C<events> method.	2066	is a bitset as described in the C<events> method.
1433		2067
1434	=item $iow = $iow->fd ($fd)	2068	=item $iow = $iow->fd ($fd)
1435		2069
1436	Set the filedescriptor (not handle) to watch.	2070	Set the file descriptor (not handle) to watch.
1437		2071
1438	=item $iow = $iow->events ($eventmask)	2072	=item $iow = $iow->events ($eventmask)
1439		2073
1440	Set the event mask to watch. The only allowed values are	2074	Set the event mask to watch. The only allowed values are
1441	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed	2075	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1442	together, or C<urxvt::EVENT_NONE>.	2076	together, or C<urxvt::EV_NONE>.
1443		2077
1444	=item $iow = $iow->start	2078	=item $iow = $iow->start
1445		2079
1446	Start watching for requested events on the given handle.	2080	Start watching for requested events on the given handle.
1447		2081
1448	=item $iow = $iow->stop	2082	=item $iow = $iow->stop
1449		2083
1450	Stop watching for events on the given filehandle.	2084	Stop watching for events on the given file handle.
		2085
		2086	=back
		2087
		2088	=head2 The C<urxvt::iw> Class
		2089
		2090	This class implements idle watchers, that get called automatically when
		2091	the process is idle. They should return as fast as possible, after doing
		2092	some useful work.
		2093
		2094	=over 4
		2095
		2096	=item $iw = new urxvt::iw
		2097
		2098	Create a new idle watcher object in stopped state.
		2099
		2100	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2101
		2102	Set the callback to be called when the watcher triggers.
		2103
		2104	=item $timer = $timer->start
		2105
		2106	Start the watcher.
		2107
		2108	=item $timer = $timer->stop
		2109
		2110	Stop the watcher.
		2111
		2112	=back
		2113
		2114	=head2 The C<urxvt::pw> Class
		2115
		2116	This class implements process watchers. They create an event whenever a
		2117	process exits, after which they stop automatically.
		2118
		2119	my $pid = fork;
		2120	...
		2121	$term->{pw} = urxvt::pw
		2122	->new
		2123	->start ($pid)
		2124	->cb (sub {
		2125	my ($pw, $exit_status) = @_;
		2126	...
		2127	});
		2128
		2129	=over 4
		2130
		2131	=item $pw = new urxvt::pw
		2132
		2133	Create a new process watcher in stopped state.
		2134
		2135	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2136
		2137	Set the callback to be called when the timer triggers.
		2138
		2139	=item $pw = $timer->start ($pid)
		2140
		2141	Tells the watcher to start watching for process C<$pid>.
		2142
		2143	=item $pw = $pw->stop
		2144
		2145	Stop the watcher.
1451		2146
1452	=back	2147	=back
1453		2148
1454	=head1 ENVIRONMENT	2149	=head1 ENVIRONMENT
1455		2150
…		…
1462		2157
1463	=item == 0 - fatal messages	2158	=item == 0 - fatal messages
1464		2159
1465	=item >= 3 - script loading and management	2160	=item >= 3 - script loading and management
1466		2161
1467	=item >=10 - all events received	2162	=item >=10 - all called hooks
		2163
		2164	=item >=11 - hook return values
1468		2165
1469	=back	2166	=back
1470		2167
1471	=head1 AUTHOR	2168	=head1 AUTHOR
1472		2169
…		…
1474	http://software.schmorp.de/pkg/rxvt-unicode	2171	http://software.schmorp.de/pkg/rxvt-unicode
1475		2172
1476	=cut	2173	=cut
1477		2174
1478	1	2175	1
		2176
		2177	# vim: sw=3:

Diff Legend

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