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.153 by root, Sat Jun 2 05:23:11 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
		310
		311	L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
		312	shows how this extension can be used to implement an automatically blurred
		313	transparent background.
90		314
91	=item block-graphics-to-ascii	315	=item block-graphics-to-ascii
92		316
93	A not very useful example of filtering all text output to the terminal,	317	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	318	by replacing all line-drawing characters (U+2500 .. U+259F) by a
95	similar-looking ascii character.	319	similar-looking ascii character.
		320
		321	=item digital-clock
		322
		323	Displays a digital clock using the built-in overlay.
		324
		325	=item remote-clipboard
		326
		327	Somewhat of a misnomer, this extension adds two menu entries to the
		328	selection popup that allows one ti run external commands to store the
		329	selection somewhere and fetch it again.
		330
		331	We use it to implement a "distributed selection mechanism", which just
		332	means that one command uploads the file to a remote server, and another
		333	reads it.
		334
		335	The commands can be set using the C<URxvt.remote-selection.store> and
		336	C<URxvt.remote-selection.fetch> resources. The first should read the
		337	selection to store from STDIN (always in UTF-8), the second should provide
		338	the selection data on STDOUT (also in UTF-8).
		339
		340	The defaults (which are likely useless to you) use rsh and cat:
		341
		342	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		343	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		344
		345	=item selection-pastebin
		346
		347	This is a little rarely useful extension that Uploads the selection as
		348	textfile to a remote site (or does other things). (The implementation is
		349	not currently secure for use in a multiuser environment as it writes to
		350	F</tmp> directly.).
		351
		352	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		353	i.e.
		354
		355	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		356
		357	Pressing this combination runs a command with C<%> replaced by the name of
		358	the textfile. This command can be set via a resource:
		359
		360	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		361
		362	And the default is likely not useful to anybody but the few people around
		363	here :)
		364
		365	The name of the textfile is the hex encoded md5 sum of the selection, so
		366	the same content should lead to the same filename.
		367
		368	After a successful upload the selection will be replaced by the text given
		369	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		370	for the filename):
		371
		372	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		373
		374	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		375	the double C</> characters as comment start. Use C<\057\057> instead,
		376	which works regardless of wether xrdb is used to parse the resource file
		377	or not.
96		378
97	=item example-refresh-hooks	379	=item example-refresh-hooks
98		380
99	Displays a very simple digital clock in the upper right corner of the	381	Displays a very simple digital clock in the upper right corner of the
100	window. Illustrates overwriting the refresh callbacks to create your own	382	window. Illustrates overwriting the refresh callbacks to create your own
…		…
123	=over 4	405	=over 4
124		406
125	=item $text	407	=item $text
126		408
127	Rxvt-unicodes special way of encoding text, where one "unicode" character	409	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.	410	always represents one screen cell. See L<ROW_t> for a discussion of this format.
129		411
130	=item $string	412	=item $string
131		413
132	A perl text string, with an emphasis on I<text>. It can store all unicode	414	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	415	characters and is to be distinguished with text encoded in a specific
…		…
140		422
141	=back	423	=back
142		424
143	=head2 Extension Objects	425	=head2 Extension Objects
144		426
145	Very perl extension is a perl class. A separate perl object is created	427	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	428	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	429	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	430	their C<$self> object without having to think about clashes with other
		431	extensions or other terminals, with the exception of methods and members
149	begin with an underscore character C<_>: these are reserved for internal	432	that begin with an underscore character C<_>: these are reserved for
150	use.	433	internal use.
151		434
152	Although it isn't a C<urxvt::term> object, you can call all methods of the	435	Although it isn't a C<urxvt::term> object, you can call all methods of the
153	C<urxvt::term> class on this object.	436	C<urxvt::term> class on this object.
154		437
155	It has the following methods and data members:	438	It has the following methods and data members:
…		…
176	=head2 Hooks	459	=head2 Hooks
177		460
178	The following subroutines can be declared in extension files, and will be	461	The following subroutines can be declared in extension files, and will be
179	called whenever the relevant event happens.	462	called whenever the relevant event happens.
180		463
181	The first argument passed to them is an extension oject as described in	464	The first argument passed to them is an extension object as described in
182	the in the C<Extension Objects> section.	465	the in the C<Extension Objects> section.
183		466
184	B<All> of these hooks must return a boolean value. If it is true, then the	467	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	468	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.	469	relevant action might not be carried out by the C++ code.
187		470
188	I<< When in doubt, return a false value (preferably C<()>). >>	471	I<< When in doubt, return a false value (preferably C<()>). >>
189		472
190	=over 4	473	=over 4
191		474
192	=item on_init $term	475	=item on_init $term
193		476
194	Called after a new terminal object has been initialized, but before	477	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	478	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	479	call or deliver senseless data, as terminal size and other characteristics
197	have not yet been determined. You can safely query and change resources,	480	have not yet been determined. You can safely query and change resources
198	though.	481	and options, though. For many purposes the C<on_start> hook is a better
		482	place.
		483
		484	=item on_start $term
		485
		486	Called at the very end of initialisation of a new terminal, just before
		487	trying to map (display) the toplevel and returning to the main loop.
		488
		489	=item on_destroy $term
		490
		491	Called whenever something tries to destroy terminal, when the terminal is
		492	still fully functional (not for long, though).
199		493
200	=item on_reset $term	494	=item on_reset $term
201		495
202	Called after the screen is "reset" for any reason, such as resizing or	496	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	497	control sequences. Here is where you can react on changes to size-related
204	variables.	498	variables.
205		499
206	=item on_start $term	500	=item on_child_start $term, $pid
207		501
208	Called at the very end of initialisation of a new terminal, just before	502	Called just after the child process has been C<fork>ed.
209	returning to the mainloop.	503
		504	=item on_child_exit $term, $status
		505
		506	Called just after the child process has exited. C<$status> is the status
		507	from C<waitpid>.
