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.20 by root, Tue Jan 3 04:18:47 2006 UTC vs.
Revision 1.206 by root, Tue Jun 5 21:06:15 2012 UTC

…		…
17		17
18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test	18	@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19		19
20	=head1 DESCRIPTION	20	=head1 DESCRIPTION
21		21
22	Everytime a terminal object gets created, scripts specified via the	22	Every time a terminal object gets created, extension scripts specified via
23	C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
31	=head2 Prepackaged Extensions	31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
32		33
		34	=head1 PREPACKAGED EXTENSIONS
		35
33	This section describes the extensiosn delivered with this version. You can	36	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
36	You can activate them like this:	39	You can activate them like this:
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
39		42
		43	Or by adding them to the resource for extensions loaded by default:
		44
		45	URxvt.perl-ext-common: default,selection-autotransform
		46
40	=over 4	47	=over 4
41		48
42	=item selection	49	=item selection (enabled by default)
43		50
44	Miscellaneous selection modifications.	51	(More) intelligent selection. This extension tries to be more intelligent
		52	when the user extends selections (double-click and further clicks). Right
		53	now, it tries to select words, urls and complete shell-quoted
		54	arguments, which is very convenient, too, if your F<ls> supports
		55	C<--quoting-style=shell>.
		56
		57	A double-click usually selects the word under the cursor, further clicks
		58	will enlarge the selection.
		59
		60	The selection works by trying to match a number of regexes and displaying
		61	them in increasing order of length. You can add your own regexes by
		62	specifying resources of the form:
		63
		64	URxvt.selection.pattern-0: perl-regex
		65	URxvt.selection.pattern-1: perl-regex
		66	...
		67
		68	The index number (0, 1...) must not have any holes, and each regex must
		69	contain at least one pair of capturing parentheses, which will be used for
		70	the match. For example, the following adds a regex that matches everything
		71	between two vertical bars:
		72
		73	URxvt.selection.pattern-0: \\|([^|]+)\\|
		74
		75	Another example: Programs I use often output "absolute path: " at the
		76	beginning of a line when they process multiple files. The following
		77	pattern matches the filename (note, there is a single space at the very
		78	end):
		79
		80	URxvt.selection.pattern-0: ^(/[^:]+):\
		81
		82	You can look at the source of the selection extension to see more
		83	interesting uses, such as parsing a line from beginning to end.
		84
		85	This extension also offers following bindable keyboard commands:
