[ViewVC] Diff of: cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.38 by root, Fri Jan 6 03:43:12 2006 UTC vs.
Revision 1.215 by root, Thu Jun 7 16:30:58 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 "vars"' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
31	=head2 Prepackaged Extensions	31	You can disable the embedded perl interpreter by setting both "perl-ext"
		32	and "perl-ext-common" resources to the empty string.
32		33
		34	=head1 PREPACKAGED EXTENSIONS
		35
33	This section describes the extensiosn delivered with this version. You can	36	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	37	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		38
36	You can activate them like this:	39	You can activate them like this:
37		40
38	@@RXVT_NAME@@ -pe <extensionname>	41	@@RXVT_NAME@@ -pe <extensionname>
39		42
		43	Or by adding them to the resource for extensions loaded by default:
		44
		45	URxvt.perl-ext-common: default,selection-autotransform
		46
40	=over 4	47	=over 4
41		48
42	=item selection	49	=item selection (enabled by default)
43		50
44	Intelligent selection. This extension tries to be more intelligent when	51	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	52	when the user extends selections (double-click and further clicks). Right
46	urls and complete shell-quoted arguments, which is very convenient, too,	53	now, it tries to select words, urls and complete shell-quoted
47	if your F<ls> supports C<--quoting-style=shell>.	54	arguments, which is very convenient, too, if your F<ls> supports
		55	C<--quoting-style=shell>.
48		56
49	It also offers the following bindable event:	57	A double-click usually selects the word under the cursor, further clicks
		58	will enlarge the selection.
		59
		60	The selection works by trying to match a number of regexes and displaying
		61	them in increasing order of length. You can add your own regexes by
		62	specifying resources of the form:
		63
		64	URxvt.selection.pattern-0: perl-regex
		65	URxvt.selection.pattern-1: perl-regex
		66	...
		67
		68	The index number (0, 1...) must not have any holes, and each regex must
		69	contain at least one pair of capturing parentheses, which will be used for
		70	the match. For example, the following adds a regex that matches everything
		71	between two vertical bars:
		72
		73	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
		74
		75	Another example: Programs I use often output "absolute path: " at the
		76	beginning of a line when they process multiple files. The following
		77	pattern matches the filename (note, there is a single space at the very
		78	end):
		79
		80	URxvt.selection.pattern-0: ^(/[^:]+):\
		81
		82	You can look at the source of the selection extension to see more
		83	interesting uses, such as parsing a line from beginning to end.
		84
		85	This extension also offers following bindable keyboard commands:
50		86
51	=over 4	87	=over 4
52		88
53	=item rot13	89	=item rot13
54		90
…		…
56		92
57	URxvt.keysym.C-M-r: perl:selection:rot13	93	URxvt.keysym.C-M-r: perl:selection:rot13
58		94
59	=back	95	=back
60		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
61	=item digital-clock	322	=item digital-clock
62		323
63	Displays a digital clock using the built-in overlay.	324	Displays a digital clock using the built-in overlay.
64		325
65	=item mark-urls	326	=item remote-clipboard
66		327
67	Uses per-line filtering (C<on_line_update>) to underline urls.	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.
68		393
69	=item example-refresh-hooks	394	=item example-refresh-hooks
70		395
71	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
72	window. Illustrates overwriting the refresh callbacks to create your own	397	window. Illustrates overwriting the refresh callbacks to create your own
73	overlays or changes.	398	overlays or changes.
74		399
75	=item example-filter-input	400	=item confirm-paste
76		401
77	A not very useful example of filtering all text output to the terminal, by	402	Displays a confirmation dialog when a paste containing at least a full
78	underlining all urls that matches a certain regex (i.e. some urls :). It	403	line is detected.
79	is not very useful because urls that are output in multiple steps (e.g.	404
80	when typing them) do not get marked.	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"
81		412
82	=back	413	=back
		414
		415	=head1 API DOCUMENTATION
83		416
84	=head2 General API Considerations	417	=head2 General API Considerations
85		418
86	All objects (such as terminals, time watchers etc.) are typical	419	All objects (such as terminals, time watchers etc.) are typical
87	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
…		…
99		432
100	=over 4	433	=over 4
101		434
102	=item $text	435	=item $text
103		436
104	Rxvt-unicodes special way of encoding text, where one "unicode" character	437	Rxvt-unicode's special way of encoding text, where one "unicode" character
105	always represents one screen cell. See L<row_t> for a discussion of this format.	438	always represents one screen cell. See L<ROW_t> for a discussion of this format.
106		439
107	=item $string	440	=item $string
108		441
109	A perl text string, with an emphasis on I<text>. It can store all unicode	442	A perl text string, with an emphasis on I<text>. It can store all unicode
110	characters and is to be distinguished with text encoded in a specific	443	characters and is to be distinguished with text encoded in a specific
…		…
113	=item $octets	446	=item $octets
114		447
115	Either binary data or - more common - a text string encoded in a	448	Either binary data or - more common - a text string encoded in a
116	locale-specific way.	449	locale-specific way.
117		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
118	=back	457	=back
119		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
120	=head2 Hooks	493	=head2 Hooks
121		494
122	The following subroutines can be declared in loaded scripts, and will be	495	The following subroutines can be declared in extension files, and will be
123	called whenever the relevant event happens.	496	called whenever the relevant event happens.
124		497
125	The first argument passed to them is an object private to each terminal	498	The first argument passed to them is an extension object as described in
126	and extension package. You can call all C<urxvt::term> methods on it, but	499	the in the C<Extension Objects> section.
127	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
128	object that is shared between all packages is stored in the C<term>
129	member.
130		500
131	All of them must return a boolean value. If it is true, then the event	501	B<All> of these hooks must return a boolean value. If any of the called
132	counts as being I<consumed>, and the invocation of other hooks is skipped,	502	hooks returns true, then the event counts as being I<consumed>, and the
133	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.
134		504
135	When in doubt, return a false value (preferably C<()>).	505	I<< When in doubt, return a false value (preferably C<()>). >>
136		506
137	=over 4	507	=over 4
138		508
139	=item on_init $term	509	=item on_init $term
140		510
141	Called after a new terminal object has been initialized, but before	511	Called after a new terminal object has been initialized, but before
142	windows are created or the command gets run. Most methods are unsafe to	512	windows are created or the command gets run. Most methods are unsafe to
143	call or deliver senseless data, as terminal size and other characteristics	513	call or deliver senseless data, as terminal size and other characteristics
144	have not yet been determined. You can safely query and change resources,	514	have not yet been determined. You can safely query and change resources
145	though.	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).
146		527
147	=item on_reset $term	528	=item on_reset $term
148		529
149	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
150	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
151	variables.	532	variables.
152		533
153	=item on_start $term	534	=item on_child_start $term, $pid
154		535
155	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.
156	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>.
157		542
158	=item on_sel_make $term, $eventtime	543	=item on_sel_make $term, $eventtime
159		544
160	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
161	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
…		…
168		553
169	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
170	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
171	by calling C<< $term->selection >>.	556	by calling C<< $term->selection >>.
172		557
173	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.
174		559
175	=item on_sel_extend $term	560	=item on_sel_extend $term
176		561
177	Called whenever the user tries to extend the selection (e.g. with a double	562	Called whenever the user tries to extend the selection (e.g. with a double
178	click) and is either supposed to return false (normal operation), or	563	click) and is either supposed to return false (normal operation), or
179	should extend the selection itelf and return true to suppress the built-in	564	should extend the selection itself and return true to suppress the built-in
180	processing.	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.
181		568
182	See the F<selection> example extension.	569	See the F<selection> example extension.
183		570
184	=item on_focus_in $term
185
186	Called whenever the window gets the keyboard focus, before urxvt does
187	focus in processing.
188
189	=item on_focus_out $term
190
191	Called wheneever the window loses keyboard focus, before urxvt does focus
192	out processing.
193
194	=item on_view_change $term, $offset	571	=item on_view_change $term, $offset
195		572
196	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
197	scrolls. Offset C<0> means display the normal terminal, positive values	574	scrolls. Offset C<0> means display the normal terminal, positive values
198	show this many lines of scrollback.	575	show this many lines of scrollback.
199		576
200	=item on_scroll_back $term, $lines, $saved	577	=item on_scroll_back $term, $lines, $saved
201		578
…		…
205		582
206	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,
207	$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
208	number of lines that will be in the scrollback buffer.	585	number of lines that will be in the scrollback buffer.
209		586
210	=item on_tty_activity $term NYI
211
212	Called whenever the program(s) running in the urxvt window send output.
213
214	=item on_osc_seq $term, $string	587	=item on_osc_seq $term, $op, $args, $resp
		588
		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
