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.28 by root, Wed Jan 4 00:09:12 2006 UTC vs.
Revision 1.187 by sf-exg, Sat Jul 24 10:20:26 2010 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, scripts specified via the	22	Every time a terminal object gets created, extension scripts specified via
23	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	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
…		…
56		92
57	URxvt.keysym.C-M-r: perl:selection:rot13	93	URxvt.keysym.C-M-r: perl:selection:rot13
58		94
59	=back	95	=back
60		96
		97	=item option-popup (enabled by default)
		98
		99	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
		100	runtime.
		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
		119	=item selection-popup (enabled by default)
		120
		121	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
		122	text into various other formats/action (such as uri unescaping, perl
		123	evaluation, web-browser starting etc.), depending on content.
		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
		144	=item searchable-scrollback<hotkey> (enabled by default)
		145
		146	Adds regex search functionality to the scrollback buffer, triggered
		147	by a hotkey (default: C<M-s>). While in search mode, normal terminal
		148	input/output is suspended and a regex is displayed at the bottom of the
		149	screen.
		150
		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.
		158
		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.
		162
		163	See L<perlre> for more info about perl regular expression syntax.
		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
		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.
		313
		314	=item block-graphics-to-ascii
		315
		316	A not very useful example of filtering all text output to the terminal
		317	by replacing all line-drawing characters (U+2500 .. U+259F) by a
		318	similar-looking ascii character.
		319
61	=item digital-clock	320	=item digital-clock
62		321
63	Displays a digital clock using the built-in overlay.	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 whether xrdb is used to parse the resource file
		376	or not.
		377
		378	=item macosx-clipboard and macosx-clipboard-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<macosx-clipboard> requires the
		389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		390	simpler etc. etc.
64		391
65	=item example-refresh-hooks	392	=item example-refresh-hooks
66		393
67	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
68	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
69	overlays or changes.	396	overlays or changes.
70		397
71	=back	398	=back
		399
		400	=head1 API DOCUMENTATION
72		401
73	=head2 General API Considerations	402	=head2 General API Considerations
74		403
75	All objects (such as terminals, time watchers etc.) are typical	404	All objects (such as terminals, time watchers etc.) are typical
76	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
…		…
81	When objects are destroyed on the C++ side, the perl object hashes are	410	When objects are destroyed on the C++ side, the perl object hashes are
82	emptied, so its best to store related objects such as time watchers and	411	emptied, so its best to store related objects such as time watchers and
83	the like inside the terminal object so they get destroyed as soon as the	412	the like inside the terminal object so they get destroyed as soon as the
84	terminal is destroyed.	413	terminal is destroyed.
85		414
		415	Argument names also often indicate the type of a parameter. Here are some
		416	hints on what they mean:
		417
		418	=over 4
		419
		420	=item $text
		421
		422	Rxvt-unicode's special way of encoding text, where one "unicode" character
		423	always represents one screen cell. See L<ROW_t> for a discussion of this format.
		424
		425	=item $string
		426
		427	A perl text string, with an emphasis on I<text>. It can store all unicode
		428	characters and is to be distinguished with text encoded in a specific
		429	encoding (often locale-specific) and binary data.
		430
		431	=item $octets
		432
		433	Either binary data or - more common - a text string encoded in a
		434	locale-specific way.
		435
		436	=back
		437
		438	=head2 Extension Objects
		439
		440	Every perl extension is a perl class. A separate perl object is created
		441	for each terminal, and each terminal has its own set of extenion objects,
		442	which are passed as the first parameter to hooks. So extensions can use
		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
		445	that begin with an underscore character C<_>: these are reserved for
		446	internal use.
		447
		448	Although it isn't a C<urxvt::term> object, you can call all methods of the
		449	C<urxvt::term> class on this object.
		450
		451	It has the following methods and data members:
		452
		453	=over 4
		454
		455	=item $urxvt_term = $self->{term}
		456
		457	Returns the C<urxvt::term> object associated with this instance of the
		458	extension. This member I<must not> be changed in any way.
		459
		460	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		461
		462	Dynamically enable the given hooks (named without the C<on_> prefix) for
		463	this extension, replacing any previous hook. This is useful when you want
		464	to overwrite time-critical hooks only temporarily.
		465
		466	=item $self->disable ($hook_name[, $hook_name..])
		467
		468	Dynamically disable the given hooks.
		469
		470	=back
		471
86	=head2 Hooks	472	=head2 Hooks
87		473
88	The following subroutines can be declared in loaded scripts, and will be	474	The following subroutines can be declared in extension files, and will be
89	called whenever the relevant event happens.	475	called whenever the relevant event happens.
90		476
91	The first argument passed to them is an object private to each terminal	477	The first argument passed to them is an extension object as described in
92	and extension package. You can call all C<urxvt::term> methods on it, but	478	the in the C<Extension Objects> section.
93	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
94	object that is shared between all packages is stored in the C<term>
95	member.
96		479
97	All of them must return a boolean value. If it is true, then the event	480	B<All> of these hooks must return a boolean value. If any of the called
98	counts as being I<consumed>, and the invocation of other hooks is skipped,	481	hooks returns true, then the event counts as being I<consumed>, and the
99	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.
100		483
101	When in doubt, return a false value (preferably C<()>).	484	I<< When in doubt, return a false value (preferably C<()>). >>
102		485
103	=over 4	486	=over 4
104		487
105	=item on_init $term	488	=item on_init $term
106		489
107	Called after a new terminal object has been initialized, but before	490	Called after a new terminal object has been initialized, but before
108	windows are created or the command gets run.	491	windows are created or the command gets run. Most methods are unsafe to
		492	call or deliver senseless data, as terminal size and other characteristics
		493	have not yet been determined. You can safely query and change resources
		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).
109		506
110	=item on_reset $term	507	=item on_reset $term
111		508
112	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
113	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
114	variables.	511	variables.
115		512
116	=item on_start $term	513	=item on_child_start $term, $pid
117		514
118	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.
119	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>.
120		521
121	=item on_sel_make $term, $eventtime	522	=item on_sel_make $term, $eventtime
122		523
123	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
124	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
…		…
131		532
132	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
133	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
134	by calling C<< $term->selection >>.	535	by calling C<< $term->selection >>.
135		536
136	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.
137		538
138	=item on_sel_extend $term	539	=item on_sel_extend $term
139		540
140	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
141	click) and is either supposed to return false (normal operation), or	542	click) and is either supposed to return false (normal operation), or
142	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
143	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.
144		547
145	See the F<selection> example extension.	548	See the F<selection> example extension.
146		549
147	=item on_focus_in $term
148
149	Called whenever the window gets the keyboard focus, before urxvt does
150	focus in processing.
151
152	=item on_focus_out $term
153
154	Called wheneever the window loses keyboard focus, before urxvt does focus
155	out processing.
156
157	=item on_view_change $term, $offset	550	=item on_view_change $term, $offset
158		551
159	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
160	scrolls. Offset C<0> means display the normal terminal, positive values	553	scrolls. Offset C<0> means display the normal terminal, positive values
161	show this many lines of scrollback.	554	show this many lines of scrollback.
162		555
163	=item on_scroll_back $term, $lines, $saved	556	=item on_scroll_back $term, $lines, $saved
164		557
…		…
168		561
169	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,
170	$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
171	number of lines that will be in the scrollback buffer.	564	number of lines that will be in the scrollback buffer.
172		565
173	=item on_tty_activity $term *NYI*
174
175	Called whenever the program(s) running in the urxvt window send output.
176
177	=item on_osc_seq $term, $string	566	=item on_osc_seq $term, $op, $args, $resp
178		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
		577
