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.1 by root, Mon Jan 2 15:35:43 2006 UTC vs.
Revision 1.208 by root, Tue Jun 5 22:23:07 2012 UTC

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

Diff Legend

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