215		598
216	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	599	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
217	operating system command) is processed. Cursor position and other state	600	operating system command) is processed. Cursor position and other state
218	information is up-to-date when this happens. For interoperability, the	601	information is up-to-date when this happens. For interoperability, the
219	string should start with the extension name and a colon, to distinguish	602	string should start with the extension name (sans -osc) and a semicolon,
220	it from commands for other extensions, and this might be enforced in the	603	to distinguish it from commands for other extensions, and this might be
221	future.	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	}
222		615
223	Be careful not ever to trust (in a security sense) the data you receive,	616	Be careful not ever to trust (in a security sense) the data you receive,
224	as its source can not easily be controleld (e-mail content, messages from	617	as its source can not easily be controlled (e-mail content, messages from
225	other users on the same system etc.).	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.
226		622
227	=item on_add_lines $term, $string	623	=item on_add_lines $term, $string
228		624
229	Called whenever text is about to be output, with the text as argument. You	625	Called whenever text is about to be output, with the text as argument. You
230	can filter/change and output the text yourself by returning a true value	626	can filter/change and output the text yourself by returning a true value
231	and calling C<< $term->scr_add_lines >> yourself. Please note that this	627	and calling C<< $term->scr_add_lines >> yourself. Please note that this
232	might be very slow, however, as your hook is called for B<all> text being	628	might be very slow, however, as your hook is called for B<all> text being
233	output.	629	output.
234		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
235	=item on_line_update $term, $row	643	=item on_line_update $term, $row
236		644
237	Called whenever a line was updated or changed. Can be used to filter	645	Called whenever a line was updated or changed. Can be used to filter
238	screen output (e.g. underline urls or other useless stuff). Only lines	646	screen output (e.g. underline urls or other useless stuff). Only lines
239	that are being shown will be filtered, and, due to performance reasons,	647	that are being shown will be filtered, and, due to performance reasons,
…		…
246	later with the already-modified line (e.g. if unrelated parts change), so	654	later with the already-modified line (e.g. if unrelated parts change), so
247	you cannot just toggle rendition bits, but only set them.	655	you cannot just toggle rendition bits, but only set them.
248		656
249	=item on_refresh_begin $term	657	=item on_refresh_begin $term
250		658
251	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
252	or similar effects by modify terminal contents in refresh_begin, and	660	similar effects by modifying the terminal contents in refresh_begin, and
253	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
254	code is run after this hook, and takes precedence.	662	code is run after this hook, and takes precedence.
255		663
256	=item on_refresh_end $term	664	=item on_refresh_end $term
257		665
258	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>.
259		667
260	=item on_keyboard_command $term, $string	668	=item on_user_command $term, $string
261		669
262	Called whenever the user presses a key combination that has a	670	Called whenever a user-configured event is being activated (e.g. via
263	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>
264	resource in the @@RXVT_NAME@@(1) manpage).	672	resource in the @@RXVT_NAME@@(1) manpage).
265		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
266	=item on_key_press $term, $event, $octets	714	=item on_key_press $term, $event, $keysym, $octets
267		715
268	=item on_key_release $term, $event	716	=item on_key_release $term, $event, $keysym
269		717
270	=item on_button_press $term, $event	718	=item on_button_press $term, $event
271		719
272	=item on_button_release $term, $event	720	=item on_button_release $term, $event
273		721
274	=item on_motion_notify $term, $event	722	=item on_motion_notify $term, $event
275		723
		724	=item on_map_notify $term, $event
		725
		726	=item on_unmap_notify $term, $event
		727
276	Called whenever the corresponding X event is received for the terminal	728	Called whenever the corresponding X event is received for the terminal. If
277	(see the XEvent manpage) If the hook returns true, then the even will be	729	the hook returns true, then the event will be ignored by rxvt-unicode.
278	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.
279		734
280	C<on_key_press> additionally receives the string rxvt-unicode would	735	C<on_key_press> additionally receives the string rxvt-unicode would
281	output, if any, in locale-specific encoding.	736	output, if any, in locale-specific encoding.
282		737
283	subwindow.	738	subwindow.
284		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
285	=back	753	=back
286		754
		755	=cut
		756
		757	package urxvt;
		758
		759	use utf8;
		760	use strict 'vars';
		761	use Carp ();
		762	use Scalar::Util ();
		763	use List::Util ();
		764
		765	our $VERSION = 1;
		766	our $TERM;
		767	our @TERM_INIT; # should go, prevents async I/O etc.
		768	our @TERM_EXT; # should go, prevents async I/O etc.
		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
