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.73 by root, Tue Jan 10 04:23:39 2006 UTC vs.
Revision 1.172 by root, Fri Oct 10 00:21:15 2008 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 (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
247	=item on_osc_seq $term, $string	546	=item on_osc_seq $term, $op, $args, $resp
		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
		556	=item on_osc_seq_perl $term, $args, $resp
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 (sans -osc) and a semicolon,
253	it from commands for other extensions, and this might be enforced in the	562	to distinguish it from commands for other extensions, and this might be
254	future.	563	enforced in the future.
		564
		565	For example, C<overlay-osc> uses this:
		566
		567	sub on_osc_seq_perl {
		568	my ($self, $osc, $resp) = @_;
		569
		570	return unless $osc =~ s/^overlay;//;
		571
		572	... process remaining $osc string
		573	}
255		574
256	Be careful not ever to trust (in a security sense) the data you receive,	575	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	576	as its source can not easily be controlled (e-mail content, messages from
258	other users on the same system etc.).	577	other users on the same system etc.).
		578
		579	For responses, C<$resp> contains the end-of-args separator used by the
		580	sender.
259		581
260	=item on_add_lines $term, $string	582	=item on_add_lines $term, $string
261		583
262	Called whenever text is about to be output, with the text as argument. You	584	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	585	can filter/change and output the text yourself by returning a true value
…		…
284	later with the already-modified line (e.g. if unrelated parts change), so	606	later with the already-modified line (e.g. if unrelated parts change), so
285	you cannot just toggle rendition bits, but only set them.	607	you cannot just toggle rendition bits, but only set them.
286		608
287	=item on_refresh_begin $term	609	=item on_refresh_begin $term
288		610
289	Called just before the screen gets redrawn. Can be used for overlay	611	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	612	similar effects by modifying the terminal contents in refresh_begin, and
291	restoring them in refresh_end. The built-in overlay and selection display	613	restoring them in refresh_end. The built-in overlay and selection display
292	code is run after this hook, and takes precedence.	614	code is run after this hook, and takes precedence.
293		615
294	=item on_refresh_end $term	616	=item on_refresh_end $term
295		617
296	Called just after the screen gets redrawn. See C<on_refresh_begin>.	618	Called just after the screen gets redrawn. See C<on_refresh_begin>.
297		619
298	=item on_keyboard_command $term, $string	620	=item on_user_command $term, $string
299		621
300	Called whenever the user presses a key combination that has a	622	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>	623	a C<perl:string> action bound to a key, see description of the B<keysym>
302	resource in the @@RXVT_NAME@@(1) manpage).	624	resource in the @@RXVT_NAME@@(1) manpage).
		625
		626	The event is simply the action string. This interface is assumed to change
		627	slightly in the future.
		628
		629	=item on_resize_all_windows $tern, $new_width, $new_height
		630
		631	Called just after the new window size has been calculated, but before
		632	windows are actually being resized or hints are being set. If this hook
		633	returns TRUE, setting of the window hints is being skipped.
		634
		635	=item on_x_event $term, $event
		636
		637	Called on every X event received on the vt window (and possibly other
		638	windows). Should only be used as a last resort. Most event structure
		639	members are not passed.
		640
		641	=item on_root_event $term, $event
		642
		643	Like C<on_x_event>, but is called for events on the root window.
303		644
304	=item on_focus_in $term	645	=item on_focus_in $term
305		646
306	Called whenever the window gets the keyboard focus, before rxvt-unicode	647	Called whenever the window gets the keyboard focus, before rxvt-unicode
307	does focus in processing.	648	does focus in processing.
308		649
309	=item on_focus_out $term	650	=item on_focus_out $term
310		651
311	Called wheneever the window loses keyboard focus, before rxvt-unicode does	652	Called whenever the window loses keyboard focus, before rxvt-unicode does
312	focus out processing.	653	focus out processing.
		654
		655	=item on_configure_notify $term, $event
		656
		657	=item on_property_notify $term, $event