179	Called whenever the B<ESC ] 777 ; string ST> command sequence is	578	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
180	processed. Cursor position and other state information is up-to-date when	579	operating system command) is processed. Cursor position and other state
181	this happens. For interoperability, the string should start with the	580	information is up-to-date when this happens. For interoperability, the
182	extension name and a colon, to distinguish it from commands for other	581	string should start with the extension name (sans -osc) and a semicolon,
183	extensions, and this might be enforced in the future.	582	to distinguish it from commands for other extensions, and this might be
		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	}
		594
		595	Be careful not ever to trust (in a security sense) the data you receive,
		596	as its source can not easily be controlled (e-mail content, messages from
		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.
		601
		602	=item on_add_lines $term, $string
		603
		604	Called whenever text is about to be output, with the text as argument. You
		605	can filter/change and output the text yourself by returning a true value
		606	and calling C<< $term->scr_add_lines >> yourself. Please note that this
		607	might be very slow, however, as your hook is called for B<all> text being
		608	output.
		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
		615	=item on_tt_paste $term, $octets
		616
		617	Called whenever text is about to be pasted, with the text as argument. You
		618	can filter/change and paste the text yourself by returning a true value
		619	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		620	locale-encoded.
		621
		622	=item on_line_update $term, $row
		623
		624	Called whenever a line was updated or changed. Can be used to filter
		625	screen output (e.g. underline urls or other useless stuff). Only lines
		626	that are being shown will be filtered, and, due to performance reasons,
		627	not always immediately.
		628
		629	The row number is always the topmost row of the line if the line spans
		630	multiple rows.
		631
		632	Please note that, if you change the line, then the hook might get called
		633	later with the already-modified line (e.g. if unrelated parts change), so
		634	you cannot just toggle rendition bits, but only set them.
184		635
185	=item on_refresh_begin $term	636	=item on_refresh_begin $term
186		637
187	Called just before the screen gets redrawn. Can be used for overlay	638	Called just before the screen gets redrawn. Can be used for overlay or
188	or similar effects by modify terminal contents in refresh_begin, and	639	similar effects by modifying the terminal contents in refresh_begin, and
189	restoring them in refresh_end. The built-in overlay and selection display	640	restoring them in refresh_end. The built-in overlay and selection display
190	code is run after this hook, and takes precedence.	641	code is run after this hook, and takes precedence.
191		642
192	=item on_refresh_end $term	643	=item on_refresh_end $term
193		644
194	Called just after the screen gets redrawn. See C<on_refresh_begin>.	645	Called just after the screen gets redrawn. See C<on_refresh_begin>.
195		646
196	=item on_keyboard_command $term, $string	647	=item on_user_command $term, $string
197		648
198	Called whenever the user presses a key combination that has a	649	Called whenever a user-configured event is being activated (e.g. via
199	C<perl:string> action bound to it (see description of the B<keysym>	650	a C<perl:string> action bound to a key, see description of the B<keysym>
200	resource in the @@RXVT_NAME@@(1) manpage).	651	resource in the @@RXVT_NAME@@(1) manpage).
201		652
		653	The event is simply the action string. This interface is assumed to change
		654	slightly in the future.
		655
		656	=item on_resize_all_windows $term, $new_width, $new_height
		657
		658	Called just after the new window size has been calculated, but before
		659	windows are actually being resized or hints are being set. If this hook
		660	returns TRUE, setting of the window hints is being skipped.
		661
		662	=item on_x_event $term, $event
		663
		664	Called on every X event received on the vt window (and possibly other
		665	windows). Should only be used as a last resort. Most event structure
		666	members are not passed.
		667
		668	=item on_root_event $term, $event
		669
		670	Like C<on_x_event>, but is called for events on the root window.
		671
		672	=item on_focus_in $term
		673
		674	Called whenever the window gets the keyboard focus, before rxvt-unicode
		675	does focus in processing.
		676
		677	=item on_focus_out $term
		678
		679	Called whenever the window loses keyboard focus, before rxvt-unicode does
		680	focus out processing.
		681
		682	=item on_configure_notify $term, $event
		683
		684	=item on_property_notify $term, $event
		685
		686	=item on_key_press $term, $event, $keysym, $octets
		687
		688	=item on_key_release $term, $event, $keysym
		689
		690	=item on_button_press $term, $event
		691
		692	=item on_button_release $term, $event
		693
		694	=item on_motion_notify $term, $event
		695
		696	=item on_map_notify $term, $event
		697
		698	=item on_unmap_notify $term, $event
		699
		700	Called whenever the corresponding X event is received for the terminal. If
		701	the hook returns true, then the event will be ignored by rxvt-unicode.
		702
		703	The event is a hash with most values as named by Xlib (see the XEvent
		704	manpage), with the additional members C<row> and C<col>, which are the
		705	(real, not screen-based) row and column under the mouse cursor.
		706
		707	C<on_key_press> additionally receives the string rxvt-unicode would
		708	output, if any, in locale-specific encoding.
		709
		710	subwindow.
		711
		712	=item on_client_message $term, $event
		713
		714	=item on_wm_protocols $term, $event
		715
		716	=item on_wm_delete_window $term, $event
		717
		718	Called when various types of ClientMessage events are received (all with
		719	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		720
		721	=item on_bell $term
		722
		723	Called on receipt of a bell character.
		724
202	=back	725	=back
203		726
		727	=cut
		728
		729	package urxvt;
		730
		731	use utf8;
		732	use strict;
		733	use Carp ();
		734	use Scalar::Util ();
		735	use List::Util ();
		736
		737	our $VERSION = 1;
		738	our $TERM;
		739	our @TERM_INIT;
		740	our @TERM_EXT;
		741	our @HOOKNAME;
		742	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		743	our %OPTION;
		744
		745	our $LIBDIR;
		746	our $RESNAME;
		747	our $RESCLASS;
		748	our $RXVTNAME;
		749
		750	our $NOCHAR = chr 0xffff;
		751
204	=head2 Variables in the C<urxvt> Package	752	=head2 Variables in the C<urxvt> Package
205		753
206	=over 4	754	=over 4
207		755
		756	=item $urxvt::LIBDIR
		757
		758	The rxvt-unicode library directory, where, among other things, the perl
		759	modules and scripts are stored.
		760
		761	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		762
		763	The resource class and name rxvt-unicode uses to look up X resources.
		764
		765	=item $urxvt::RXVTNAME
		766
		767	The basename of the installed binaries, usually C<urxvt>.
		768
208	=item $urxvt::TERM	769	=item $urxvt::TERM
209		770
210	The current terminal. Whenever a callback/Hook is bein executed, this	771	The current terminal. This variable stores the current C<urxvt::term>
211	variable stores the current C<urxvt::term> object.	772	object, whenever a callback/hook is executing.
		773
		774	=item @urxvt::TERM_INIT
		775
		776	All code references in this array will be called as methods of the next newly
		777	created C<urxvt::term> object (during the C<on_init> phase). The array
		778	gets cleared before the code references that were in it are being executed,
		779	so references can push themselves onto it again if they so desire.
		780
		781	This complements to the perl-eval command line option, but gets executed
		782	first.
		783
		784	=item @urxvt::TERM_EXT
		785
		786	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		787	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		788	but before other extensions. Gets cleared just like C<@TERM_INIT>.
212		789
213	=back	790	=back
214		791
215	=head2 Functions in the C<urxvt> Package	792	=head2 Functions in the C<urxvt> Package
216		793
…		…
229	that calls this function.	806	that calls this function.
230		807
231	Using this function has the advantage that its output ends up in the	808	Using this function has the advantage that its output ends up in the
232	correct place, e.g. on stderr of the connecting urxvtc client.	809	correct place, e.g. on stderr of the connecting urxvtc client.
233		810
		811	Messages have a size limit of 1023 bytes currently.
		812
		813	=item @terms = urxvt::termlist
		814
		815	Returns all urxvt::term objects that exist in this process, regardless of
		816	whether they are started, being destroyed etc., so be careful. Only term
		817	objects that have perl extensions attached will be returned (because there
		818	is no urxvt::term objet associated with others).
		819
234	=item $time = urxvt::NOW	820	=item $time = urxvt::NOW
235		821
236	Returns the "current time" (as per the event loop).	822	Returns the "current time" (as per the event loop).
		823
		824	=item urxvt::CurrentTime
		825
		826	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		827	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		828	Button4Mask, Button5Mask, AnyModifier
		829
		830	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		831	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		832	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		833	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		834	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		835	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		836	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		837
		838	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		839	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		840	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		841	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		842	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		843	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		844	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
		845
		846	Various constants for use in X calls and event processing.
237		847
238	=back	848	=back
239		849
240	=head2 RENDITION	850	=head2 RENDITION
241		851
…		…
268		878
269	=item $background = urxvt::GET_BASEBG $rend	879	=item $background = urxvt::GET_BASEBG $rend
270		880
271	Return the foreground/background colour index, respectively.	881	Return the foreground/background colour index, respectively.
272		882
273	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	883	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
274		884
275	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	885	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		886
		887	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
276		888
277	Replace the foreground/background colour in the rendition mask with the	889	Replace the foreground/background colour in the rendition mask with the
278	specified one.	890	specified one.
279		891
280	=item $value = urxvt::GET_CUSTOM ($rend)	892	=item $value = urxvt::GET_CUSTOM $rend
281		893
282	Return the "custom" value: Every rendition has 5 bits for use by	894	Return the "custom" value: Every rendition has 5 bits for use by
283	extensions. They can be set and changed as you like and are initially	895	extensions. They can be set and changed as you like and are initially
284	zero.	896	zero.
285		897
286	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	898	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
287		899
288	Change the custom value.	900	Change the custom value.
289		901
290	=back	902	=back
291		903
292	=cut	904	=cut
293		905
294	package urxvt;
295
296	use strict;
297	use Scalar::Util ();
298
299	our $TERM;
300	our @HOOKNAME;
301	our $LIBDIR;
302
303	BEGIN {	906	BEGIN {
304	urxvt->bootstrap;
305
306	# overwrite perl's warn	907	# overwrite perl's warn
307	*CORE::GLOBAL::warn = sub {	908	*CORE::GLOBAL::warn = sub {
308	my $msg = join "", @_;	909	my $msg = join "", @_;
309	$msg .= "\n"	910	$msg .= "\n"
310	unless $msg =~ /\n$/;	911	unless $msg =~ /\n$/;
311	urxvt::warn ($msg);	912	urxvt::warn ($msg);
312	};	913	};
313	}	914	}
314		915
315	my @hook_count;	916	no warnings 'utf8';
		917
316	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	918	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
317		919
318	sub verbose {	920	sub verbose {
319	my ($level, $msg) = @_;	921	my ($level, $msg) = @_;
320	warn "$msg\n" if $level <= $verbosity;	922	warn "$msg\n" if $level <= $verbosity;
321	}	923	}
322		924
323	# find on_xxx subs in the package and register them	925	my %extension_pkg;
324	# as hooks
325	sub register_package($) {
326	my ($pkg) = @_;
327
328	for my $htype (0.. $#HOOKNAME) {
329	my $name = $HOOKNAME[$htype];
330
331	my $ref = $pkg->can ("on_" . lc $name)
332	or next;
333
334	$TERM->{_hook}[$htype]{$pkg} = $ref;
335	$hook_count[$htype]++
336	or set_should_invoke $htype, 1;
337	}
338	}
339
340	my $script_pkg = "script0000";
341	my %script_pkg;
342		926
343	# load a single script into its own package, once only	927	# load a single script into its own package, once only
344	sub script_package($) {	928	sub extension_package($) {
345	my ($path) = @_;	929	my ($path) = @_;
346		930
347	$script_pkg{$path} ||= do {	931	$extension_pkg{$path} ||= do {
348	my $pkg = "urxvt::" . ($script_pkg++);	932	$path =~ /([^\/\\]+)$/;
		933	my $pkg = $1;
		934	$pkg =~ s/[^[:word:]]/_/g;
		935	$pkg = "urxvt::ext::$pkg";
349		936
350	verbose 3, "loading script '$path' into package '$pkg'";	937	verbose 3, "loading extension '$path' into package '$pkg'";
351		938
352	open my $fh, "<:raw", $path	939	open my $fh, "<:raw", $path
353	or die "$path: $!";	940	or die "$path: $!";
354		941
355	my $source = "package $pkg; use strict; use utf8;\n"	942	my $source =
		943	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
356	. "#line 1 \"$path\"\n{\n"	944	. "#line 1 \"$path\"\n{\n"
357	. (do { local $/; <$fh> })	945	. (do { local $/; <$fh> })
358	. "\n};\n1";	946	. "\n};\n1";
359		947
		948	eval $source
360	eval $source or die "$path: $@";	949	or die "$path: $@";
361		950
362	$pkg	951	$pkg
363	}	952	}
364	}	953	}
		954
		955	our $retval; # return value for urxvt
365		956
366	# called by the rxvt core	957	# called by the rxvt core
367	sub invoke {	958	sub invoke {
368	local $TERM = shift;	959	local $TERM = shift;
369	my $htype = shift;	960	my $htype = shift;
370		961
371	if ($htype == 0) { # INIT	962	if ($htype == 0) { # INIT
372	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	963	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
373		964
374	for my $ext (split /:/, $TERM->resource ("perl_ext")) {	965	my %ext_arg;
		966
		967	{
		968	my @init = @TERM_INIT;
		969	@TERM_INIT = ();
		970	$_->($TERM) for @init;
		971	my @pkg = @TERM_EXT;
		972	@TERM_EXT = ();
		973	$TERM->register_package ($_) for @pkg;
		974	}
		975
		976	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		977	if ($_ eq "default") {
		978	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
		979	} elsif (/^-(.*)$/) {
		980	delete $ext_arg{$1};
		981	} elsif (/^([^<]+)<(.*)>$/) {
		982	push @{ $ext_arg{$1} }, $2;
		983	} else {
		984	$ext_arg{$_} ||= [];
		985	}
		986	}
		987
		988	for my $ext (sort keys %ext_arg) {
375	my @files = grep -f $_, map "$_/$ext", @dirs;	989	my @files = grep -f $_, map "$_/$ext", @dirs;
376		990
377	if (@files) {	991	if (@files) {
378	register_package script_package $files[0];	992	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
379	} else {	993	} else {
380	warn "perl extension '$ext' not found in perl library search path\n";	994	warn "perl extension '$ext' not found in perl library search path\n";
381	}	995	}
382	}	996	}
383		997
		998	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		999	warn $@ if $@;
		1000	}
		1001
		1002	$retval = undef;
		1003
		1004	if (my $cb = $TERM->{_hook}[$htype]) {
		1005	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		1006	if $verbosity >= 10;
		1007
		1008	for my $pkg (keys %$cb) {
		1009	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
		1010	$retval ||= $retval_;
		1011
		1012	if ($@) {
		1013	$TERM->ungrab; # better to lose the grab than the session
		1014	warn $@;
		1015	}
		1016	}
		1017
		1018	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		1019	if $verbosity >= 11;
		1020	}
		1021
384	} elsif ($htype == 1) { # DESTROY	1022	if ($htype == 1) { # DESTROY
385	if (my $hook = $TERM->{_hook}) {	1023	# clear package objects
386	for my $htype (0..$#$hook) {	1024	%$_ = () for values %{ $TERM->{_pkg} };
387	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }	1025
388	or set_should_invoke $htype, 0;	1026	# clear package
		1027	%$TERM = ();
		1028	}
		1029
		1030	$retval
		1031	}
		1032
		1033	sub SET_COLOR($$$) {
		1034	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1035	}
		1036
		1037	sub rend2mask {
		1038	no strict 'refs';
		1039	my ($str, $mask) = (@_, 0);
		1040	my %color = ( fg => undef, bg => undef );
		1041	my @failed;
		1042	for my $spec ( split /\s+/, $str ) {
		1043	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1044	$color{lc($1)} = $2;
		1045	} else {
		1046	my $neg = $spec =~ s/^[-^]//;
		1047	unless ( exists &{"RS_$spec"} ) {
		1048	push @failed, $spec;
		1049	next;
		1050	}
		1051	my $cur = &{"RS_$spec"};
		1052	if ( $neg ) {
		1053	$mask &= ~$cur;
		1054	} else {
		1055	$mask |= $cur;
389	}	1056	}
390	}	1057	}
391	}	1058	}
		1059	($mask, @color{qw(fg bg)}, \@failed)
		1060	}