287	=head2 Variables in the C<urxvt> Package	780	=head2 Variables in the C<urxvt> Package
288		781
289	=over 4	782	=over 4
290		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
291	=item $urxvt::TERM	797	=item $urxvt::TERM
292		798
293	The current terminal. Whenever a callback/Hook is bein executed, this	799	The current terminal. This variable stores the current C<urxvt::term>
294	variable stores the current C<urxvt::term> object.	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>.
295		817
296	=back	818	=back
297		819
298	=head2 Functions in the C<urxvt> Package	820	=head2 Functions in the C<urxvt> Package
299		821
300	=over 4	822	=over 4
301		823
302	=item $term = new urxvt [arg...]
303
304	Creates a new terminal, very similar as if you had started it with
305	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
306	if the new instance couldn't be created. Returns C<undef> if the new
307	instance didn't initialise perl, and the terminal object otherwise. The
308	C<init> and C<start> hooks will be called during the call.
309
310	=item urxvt::fatal $errormessage	824	=item urxvt::fatal $errormessage
311		825
312	Fatally aborts execution with the given error message. Avoid at all	826	Fatally aborts execution with the given error message (which should
313	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
314	starts up.	828	is acceptable (and useful) is in the init hook, where it prevents the
		829	terminal from starting up.
315		830
316	=item urxvt::warn $string	831	=item urxvt::warn $string
317		832
318	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
319	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
320	that calls this function.	835	that calls this function.
321		836
322	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
323	correct place, e.g. on stderr of the connecting urxvtc client.	838	correct place, e.g. on stderr of the connecting urxvtc client.
324		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
325	=item $time = urxvt::NOW	849	=item $time = urxvt::NOW
326		850
327	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.
328		876
329	=back	877	=back
330		878
331	=head2 RENDITION	879	=head2 RENDITION
332		880
…		…
347		895
348	=item $rend = urxvt::OVERLAY_RSTYLE	896	=item $rend = urxvt::OVERLAY_RSTYLE
349		897
350	Return the rendition mask used for overlays by default.	898	Return the rendition mask used for overlays by default.
351		899
352	=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
353		902
354	Return the bit that enabled bold, italic, blink, reverse-video and	903	Return the bit that enabled bold, italic, blink, reverse-video and
355	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
356	the bitset.	905	the bitset.
357		906
…		…
359		908
360	=item $background = urxvt::GET_BASEBG $rend	909	=item $background = urxvt::GET_BASEBG $rend
361		910
362	Return the foreground/background colour index, respectively.	911	Return the foreground/background colour index, respectively.
363		912
364	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	913	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
365		914
366	=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
367		918
368	Replace the foreground/background colour in the rendition mask with the	919	Replace the foreground/background colour in the rendition mask with the
369	specified one.	920	specified one.
370		921
371	=item $value = urxvt::GET_CUSTOM ($rend)	922	=item $value = urxvt::GET_CUSTOM $rend
372		923
373	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
374	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
375	zero.	926	zero.
376		927
377	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	928	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
378		929
379	Change the custom value.	930	Change the custom value.
380		931
381	=back	932	=back
382		933
383	=cut	934	=cut
384		935
385	package urxvt;
386
387	use strict;
388	use Scalar::Util ();
389
390	our $TERM;
391	our @HOOKNAME;
392	our $LIBDIR;
393
394	BEGIN {	936	BEGIN {
395	urxvt->bootstrap;
396
397	# overwrite perl's warn	937	# overwrite perl's warn
398	*CORE::GLOBAL::warn = sub {	938	*CORE::GLOBAL::warn = sub {
399	my $msg = join "", @_;	939	my $msg = join "", @_;
400	$msg .= "\n"	940	$msg .= "\n"
401	unless $msg =~ /\n$/;	941	unless $msg =~ /\n$/;
402	urxvt::warn ($msg);	942	urxvt::warn ($msg);
403	};	943	};
404	}	944	}
405		945
406	my @hook_count;	946	no warnings 'utf8';
		947
		948	sub parse_resource {
		949	my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
		950
		951	$term->scan_meta;
		952
		953	my $r = $term->{meta}{resource};
		954	while (my ($pattern, $v) = each %$r) {
		955	$name =~ y/-/./ if $isarg;
		956
		957	if (
		958	$pattern =~ /\.$/
		959	? $pattern eq substr $name, 0, length $pattern
		960	: $pattern eq $name
		961	) {
		962	$name = "$urxvt::RESCLASS.$name";
		963
		964	push @{ $term->{perl_ext_3} }, $v->[0];
		965
		966	if ($v->[1] eq "boolean") {
		967	$term->put_option_db ($name, $flag ? "true" : "false");
		968	return 1;
		969	} else {
		970	$term->put_option_db ($name, $value);
		971	return 1 + 2;
		972	}
		973	}
		974	}
		975
		976	0
		977	}
		978
		979	sub usage {
		980	my ($term, $usage_type) = @_;
		981
		982	$term->scan_meta;
		983
		984	my $r = $term->{meta}{resource};
		985
		986	for my $pattern (sort keys %$r) {
		987	my ($ext, $type, $desc) = @{ $r->{$pattern} };
		988
		989	$desc .= " (-pe $ext)";
		990
		991	if ($usage_type == 1) {
		992	$pattern =~ y/./-/;
		993	$pattern =~ s/-$/-.../g;
		994
		995	if ($type eq "boolean") {
		996	urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
		997	} else {
		998	urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
		999	}
		1000	} else {
		1001	$pattern =~ s/\.$/.*/g;
		1002	urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
		1003	}
		1004	}
		1005	}
		1006
407	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	1007	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
408		1008
409	sub verbose {	1009	sub verbose {
410	my ($level, $msg) = @_;	1010	my ($level, $msg) = @_;
411	warn "$msg\n" if $level <= $verbosity;	1011	warn "$msg\n" if $level <= $verbosity;
412	}	1012	}
413		1013
414	# find on_xxx subs in the package and register them	1014	my %extension_pkg;
415	# as hooks
416	sub register_package($) {
417	my ($pkg) = @_;
418
419	for my $htype (0.. $#HOOKNAME) {
420	my $name = $HOOKNAME[$htype];
421
422	my $ref = $pkg->can ("on_" . lc $name)
423	or next;
424
425	$TERM->{_hook}[$htype]{$pkg} = $ref;
426	$hook_count[$htype]++
427	or set_should_invoke $htype, 1;
428	}
429	}
430
431	my $script_pkg = "script0000";
432	my %script_pkg;
433		1015
434	# load a single script into its own package, once only	1016	# load a single script into its own package, once only
435	sub script_package($) {	1017	sub extension_package($) {
436	my ($path) = @_;	1018	my ($path) = @_;
437		1019
438	$script_pkg{$path} \|\|= do {	1020	$extension_pkg{$path} \|\|= do {
439	my $pkg = "urxvt::" . ($script_pkg++);	1021	$path =~ /([^\/\\]+)$/;
		1022	my $pkg = $1;
		1023	$pkg =~ s/[^[:word:]]/_/g;
		1024	$pkg = "urxvt::ext::$pkg";
440		1025
441	verbose 3, "loading script '$path' into package '$pkg'";	1026	verbose 3, "loading extension '$path' into package '$pkg'";
442		1027
443	open my $fh, "<:raw", $path	1028	open my $fh, "<:raw", $path
444	or die "$path: $!";	1029	or die "$path: $!";
445		1030
446	my $source = "package $pkg; use strict; use utf8;\n"	1031	my $source =
		1032	"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
447	. "#line 1 \"$path\"\n{\n"	1033	. "#line 1 \"$path\"\n{\n"
448	. (do { local $/; <$fh> })	1034	. (do { local $/; <$fh> })
449	. "\n};\n1";	1035	. "\n};\n1";
450		1036
		1037	eval $source
451	eval $source or die "$path: $@";	1038	or die "$path: $@";
452		1039
453	$pkg	1040	$pkg
454	}	1041	}
455	}	1042	}
456		1043
…		…
460	sub invoke {	1047	sub invoke {
461	local $TERM = shift;	1048	local $TERM = shift;
462	my $htype = shift;	1049	my $htype = shift;
463		1050
464	if ($htype == 0) { # INIT	1051	if ($htype == 0) { # INIT
465	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	1052	my @dirs = $TERM->perl_libdirs;
466		1053
		1054	my %ext_arg;
		1055
		1056	{
		1057	my @init = @TERM_INIT;
		1058	@TERM_INIT = ();
		1059	$_->($TERM) for @init;
		1060	my @pkg = @TERM_EXT;
		1061	@TERM_EXT = ();
		1062	$TERM->register_package ($_) for @pkg;
		1063	}
		1064
		1065	for (
		1066	@{ delete $TERM->{perl_ext_3} },
467	for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {	1067	grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
		1068	) {
		1069	if ($_ eq "default") {
		1070	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
		1071	} elsif (/^-(.*)$/) {
		1072	delete $ext_arg{$1};
		1073	} elsif (/^([^<]+)<(.*)>$/) {
		1074	push @{ $ext_arg{$1} }, $2;
		1075	} else {
		1076	$ext_arg{$_} \|\|= [];
		1077	}
		1078	}
		1079
		1080	for my $ext (sort keys %ext_arg) {
468	my @files = grep -f $_, map "$_/$ext", @dirs;	1081	my @files = grep -f $_, map "$_/$ext", @dirs;
469		1082
470	if (@files) {	1083	if (@files) {
471	register_package script_package $files[0];	1084	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
472	} else {	1085	} else {
473	warn "perl extension '$ext' not found in perl library search path\n";	1086	warn "perl extension '$ext' not found in perl library search path\n";
474	}	1087	}
475	}	1088	}
		1089
		1090	eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
		1091	warn $@ if $@;
476	}	1092	}
477		1093
478	$retval = undef;	1094	$retval = undef;
479		1095
480	if (my $cb = $TERM->{_hook}[$htype]) {	1096	if (my $cb = $TERM->{_hook}[$htype]) {
481	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	1097	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
482	if $verbosity >= 10;	1098	if $verbosity >= 10;
483		1099
484	keys %$cb;	1100	for my $pkg (keys %$cb) {
		1101	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
		1102	$retval \|\|= $retval_;
485		1103
486	while (my ($pkg, $cb) = each %$cb) {	1104	if ($@) {
487	$retval = $cb->(	1105	$TERM->ungrab; # better to lose the grab than the session
488	$TERM->{_pkg}{$pkg} \|\|= do {	1106	warn $@;
489	my $proxy = bless { }, urxvt::term::proxy::;
490	Scalar::Util::weaken ($proxy->{term} = $TERM);
491	$proxy
492	},
493	@_,
494	) and last;
495	}
496	}
497
498	if ($htype == 1) { # DESTROY
499	# remove hooks if unused
500	if (my $hook = $TERM->{_hook}) {
501	for my $htype (0..$#$hook) {
502	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
503	or set_should_invoke $htype, 0;
504	}	1107	}
505	}	1108	}
506		1109
		1110	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		1111	if $verbosity >= 11;
		1112	}
		1113
		1114	if ($htype == 1) { # DESTROY
507	# clear package objects	1115	# clear package objects
508	%$_ = () for values %{ $TERM->{_pkg} };	1116	%$_ = () for values %{ $TERM->{_pkg} };
509		1117
510	# clear package	1118	# clear package
511	%$TERM = ();	1119	%$TERM = ();
512	}	1120	}
513		1121
514	$retval	1122	$retval
515	}	1123	}
516		1124
517	sub urxvt::term::proxy::AUTOLOAD {	1125	sub SET_COLOR($$$) {
518	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	1126	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		1127	}
		1128
		1129	sub rend2mask {
		1130	no strict 'refs';
		1131	my ($str, $mask) = (@_, 0);
		1132	my %color = ( fg => undef, bg => undef );
		1133	my @failed;
		1134	for my $spec ( split /\s+/, $str ) {
		1135	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1136	$color{lc($1)} = $2;
		1137	} else {
		1138	my $neg = $spec =~ s/^[-^]//;
		1139	unless ( exists &{"RS_$spec"} ) {
		1140	push @failed, $spec;
		1141	next;
		1142	}
		1143	my $cur = &{"RS_$spec"};
		1144	if ( $neg ) {
		1145	$mask &= ~$cur;
		1146	} else {
		1147	$mask \|= $cur;
		1148	}
		1149	}
		1150	}
		1151	($mask, @color{qw(fg bg)}, \@failed)
		1152	}
		1153
		1154	# urxvt::term::extension
		1155
		1156	package urxvt::term::extension;
		1157
		1158	sub enable {
		1159	my ($self, %hook) = @_;
		1160	my $pkg = $self->{_pkg};
		1161
		1162	while (my ($name, $cb) = each %hook) {
		1163	my $htype = $HOOKTYPE{uc $name};
		1164	defined $htype
		1165	or Carp::croak "unsupported hook type '$name'";
		1166
		1167	$self->set_should_invoke ($htype, +1)
		1168	unless exists $self->{term}{_hook}[$htype]{$pkg};
		1169
		1170	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		1171	}
		1172	}
		1173
		1174	sub disable {
		1175	my ($self, @hook) = @_;
		1176	my $pkg = $self->{_pkg};
		1177
		1178	for my $name (@hook) {
		1179	my $htype = $HOOKTYPE{uc $name};
		1180	defined $htype
		1181	or Carp::croak "unsupported hook type '$name'";
		1182
		1183	$self->set_should_invoke ($htype, -1)
		1184	if delete $self->{term}{_hook}[$htype]{$pkg};
		1185	}
		1186	}
		1187
		1188	our $AUTOLOAD;
		1189
		1190	sub AUTOLOAD {
		1191	$AUTOLOAD =~ /:([^:]+)$/
519	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	1192	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
520		1193
521	eval qq{	1194	eval qq{
522	sub $urxvt::term::proxy::AUTOLOAD {	1195	sub $AUTOLOAD {
523	my \$proxy = shift;	1196	my \$proxy = shift;
524	\$proxy->{term}->$1 (\@_)	1197	\$proxy->{term}->$1 (\@_)
525	}	1198	}
526	1	1199	1
527	} or die "FATAL: unable to compile method forwarder: $@";	1200	} or die "FATAL: unable to compile method forwarder: $@";
528		1201
529	goto &$urxvt::term::proxy::AUTOLOAD;	1202	goto &$AUTOLOAD;
530	}	1203	}
		1204
		1205	sub DESTROY {
		1206	# nop
		1207	}
		1208
		1209	# urxvt::destroy_hook
		1210
		1211	sub urxvt::destroy_hook::DESTROY {
		1212	${$_[0]}->();
		1213	}
		1214
		1215	sub urxvt::destroy_hook(&) {
		1216	bless \shift, urxvt::destroy_hook::
		1217	}
		1218
		1219	package urxvt::anyevent;
		1220
		1221	=head2 The C<urxvt::anyevent> Class
		1222
		1223	The sole purpose of this class is to deliver an interface to the
		1224	C<AnyEvent> module - any module using it will work inside urxvt without
		1225	further programming. The only exception is that you cannot wait on
		1226	condition variables, but non-blocking condvar use is ok.
		1227
		1228	In practical terms this means is that you cannot use blocking APIs, but
		1229	the non-blocking variant should work.
		1230
		1231	=cut
		1232
		1233	our $VERSION = '5.23';
		1234
		1235	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
		1236	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
		1237
		1238	sub timer {
		1239	my ($class, %arg) = @_;
		1240
		1241	my $cb = $arg{cb};
		1242
		1243	urxvt::timer
		1244	->new
		1245	->after ($arg{after}, $arg{interval})
		1246	->cb ($arg{interval} ? $cb : sub {
		1247	$_[0]->stop; # need to cancel manually
		1248	$cb->();
		1249	})
		1250	}
		1251
		1252	sub io {
		1253	my ($class, %arg) = @_;
		1254
		1255	my $cb = $arg{cb};
		1256	my $fd = fileno $arg{fh};
		1257	defined $fd or $fd = $arg{fh};
		1258
		1259	bless [$arg{fh}, urxvt::iow
		1260	->new
		1261	->fd ($fd)
		1262	->events (($arg{poll} =~ /r/ ? 1 : 0)
		1263	\| ($arg{poll} =~ /w/ ? 2 : 0))
		1264	->start
		1265	->cb ($cb)
		1266	], urxvt::anyevent::
		1267	}
		1268
		1269	sub idle {
		1270	my ($class, %arg) = @_;
		1271
		1272	my $cb = $arg{cb};
		1273
		1274	urxvt::iw
		1275	->new
		1276	->start
		1277	->cb ($cb)
		1278	}
		1279
		1280	sub child {
		1281	my ($class, %arg) = @_;
		1282
		1283	my $cb = $arg{cb};
		1284
		1285	urxvt::pw
		1286	->new
		1287	->start ($arg{pid})
		1288	->cb (sub {
		1289	$_[0]->stop; # need to cancel manually
		1290	$cb->($_[0]->rpid, $_[0]->rstatus);
		1291	})
		1292	}
		1293
		1294	sub DESTROY {
		1295	$_[0][1]->stop;
		1296	}
		1297
		1298	# only needed for AnyEvent < 6 compatibility
		1299	sub one_event {
		1300	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
		1301	}
		1302
		1303	package urxvt::term;