210		508
211	=item on_sel_make $term, $eventtime	509	=item on_sel_make $term, $eventtime
212		510
213	Called whenever a selection has been made by the user, but before the	511	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	512	selection text is copied, so changes to the beginning, end or type of the
…		…
221		519
222	Called whenever a selection has been copied, but before the selection is	520	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	521	requested from the server. The selection text can be queried and changed
224	by calling C<< $term->selection >>.	522	by calling C<< $term->selection >>.
225		523
226	Returning a true value aborts selection grabbing. It will still be hilighted.	524	Returning a true value aborts selection grabbing. It will still be highlighted.
227		525
228	=item on_sel_extend $term	526	=item on_sel_extend $term
229		527
230	Called whenever the user tries to extend the selection (e.g. with a double	528	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	529	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	530	should extend the selection itself and return true to suppress the built-in
233	processing.	531	processing. This can happen multiple times, as long as the callback
		532	returns true, it will be called on every further click by the user and is
		533	supposed to enlarge the selection more and more, if possible.
234		534
235	See the F<selection> example extension.	535	See the F<selection> example extension.
236		536
237	=item on_view_change $term, $offset	537	=item on_view_change $term, $offset
238		538
239	Called whenever the view offset changes, i..e the user or program	539	Called whenever the view offset changes, i.e. the user or program
240	scrolls. Offset C<0> means display the normal terminal, positive values	540	scrolls. Offset C<0> means display the normal terminal, positive values
241	show this many lines of scrollback.	541	show this many lines of scrollback.
242		542
243	=item on_scroll_back $term, $lines, $saved	543	=item on_scroll_back $term, $lines, $saved
244		544
…		…
248		548
249	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	549	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	550	$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.	551	number of lines that will be in the scrollback buffer.
252		552
		553	=item on_osc_seq $term, $op, $args
		554
		555	Called on every OSC sequence and can be used to suppress it or modify its
		556	behaviour. The default should be to return an empty list. A true value
		557	suppresses execution of the request completely. Make sure you don't get
		558	confused by recursive invocations when you output an osc sequence within
		559	this callback.
		560
		561	C<on_osc_seq_perl> should be used for new behaviour.
		562
253	=item on_osc_seq $term, $string	563	=item on_osc_seq_perl $term, $string
254		564
255	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	565	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
256	operating system command) is processed. Cursor position and other state	566	operating system command) is processed. Cursor position and other state
257	information is up-to-date when this happens. For interoperability, the	567	information is up-to-date when this happens. For interoperability, the
258	string should start with the extension name and a colon, to distinguish	568	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	569	it from commands for other extensions, and this might be enforced in the
260	future.	570	future.
261		571
262	Be careful not ever to trust (in a security sense) the data you receive,	572	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	573	as its source can not easily be controlled (e-mail content, messages from
264	other users on the same system etc.).	574	other users on the same system etc.).
265		575
266	=item on_add_lines $term, $string	576	=item on_add_lines $term, $string
267		577
268	Called whenever text is about to be output, with the text as argument. You	578	Called whenever text is about to be output, with the text as argument. You
…		…
299		609
300	=item on_refresh_end $term	610	=item on_refresh_end $term
301		611
302	Called just after the screen gets redrawn. See C<on_refresh_begin>.	612	Called just after the screen gets redrawn. See C<on_refresh_begin>.
303		613
304	=item on_keyboard_command $term, $string	614	=item on_user_command $term, $string
305		615
306	Called whenever the user presses a key combination that has a	616	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>	617	a C<perl:string> action bound to a key, see description of the B<keysym>
308	resource in the @@RXVT_NAME@@(1) manpage).	618	resource in the @@RXVT_NAME@@(1) manpage).
		619
		620	The event is simply the action string. This interface is assumed to change
		621	slightly in the future.
		622
		623	=item on_resize_all_windows $tern, $new_width, $new_height
		624
		625	Called just after the new window size has been calculated, but before
		626	windows are actually being resized or hints are being set. If this hook
		627	returns TRUE, setting of the window hints is being skipped.
		628
		629	=item on_x_event $term, $event
		630
		631	Called on every X event received on the vt window (and possibly other
		632	windows). Should only be used as a last resort. Most event structure
		633	members are not passed.
		634
		635	=item on_root_event $term, $event
		636
		637	Like C<on_x_event>, but is called for events on the root window.
309		638
310	=item on_focus_in $term	639	=item on_focus_in $term
311		640
312	Called whenever the window gets the keyboard focus, before rxvt-unicode	641	Called whenever the window gets the keyboard focus, before rxvt-unicode
313	does focus in processing.	642	does focus in processing.
314		643
315	=item on_focus_out $term	644	=item on_focus_out $term
316		645
317	Called wheneever the window loses keyboard focus, before rxvt-unicode does	646	Called whenever the window loses keyboard focus, before rxvt-unicode does
318	focus out processing.	647	focus out processing.
		648
		649	=item on_configure_notify $term, $event
		650
		651	=item on_property_notify $term, $event