392		1061
393	my $cb = $TERM->{_hook}[$htype]	1062	# urxvt::term::extension
394	or return;
395		1063
396	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1064	package urxvt::term::extension;
397	if $verbosity >= 10;
398		1065
399	keys %$cb;	1066	sub enable {
		1067	my ($self, %hook) = @_;
		1068	my $pkg = $self->{_pkg};
400		1069
401	while (my ($pkg, $cb) = each %$cb) {	1070	while (my ($name, $cb) = each %hook) {
402	return 1	1071	my $htype = $HOOKTYPE{uc $name};
403	if $cb->(	1072	defined $htype
404	$TERM->{$pkg} ||= do {	1073	or Carp::croak "unsupported hook type '$name'";
405	my $proxy = bless { }, urxvt::term::proxy::;	1074
406	Scalar::Util::weaken ($proxy->{term} = $TERM);	1075	$self->set_should_invoke ($htype, +1)
407	$proxy	1076	unless exists $self->{term}{_hook}[$htype]{$pkg};
408	},	1077
409	@_,	1078	$self->{term}{_hook}[$htype]{$pkg} = $cb;
410	);
411	}	1079	}
		1080	}
412		1081
		1082	sub disable {
		1083	my ($self, @hook) = @_;
		1084	my $pkg = $self->{_pkg};
		1085
		1086	for my $name (@hook) {
		1087	my $htype = $HOOKTYPE{uc $name};
		1088	defined $htype
		1089	or Carp::croak "unsupported hook type '$name'";
		1090
		1091	$self->set_should_invoke ($htype, -1)
		1092	if delete $self->{term}{_hook}[$htype]{$pkg};
413	0	1093	}
414	}	1094	}
415		1095
416	sub urxvt::term::proxy::AUTOLOAD {	1096	our $AUTOLOAD;
417	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	1097
		1098	sub AUTOLOAD {
		1099	$AUTOLOAD =~ /:([^:]+)$/
418	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	1100	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
419		1101
420	eval qq{	1102	eval qq{
421	sub $urxvt::term::proxy::AUTOLOAD {	1103	sub $AUTOLOAD {
422	my \$proxy = shift;	1104	my \$proxy = shift;
423	\$proxy->{term}->$1 (\@_)	1105	\$proxy->{term}->$1 (\@_)
424	}	1106	}
425	1	1107	1
426	} or die "FATAL: unable to compile method forwarder: $@";	1108	} or die "FATAL: unable to compile method forwarder: $@";
427		1109
428	goto &$urxvt::term::proxy::AUTOLOAD;	1110	goto &$AUTOLOAD;
429	}	1111	}
		1112
		1113	sub DESTROY {
		1114	# nop
		1115	}
		1116
		1117	# urxvt::destroy_hook
		1118
		1119	sub urxvt::destroy_hook::DESTROY {
		1120	${$_[0]}->();
		1121	}
		1122
		1123	sub urxvt::destroy_hook(&) {
		1124	bless \shift, urxvt::destroy_hook::
		1125	}
		1126
		1127	package urxvt::anyevent;
		1128
		1129	=head2 The C<urxvt::anyevent> Class
		1130
		1131	The sole purpose of this class is to deliver an interface to the
		1132	C<AnyEvent> module - any module using it will work inside urxvt without
		1133	further programming. The only exception is that you cannot wait on
		1134	condition variables, but non-blocking condvar use is ok. What this means
		1135	is that you cannot use blocking APIs, but the non-blocking variant should
		1136	work.
		1137
		1138	=cut
		1139
		1140	our $VERSION = '5.23';
		1141
		1142	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		1143	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		1144
		1145	sub timer {
		1146	my ($class, %arg) = @_;
		1147
		1148	my $cb = $arg{cb};
		1149
		1150	urxvt::timer
		1151	->new
		1152	->after ($arg{after}, $arg{interval})
		1153	->cb ($arg{interval} ? $cb : sub {
		1154	$_[0]->stop; # need to cancel manually
		1155	$cb->();
		1156	})
		1157	}
		1158
		1159	sub io {
		1160	my ($class, %arg) = @_;
		1161
		1162	my $cb = $arg{cb};
		1163	my $fd = fileno $arg{fh};
		1164	defined $fd or $fd = $arg{fh};
		1165
		1166	bless [$arg{fh}, urxvt::iow
		1167	->new
		1168	->fd ($fd)
		1169	->events (($arg{poll} =~ /r/ ? 1 : 0)
		1170	| ($arg{poll} =~ /w/ ? 2 : 0))
		1171	->start
		1172	->cb ($cb)
		1173	], urxvt::anyevent::
		1174	}
		1175
		1176	sub idle {
		1177	my ($class, %arg) = @_;
		1178
		1179	my $cb = $arg{cb};
		1180
		1181	urxvt::iw
		1182	->new
		1183	->start
		1184	->cb ($cb)
		1185	}
		1186
		1187	sub child {
		1188	my ($class, %arg) = @_;
		1189
		1190	my $cb = $arg{cb};
		1191
		1192	urxvt::pw
		1193	->new
		1194	->start ($arg{pid})
		1195	->cb (sub {
		1196	$_[0]->stop; # need to cancel manually
		1197	$cb->($_[0]->rpid, $_[0]->rstatus);
		1198	})
		1199	}
		1200
		1201	sub DESTROY {
		1202	$_[0][1]->stop;
		1203	}
		1204
		1205	sub one_event {
		1206	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
		1207	}
		1208
		1209	package urxvt::term;