531		1304
532	=head2 The C<urxvt::term> Class	1305	=head2 The C<urxvt::term> Class
533		1306
534	=over 4	1307	=over 4
535		1308
		1309	=cut
		1310
		1311	# find on_xxx subs in the package and register them
		1312	# as hooks
		1313	sub register_package {
		1314	my ($self, $pkg, $argv) = @_;
		1315
		1316	no strict 'refs';
		1317
		1318	urxvt::verbose 6, "register package $pkg to $self";
		1319
		1320	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1321
		1322	my $proxy = bless {
		1323	_pkg => $pkg,
		1324	argv => $argv,
		1325	}, $pkg;
		1326	Scalar::Util::weaken ($proxy->{term} = $self);
		1327
		1328	$self->{_pkg}{$pkg} = $proxy;
		1329
		1330	for my $name (@HOOKNAME) {
		1331	if (my $ref = $pkg->can ("on_" . lc $name)) {
		1332	$proxy->enable ($name => $ref);
		1333	}
		1334	}
		1335	}
		1336
		1337	sub perl_libdirs {
		1338	map { split /:/ }
		1339	$_[0]->resource ("perl_lib"),
		1340	$ENV{URXVT_PERL_LIB},
		1341	"$ENV{HOME}/.urxvt/ext",
		1342	"$LIBDIR/perl"
		1343	}
		1344
		1345	sub scan_meta {
		1346	my ($self) = @_;
		1347	my @libdirs = perl_libdirs $self;
		1348
		1349	return if $self->{meta_libdirs} eq join "\x00", @libdirs;
		1350
		1351	my %meta;
		1352
		1353	$self->{meta_libdirs} = join "\x00", @libdirs;
		1354	$self->{meta} = \%meta;
		1355
		1356	for my $dir (reverse @libdirs) {
		1357	opendir my $fh, $dir
		1358	or next;
		1359	for my $ext (readdir $fh) {
		1360	$ext ne "."
		1361	and $ext ne ".."
		1362	and open my $fh, "<", "$dir/$ext"
		1363	or next;
		1364
		1365	while (<$fh>) {
		1366	if (/^#:META:X_RESOURCE:(.*)/) {
		1367	my ($pattern, $type, $desc) = split /:/, $1;
		1368	$pattern =~ s/^%(\.\|$)/$ext$1/g; # % in pattern == extension name
		1369	if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
		1370	warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
		1371	} else {
		1372	$meta{resource}{$pattern} = [$ext, $type, $desc];
		1373	}
		1374	} elsif (/^\s*(?:#\|$)/) {
		1375	# skip other comments and empty lines
		1376	} else {
		1377	last; # stop parsing on first non-empty non-comment line
		1378	}
		1379	}
		1380	}
		1381	}
		1382	}
		1383
		1384	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1385
		1386	Creates a new terminal, very similar as if you had started it with system
		1387	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1388	hash which defines the environment of the new terminal.
		1389
		1390	Croaks (and probably outputs an error message) if the new instance
		1391	couldn't be created. Returns C<undef> if the new instance didn't
		1392	initialise perl, and the terminal object otherwise. The C<init> and
		1393	C<start> hooks will be called before this call returns, and are free to
		1394	refer to global data (which is race free).
		1395
		1396	=cut
		1397
		1398	sub new {
		1399	my ($class, $env, @args) = @_;
		1400
		1401	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1402	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1403
		1404	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1405	}
		1406
