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.9 by root, Mon Jan 2 20:40:20 2006 UTC vs.
Revision 1.202 by sf-exg, Wed Nov 30 10:29:51 2011 UTC

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

Diff Legend

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