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.69 by root, Mon Jan 9 22:41:41 2006 UTC vs.
Revision 1.180 by root, Sat Dec 26 09:42:16 2009 UTC

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

Diff Legend

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