536	=item $term->destroy	1407	=item $term->destroy
537		1408
538	Destroy the terminal object (close the window, free resources etc.).	1409	Destroy the terminal object (close the window, free resources
		1410	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1411	watchers (timers, io watchers) are still active.
		1412
		1413	=item $term->exec_async ($cmd[, @args])
		1414
		1415	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1416	("starts") programs in the background. This function takes care of setting
		1417	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1418	be preferred over explicit calls to C<exec> or C<system>.
		1419
		1420	Returns the pid of the subprocess or C<undef> on error.
		1421
		1422	=cut
		1423
		1424	sub exec_async {
		1425	my $self = shift;
		1426
		1427	my $pid = fork;
		1428
		1429	return $pid
		1430	if !defined $pid or $pid;
		1431
		1432	%ENV = %{ $self->env };
		1433
		1434	exec @_;
		1435	urxvt::_exit 255;
		1436	}
		1437
		1438	=item $isset = $term->option ($optval[, $set])
		1439
		1440	Returns true if the option specified by C<$optval> is enabled, and
		1441	optionally change it. All option values are stored by name in the hash
		1442	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
		1443
		1444	Here is a likely non-exhaustive list of option names, please see the
		1445	source file F</src/optinc.h> to see the actual list:
		1446
		1447	borderLess buffered console cursorBlink cursorUnderline hold iconic
		1448	insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
		1449	mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
		1450	pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
		1451	scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
		1452	secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
		1453	urgentOnBell utmpInhibit visualBell
539		1454
540	=item $value = $term->resource ($name[, $newval])	1455	=item $value = $term->resource ($name[, $newval])
541		1456
542	Returns the current resource value associated with a given name and	1457	Returns the current resource value associated with a given name and
543	optionally sets a new value. Setting values is most useful in the C<init>	1458	optionally sets a new value. Setting values is most useful in the C<init>
…		…
552	likely change).	1467	likely change).
553		1468
554	Please note that resource strings will currently only be freed when the	1469	Please note that resource strings will currently only be freed when the
555	terminal is destroyed, so changing options frequently will eat memory.	1470	terminal is destroyed, so changing options frequently will eat memory.
556		1471
557	Here is a a likely non-exhaustive list of resource names, not all of which	1472	Here is a likely non-exhaustive list of resource names, not all of which
558	are supported in every build, please see the source to see the actual	1473	are supported in every build, please see the source file F</src/rsinc.h>
559	list:	1474	to see the actual list:
560		1475
561	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1476	answerbackstring backgroundPixmap backspace_key blendtype blurradius
562	borderLess color cursorBlink cursorUnderline cutchars delete_key	1477	boldFont boldItalicFont borderLess buffered chdir color cursorBlink
563	display_name embed ext_bwidth fade font geometry hold iconName	1478	cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
564	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1479	fade font geometry hold iconName iconfile imFont imLocale inputMethod
		1480	insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
565	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1481	jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
566	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1482	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
567	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1483	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
568	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1484	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
569	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1485	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
570	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1486	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
571	shade term_name title transparent transparent_all tripleclickwords	1487	secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
		1488	term_name title transient_for transparent tripleclickwords urgentOnBell
572	utmpInhibit visualBell	1489	utmpInhibit visualBell
573		1490
574	=cut	1491	=cut
575		1492
576	sub urxvt::term::resource($$;$) {	1493	sub resource($$;$) {
577	my ($self, $name) = (shift, shift);	1494	my ($self, $name) = (shift, shift);
578	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	1495	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
579	goto &urxvt::term::_resource;	1496	goto &urxvt::term::_resource
580	}	1497	}
		1498
		1499	=item $value = $term->x_resource ($pattern)
		1500
		1501	Returns the X-Resource for the given pattern, excluding the program or
		1502	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1503	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1504	resource with that pattern exists.
		1505
		1506	This method should only be called during the C<on_start> hook, as there is
		1507	only one resource database per display, and later invocations might return
		1508	the wrong resources.
		1509
		1510	=item $value = $term->x_resource_boolean ($pattern)
		1511
		1512	Like C<x_resource>, above, but interprets the string value as a boolean
		1513	and returns C<1> for true values, C<0> for false values and C<undef> if
		1514	the resource or option isn't specified.
		1515
		1516	You should always use this method to parse boolean resources.
		1517
		1518	=cut
		1519
		1520	sub x_resource_boolean {
		1521	my $res = &x_resource;
		1522
		1523	$res =~ /^\s(?:true\|yes\|on\|1)\s$/i ? 1 : defined $res && 0
		1524	}
		1525
		1526	=item $success = $term->parse_keysym ($key, $octets)
		1527
		1528	Adds a key binding exactly as specified via a resource. See the
		1529	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1530
		1531	=item $term->register_command ($keysym, $modifiermask, $string)
		1532
		1533	Adds a key binding. This is a lower level api compared to
		1534	C<parse_keysym>, as it expects a parsed key description, and can be
		1535	used only inside either the C<on_init> hook, to add a binding, or the
		1536	C<on_register_command> hook, to modify a parsed binding.
581		1537
582	=item $rend = $term->rstyle ([$new_rstyle])	1538	=item $rend = $term->rstyle ([$new_rstyle])
583		1539
584	Return and optionally change the current rendition. Text that is output by	1540	Return and optionally change the current rendition. Text that is output by
585	the terminal application will use this style.	1541	the terminal application will use this style.
…		…
593		1549
594	=item ($row, $col) = $term->selection_beg ([$row, $col])	1550	=item ($row, $col) = $term->selection_beg ([$row, $col])
595		1551
596	=item ($row, $col) = $term->selection_end ([$row, $col])	1552	=item ($row, $col) = $term->selection_end ([$row, $col])
597		1553
598	Return the current values of the selection mark, begin or end positions,	1554	Return the current values of the selection mark, begin or end positions.
599	and optionally set them to new values.
600		1555
		1556	When arguments are given, then the selection coordinates are set to
		1557	C<$row> and C<$col>, and the selection screen is set to the current
		1558	screen.
		1559
		1560	=item $screen = $term->selection_screen ([$screen])
		1561
		1562	Returns the current selection screen, and then optionally sets it.
		1563
		1564	=item $term->selection_make ($eventtime[, $rectangular])
		1565
		1566	Tries to make a selection as set by C<selection_beg> and
		1567	C<selection_end>. If C<$rectangular> is true (default: false), a
		1568	rectangular selection will be made. This is the preferred function to make
		1569	a selection.
		1570
601	=item $success = $term->selection_grab ($eventtime)	1571	=item $success = $term->selection_grab ($eventtime[, $clipboard])
602		1572
603	Try to request the primary selection from the server (for example, as set	1573	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
604	by the next method).	1574	true) selection from the server. The corresponding text can be set
		1575	with the next method. No visual feedback will be given. This function
		1576	is mostly useful from within C<on_sel_grab> hooks.
605		1577
606	=item $oldtext = $term->selection ([$newtext])	1578	=item $oldtext = $term->selection ([$newtext, $clipboard])
607		1579
608	Return the current selection text and optionally replace it by C<$newtext>.	1580	Return the current selection (clipboard if C<$clipboard> is true) text
		1581	and optionally replace it by C<$newtext>.
609		1582
		1583	=item $term->selection_clear ([$clipboard])
		1584
		1585	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
		1586
610	#=item $term->overlay ($x, $y, $text)	1587	=item $term->overlay_simple ($x, $y, $text)
611	#	1588
612	#Create a simple multi-line overlay box. See the next method for details.	1589	Create a simple multi-line overlay box. See the next method for details.
613	#	1590
614	#=cut	1591	=cut
615	#	1592
616	#sub urxvt::term::scr_overlay {	1593	sub overlay_simple {
617	# my ($self, $x, $y, $text) = @_;	1594	my ($self, $x, $y, $text) = @_;
618	#	1595
619	# my @lines = split /\n/, $text;	1596	my @lines = split /\n/, $text;
620	#	1597
621	# my $w = 0;	1598	my $w = List::Util::max map $self->strwidth ($_), @lines;
622	# for (map $self->strwidth ($_), @lines) {	1599
623	# $w = $_ if $w < $_;
624	# }
625	#
626	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1600	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
627	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1601	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
628	#}	1602
		1603	$overlay
		1604	}
629		1605
630	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1606	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
631		1607
632	Create a new (empty) overlay at the given position with the given	1608	Create a new (empty) overlay at the given position with the given
633	width/height. C<$rstyle> defines the initial rendition style	1609	width/height. C<$rstyle> defines the initial rendition style
…		…
644		1620
645	The methods currently supported on C<urxvt::overlay> objects are:	1621	The methods currently supported on C<urxvt::overlay> objects are:
646		1622
647	=over 4	1623	=over 4
648		1624
649	=item $overlay->set ($x, $y, $text, $rend)	1625	=item $overlay->set ($x, $y, $text[, $rend])
650		1626
651	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts	1627	Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
652	text in rxvt-unicode's special encoding and an array of rendition values	1628	text in rxvt-unicode's special encoding and an array of rendition values
653	at a specific position inside the overlay.	1629	at a specific position inside the overlay.
654		1630
		1631	If C<$rend> is missing, then the rendition will not be changed.
		1632
