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

Diff Legend

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