45		86
46	=over 4	87	=over 4
47		88
48	=item rot13	89	=item rot13
49		90
…		…
51		92
52	URxvt.keysym.C-M-r: perl:selection:rot13	93	URxvt.keysym.C-M-r: perl:selection:rot13
53		94
54	=back	95	=back
55		96
		97	=item option-popup (enabled by default)
		98
		99	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
		100	runtime.
		101
		102	Other extensions can extend this popup menu by pushing a code reference
		103	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
		104	popup is being displayed.
		105
		106	Its sole argument is the popup menu, which can be modified. It should
		107	either return nothing or a string, the initial boolean value and a code
		108	reference. The string will be used as button text and the code reference
		109	will be called when the toggle changes, with the new boolean value as
		110	first argument.
		111
		112	The following will add an entry C<myoption> that changes
		113	C<< $self->{myoption} >>:
		114
		115	push @{ $self->{term}{option_popup_hook} }, sub {
		116	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
		117	};
		118
		119	=item selection-popup (enabled by default)
		120
		121	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
		122	text into various other formats/action (such as uri unescaping, perl
		123	evaluation, web-browser starting etc.), depending on content.
		124
		125	Other extensions can extend this popup menu by pushing a code reference
		126	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
		127	popup is being displayed.
		128
		129	Its sole argument is the popup menu, which can be modified. The selection
		130	is in C<$_>, which can be used to decide whether to add something or not.
		131	It should either return nothing or a string and a code reference. The
		132	string will be used as button text and the code reference will be called
		133	when the button gets activated and should transform C<$_>.
		134
		135	The following will add an entry C<a to b> that transforms all C<a>s in
		136	the selection to C<b>s, but only if the selection currently contains any
		137	C<a>s:
		138
		139	push @{ $self->{term}{selection_popup_hook} }, sub {
		140	/a/ ? ("a to b" => sub { s/a/b/g }
		141	: ()
		142	};
		143
		144	=item searchable-scrollback<hotkey> (enabled by default)
		145
		146	Adds regex search functionality to the scrollback buffer, triggered
		147	by a hotkey (default: C<M-s>). While in search mode, normal terminal
		148	input/output is suspended and a regex is displayed at the bottom of the
		149	screen.
		150
		151	Inputting characters appends them to the regex and continues incremental
		152	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		153	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		154	bottom. C<Escape> leaves search mode and returns to the point where search
		155	was started, while C<Enter> or C<Return> stay at the current position and
		156	additionally stores the first match in the current line into the primary
		157	selection if the C<Shift> modifier is active.
		158
		159	The regex defaults to "(?i)", resulting in a case-insensitive search. To
		160	get a case-sensitive search you can delete this prefix using C<BackSpace>
		161	or simply use an uppercase character which removes the "(?i)" prefix.
		162
		163	See L<perlre> for more info about perl regular expression syntax.
		164
		165	=item readline (enabled by default)
		166
		167	A support package that tries to make editing with readline easier. At
		168	the moment, it reacts to clicking shift-left mouse button by trying to
		169	move the text cursor to this position. It does so by generating as many
		170	cursor-left or cursor-right keypresses as required (this only works
		171	for programs that correctly support wide characters).
		172
		173	To avoid too many false positives, this is only done when:
		174
		175	=over 4
		176
		177	=item - the tty is in ICANON state.
		178
		179	=item - the text cursor is visible.
		180
		181	=item - the primary screen is currently being displayed.
		182
		183	=item - the mouse is on the same (multi-row-) line as the text cursor.
		184
		185	=back
		186
		187	The normal selection mechanism isn't disabled, so quick successive clicks
		188	might interfere with selection creation in harmless ways.
		189
		190	=item selection-autotransform
		191
		192	This selection allows you to do automatic transforms on a selection
		193	whenever a selection is made.
		194
		195	It works by specifying perl snippets (most useful is a single C<s///>
		196	operator) that modify C<$_> as resources:
		197
		198	URxvt.selection-autotransform.0: transform
		199	URxvt.selection-autotransform.1: transform
		200	...
		201
		202	For example, the following will transform selections of the form
		203	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		204	$word>:
		205
		206	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		207
		208	And this example matches the same,but replaces it with vi-commands you can
		209	paste directly into your (vi :) editor:
		210
		211	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		212
		213	Of course, this can be modified to suit your needs and your editor :)
		214
		215	To expand the example above to typical perl error messages ("XXX at
		216	FILENAME line YYY."), you need a slightly more elaborate solution:
		217
		218	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		219	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		220
		221	The first line tells the selection code to treat the unchanging part of
		222	every error message as a selection pattern, and the second line transforms
		223	the message into vi commands to load the file.
		224
		225	=item tabbed
		226
		227	This transforms the terminal into a tabbar with additional terminals, that
		228	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
		229	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		230	button per tab.
		231
		232	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		233	B<Shift-Right> will switch to the tab left or right of the current one,
		234	while B<Shift-Down> creates a new tab.
		235
		236	The tabbar itself can be configured similarly to a normal terminal, but
		237	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		238	following four resources (shown with defaults):
		239
		240	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		241	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		242	URxvt.tabbed.tab-fg: <colour-index, default 0>
		243	URxvt.tabbed.tab-bg: <colour-index, default 1>
		244
		245	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		246	indices.
		247
		248	=item matcher
		249
		250	Uses per-line display filtering (C<on_line_update>) to underline text
		251	matching a certain pattern and make it clickable. When clicked with the
		252	mouse button specified in the C<matcher.button> resource (default 2, or
		253	middle), the program specified in the C<matcher.launcher> resource
		254	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
		255	with the matched text as first argument. The default configuration is
		256	suitable for matching URLs and launching a web browser, like the
		257	former "mark-urls" extension.
		258
		259	The default pattern to match URLs can be overridden with the
		260	C<matcher.pattern.0> resource, and additional patterns can be specified
		261	with numbered patterns, in a manner similar to the "selection" extension.
		262	The launcher can also be overridden on a per-pattern basis.
		263
		264	It is possible to activate the most recently seen match 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
56	=item digital-clock	322	=item digital-clock
57		323
58	Displays a digital clock using the built-in overlay.	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.
59		393
60	=item example-refresh-hooks	394	=item example-refresh-hooks
61		395
62	Displays a very simple digital clock in the upper right corner of the	396	Displays a very simple digital clock in the upper right corner of the
63	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
64	overlays or changes.	398	overlays or changes.
65		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
66	=back	413	=back
		414
		415	=head1 API DOCUMENTATION
67		416
68	=head2 General API Considerations	417	=head2 General API Considerations
69		418
70	All objects (such as terminals, time watchers etc.) are typical	419	All objects (such as terminals, time watchers etc.) are typical
71	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
72	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
73	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
74	modified).	423	modified).
75		424
76	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
77	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
78	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
79	terminal is destroyed.	428	terminal is destroyed.
80		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
81	=head2 Hooks	493	=head2 Hooks
82		494
83	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
84	whenever the relevant event happens.	496	called whenever the relevant event happens.
85		497
86	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
87	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
88	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.
89		504
90	When in doubt, return a false value (preferably C<()>).	505	I<< When in doubt, return a false value (preferably C<()>). >>
91		506
92	=over 4	507	=over 4
93		508
94	=item on_init $term	509	=item on_init $term
95		510
96	Called after a new terminal object has been initialized, but before	511	Called after a new terminal object has been initialized, but before
97	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).
98		527
99	=item on_reset $term	528	=item on_reset $term
100		529
101	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
102	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
103	variables.	532	variables.
104		533
105	=item on_start $term	534	=item on_child_start $term, $pid
106		535
107	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.
108	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>.
109		542
110	=item on_sel_make $term, $eventtime	543	=item on_sel_make $term, $eventtime
111		544
112	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
113	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
…		…
120		553
121	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
122	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
123	by calling C<< $term->selection >>.	556	by calling C<< $term->selection >>.
124		557
125	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.
126		559
127	=item on_focus_in $term	560	=item on_sel_extend $term
128		561
129	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
130	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.
131		568
132	=item on_focus_out $term	569	See the F<selection> example extension.
133
134	Called wheneever the window loses keyboard focus, before urxvt does focus
135	out processing.
136		570
137	=item on_view_change $term, $offset	571	=item on_view_change $term, $offset
138		572
139	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
140	scrolls. Offset C<0> means display the normal terminal, positive values	574	scrolls. Offset C<0> means display the normal terminal, positive values
141	show this many lines of scrollback.	575	show this many lines of scrollback.
142		576
143	=item on_scroll_back $term, $lines, $saved	577	=item on_scroll_back $term, $lines, $saved
144		578
…		…
148		582
149	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,
150	$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
151	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
152		586
153	=item on_tty_activity $term *NYI*	587	=item on_osc_seq $term, $op, $args, $resp
154		588
155	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.
156		656
157	=item on_refresh_begin $term	657	=item on_refresh_begin $term
158		658
159	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
160	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
161	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
162	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
163		663
164	=item on_refresh_end $term	664	=item on_refresh_end $term
165		665
166	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>.
167		667
168	=item on_keyboard_command $term, $string	668	=item on_user_command $term, $string
169		669
170	Called whenever the user presses a key combination that has a	670	Called whenever a user-configured event is being activated (e.g. via
171	C<perl:string> action bound to it (see description of the B<keysym>	671	a C<perl:string> action bound to a key, see description of the B<keysym>
172	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
173		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
174	=back	753	=back
175		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
176	=head2 Functions in the C<urxvt> Package	820	=head2 Functions in the C<urxvt> Package
177		821
178	=over 4	822	=over 4
179		823
180	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
181		825
182	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
183	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
184	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
185		830
186	=item urxvt::warn $string	831	=item urxvt::warn $string
187		832
188	Calls C<rxvt_warn> with the given string which should not include a	833	Calls C<rxvt_warn> with the given string which should include a trailing
189	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
190	that calls this function.	835	that calls this function.
191		836
192	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
193	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
194		839
		840	Messages have a size limit of 1023 bytes currently.
		841
		842	=item @terms = urxvt::termlist
		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).
		848
195	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
196		850
197	Returns the "current time" (as per the event loop).	851	Returns the "current time" (as per the event loop).
		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
198		878
199	=head2 RENDITION	879	=head2 RENDITION
200		880
201	Rendition bitsets contain information about colour, font, font styles and	881	Rendition bitsets contain information about colour, font, font styles and
202	similar information for each screen cell.	882	similar information for each screen cell.
…		…
215		895
216	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
217		897
218	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
219		899
220	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	900	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		901	urxvt::RS_RVid, urxvt::RS_Uline
221		902
222	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
223	underline, respectively. To enable such a style, just logically OR it into	904	underline, respectively. To enable such a style, just logically OR it into
224	the bitset.	905	the bitset.
225		906
…		…
227		908
228	=item $background = urxvt::GET_BASEBG $rend	909	=item $background = urxvt::GET_BASEBG $rend
229		910
230	Return the foreground/background colour index, respectively.	911	Return the foreground/background colour index, respectively.
231		912
232	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	913	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
233		914
234	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	915	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		916
		917	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
235		918
236	Replace the foreground/background colour in the rendition mask with the	919	Replace the foreground/background colour in the rendition mask with the
237	specified one.	920	specified one.
238		921
239	=item $value = urxvt::GET_CUSTOM ($rend)	922	=item $value = urxvt::GET_CUSTOM $rend
240		923
241	Return the "custom" value: Every rendition has 5 bits for use by	924	Return the "custom" value: Every rendition has 5 bits for use by
242	extensions. They can be set and changed as you like and are initially	925	extensions. They can be set and changed as you like and are initially
243	zero.	926	zero.
244		927
245	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	928	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
246		929
247	Change the custom value.	930	Change the custom value.
248		931
249	=back	932	=back
250		933
251	=cut	934	=cut
252		935
253	package urxvt;
254
255	use strict;
256
257	our $term;
258	our @HOOKNAME;
259	our $LIBDIR;
260
261	BEGIN {	936	BEGIN {
262	urxvt->bootstrap;
263
264	# overwrite perl's warn	937	# overwrite perl's warn
265	*CORE::GLOBAL::warn = sub {	938	*CORE::GLOBAL::warn = sub {
266	my $msg = join "", @_;	939	my $msg = join "", @_;
267	$msg .= "\n"	940	$msg .= "\n"
268	unless $msg =~ /\n$/;	941	unless $msg =~ /\n$/;
269	urxvt::warn ($msg);	942	urxvt::warn ($msg);
270	};	943	};
271	}	944	}
272		945
273	my @hook_count;	946	no warnings 'utf8';
		947
		948	sub resource {
		949	my ($term, $name, $isarg, $flag, $value) = @_;
		950
		951	warn "resourece<@_>\n";#d#
		952
		953	0
		954	}
		955
274	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	956	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
275		957
276	sub verbose {	958	sub verbose {
277	my ($level, $msg) = @_;	959	my ($level, $msg) = @_;
278	warn "$msg\n" if $level <= $verbosity;	960	warn "$msg\n" if $level <= $verbosity;
279	}	961	}
280		962
281	# find on_xxx subs in the package and register them	963	my %extension_pkg;
282	# as hooks
283	sub register_package($) {
284	my ($pkg) = @_;
285
286	for my $htype (0.. $#HOOKNAME) {
287	my $name = $HOOKNAME[$htype];
288
289	my $ref = $pkg->can ("on_" . lc $name)
290	or next;
291
292	$term->{_hook}[$htype]{$ref*1} = $ref;
293	$hook_count[$htype]++
294	or set_should_invoke $htype, 1;
295	}
296	}
297
298	my $script_pkg = "script0000";
299	my %script_pkg;
300		964
301	# load a single script into its own package, once only	965	# load a single script into its own package, once only
302	sub script_package($) {	966	sub extension_package($) {
303	my ($path) = @_;	967	my ($path) = @_;
304		968
305	$script_pkg{$path} ||= do {	969	$extension_pkg{$path} ||= do {
306	my $pkg = "urxvt::" . ($script_pkg++);	970	$path =~ /([^\/\\]+)$/;
		971	my $pkg = $1;
		972	$pkg =~ s/[^[:word:]]/_/g;
		973	$pkg = "urxvt::ext::$pkg";
307		974
308	verbose 3, "loading script '$path' into package '$pkg'";	975	verbose 3, "loading extension '$path' into package '$pkg'";
309		976
310	open my $fh, "<:raw", $path	977	open my $fh, "<:raw", $path
311	or die "$path: $!";	978	or die "$path: $!";
312		979
313	my $source = "package $pkg; use strict; use utf8;\n"	980	my $source =
		981	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
314	. "#line 1 \"$path\"\n{\n"	982	. "#line 1 \"$path\"\n{\n"
315	. (do { local $/; <$fh> })	983	. (do { local $/; <$fh> })
316	. "\n};\n1";	984	. "\n};\n1";
317		985
		986	eval $source
318	eval $source or die "$path: $@";	987	or die "$path: $@";
319		988
320	$pkg	989	$pkg
321	}	990	}
322	}	991	}
323		992
		993	our $retval; # return value for urxvt
		994
324	# called by the rxvt core	995	# called by the rxvt core
325	sub invoke {	996	sub invoke {
326	local $term = shift;	997	local $TERM = shift;
327	my $htype = shift;	998	my $htype = shift;
328		999
329	if ($htype == 0) { # INIT	1000	if ($htype == 0) { # INIT
330	my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");	1001	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl");
331		1002
332	for my $ext (split /:/, $term->resource ("perl_ext")) {	1003	my %ext_arg;
		1004
		1005	{
		1006	my @init = @TERM_INIT;
		1007	@TERM_INIT = ();
		1008	$_->($TERM) for @init;
		1009	my @pkg = @TERM_EXT;
		1010	@TERM_EXT = ();
		1011	$TERM->register_package ($_) for @pkg;
		1012	}
		1013
		1014	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
		1015	if ($_ eq "default") {
		1016	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
		1017	} elsif (/^-(.*)$/) {
		1018	delete $ext_arg{$1};
		1019	} elsif (/^([^<]+)<(.*)>$/) {
		1020	push @{ $ext_arg{$1} }, $2;
		1021	} else {
		1022	$ext_arg{$_} ||= [];
		1023	}
		1024	}
		1025
		1026	for my $ext (sort keys %ext_arg) {
333	my @files = grep -f $_, map "$_/$ext", @dirs;	1027	my @files = grep -f $_, map "$_/$ext", @dirs;
334		1028
335	if (@files) {	1029	if (@files) {
336	register_package script_package $files[0];	1030	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
337	} else {	1031	} else {
338	warn "perl extension '$ext' not found in perl library search path\n";	1032	warn "perl extension '$ext' not found in perl library search path\n";
339	}	1033	}
340	}	1034	}
341		1035
		1036	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		1037	warn $@ if $@;
		1038	}
		1039
		1040	$retval = undef;
		1041
		1042	if (my $cb = $TERM->{_hook}[$htype]) {
		1043	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
		1044	if $verbosity >= 10;
		1045
		1046	for my $pkg (keys %$cb) {
		1047	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
		1048	$retval ||= $retval_;
		1049
		1050	if ($@) {
		1051	$TERM->ungrab; # better to lose the grab than the session
		1052	warn $@;
		1053	}
		1054	}
		1055
		1056	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		1057	if $verbosity >= 11;
		1058	}
		1059
342	} elsif ($htype == 1) { # DESTROY	1060	if ($htype == 1) { # DESTROY
343	if (my $hook = $term->{_hook}) {	1061	# clear package objects
344	for my $htype (0..$#$hook) {	1062	%$_ = () for values %{ $TERM->{_pkg} };
345	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }	1063
346	or set_should_invoke $htype, 0;	1064	# clear package
		1065	%$TERM = ();
		1066	}
		1067
		1068	$retval
		1069	}
		1070
		1071	sub SET_COLOR($$$) {
		1072	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1073	}
		1074
		1075	sub rend2mask {
		1076	no strict 'refs';
		1077	my ($str, $mask) = (@_, 0);
		1078	my %color = ( fg => undef, bg => undef );
		1079	my @failed;
		1080	for my $spec ( split /\s+/, $str ) {
		1081	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1082	$color{lc($1)} = $2;
		1083	} else {
		1084	my $neg = $spec =~ s/^[-^]//;
		1085	unless ( exists &{"RS_$spec"} ) {
		1086	push @failed, $spec;
		1087	next;
		1088	}
		1089	my $cur = &{"RS_$spec"};
		1090	if ( $neg ) {
		1091	$mask &= ~$cur;
		1092	} else {
		1093	$mask |= $cur;
347	}	1094	}
348	}	1095	}
349	}	1096	}
		1097	($mask, @color{qw(fg bg)}, \@failed)
		1098	}