319		652
320	=item on_key_press $term, $event, $keysym, $octets	653	=item on_key_press $term, $event, $keysym, $octets
321		654
322	=item on_key_release $term, $event, $keysym	655	=item on_key_release $term, $event, $keysym
323		656
…		…
333		666
334	Called whenever the corresponding X event is received for the terminal If	667	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.	668	the hook returns true, then the even will be ignored by rxvt-unicode.
336		669
337	The event is a hash with most values as named by Xlib (see the XEvent	670	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	671	manpage), with the additional members C<row> and C<col>, which are the
339	and column under the mouse cursor.	672	(real, not screen-based) row and column under the mouse cursor.
340		673
341	C<on_key_press> additionally receives the string rxvt-unicode would	674	C<on_key_press> additionally receives the string rxvt-unicode would
342	output, if any, in locale-specific encoding.	675	output, if any, in locale-specific encoding.
343		676
344	subwindow.	677	subwindow.
345		678
346	=back	679	=item on_client_message $term, $event
347		680
348	=head2 Variables in the C<urxvt> Package	681	=item on_wm_protocols $term, $event
349		682
350	=over 4	683	=item on_wm_delete_window $term, $event
351		684
352	=item $urxvt::LIBDIR	685	Called when various types of ClientMessage events are received (all with
353		686	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		687
471	=back	688	=back
472		689
473	=cut	690	=cut
474		691
…		…
480	use Scalar::Util ();	697	use Scalar::Util ();
481	use List::Util ();	698	use List::Util ();
482		699
483	our $VERSION = 1;	700	our $VERSION = 1;
484	our $TERM;	701	our $TERM;
		702	our @TERM_INIT;
		703	our @TERM_EXT;
485	our @HOOKNAME;	704	our @HOOKNAME;
486	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	705	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
487	our %OPTION;	706	our %OPTION;
488		707
489	our $LIBDIR;	708	our $LIBDIR;
490	our $RESNAME;	709	our $RESNAME;
491	our $RESCLASS;	710	our $RESCLASS;
492	our $RXVTNAME;	711	our $RXVTNAME;
493		712
		713	our $NOCHAR = chr 0xffff;
		714
		715	=head2 Variables in the C<urxvt> Package
		716
		717	=over 4
		718
		719	=item $urxvt::LIBDIR
		720
		721	The rxvt-unicode library directory, where, among other things, the perl
		722	modules and scripts are stored.
		723
		724	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		725
		726	The resource class and name rxvt-unicode uses to look up X resources.
		727
		728	=item $urxvt::RXVTNAME
		729
		730	The basename of the installed binaries, usually C<urxvt>.
		731
		732	=item $urxvt::TERM
		733
		734	The current terminal. This variable stores the current C<urxvt::term>
		735	object, whenever a callback/hook is executing.
		736
		737	=item @urxvt::TERM_INIT
		738
		739	All code references in this array will be called as methods of the next newly
		740	created C<urxvt::term> object (during the C<on_init> phase). The array
		741	gets cleared before the code references that were in it are being executed,
		742	so references can push themselves onto it again if they so desire.
		743
		744	This complements to the perl-eval command line option, but gets executed
		745	first.
		746
		747	=item @urxvt::TERM_EXT
		748
		749	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		750	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		751	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		752
		753	=back
		754
		755	=head2 Functions in the C<urxvt> Package
		756
		757	=over 4
		758
		759	=item urxvt::fatal $errormessage
		760
		761	Fatally aborts execution with the given error message. Avoid at all
		762	costs! The only time this is acceptable is when the terminal process
		763	starts up.
		764
		765	=item urxvt::warn $string
		766
		767	Calls C<rxvt_warn> with the given string which should not include a
		768	newline. The module also overwrites the C<warn> builtin with a function
		769	that calls this function.
		770
		771	Using this function has the advantage that its output ends up in the
		772	correct place, e.g. on stderr of the connecting urxvtc client.
		773
		774	Messages have a size limit of 1023 bytes currently.
		775
		776	=item @terms = urxvt::termlist
		777
		778	Returns all urxvt::term objects that exist in this process, regardless of
		779	whether they are started, being destroyed etc., so be careful. Only term
		780	objects that have perl extensions attached will be returned (because there
		781	is no urxvt::term objet associated with others).
		782
		783	=item $time = urxvt::NOW
		784
		785	Returns the "current time" (as per the event loop).
		786
		787	=item urxvt::CurrentTime
		788
		789	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		790	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		791	Button4Mask, Button5Mask, AnyModifier
		792
		793	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		794	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		795	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		796	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		797	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		798	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		799	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		800
		801	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		802	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		803	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		804	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		805	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		806	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		807	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		808
		809	Various constants for use in X calls and event processing.
		810
		811	=back
		812
		813	=head2 RENDITION
		814
		815	Rendition bitsets contain information about colour, font, font styles and
		816	similar information for each screen cell.
		817
		818	The following "macros" deal with changes in rendition sets. You should
		819	never just create a bitset, you should always modify an existing one,
		820	as they contain important information required for correct operation of
		821	rxvt-unicode.
		822
		823	=over 4
		824
		825	=item $rend = urxvt::DEFAULT_RSTYLE
		826
		827	Returns the default rendition, as used when the terminal is starting up or
		828	being reset. Useful as a base to start when creating renditions.
		829
		830	=item $rend = urxvt::OVERLAY_RSTYLE
		831
		832	Return the rendition mask used for overlays by default.
		833
		834	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		835
		836	Return the bit that enabled bold, italic, blink, reverse-video and
		837	underline, respectively. To enable such a style, just logically OR it into
		838	the bitset.
		839
		840	=item $foreground = urxvt::GET_BASEFG $rend
		841
		842	=item $background = urxvt::GET_BASEBG $rend
		843
		844	Return the foreground/background colour index, respectively.
		845
		846	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		847
		848	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		849
		850	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		851
		852	Replace the foreground/background colour in the rendition mask with the
		853	specified one.
		854
		855	=item $value = urxvt::GET_CUSTOM $rend
		856
		857	Return the "custom" value: Every rendition has 5 bits for use by
		858	extensions. They can be set and changed as you like and are initially
		859	zero.
		860
		861	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		862
		863	Change the custom value.
		864
		865	=back
		866
		867	=cut
		868
494	BEGIN {	869	BEGIN {
495	urxvt->bootstrap;
496
497	# overwrite perl's warn	870	# overwrite perl's warn
498	*CORE::GLOBAL::warn = sub {	871	*CORE::GLOBAL::warn = sub {
499	my $msg = join "", @_;	872	my $msg = join "", @_;
500	$msg .= "\n"	873	$msg .= "\n"
501	unless $msg =~ /\n$/;	874	unless $msg =~ /\n$/;
502	urxvt::warn ($msg);	875	urxvt::warn ($msg);
503	};	876	};
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	}	877	}
510		878
511	my @hook_count;	879	no warnings 'utf8';
		880
512	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	881	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
513		882
514	sub verbose {	883	sub verbose {
515	my ($level, $msg) = @_;	884	my ($level, $msg) = @_;
516	warn "$msg\n" if $level <= $verbosity;	885	warn "$msg\n" if $level <= $verbosity;
517	}	886	}
518		887
519	my $extension_pkg = "extension0000";
520	my %extension_pkg;	888	my %extension_pkg;
521		889
522	# load a single script into its own package, once only	890	# load a single script into its own package, once only
523	sub extension_package($) {	891	sub extension_package($) {
524	my ($path) = @_;	892	my ($path) = @_;
525		893
526	$extension_pkg{$path} ||= do {	894	$extension_pkg{$path} ||= do {
527	my $pkg = "urxvt::" . ($extension_pkg++);	895	$path =~ /([^\/\\]+)$/;
		896	my $pkg = $1;
		897	$pkg =~ s/[^[:word:]]/_/g;
		898	$pkg = "urxvt::ext::$pkg";
528		899
529	verbose 3, "loading extension '$path' into package '$pkg'";	900	verbose 3, "loading extension '$path' into package '$pkg'";
530		901
531	open my $fh, "<:raw", $path	902	open my $fh, "<:raw", $path
532	or die "$path: $!";	903	or die "$path: $!";
533		904
534	my $source = untaint	905	my $source =
535	"package $pkg; use strict; use utf8;\n"	906	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
536	. "use base urxvt::term::extension::;\n"
537	. "#line 1 \"$path\"\n{\n"	907	. "#line 1 \"$path\"\n{\n"
538	. (do { local $/; <$fh> })	908	. (do { local $/; <$fh> })
539	. "\n};\n1";	909	. "\n};\n1";
540		910
541	eval $source	911	eval $source
…		…
555	if ($htype == 0) { # INIT	925	if ($htype == 0) { # INIT
556	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	926	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
557		927
558	my %ext_arg;	928	my %ext_arg;
559		929
		930	{
		931	my @init = @TERM_INIT;
		932	@TERM_INIT = ();
		933	$_->($TERM) for @init;
		934	my @pkg = @TERM_EXT;
		935	@TERM_EXT = ();
		936	$TERM->register_package ($_) for @pkg;
		937	}
		938
560	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	939	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
561	if ($_ eq "default") {	940	if ($_ eq "default") {
562	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);	941	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
563	} elsif (/^-(.*)$/) {	942	} elsif (/^-(.*)$/) {
564	delete $ext_arg{$1};	943	delete $ext_arg{$1};
565	} elsif (/^([^<]+)<(.*)>$/) {	944	} elsif (/^([^<]+)<(.*)>$/) {
566	push @{ $ext_arg{$1} }, $2;	945	push @{ $ext_arg{$1} }, $2;
567	} else {	946	} else {
568	$ext_arg{$_} ||= [];	947	$ext_arg{$_} ||= [];
569	}	948	}
570	}	949	}
571		950
572	while (my ($ext, $argv) = each %ext_arg) {	951	for my $ext (sort keys %ext_arg) {
573	my @files = grep -f $_, map "$_/$ext", @dirs;	952	my @files = grep -f $_, map "$_/$ext", @dirs;
574		953
575	if (@files) {	954	if (@files) {
576	$TERM->register_package (extension_package $files[0], $argv);	955	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
577	} else {	956	} else {
578	warn "perl extension '$ext' not found in perl library search path\n";	957	warn "perl extension '$ext' not found in perl library search path\n";
579	}	958	}
580	}	959	}
581		960
…		…
587		966
588	if (my $cb = $TERM->{_hook}[$htype]) {	967	if (my $cb = $TERM->{_hook}[$htype]) {
589	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	968	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
590	if $verbosity >= 10;	969	if $verbosity >= 10;
591		970
592	keys %$cb;	971	for my $pkg (keys %$cb) {
593
594	while (my ($pkg, $cb) = each %$cb) {
595	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	972	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
596	and last;	973	$retval ||= $retval_;
597		974
598	if ($@) {	975	if ($@) {
599	$TERM->ungrab; # better to lose the grab than the session	976	$TERM->ungrab; # better to lose the grab than the session
600	warn $@;	977	warn $@;
601	}	978	}
602	}	979	}
		980
		981	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		982	if $verbosity >= 11;
603	}	983	}
604		984
605	if ($htype == 1) { # DESTROY	985	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	986	# clear package objects
614	%$_ = () for values %{ $TERM->{_pkg} };	987	%$_ = () for values %{ $TERM->{_pkg} };
615		988
616	# clear package	989	# clear package
617	%$TERM = ();	990	%$TERM = ();
618	}	991	}
619		992
620	$retval	993	$retval
		994	}
		995
		996	sub SET_COLOR($$$) {
		997	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		998	}
		999
		1000	sub rend2mask {
		1001	no strict 'refs';
		1002	my ($str, $mask) = (@_, 0);
		1003	my %color = ( fg => undef, bg => undef );
		1004	my @failed;
		1005	for my $spec ( split /\s+/, $str ) {
		1006	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1007	$color{lc($1)} = $2;
		1008	} else {
		1009	my $neg = $spec =~ s/^[-^]//;
		1010	unless ( exists &{"RS_$spec"} ) {
		1011	push @failed, $spec;
		1012	next;
		1013	}
		1014	my $cur = &{"RS_$spec"};
		1015	if ( $neg ) {
		1016	$mask &= ~$cur;
		1017	} else {
		1018	$mask |= $cur;
		1019	}
		1020	}
		1021	}
		1022	($mask, @color{qw(fg bg)}, \@failed)
621	}	1023	}
622		1024
623	# urxvt::term::extension	1025	# urxvt::term::extension
624		1026
625	package urxvt::term::extension;	1027	package urxvt::term::extension;
…		…
631	while (my ($name, $cb) = each %hook) {	1033	while (my ($name, $cb) = each %hook) {
632	my $htype = $HOOKTYPE{uc $name};	1034	my $htype = $HOOKTYPE{uc $name};
633	defined $htype	1035	defined $htype
634	or Carp::croak "unsupported hook type '$name'";	1036	or Carp::croak "unsupported hook type '$name'";
635		1037
		1038	$self->set_should_invoke ($htype, +1)
636	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	1039	unless exists $self->{term}{_hook}[$htype]{$pkg};
637	$hook_count[$htype]++
638	or urxvt::set_should_invoke $htype, 1;
639	}
640		1040
641	$self->{term}{_hook}[$htype]{$pkg} = $cb;	1041	$self->{term}{_hook}[$htype]{$pkg} = $cb;
642	}	1042	}
643	}	1043	}
644		1044
…		…
649	for my $name (@hook) {	1049	for my $name (@hook) {
650	my $htype = $HOOKTYPE{uc $name};	1050	my $htype = $HOOKTYPE{uc $name};
651	defined $htype	1051	defined $htype
652	or Carp::croak "unsupported hook type '$name'";	1052	or Carp::croak "unsupported hook type '$name'";
653		1053
		1054	$self->set_should_invoke ($htype, -1)
654	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	1055	if delete $self->{term}{_hook}[$htype]{$pkg};
655	--$hook_count[$htype]
656	or urxvt::set_should_invoke $htype, 0;
657	}
658	}	1056	}
659	}	1057	}
660		1058
661	our $AUTOLOAD;	1059	our $AUTOLOAD;
662		1060
…		…
742	sub DESTROY {	1140	sub DESTROY {
743	$_[0][1]->stop;	1141	$_[0][1]->stop;
744	}	1142	}
745		1143
746	sub condvar {	1144	sub condvar {
747	bless \my $flag, urxvt::anyevent::condvar::	1145	bless \my $flag, urxvt::anyevent::
748	}	1146	}
749		1147
750	sub urxvt::anyevent::condvar::broadcast {	1148	sub broadcast {
751	${$_[0]}++;	1149	${$_[0]}++;
752	}	1150	}
753		1151
754	sub urxvt::anyevent::condvar::wait {	1152	sub wait {
755	unless (${$_[0]}) {	1153	unless (${$_[0]}) {
756	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";	1154	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
757	}	1155	}
		1156	}
		1157
		1158	sub one_event {
		1159	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
758	}	1160	}
759		1161
760	package urxvt::term;	1162	package urxvt::term;
761		1163
762	=head2 The C<urxvt::term> Class	1164	=head2 The C<urxvt::term> Class
…		…
767		1169
768	# find on_xxx subs in the package and register them	1170	# find on_xxx subs in the package and register them
769	# as hooks	1171	# as hooks
770	sub register_package {	1172	sub register_package {
771	my ($self, $pkg, $argv) = @_;	1173	my ($self, $pkg, $argv) = @_;
		1174
		1175	no strict 'refs';
		1176
		1177	urxvt::verbose 6, "register package $pkg to $self";
		1178
		1179	@{"$pkg\::ISA"} = urxvt::term::extension::;
772		1180
773	my $proxy = bless {	1181	my $proxy = bless {
774	_pkg => $pkg,	1182	_pkg => $pkg,
775	argv => $argv,	1183	argv => $argv,
776	}, $pkg;	1184	}, $pkg;
…		…
783	$proxy->enable ($name => $ref);	1191	$proxy->enable ($name => $ref);
784	}	1192	}
785	}	1193	}
786	}	1194	}
787		1195
		1196	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1197
		1198	Creates a new terminal, very similar as if you had started it with system
		1199	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1200	hash which defines the environment of the new terminal.
		1201
		1202	Croaks (and probably outputs an error message) if the new instance
		1203	couldn't be created. Returns C<undef> if the new instance didn't
		1204	initialise perl, and the terminal object otherwise. The C<init> and
		1205	C<start> hooks will be called before this call returns, and are free to
		1206	refer to global data (which is race free).
		1207
		1208	=cut
		1209
		1210	sub new {
		1211	my ($class, $env, @args) = @_;
		1212
		1213	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1214	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1215
		1216	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1217	}
		1218
