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

Diff Legend

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