655	=item $overlay->hide	1633	=item $overlay->hide
656		1634
657	If visible, hide the overlay, but do not destroy it.	1635	If visible, hide the overlay, but do not destroy it.
658		1636
659	=item $overlay->show	1637	=item $overlay->show
660		1638
661	If hidden, display the overlay again.	1639	If hidden, display the overlay again.
662		1640
663	=back	1641	=back
664		1642
		1643	=item $popup = $term->popup ($event)
		1644
		1645	Creates a new C<urxvt::popup> object that implements a popup menu. The
		1646	C<$event> I<must> be the event causing the menu to pop up (a button event,
		1647	currently).
		1648
		1649	=cut
		1650
		1651	sub popup {
		1652	my ($self, $event) = @_;
		1653
		1654	$self->grab ($event->{time}, 1)
		1655	or return;
		1656
		1657	my $popup = bless {
		1658	term => $self,
		1659	event => $event,
		1660	}, urxvt::popup::;
		1661
		1662	Scalar::Util::weaken $popup->{term};
		1663
		1664	$self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
		1665	Scalar::Util::weaken $self->{_destroy}{$popup};
		1666
		1667	$popup
		1668	}
		1669
665	=item $cellwidth = $term->strwidth $string	1670	=item $cellwidth = $term->strwidth ($string)
666		1671
667	Returns the number of screen-cells this string would need. Correctly	1672	Returns the number of screen-cells this string would need. Correctly
668	accounts for wide and combining characters.	1673	accounts for wide and combining characters.
669		1674
670	=item $octets = $term->locale_encode $string	1675	=item $octets = $term->locale_encode ($string)
671		1676
672	Convert the given text string into the corresponding locale encoding.	1677	Convert the given text string into the corresponding locale encoding.
673		1678
674	=item $string = $term->locale_decode $octets	1679	=item $string = $term->locale_decode ($octets)
675		1680
676	Convert the given locale-encoded octets into a perl string.	1681	Convert the given locale-encoded octets into a perl string.
		1682
		1683	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1684
		1685	XORs the rendition values in the given span with the provided value
		1686	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1687	refresh hooks to provide effects similar to the selection.
		1688
		1689	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1690
		1691	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1692	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1693	to C<RS_RVid \| RS_Uline>, which removes reverse video again and underlines
		1694	it instead. Both styles I<MUST NOT> contain font styles.
		1695
		1696	=item $term->scr_bell
		1697
		1698	Ring the bell!
677		1699
678	=item $term->scr_add_lines ($string)	1700	=item $term->scr_add_lines ($string)
679		1701
680	Write the given text string to the screen, as if output by the application	1702	Write the given text string to the screen, as if output by the application
681	running inside the terminal. It may not contain command sequences (escape	1703	running inside the terminal. It may not contain command sequences (escape
…		…
684		1706
685	Normally its not a good idea to use this function, as programs might be	1707	Normally its not a good idea to use this function, as programs might be
686	confused by changes in cursor position or scrolling. Its useful inside a	1708	confused by changes in cursor position or scrolling. Its useful inside a
687	C<on_add_lines> hook, though.	1709	C<on_add_lines> hook, though.
688		1710
		1711	=item $term->scr_change_screen ($screen)
		1712
		1713	Switch to given screen - 0 primary, 1 secondary.
		1714
689	=item $term->cmd_parse ($octets)	1715	=item $term->cmd_parse ($octets)
690		1716
691	Similar to C<scr_add_lines>, but the argument must be in the	1717	Similar to C<scr_add_lines>, but the argument must be in the
692	locale-specific encoding of the terminal and can contain command sequences	1718	locale-specific encoding of the terminal and can contain command sequences
693	(escape codes) that will be interpreted.	1719	(escape codes) that will be interpreted.
694		1720
695	=item $term->tt_write ($octets)	1721	=item $term->tt_write ($octets)
696		1722
697	Write the octets given in C<$data> to the tty (i.e. as program input). To	1723	Write the octets given in C<$octets> to the tty (i.e. as program input). To
698	pass characters instead of octets, you should convert your strings first	1724	pass characters instead of octets, you should convert your strings first
699	to the locale-specific encoding using C<< $term->locale_encode >>.	1725	to the locale-specific encoding using C<< $term->locale_encode >>.
700		1726
		1727	=item $term->tt_paste ($octets)
		1728
		1729	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1730	CR and bracketing the data with control sequences if bracketed paste mode
		1731	is set.
		1732
		1733	=item $old_events = $term->pty_ev_events ([$new_events])
		1734
		1735	Replaces the event mask of the pty watcher by the given event mask. Can
		1736	be used to suppress input and output handling to the pty/tty. See the
		1737	description of C<< urxvt::timer->events >>. Make sure to always restore
		1738	the previous value.
		1739
		1740	=item $fd = $term->pty_fd
		1741
		1742	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1743	is used.
		1744
		1745	=item $windowid = $term->parent
		1746
		1747	Return the window id of the toplevel window.
		1748
		1749	=item $windowid = $term->vt
		1750
		1751	Return the window id of the terminal window.
		1752
		1753	=item $term->vt_emask_add ($x_event_mask)
		1754
		1755	Adds the specified events to the vt event mask. Useful e.g. when you want
		1756	to receive pointer events all the times:
		1757
		1758	$term->vt_emask_add (urxvt::PointerMotionMask);
		1759
		1760	=item $term->set_urgency ($set)
		1761
		1762	Enable/disable the urgency hint on the toplevel window.
		1763
		1764	=item $term->focus_in
		1765
		1766	=item $term->focus_out
		1767
		1768	=item $term->key_press ($state, $keycode[, $time])
		1769
		1770	=item $term->key_release ($state, $keycode[, $time])
		1771
		1772	Deliver various fake events to to terminal.
		1773
701	=item $window_width = $term->width	1774	=item $window_width = $term->width
702		1775
703	=item $window_height = $term->height	1776	=item $window_height = $term->height
704		1777
705	=item $font_width = $term->fwidth	1778	=item $font_width = $term->fwidth
…		…
718		1791
719	=item $max_scrollback = $term->saveLines	1792	=item $max_scrollback = $term->saveLines
720		1793
721	=item $nrow_plus_saveLines = $term->total_rows	1794	=item $nrow_plus_saveLines = $term->total_rows
722		1795
723	=item $lines_in_scrollback = $term->nsaved	1796	=item $topmost_scrollback_row = $term->top_row
724		1797
725	Return various integers describing terminal characteristics.	1798	Return various integers describing terminal characteristics.
726		1799
		1800	=item $x_display = $term->display_id
		1801
		1802	Return the DISPLAY used by rxvt-unicode.
		1803
		1804	=item $lc_ctype = $term->locale
		1805
		1806	Returns the LC_CTYPE category string used by this rxvt-unicode.
		1807
		1808	=item $env = $term->env
		1809
		1810	Returns a copy of the environment in effect for the terminal as a hashref
		1811	similar to C<\%ENV>.
		1812
		1813	=item @envv = $term->envv
		1814
		1815	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1816
		1817	=item @argv = $term->argv
		1818
		1819	Return the argument vector as this terminal, similar to @ARGV, but
		1820	includes the program name as first element.
		1821
		1822	=cut
		1823
		1824	sub env {
		1825	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
		1826	}
		1827
		1828	=item $modifiermask = $term->ModLevel3Mask
		1829
		1830	=item $modifiermask = $term->ModMetaMask
		1831
		1832	=item $modifiermask = $term->ModNumLockMask
		1833
		1834	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
		1835	AltGr), the meta key (often Alt) and the num lock key, if applicable.
		1836
		1837	=item $screen = $term->current_screen
		1838
		1839	Returns the currently displayed screen (0 primary, 1 secondary).
		1840
		1841	=item $cursor_is_hidden = $term->hidden_cursor
		1842
		1843	Returns whether the cursor is currently hidden or not.
		1844
727	=item $view_start = $term->view_start ([$newvalue])	1845	=item $view_start = $term->view_start ([$newvalue])
728		1846
729	Returns the negative row number of the topmost line. Minimum value is	1847	Returns the row number of the topmost displayed line. Maximum value is
730	C<0>, which displays the normal terminal contents. Larger values scroll	1848	C<0>, which displays the normal terminal contents. Lower values scroll
731	this many lines into the scrollback buffer.	1849	this many lines into the scrollback buffer.
732		1850
733	=item $term->want_refresh	1851	=item $term->want_refresh
734		1852
735	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1853	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
738		1856
739	Used after changing terminal contents to display them.	1857	Used after changing terminal contents to display them.
740		1858
741	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])	1859	=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
742		1860
743	Returns the text of the entire row with number C<$row_number>. Row C<0>	1861	Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
744	is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost	1862	is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
745	terminal line. The scrollback buffer starts at line C<-1> and extends to
746	line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line	1863	terminal line. Nothing will be returned if a nonexistent line
747	is requested.	1864	is requested.
748		1865
749	If C<$new_text> is specified, it will replace characters in the current	1866	If C<$new_text> is specified, it will replace characters in the current
750	line, starting at column C<$start_col> (default C<0>), which is useful	1867	line, starting at column C<$start_col> (default C<0>), which is useful
751	to replace only parts of a line. The font index in the rendition will	1868	to replace only parts of a line. The font index in the rendition will
752	automatically be updated.	1869	automatically be updated.
753		1870
754	C<$text> is in a special encoding: tabs and wide characters that use more	1871	C<$text> is in a special encoding: tabs and wide characters that use more
755	than one cell when displayed are padded with urxvt::NOCHAR characters	1872	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
756	(C<chr 65535>). Characters with combining characters and other characters	1873	characters. Characters with combining characters and other characters that
757	that do not fit into the normal tetx encoding will be replaced with	1874	do not fit into the normal text encoding will be replaced with characters
758	characters in the private use area.	1875	in the private use area.
759		1876
760	You have to obey this encoding when changing text. The advantage is	1877	You have to obey this encoding when changing text. The advantage is
761	that C<substr> and similar functions work on screen cells and not on	1878	that C<substr> and similar functions work on screen cells and not on
762	characters.	1879	characters.
763		1880
…		…
814	Return the row number of the first/last row of the line, respectively.	1931	Return the row number of the first/last row of the line, respectively.
815		1932
816	=item $offset = $line->offset_of ($row, $col)	1933	=item $offset = $line->offset_of ($row, $col)
817		1934
818	Returns the character offset of the given row\|col pair within the logical	1935	Returns the character offset of the given row\|col pair within the logical
819	line.	1936	line. Works for rows outside the line, too, and returns corresponding
		1937	offsets outside the string.