788	=item $term->destroy	1219	=item $term->destroy
789		1220
790	Destroy the terminal object (close the window, free resources	1221	Destroy the terminal object (close the window, free resources
791	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1222	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
792	watchers (timers, io watchers) are still active.	1223	watchers (timers, io watchers) are still active.
793		1224
		1225	=item $term->exec_async ($cmd[, @args])
		1226
		1227	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1228	("starts") programs in the background. This function takes care of setting
		1229	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1230	be preferred over explicit calls to C<exec> or C<system>.
		1231
		1232	Returns the pid of the subprocess or C<undef> on error.
		1233
		1234	=cut
		1235
		1236	sub exec_async {
		1237	my $self = shift;
		1238
		1239	my $pid = fork;
		1240
		1241	return $pid
		1242	if !defined $pid or $pid;
		1243
		1244	%ENV = %{ $self->env };
		1245
		1246	exec @_;
		1247	urxvt::_exit 255;
		1248	}
		1249
794	=item $isset = $term->option ($optval[, $set])	1250	=item $isset = $term->option ($optval[, $set])
795		1251
796	Returns true if the option specified by C<$optval> is enabled, and	1252	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	1253	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.	1254	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
799		1255
800	Here is a a likely non-exhaustive list of option names, please see the	1256	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:	1257	source file F</src/optinc.h> to see the actual list:
802		1258
803	borderLess console cursorBlink cursorUnderline hold iconic insecure	1259	borderLess console cursorBlink cursorUnderline hold iconic insecure
804	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1260	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
805	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1261	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
806	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1262	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
807	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1263	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
808	tripleclickwords utmpInhibit visualBell	1264	transparent tripleclickwords utmpInhibit visualBell
809		1265
810	=item $value = $term->resource ($name[, $newval])	1266	=item $value = $term->resource ($name[, $newval])
811		1267
812	Returns the current resource value associated with a given name and	1268	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>	1269	optionally sets a new value. Setting values is most useful in the C<init>
…		…
822	likely change).	1278	likely change).
823		1279
824	Please note that resource strings will currently only be freed when the	1280	Please note that resource strings will currently only be freed when the
825	terminal is destroyed, so changing options frequently will eat memory.	1281	terminal is destroyed, so changing options frequently will eat memory.
826		1282
827	Here is a a likely non-exhaustive list of resource names, not all of which	1283	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>	1284	are supported in every build, please see the source file F</src/rsinc.h>
829	to see the actual list:	1285	to see the actual list:
830		1286
831	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1287	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
832	borderLess color cursorBlink cursorUnderline cutchars delete_key	1288	borderLess color cursorBlink cursorUnderline cutchars delete_key
833	display_name embed ext_bwidth fade font geometry hold iconName	1289	display_name embed ext_bwidth fade font geometry hold iconName
834	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1290	imFont imLocale inputMethod insecure int_bwidth intensityStyles
835	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1291	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
836	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1292	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
837	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1293	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
838	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1294	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
839	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1295	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
840	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1296	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
841	shade term_name title transparent transparent_all tripleclickwords	1297	secondaryScreen secondaryScroll selectstyle shade term_name title
842	utmpInhibit visualBell	1298	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1299	visualBell
843		1300
844	=cut	1301	=cut
845		1302
846	sub resource($$;$) {	1303	sub resource($$;$) {
847	my ($self, $name) = (shift, shift);	1304	my ($self, $name) = (shift, shift);
848	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1305	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
849	&urxvt::term::_resource	1306	&urxvt::term::_resource
850	}	1307	}
851		1308
		1309	=item $value = $term->x_resource ($pattern)
		1310
		1311	Returns the X-Resource for the given pattern, excluding the program or
		1312	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1313	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1314	resource with that pattern exists.
		1315
		1316	This method should only be called during the C<on_start> hook, as there is
		1317	only one resource database per display, and later invocations might return
		1318	the wrong resources.
		1319