350		1099
351	my $cb = $term->{_hook}[$htype]	1100	# urxvt::term::extension
352	or return;
353		1101
354	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"	1102	package urxvt::term::extension;
355	if $verbosity >= 10;
356		1103
		1104	sub enable {
		1105	my ($self, %hook) = @_;
		1106	my $pkg = $self->{_pkg};
		1107
357	while (my ($k, $v) = each %$cb) {	1108	while (my ($name, $cb) = each %hook) {
358	return 1 if $v->($term, @_);	1109	my $htype = $HOOKTYPE{uc $name};
		1110	defined $htype
		1111	or Carp::croak "unsupported hook type '$name'";
		1112
		1113	$self->set_should_invoke ($htype, +1)
		1114	unless exists $self->{term}{_hook}[$htype]{$pkg};
		1115
		1116	$self->{term}{_hook}[$htype]{$pkg} = $cb;
359	}	1117	}
		1118	}
360		1119
		1120	sub disable {
		1121	my ($self, @hook) = @_;
		1122	my $pkg = $self->{_pkg};
		1123
		1124	for my $name (@hook) {
		1125	my $htype = $HOOKTYPE{uc $name};
		1126	defined $htype
		1127	or Carp::croak "unsupported hook type '$name'";
		1128
		1129	$self->set_should_invoke ($htype, -1)
		1130	if delete $self->{term}{_hook}[$htype]{$pkg};
361	0	1131	}
362	}	1132	}
363		1133
364	=back	1134	our $AUTOLOAD;
		1135
		1136	sub AUTOLOAD {
		1137	$AUTOLOAD =~ /:([^:]+)$/
		1138	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
		1139
		1140	eval qq{
		1141	sub $AUTOLOAD {
		1142	my \$proxy = shift;
		1143	\$proxy->{term}->$1 (\@_)
		1144	}
		1145	1
		1146	} or die "FATAL: unable to compile method forwarder: $@";
		1147
		1148	goto &$AUTOLOAD;
		1149	}
		1150
		1151	sub DESTROY {
		1152	# nop
		1153	}
		1154
		1155	# urxvt::destroy_hook
		1156
		1157	sub urxvt::destroy_hook::DESTROY {
		1158	${$_[0]}->();
		1159	}
		1160
		1161	sub urxvt::destroy_hook(&) {
		1162	bless \shift, urxvt::destroy_hook::
		1163	}
		1164
		1165	package urxvt::anyevent;
		1166
		1167	=head2 The C<urxvt::anyevent> Class
		1168
		1169	The sole purpose of this class is to deliver an interface to the
		1170	C<AnyEvent> module - any module using it will work inside urxvt without
		1171	further programming. The only exception is that you cannot wait on
		1172	condition variables, but non-blocking condvar use is ok. What this means
		1173	is that you cannot use blocking APIs, but the non-blocking variant should
		1174	work.
		1175
		1176	=cut
		1177
		1178	our $VERSION = '5.23';
		1179
		1180	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		1181	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		1182
		1183	sub timer {
		1184	my ($class, %arg) = @_;
		1185
		1186	my $cb = $arg{cb};
		1187
		1188	urxvt::timer
		1189	->new
		1190	->after ($arg{after}, $arg{interval})
		1191	->cb ($arg{interval} ? $cb : sub {
		1192	$_[0]->stop; # need to cancel manually
		1193	$cb->();
		1194	})
		1195	}
		1196
		1197	sub io {
		1198	my ($class, %arg) = @_;
		1199
		1200	my $cb = $arg{cb};
		1201	my $fd = fileno $arg{fh};
		1202	defined $fd or $fd = $arg{fh};
		1203
		1204	bless [$arg{fh}, urxvt::iow
		1205	->new
		1206	->fd ($fd)
		1207	->events (($arg{poll} =~ /r/ ? 1 : 0)
		1208	| ($arg{poll} =~ /w/ ? 2 : 0))
		1209	->start
		1210	->cb ($cb)
		1211	], urxvt::anyevent::
		1212	}
		1213
		1214	sub idle {
		1215	my ($class, %arg) = @_;
		1216
		1217	my $cb = $arg{cb};
		1218
		1219	urxvt::iw
		1220	->new
		1221	->start
		1222	->cb ($cb)
		1223	}
		1224
		1225	sub child {
		1226	my ($class, %arg) = @_;
		1227
		1228	my $cb = $arg{cb};
		1229
		1230	urxvt::pw
		1231	->new
		1232	->start ($arg{pid})
		1233	->cb (sub {
		1234	$_[0]->stop; # need to cancel manually
		1235	$cb->($_[0]->rpid, $_[0]->rstatus);
		1236	})
		1237	}
		1238
		1239	sub DESTROY {
		1240	$_[0][1]->stop;
		1241	}
		1242
		1243	# only needed for AnyEvent < 6 compatibility
		1244	sub one_event {
		1245	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
		1246	}
		1247
		1248	package urxvt::term;