820		1938
821	=item ($row, $col) = $line->coord_of ($offset)	1939	=item ($row, $col) = $line->coord_of ($offset)
822		1940
823	Translates a string offset into terminal coordinates again.	1941	Translates a string offset into terminal coordinates again.
824		1942
825	=back	1943	=back
826		1944
827	=cut	1945	=cut
828		1946
829	sub urxvt::term::line {	1947	sub line {
830	my ($self, $row) = @_;	1948	my ($self, $row) = @_;
831		1949
832	my $maxrow = $self->nrow - 1;	1950	my $maxrow = $self->nrow - 1;
833		1951
834	my ($beg, $end) = ($row, $row);	1952	my ($beg, $end) = ($row, $row);
…		…
898	$offset / $self->{ncol} + $self->{beg},	2016	$offset / $self->{ncol} + $self->{beg},
899	$offset % $self->{ncol}	2017	$offset % $self->{ncol}
900	)	2018	)
901	}	2019	}
902		2020
903	=item ($row, $col) = $line->coord_of ($offset)
904	=item $text = $term->special_encode $string	2021	=item $text = $term->special_encode $string
905		2022
906	Converts a perl string into the special encoding used by rxvt-unicode,	2023	Converts a perl string into the special encoding used by rxvt-unicode,
907	where one character corresponds to one screen cell. See	2024	where one character corresponds to one screen cell. See
908	C<< $term->ROW_t >> for details.	2025	C<< $term->ROW_t >> for details.
909		2026
910	=item $string = $term->special_decode $text	2027	=item $string = $term->special_decode $text
911		2028
912	Converts rxvt-unicodes text reprsentation into a perl string. See	2029	Converts rxvt-unicodes text representation into a perl string. See
913	C<< $term->ROW_t >> for details.	2030	C<< $term->ROW_t >> for details.
914		2031
		2032	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
		2033
		2034	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		2035
		2036	Register/unregister a synchronous button grab. See the XGrabButton
		2037	manpage.
		2038
		2039	=item $success = $term->grab ($eventtime[, $sync])
		2040
		2041	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
		2042	synchronous (C<$sync> is true). Also remembers the grab timestamp.
		2043
		2044	=item $term->allow_events_async
		2045
		2046	Calls XAllowEvents with AsyncBoth for the most recent grab.
		2047
		2048	=item $term->allow_events_sync
		2049
		2050	Calls XAllowEvents with SyncBoth for the most recent grab.
		2051
		2052	=item $term->allow_events_replay
		2053
		2054	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
		2055	recent grab.
		2056
		2057	=item $term->ungrab
		2058
		2059	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
		2060	evaluation errors, as it is better to lose the grab in the error case as
		2061	the session.
		2062
		2063	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		2064
		2065	=item $atom_name = $term->XGetAtomName ($atom)
		2066
		2067	=item @atoms = $term->XListProperties ($window)
		2068
		2069	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		2070
		2071	=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
		2072
		2073	=item $term->XDeleteProperty ($window, $property)
		2074
		2075	=item $window = $term->DefaultRootWindow
		2076
		2077	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		2078
		2079	=item $term->XMapWindow ($window)
		2080
		2081	=item $term->XUnmapWindow ($window)
		2082
		2083	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		2084
		2085	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		2086
		2087	=item $term->XChangeInput ($window, $add_events[, $del_events])
		2088
		2089	=item $keysym = $term->XStringToKeysym ($string)
		2090
		2091	=item $string = $term->XKeysymToString ($keysym)
		2092
		2093	Various X or X-related functions. The C<$term> object only serves as
		2094	the source of the display, otherwise those functions map more-or-less
		2095	directly onto the X functions of the same name.
		2096
915	=back	2097	=back
		2098
		2099	=cut
		2100
		2101	package urxvt::popup;
		2102
		2103	=head2 The C<urxvt::popup> Class
		2104
		2105	=over 4
		2106
		2107	=cut
		2108
		2109	sub add_item {
		2110	my ($self, $item) = @_;
		2111
		2112	$item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
		2113	$item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
		2114	$item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
		2115
		2116	$item->{render} \|\|= sub { $_[0]{text} };
		2117
		2118	push @{ $self->{item} }, $item;
		2119	}
		2120
		2121	=item $popup->add_title ($title)
		2122
		2123	Adds a non-clickable title to the popup.
		2124
		2125	=cut
		2126
		2127	sub add_title {
		2128	my ($self, $title) = @_;
		2129
		2130	$self->add_item ({
		2131	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		2132	text => $title,
		2133	activate => sub { },
		2134	});
		2135	}
		2136
		2137	=item $popup->add_separator ([$sepchr])
		2138
		2139	Creates a separator, optionally using the character given as C<$sepchr>.
		2140
		2141	=cut
		2142
		2143	sub add_separator {
		2144	my ($self, $sep) = @_;
		2145
		2146	$sep \|\|= "=";
		2147
		2148	$self->add_item ({
		2149	rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
		2150	text => "",
		2151	render => sub { $sep x $self->{term}->ncol },
		2152	activate => sub { },
		2153	});
		2154	}
		2155
		2156	=item $popup->add_button ($text, $cb)
		2157
		2158	Adds a clickable button to the popup. C<$cb> is called whenever it is
		2159	selected.
		2160
		2161	=cut
		2162
		2163	sub add_button {
		2164	my ($self, $text, $cb) = @_;
		2165
		2166	$self->add_item ({ type => "button", text => $text, activate => $cb});
		2167	}
		2168
		2169	=item $popup->add_toggle ($text, $initial_value, $cb)
		2170
		2171	Adds a toggle/checkbox item to the popup. The callback gets called
		2172	whenever it gets toggled, with a boolean indicating its new value as its
		2173	first argument.
		2174
		2175	=cut
		2176
		2177	sub add_toggle {
		2178	my ($self, $text, $value, $cb) = @_;
		2179
		2180	my $item; $item = {
		2181	type => "button",
		2182	text => " $text",
		2183	value => $value,
		2184	render => sub { ($_[0]{value} ? "* " : " ") . $text },
		2185	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
		2186	};
		2187
		2188	$self->add_item ($item);
		2189	}
		2190
		2191	=item $popup->show
		2192
		2193	Displays the popup (which is initially hidden).
		2194
		2195	=cut
		2196
		2197	sub show {
		2198	my ($self) = @_;
		2199
		2200	local $urxvt::popup::self = $self;
		2201
		2202	my $env = $self->{term}->env;
		2203	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		2204	delete $env->{LC_ALL};
		2205	$env->{LC_CTYPE} = $self->{term}->locale;
		2206
		2207	my $term = urxvt::term->new (
		2208	$env, "popup",
		2209	"--perl-lib" => "", "--perl-ext-common" => "",
		2210	"-pty-fd" => -1, "-sl" => 0,
		2211	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
		2212	"--transient-for" => $self->{term}->parent,
		2213	"-display" => $self->{term}->display_id,
		2214	"-pe" => "urxvt-popup",
		2215	) or die "unable to create popup window\n";
		2216
		2217	unless (delete $term->{urxvt_popup_init_done}) {
		2218	$term->ungrab;
		2219	$term->destroy;
		2220	die "unable to initialise popup window\n";
		2221	}
		2222	}
		2223
		2224	sub DESTROY {
		2225	my ($self) = @_;
		2226
		2227	delete $self->{term}{_destroy}{$self};
		2228	$self->{term}->ungrab;
		2229	}
		2230
		2231	=back
		2232
		2233	=cut
		2234
		2235	package urxvt::watcher;