313		658
314	=item on_key_press $term, $event, $keysym, $octets	659	=item on_key_press $term, $event, $keysym, $octets
315		660
316	=item on_key_release $term, $event, $keysym	661	=item on_key_release $term, $event, $keysym
317		662
…		…
327		672
328	Called whenever the corresponding X event is received for the terminal If	673	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.	674	the hook returns true, then the even will be ignored by rxvt-unicode.
330		675
331	The event is a hash with most values as named by Xlib (see the XEvent	676	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	677	manpage), with the additional members C<row> and C<col>, which are the
333	and column under the mouse cursor.	678	(real, not screen-based) row and column under the mouse cursor.
334		679
335	C<on_key_press> additionally receives the string rxvt-unicode would	680	C<on_key_press> additionally receives the string rxvt-unicode would
336	output, if any, in locale-specific encoding.	681	output, if any, in locale-specific encoding.
337		682
338	subwindow.	683	subwindow.
339		684
340	=back	685	=item on_client_message $term, $event
341		686
342	=head2 Variables in the C<urxvt> Package	687	=item on_wm_protocols $term, $event
343		688
344	=over 4	689	=item on_wm_delete_window $term, $event
345		690
346	=item $urxvt::TERM	691	Called when various types of ClientMessage events are received (all with
347		692	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		693
450	=back	694	=back
451		695
452	=cut	696	=cut
453		697
…		…
459	use Scalar::Util ();	703	use Scalar::Util ();
460	use List::Util ();	704	use List::Util ();
461		705
462	our $VERSION = 1;	706	our $VERSION = 1;
463	our $TERM;	707	our $TERM;
		708	our @TERM_INIT;
		709	our @TERM_EXT;
464	our @HOOKNAME;	710	our @HOOKNAME;
465	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	711	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
466	our %OPTION;	712	our %OPTION;
467		713
468	our $LIBDIR;	714	our $LIBDIR;
469	our $RESNAME;	715	our $RESNAME;
470	our $RESCLASS;	716	our $RESCLASS;
471	our $RXVTNAME;	717	our $RXVTNAME;
472		718
		719	our $NOCHAR = chr 0xffff;
		720
		721	=head2 Variables in the C<urxvt> Package
		722
		723	=over 4
		724
		725	=item $urxvt::LIBDIR
		726
		727	The rxvt-unicode library directory, where, among other things, the perl
		728	modules and scripts are stored.
		729
		730	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		731
		732	The resource class and name rxvt-unicode uses to look up X resources.
		733
		734	=item $urxvt::RXVTNAME
		735
		736	The basename of the installed binaries, usually C<urxvt>.
		737
		738	=item $urxvt::TERM
		739
		740	The current terminal. This variable stores the current C<urxvt::term>
		741	object, whenever a callback/hook is executing.
		742
		743	=item @urxvt::TERM_INIT
		744
		745	All code references in this array will be called as methods of the next newly
		746	created C<urxvt::term> object (during the C<on_init> phase). The array
		747	gets cleared before the code references that were in it are being executed,
		748	so references can push themselves onto it again if they so desire.
		749
		750	This complements to the perl-eval command line option, but gets executed
		751	first.
		752
		753	=item @urxvt::TERM_EXT
		754
		755	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		756	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		757	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		758
		759	=back
		760
		761	=head2 Functions in the C<urxvt> Package
		762
		763	=over 4
		764
		765	=item urxvt::fatal $errormessage
		766
		767	Fatally aborts execution with the given error message. Avoid at all
		768	costs! The only time this is acceptable is when the terminal process
		769	starts up.
		770
		771	=item urxvt::warn $string
		772
		773	Calls C<rxvt_warn> with the given string which should not include a
		774	newline. The module also overwrites the C<warn> builtin with a function
		775	that calls this function.
		776
		777	Using this function has the advantage that its output ends up in the
		778	correct place, e.g. on stderr of the connecting urxvtc client.
		779
		780	Messages have a size limit of 1023 bytes currently.
		781
		782	=item @terms = urxvt::termlist
		783
		784	Returns all urxvt::term objects that exist in this process, regardless of
		785	whether they are started, being destroyed etc., so be careful. Only term
		786	objects that have perl extensions attached will be returned (because there
		787	is no urxvt::term objet associated with others).
		788
		789	=item $time = urxvt::NOW
		790
		791	Returns the "current time" (as per the event loop).
		792
		793	=item urxvt::CurrentTime
		794
		795	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		796	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		797	Button4Mask, Button5Mask, AnyModifier
		798
		799	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		800	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		801	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		802	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		803	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		804	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		805	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		806
		807	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		808	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		809	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		810	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		811	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		812	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		813	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		814
		815	Various constants for use in X calls and event processing.
		816
		817	=back
		818
		819	=head2 RENDITION
		820
		821	Rendition bitsets contain information about colour, font, font styles and
		822	similar information for each screen cell.
		823
		824	The following "macros" deal with changes in rendition sets. You should
		825	never just create a bitset, you should always modify an existing one,
		826	as they contain important information required for correct operation of
		827	rxvt-unicode.
		828
		829	=over 4
		830
		831	=item $rend = urxvt::DEFAULT_RSTYLE
		832
		833	Returns the default rendition, as used when the terminal is starting up or
		834	being reset. Useful as a base to start when creating renditions.
		835
		836	=item $rend = urxvt::OVERLAY_RSTYLE
		837
		838	Return the rendition mask used for overlays by default.
		839
		840	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		841
		842	Return the bit that enabled bold, italic, blink, reverse-video and
		843	underline, respectively. To enable such a style, just logically OR it into
		844	the bitset.
		845
		846	=item $foreground = urxvt::GET_BASEFG $rend
		847
		848	=item $background = urxvt::GET_BASEBG $rend
		849
		850	Return the foreground/background colour index, respectively.
		851
		852	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		853
		854	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		855
		856	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		857
		858	Replace the foreground/background colour in the rendition mask with the
		859	specified one.
		860
		861	=item $value = urxvt::GET_CUSTOM $rend
		862
		863	Return the "custom" value: Every rendition has 5 bits for use by
		864	extensions. They can be set and changed as you like and are initially
		865	zero.
		866
		867	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		868
		869	Change the custom value.
		870
		871	=back
		872
		873	=cut
		874
473	BEGIN {	875	BEGIN {
474	urxvt->bootstrap;
475
476	# overwrite perl's warn	876	# overwrite perl's warn
477	*CORE::GLOBAL::warn = sub {	877	*CORE::GLOBAL::warn = sub {
478	my $msg = join "", @_;	878	my $msg = join "", @_;
479	$msg .= "\n"	879	$msg .= "\n"
480	unless $msg =~ /\n$/;	880	unless $msg =~ /\n$/;
481	urxvt::warn ($msg);	881	urxvt::warn ($msg);
482	};	882	};
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	}	883	}
489		884
490	my @hook_count;	885	no warnings 'utf8';
		886
491	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	887	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
492		888
493	sub verbose {	889	sub verbose {
494	my ($level, $msg) = @_;	890	my ($level, $msg) = @_;
495	warn "$msg\n" if $level <= $verbosity;	891	warn "$msg\n" if $level <= $verbosity;
496	}	892	}
497		893
498	my $extension_pkg = "extension0000";
499	my %extension_pkg;	894	my %extension_pkg;
500		895
501	# load a single script into its own package, once only	896	# load a single script into its own package, once only
502	sub extension_package($) {	897	sub extension_package($) {
503	my ($path) = @_;	898	my ($path) = @_;
504		899
505	$extension_pkg{$path} ||= do {	900	$extension_pkg{$path} ||= do {
506	my $pkg = "urxvt::" . ($extension_pkg++);	901	$path =~ /([^\/\\]+)$/;
		902	my $pkg = $1;
		903	$pkg =~ s/[^[:word:]]/_/g;
		904	$pkg = "urxvt::ext::$pkg";
507		905
508	verbose 3, "loading extension '$path' into package '$pkg'";	906	verbose 3, "loading extension '$path' into package '$pkg'";
509		907
510	open my $fh, "<:raw", $path	908	open my $fh, "<:raw", $path
511	or die "$path: $!";	909	or die "$path: $!";
512		910
513	my $source = untaint	911	my $source =
514	"package $pkg; use strict; use utf8;\n"	912	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
515	. "use base urxvt::term::extension::;\n"
516	. "#line 1 \"$path\"\n{\n"	913	. "#line 1 \"$path\"\n{\n"
517	. (do { local $/; <$fh> })	914	. (do { local $/; <$fh> })
518	. "\n};\n1";	915	. "\n};\n1";
519		916
520	eval $source	917	eval $source
…		…
531	local $TERM = shift;	928	local $TERM = shift;
532	my $htype = shift;	929	my $htype = shift;
533		930
534	if ($htype == 0) { # INIT	931	if ($htype == 0) { # INIT
535	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	932	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
536		933
537	my %ext_arg;	934	my %ext_arg;
538		935
		936	{
		937	my @init = @TERM_INIT;
		938	@TERM_INIT = ();
		939	$_->($TERM) for @init;
		940	my @pkg = @TERM_EXT;
		941	@TERM_EXT = ();
		942	$TERM->register_package ($_) for @pkg;
		943	}
		944
539	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	945	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
540	if ($_ eq "default") {	946	if ($_ eq "default") {
541	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	947	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
542	} elsif (/^-(.*)$/) {	948	} elsif (/^-(.*)$/) {
543	delete $ext_arg{$1};	949	delete $ext_arg{$1};
544	} elsif (/^([^<]+)<(.*)>$/) {	950	} elsif (/^([^<]+)<(.*)>$/) {
545	push @{ $ext_arg{$1} }, $2;	951	push @{ $ext_arg{$1} }, $2;
546	} else {	952	} else {
547	$ext_arg{$_} ||= [];	953	$ext_arg{$_} ||= [];
548	}	954	}
549	}	955	}
550		956
551	while (my ($ext, $argv) = each %ext_arg) {	957	for my $ext (sort keys %ext_arg) {
552	my @files = grep -f $_, map "$_/$ext", @dirs;	958	my @files = grep -f $_, map "$_/$ext", @dirs;
553		959
554	if (@files) {	960	if (@files) {
555	$TERM->register_package (extension_package $files[0], $argv);	961	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
556	} else {	962	} else {
557	warn "perl extension '$ext' not found in perl library search path\n";	963	warn "perl extension '$ext' not found in perl library search path\n";
558	}	964	}
559	}	965	}
560		966
…		…
566		972
567	if (my $cb = $TERM->{_hook}[$htype]) {	973	if (my $cb = $TERM->{_hook}[$htype]) {
568	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	974	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
569	if $verbosity >= 10;	975	if $verbosity >= 10;
570		976
571	keys %$cb;	977	for my $pkg (keys %$cb) {
572
573	while (my ($pkg, $cb) = each %$cb) {
574	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	978	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
575	and last;	979	$retval ||= $retval_;
576		980
577	if ($@) {	981	if ($@) {
578	$TERM->ungrab; # better to lose the grab than the session	982	$TERM->ungrab; # better to lose the grab than the session
579	warn $@;	983	warn $@;
580	}	984	}
581	}	985	}
		986
		987	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		988	if $verbosity >= 11;
582	}	989	}
583		990
584	if ($htype == 1) { # DESTROY	991	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	992	# clear package objects
593	%$_ = () for values %{ $TERM->{_pkg} };	993	%$_ = () for values %{ $TERM->{_pkg} };
594		994
595	# clear package	995	# clear package
596	%$TERM = ();	996	%$TERM = ();
597	}	997	}
598		998
599	$retval	999	$retval
		1000	}
		1001
		1002	sub SET_COLOR($$$) {
		1003	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1004	}
		1005
		1006	sub rend2mask {
		1007	no strict 'refs';
		1008	my ($str, $mask) = (@_, 0);
		1009	my %color = ( fg => undef, bg => undef );
		1010	my @failed;
		1011	for my $spec ( split /\s+/, $str ) {
		1012	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1013	$color{lc($1)} = $2;
		1014	} else {
		1015	my $neg = $spec =~ s/^[-^]//;
		1016	unless ( exists &{"RS_$spec"} ) {
		1017	push @failed, $spec;
		1018	next;
		1019	}
		1020	my $cur = &{"RS_$spec"};
		1021	if ( $neg ) {
		1022	$mask &= ~$cur;
		1023	} else {
		1024	$mask |= $cur;
		1025	}
		1026	}
		1027	}
		1028	($mask, @color{qw(fg bg)}, \@failed)
600	}	1029	}
601		1030
602	# urxvt::term::extension	1031	# urxvt::term::extension
603		1032
604	package urxvt::term::extension;	1033	package urxvt::term::extension;
…		…
610	while (my ($name, $cb) = each %hook) {	1039	while (my ($name, $cb) = each %hook) {
611	my $htype = $HOOKTYPE{uc $name};	1040	my $htype = $HOOKTYPE{uc $name};
612	defined $htype	1041	defined $htype
613	or Carp::croak "unsupported hook type '$name'";	1042	or Carp::croak "unsupported hook type '$name'";
614		1043
		1044	$self->set_should_invoke ($htype, +1)
615	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	1045	unless exists $self->{term}{_hook}[$htype]{$pkg};
616	$hook_count[$htype]++
617	or urxvt::set_should_invoke $htype, 1;
618	}
619		1046
620	$self->{term}{_hook}[$htype]{$pkg} = $cb;	1047	$self->{term}{_hook}[$htype]{$pkg} = $cb;
621	}	1048	}
622	}	1049	}
623		1050
…		…
628	for my $name (@hook) {	1055	for my $name (@hook) {
629	my $htype = $HOOKTYPE{uc $name};	1056	my $htype = $HOOKTYPE{uc $name};
630	defined $htype	1057	defined $htype
631	or Carp::croak "unsupported hook type '$name'";	1058	or Carp::croak "unsupported hook type '$name'";
632		1059
		1060	$self->set_should_invoke ($htype, -1)
633	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1061	if delete $self->{term}{_hook}[$htype]{$pkg};
634	--$hook_count[$htype]
635	or urxvt::set_should_invoke $htype, 0;
636	}
637	}	1062	}
638	}	1063	}
639		1064
640	our $AUTOLOAD;	1065	our $AUTOLOAD;
641		1066
…		…
672		1097
673	=head2 The C<urxvt::anyevent> Class	1098	=head2 The C<urxvt::anyevent> Class
674		1099
675	The sole purpose of this class is to deliver an interface to the	1100	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	1101	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	1102	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	1103	condition variables, but non-blocking condvar use is ok. What this means
679	cannot use blocking APIs, but the non-blocking variant should work.	1104	is that you cannot use blocking APIs, but the non-blocking variant should
		1105	work.