430		1210
431	=head2 The C<urxvt::term> Class	1211	=head2 The C<urxvt::term> Class
432		1212
433	=over 4	1213	=over 4
		1214
		1215	=cut
		1216
		1217	# find on_xxx subs in the package and register them
		1218	# as hooks
		1219	sub register_package {
		1220	my ($self, $pkg, $argv) = @_;
		1221
		1222	no strict 'refs';
		1223
		1224	urxvt::verbose 6, "register package $pkg to $self";
		1225
		1226	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1227
		1228	my $proxy = bless {
		1229	_pkg => $pkg,
		1230	argv => $argv,
		1231	}, $pkg;
		1232	Scalar::Util::weaken ($proxy->{term} = $self);
		1233
		1234	$self->{_pkg}{$pkg} = $proxy;
		1235
		1236	for my $name (@HOOKNAME) {
		1237	if (my $ref = $pkg->can ("on_" . lc $name)) {
		1238	$proxy->enable ($name => $ref);
		1239	}
		1240	}
		1241	}
		1242
		1243	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1244
		1245	Creates a new terminal, very similar as if you had started it with system
		1246	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1247	hash which defines the environment of the new terminal.
		1248
		1249	Croaks (and probably outputs an error message) if the new instance
		1250	couldn't be created. Returns C<undef> if the new instance didn't
		1251	initialise perl, and the terminal object otherwise. The C<init> and
		1252	C<start> hooks will be called before this call returns, and are free to
		1253	refer to global data (which is race free).
		1254
		1255	=cut
		1256
		1257	sub new {
		1258	my ($class, $env, @args) = @_;
		1259
		1260	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1261	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1262
		1263	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1264	}
		1265
		1266	=item $term->destroy
		1267
		1268	Destroy the terminal object (close the window, free resources
		1269	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1270	watchers (timers, io watchers) are still active.
		1271
		1272	=item $term->exec_async ($cmd[, @args])
		1273
		1274	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1275	("starts") programs in the background. This function takes care of setting
		1276	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1277	be preferred over explicit calls to C<exec> or C<system>.
		1278
		1279	Returns the pid of the subprocess or C<undef> on error.
		1280
		1281	=cut
		1282
		1283	sub exec_async {
		1284	my $self = shift;
		1285
		1286	my $pid = fork;
		1287
		1288	return $pid
		1289	if !defined $pid or $pid;
		1290
		1291	%ENV = %{ $self->env };
		1292
		1293	exec @_;
		1294	urxvt::_exit 255;
		1295	}
		1296
		1297	=item $isset = $term->option ($optval[, $set])
		1298
		1299	Returns true if the option specified by C<$optval> is enabled, and
		1300	optionally change it. All option values are stored by name in the hash
		1301	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		1302
		1303	Here is a likely non-exhaustive list of option names, please see the
		1304	source file F</src/optinc.h> to see the actual list:
		1305
		1306	borderLess console cursorBlink cursorUnderline hold iconic insecure
		1307	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
		1308	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
		1309	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
		1310	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
		1311	transparent tripleclickwords utmpInhibit visualBell
434		1312
435	=item $value = $term->resource ($name[, $newval])	1313	=item $value = $term->resource ($name[, $newval])
436		1314
437	Returns the current resource value associated with a given name and	1315	Returns the current resource value associated with a given name and
438	optionally sets a new value. Setting values is most useful in the C<init>	1316	optionally sets a new value. Setting values is most useful in the C<init>
…		…
447	likely change).	1325	likely change).
448		1326
449	Please note that resource strings will currently only be freed when the	1327	Please note that resource strings will currently only be freed when the
450	terminal is destroyed, so changing options frequently will eat memory.	1328	terminal is destroyed, so changing options frequently will eat memory.
451		1329
452	Here is a a likely non-exhaustive list of resource names, not all of which	1330	Here is a likely non-exhaustive list of resource names, not all of which
453	are supported in every build, please see the source to see the actual	1331	are supported in every build, please see the source file F</src/rsinc.h>
454	list:	1332	to see the actual list:
455		1333
456	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1334	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
457	borderLess color cursorBlink cursorUnderline cutchars delete_key	1335	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
458	display_name embed ext_bwidth fade font geometry hold iconName	1336	display_name embed ext_bwidth fade font geometry hold iconName
459	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1337	imFont imLocale inputMethod insecure int_bwidth intensityStyles
460	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1338	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
461	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	1339	modifier mouseWheelScrollPage name override_redirect pastableTabs path
462	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1340	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
463	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1341	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
464	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1342	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
465	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1343	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
466	shade term_name title transparent transparent_all tripleclickwords	1344	secondaryScreen secondaryScroll shade term_name title
467	utmpInhibit visualBell	1345	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1346	visualBell
468		1347
469	=cut	1348	=cut
470		1349
471	sub urxvt::term::resource($$;$) {	1350	sub resource($$;$) {
472	my ($self, $name) = (shift, shift);	1351	my ($self, $name) = (shift, shift);
473	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1352	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
474	goto &urxvt::term::_resource;	1353	goto &urxvt::term::_resource
475	}	1354	}
		1355
		1356	=item $value = $term->x_resource ($pattern)
		1357
		1358	Returns the X-Resource for the given pattern, excluding the program or
		1359	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1360	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1361	resource with that pattern exists.
		1362
		1363	This method should only be called during the C<on_start> hook, as there is
		1364	only one resource database per display, and later invocations might return
		1365	the wrong resources.
		1366
		1367	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		1368
		1369	Adds a keymap translation exactly as specified via a resource. See the
		1370	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1371
		1372	=item $rend = $term->rstyle ([$new_rstyle])
		1373
		1374	Return and optionally change the current rendition. Text that is output by
		1375	the terminal application will use this style.
		1376
		1377	=item ($row, $col) = $term->screen_cur ([$row, $col])
		1378
		1379	Return the current coordinates of the text cursor position and optionally
		1380	set it (which is usually bad as applications don't expect that).
476		1381
477	=item ($row, $col) = $term->selection_mark ([$row, $col])	1382	=item ($row, $col) = $term->selection_mark ([$row, $col])
478		1383
479	=item ($row, $col) = $term->selection_beg ([$row, $col])	1384	=item ($row, $col) = $term->selection_beg ([$row, $col])
480		1385
481	=item ($row, $col) = $term->selection_end ([$row, $col])	1386	=item ($row, $col) = $term->selection_end ([$row, $col])
482		1387
483	Return the current values of the selection mark, begin or end positions,	1388	Return the current values of the selection mark, begin or end positions.
484	and optionally set them to new values.
485		1389
		1390	When arguments are given, then the selection coordinates are set to
		1391	C<$row> and C<$col>, and the selection screen is set to the current
		1392	screen.
		1393
		1394	=item $screen = $term->selection_screen ([$screen])
		1395
		1396	Returns the current selection screen, and then optionally sets it.
		1397
		1398	=item $term->selection_make ($eventtime[, $rectangular])
		1399
		1400	Tries to make a selection as set by C<selection_beg> and
		1401	C<selection_end>. If C<$rectangular> is true (default: false), a
		1402	rectangular selection will be made. This is the preferred function to make
		1403	a selection.
		1404
486	=item $success = $term->selection_grab ($eventtime)	1405	=item $success = $term->selection_grab ($eventtime[, $clipboard])
487		1406
488	Try to request the primary selection from the server (for example, as set	1407	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
489	by the next method).	1408	true) selection from the server. The corresponding text can be set
		1409	with the next method. No visual feedback will be given. This function
		1410	is mostly useful from within C<on_sel_grab> hooks.