852	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	1320	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
853		1321
854	Adds a keymap translation exactly as specified via a resource. See the	1322	Adds a keymap translation exactly as specified via a resource. See the
855	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	1323	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
856		1324
…		…
871	=item ($row, $col) = $term->selection_end ([$row, $col])	1339	=item ($row, $col) = $term->selection_end ([$row, $col])
872		1340
873	Return the current values of the selection mark, begin or end positions,	1341	Return the current values of the selection mark, begin or end positions,
874	and optionally set them to new values.	1342	and optionally set them to new values.
875		1343
		1344	=item $term->selection_make ($eventtime[, $rectangular])
		1345
		1346	Tries to make a selection as set by C<selection_beg> and
		1347	C<selection_end>. If C<$rectangular> is true (default: false), a
		1348	rectangular selection will be made. This is the prefered function to make
		1349	a selection.
		1350
876	=item $success = $term->selection_grab ($eventtime)	1351	=item $success = $term->selection_grab ($eventtime)
877		1352
878	Try to request the primary selection from the server (for example, as set	1353	Try to request the primary selection text from the server (for example, as
879	by the next method).	1354	set by the next method). No visual feedback will be given. This function
		1355	is mostly useful from within C<on_sel_grab> hooks.
880		1356
881	=item $oldtext = $term->selection ([$newtext])	1357	=item $oldtext = $term->selection ([$newtext])
882		1358
883	Return the current selection text and optionally replace it by C<$newtext>.	1359	Return the current selection text and optionally replace it by C<$newtext>.
884		1360
…		…
977	Convert the given locale-encoded octets into a perl string.	1453	Convert the given locale-encoded octets into a perl string.
978		1454
979	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])	1455	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
980		1456
981	XORs the rendition values in the given span with the provided value	1457	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	1458	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
983	to the selection.	1459	refresh hooks to provide effects similar to the selection.
984		1460
985	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])	1461	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
986		1462
987	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing	1463	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
988	whitespace will additionally be xored with the C<$rstyle2>, which defaults	1464	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	1465	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
990	it instead.	1466	it instead. Both styles I<MUST NOT> contain font styles.
991		1467
992	=item $term->scr_bell	1468	=item $term->scr_bell
993		1469
994	Ring the bell!	1470	Ring the bell!
995		1471
…		…
1002		1478
1003	Normally its not a good idea to use this function, as programs might be	1479	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	1480	confused by changes in cursor position or scrolling. Its useful inside a
1005	C<on_add_lines> hook, though.	1481	C<on_add_lines> hook, though.
1006		1482
		1483	=item $term->scr_change_screen ($screen)
		1484
		1485	Switch to given screen - 0 primary, 1 secondary.
		1486