680		1106
681	=cut	1107	=cut
682		1108
683	our $VERSION = 1;	1109	our $VERSION = '3.4';
684		1110
685	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1111	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
686	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1112	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
687		1113
688	sub timer {	1114	sub timer {
…		…
719		1145
720	sub DESTROY {	1146	sub DESTROY {
721	$_[0][1]->stop;	1147	$_[0][1]->stop;
722	}	1148	}
723		1149
724	sub condvar {	1150	sub one_event {
725	bless \my $flag, urxvt::anyevent::condvar::
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";	1151	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
735	}
736	}	1152	}
737		1153
738	package urxvt::term;	1154	package urxvt::term;
739		1155
740	=head2 The C<urxvt::term> Class	1156	=head2 The C<urxvt::term> Class
…		…
745		1161
746	# find on_xxx subs in the package and register them	1162	# find on_xxx subs in the package and register them
747	# as hooks	1163	# as hooks
748	sub register_package {	1164	sub register_package {
749	my ($self, $pkg, $argv) = @_;	1165	my ($self, $pkg, $argv) = @_;
		1166
		1167	no strict 'refs';
		1168
		1169	urxvt::verbose 6, "register package $pkg to $self";
		1170
		1171	@{"$pkg\::ISA"} = urxvt::term::extension::;
750		1172
751	my $proxy = bless {	1173	my $proxy = bless {
752	_pkg => $pkg,	1174	_pkg => $pkg,
753	argv => $argv,	1175	argv => $argv,
754	}, $pkg;	1176	}, $pkg;
…		…
761	$proxy->enable ($name => $ref);	1183	$proxy->enable ($name => $ref);
762	}	1184	}
763	}	1185	}
764	}	1186	}
765		1187
		1188	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1189
		1190	Creates a new terminal, very similar as if you had started it with system
		1191	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1192	hash which defines the environment of the new terminal.
		1193
		1194	Croaks (and probably outputs an error message) if the new instance
		1195	couldn't be created. Returns C<undef> if the new instance didn't
		1196	initialise perl, and the terminal object otherwise. The C<init> and
		1197	C<start> hooks will be called before this call returns, and are free to
		1198	refer to global data (which is race free).
		1199
		1200	=cut
		1201
		1202	sub new {
		1203	my ($class, $env, @args) = @_;
		1204
		1205	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1206	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1207
		1208	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1209	}
		1210
