ViewVC Help

View File | Revision Log | Show Annotations | Download File

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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.72 by root, Mon Jan 9 23:30:01 2006 UTC vs.
Revision 1.151 by root, Thu Dec 14 17:22:04 2006 UTC

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

Diff Legend

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