365		1249
366	=head2 The C<urxvt::term> Class	1250	=head2 The C<urxvt::term> Class
367		1251
368	=over 4	1252	=over 4
		1253
		1254	=cut
		1255
		1256	# find on_xxx subs in the package and register them
		1257	# as hooks
		1258	sub register_package {
		1259	my ($self, $pkg, $argv) = @_;
		1260
		1261	no strict 'refs';
		1262
		1263	urxvt::verbose 6, "register package $pkg to $self";
		1264
		1265	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1266
		1267	my $proxy = bless {
		1268	_pkg => $pkg,
		1269	argv => $argv,
		1270	}, $pkg;
		1271	Scalar::Util::weaken ($proxy->{term} = $self);
		1272
		1273	$self->{_pkg}{$pkg} = $proxy;
		1274
		1275	for my $name (@HOOKNAME) {
		1276	if (my $ref = $pkg->can ("on_" . lc $name)) {
		1277	$proxy->enable ($name => $ref);
		1278	}
		1279	}
		1280	}
		1281
		1282	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1283
		1284	Creates a new terminal, very similar as if you had started it with system
		1285	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1286	hash which defines the environment of the new terminal.
		1287
		1288	Croaks (and probably outputs an error message) if the new instance
		1289	couldn't be created. Returns C<undef> if the new instance didn't
		1290	initialise perl, and the terminal object otherwise. The C<init> and
		1291	C<start> hooks will be called before this call returns, and are free to
		1292	refer to global data (which is race free).
		1293
		1294	=cut
		1295
		1296	sub new {
		1297	my ($class, $env, @args) = @_;
		1298
		1299	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1300	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1301
		1302	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1303	}
		1304
		1305	=item $term->destroy
		1306
		1307	Destroy the terminal object (close the window, free resources
		1308	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1309	watchers (timers, io watchers) are still active.
		1310
		1311	=item $term->exec_async ($cmd[, @args])
		1312
		1313	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1314	("starts") programs in the background. This function takes care of setting
		1315	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1316	be preferred over explicit calls to C<exec> or C<system>.
		1317
		1318	Returns the pid of the subprocess or C<undef> on error.
		1319
		1320	=cut
		1321
		1322	sub exec_async {
		1323	my $self = shift;
		1324
		1325	my $pid = fork;
		1326
		1327	return $pid
		1328	if !defined $pid or $pid;
		1329
		1330	%ENV = %{ $self->env };
		1331
		1332	exec @_;
		1333	urxvt::_exit 255;
		1334	}
		1335
		1336	=item $isset = $term->option ($optval[, $set])
		1337
		1338	Returns true if the option specified by C<$optval> is enabled, and
		1339	optionally change it. All option values are stored by name in the hash
		1340	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		1341
		1342	Here is a likely non-exhaustive list of option names, please see the
		1343	source file F</src/optinc.h> to see the actual list:
		1344
		1345	borderLess buffered console cursorBlink cursorUnderline hold iconic
		1346	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1347	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
		1348	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
		1349	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
		1350	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1351	urgentOnBell utmpInhibit visualBell
369		1352
370	=item $value = $term->resource ($name[, $newval])	1353	=item $value = $term->resource ($name[, $newval])
371		1354
372	Returns the current resource value associated with a given name and	1355	Returns the current resource value associated with a given name and
373	optionally sets a new value. Setting values is most useful in the C<init>	1356	optionally sets a new value. Setting values is most useful in the C<init>
…		…
382	likely change).	1365	likely change).
383		1366
384	Please note that resource strings will currently only be freed when the	1367	Please note that resource strings will currently only be freed when the
385	terminal is destroyed, so changing options frequently will eat memory.	1368	terminal is destroyed, so changing options frequently will eat memory.
386		1369
387	Here is a a likely non-exhaustive list of resource names, not all of which	1370	Here is a likely non-exhaustive list of resource names, not all of which
388	are supported in every build, please see the source to see the actual	1371	are supported in every build, please see the source file F</src/rsinc.h>
389	list:	1372	to see the actual list:
390		1373
391	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1374	answerbackstring backgroundPixmap backspace_key blendtype blurradius
392	borderLess color cursorBlink cursorUnderline cutchars delete_key	1375	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
393	display_name embed ext_bwidth fade font geometry hold iconName	1376	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
394	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1377	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1378	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
395	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1379	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
396	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext	1380	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
397	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1381	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
398	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1382	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
399	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1383	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
400	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1384	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
401	shade term_name title transparent transparent_all tripleclickwords	1385	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1386	term_name title transient_for transparent tripleclickwords urgentOnBell
402	utmpInhibit visualBell	1387	utmpInhibit visualBell
403		1388
404	=cut	1389	=cut
405		1390
406	sub urxvt::term::resource($$;$) {	1391	sub resource($$;$) {
407	my ($self, $name) = (shift, shift);	1392	my ($self, $name) = (shift, shift);
408	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1393	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
409	goto &urxvt::term::_resource;	1394	goto &urxvt::term::_resource
410	}	1395	}
		1396
		1397	=item $value = $term->x_resource ($pattern)
		1398
		1399	Returns the X-Resource for the given pattern, excluding the program or
		1400	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1401	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1402	resource with that pattern exists.
		1403
		1404	This method should only be called during the C<on_start> hook, as there is
		1405	only one resource database per display, and later invocations might return
		1406	the wrong resources.
		1407
		1408	=item $success = $term->parse_keysym ($key, $octets)
		1409
		1410	Adds a key binding exactly as specified via a resource. See the
		1411	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1412
		1413	=item $term->register_command ($keysym, $modifiermask, $string)
		1414
		1415	Adds a key binding. This is a lower level api compared to
		1416	C<parse_keysym>, as it expects a parsed key description, and can be
		1417	used only inside either the C<on_init> hook, to add a binding, or the
		1418	C<on_register_command> hook, to modify a parsed binding.
		1419
		1420	=item $rend = $term->rstyle ([$new_rstyle])
		1421
		1422	Return and optionally change the current rendition. Text that is output by
		1423	the terminal application will use this style.
		1424
		1425	=item ($row, $col) = $term->screen_cur ([$row, $col])
		1426
		1427	Return the current coordinates of the text cursor position and optionally
		1428	set it (which is usually bad as applications don't expect that).
411		1429
412	=item ($row, $col) = $term->selection_mark ([$row, $col])	1430	=item ($row, $col) = $term->selection_mark ([$row, $col])
413		1431
414	=item ($row, $col) = $term->selection_beg ([$row, $col])	1432	=item ($row, $col) = $term->selection_beg ([$row, $col])
415		1433
416	=item ($row, $col) = $term->selection_end ([$row, $col])	1434	=item ($row, $col) = $term->selection_end ([$row, $col])
417		1435
418	Return the current values of the selection mark, begin or end positions,	1436	Return the current values of the selection mark, begin or end positions.
419	and optionally set them to new values.
420		1437
		1438	When arguments are given, then the selection coordinates are set to
		1439	C<$row> and C<$col>, and the selection screen is set to the current
		1440	screen.
		1441
		1442	=item $screen = $term->selection_screen ([$screen])
		1443
		1444	Returns the current selection screen, and then optionally sets it.
		1445
		1446	=item $term->selection_make ($eventtime[, $rectangular])
		1447
		1448	Tries to make a selection as set by C<selection_beg> and
		1449	C<selection_end>. If C<$rectangular> is true (default: false), a
		1450	rectangular selection will be made. This is the preferred function to make
		1451	a selection.
		1452
421	=item $success = $term->selection_grab ($eventtime)	1453	=item $success = $term->selection_grab ($eventtime[, $clipboard])
422		1454
423	Try to request the primary selection from the server (for example, as set	1455	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
424	by the next method).	1456	true) selection from the server. The corresponding text can be set
		1457	with the next method. No visual feedback will be given. This function
		1458	is mostly useful from within C<on_sel_grab> hooks.