1007	=item $term->cmd_parse ($octets)	1487	=item $term->cmd_parse ($octets)
1008		1488
1009	Similar to C<scr_add_lines>, but the argument must be in the	1489	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	1490	locale-specific encoding of the terminal and can contain command sequences
1011	(escape codes) that will be interpreted.	1491	(escape codes) that will be interpreted.
…		…
1021	Replaces the event mask of the pty watcher by the given event mask. Can	1501	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	1502	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	1503	description of C<< urxvt::timer->events >>. Make sure to always restore
1024	the previous value.	1504	the previous value.
1025		1505
		1506	=item $fd = $term->pty_fd
		1507
		1508	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1509	is used.
		1510
1026	=item $windowid = $term->parent	1511	=item $windowid = $term->parent
1027		1512
1028	Return the window id of the toplevel window.	1513	Return the window id of the toplevel window.
1029		1514
1030	=item $windowid = $term->vt	1515	=item $windowid = $term->vt
1031		1516
1032	Return the window id of the terminal window.	1517	Return the window id of the terminal window.
1033		1518
		1519	=item $term->vt_emask_add ($x_event_mask)
		1520
		1521	Adds the specified events to the vt event mask. Useful e.g. when you want
		1522	to receive pointer events all the times:
		1523
		1524	$term->vt_emask_add (urxvt::PointerMotionMask);
		1525
		1526	=item $term->focus_in
		1527
		1528	=item $term->focus_out
		1529
		1530	=item $term->key_press ($state, $keycode[, $time])
		1531
		1532	=item $term->key_release ($state, $keycode[, $time])
		1533
		1534	Deliver various fake events to to terminal.
		1535
1034	=item $window_width = $term->width	1536	=item $window_width = $term->width
1035		1537
1036	=item $window_height = $term->height	1538	=item $window_height = $term->height
1037		1539
1038	=item $font_width = $term->fwidth	1540	=item $font_width = $term->fwidth
…		…
1051		1553
1052	=item $max_scrollback = $term->saveLines	1554	=item $max_scrollback = $term->saveLines
1053		1555
1054	=item $nrow_plus_saveLines = $term->total_rows	1556	=item $nrow_plus_saveLines = $term->total_rows
1055		1557
1056	=item $lines_in_scrollback = $term->nsaved	1558	=item $topmost_scrollback_row = $term->top_row
1057		1559
1058	Return various integers describing terminal characteristics.	1560	Return various integers describing terminal characteristics.
1059		1561
		1562	=item $x_display = $term->display_id
		1563
		1564	Return the DISPLAY used by rxvt-unicode.
		1565
1060	=item $lc_ctype = $term->locale	1566	=item $lc_ctype = $term->locale
1061		1567
1062	Returns the LC_CTYPE category string used by this rxvt-unicode.	1568	Returns the LC_CTYPE category string used by this rxvt-unicode.
1063		1569
1064	=item $x_display = $term->display_id	1570	=item $env = $term->env
1065		1571
1066	Return the DISPLAY used by rxvt-unicode.	1572	Returns a copy of the environment in effect for the terminal as a hashref
		1573	similar to C<\%ENV>.
		1574
		1575	=item @envv = $term->envv
		1576
		1577	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1578
		1579	=item @argv = $term->argv
		1580
		1581	Return the argument vector as this terminal, similar to @ARGV, but
		1582	includes the program name as first element.
		1583
		1584	=cut
		1585
		1586	sub env {
		1587	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
		1588	}