766	=item $term->destroy	1211	=item $term->destroy
767		1212
768	Destroy the terminal object (close the window, free resources etc.).	1213	Destroy the terminal object (close the window, free resources
		1214	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1215	watchers (timers, io watchers) are still active.
		1216
		1217	=item $term->exec_async ($cmd[, @args])
		1218
		1219	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1220	("starts") programs in the background. This function takes care of setting
		1221	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1222	be preferred over explicit calls to C<exec> or C<system>.
		1223
		1224	Returns the pid of the subprocess or C<undef> on error.
		1225
		1226	=cut
		1227
		1228	sub exec_async {
		1229	my $self = shift;
		1230
		1231	my $pid = fork;
		1232
		1233	return $pid
		1234	if !defined $pid or $pid;
		1235
		1236	%ENV = %{ $self->env };
		1237
		1238	exec @_;
		1239	urxvt::_exit 255;
		1240	}
769		1241
770	=item $isset = $term->option ($optval[, $set])	1242	=item $isset = $term->option ($optval[, $set])
771		1243
772	Returns true if the option specified by C<$optval> is enabled, and	1244	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	1245	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.	1246	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
775		1247
776	Here is a a likely non-exhaustive list of option names, please see the	1248	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:	1249	source file F</src/optinc.h> to see the actual list:
778		1250
779	borderLess console cursorBlink cursorUnderline hold iconic insecure	1251	borderLess console cursorBlink cursorUnderline hold iconic insecure
780	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1252	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
781	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1253	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
782	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1254	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
783	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1255	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
784	tripleclickwords utmpInhibit visualBell	1256	transparent tripleclickwords utmpInhibit visualBell
785		1257
786	=item $value = $term->resource ($name[, $newval])	1258	=item $value = $term->resource ($name[, $newval])
787		1259
788	Returns the current resource value associated with a given name and	1260	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>	1261	optionally sets a new value. Setting values is most useful in the C<init>
…		…
798	likely change).	1270	likely change).
799		1271
800	Please note that resource strings will currently only be freed when the	1272	Please note that resource strings will currently only be freed when the
801	terminal is destroyed, so changing options frequently will eat memory.	1273	terminal is destroyed, so changing options frequently will eat memory.
802		1274
803	Here is a a likely non-exhaustive list of resource names, not all of which	1275	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>	1276	are supported in every build, please see the source file F</src/rsinc.h>
805	to see the actual list:	1277	to see the actual list:
806		1278
807	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1279	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
808	borderLess color cursorBlink cursorUnderline cutchars delete_key	1280	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
809	display_name embed ext_bwidth fade font geometry hold iconName	1281	display_name embed ext_bwidth fade font geometry hold iconName
810	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1282	imFont imLocale inputMethod insecure int_bwidth intensityStyles
811	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1283	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
812	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1284	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
813	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1285	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
814	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1286	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
815	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1287	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
816	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1288	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
817	shade term_name title transparent transparent_all tripleclickwords	1289	secondaryScreen secondaryScroll shade term_name title
818	utmpInhibit visualBell	1290	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1291	visualBell
819		1292
820	=cut	1293	=cut
821		1294
822	sub resource($$;$) {	1295	sub resource($$;$) {
823	my ($self, $name) = (shift, shift);	1296	my ($self, $name) = (shift, shift);
824	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1297	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
825	&urxvt::term::_resource	1298	goto &urxvt::term::_resource
826	}	1299	}
		1300
		1301	=item $value = $term->x_resource ($pattern)
		1302
		1303	Returns the X-Resource for the given pattern, excluding the program or
		1304	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1305	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1306	resource with that pattern exists.
		1307
		1308	This method should only be called during the C<on_start> hook, as there is
		1309	only one resource database per display, and later invocations might return
		1310	the wrong resources.