425		1459
426	=item $oldtext = $term->selection ([$newtext])	1460	=item $oldtext = $term->selection ([$newtext, $clipboard])
427		1461
428	Return the current selection text and optionally replace it by C<$newtext>.	1462	Return the current selection (clipboard if C<$clipboard> is true) text
		1463	and optionally replace it by C<$newtext>.
429		1464
		1465	=item $term->selection_clear ([$clipboard])
		1466
		1467	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
		1468
430	#=item $term->overlay ($x, $y, $text)	1469	=item $term->overlay_simple ($x, $y, $text)
431	#	1470
432	#Create a simple multi-line overlay box. See the next method for details.	1471	Create a simple multi-line overlay box. See the next method for details.
433	#	1472
434	#=cut	1473	=cut
435		1474
436	sub urxvt::term::scr_overlay {	1475	sub overlay_simple {
437	die;
438	my ($self, $x, $y, $text) = @_;	1476	my ($self, $x, $y, $text) = @_;
439		1477
440	my @lines = split /\n/, $text;	1478	my @lines = split /\n/, $text;
441		1479
442	my $w = 0;	1480	my $w = List::Util::max map $self->strwidth ($_), @lines;
443	for (map $self->strwidth ($_), @lines) {
444	$w = $_ if $w < $_;
445	}
446		1481
447	$self->scr_overlay_new ($x, $y, $w, scalar @lines);	1482	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
448	$self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1483	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
		1484
		1485	$overlay
449	}	1486	}
450		1487
451	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1488	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
452		1489
453	Create a new (empty) overlay at the given position with the given	1490	Create a new (empty) overlay at the given position with the given
…		…
461	right/bottom side, respectively.	1498	right/bottom side, respectively.
462		1499
463	This method returns an urxvt::overlay object. The overlay will be visible	1500	This method returns an urxvt::overlay object. The overlay will be visible
464	as long as the perl object is referenced.	1501	as long as the perl object is referenced.
465		1502
466	Currently, the only method on the C<urxvt::overlay> object is C<set>:	1503	The methods currently supported on C<urxvt::overlay> objects are:
467		1504
		1505	=over 4
		1506
468	=item $overlay->set ($x, $y, $text, $rend)	1507	=item $overlay->set ($x, $y, $text[, $rend])
469		1508
470	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1509	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
471	text in rxvt-unicode's special encoding and an array of rendition values	1510	text in rxvt-unicode's special encoding and an array of rendition values
472	at a specific position inside the overlay.	1511	at a specific position inside the overlay.
473		1512
		1513	If C<$rend> is missing, then the rendition will not be changed.
		1514
		1515	=item $overlay->hide
		1516
		1517	If visible, hide the overlay, but do not destroy it.
		1518
		1519	=item $overlay->show
		1520
		1521	If hidden, display the overlay again.
		1522
		1523	=back
		1524
		1525	=item $popup = $term->popup ($event)
		1526
		1527	Creates a new C<urxvt::popup> object that implements a popup menu. The
		1528	C<$event> I<must> be the event causing the menu to pop up (a button event,
		1529	currently).
		1530
		1531	=cut
		1532
		1533	sub popup {
		1534	my ($self, $event) = @_;
		1535
		1536	$self->grab ($event->{time}, 1)
		1537	or return;
		1538
		1539	my $popup = bless {
		1540	term => $self,
		1541	event => $event,
		1542	}, urxvt::popup::;
		1543
		1544	Scalar::Util::weaken $popup->{term};
		1545
		1546	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		1547	Scalar::Util::weaken $self->{_destroy}{$popup};
		1548
		1549	$popup
		1550	}
		1551
474	=item $cellwidth = $term->strwidth $string	1552	=item $cellwidth = $term->strwidth ($string)
475		1553
476	Returns the number of screen-cells this string would need. Correctly	1554	Returns the number of screen-cells this string would need. Correctly
477	accounts for wide and combining characters.	1555	accounts for wide and combining characters.
478		1556
479	=item $octets = $term->locale_encode $string	1557	=item $octets = $term->locale_encode ($string)
480		1558
481	Convert the given text string into the corresponding locale encoding.	1559	Convert the given text string into the corresponding locale encoding.
482		1560
483	=item $string = $term->locale_decode $octets	1561	=item $string = $term->locale_decode ($octets)
484		1562
485	Convert the given locale-encoded octets into a perl string.	1563	Convert the given locale-encoded octets into a perl string.
486		1564
		1565	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1566
		1567	XORs the rendition values in the given span with the provided value
		1568	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1569	refresh hooks to provide effects similar to the selection.
		1570
		1571	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1572
		1573	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1574	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1575	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
		1576	it instead. Both styles I<MUST NOT> contain font styles.
		1577
		1578	=item $term->scr_bell
		1579
		1580	Ring the bell!
		1581
		1582	=item $term->scr_add_lines ($string)
		1583
		1584	Write the given text string to the screen, as if output by the application
		1585	running inside the terminal. It may not contain command sequences (escape
		1586	codes), but is free to use line feeds, carriage returns and tabs. The
		1587	string is a normal text string, not in locale-dependent encoding.
		1588
		1589	Normally its not a good idea to use this function, as programs might be
		1590	confused by changes in cursor position or scrolling. Its useful inside a
		1591	C<on_add_lines> hook, though.
		1592
		1593	=item $term->scr_change_screen ($screen)
		1594
		1595	Switch to given screen - 0 primary, 1 secondary.
		1596
		1597	=item $term->cmd_parse ($octets)
		1598
		1599	Similar to C<scr_add_lines>, but the argument must be in the
		1600	locale-specific encoding of the terminal and can contain command sequences
		1601	(escape codes) that will be interpreted.
		1602