490		1411
491	=item $oldtext = $term->selection ([$newtext])	1412	=item $oldtext = $term->selection ([$newtext, $clipboard])
492		1413
493	Return the current selection text and optionally replace it by C<$newtext>.	1414	Return the current selection (clipboard if C<$clipboard> is true) text
		1415	and optionally replace it by C<$newtext>.
494		1416
		1417	=item $term->selection_clear ([$clipboard])
		1418
		1419	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
		1420
495	#=item $term->overlay ($x, $y, $text)	1421	=item $term->overlay_simple ($x, $y, $text)
496	#	1422
497	#Create a simple multi-line overlay box. See the next method for details.	1423	Create a simple multi-line overlay box. See the next method for details.
498	#	1424
499	#=cut	1425	=cut
500		1426
501	sub urxvt::term::scr_overlay {	1427	sub overlay_simple {
502	die;
503	my ($self, $x, $y, $text) = @_;	1428	my ($self, $x, $y, $text) = @_;
504		1429
505	my @lines = split /\n/, $text;	1430	my @lines = split /\n/, $text;
506		1431
507	my $w = 0;	1432	my $w = List::Util::max map $self->strwidth ($_), @lines;
508	for (map $self->strwidth ($_), @lines) {
509	$w = $_ if $w < $_;
510	}
511		1433
512	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	1434	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
513	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1435	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
		1436
		1437	$overlay
514	}	1438	}
515		1439
516	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1440	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
517		1441
518	Create a new (empty) overlay at the given position with the given	1442	Create a new (empty) overlay at the given position with the given
…		…
530		1454
531	The methods currently supported on C<urxvt::overlay> objects are:	1455	The methods currently supported on C<urxvt::overlay> objects are:
532		1456
533	=over 4	1457	=over 4
534		1458
535	=item $overlay->set ($x, $y, $text, $rend)	1459	=item $overlay->set ($x, $y, $text[, $rend])
536		1460
537	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1461	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
538	text in rxvt-unicode's special encoding and an array of rendition values	1462	text in rxvt-unicode's special encoding and an array of rendition values
539	at a specific position inside the overlay.	1463	at a specific position inside the overlay.
540		1464
		1465	If C<$rend> is missing, then the rendition will not be changed.
		1466
541	=item $overlay->hide	1467	=item $overlay->hide
542		1468
543	If visible, hide the overlay, but do not destroy it.	1469	If visible, hide the overlay, but do not destroy it.
544		1470
545	=item $overlay->show	1471	=item $overlay->show
546		1472
547	If hidden, display the overlay again.	1473	If hidden, display the overlay again.
548		1474
549	=back	1475	=back
550		1476
		1477	=item $popup = $term->popup ($event)
		1478
		1479	Creates a new C<urxvt::popup> object that implements a popup menu. The
		1480	C<$event> I<must> be the event causing the menu to pop up (a button event,
		1481	currently).
		1482
		1483	=cut
		1484
		1485	sub popup {
		1486	my ($self, $event) = @_;
		1487
		1488	$self->grab ($event->{time}, 1)
		1489	or return;
		1490
		1491	my $popup = bless {
		1492	term => $self,
		1493	event => $event,
		1494	}, urxvt::popup::;
		1495
		1496	Scalar::Util::weaken $popup->{term};
		1497
		1498	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		1499	Scalar::Util::weaken $self->{_destroy}{$popup};
		1500
		1501	$popup
		1502	}
		1503
551	=item $cellwidth = $term->strwidth $string	1504	=item $cellwidth = $term->strwidth ($string)
552		1505
553	Returns the number of screen-cells this string would need. Correctly	1506	Returns the number of screen-cells this string would need. Correctly
554	accounts for wide and combining characters.	1507	accounts for wide and combining characters.
555		1508
556	=item $octets = $term->locale_encode $string	1509	=item $octets = $term->locale_encode ($string)
557		1510
558	Convert the given text string into the corresponding locale encoding.	1511	Convert the given text string into the corresponding locale encoding.
559		1512
560	=item $string = $term->locale_decode $octets	1513	=item $string = $term->locale_decode ($octets)
561		1514
562	Convert the given locale-encoded octets into a perl string.	1515	Convert the given locale-encoded octets into a perl string.
563		1516
		1517	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1518
		1519	XORs the rendition values in the given span with the provided value
		1520	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1521	refresh hooks to provide effects similar to the selection.
		1522
		1523	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1524
		1525	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1526	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1527	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
		1528	it instead. Both styles I<MUST NOT> contain font styles.
		1529
		1530	=item $term->scr_bell
		1531
		1532	Ring the bell!
		1533
		1534	=item $term->scr_add_lines ($string)
		1535
		1536	Write the given text string to the screen, as if output by the application
		1537	running inside the terminal. It may not contain command sequences (escape
		1538	codes), but is free to use line feeds, carriage returns and tabs. The
		1539	string is a normal text string, not in locale-dependent encoding.
		1540
		1541	Normally its not a good idea to use this function, as programs might be
		1542	confused by changes in cursor position or scrolling. Its useful inside a
		1543	C<on_add_lines> hook, though.
		1544
		1545	=item $term->scr_change_screen ($screen)
		1546
		1547	Switch to given screen - 0 primary, 1 secondary.
		1548
		1549	=item $term->cmd_parse ($octets)
		1550
		1551	Similar to C<scr_add_lines>, but the argument must be in the
		1552	locale-specific encoding of the terminal and can contain command sequences
		1553	(escape codes) that will be interpreted.
		1554