827		1311
828	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1312	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
829		1313
830	Adds a keymap translation exactly as specified via a resource. See the	1314	Adds a keymap translation exactly as specified via a resource. See the
831	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1315	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
…		…
847	=item ($row, $col) = $term->selection_end ([$row, $col])	1331	=item ($row, $col) = $term->selection_end ([$row, $col])
848		1332
849	Return the current values of the selection mark, begin or end positions,	1333	Return the current values of the selection mark, begin or end positions,
850	and optionally set them to new values.	1334	and optionally set them to new values.
851		1335
		1336	=item $term->selection_make ($eventtime[, $rectangular])
		1337
		1338	Tries to make a selection as set by C<selection_beg> and
		1339	C<selection_end>. If C<$rectangular> is true (default: false), a
		1340	rectangular selection will be made. This is the prefered function to make
		1341	a selection.
		1342
852	=item $success = $term->selection_grab ($eventtime)	1343	=item $success = $term->selection_grab ($eventtime)
853		1344
854	Try to request the primary selection from the server (for example, as set	1345	Try to request the primary selection text from the server (for example, as
855	by the next method).	1346	set by the next method). No visual feedback will be given. This function
		1347	is mostly useful from within C<on_sel_grab> hooks.
856		1348
857	=item $oldtext = $term->selection ([$newtext])	1349	=item $oldtext = $term->selection ([$newtext])
858		1350
859	Return the current selection text and optionally replace it by C<$newtext>.	1351	Return the current selection text and optionally replace it by C<$newtext>.
860		1352
…		…
894		1386
895	The methods currently supported on C<urxvt::overlay> objects are:	1387	The methods currently supported on C<urxvt::overlay> objects are:
896		1388
897	=over 4	1389	=over 4
898		1390
899	=item $overlay->set ($x, $y, $text, $rend)	1391	=item $overlay->set ($x, $y, $text[, $rend])
900		1392
901	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1393	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	1394	text in rxvt-unicode's special encoding and an array of rendition values
903	at a specific position inside the overlay.	1395	at a specific position inside the overlay.
		1396
		1397	If C<$rend> is missing, then the rendition will not be changed.
904		1398
905	=item $overlay->hide	1399	=item $overlay->hide
906		1400
907	If visible, hide the overlay, but do not destroy it.	1401	If visible, hide the overlay, but do not destroy it.
908		1402
…		…
953	Convert the given locale-encoded octets into a perl string.	1447	Convert the given locale-encoded octets into a perl string.
954		1448
955	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1449	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
956		1450
957	XORs the rendition values in the given span with the provided value	1451	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	1452	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
959	to the selection.	1453	refresh hooks to provide effects similar to the selection.
960		1454
961	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1455	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
962		1456
963	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1457	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
964	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1458	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	1459	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
966	it instead.	1460	it instead. Both styles I<MUST NOT> contain font styles.
967		1461
968	=item $term->scr_bell	1462	=item $term->scr_bell
969		1463
970	Ring the bell!	1464	Ring the bell!
971		1465
…		…
978		1472
979	Normally its not a good idea to use this function, as programs might be	1473	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	1474	confused by changes in cursor position or scrolling. Its useful inside a
981	C<on_add_lines> hook, though.	1475	C<on_add_lines> hook, though.
982		1476
		1477	=item $term->scr_change_screen ($screen)
		1478
		1479	Switch to given screen - 0 primary, 1 secondary.
		1480
983	=item $term->cmd_parse ($octets)	1481	=item $term->cmd_parse ($octets)
984		1482
985	Similar to C<scr_add_lines>, but the argument must be in the	1483	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	1484	locale-specific encoding of the terminal and can contain command sequences
987	(escape codes) that will be interpreted.	1485	(escape codes) that will be interpreted.
…		…
997	Replaces the event mask of the pty watcher by the given event mask. Can	1495	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	1496	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	1497	description of C<< urxvt::timer->events >>. Make sure to always restore
1000	the previous value.	1498	the previous value.
1001		1499
		1500	=item $fd = $term->pty_fd
		1501
		1502	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1503	is used.
		1504
