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

Diff Legend

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