564	=item $term->tt_write ($octets)	1555	=item $term->tt_write ($octets)
565		1556
566	Write the octets given in C<$data> to the tty (i.e. as program input). To	1557	Write the octets given in C<$octets> to the tty (i.e. as program input). To
567	pass characters instead of octets, you should convert your strings first	1558	pass characters instead of octets, you should convert your strings first
568	to the locale-specific encoding using C<< $term->locale_encode >>.	1559	to the locale-specific encoding using C<< $term->locale_encode >>.
569		1560
		1561	=item $term->tt_paste ($octets)
		1562
		1563	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1564	CR and bracketing the data with control sequences if bracketed paste mode
		1565	is set.
		1566
		1567	=item $old_events = $term->pty_ev_events ([$new_events])
		1568
		1569	Replaces the event mask of the pty watcher by the given event mask. Can
		1570	be used to suppress input and output handling to the pty/tty. See the
		1571	description of C<< urxvt::timer->events >>. Make sure to always restore
		1572	the previous value.
		1573
		1574	=item $fd = $term->pty_fd
		1575
		1576	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1577	is used.
		1578
		1579	=item $windowid = $term->parent
		1580
		1581	Return the window id of the toplevel window.
		1582
		1583	=item $windowid = $term->vt
		1584
		1585	Return the window id of the terminal window.
		1586
		1587	=item $term->vt_emask_add ($x_event_mask)
		1588
		1589	Adds the specified events to the vt event mask. Useful e.g. when you want
		1590	to receive pointer events all the times:
		1591
		1592	$term->vt_emask_add (urxvt::PointerMotionMask);
		1593
		1594	=item $term->focus_in
		1595
		1596	=item $term->focus_out
		1597
		1598	=item $term->key_press ($state, $keycode[, $time])
		1599
		1600	=item $term->key_release ($state, $keycode[, $time])
		1601
		1602	Deliver various fake events to to terminal.
		1603
		1604	=item $window_width = $term->width
		1605
		1606	=item $window_height = $term->height
		1607
		1608	=item $font_width = $term->fwidth
		1609
		1610	=item $font_height = $term->fheight
		1611
		1612	=item $font_ascent = $term->fbase
		1613
570	=item $nrow = $term->nrow	1614	=item $terminal_rows = $term->nrow
571		1615
572	=item $ncol = $term->ncol	1616	=item $terminal_columns = $term->ncol
573		1617
574	Return the number of rows/columns of the terminal window (i.e. as	1618	=item $has_focus = $term->focus
575	specified by C<-geometry>, excluding any scrollback).
576		1619
		1620	=item $is_mapped = $term->mapped
		1621
		1622	=item $max_scrollback = $term->saveLines
		1623
		1624	=item $nrow_plus_saveLines = $term->total_rows
		1625
		1626	=item $topmost_scrollback_row = $term->top_row
		1627
		1628	Return various integers describing terminal characteristics.
		1629
		1630	=item $x_display = $term->display_id
		1631
		1632	Return the DISPLAY used by rxvt-unicode.
		1633
		1634	=item $lc_ctype = $term->locale
		1635
		1636	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1637
577	=item $nsaved = $term->nsaved	1638	=item $env = $term->env
578		1639
579	Returns the number of lines in the scrollback buffer.	1640	Returns a copy of the environment in effect for the terminal as a hashref
		1641	similar to C<\%ENV>.
		1642
		1643	=item @envv = $term->envv
		1644
		1645	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1646
		1647	=item @argv = $term->argv
		1648
		1649	Return the argument vector as this terminal, similar to @ARGV, but
		1650	includes the program name as first element.
		1651
		1652	=cut
		1653
		1654	sub env {
		1655	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
		1656	}
		1657
		1658	=item $modifiermask = $term->ModLevel3Mask
		1659
		1660	=item $modifiermask = $term->ModMetaMask
		1661
		1662	=item $modifiermask = $term->ModNumLockMask
		1663
		1664	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1665	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1666
		1667	=item $screen = $term->current_screen
		1668
		1669	Returns the currently displayed screen (0 primary, 1 secondary).
		1670
		1671	=item $cursor_is_hidden = $term->hidden_cursor
		1672
		1673	Returns whether the cursor is currently hidden or not.
580		1674
581	=item $view_start = $term->view_start ([$newvalue])	1675	=item $view_start = $term->view_start ([$newvalue])
582		1676
583	Returns the negative row number of the topmost line. Minimum value is	1677	Returns the row number of the topmost displayed line. Maximum value is
584	C<0>, which displays the normal terminal contents. Larger values scroll	1678	C<0>, which displays the normal terminal contents. Lower values scroll
585	this many lines into the scrollback buffer.	1679	this many lines into the scrollback buffer.
586		1680
587	=item $term->want_refresh	1681	=item $term->want_refresh
588		1682
589	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1683	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
592		1686
593	Used after changing terminal contents to display them.	1687	Used after changing terminal contents to display them.
594		1688
595	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1689	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
596		1690
597	Returns the text of the entire row with number C<$row_number>. Row C<0>	1691	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
598	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1692	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
599	terminal line. The scrollback buffer starts at line C<-1> and extends to
600	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1693	terminal line. Nothing will be returned if a nonexistent line
601	is requested.	1694	is requested.
602		1695
603	If C<$new_text> is specified, it will replace characters in the current	1696	If C<$new_text> is specified, it will replace characters in the current
604	line, starting at column C<$start_col> (default C<0>), which is useful	1697	line, starting at column C<$start_col> (default C<0>), which is useful
605	to replace only parts of a line. The font index in the rendition will	1698	to replace only parts of a line. The font index in the rendition will
606	automatically be updated.	1699	automatically be updated.
607		1700
608	C<$text> is in a special encoding: tabs and wide characters that use more	1701	C<$text> is in a special encoding: tabs and wide characters that use more
609	than one cell when displayed are padded with urxvt::NOCHAR characters	1702	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
610	(C<chr 65535>). Characters with combining characters and other characters	1703	characters. Characters with combining characters and other characters that
611	that do not fit into the normal tetx encoding will be replaced with	1704	do not fit into the normal text encoding will be replaced with characters
612	characters in the private use area.	1705	in the private use area.
613		1706
614	You have to obey this encoding when changing text. The advantage is	1707	You have to obey this encoding when changing text. The advantage is
615	that C<substr> and similar functions work on screen cells and not on	1708	that C<substr> and similar functions work on screen cells and not on
616	characters.	1709	characters.
617		1710
…		…
647	about the logical line that row C<$row_number> is part of. It supports the	1740	about the logical line that row C<$row_number> is part of. It supports the
648	following methods:	1741	following methods:
649		1742
650	=over 4	1743	=over 4
651		1744
652	=item $text = $line->t	1745	=item $text = $line->t ([$new_text])
653		1746
654	Returns the full text of the line, similar to C<ROW_t>	1747	Returns or replaces the full text of the line, similar to C<ROW_t>
655		1748
656	=item $rend = $line->r	1749	=item $rend = $line->r ([$new_rend])
657		1750
658	Returns the full rendition array of the line, similar to C<ROW_r>	1751	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
659		1752
660	=item $length = $line->l	1753	=item $length = $line->l
661		1754
662	Returns the length of the line in cells, similar to C<ROW_l>.	1755	Returns the length of the line in cells, similar to C<ROW_l>.
663		1756
…		…
668	Return the row number of the first/last row of the line, respectively.	1761	Return the row number of the first/last row of the line, respectively.
669		1762
670	=item $offset = $line->offset_of ($row, $col)	1763	=item $offset = $line->offset_of ($row, $col)
671		1764
672	Returns the character offset of the given row|col pair within the logical	1765	Returns the character offset of the given row|col pair within the logical
673	line.	1766	line. Works for rows outside the line, too, and returns corresponding
		1767	offsets outside the string.