916		2236
917	=head2 The C<urxvt::timer> Class	2237	=head2 The C<urxvt::timer> Class
918		2238
919	This class implements timer watchers/events. Time is represented as a	2239	This class implements timer watchers/events. Time is represented as a
920	fractional number of seconds since the epoch. Example:	2240	fractional number of seconds since the epoch. Example:
…		…
924	->new	2244	->new
925	->interval (1)	2245	->interval (1)
926	->cb (sub {	2246	->cb (sub {
927	$term->{overlay}->set (0, 0,	2247	$term->{overlay}->set (0, 0,
928	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);	2248	sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
929	});	2249	});
930		2250
931	=over 4	2251	=over 4
932		2252
933	=item $timer = new urxvt::timer	2253	=item $timer = new urxvt::timer
934		2254
…		…
937		2257
938	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2258	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
939		2259
940	Set the callback to be called when the timer triggers.	2260	Set the callback to be called when the timer triggers.
941		2261
942	=item $tstamp = $timer->at
943
944	Return the time this watcher will fire next.
945
946	=item $timer = $timer->set ($tstamp)	2262	=item $timer = $timer->set ($tstamp[, $interval])
947		2263
948	Set the time the event is generated to $tstamp.	2264	Set the time the event is generated to $tstamp (and optionally specifies a
		2265	new $interval).
949		2266
950	=item $timer = $timer->interval ($interval)	2267	=item $timer = $timer->interval ($interval)
951		2268
952	Normally (and when C<$interval> is C<0>), the timer will automatically	2269	By default (and when C<$interval> is C<0>), the timer will automatically
953	stop after it has fired once. If C<$interval> is non-zero, then the timer	2270	stop after it has fired once. If C<$interval> is non-zero, then the timer
954	is automatically rescheduled at the given intervals.	2271	is automatically rescheduled at the given intervals.
955		2272
956	=item $timer = $timer->start	2273	=item $timer = $timer->start
957		2274
958	Start the timer.	2275	Start the timer.
959		2276
960	=item $timer = $timer->start ($tstamp)	2277	=item $timer = $timer->start ($tstamp[, $interval])
961		2278
962	Set the event trigger time to C<$tstamp> and start the timer.	2279	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2280	also replaces the interval.
		2281
		2282	=item $timer = $timer->after ($delay[, $interval])
		2283
		2284	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
963		2285
964	=item $timer = $timer->stop	2286	=item $timer = $timer->stop
965		2287
966	Stop the timer.	2288	Stop the timer.
967		2289
…		…
973		2295
974	$term->{socket} = ...	2296	$term->{socket} = ...
975	$term->{iow} = urxvt::iow	2297	$term->{iow} = urxvt::iow
976	->new	2298	->new
977	->fd (fileno $term->{socket})	2299	->fd (fileno $term->{socket})
978	->events (1) # wait for read data	2300	->events (urxvt::EV_READ)
979	->start	2301	->start
980	->cb (sub {	2302	->cb (sub {
981	my ($iow, $revents) = @_;	2303	my ($iow, $revents) = @_;
982	# $revents must be 1 here, no need to check	2304	# $revents must be 1 here, no need to check
983	sysread $term->{socket}, my $buf, 8192	2305	sysread $term->{socket}, my $buf, 8192
…		…
996	Set the callback to be called when io events are triggered. C<$reventmask>	2318	Set the callback to be called when io events are triggered. C<$reventmask>
997	is a bitset as described in the C<events> method.	2319	is a bitset as described in the C<events> method.
998		2320
999	=item $iow = $iow->fd ($fd)	2321	=item $iow = $iow->fd ($fd)
1000		2322
1001	Set the filedescriptor (not handle) to watch.	2323	Set the file descriptor (not handle) to watch.
1002		2324
1003	=item $iow = $iow->events ($eventmask)	2325	=item $iow = $iow->events ($eventmask)
1004		2326
1005	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	2327	Set the event mask to watch. The only allowed values are
1006	data, Bit #1 (value C<2>) enables watching for write data.	2328	C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
		2329	together, or C<urxvt::EV_NONE>.
1007		2330
1008	=item $iow = $iow->start	2331	=item $iow = $iow->start
1009		2332
1010	Start watching for requested events on the given handle.	2333	Start watching for requested events on the given handle.
1011		2334
1012	=item $iow = $iow->stop	2335	=item $iow = $iow->stop
1013		2336
1014	Stop watching for events on the given filehandle.	2337	Stop watching for events on the given file handle.
		2338
		2339	=back
		2340
		2341	=head2 The C<urxvt::iw> Class
		2342
		2343	This class implements idle watchers, that get called automatically when
		2344	the process is idle. They should return as fast as possible, after doing
		2345	some useful work.
		2346
		2347	=over 4
		2348
		2349	=item $iw = new urxvt::iw
		2350
		2351	Create a new idle watcher object in stopped state.
		2352
		2353	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2354
		2355	Set the callback to be called when the watcher triggers.
		2356
		2357	=item $timer = $timer->start
		2358
		2359	Start the watcher.
		2360
		2361	=item $timer = $timer->stop
		2362
		2363	Stop the watcher.
		2364
		2365	=back
		2366
		2367	=head2 The C<urxvt::pw> Class
		2368
		2369	This class implements process watchers. They create an event whenever a
		2370	process exits, after which they stop automatically.
		2371
		2372	my $pid = fork;
		2373	...
		2374	$term->{pw} = urxvt::pw
		2375	->new
		2376	->start ($pid)
		2377	->cb (sub {
		2378	my ($pw, $exit_status) = @_;
		2379	...
		2380	});
		2381
		2382	=over 4
		2383
		2384	=item $pw = new urxvt::pw
		2385
		2386	Create a new process watcher in stopped state.
		2387
		2388	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2389
		2390	Set the callback to be called when the timer triggers.
		2391
		2392	=item $pw = $timer->start ($pid)
		2393
		2394	Tells the watcher to start watching for process C<$pid>.
		2395
		2396	=item $pw = $pw->stop
		2397
		2398	Stop the watcher.
1015		2399
1016	=back	2400	=back
1017		2401
1018	=head1 ENVIRONMENT	2402	=head1 ENVIRONMENT
1019		2403
…		…
1022	This variable controls the verbosity level of the perl extension. Higher	2406	This variable controls the verbosity level of the perl extension. Higher
1023	numbers indicate more verbose output.	2407	numbers indicate more verbose output.
1024		2408
1025	=over 4	2409	=over 4
1026		2410
1027	=item =0 - only fatal messages	2411	=item == 0 - fatal messages
1028		2412
1029	=item =3 - script loading and management	2413	=item >= 3 - script loading and management
1030		2414
1031	=item =10 - all events received	2415	=item >=10 - all called hooks
		2416
		2417	=item >=11 - hook return values
1032		2418
1033	=back	2419	=back
1034		2420
1035	=head1 AUTHOR	2421	=head1 AUTHOR
1036		2422
1037	Marc Lehmann <pcg@goof.com>	2423	Marc Lehmann <schmorp@schmorp.de>
1038	http://software.schmorp.de/pkg/rxvt-unicode	2424	http://software.schmorp.de/pkg/rxvt-unicode
1039		2425
1040	=cut	2426	=cut
1041		2427
1042	1	2428	1
		2429
		2430	# vim: sw=3:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.38 by root, Fri Jan 6 03:43:12 2006 UTC vs. Revision 1.215 by root, Thu Jun 7 16:30:58 2012 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.38 by root, Fri Jan 6 03:43:12 2006 UTC vs.
Revision 1.215 by root, Thu Jun 7 16:30:58 2012 UTC