1002	=item $windowid = $term->parent	1505	=item $windowid = $term->parent
1003		1506
1004	Return the window id of the toplevel window.	1507	Return the window id of the toplevel window.
1005		1508
1006	=item $windowid = $term->vt	1509	=item $windowid = $term->vt
1007		1510
1008	Return the window id of the terminal window.	1511	Return the window id of the terminal window.
1009		1512
		1513	=item $term->vt_emask_add ($x_event_mask)
		1514
		1515	Adds the specified events to the vt event mask. Useful e.g. when you want
		1516	to receive pointer events all the times:
		1517
		1518	$term->vt_emask_add (urxvt::PointerMotionMask);
		1519
		1520	=item $term->focus_in
		1521
		1522	=item $term->focus_out
		1523
		1524	=item $term->key_press ($state, $keycode[, $time])
		1525
		1526	=item $term->key_release ($state, $keycode[, $time])
		1527
		1528	Deliver various fake events to to terminal.
		1529
1010	=item $window_width = $term->width	1530	=item $window_width = $term->width
1011		1531
1012	=item $window_height = $term->height	1532	=item $window_height = $term->height
1013		1533
1014	=item $font_width = $term->fwidth	1534	=item $font_width = $term->fwidth
…		…
1027		1547
1028	=item $max_scrollback = $term->saveLines	1548	=item $max_scrollback = $term->saveLines
1029		1549
1030	=item $nrow_plus_saveLines = $term->total_rows	1550	=item $nrow_plus_saveLines = $term->total_rows
1031		1551
1032	=item $lines_in_scrollback = $term->nsaved	1552	=item $topmost_scrollback_row = $term->top_row
1033		1553
1034	Return various integers describing terminal characteristics.	1554	Return various integers describing terminal characteristics.
1035		1555
		1556	=item $x_display = $term->display_id
		1557
		1558	Return the DISPLAY used by rxvt-unicode.
		1559
1036	=item $lc_ctype = $term->locale	1560	=item $lc_ctype = $term->locale
1037		1561
1038	Returns the LC_CTYPE category string used by this rxvt-unicode.	1562	Returns the LC_CTYPE category string used by this rxvt-unicode.
1039		1563
1040	=item $x_display = $term->display_id	1564	=item $env = $term->env
1041		1565
1042	Return the DISPLAY used by rxvt-unicode.	1566	Returns a copy of the environment in effect for the terminal as a hashref
		1567	similar to C<\%ENV>.
		1568
		1569	=item @envv = $term->envv
		1570
		1571	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1572
		1573	=item @argv = $term->argv
		1574
		1575	Return the argument vector as this terminal, similar to @ARGV, but
		1576	includes the program name as first element.
		1577
		1578	=cut
		1579
		1580	sub env {
		1581	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
		1582	}
1043		1583
1044	=item $modifiermask = $term->ModLevel3Mask	1584	=item $modifiermask = $term->ModLevel3Mask
1045		1585
1046	=item $modifiermask = $term->ModMetaMask	1586	=item $modifiermask = $term->ModMetaMask
1047		1587
1048	=item $modifiermask = $term->ModNumLockMask	1588	=item $modifiermask = $term->ModNumLockMask
1049		1589
1050	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1590	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.	1591	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1052		1592
		1593	=item $screen = $term->current_screen
		1594
		1595	Returns the currently displayed screen (0 primary, 1 secondary).
		1596
		1597	=item $cursor_is_hidden = $term->hidden_cursor
		1598
		1599	Returns whether the cursor is currently hidden or not.
		1600
1053	=item $view_start = $term->view_start ([$newvalue])	1601	=item $view_start = $term->view_start ([$newvalue])
1054		1602
1055	Returns the negative row number of the topmost line. Minimum value is	1603	Returns the row number of the topmost displayed line. Maximum value is
1056	C<0>, which displays the normal terminal contents. Larger values scroll	1604	C<0>, which displays the normal terminal contents. Lower values scroll
1057	this many lines into the scrollback buffer.	1605	this many lines into the scrollback buffer.
1058		1606
1059	=item $term->want_refresh	1607	=item $term->want_refresh
1060		1608
1061	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1609	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1064		1612
1065	Used after changing terminal contents to display them.	1613	Used after changing terminal contents to display them.
1066		1614
1067	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1615	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1068		1616
1069	Returns the text of the entire row with number C<$row_number>. Row C<0>	1617	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	1618	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	1619	terminal line. Nothing will be returned if a nonexistent line
1073	is requested.	1620	is requested.
1074		1621
1075	If C<$new_text> is specified, it will replace characters in the current	1622	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	1623	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	1624	to replace only parts of a line. The font index in the rendition will
1078	automatically be updated.	1625	automatically be updated.
1079		1626
1080	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
1081	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)
1082	(C<chr 65535>). Characters with combining characters and other characters	1629	characters. Characters with combining characters and other characters that
1083	that do not fit into the normal tetx encoding will be replaced with	1630	do not fit into the normal text encoding will be replaced with characters
1084	characters in the private use area.	1631	in the private use area.
1085		1632
1086	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
1087	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
1088	characters.	1635	characters.
1089		1636
…		…
1140	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.
1141		1688
1142	=item $offset = $line->offset_of ($row, $col)	1689	=item $offset = $line->offset_of ($row, $col)
1143		1690
1144	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
1145	line.	1692	line. Works for rows outside the line, too, and returns corresponding
		1693	offsets outside the string.