674		1768
675	=item ($row, $col) = $line->coord_of ($offset)	1769	=item ($row, $col) = $line->coord_of ($offset)
676		1770
677	Translates a string offset into terminal coordinates again.	1771	Translates a string offset into terminal coordinates again.
678		1772
679	=back	1773	=back
680		1774
681	=cut	1775	=cut
682		1776
683	sub urxvt::term::line {	1777	sub line {
684	my ($self, $row) = @_;	1778	my ($self, $row) = @_;
685		1779
686	my $maxrow = $self->nrow - 1;	1780	my $maxrow = $self->nrow - 1;
687		1781
688	my ($beg, $end) = ($row, $row);	1782	my ($beg, $end) = ($row, $row);
…		…
692		1786
693	bless {	1787	bless {
694	term => $self,	1788	term => $self,
695	beg => $beg,	1789	beg => $beg,
696	end => $end,	1790	end => $end,
		1791	ncol => $self->ncol,
697	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),	1792	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
698	}, urxvt::line::	1793	}, urxvt::line::
699	}	1794	}
700		1795
701	sub urxvt::line::t {	1796	sub urxvt::line::t {
702	my ($self) = @_;	1797	my ($self) = @_;
703		1798
		1799	if (@_ > 1)
		1800	{
		1801	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1802	for $self->{beg} .. $self->{end};
		1803	}
		1804
		1805	defined wantarray &&
704	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),	1806	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
705	0, $self->{len}	1807	0, $self->{len}
706	}	1808	}
707		1809
708	sub urxvt::line::r {	1810	sub urxvt::line::r {
709	my ($self) = @_;	1811	my ($self) = @_;
710		1812
		1813	if (@_ > 1)
		1814	{
		1815	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1816	for $self->{beg} .. $self->{end};
		1817	}
		1818
		1819	if (defined wantarray) {
711	my $rend = [	1820	my $rend = [
712	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}	1821	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
713	];	1822	];
714	$#$rend = $self->{len} - 1;	1823	$#$rend = $self->{len} - 1;
715	$rend	1824	return $rend;
		1825	}
		1826
		1827	()
716	}	1828	}
717		1829
718	sub urxvt::line::beg { $_[0]{beg} }	1830	sub urxvt::line::beg { $_[0]{beg} }
719	sub urxvt::line::end { $_[0]{end} }	1831	sub urxvt::line::end { $_[0]{end} }
720	sub urxvt::line::l { $_[0]{len} }	1832	sub urxvt::line::l { $_[0]{len} }
721		1833
722	sub urxvt::line::offset_of {	1834	sub urxvt::line::offset_of {
723	my ($self, $row, $col) = @_;	1835	my ($self, $row, $col) = @_;
724		1836
725	($row - $self->{beg}) * $self->{term}->ncol + $col	1837	($row - $self->{beg}) * $self->{ncol} + $col
726	}	1838	}
727		1839
728	sub urxvt::line::coord_of {	1840	sub urxvt::line::coord_of {
729	my ($self, $offset) = @_;	1841	my ($self, $offset) = @_;
730		1842
731	use integer;	1843	use integer;
732		1844
733	(	1845	(
734	$offset / $self->{term}->ncol + $self->{beg},	1846	$offset / $self->{ncol} + $self->{beg},
735	$offset % $self->{term}->ncol	1847	$offset % $self->{ncol}
736	)	1848	)
737	}	1849	}
738		1850
739	=item ($row, $col) = $line->coord_of ($offset)
740	=item $text = $term->special_encode $string	1851	=item $text = $term->special_encode $string
741		1852
742	Converts a perl string into the special encoding used by rxvt-unicode,	1853	Converts a perl string into the special encoding used by rxvt-unicode,
743	where one character corresponds to one screen cell. See	1854	where one character corresponds to one screen cell. See
744	C<< $term->ROW_t >> for details.	1855	C<< $term->ROW_t >> for details.
745		1856
746	=item $string = $term->special_decode $text	1857	=item $string = $term->special_decode $text
747		1858
748	Converts rxvt-unicodes text reprsentation into a perl string. See	1859	Converts rxvt-unicodes text representation into a perl string. See
749	C<< $term->ROW_t >> for details.	1860	C<< $term->ROW_t >> for details.
750		1861
		1862	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
		1863
		1864	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1865
		1866	Register/unregister a synchronous button grab. See the XGrabButton
		1867	manpage.
		1868
		1869	=item $success = $term->grab ($eventtime[, $sync])
		1870
		1871	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1872	synchronous (C<$sync> is true). Also remembers the grab timestamp.
		1873
		1874	=item $term->allow_events_async
		1875
		1876	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1877
		1878	=item $term->allow_events_sync
		1879
		1880	Calls XAllowEvents with SyncBoth for the most recent grab.
		1881
		1882	=item $term->allow_events_replay
		1883
		1884	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1885	recent grab.
		1886
		1887	=item $term->ungrab
		1888
		1889	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
		1890	evaluation errors, as it is better to lose the grab in the error case as
		1891	the session.
		1892
		1893	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1894
		1895	=item $atom_name = $term->XGetAtomName ($atom)
		1896
		1897	=item @atoms = $term->XListProperties ($window)
		1898
		1899	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1900
		1901	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1902
		1903	=item $term->XDeleteProperty ($window, $property)
		1904
		1905	=item $window = $term->DefaultRootWindow
		1906
		1907	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1908
		1909	=item $term->XMapWindow ($window)
		1910
		1911	=item $term->XUnmapWindow ($window)
		1912
		1913	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1914
		1915	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1916
		1917	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1918
		1919	Various X or X-related functions. The C<$term> object only serves as
		1920	the source of the display, otherwise those functions map more-or-less
		1921	directly onto the X functions of the same name.
		1922
751	=back	1923	=back
		1924
		1925	=cut
		1926
		1927	package urxvt::popup;
		1928
		1929	=head2 The C<urxvt::popup> Class
		1930
		1931	=over 4
		1932
		1933	=cut
		1934
		1935	sub add_item {
		1936	my ($self, $item) = @_;
		1937
		1938	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1939	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1940	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1941
		1942	$item->{render} ||= sub { $_[0]{text} };
		1943
		1944	push @{ $self->{item} }, $item;
		1945	}
		1946
		1947	=item $popup->add_title ($title)
		1948
		1949	Adds a non-clickable title to the popup.
		1950
		1951	=cut
		1952
		1953	sub add_title {
		1954	my ($self, $title) = @_;
		1955
		1956	$self->add_item ({
		1957	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1958	text => $title,
		1959	activate => sub { },
		1960	});
		1961	}
		1962
		1963	=item $popup->add_separator ([$sepchr])
		1964
		1965	Creates a separator, optionally using the character given as C<$sepchr>.
		1966
		1967	=cut
		1968
		1969	sub add_separator {
		1970	my ($self, $sep) = @_;
		1971
		1972	$sep ||= "=";
		1973
		1974	$self->add_item ({
		1975	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		1976	text => "",
		1977	render => sub { $sep x $self->{term}->ncol },
		1978	activate => sub { },
		1979	});
		1980	}
		1981
		1982	=item $popup->add_button ($text, $cb)
		1983
		1984	Adds a clickable button to the popup. C<$cb> is called whenever it is
		1985	selected.
		1986
		1987	=cut
		1988
		1989	sub add_button {
		1990	my ($self, $text, $cb) = @_;
		1991
		1992	$self->add_item ({ type => "button", text => $text, activate => $cb});
		1993	}
		1994
		1995	=item $popup->add_toggle ($text, $initial_value, $cb)
		1996
		1997	Adds a toggle/checkbox item to the popup. The callback gets called
		1998	whenever it gets toggled, with a boolean indicating its new value as its
		1999	first argument.
		2000
		2001	=cut
		2002
		2003	sub add_toggle {
		2004	my ($self, $text, $value, $cb) = @_;
		2005
		2006	my $item; $item = {
		2007	type => "button",
		2008	text => " $text",
		2009	value => $value,
		2010	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		2011	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
		2012	};
		2013
		2014	$self->add_item ($item);
		2015	}
		2016
		2017	=item $popup->show
		2018
		2019	Displays the popup (which is initially hidden).
		2020
		2021	=cut
		2022
		2023	sub show {
		2024	my ($self) = @_;
		2025
		2026	local $urxvt::popup::self = $self;
		2027
		2028	my $env = $self->{term}->env;
		2029	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		2030	delete $env->{LC_ALL};
		2031	$env->{LC_CTYPE} = $self->{term}->locale;
		2032
		2033	my $term = urxvt::term->new (
		2034	$env, "popup",
		2035	"--perl-lib" => "", "--perl-ext-common" => "",
		2036	"-pty-fd" => -1, "-sl" => 0,
		2037	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
		2038	"--transient-for" => $self->{term}->parent,
		2039	"-display" => $self->{term}->display_id,
		2040	"-pe" => "urxvt-popup",
		2041	) or die "unable to create popup window\n";
		2042
		2043	unless (delete $term->{urxvt_popup_init_done}) {
		2044	$term->ungrab;
		2045	$term->destroy;
		2046	die "unable to initialise popup window\n";
		2047	}
		2048	}
		2049
		2050	sub DESTROY {
		2051	my ($self) = @_;
		2052
		2053	delete $self->{term}{_destroy}{$self};
		2054	$self->{term}->ungrab;
		2055	}
		2056
		2057	=back
		2058
		2059	=cut
		2060
		2061	package urxvt::watcher;