487	=item $term->tt_write ($octets)	1603	=item $term->tt_write ($octets)
488		1604
489	Write the octets given in C<$data> to the tty (i.e. as program input). To	1605	Write the octets given in C<$octets> to the tty (i.e. as program input). To
490	pass characters instead of octets, you should convert your strings first	1606	pass characters instead of octets, you should convert your strings first
491	to the locale-specific encoding using C<< $term->locale_encode >>.	1607	to the locale-specific encoding using C<< $term->locale_encode >>.
492		1608
		1609	=item $term->tt_paste ($octets)
		1610
		1611	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1612	CR and bracketing the data with control sequences if bracketed paste mode
		1613	is set.
		1614
		1615	=item $old_events = $term->pty_ev_events ([$new_events])
		1616
		1617	Replaces the event mask of the pty watcher by the given event mask. Can
		1618	be used to suppress input and output handling to the pty/tty. See the
		1619	description of C<< urxvt::timer->events >>. Make sure to always restore
		1620	the previous value.
		1621
		1622	=item $fd = $term->pty_fd
		1623
		1624	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1625	is used.
		1626
		1627	=item $windowid = $term->parent
		1628
		1629	Return the window id of the toplevel window.
		1630
		1631	=item $windowid = $term->vt
		1632
		1633	Return the window id of the terminal window.
		1634
		1635	=item $term->vt_emask_add ($x_event_mask)
		1636
		1637	Adds the specified events to the vt event mask. Useful e.g. when you want
		1638	to receive pointer events all the times:
		1639
		1640	$term->vt_emask_add (urxvt::PointerMotionMask);
		1641
		1642	=item $term->set_urgency ($set)
		1643
		1644	Enable/disable the urgency hint on the toplevel window.
		1645
		1646	=item $term->focus_in
		1647
		1648	=item $term->focus_out
		1649
		1650	=item $term->key_press ($state, $keycode[, $time])
		1651
		1652	=item $term->key_release ($state, $keycode[, $time])
		1653
		1654	Deliver various fake events to to terminal.
		1655
		1656	=item $window_width = $term->width
		1657
		1658	=item $window_height = $term->height
		1659
		1660	=item $font_width = $term->fwidth
		1661
		1662	=item $font_height = $term->fheight
		1663
		1664	=item $font_ascent = $term->fbase
		1665
493	=item $nrow = $term->nrow	1666	=item $terminal_rows = $term->nrow
494		1667
495	=item $ncol = $term->ncol	1668	=item $terminal_columns = $term->ncol
496		1669
497	Return the number of rows/columns of the terminal window (i.e. as	1670	=item $has_focus = $term->focus
498	specified by C<-geometry>, excluding any scrollback).
499		1671
		1672	=item $is_mapped = $term->mapped
		1673
		1674	=item $max_scrollback = $term->saveLines
		1675
		1676	=item $nrow_plus_saveLines = $term->total_rows
		1677
		1678	=item $topmost_scrollback_row = $term->top_row
		1679
		1680	Return various integers describing terminal characteristics.
		1681
		1682	=item $x_display = $term->display_id
		1683
		1684	Return the DISPLAY used by rxvt-unicode.
		1685
		1686	=item $lc_ctype = $term->locale
		1687
		1688	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1689
500	=item $nsaved = $term->nsaved	1690	=item $env = $term->env
501		1691
502	Returns the number of lines in the scrollback buffer.	1692	Returns a copy of the environment in effect for the terminal as a hashref
		1693	similar to C<\%ENV>.
		1694
		1695	=item @envv = $term->envv
		1696
		1697	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1698
		1699	=item @argv = $term->argv
		1700
		1701	Return the argument vector as this terminal, similar to @ARGV, but
		1702	includes the program name as first element.
		1703
		1704	=cut
		1705
		1706	sub env {
		1707	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
		1708	}
		1709
		1710	=item $modifiermask = $term->ModLevel3Mask
		1711
		1712	=item $modifiermask = $term->ModMetaMask
		1713
		1714	=item $modifiermask = $term->ModNumLockMask
		1715
		1716	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1717	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1718
		1719	=item $screen = $term->current_screen
		1720
		1721	Returns the currently displayed screen (0 primary, 1 secondary).
		1722
		1723	=item $cursor_is_hidden = $term->hidden_cursor
		1724
		1725	Returns whether the cursor is currently hidden or not.