1146		1694
1147	=item ($row, $col) = $line->coord_of ($offset)	1695	=item ($row, $col) = $line->coord_of ($offset)
1148		1696
1149	Translates a string offset into terminal coordinates again.	1697	Translates a string offset into terminal coordinates again.
1150		1698
…		…
1232	where one character corresponds to one screen cell. See	1780	where one character corresponds to one screen cell. See
1233	C<< $term->ROW_t >> for details.	1781	C<< $term->ROW_t >> for details.
1234		1782
1235	=item $string = $term->special_decode $text	1783	=item $string = $term->special_decode $text
1236		1784
1237	Converts rxvt-unicodes text reprsentation into a perl string. See	1785	Converts rxvt-unicodes text representation into a perl string. See
1238	C<< $term->ROW_t >> for details.	1786	C<< $term->ROW_t >> for details.
1239		1787
1240	=item $success = $term->grab_button ($button, $modifiermask)	1788	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1241		1789
		1790	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1791
1242	Registers a synchronous button grab. See the XGrabButton manpage.	1792	Register/unregister a synchronous button grab. See the XGrabButton
		1793	manpage.
1243		1794
1244	=item $success = $term->grab ($eventtime[, $sync])	1795	=item $success = $term->grab ($eventtime[, $sync])
1245		1796
1246	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1797	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1247	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1798	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1248		1799
1249	=item $term->allow_events_async	1800	=item $term->allow_events_async
1250		1801
1251	Calls XAllowEvents with AsyncBoth for the most recent grab.	1802	Calls XAllowEvents with AsyncBoth for the most recent grab.
1252		1803
…		…
1263		1814
1264	Calls XUngrab for the most recent grab. Is called automatically on	1815	Calls XUngrab 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	1816	evaluation errors, as it is better to lose the grab in the error case as
1266	the session.	1817	the session.
1267		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->XChangeProperty ($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
1268	=back	1849	=back
1269		1850
1270	=cut	1851	=cut
1271		1852
1272	package urxvt::popup;	1853	package urxvt::popup;
…		…
1286		1867
1287	$item->{render} ||= sub { $_[0]{text} };	1868	$item->{render} ||= sub { $_[0]{text} };
1288		1869
1289	push @{ $self->{item} }, $item;	1870	push @{ $self->{item} }, $item;
1290	}	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
1291		1894
1292	sub add_separator {	1895	sub add_separator {
1293	my ($self, $sep) = @_;	1896	my ($self, $sep) = @_;
1294		1897
1295	$sep ||= "=";	1898	$sep ||= "=";
…		…
1300	render => sub { $sep x $self->{term}->ncol },	1903	render => sub { $sep x $self->{term}->ncol },
1301	activate => sub { },	1904	activate => sub { },
1302	});	1905	});
1303	}	1906	}
1304		1907
1305	sub add_title {	1908	=item $popup->add_button ($text, $cb)
1306	my ($self, $title) = @_;
1307		1909
1308	$self->add_item ({	1910	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" },	1911	selected.
1310	text => $title,	1912
1311	activate => sub { },	1913	=cut
1312	});
1313	}
1314		1914
1315	sub add_button {	1915	sub add_button {
1316	my ($self, $text, $cb) = @_;	1916	my ($self, $text, $cb) = @_;
1317		1917
1318	$self->add_item ({ type => "button", text => $text, activate => $cb});	1918	$self->add_item ({ type => "button", text => $text, activate => $cb});
1319	}	1919	}
1320		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
1321	sub add_toggle {	1929	sub add_toggle {
1322	my ($self, $text, $cb, $value) = @_;	1930	my ($self, $text, $value, $cb) = @_;
1323		1931
1324	my $item; $item = {	1932	my $item; $item = {
1325	type => "button",	1933	type => "button",
1326	text => " $text",	1934	text => " $text",
1327	value => $value,	1935	value => $value,
1328	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1936	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1329	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1937	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1330	};	1938	};
1331		1939
1332	$self->add_item ($item);	1940	$self->add_item ($item);
1333	}	1941	}
		1942
		1943	=item $popup->show
		1944
		1945	Displays the popup (which is initially hidden).
		1946
		1947	=cut
1334		1948
1335	sub show {	1949	sub show {
1336	my ($self) = @_;	1950	my ($self) = @_;
1337		1951
1338	local $urxvt::popup::self = $self;	1952	local $urxvt::popup::self = $self;
1339		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};
1340	local $ENV{LC_ALL} = $self->{term}->locale;	1957	$env->{LC_CTYPE} = $self->{term}->locale;
1341		1958
1342	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1959	my $term = urxvt::term->new (
		1960	$env, "popup",
		1961	"--perl-lib" => "", "--perl-ext-common" => "",
		1962	"-pty-fd" => -1, "-sl" => 0,
		1963	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1343	"--transient-for" => $self->{term}->parent,	1964	"--transient-for" => $self->{term}->parent,
1344	"-display" => $self->{term}->display_id,	1965	"-display" => $self->{term}->display_id,
1345	"-pe" => "urxvt-popup")	1966	"-pe" => "urxvt-popup",
1346	or die "unable to create popup window\n";	1967	) or die "unable to create popup window\n";
		1968
		1969	unless (delete $term->{urxvt_popup_init_done}) {
		1970	$term->ungrab;
		1971	$term->destroy;
		1972	die "unable to initialise popup window\n";
		1973	}
1347	}	1974	}
1348		1975
1349	sub DESTROY {	1976	sub DESTROY {
1350	my ($self) = @_;	1977	my ($self) = @_;
1351		1978
1352	delete $self->{term}{_destroy}{$self};	1979	delete $self->{term}{_destroy}{$self};
1353	$self->{term}->ungrab;	1980	$self->{term}->ungrab;
1354	}	1981	}
		1982
		1983	=back
		1984
		1985	=cut
		1986
		1987	package urxvt::watcher;