752		2062
753	=head2 The C<urxvt::timer> Class	2063	=head2 The C<urxvt::timer> Class
754		2064
755	This class implements timer watchers/events. Time is represented as a	2065	This class implements timer watchers/events. Time is represented as a
756	fractional number of seconds since the epoch. Example:	2066	fractional number of seconds since the epoch. Example:
…		…
760	->new	2070	->new
761	->interval (1)	2071	->interval (1)
762	->cb (sub {	2072	->cb (sub {
763	$term->{overlay}->set (0, 0,	2073	$term->{overlay}->set (0, 0,
764	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2074	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
765	});	2075	});
766		2076
767	=over 4	2077	=over 4
768		2078
769	=item $timer = new urxvt::timer	2079	=item $timer = new urxvt::timer
770		2080
…		…
773		2083
774	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2084	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
775		2085
776	Set the callback to be called when the timer triggers.	2086	Set the callback to be called when the timer triggers.
777		2087
778	=item $tstamp = $timer->at
779
780	Return the time this watcher will fire next.
781
782	=item $timer = $timer->set ($tstamp)	2088	=item $timer = $timer->set ($tstamp[, $interval])
783		2089
784	Set the time the event is generated to $tstamp.	2090	Set the time the event is generated to $tstamp (and optionally specifies a
		2091	new $interval).
785		2092
786	=item $timer = $timer->interval ($interval)	2093	=item $timer = $timer->interval ($interval)
787		2094
788	Normally (and when C<$interval> is C<0>), the timer will automatically	2095	By default (and when C<$interval> is C<0>), the timer will automatically
789	stop after it has fired once. If C<$interval> is non-zero, then the timer	2096	stop after it has fired once. If C<$interval> is non-zero, then the timer
790	is automatically rescheduled at the given intervals.	2097	is automatically rescheduled at the given intervals.
791		2098
792	=item $timer = $timer->start	2099	=item $timer = $timer->start
793		2100
794	Start the timer.	2101	Start the timer.
795		2102
796	=item $timer = $timer->start ($tstamp)	2103	=item $timer = $timer->start ($tstamp[, $interval])
797		2104
798	Set the event trigger time to C<$tstamp> and start the timer.	2105	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2106	also replaces the interval.
		2107
		2108	=item $timer = $timer->after ($delay[, $interval])
		2109
		2110	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
799		2111
800	=item $timer = $timer->stop	2112	=item $timer = $timer->stop
801		2113
802	Stop the timer.	2114	Stop the timer.
803		2115
…		…
809		2121
810	$term->{socket} = ...	2122	$term->{socket} = ...
811	$term->{iow} = urxvt::iow	2123	$term->{iow} = urxvt::iow
812	->new	2124	->new
813	->fd (fileno $term->{socket})	2125	->fd (fileno $term->{socket})
814	->events (1) # wait for read data	2126	->events (urxvt::EV_READ)
815	->start	2127	->start
816	->cb (sub {	2128	->cb (sub {
817	my ($iow, $revents) = @_;	2129	my ($iow, $revents) = @_;
818	# $revents must be 1 here, no need to check	2130	# $revents must be 1 here, no need to check
819	sysread $term->{socket}, my $buf, 8192	2131	sysread $term->{socket}, my $buf, 8192
…		…
832	Set the callback to be called when io events are triggered. C<$reventmask>	2144	Set the callback to be called when io events are triggered. C<$reventmask>
833	is a bitset as described in the C<events> method.	2145	is a bitset as described in the C<events> method.
834		2146
835	=item $iow = $iow->fd ($fd)	2147	=item $iow = $iow->fd ($fd)
836		2148
837	Set the filedescriptor (not handle) to watch.	2149	Set the file descriptor (not handle) to watch.
838		2150
839	=item $iow = $iow->events ($eventmask)	2151	=item $iow = $iow->events ($eventmask)
840		2152
841	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	2153	Set the event mask to watch. The only allowed values are
842	data, Bit #1 (value C<2>) enables watching for write data.	2154	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
		2155	together, or C<urxvt::EV_NONE>.
843		2156
844	=item $iow = $iow->start	2157	=item $iow = $iow->start
845		2158
846	Start watching for requested events on the given handle.	2159	Start watching for requested events on the given handle.
847		2160
848	=item $iow = $iow->stop	2161	=item $iow = $iow->stop
849		2162
850	Stop watching for events on the given filehandle.	2163	Stop watching for events on the given file handle.
		2164
		2165	=back
		2166
		2167	=head2 The C<urxvt::iw> Class
		2168
		2169	This class implements idle watchers, that get called automatically when
		2170	the process is idle. They should return as fast as possible, after doing
		2171	some useful work.
		2172
		2173	=over 4
		2174
		2175	=item $iw = new urxvt::iw
		2176
		2177	Create a new idle watcher object in stopped state.
		2178
		2179	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2180
		2181	Set the callback to be called when the watcher triggers.
		2182
		2183	=item $timer = $timer->start
		2184
		2185	Start the watcher.
		2186
		2187	=item $timer = $timer->stop
		2188
		2189	Stop the watcher.
		2190
		2191	=back
		2192
		2193	=head2 The C<urxvt::pw> Class
		2194
		2195	This class implements process watchers. They create an event whenever a
		2196	process exits, after which they stop automatically.
		2197
		2198	my $pid = fork;
		2199	...
		2200	$term->{pw} = urxvt::pw
		2201	->new
		2202	->start ($pid)
		2203	->cb (sub {
		2204	my ($pw, $exit_status) = @_;
		2205	...
		2206	});
		2207
		2208	=over 4
		2209
		2210	=item $pw = new urxvt::pw
		2211
		2212	Create a new process watcher in stopped state.
		2213
		2214	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2215
		2216	Set the callback to be called when the timer triggers.
		2217
		2218	=item $pw = $timer->start ($pid)
		2219
		2220	Tells the watcher to start watching for process C<$pid>.
		2221
		2222	=item $pw = $pw->stop
		2223
		2224	Stop the watcher.
851		2225
852	=back	2226	=back
853		2227
854	=head1 ENVIRONMENT	2228	=head1 ENVIRONMENT
855		2229
…		…
858	This variable controls the verbosity level of the perl extension. Higher	2232	This variable controls the verbosity level of the perl extension. Higher
859	numbers indicate more verbose output.	2233	numbers indicate more verbose output.
860		2234
861	=over 4	2235	=over 4
862		2236
863	=item =0 - only fatal messages	2237	=item == 0 - fatal messages
864		2238
865	=item =3 - script loading and management	2239	=item >= 3 - script loading and management
866		2240
867	=item =10 - all events received	2241	=item >=10 - all called hooks
		2242
		2243	=item >=11 - hook return values
868		2244
869	=back	2245	=back
870		2246
871	=head1 AUTHOR	2247	=head1 AUTHOR
872		2248
…		…
874	http://software.schmorp.de/pkg/rxvt-unicode	2250	http://software.schmorp.de/pkg/rxvt-unicode
875		2251
876	=cut	2252	=cut
877		2253
878	1	2254	1
		2255
		2256	# vim: sw=3:

Diff Legend

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