503		1726
504	=item $view_start = $term->view_start ([$newvalue])	1727	=item $view_start = $term->view_start ([$newvalue])
505		1728
506	Returns the negative row number of the topmost line. Minimum value is	1729	Returns the row number of the topmost displayed line. Maximum value is
507	C<0>, which displays the normal terminal contents. Larger values scroll	1730	C<0>, which displays the normal terminal contents. Lower values scroll
508	this many lines into the scrollback buffer.	1731	this many lines into the scrollback buffer.
509		1732
510	=item $term->want_refresh	1733	=item $term->want_refresh
511		1734
512	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1735	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
515		1738
516	Used after changing terminal contents to display them.	1739	Used after changing terminal contents to display them.
517		1740
518	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1741	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
519		1742
520	Returns the text of the entire row with number C<$row_number>. Row C<0>	1743	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
521	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1744	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
522	terminal line. The scrollback buffer starts at line C<-1> and extends to	1745	terminal line. Nothing will be returned if a nonexistent line
523	line C<< -$term->nsaved >>.	1746	is requested.
524		1747
525	If C<$new_text> is specified, it will replace characters in the current	1748	If C<$new_text> is specified, it will replace characters in the current
526	line, starting at column C<$start_col> (default C<0>), which is useful	1749	line, starting at column C<$start_col> (default C<0>), which is useful
527	to replace only parts of a line. The font index in the rendition will	1750	to replace only parts of a line. The font index in the rendition will
528	automatically be updated.	1751	automatically be updated.
529		1752
530	C<$text> is in a special encoding: tabs and wide characters that use more	1753	C<$text> is in a special encoding: tabs and wide characters that use more
531	than one cell when displayed are padded with urxvt::NOCHAR characters	1754	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
532	(C<chr 65535>). Characters with combining characters and other characters	1755	characters. Characters with combining characters and other characters that
533	that do not fit into the normal tetx encoding will be replaced with	1756	do not fit into the normal text encoding will be replaced with characters
534	characters in the private use area.	1757	in the private use area.
535		1758
536	You have to obey this encoding when changing text. The advantage is	1759	You have to obey this encoding when changing text. The advantage is
537	that C<substr> and similar functions work on screen cells and not on	1760	that C<substr> and similar functions work on screen cells and not on
538	characters.	1761	characters.
539		1762
…		…
550		1773
551	See the section on RENDITION, above.	1774	See the section on RENDITION, above.
552		1775
553	=item $length = $term->ROW_l ($row_number[, $new_length])	1776	=item $length = $term->ROW_l ($row_number[, $new_length])
554		1777
555	Returns the number of screen cells that are in use ("the line length"). If	1778	Returns the number of screen cells that are in use ("the line
556	it is C<-1>, then the line is part of a multiple-row logical "line", which	1779	length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
557	means all characters are in use and it is continued on the next row.	1780	line is joined with the following one.
		1781
		1782	=item $bool = $term->is_longer ($row_number)
		1783
		1784	Returns true if the row is part of a multiple-row logical "line" (i.e.
		1785	joined with the following row), which means all characters are in use
		1786	and it is continued on the next row (and possibly a continuation of the
		1787	previous row(s)).
		1788
		1789	=item $line = $term->line ($row_number)
		1790
		1791	Create and return a new C<urxvt::line> object that stores information
		1792	about the logical line that row C<$row_number> is part of. It supports the
		1793	following methods:
		1794
		1795	=over 4
		1796
		1797	=item $text = $line->t ([$new_text])
		1798
		1799	Returns or replaces the full text of the line, similar to C<ROW_t>
		1800
		1801	=item $rend = $line->r ([$new_rend])
		1802
		1803	Returns or replaces the full rendition array of the line, similar to C<ROW_r>
		1804
		1805	=item $length = $line->l
		1806
		1807	Returns the length of the line in cells, similar to C<ROW_l>.
		1808
		1809	=item $rownum = $line->beg
		1810
		1811	=item $rownum = $line->end
		1812
		1813	Return the row number of the first/last row of the line, respectively.
		1814
		1815	=item $offset = $line->offset_of ($row, $col)
		1816
		1817	Returns the character offset of the given row|col pair within the logical
		1818	line. Works for rows outside the line, too, and returns corresponding
		1819	offsets outside the string.
		1820
		1821	=item ($row, $col) = $line->coord_of ($offset)
		1822
		1823	Translates a string offset into terminal coordinates again.
		1824
		1825	=back
		1826
		1827	=cut
		1828
		1829	sub line {
		1830	my ($self, $row) = @_;
		1831
		1832	my $maxrow = $self->nrow - 1;
		1833
		1834	my ($beg, $end) = ($row, $row);
		1835
		1836	--$beg while $self->ROW_is_longer ($beg - 1);
		1837	++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
		1838
		1839	bless {
		1840	term => $self,
		1841	beg => $beg,
		1842	end => $end,
		1843	ncol => $self->ncol,
		1844	len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
		1845	}, urxvt::line::
		1846	}
		1847
		1848	sub urxvt::line::t {
		1849	my ($self) = @_;
		1850
		1851	if (@_ > 1)
		1852	{
		1853	$self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1854	for $self->{beg} .. $self->{end};
		1855	}
		1856
		1857	defined wantarray &&
		1858	substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
		1859	0, $self->{len}
		1860	}
		1861
		1862	sub urxvt::line::r {
		1863	my ($self) = @_;
		1864
		1865	if (@_ > 1)
		1866	{
		1867	$self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
		1868	for $self->{beg} .. $self->{end};
		1869	}
		1870
		1871	if (defined wantarray) {
		1872	my $rend = [
		1873	map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
		1874	];
		1875	$#$rend = $self->{len} - 1;
		1876	return $rend;
		1877	}
		1878
		1879	()
		1880	}
		1881
		1882	sub urxvt::line::beg { $_[0]{beg} }
		1883	sub urxvt::line::end { $_[0]{end} }
		1884	sub urxvt::line::l { $_[0]{len} }
		1885
		1886	sub urxvt::line::offset_of {
		1887	my ($self, $row, $col) = @_;
		1888
		1889	($row - $self->{beg}) * $self->{ncol} + $col
		1890	}
		1891
		1892	sub urxvt::line::coord_of {
		1893	my ($self, $offset) = @_;
		1894
		1895	use integer;
		1896
		1897	(
		1898	$offset / $self->{ncol} + $self->{beg},
		1899	$offset % $self->{ncol}
		1900	)
		1901	}
558		1902
559	=item $text = $term->special_encode $string	1903	=item $text = $term->special_encode $string
560		1904
561	Converts a perl string into the special encoding used by rxvt-unicode,	1905	Converts a perl string into the special encoding used by rxvt-unicode,
562	where one character corresponds to one screen cell. See	1906	where one character corresponds to one screen cell. See
563	C<< $term->ROW_t >> for details.	1907	C<< $term->ROW_t >> for details.
564		1908
565	=item $string = $term->special_decode $text	1909	=item $string = $term->special_decode $text
566		1910
567	Converts rxvt-unicodes text reprsentation into a perl string. See	1911	Converts rxvt-unicodes text representation into a perl string. See
568	C<< $term->ROW_t >> for details.	1912	C<< $term->ROW_t >> for details.
569		1913
		1914	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
		1915
		1916	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1917
		1918	Register/unregister a synchronous button grab. See the XGrabButton
		1919	manpage.
		1920
		1921	=item $success = $term->grab ($eventtime[, $sync])
		1922
		1923	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		1924	synchronous (C<$sync> is true). Also remembers the grab timestamp.
		1925
		1926	=item $term->allow_events_async
		1927
		1928	Calls XAllowEvents with AsyncBoth for the most recent grab.
		1929
		1930	=item $term->allow_events_sync
		1931
		1932	Calls XAllowEvents with SyncBoth for the most recent grab.
		1933
		1934	=item $term->allow_events_replay
		1935
		1936	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		1937	recent grab.
		1938
		1939	=item $term->ungrab
		1940
		1941	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
		1942	evaluation errors, as it is better to lose the grab in the error case as
		1943	the session.
		1944
		1945	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1946
		1947	=item $atom_name = $term->XGetAtomName ($atom)
		1948
		1949	=item @atoms = $term->XListProperties ($window)
		1950
		1951	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1952
		1953	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		1954
		1955	=item $term->XDeleteProperty ($window, $property)
		1956
		1957	=item $window = $term->DefaultRootWindow
		1958
		1959	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1960
		1961	=item $term->XMapWindow ($window)
		1962
		1963	=item $term->XUnmapWindow ($window)
		1964
		1965	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1966
		1967	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1968
		1969	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1970
		1971	=item $keysym = $term->XStringToKeysym ($string)
		1972
		1973	=item $string = $term->XKeysymToString ($keysym)
		1974
		1975	Various X or X-related functions. The C<$term> object only serves as
		1976	the source of the display, otherwise those functions map more-or-less
		1977	directly onto the X functions of the same name.
		1978
570	=back	1979	=back
		1980
		1981	=cut
		1982
		1983	package urxvt::popup;
		1984
		1985	=head2 The C<urxvt::popup> Class
		1986
		1987	=over 4
		1988
		1989	=cut
		1990
		1991	sub add_item {
		1992	my ($self, $item) = @_;
		1993
		1994	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		1995	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		1996	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		1997
		1998	$item->{render} ||= sub { $_[0]{text} };
		1999
		2000	push @{ $self->{item} }, $item;
		2001	}
		2002
		2003	=item $popup->add_title ($title)
		2004
		2005	Adds a non-clickable title to the popup.
		2006
		2007	=cut
		2008
		2009	sub add_title {
		2010	my ($self, $title) = @_;
		2011
		2012	$self->add_item ({
		2013	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		2014	text => $title,
		2015	activate => sub { },
		2016	});
		2017	}
		2018
		2019	=item $popup->add_separator ([$sepchr])
		2020
		2021	Creates a separator, optionally using the character given as C<$sepchr>.
		2022
		2023	=cut
		2024
		2025	sub add_separator {
		2026	my ($self, $sep) = @_;
		2027
		2028	$sep ||= "=";
		2029
		2030	$self->add_item ({
		2031	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		2032	text => "",
		2033	render => sub { $sep x $self->{term}->ncol },
		2034	activate => sub { },
		2035	});
		2036	}
		2037
		2038	=item $popup->add_button ($text, $cb)
		2039
		2040	Adds a clickable button to the popup. C<$cb> is called whenever it is
		2041	selected.
		2042
		2043	=cut
		2044
		2045	sub add_button {
		2046	my ($self, $text, $cb) = @_;
		2047
		2048	$self->add_item ({ type => "button", text => $text, activate => $cb});
		2049	}
		2050
		2051	=item $popup->add_toggle ($text, $initial_value, $cb)
		2052
		2053	Adds a toggle/checkbox item to the popup. The callback gets called
		2054	whenever it gets toggled, with a boolean indicating its new value as its
		2055	first argument.
		2056
		2057	=cut
		2058
		2059	sub add_toggle {
		2060	my ($self, $text, $value, $cb) = @_;
		2061
		2062	my $item; $item = {
		2063	type => "button",
		2064	text => " $text",
		2065	value => $value,
		2066	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		2067	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
		2068	};
		2069
		2070	$self->add_item ($item);
		2071	}
		2072
		2073	=item $popup->show
		2074
		2075	Displays the popup (which is initially hidden).
		2076
		2077	=cut
		2078
		2079	sub show {
		2080	my ($self) = @_;
		2081
		2082	local $urxvt::popup::self = $self;
		2083
		2084	my $env = $self->{term}->env;
		2085	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		2086	delete $env->{LC_ALL};
		2087	$env->{LC_CTYPE} = $self->{term}->locale;
		2088
		2089	my $term = urxvt::term->new (
		2090	$env, "popup",
		2091	"--perl-lib" => "", "--perl-ext-common" => "",
		2092	"-pty-fd" => -1, "-sl" => 0,
		2093	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
		2094	"--transient-for" => $self->{term}->parent,
		2095	"-display" => $self->{term}->display_id,
		2096	"-pe" => "urxvt-popup",
		2097	) or die "unable to create popup window\n";
		2098
		2099	unless (delete $term->{urxvt_popup_init_done}) {
		2100	$term->ungrab;
		2101	$term->destroy;
		2102	die "unable to initialise popup window\n";
		2103	}
		2104	}
		2105
		2106	sub DESTROY {
		2107	my ($self) = @_;
		2108
		2109	delete $self->{term}{_destroy}{$self};
		2110	$self->{term}->ungrab;
		2111	}
		2112
		2113	=back
		2114
		2115	=cut
		2116
		2117	package urxvt::watcher;
571		2118
572	=head2 The C<urxvt::timer> Class	2119	=head2 The C<urxvt::timer> Class
573		2120
574	This class implements timer watchers/events. Time is represented as a	2121	This class implements timer watchers/events. Time is represented as a
575	fractional number of seconds since the epoch. Example:	2122	fractional number of seconds since the epoch. Example:
…		…
579	->new	2126	->new
580	->interval (1)	2127	->interval (1)
581	->cb (sub {	2128	->cb (sub {
582	$term->{overlay}->set (0, 0,	2129	$term->{overlay}->set (0, 0,
583	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2130	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
584	});	2131	});
585		2132
586	=over 4	2133	=over 4
587		2134
588	=item $timer = new urxvt::timer	2135	=item $timer = new urxvt::timer
589		2136
…		…
592		2139
593	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2140	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
594		2141
595	Set the callback to be called when the timer triggers.	2142	Set the callback to be called when the timer triggers.
596		2143
597	=item $tstamp = $timer->at
598
599	Return the time this watcher will fire next.
600
601	=item $timer = $timer->set ($tstamp)	2144	=item $timer = $timer->set ($tstamp[, $interval])
602		2145
603	Set the time the event is generated to $tstamp.	2146	Set the time the event is generated to $tstamp (and optionally specifies a
		2147	new $interval).
604		2148
605	=item $timer = $timer->interval ($interval)	2149	=item $timer = $timer->interval ($interval)
606		2150
607	Normally (and when C<$interval> is C<0>), the timer will automatically	2151	By default (and when C<$interval> is C<0>), the timer will automatically
608	stop after it has fired once. If C<$interval> is non-zero, then the timer	2152	stop after it has fired once. If C<$interval> is non-zero, then the timer
609	is automatically rescheduled at the given intervals.	2153	is automatically rescheduled at the given intervals.
610		2154
611	=item $timer = $timer->start	2155	=item $timer = $timer->start
612		2156
613	Start the timer.	2157	Start the timer.
614		2158
615	=item $timer = $timer->start ($tstamp)	2159	=item $timer = $timer->start ($tstamp[, $interval])
616		2160
617	Set the event trigger time to C<$tstamp> and start the timer.	2161	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2162	also replaces the interval.
		2163
		2164	=item $timer = $timer->after ($delay[, $interval])
		2165
		2166	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
618		2167
619	=item $timer = $timer->stop	2168	=item $timer = $timer->stop
620		2169
621	Stop the timer.	2170	Stop the timer.
622		2171
…		…
628		2177
629	$term->{socket} = ...	2178	$term->{socket} = ...
630	$term->{iow} = urxvt::iow	2179	$term->{iow} = urxvt::iow
631	->new	2180	->new
632	->fd (fileno $term->{socket})	2181	->fd (fileno $term->{socket})
633	->events (1) # wait for read data	2182	->events (urxvt::EV_READ)
634	->start	2183	->start
635	->cb (sub {	2184	->cb (sub {
636	my ($iow, $revents) = @_;	2185	my ($iow, $revents) = @_;
637	# $revents must be 1 here, no need to check	2186	# $revents must be 1 here, no need to check
638	sysread $term->{socket}, my $buf, 8192	2187	sysread $term->{socket}, my $buf, 8192
…		…
651	Set the callback to be called when io events are triggered. C<$reventmask>	2200	Set the callback to be called when io events are triggered. C<$reventmask>
652	is a bitset as described in the C<events> method.	2201	is a bitset as described in the C<events> method.
653		2202
654	=item $iow = $iow->fd ($fd)	2203	=item $iow = $iow->fd ($fd)
655		2204
656	Set the filedescriptor (not handle) to watch.	2205	Set the file descriptor (not handle) to watch.
657		2206
658	=item $iow = $iow->events ($eventmask)	2207	=item $iow = $iow->events ($eventmask)
659		2208
660	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	2209	Set the event mask to watch. The only allowed values are
661	data, Bit #1 (value C<2>) enables watching for write data.	2210	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
		2211	together, or C<urxvt::EV_NONE>.
662		2212
663	=item $iow = $iow->start	2213	=item $iow = $iow->start
664		2214
665	Start watching for requested events on the given handle.	2215	Start watching for requested events on the given handle.
666		2216
667	=item $iow = $iow->stop	2217	=item $iow = $iow->stop
668		2218
669	Stop watching for events on the given filehandle.	2219	Stop watching for events on the given file handle.
		2220
		2221	=back
		2222
		2223	=head2 The C<urxvt::iw> Class
		2224
		2225	This class implements idle watchers, that get called automatically when
		2226	the process is idle. They should return as fast as possible, after doing
		2227	some useful work.
		2228
		2229	=over 4
		2230
		2231	=item $iw = new urxvt::iw
		2232
		2233	Create a new idle watcher object in stopped state.
		2234
		2235	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2236
		2237	Set the callback to be called when the watcher triggers.
		2238
		2239	=item $timer = $timer->start
		2240
		2241	Start the watcher.
		2242
		2243	=item $timer = $timer->stop
		2244
		2245	Stop the watcher.
		2246
		2247	=back
		2248
		2249	=head2 The C<urxvt::pw> Class
		2250
		2251	This class implements process watchers. They create an event whenever a
		2252	process exits, after which they stop automatically.
		2253
		2254	my $pid = fork;
		2255	...
		2256	$term->{pw} = urxvt::pw
		2257	->new
		2258	->start ($pid)
		2259	->cb (sub {
		2260	my ($pw, $exit_status) = @_;
		2261	...
		2262	});
		2263
		2264	=over 4
		2265
		2266	=item $pw = new urxvt::pw
		2267
		2268	Create a new process watcher in stopped state.
		2269
		2270	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2271
		2272	Set the callback to be called when the timer triggers.
		2273
		2274	=item $pw = $timer->start ($pid)
		2275
		2276	Tells the watcher to start watching for process C<$pid>.
		2277
		2278	=item $pw = $pw->stop
		2279
		2280	Stop the watcher.
670		2281
671	=back	2282	=back
672		2283
673	=head1 ENVIRONMENT	2284	=head1 ENVIRONMENT
674		2285
…		…
677	This variable controls the verbosity level of the perl extension. Higher	2288	This variable controls the verbosity level of the perl extension. Higher
678	numbers indicate more verbose output.	2289	numbers indicate more verbose output.
679		2290
680	=over 4	2291	=over 4
681		2292
682	=item 0 - only fatal messages	2293	=item == 0 - fatal messages
683		2294
684	=item 3 - script loading and management	2295	=item >= 3 - script loading and management
685		2296
686	=item 10 - all events received	2297	=item >=10 - all called hooks
		2298
		2299	=item >=11 - hook return values
687		2300
688	=back	2301	=back
689		2302
690	=head1 AUTHOR	2303	=head1 AUTHOR
691		2304
692	Marc Lehmann <pcg@goof.com>	2305	Marc Lehmann <schmorp@schmorp.de>
693	http://software.schmorp.de/pkg/rxvt-unicode	2306	http://software.schmorp.de/pkg/rxvt-unicode
694		2307
695	=cut	2308	=cut
696		2309
697	1	2310	1
		2311
		2312	# vim: sw=3:

Diff Legend

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