1067		1589
1068	=item $modifiermask = $term->ModLevel3Mask	1590	=item $modifiermask = $term->ModLevel3Mask
1069		1591
1070	=item $modifiermask = $term->ModMetaMask	1592	=item $modifiermask = $term->ModMetaMask
1071		1593
1072	=item $modifiermask = $term->ModNumLockMask	1594	=item $modifiermask = $term->ModNumLockMask
1073		1595
1074	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1596	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.	1597	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1076		1598
		1599	=item $screen = $term->current_screen
		1600
		1601	Returns the currently displayed screen (0 primary, 1 secondary).
		1602
		1603	=item $cursor_is_hidden = $term->hidden_cursor
		1604
		1605	Returns whether the cursor is currently hidden or not.
		1606
1077	=item $view_start = $term->view_start ([$newvalue])	1607	=item $view_start = $term->view_start ([$newvalue])
1078		1608
1079	Returns the negative row number of the topmost line. Minimum value is	1609	Returns the row number of the topmost displayed line. Maximum value is
1080	C<0>, which displays the normal terminal contents. Larger values scroll	1610	C<0>, which displays the normal terminal contents. Lower values scroll
1081	this many lines into the scrollback buffer.	1611	this many lines into the scrollback buffer.
1082		1612
1083	=item $term->want_refresh	1613	=item $term->want_refresh
1084		1614
1085	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1615	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	1630	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	1631	to replace only parts of a line. The font index in the rendition will
1102	automatically be updated.	1632	automatically be updated.
1103		1633
1104	C<$text> is in a special encoding: tabs and wide characters that use more	1634	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	1635	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1106	(C<chr 65535>). Characters with combining characters and other characters	1636	characters. Characters with combining characters and other characters that
1107	that do not fit into the normal tetx encoding will be replaced with	1637	do not fit into the normal tetx encoding will be replaced with characters
1108	characters in the private use area.	1638	in the private use area.
1109		1639
1110	You have to obey this encoding when changing text. The advantage is	1640	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	1641	that C<substr> and similar functions work on screen cells and not on
1112	characters.	1642	characters.
1113		1643
…		…
1164	Return the row number of the first/last row of the line, respectively.	1694	Return the row number of the first/last row of the line, respectively.
1165		1695
1166	=item $offset = $line->offset_of ($row, $col)	1696	=item $offset = $line->offset_of ($row, $col)
1167		1697
1168	Returns the character offset of the given row|col pair within the logical	1698	Returns the character offset of the given row|col pair within the logical
1169	line.	1699	line. Works for rows outside the line, too, and returns corresponding
		1700	offsets outside the string.
1170		1701
1171	=item ($row, $col) = $line->coord_of ($offset)	1702	=item ($row, $col) = $line->coord_of ($offset)
1172		1703
1173	Translates a string offset into terminal coordinates again.	1704	Translates a string offset into terminal coordinates again.
1174		1705
…		…
1256	where one character corresponds to one screen cell. See	1787	where one character corresponds to one screen cell. See
1257	C<< $term->ROW_t >> for details.	1788	C<< $term->ROW_t >> for details.
1258		1789
1259	=item $string = $term->special_decode $text	1790	=item $string = $term->special_decode $text
1260		1791
1261	Converts rxvt-unicodes text reprsentation into a perl string. See	1792	Converts rxvt-unicodes text representation into a perl string. See
1262	C<< $term->ROW_t >> for details.	1793	C<< $term->ROW_t >> for details.
1263		1794
1264	=item $success = $term->grab_button ($button, $modifiermask)	1795	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1265		1796
		1797	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1798
1266	Registers a synchronous button grab. See the XGrabButton manpage.	1799	Register/unregister a synchronous button grab. See the XGrabButton
		1800	manpage.
1267		1801
1268	=item $success = $term->grab ($eventtime[, $sync])	1802	=item $success = $term->grab ($eventtime[, $sync])
1269		1803
1270	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1804	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1271	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1805	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1272		1806
1273	=item $term->allow_events_async	1807	=item $term->allow_events_async
1274		1808
1275	Calls XAllowEvents with AsyncBoth for the most recent grab.	1809	Calls XAllowEvents with AsyncBoth for the most recent grab.
1276		1810
…		…
1287		1821
1288	Calls XUngrab for the most recent grab. Is called automatically on	1822	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	1823	evaluation errors, as it is better to lose the grab in the error case as
1290	the session.	1824	the session.
1291		1825
		1826	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1827
		1828	=item $atom_name = $term->XGetAtomName ($atom)
		1829
		1830	=item @atoms = $term->XListProperties ($window)
		1831
		1832	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1833
		1834	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1835
		1836	=item $term->XDeleteProperty ($window, $property)
		1837
		1838	=item $window = $term->DefaultRootWindow
		1839
		1840	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1841
		1842	=item $term->XMapWindow ($window)
		1843
		1844	=item $term->XUnmapWindow ($window)
		1845
		1846	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1847
		1848	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1849
		1850	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1851
		1852	Various X or X-related functions. The C<$term> object only serves as
		1853	the source of the display, otherwise those functions map more-or-less
		1854	directory onto the X functions of the same name.
		1855
1292	=back	1856	=back
1293		1857
1294	=cut	1858	=cut
1295		1859
1296	package urxvt::popup;	1860	package urxvt::popup;
…		…
1310		1874
1311	$item->{render} ||= sub { $_[0]{text} };	1875	$item->{render} ||= sub { $_[0]{text} };
1312		1876
1313	push @{ $self->{item} }, $item;	1877	push @{ $self->{item} }, $item;
1314	}	1878	}
		1879
		1880	=item $popup->add_title ($title)
		1881
		1882	Adds a non-clickable title to the popup.
		1883
		1884	=cut
		1885
		1886	sub add_title {
		1887	my ($self, $title) = @_;
		1888
		1889	$self->add_item ({
		1890	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1891	text => $title,
		1892	activate => sub { },
		1893	});
		1894	}
		1895
		1896	=item $popup->add_separator ([$sepchr])
		1897
		1898	Creates a separator, optionally using the character given as C<$sepchr>.
		1899
		1900	=cut