1355		1988
1356	=head2 The C<urxvt::timer> Class	1989	=head2 The C<urxvt::timer> Class
1357		1990
1358	This class implements timer watchers/events. Time is represented as a	1991	This class implements timer watchers/events. Time is represented as a
1359	fractional number of seconds since the epoch. Example:	1992	fractional number of seconds since the epoch. Example:
…		…
1363	->new	1996	->new
1364	->interval (1)	1997	->interval (1)
1365	->cb (sub {	1998	->cb (sub {
1366	$term->{overlay}->set (0, 0,	1999	$term->{overlay}->set (0, 0,
1367	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2000	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1368	});	2001	});
1369		2002
1370	=over 4	2003	=over 4
1371		2004
1372	=item $timer = new urxvt::timer	2005	=item $timer = new urxvt::timer
1373		2006
…		…
1397	Start the timer.	2030	Start the timer.
1398		2031
1399	=item $timer = $timer->start ($tstamp)	2032	=item $timer = $timer->start ($tstamp)
1400		2033
1401	Set the event trigger time to C<$tstamp> and start the timer.	2034	Set the event trigger time to C<$tstamp> and start the timer.
		2035
		2036	=item $timer = $timer->after ($delay)
		2037
		2038	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1402		2039
1403	=item $timer = $timer->stop	2040	=item $timer = $timer->stop
1404		2041
1405	Stop the timer.	2042	Stop the timer.
1406		2043
…		…
1412		2049
1413	$term->{socket} = ...	2050	$term->{socket} = ...
1414	$term->{iow} = urxvt::iow	2051	$term->{iow} = urxvt::iow
1415	->new	2052	->new
1416	->fd (fileno $term->{socket})	2053	->fd (fileno $term->{socket})
1417	->events (urxvt::EVENT_READ)	2054	->events (urxvt::EV_READ)
1418	->start	2055	->start
1419	->cb (sub {	2056	->cb (sub {
1420	my ($iow, $revents) = @_;	2057	my ($iow, $revents) = @_;
1421	# $revents must be 1 here, no need to check	2058	# $revents must be 1 here, no need to check
1422	sysread $term->{socket}, my $buf, 8192	2059	sysread $term->{socket}, my $buf, 8192
…		…
1435	Set the callback to be called when io events are triggered. C<$reventmask>	2072	Set the callback to be called when io events are triggered. C<$reventmask>
1436	is a bitset as described in the C<events> method.	2073	is a bitset as described in the C<events> method.
1437		2074
1438	=item $iow = $iow->fd ($fd)	2075	=item $iow = $iow->fd ($fd)
1439		2076
1440	Set the filedescriptor (not handle) to watch.	2077	Set the file descriptor (not handle) to watch.
1441		2078
1442	=item $iow = $iow->events ($eventmask)	2079	=item $iow = $iow->events ($eventmask)
1443		2080
1444	Set the event mask to watch. The only allowed values are	2081	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	2082	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1446	together, or C<urxvt::EVENT_NONE>.	2083	together, or C<urxvt::EV_NONE>.
1447		2084
1448	=item $iow = $iow->start	2085	=item $iow = $iow->start
1449		2086
1450	Start watching for requested events on the given handle.	2087	Start watching for requested events on the given handle.
1451		2088
1452	=item $iow = $iow->stop	2089	=item $iow = $iow->stop
1453		2090
1454	Stop watching for events on the given filehandle.	2091	Stop watching for events on the given file handle.
		2092
		2093	=back
		2094
		2095	=head2 The C<urxvt::iw> Class
		2096
		2097	This class implements idle watchers, that get called automatically when
		2098	the process is idle. They should return as fast as possible, after doing
		2099	some useful work.
		2100
		2101	=over 4
		2102
		2103	=item $iw = new urxvt::iw
		2104
		2105	Create a new idle watcher object in stopped state.
		2106
		2107	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2108
		2109	Set the callback to be called when the watcher triggers.
		2110
		2111	=item $timer = $timer->start
		2112
		2113	Start the watcher.
		2114
		2115	=item $timer = $timer->stop
		2116
		2117	Stop the watcher.
		2118
		2119	=back
		2120
		2121	=head2 The C<urxvt::pw> Class
		2122
		2123	This class implements process watchers. They create an event whenever a
		2124	process exits, after which they stop automatically.
		2125
		2126	my $pid = fork;
		2127	...
		2128	$term->{pw} = urxvt::pw
		2129	->new
		2130	->start ($pid)
		2131	->cb (sub {
		2132	my ($pw, $exit_status) = @_;
		2133	...
		2134	});
		2135
		2136	=over 4
		2137
		2138	=item $pw = new urxvt::pw
		2139
		2140	Create a new process watcher in stopped state.
		2141
		2142	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2143
		2144	Set the callback to be called when the timer triggers.
		2145
		2146	=item $pw = $timer->start ($pid)
		2147
		2148	Tells the watcher to start watching for process C<$pid>.
		2149
		2150	=item $pw = $pw->stop
		2151
		2152	Stop the watcher.
1455		2153
1456	=back	2154	=back
1457		2155
1458	=head1 ENVIRONMENT	2156	=head1 ENVIRONMENT
1459		2157
…		…
1466		2164
1467	=item == 0 - fatal messages	2165	=item == 0 - fatal messages
1468		2166
1469	=item >= 3 - script loading and management	2167	=item >= 3 - script loading and management
1470		2168
1471	=item >=10 - all events received	2169	=item >=10 - all called hooks
		2170
		2171	=item >=11 - hook return values
1472		2172
1473	=back	2173	=back
1474		2174
1475	=head1 AUTHOR	2175	=head1 AUTHOR
1476		2176
…		…
1478	http://software.schmorp.de/pkg/rxvt-unicode	2178	http://software.schmorp.de/pkg/rxvt-unicode
1479		2179
1480	=cut	2180	=cut
1481		2181
1482	1	2182	1
		2183
		2184	# vim: sw=3:

Diff Legend

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