1315		1901
1316	sub add_separator {	1902	sub add_separator {
1317	my ($self, $sep) = @_;	1903	my ($self, $sep) = @_;
1318		1904
1319	$sep ||= "=";	1905	$sep ||= "=";
…		…
1324	render => sub { $sep x $self->{term}->ncol },	1910	render => sub { $sep x $self->{term}->ncol },
1325	activate => sub { },	1911	activate => sub { },
1326	});	1912	});
1327	}	1913	}
1328		1914
1329	sub add_title {	1915	=item $popup->add_button ($text, $cb)
1330	my ($self, $title) = @_;
1331		1916
1332	$self->add_item ({	1917	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" },	1918	selected.
1334	text => $title,	1919
1335	activate => sub { },	1920	=cut
1336	});
1337	}
1338		1921
1339	sub add_button {	1922	sub add_button {
1340	my ($self, $text, $cb) = @_;	1923	my ($self, $text, $cb) = @_;
1341		1924
1342	$self->add_item ({ type => "button", text => $text, activate => $cb});	1925	$self->add_item ({ type => "button", text => $text, activate => $cb});
1343	}	1926	}
1344		1927
		1928	=item $popup->add_toggle ($text, $initial_value, $cb)
		1929
		1930	Adds a toggle/checkbox item to the popup. The callback gets called
		1931	whenever it gets toggled, with a boolean indicating its new value as its
		1932	first argument.
		1933
		1934	=cut
		1935
1345	sub add_toggle {	1936	sub add_toggle {
1346	my ($self, $text, $cb, $value) = @_;	1937	my ($self, $text, $value, $cb) = @_;
1347		1938
1348	my $item; $item = {	1939	my $item; $item = {
1349	type => "button",	1940	type => "button",
1350	text => " $text",	1941	text => " $text",
1351	value => $value,	1942	value => $value,
1352	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1943	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1353	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1944	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1354	};	1945	};
1355		1946
1356	$self->add_item ($item);	1947	$self->add_item ($item);
1357	}	1948	}
		1949
		1950	=item $popup->show
		1951
		1952	Displays the popup (which is initially hidden).
		1953
		1954	=cut
1358		1955
1359	sub show {	1956	sub show {
1360	my ($self) = @_;	1957	my ($self) = @_;
1361		1958
1362	local $urxvt::popup::self = $self;	1959	local $urxvt::popup::self = $self;
1363		1960
		1961	my $env = $self->{term}->env;
		1962	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1963	delete $env->{LC_ALL};
1364	local $ENV{LC_ALL} = $self->{term}->locale;	1964	$env->{LC_CTYPE} = $self->{term}->locale;
1365		1965
1366	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1966	urxvt::term->new ($env, "popup",
		1967	"--perl-lib" => "", "--perl-ext-common" => "",
		1968	"-pty-fd" => -1, "-sl" => 0,
		1969	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1367	"--transient-for" => $self->{term}->parent,	1970	"--transient-for" => $self->{term}->parent,
1368	"-display" => $self->{term}->display_id,	1971	"-display" => $self->{term}->display_id,
1369	"-pe" => "urxvt-popup")	1972	"-pe" => "urxvt-popup")
1370	or die "unable to create popup window\n";	1973	or die "unable to create popup window\n";
1371	}	1974	}
1372		1975
1373	sub DESTROY {	1976	sub DESTROY {
1374	my ($self) = @_;	1977	my ($self) = @_;
1375		1978
1376	delete $self->{term}{_destroy}{$self};	1979	delete $self->{term}{_destroy}{$self};
1377	$self->{term}->ungrab;	1980	$self->{term}->ungrab;
1378	}	1981	}
		1982
		1983	=back
		1984
		1985	=cut
		1986
		1987	package urxvt::watcher;
1379		1988
1380	=head2 The C<urxvt::timer> Class	1989	=head2 The C<urxvt::timer> Class
1381		1990
1382	This class implements timer watchers/events. Time is represented as a	1991	This class implements timer watchers/events. Time is represented as a
1383	fractional number of seconds since the epoch. Example:	1992	fractional number of seconds since the epoch. Example:
…		…
1421	Start the timer.	2030	Start the timer.
1422		2031
1423	=item $timer = $timer->start ($tstamp)	2032	=item $timer = $timer->start ($tstamp)
1424		2033
1425	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>.
1426		2039
1427	=item $timer = $timer->stop	2040	=item $timer = $timer->stop
1428		2041
1429	Stop the timer.	2042	Stop the timer.
1430		2043
…		…
1459	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>
1460	is a bitset as described in the C<events> method.	2073	is a bitset as described in the C<events> method.
1461		2074
1462	=item $iow = $iow->fd ($fd)	2075	=item $iow = $iow->fd ($fd)
1463		2076
1464	Set the filedescriptor (not handle) to watch.	2077	Set the file descriptor (not handle) to watch.
1465		2078
1466	=item $iow = $iow->events ($eventmask)	2079	=item $iow = $iow->events ($eventmask)
1467		2080
1468	Set the event mask to watch. The only allowed values are	2081	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	2082	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
…		…
1473		2086
1474	Start watching for requested events on the given handle.	2087	Start watching for requested events on the given handle.
1475		2088
1476	=item $iow = $iow->stop	2089	=item $iow = $iow->stop
1477		2090
1478	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.
1479		2153
1480	=back	2154	=back
1481		2155
1482	=head1 ENVIRONMENT	2156	=head1 ENVIRONMENT
1483		2157
…		…
1490		2164
1491	=item == 0 - fatal messages	2165	=item == 0 - fatal messages
1492		2166
1493	=item >= 3 - script loading and management	2167	=item >= 3 - script loading and management
1494		2168
1495	=item >=10 - all events received	2169	=item >=10 - all called hooks
		2170
		2171	=item >=11 - hook return values
1496		2172
1497	=back	2173	=back
1498		2174
1499	=head1 AUTHOR	2175	=head1 AUTHOR
1500		2176
…		…
1502	http://software.schmorp.de/pkg/rxvt-unicode	2178	http://software.schmorp.de/pkg/rxvt-unicode
1503		2179
1504	=cut	2180	=cut
1505		2181
1506	1	2182	1
		2183
		2184	# vim: sw=3:

Diff Legend

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