ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.68 by root, Mon Jan 9 20:00:31 2006 UTC vs.
Revision 1.152 by tpope, Tue Jan 9 16:18:56 2007 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, extension scripts specified via	22	Every time a terminal object gets created, extension scripts specified via
23	the C<perl> resource are loaded and associated with it.	23	the C<perl> resource are loaded and associated with it.
24		24
25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and	25	Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
31	=head2 Prepackaged Extensions	31	=head1 PREPACKAGED EXTENSIONS
32		32
33	This section describes the extensiosn delivered with this version. You can	33	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
39		39
		40	Or by adding them to the resource for extensions loaded by default:
		41
		42	URxvt.perl-ext-common: default,automove-background,selection-autotransform
		43
40	=over 4	44	=over 4
41		45
42	=item selection (enabled by default)	46	=item selection (enabled by default)
43		47
44	Intelligent selection. This extension tries to be more intelligent when	48	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	49	when the user extends selections (double-click and further clicks). Right
46	urls and complete shell-quoted arguments, which is very convenient, too,	50	now, it tries to select words, urls and complete shell-quoted
47	if your F<ls> supports C<--quoting-style=shell>.	51	arguments, which is very convenient, too, if your F<ls> supports
		52	C<--quoting-style=shell>.
48		53
49	It also offers the following bindable event:	54	A double-click usually selects the word under the cursor, further clicks
		55	will enlarge the selection.
		56
		57	The selection works by trying to match a number of regexes and displaying
		58	them in increasing order of length. You can add your own regexes by
		59	specifying resources of the form:
		60
		61	URxvt.selection.pattern-0: perl-regex
		62	URxvt.selection.pattern-1: perl-regex
		63	...
		64
		65	The index number (0, 1...) must not have any holes, and each regex must
		66	contain at least one pair of capturing parentheses, which will be used for
		67	the match. For example, the following adds a regex that matches everything
		68	between two vertical bars:
		69
		70	URxvt.selection.pattern-0: \\|([^|]+)\\|
		71
		72	Another example: Programs I use often output "absolute path: " at the
		73	beginning of a line when they process multiple files. The following
		74	pattern matches the filename (note, there is a single space at the very
		75	end):
		76
		77	URxvt.selection.pattern-0: ^(/[^:]+):\
		78
		79	You can look at the source of the selection extension to see more
		80	interesting uses, such as parsing a line from beginning to end.
		81
		82	This extension also offers following bindable keyboard commands:
50		83
51	=over 4	84	=over 4
52		85
53	=item rot13	86	=item rot13
54		87
…		…
61	=item option-popup (enabled by default)	94	=item option-popup (enabled by default)
62		95
63	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at	96	Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64	runtime.	97	runtime.
65		98
		99	Other extensions can extend this popup menu by pushing a code reference
		100	onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
		101	popup is being displayed.
		102
		103	It's sole argument is the popup menu, which can be modified. It should
		104	either return nothing or a string, the initial boolean value and a code
		105	reference. The string will be used as button text and the code reference
		106	will be called when the toggle changes, with the new boolean value as
		107	first argument.
		108
		109	The following will add an entry C<myoption> that changes
		110	C<$self->{myoption}>:
		111
		112	push @{ $self->{term}{option_popup_hook} }, sub {
		113	("my option" => $myoption, sub { $self->{myoption} = $_[0] })
		114	};
		115
66	=item selection-popup (enabled by default)	116	=item selection-popup (enabled by default)
67		117
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	118	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	119	text into various other formats/action (such as uri unescaping, perl
		120	evaluation, web-browser starting etc.), depending on content.
70		121
71	=item digital-clock	122	Other extensions can extend this popup menu by pushing a code reference
		123	onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
		124	popup is being displayed.
72		125
73	Displays a digital clock using the built-in overlay.	126	It's sole argument is the popup menu, which can be modified. The selection
		127	is in C<$_>, which can be used to decide whether to add something or not.
		128	It should either return nothing or a string and a code reference. The
		129	string will be used as button text and the code reference will be called
		130	when the button gets activated and should transform C<$_>.
74		131
75	=item mark-urls	132	The following will add an entry C<a to b> that transforms all C<a>s in
		133	the selection to C<b>s, but only if the selection currently contains any
		134	C<a>s:
76		135
		136	push @{ $self->{term}{selection_popup_hook} }, sub {
		137	/a/ ? ("a to be" => sub { s/a/b/g }
		138	: ()
		139	};
		140
		141	=item searchable-scrollback<hotkey> (enabled by default)
		142
		143	Adds regex search functionality to the scrollback buffer, triggered
		144	by a hotkey (default: C<M-s>). While in search mode, normal terminal
		145	input/output is suspended and a regex is displayed at the bottom of the
		146	screen.
		147
		148	Inputting characters appends them to the regex and continues incremental
		149	search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
		150	search upwards/downwards in the scrollback buffer, C<End> jumps to the
		151	bottom. C<Escape> leaves search mode and returns to the point where search
		152	was started, while C<Enter> or C<Return> stay at the current position and
		153	additionally stores the first match in the current line into the primary
		154	selection.
		155
		156	The regex defaults to "(?i)", resulting in a case-insensitive search. To
		157	get a case-sensitive search you can delete this prefix using C<BackSpace>
		158	or simply use an uppercase character which removes the "(?i)" prefix.
		159
		160	See L<perlre> for more info about perl regular expression syntax.
		161
		162	=item readline (enabled by default)
		163
		164	A support package that tries to make editing with readline easier. At
		165	the moment, it reacts to clicking shift-left mouse button by trying to
		166	move the text cursor to this position. It does so by generating as many
		167	cursor-left or cursor-right keypresses as required (the this only works
		168	for programs that correctly support wide characters).
		169
		170	To avoid too many false positives, this is only done when:
		171
		172	=over 4
		173
		174	=item - the tty is in ICANON state.
		175
		176	=item - the text cursor is visible.
		177
		178	=item - the primary screen is currently being displayed.
		179
		180	=item - the mouse is on the same (multi-row-) line as the text cursor.
		181
		182	=back
		183
		184	The normal selection mechanism isn't disabled, so quick successive clicks
		185	might interfere with selection creation in harmless ways.
		186
		187	=item selection-autotransform
		188
		189	This selection allows you to do automatic transforms on a selection
		190	whenever a selection is made.
		191
		192	It works by specifying perl snippets (most useful is a single C<s///>
		193	operator) that modify C<$_> as resources:
		194
		195	URxvt.selection-autotransform.0: transform
		196	URxvt.selection-autotransform.1: transform
		197	...
		198
		199	For example, the following will transform selections of the form
		200	C<filename:number>, often seen in compiler messages, into C<vi +$filename
		201	$word>:
		202
		203	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
		204
		205	And this example matches the same,but replaces it with vi-commands you can
		206	paste directly into your (vi :) editor:
		207
		208	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
		209
		210	Of course, this can be modified to suit your needs and your editor :)
		211
		212	To expand the example above to typical perl error messages ("XXX at
		213	FILENAME line YYY."), you need a slightly more elaborate solution:
		214
		215	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		216	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		217
		218	The first line tells the selection code to treat the unchanging part of
		219	every error message as a selection pattern, and the second line transforms
		220	the message into vi commands to load the file.
		221
		222	=item tabbed
		223
		224	This transforms the terminal into a tabbar with additional terminals, that
		225	is, it implements what is commonly referred to as "tabbed terminal". The topmost line
		226	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		227	button per tab.
		228
		229	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		230	B<Shift-Right> will switch to the tab left or right of the current one,
		231	while B<Shift-Down> creates a new tab.
		232
		233	The tabbar itself can be configured similarly to a normal terminal, but
		234	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		235	following four resources (shown with defaults):
		236
		237	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		238	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		239	URxvt.tabbed.tab-fg: <colour-index, default 0>
		240	URxvt.tabbed.tab-bg: <colour-index, default 1>
		241
		242	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		243	indices.
		244
		245	=item matcher
		246
77	Uses per-line display filtering (C<on_line_update>) to underline urls.	247	Uses per-line display filtering (C<on_line_update>) to underline text
		248	matching a certain pattern and make it clickable. When clicked with the
		249	mouse button specified in the C<matcher.button> resource (default 2, or
		250	middle), the program specified in the C<matcher.launcher> resource
		251	(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
		252	with the matched text as first argument. The default configuration is
		253	suitable for matching URLs and launching a web browser, like the
		254	former "mark-urls" extension.
		255
		256	The default pattern to match URLs can be overridden with the
		257	C<matcher.pattern.0> resource, and additional patterns can be specified
		258	with numbered patterns, in a manner similar to the "selection" extension.
		259	The launcher can also be overridden on a per-pattern basis.
		260
		261	Example configuration:
		262
		263	URxvt.perl-ext: default,matcher
		264	URxvt.urlLauncher: sensible-browser
		265	URxvt.keysym.C-Delete: perl:matcher
		266	URxvt.matcher.button: 1
		267	URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
		268	URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
		269	URxvt.matcher.launcher.2: gvim +$2 $1
		270
		271	=item xim-onthespot
		272
		273	This (experimental) perl extension implements OnTheSpot editing. It does
		274	not work perfectly, and some input methods don't seem to work well with
		275	OnTheSpot editing in general, but it seems to work at leats for SCIM and
		276	kinput2.
		277
		278	You enable it by specifying this extension and a preedit style of
		279	C<OnTheSpot>, i.e.:
		280
		281	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		282
		283	=item kuake<hotkey>
		284
		285	A very primitive quake-console-like extension. It was inspired by a
		286	description of how the programs C<kuake> and C<yakuake> work: Whenever the
		287	user presses a global accelerator key (by default C<F10>), the terminal
		288	will show or hide itself. Another press of the accelerator key will hide
		289	or show it again.
		290
		291	Initially, the window will not be shown when using this extension.
		292
		293	This is useful if you need a single terminal thats not using any desktop
		294	space most of the time but is quickly available at the press of a key.
		295
		296	The accelerator key is grabbed regardless of any modifiers, so this
		297	extension will actually grab a physical key just for this function.
		298
		299	If you want a quake-like animation, tell your window manager to do so
		300	(fvwm can do it).
		301
		302	=item automove-background
		303
		304	This is basically a very small extension that dynamically changes the
		305	background pixmap offset to the window position, in effect creating the
		306	same effect as pseudo transparency with a custom pixmap. No scaling is
		307	supported in this mode. Example:
		308
		309	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
78		310
79	=item block-graphics-to-ascii	311	=item block-graphics-to-ascii
80		312
81	A not very useful example of filtering all text output to the terminal,	313	A not very useful example of filtering all text output to the terminal
82	by replacing all line-drawing characters (U+2500 .. U+259F) by a	314	by replacing all line-drawing characters (U+2500 .. U+259F) by a
83	similar-looking ascii character.	315	similar-looking ascii character.
		316
		317	=item digital-clock
		318
		319	Displays a digital clock using the built-in overlay.
		320
		321	=item remote-clipboard
		322
		323	Somewhat of a misnomer, this extension adds two menu entries to the
		324	selection popup that allows one ti run external commands to store the
		325	selection somewhere and fetch it again.
		326
		327	We use it to implement a "distributed selection mechanism", which just
		328	means that one command uploads the file to a remote server, and another
		329	reads it.
		330
		331	The commands can be set using the C<URxvt.remote-selection.store> and
		332	C<URxvt.remote-selection.fetch> resources. The first should read the
		333	selection to store from STDIN (always in UTF-8), the second should provide
		334	the selection data on STDOUT (also in UTF-8).
		335
		336	The defaults (which are likely useless to you) use rsh and cat:
		337
		338	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		339	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		340
		341	=item selection-pastebin
		342
		343	This is a little rarely useful extension that Uploads the selection as
		344	textfile to a remote site (or does other things). (The implementation is
		345	not currently secure for use in a multiuser environment as it writes to
		346	F</tmp> directly.).
		347
		348	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		349	i.e.
		350
		351	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		352
		353	Pressing this combination runs a command with C<%> replaced by the name of
		354	the textfile. This command can be set via a resource:
		355
		356	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		357
		358	And the default is likely not useful to anybody but the few people around
		359	here :)
		360
		361	The name of the textfile is the hex encoded md5 sum of the selection, so
		362	the same content should lead to the same filename.
		363
		364	After a successful upload the selection will be replaced by the text given
		365	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		366	for the filename):
		367
		368	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
		369
		370	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
		371	the double C</> characters as comment start. Use C<\057\057> instead,
		372	which works regardless of wether xrdb is used to parse the resource file
		373	or not.
84		374
85	=item example-refresh-hooks	375	=item example-refresh-hooks
86		376
87	Displays a very simple digital clock in the upper right corner of the	377	Displays a very simple digital clock in the upper right corner of the
88	window. Illustrates overwriting the refresh callbacks to create your own	378	window. Illustrates overwriting the refresh callbacks to create your own
89	overlays or changes.	379	overlays or changes.
90		380
91	=back	381	=back
		382
		383	=head1 API DOCUMENTATION
92		384
93	=head2 General API Considerations	385	=head2 General API Considerations
94		386
95	All objects (such as terminals, time watchers etc.) are typical	387	All objects (such as terminals, time watchers etc.) are typical
96	reference-to-hash objects. The hash can be used to store anything you	388	reference-to-hash objects. The hash can be used to store anything you
…		…
109	=over 4	401	=over 4
110		402
111	=item $text	403	=item $text
112		404
113	Rxvt-unicodes special way of encoding text, where one "unicode" character	405	Rxvt-unicodes special way of encoding text, where one "unicode" character
114	always represents one screen cell. See L<row_t> for a discussion of this format.	406	always represents one screen cell. See L<ROW_t> for a discussion of this format.
115		407
116	=item $string	408	=item $string
117		409
118	A perl text string, with an emphasis on I<text>. It can store all unicode	410	A perl text string, with an emphasis on I<text>. It can store all unicode
119	characters and is to be distinguished with text encoded in a specific	411	characters and is to be distinguished with text encoded in a specific
…		…
124	Either binary data or - more common - a text string encoded in a	416	Either binary data or - more common - a text string encoded in a
125	locale-specific way.	417	locale-specific way.
126		418
127	=back	419	=back
128		420
		421	=head2 Extension Objects
		422
		423	Every perl extension is a perl class. A separate perl object is created
		424	for each terminal, and each terminal has its own set of extenion objects,
		425	which are passed as the first parameter to hooks. So extensions can use
		426	their C<$self> object without having to think about clashes with other
		427	extensions or other terminals, with the exception of methods and members
		428	that begin with an underscore character C<_>: these are reserved for
		429	internal use.
		430
		431	Although it isn't a C<urxvt::term> object, you can call all methods of the
		432	C<urxvt::term> class on this object.
		433
		434	It has the following methods and data members:
		435
		436	=over 4
		437
		438	=item $urxvt_term = $self->{term}
		439
		440	Returns the C<urxvt::term> object associated with this instance of the
		441	extension. This member I<must not> be changed in any way.
		442
		443	=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
		444
		445	Dynamically enable the given hooks (named without the C<on_> prefix) for
		446	this extension, replacing any previous hook. This is useful when you want
		447	to overwrite time-critical hooks only temporarily.
		448
		449	=item $self->disable ($hook_name[, $hook_name..])
		450
		451	Dynamically disable the given hooks.
		452
		453	=back
		454
129	=head2 Hooks	455	=head2 Hooks
130		456
131	The following subroutines can be declared in extension files, and will be	457	The following subroutines can be declared in extension files, and will be
132	called whenever the relevant event happens.	458	called whenever the relevant event happens.
133		459
134	The first argument passed to them is an object private to each terminal	460	The first argument passed to them is an extension object as described in
135	and extension package. You can call all C<urxvt::term> methods on it, but	461	the in the C<Extension Objects> section.
136	its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
137	object that is shared between all packages is stored in the C<term>
138	member. It is, however, blessed intot he package of the extension script,
139	so for all practical purposes you can treat an extension script as a class.
140		462
141	All of them must return a boolean value. If it is true, then the event	463	B<All> of these hooks must return a boolean value. If any of the called
142	counts as being I<consumed>, and the invocation of other hooks is skipped,	464	hooks returns true, then the event counts as being I<consumed>, and the
143	and the relevant action might not be carried out by the C++ code.	465	relevant action might not be carried out by the C++ code.
144		466
145	When in doubt, return a false value (preferably C<()>).	467	I<< When in doubt, return a false value (preferably C<()>). >>
146		468
147	=over 4	469	=over 4
148		470
149	=item on_init $term	471	=item on_init $term
150		472
151	Called after a new terminal object has been initialized, but before	473	Called after a new terminal object has been initialized, but before
152	windows are created or the command gets run. Most methods are unsafe to	474	windows are created or the command gets run. Most methods are unsafe to
153	call or deliver senseless data, as terminal size and other characteristics	475	call or deliver senseless data, as terminal size and other characteristics
154	have not yet been determined. You can safely query and change resources,	476	have not yet been determined. You can safely query and change resources
155	though.	477	and options, though. For many purposes the C<on_start> hook is a better
		478	place.
		479
		480	=item on_start $term
		481
		482	Called at the very end of initialisation of a new terminal, just before
		483	trying to map (display) the toplevel and returning to the main loop.
		484
		485	=item on_destroy $term
		486
		487	Called whenever something tries to destroy terminal, when the terminal is
		488	still fully functional (not for long, though).
156		489
157	=item on_reset $term	490	=item on_reset $term
158		491
159	Called after the screen is "reset" for any reason, such as resizing or	492	Called after the screen is "reset" for any reason, such as resizing or
160	control sequences. Here is where you can react on changes to size-related	493	control sequences. Here is where you can react on changes to size-related
161	variables.	494	variables.
162		495
163	=item on_start $term	496	=item on_child_start $term, $pid
164		497
165	Called at the very end of initialisation of a new terminal, just before	498	Called just after the child process has been C<fork>ed.
166	returning to the mainloop.	499
		500	=item on_child_exit $term, $status
		501
		502	Called just after the child process has exited. C<$status> is the status
		503	from C<waitpid>.
167		504
168	=item on_sel_make $term, $eventtime	505	=item on_sel_make $term, $eventtime
169		506
170	Called whenever a selection has been made by the user, but before the	507	Called whenever a selection has been made by the user, but before the
171	selection text is copied, so changes to the beginning, end or type of the	508	selection text is copied, so changes to the beginning, end or type of the
…		…
178		515
179	Called whenever a selection has been copied, but before the selection is	516	Called whenever a selection has been copied, but before the selection is
180	requested from the server. The selection text can be queried and changed	517	requested from the server. The selection text can be queried and changed
181	by calling C<< $term->selection >>.	518	by calling C<< $term->selection >>.
182		519
183	Returning a true value aborts selection grabbing. It will still be hilighted.	520	Returning a true value aborts selection grabbing. It will still be highlighted.
184		521
185	=item on_sel_extend $term	522	=item on_sel_extend $term
186		523
187	Called whenever the user tries to extend the selection (e.g. with a double	524	Called whenever the user tries to extend the selection (e.g. with a double
188	click) and is either supposed to return false (normal operation), or	525	click) and is either supposed to return false (normal operation), or
189	should extend the selection itelf and return true to suppress the built-in	526	should extend the selection itself and return true to suppress the built-in
190	processing.	527	processing. This can happen multiple times, as long as the callback
		528	returns true, it will be called on every further click by the user and is
		529	supposed to enlarge the selection more and more, if possible.
191		530
192	See the F<selection> example extension.	531	See the F<selection> example extension.
193		532
194	=item on_view_change $term, $offset	533	=item on_view_change $term, $offset
195		534
196	Called whenever the view offset changes, i..e the user or program	535	Called whenever the view offset changes, i.e. the user or program
197	scrolls. Offset C<0> means display the normal terminal, positive values	536	scrolls. Offset C<0> means display the normal terminal, positive values
198	show this many lines of scrollback.	537	show this many lines of scrollback.
199		538
200	=item on_scroll_back $term, $lines, $saved	539	=item on_scroll_back $term, $lines, $saved
201		540
…		…
205		544
206	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	545	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	546	$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.	547	number of lines that will be in the scrollback buffer.
209		548
		549	=item on_osc_seq $term, $op, $args
		550
		551	Called on every OSC sequence and can be used to suppress it or modify its
		552	behaviour. The default should be to return an empty list. A true value
		553	suppresses execution of the request completely. Make sure you don't get
		554	confused by recursive invocations when you output an osc sequence within
		555	this callback.
		556
		557	C<on_osc_seq_perl> should be used for new behaviour.
		558
210	=item on_osc_seq $term, $string	559	=item on_osc_seq_perl $term, $string
211		560
212	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	561	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
213	operating system command) is processed. Cursor position and other state	562	operating system command) is processed. Cursor position and other state
214	information is up-to-date when this happens. For interoperability, the	563	information is up-to-date when this happens. For interoperability, the
215	string should start with the extension name and a colon, to distinguish	564	string should start with the extension name and a colon, to distinguish
216	it from commands for other extensions, and this might be enforced in the	565	it from commands for other extensions, and this might be enforced in the
217	future.	566	future.
218		567
219	Be careful not ever to trust (in a security sense) the data you receive,	568	Be careful not ever to trust (in a security sense) the data you receive,
220	as its source can not easily be controleld (e-mail content, messages from	569	as its source can not easily be controlled (e-mail content, messages from
221	other users on the same system etc.).	570	other users on the same system etc.).
222		571
223	=item on_add_lines $term, $string	572	=item on_add_lines $term, $string
224		573
225	Called whenever text is about to be output, with the text as argument. You	574	Called whenever text is about to be output, with the text as argument. You
226	can filter/change and output the text yourself by returning a true value	575	can filter/change and output the text yourself by returning a true value
227	and calling C<< $term->scr_add_lines >> yourself. Please note that this	576	and calling C<< $term->scr_add_lines >> yourself. Please note that this
228	might be very slow, however, as your hook is called for B<all> text being	577	might be very slow, however, as your hook is called for B<all> text being
229	output.	578	output.
230		579
		580	=item on_tt_write $term, $octets
		581
		582	Called whenever some data is written to the tty/pty and can be used to
		583	suppress or filter tty input.
		584
231	=item on_line_update $term, $row	585	=item on_line_update $term, $row
232		586
233	Called whenever a line was updated or changed. Can be used to filter	587	Called whenever a line was updated or changed. Can be used to filter
234	screen output (e.g. underline urls or other useless stuff). Only lines	588	screen output (e.g. underline urls or other useless stuff). Only lines
235	that are being shown will be filtered, and, due to performance reasons,	589	that are being shown will be filtered, and, due to performance reasons,
…		…
251		605
252	=item on_refresh_end $term	606	=item on_refresh_end $term
253		607
254	Called just after the screen gets redrawn. See C<on_refresh_begin>.	608	Called just after the screen gets redrawn. See C<on_refresh_begin>.
255		609
256	=item on_keyboard_command $term, $string	610	=item on_user_command $term, $string
257		611
258	Called whenever the user presses a key combination that has a	612	Called whenever a user-configured event is being activated (e.g. via
259	C<perl:string> action bound to it (see description of the B<keysym>	613	a C<perl:string> action bound to a key, see description of the B<keysym>
260	resource in the @@RXVT_NAME@@(1) manpage).	614	resource in the @@RXVT_NAME@@(1) manpage).
		615
		616	The event is simply the action string. This interface is assumed to change
		617	slightly in the future.
		618
		619	=item on_resize_all_windows $tern, $new_width, $new_height
		620
		621	Called just after the new window size has been calculated, but before
		622	windows are actually being resized or hints are being set. If this hook
		623	returns TRUE, setting of the window hints is being skipped.
		624
		625	=item on_x_event $term, $event
		626
		627	Called on every X event received on the vt window (and possibly other
		628	windows). Should only be used as a last resort. Most event structure
		629	members are not passed.
		630
		631	=item on_root_event $term, $event
		632
		633	Like C<on_x_event>, but is called for events on the root window.
261		634
262	=item on_focus_in $term	635	=item on_focus_in $term
263		636
264	Called whenever the window gets the keyboard focus, before rxvt-unicode	637	Called whenever the window gets the keyboard focus, before rxvt-unicode
265	does focus in processing.	638	does focus in processing.
266		639
267	=item on_focus_out $term	640	=item on_focus_out $term
268		641
269	Called wheneever the window loses keyboard focus, before rxvt-unicode does	642	Called whenever the window loses keyboard focus, before rxvt-unicode does
270	focus out processing.	643	focus out processing.
271		644
		645	=item on_configure_notify $term, $event
		646
		647	=item on_property_notify $term, $event
		648
272	=item on_key_press $term, $event, $octets	649	=item on_key_press $term, $event, $keysym, $octets
273		650
274	=item on_key_release $term, $event	651	=item on_key_release $term, $event, $keysym
275		652
276	=item on_button_press $term, $event	653	=item on_button_press $term, $event
277		654
278	=item on_button_release $term, $event	655	=item on_button_release $term, $event
279		656
…		…
285		662
286	Called whenever the corresponding X event is received for the terminal If	663	Called whenever the corresponding X event is received for the terminal If
287	the hook returns true, then the even will be ignored by rxvt-unicode.	664	the hook returns true, then the even will be ignored by rxvt-unicode.
288		665
289	The event is a hash with most values as named by Xlib (see the XEvent	666	The event is a hash with most values as named by Xlib (see the XEvent
290	manpage), with the additional members C<row> and C<col>, which are the row	667	manpage), with the additional members C<row> and C<col>, which are the
291	and column under the mouse cursor.	668	(real, not screen-based) row and column under the mouse cursor.
292		669
293	C<on_key_press> additionally receives the string rxvt-unicode would	670	C<on_key_press> additionally receives the string rxvt-unicode would
294	output, if any, in locale-specific encoding.	671	output, if any, in locale-specific encoding.
295		672
296	subwindow.	673	subwindow.
297		674
		675	=item on_client_message $term, $event
		676
		677	=item on_wm_protocols $term, $event
		678
		679	=item on_wm_delete_window $term, $event
		680
		681	Called when various types of ClientMessage events are received (all with
		682	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		683
298	=back	684	=back
299		685
		686	=cut
		687
		688	package urxvt;
		689
		690	use utf8;
		691	use strict;
		692	use Carp ();
		693	use Scalar::Util ();
		694	use List::Util ();
		695
		696	our $VERSION = 1;
		697	our $TERM;
		698	our @TERM_INIT;
		699	our @TERM_EXT;
		700	our @HOOKNAME;
		701	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
		702	our %OPTION;
		703
		704	our $LIBDIR;
		705	our $RESNAME;
		706	our $RESCLASS;
		707	our $RXVTNAME;
		708
		709	our $NOCHAR = chr 0xffff;
		710
300	=head2 Variables in the C<urxvt> Package	711	=head2 Variables in the C<urxvt> Package
301		712
302	=over 4	713	=over 4
		714
		715	=item $urxvt::LIBDIR
		716
		717	The rxvt-unicode library directory, where, among other things, the perl
		718	modules and scripts are stored.
		719
		720	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		721
		722	The resource class and name rxvt-unicode uses to look up X resources.
		723
		724	=item $urxvt::RXVTNAME
		725
		726	The basename of the installed binaries, usually C<urxvt>.
303		727
304	=item $urxvt::TERM	728	=item $urxvt::TERM
305		729
306	The current terminal. This variable stores the current C<urxvt::term>	730	The current terminal. This variable stores the current C<urxvt::term>
307	object, whenever a callback/hook is executing.	731	object, whenever a callback/hook is executing.
308		732
		733	=item @urxvt::TERM_INIT
		734
		735	All code references in this array will be called as methods of the next newly
		736	created C<urxvt::term> object (during the C<on_init> phase). The array
		737	gets cleared before the code references that were in it are being executed,
		738	so references can push themselves onto it again if they so desire.
		739
		740	This complements to the perl-eval command line option, but gets executed
		741	first.
		742
		743	=item @urxvt::TERM_EXT
		744
		745	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		746	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		747	but before other extensions. Gets cleared just like C<@TERM_INIT>.
		748
309	=back	749	=back
310		750
311	=head2 Functions in the C<urxvt> Package	751	=head2 Functions in the C<urxvt> Package
312		752
313	=over 4	753	=over 4
314
315	=item $term = new urxvt [arg...]
316
317	Creates a new terminal, very similar as if you had started it with
318	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
319	if the new instance couldn't be created. Returns C<undef> if the new
320	instance didn't initialise perl, and the terminal object otherwise. The
321	C<init> and C<start> hooks will be called during the call.
322		754
323	=item urxvt::fatal $errormessage	755	=item urxvt::fatal $errormessage
324		756
325	Fatally aborts execution with the given error message. Avoid at all	757	Fatally aborts execution with the given error message. Avoid at all
326	costs! The only time this is acceptable is when the terminal process	758	costs! The only time this is acceptable is when the terminal process
…		…
333	that calls this function.	765	that calls this function.
334		766
335	Using this function has the advantage that its output ends up in the	767	Using this function has the advantage that its output ends up in the
336	correct place, e.g. on stderr of the connecting urxvtc client.	768	correct place, e.g. on stderr of the connecting urxvtc client.
337		769
338	=item $is_safe = urxvt::safe	770	Messages have a size limit of 1023 bytes currently.
339		771
340	Returns true when it is safe to do potentially unsafe things, such as	772	=item @terms = urxvt::termlist
341	evaluating perl code specified by the user. This is true when urxvt was	773
342	started setuid or setgid.	774	Returns all urxvt::term objects that exist in this process, regardless of
		775	whether they are started, being destroyed etc., so be careful. Only term
		776	objects that have perl extensions attached will be returned (because there
		777	is no urxvt::term objet associated with others).
343		778
344	=item $time = urxvt::NOW	779	=item $time = urxvt::NOW
345		780
346	Returns the "current time" (as per the event loop).	781	Returns the "current time" (as per the event loop).
347		782
348	=item urxvt::CurrentTime	783	=item urxvt::CurrentTime
349		784
350	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	785	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
351	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	786	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
352	Button4Mask, Button5Mask, AnyModifier	787	Button4Mask, Button5Mask, AnyModifier
		788
		789	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		790	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		791	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		792	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		793	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		794	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		795	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		796
		797	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		798	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		799	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		800	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		801	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		802	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		803	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
353		804
354	Various constants for use in X calls and event processing.	805	Various constants for use in X calls and event processing.
355		806
356	=back	807	=back
357		808
…		…
386		837
387	=item $background = urxvt::GET_BASEBG $rend	838	=item $background = urxvt::GET_BASEBG $rend
388		839
389	Return the foreground/background colour index, respectively.	840	Return the foreground/background colour index, respectively.
390		841
391	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)	842	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
392		843
393	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)	844	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		845
		846	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
394		847
395	Replace the foreground/background colour in the rendition mask with the	848	Replace the foreground/background colour in the rendition mask with the
396	specified one.	849	specified one.
397		850
398	=item $value = urxvt::GET_CUSTOM ($rend)	851	=item $value = urxvt::GET_CUSTOM $rend
399		852
400	Return the "custom" value: Every rendition has 5 bits for use by	853	Return the "custom" value: Every rendition has 5 bits for use by
401	extensions. They can be set and changed as you like and are initially	854	extensions. They can be set and changed as you like and are initially
402	zero.	855	zero.
403		856
404	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)	857	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
405		858
406	Change the custom value.	859	Change the custom value.
407		860
408	=back	861	=back
409		862
410	=cut	863	=cut
411		864
412	package urxvt;
413
414	use utf8;
415	use strict;
416	use Scalar::Util ();
417	use List::Util ();
418
419	our $VERSION = 1;
420	our $TERM;
421	our @HOOKNAME;
422	our %OPTION;
423	our $LIBDIR;
424
425	BEGIN {	865	BEGIN {
426	urxvt->bootstrap;
427
428	# overwrite perl's warn	866	# overwrite perl's warn
429	*CORE::GLOBAL::warn = sub {	867	*CORE::GLOBAL::warn = sub {
430	my $msg = join "", @_;	868	my $msg = join "", @_;
431	$msg .= "\n"	869	$msg .= "\n"
432	unless $msg =~ /\n$/;	870	unless $msg =~ /\n$/;
433	urxvt::warn ($msg);	871	urxvt::warn ($msg);
434	};	872	};
435
436	delete $ENV{IFS};
437	delete $ENV{CDPATH};
438	delete $ENV{BASH_ENV};
439	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
440	}	873	}
441		874
442	my @hook_count;	875	no warnings 'utf8';
		876
443	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	877	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
444		878
445	sub verbose {	879	sub verbose {
446	my ($level, $msg) = @_;	880	my ($level, $msg) = @_;
447	warn "$msg\n" if $level <= $verbosity;	881	warn "$msg\n" if $level <= $verbosity;
448	}	882	}
449		883
450	my $extension_pkg = "extension0000";
451	my %extension_pkg;	884	my %extension_pkg;
452		885
453	# load a single script into its own package, once only	886	# load a single script into its own package, once only
454	sub extension_package($) {	887	sub extension_package($) {
455	my ($path) = @_;	888	my ($path) = @_;
456		889
457	$extension_pkg{$path} ||= do {	890	$extension_pkg{$path} ||= do {
458	my $pkg = "urxvt::" . ($extension_pkg++);	891	$path =~ /([^\/\\]+)$/;
		892	my $pkg = $1;
		893	$pkg =~ s/[^[:word:]]/_/g;
		894	$pkg = "urxvt::ext::$pkg";
459		895
460	verbose 3, "loading extension '$path' into package '$pkg'";	896	verbose 3, "loading extension '$path' into package '$pkg'";
461		897
462	open my $fh, "<:raw", $path	898	open my $fh, "<:raw", $path
463	or die "$path: $!";	899	or die "$path: $!";
464		900
465	my $source = untaint "package $pkg; use strict; use utf8;\n"	901	my $source =
466	. "use base urxvt::term::proxy::;\n"	902	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
467	. "#line 1 \"$path\"\n{\n"	903	. "#line 1 \"$path\"\n{\n"
468	. (do { local $/; <$fh> })	904	. (do { local $/; <$fh> })
469	. "\n};\n1";	905	. "\n};\n1";
470		906
		907	eval $source
471	eval $source or die "$path: $@";	908	or die "$path: $@";
472		909
473	$pkg	910	$pkg
474	}	911	}
475	}	912	}
476		913
…		…
484	if ($htype == 0) { # INIT	921	if ($htype == 0) { # INIT
485	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	922	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
486		923
487	my %ext_arg;	924	my %ext_arg;
488		925
		926	{
		927	my @init = @TERM_INIT;
		928	@TERM_INIT = ();
		929	$_->($TERM) for @init;
		930	my @pkg = @TERM_EXT;
		931	@TERM_EXT = ();
		932	$TERM->register_package ($_) for @pkg;
		933	}
		934
489	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	935	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
490	if ($_ eq "default") {	936	if ($_ eq "default") {
491	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup);	937	$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
492	} elsif (/^-(.*)$/) {	938	} elsif (/^-(.*)$/) {
493	delete $ext_arg{$1};	939	delete $ext_arg{$1};
494	} elsif (/^([^<]+)<(.*)>$/) {	940	} elsif (/^([^<]+)<(.*)>$/) {
495	push @{ $ext_arg{$1} }, $2;	941	push @{ $ext_arg{$1} }, $2;
496	} else {	942	} else {
497	$ext_arg{$_} ||= [];	943	$ext_arg{$_} ||= [];
498	}	944	}
499	}	945	}
500		946
501	while (my ($ext, $argv) = each %ext_arg) {	947	for my $ext (sort keys %ext_arg) {
502	my @files = grep -f $_, map "$_/$ext", @dirs;	948	my @files = grep -f $_, map "$_/$ext", @dirs;
503		949
504	if (@files) {	950	if (@files) {
505	$TERM->register_package (extension_package $files[0], $argv);	951	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
506	} else {	952	} else {
507	warn "perl extension '$ext' not found in perl library search path\n";	953	warn "perl extension '$ext' not found in perl library search path\n";
508	}	954	}
509	}	955	}
510		956
…		…
516		962
517	if (my $cb = $TERM->{_hook}[$htype]) {	963	if (my $cb = $TERM->{_hook}[$htype]) {
518	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	964	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
519	if $verbosity >= 10;	965	if $verbosity >= 10;
520		966
521	keys %$cb;	967	for my $pkg (keys %$cb) {
522
523	while (my ($pkg, $cb) = each %$cb) {
524	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	968	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
525	and last;	969	$retval ||= $retval_;
526		970
527	if ($@) {	971	if ($@) {
528	$TERM->ungrab; # better to lose the grab than the session	972	$TERM->ungrab; # better to lose the grab than the session
529	warn $@;	973	warn $@;
530	}	974	}
531	}	975	}
		976
		977	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
		978	if $verbosity >= 11;
532	}	979	}
533		980
534	if ($htype == 1) { # DESTROY	981	if ($htype == 1) { # DESTROY
535	# remove hooks if unused
536	if (my $hook = $TERM->{_hook}) {
537	for my $htype (0..$#$hook) {
538	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
539	or set_should_invoke $htype, 0;
540	}
541	}
542
543	# clear package objects	982	# clear package objects
544	%$_ = () for values %{ $TERM->{_pkg} };	983	%$_ = () for values %{ $TERM->{_pkg} };
545		984
546	# clear package	985	# clear package
547	%$TERM = ();	986	%$TERM = ();
548	}	987	}
549		988
550	$retval	989	$retval
551	}	990	}
552		991
553	# urxvt::term::proxy	992	sub SET_COLOR($$$) {
		993	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
		994	}
554		995
555	sub urxvt::term::proxy::AUTOLOAD {	996	sub rend2mask {
556	$urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/	997	no strict 'refs';
		998	my ($str, $mask) = (@_, 0);
		999	my %color = ( fg => undef, bg => undef );
		1000	my @failed;
		1001	for my $spec ( split /\s+/, $str ) {
		1002	if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
		1003	$color{lc($1)} = $2;
		1004	} else {
		1005	my $neg = $spec =~ s/^[-^]//;
		1006	unless ( exists &{"RS_$spec"} ) {
		1007	push @failed, $spec;
		1008	next;
		1009	}
		1010	my $cur = &{"RS_$spec"};
		1011	if ( $neg ) {
		1012	$mask &= ~$cur;
		1013	} else {
		1014	$mask |= $cur;
		1015	}
		1016	}
		1017	}
		1018	($mask, @color{qw(fg bg)}, \@failed)
		1019	}
		1020
		1021	# urxvt::term::extension
		1022
		1023	package urxvt::term::extension;
		1024
		1025	sub enable {
		1026	my ($self, %hook) = @_;
		1027	my $pkg = $self->{_pkg};
		1028
		1029	while (my ($name, $cb) = each %hook) {
		1030	my $htype = $HOOKTYPE{uc $name};
		1031	defined $htype
		1032	or Carp::croak "unsupported hook type '$name'";
		1033
		1034	$self->set_should_invoke ($htype, +1)
		1035	unless exists $self->{term}{_hook}[$htype]{$pkg};
		1036
		1037	$self->{term}{_hook}[$htype]{$pkg} = $cb;
		1038	}
		1039	}
		1040
		1041	sub disable {
		1042	my ($self, @hook) = @_;
		1043	my $pkg = $self->{_pkg};
		1044
		1045	for my $name (@hook) {
		1046	my $htype = $HOOKTYPE{uc $name};
		1047	defined $htype
		1048	or Carp::croak "unsupported hook type '$name'";
		1049
		1050	$self->set_should_invoke ($htype, -1)
		1051	if delete $self->{term}{_hook}[$htype]{$pkg};
		1052	}
		1053	}
		1054
		1055	our $AUTOLOAD;
		1056
		1057	sub AUTOLOAD {
		1058	$AUTOLOAD =~ /:([^:]+)$/
557	or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";	1059	or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
558		1060
559	eval qq{	1061	eval qq{
560	sub $urxvt::term::proxy::AUTOLOAD {	1062	sub $AUTOLOAD {
561	my \$proxy = shift;	1063	my \$proxy = shift;
562	\$proxy->{term}->$1 (\@_)	1064	\$proxy->{term}->$1 (\@_)
563	}	1065	}
564	1	1066	1
565	} or die "FATAL: unable to compile method forwarder: $@";	1067	} or die "FATAL: unable to compile method forwarder: $@";
566		1068
567	goto &$urxvt::term::proxy::AUTOLOAD;	1069	goto &$AUTOLOAD;
568	}	1070	}
569		1071
570	sub urxvt::term::proxy::DESTROY {	1072	sub DESTROY {
571	# nop	1073	# nop
572	}	1074	}
573		1075
574	# urxvt::destroy_hook	1076	# urxvt::destroy_hook
575		1077
…		…
585		1087
586	=head2 The C<urxvt::anyevent> Class	1088	=head2 The C<urxvt::anyevent> Class
587		1089
588	The sole purpose of this class is to deliver an interface to the	1090	The sole purpose of this class is to deliver an interface to the
589	C<AnyEvent> module - any module using it will work inside urxvt without	1091	C<AnyEvent> module - any module using it will work inside urxvt without
590	further work. The only exception is that you cannot wait on condition	1092	further programming. The only exception is that you cannot wait on
591	variables, but non-blocking condvar use is ok. What this means is that you	1093	condition variables, but non-blocking condvar use is ok. What this means
592	cannot use blocking APIs, but the non-blocking variant should work.	1094	is that you cannot use blocking APIs, but the non-blocking variant should
		1095	work.
593		1096
594	=cut	1097	=cut
595		1098
596	our $VERSION = 1;	1099	our $VERSION = 1;
597		1100
…		…
633	sub DESTROY {	1136	sub DESTROY {
634	$_[0][1]->stop;	1137	$_[0][1]->stop;
635	}	1138	}
636		1139
637	sub condvar {	1140	sub condvar {
638	bless \my $flag, urxvt::anyevent::condvar::	1141	bless \my $flag, urxvt::anyevent::
639	}	1142	}
640		1143
641	sub urxvt::anyevent::condvar::broadcast {	1144	sub broadcast {
642	${$_[0]}++;	1145	${$_[0]}++;
643	}	1146	}
644		1147
645	sub urxvt::anyevent::condvar::wait {	1148	sub wait {
646	unless (${$_[0]}) {	1149	unless (${$_[0]}) {
647	require Carp;
648	Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");	1150	Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
649	}	1151	}
		1152	}
		1153
		1154	sub one_event {
		1155	Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
650	}	1156	}
651		1157
652	package urxvt::term;	1158	package urxvt::term;
653		1159
654	=head2 The C<urxvt::term> Class	1160	=head2 The C<urxvt::term> Class
…		…
660	# find on_xxx subs in the package and register them	1166	# find on_xxx subs in the package and register them
661	# as hooks	1167	# as hooks
662	sub register_package {	1168	sub register_package {
663	my ($self, $pkg, $argv) = @_;	1169	my ($self, $pkg, $argv) = @_;
664		1170
665	my $proxy = bless { argv => $argv }, $pkg;	1171	no strict 'refs';
		1172
		1173	urxvt::verbose 6, "register package $pkg to $self";
		1174
		1175	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1176
		1177	my $proxy = bless {
		1178	_pkg => $pkg,
		1179	argv => $argv,
		1180	}, $pkg;
666	Scalar::Util::weaken ($proxy->{term} = $TERM);	1181	Scalar::Util::weaken ($proxy->{term} = $self);
667		1182
668	$self->{_pkg}{$pkg} = $proxy;	1183	$self->{_pkg}{$pkg} = $proxy;
669		1184
670	for my $htype (0.. $#HOOKNAME) {	1185	for my $name (@HOOKNAME) {
671	my $name = $HOOKNAME[$htype];
672
673	my $ref = $pkg->can ("on_" . lc $name)	1186	if (my $ref = $pkg->can ("on_" . lc $name)) {
674	or next;	1187	$proxy->enable ($name => $ref);
675		1188	}
676	$self->{_hook}[$htype]{$pkg} = $ref;
677	$hook_count[$htype]++
678	or urxvt::set_should_invoke $htype, 1;
679	}	1189	}
680	}	1190	}
681		1191
		1192	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		1193
		1194	Creates a new terminal, very similar as if you had started it with system
		1195	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		1196	hash which defines the environment of the new terminal.
		1197
		1198	Croaks (and probably outputs an error message) if the new instance
		1199	couldn't be created. Returns C<undef> if the new instance didn't
		1200	initialise perl, and the terminal object otherwise. The C<init> and
		1201	C<start> hooks will be called before this call returns, and are free to
		1202	refer to global data (which is race free).
		1203
		1204	=cut
		1205
		1206	sub new {
		1207	my ($class, $env, @args) = @_;
		1208
		1209	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1210	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1211
		1212	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
		1213	}
		1214
682	=item $term->destroy	1215	=item $term->destroy
683		1216
684	Destroy the terminal object (close the window, free resources etc.).	1217	Destroy the terminal object (close the window, free resources
		1218	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		1219	watchers (timers, io watchers) are still active.
		1220
		1221	=item $term->exec_async ($cmd[, @args])
		1222
		1223	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1224	("starts") programs in the background. This function takes care of setting
		1225	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1226	be preferred over explicit calls to C<exec> or C<system>.
		1227
		1228	Returns the pid of the subprocess or C<undef> on error.
		1229
		1230	=cut
		1231
		1232	sub exec_async {
		1233	my $self = shift;
		1234
		1235	my $pid = fork;
		1236
		1237	return $pid
		1238	if !defined $pid or $pid;
		1239
		1240	%ENV = %{ $self->env };
		1241
		1242	exec @_;
		1243	urxvt::_exit 255;
		1244	}
685		1245
686	=item $isset = $term->option ($optval[, $set])	1246	=item $isset = $term->option ($optval[, $set])
687		1247
688	Returns true if the option specified by C<$optval> is enabled, and	1248	Returns true if the option specified by C<$optval> is enabled, and
689	optionally change it. All option values are stored by name in the hash	1249	optionally change it. All option values are stored by name in the hash
690	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1250	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
691		1251
692	Here is a a likely non-exhaustive list of option names, please see the	1252	Here is a likely non-exhaustive list of option names, please see the
693	source file F</src/optinc.h> to see the actual list:	1253	source file F</src/optinc.h> to see the actual list:
694		1254
695	borderLess console cursorBlink cursorUnderline hold iconic insecure	1255	borderLess console cursorBlink cursorUnderline hold iconic insecure
696	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1256	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
697	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1257	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
698	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1258	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
699	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1259	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
700	tripleclickwords utmpInhibit visualBell	1260	transparent tripleclickwords utmpInhibit visualBell
701		1261
702	=item $value = $term->resource ($name[, $newval])	1262	=item $value = $term->resource ($name[, $newval])
703		1263
704	Returns the current resource value associated with a given name and	1264	Returns the current resource value associated with a given name and
705	optionally sets a new value. Setting values is most useful in the C<init>	1265	optionally sets a new value. Setting values is most useful in the C<init>
…		…
714	likely change).	1274	likely change).
715		1275
716	Please note that resource strings will currently only be freed when the	1276	Please note that resource strings will currently only be freed when the
717	terminal is destroyed, so changing options frequently will eat memory.	1277	terminal is destroyed, so changing options frequently will eat memory.
718		1278
719	Here is a a likely non-exhaustive list of resource names, not all of which	1279	Here is a likely non-exhaustive list of resource names, not all of which
720	are supported in every build, please see the source file F</src/rsinc.h>	1280	are supported in every build, please see the source file F</src/rsinc.h>
721	to see the actual list:	1281	to see the actual list:
722		1282
723	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1283	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
724	borderLess color cursorBlink cursorUnderline cutchars delete_key	1284	borderLess color cursorBlink cursorUnderline cutchars delete_key
725	display_name embed ext_bwidth fade font geometry hold iconName	1285	display_name embed ext_bwidth fade font geometry hold iconName
726	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1286	imFont imLocale inputMethod insecure int_bwidth intensityStyles
727	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1287	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
728	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1288	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
729	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1289	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
730	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1290	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
731	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1291	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
732	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1292	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
733	shade term_name title transparent transparent_all tripleclickwords	1293	secondaryScreen secondaryScroll selectstyle shade term_name title
734	utmpInhibit visualBell	1294	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1295	visualBell
735		1296
736	=cut	1297	=cut
737		1298
738	sub resource($$;$) {	1299	sub resource($$;$) {
739	my ($self, $name) = (shift, shift);	1300	my ($self, $name) = (shift, shift);
740	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);	1301	unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
741	&urxvt::term::_resource	1302	&urxvt::term::_resource
742	}	1303	}
743		1304
		1305	=item $value = $term->x_resource ($pattern)
		1306
		1307	Returns the X-Resource for the given pattern, excluding the program or
		1308	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		1309	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		1310	resource with that pattern exists.
		1311
		1312	This method should only be called during the C<on_start> hook, as there is
		1313	only one resource database per display, and later invocations might return
		1314	the wrong resources.
		1315
		1316	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
		1317
		1318	Adds a keymap translation exactly as specified via a resource. See the
		1319	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
		1320
744	=item $rend = $term->rstyle ([$new_rstyle])	1321	=item $rend = $term->rstyle ([$new_rstyle])
745		1322
746	Return and optionally change the current rendition. Text that is output by	1323	Return and optionally change the current rendition. Text that is output by
747	the terminal application will use this style.	1324	the terminal application will use this style.
748		1325
…		…
758	=item ($row, $col) = $term->selection_end ([$row, $col])	1335	=item ($row, $col) = $term->selection_end ([$row, $col])
759		1336
760	Return the current values of the selection mark, begin or end positions,	1337	Return the current values of the selection mark, begin or end positions,
761	and optionally set them to new values.	1338	and optionally set them to new values.
762		1339
		1340	=item $term->selection_make ($eventtime[, $rectangular])
		1341
		1342	Tries to make a selection as set by C<selection_beg> and
		1343	C<selection_end>. If C<$rectangular> is true (default: false), a
		1344	rectangular selection will be made. This is the prefered function to make
		1345	a selection.
		1346
763	=item $success = $term->selection_grab ($eventtime)	1347	=item $success = $term->selection_grab ($eventtime)
764		1348
765	Try to request the primary selection from the server (for example, as set	1349	Try to request the primary selection text from the server (for example, as
766	by the next method).	1350	set by the next method). No visual feedback will be given. This function
		1351	is mostly useful from within C<on_sel_grab> hooks.
767		1352
768	=item $oldtext = $term->selection ([$newtext])	1353	=item $oldtext = $term->selection ([$newtext])
769		1354
770	Return the current selection text and optionally replace it by C<$newtext>.	1355	Return the current selection text and optionally replace it by C<$newtext>.
771		1356
772	#=item $term->overlay ($x, $y, $text)	1357	=item $term->overlay_simple ($x, $y, $text)
773	#	1358
774	#Create a simple multi-line overlay box. See the next method for details.	1359	Create a simple multi-line overlay box. See the next method for details.
775	#	1360
776	#=cut	1361	=cut
777	#	1362
778	#sub urxvt::term::scr_overlay {	1363	sub overlay_simple {
779	# my ($self, $x, $y, $text) = @_;	1364	my ($self, $x, $y, $text) = @_;
780	#	1365
781	# my @lines = split /\n/, $text;	1366	my @lines = split /\n/, $text;
782	#	1367
783	# my $w = 0;	1368	my $w = List::Util::max map $self->strwidth ($_), @lines;
784	# for (map $self->strwidth ($_), @lines) {	1369
785	# $w = $_ if $w < $_;
786	# }
787	#
788	# $self->scr_overlay_new ($x, $y, $w, scalar @lines);	1370	my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
789	# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;	1371	$overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
790	#}	1372
		1373	$overlay
		1374	}
791		1375
792	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])	1376	=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
793		1377
794	Create a new (empty) overlay at the given position with the given	1378	Create a new (empty) overlay at the given position with the given
795	width/height. C<$rstyle> defines the initial rendition style	1379	width/height. C<$rstyle> defines the initial rendition style
…		…
862		1446
863	=item $string = $term->locale_decode ($octets)	1447	=item $string = $term->locale_decode ($octets)
864		1448
865	Convert the given locale-encoded octets into a perl string.	1449	Convert the given locale-encoded octets into a perl string.
866		1450
		1451	=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
		1452
		1453	XORs the rendition values in the given span with the provided value
		1454	(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
		1455	refresh hooks to provide effects similar to the selection.
		1456
		1457	=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
		1458
		1459	Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
		1460	whitespace will additionally be xored with the C<$rstyle2>, which defaults
		1461	to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
		1462	it instead. Both styles I<MUST NOT> contain font styles.
		1463
		1464	=item $term->scr_bell
		1465
		1466	Ring the bell!
		1467
867	=item $term->scr_add_lines ($string)	1468	=item $term->scr_add_lines ($string)
868		1469
869	Write the given text string to the screen, as if output by the application	1470	Write the given text string to the screen, as if output by the application
870	running inside the terminal. It may not contain command sequences (escape	1471	running inside the terminal. It may not contain command sequences (escape
871	codes), but is free to use line feeds, carriage returns and tabs. The	1472	codes), but is free to use line feeds, carriage returns and tabs. The
…		…
873		1474
874	Normally its not a good idea to use this function, as programs might be	1475	Normally its not a good idea to use this function, as programs might be
875	confused by changes in cursor position or scrolling. Its useful inside a	1476	confused by changes in cursor position or scrolling. Its useful inside a
876	C<on_add_lines> hook, though.	1477	C<on_add_lines> hook, though.
877		1478
		1479	=item $term->scr_change_screen ($screen)
		1480
		1481	Switch to given screen - 0 primary, 1 secondary.
		1482
878	=item $term->cmd_parse ($octets)	1483	=item $term->cmd_parse ($octets)
879		1484
880	Similar to C<scr_add_lines>, but the argument must be in the	1485	Similar to C<scr_add_lines>, but the argument must be in the
881	locale-specific encoding of the terminal and can contain command sequences	1486	locale-specific encoding of the terminal and can contain command sequences
882	(escape codes) that will be interpreted.	1487	(escape codes) that will be interpreted.
…		…
885		1490
886	Write the octets given in C<$data> to the tty (i.e. as program input). To	1491	Write the octets given in C<$data> to the tty (i.e. as program input). To
887	pass characters instead of octets, you should convert your strings first	1492	pass characters instead of octets, you should convert your strings first
888	to the locale-specific encoding using C<< $term->locale_encode >>.	1493	to the locale-specific encoding using C<< $term->locale_encode >>.
889		1494
		1495	=item $old_events = $term->pty_ev_events ([$new_events])
		1496
		1497	Replaces the event mask of the pty watcher by the given event mask. Can
		1498	be used to suppress input and output handling to the pty/tty. See the
		1499	description of C<< urxvt::timer->events >>. Make sure to always restore
		1500	the previous value.
		1501
		1502	=item $fd = $term->pty_fd
		1503
		1504	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1505	is used.
		1506
890	=item $windowid = $term->parent	1507	=item $windowid = $term->parent
891		1508
892	Return the window id of the toplevel window.	1509	Return the window id of the toplevel window.
893		1510
894	=item $windowid = $term->vt	1511	=item $windowid = $term->vt
895		1512
896	Return the window id of the terminal window.	1513	Return the window id of the terminal window.
897		1514
		1515	=item $term->vt_emask_add ($x_event_mask)
		1516
		1517	Adds the specified events to the vt event mask. Useful e.g. when you want
		1518	to receive pointer events all the times:
		1519
		1520	$term->vt_emask_add (urxvt::PointerMotionMask);
		1521
		1522	=item $term->focus_in
		1523
		1524	=item $term->focus_out
		1525
		1526	=item $term->key_press ($state, $keycode[, $time])
		1527
		1528	=item $term->key_release ($state, $keycode[, $time])
		1529
		1530	Deliver various fake events to to terminal.
		1531
898	=item $window_width = $term->width	1532	=item $window_width = $term->width
899		1533
900	=item $window_height = $term->height	1534	=item $window_height = $term->height
901		1535
902	=item $font_width = $term->fwidth	1536	=item $font_width = $term->fwidth
…		…
915		1549
916	=item $max_scrollback = $term->saveLines	1550	=item $max_scrollback = $term->saveLines
917		1551
918	=item $nrow_plus_saveLines = $term->total_rows	1552	=item $nrow_plus_saveLines = $term->total_rows
919		1553
920	=item $lines_in_scrollback = $term->nsaved	1554	=item $topmost_scrollback_row = $term->top_row
921		1555
922	Return various integers describing terminal characteristics.	1556	Return various integers describing terminal characteristics.
923		1557
		1558	=item $x_display = $term->display_id
		1559
		1560	Return the DISPLAY used by rxvt-unicode.
		1561
924	=item $lc_ctype = $term->locale	1562	=item $lc_ctype = $term->locale
925		1563
926	Returns the LC_CTYPE category string used by this rxvt-unicode.	1564	Returns the LC_CTYPE category string used by this rxvt-unicode.
927		1565
928	=item $x_display = $term->display_id	1566	=item $env = $term->env
929		1567
930	Return the DISPLAY used by rxvt-unicode.	1568	Returns a copy of the environment in effect for the terminal as a hashref
		1569	similar to C<\%ENV>.
		1570
		1571	=item @envv = $term->envv
		1572
		1573	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1574
		1575	=item @argv = $term->argv
		1576
		1577	Return the argument vector as this terminal, similar to @ARGV, but
		1578	includes the program name as first element.
		1579
		1580	=cut
		1581
		1582	sub env {
		1583	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
		1584	}
931		1585
932	=item $modifiermask = $term->ModLevel3Mask	1586	=item $modifiermask = $term->ModLevel3Mask
933		1587
934	=item $modifiermask = $term->ModMetaMask	1588	=item $modifiermask = $term->ModMetaMask
935		1589
936	=item $modifiermask = $term->ModNumLockMask	1590	=item $modifiermask = $term->ModNumLockMask
937		1591
938	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1592	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
939	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1593	AltGr), the meta key (often Alt) and the num lock key, if applicable.
940		1594
		1595	=item $screen = $term->current_screen
		1596
		1597	Returns the currently displayed screen (0 primary, 1 secondary).
		1598
		1599	=item $cursor_is_hidden = $term->hidden_cursor
		1600
		1601	Returns whether the cursor is currently hidden or not.
		1602
941	=item $view_start = $term->view_start ([$newvalue])	1603	=item $view_start = $term->view_start ([$newvalue])
942		1604
943	Returns the negative row number of the topmost line. Minimum value is	1605	Returns the row number of the topmost displayed line. Maximum value is
944	C<0>, which displays the normal terminal contents. Larger values scroll	1606	C<0>, which displays the normal terminal contents. Lower values scroll
945	this many lines into the scrollback buffer.	1607	this many lines into the scrollback buffer.
946		1608
947	=item $term->want_refresh	1609	=item $term->want_refresh
948		1610
949	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1611	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
964	line, starting at column C<$start_col> (default C<0>), which is useful	1626	line, starting at column C<$start_col> (default C<0>), which is useful
965	to replace only parts of a line. The font index in the rendition will	1627	to replace only parts of a line. The font index in the rendition will
966	automatically be updated.	1628	automatically be updated.
967		1629
968	C<$text> is in a special encoding: tabs and wide characters that use more	1630	C<$text> is in a special encoding: tabs and wide characters that use more
969	than one cell when displayed are padded with urxvt::NOCHAR characters	1631	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
970	(C<chr 65535>). Characters with combining characters and other characters	1632	characters. Characters with combining characters and other characters that
971	that do not fit into the normal tetx encoding will be replaced with	1633	do not fit into the normal tetx encoding will be replaced with characters
972	characters in the private use area.	1634	in the private use area.
973		1635
974	You have to obey this encoding when changing text. The advantage is	1636	You have to obey this encoding when changing text. The advantage is
975	that C<substr> and similar functions work on screen cells and not on	1637	that C<substr> and similar functions work on screen cells and not on
976	characters.	1638	characters.
977		1639
…		…
1028	Return the row number of the first/last row of the line, respectively.	1690	Return the row number of the first/last row of the line, respectively.
1029		1691
1030	=item $offset = $line->offset_of ($row, $col)	1692	=item $offset = $line->offset_of ($row, $col)
1031		1693
1032	Returns the character offset of the given row|col pair within the logical	1694	Returns the character offset of the given row|col pair within the logical
1033	line.	1695	line. Works for rows outside the line, too, and returns corresponding
		1696	offsets outside the string.
1034		1697
1035	=item ($row, $col) = $line->coord_of ($offset)	1698	=item ($row, $col) = $line->coord_of ($offset)
1036		1699
1037	Translates a string offset into terminal coordinates again.	1700	Translates a string offset into terminal coordinates again.
1038		1701
…		…
1120	where one character corresponds to one screen cell. See	1783	where one character corresponds to one screen cell. See
1121	C<< $term->ROW_t >> for details.	1784	C<< $term->ROW_t >> for details.
1122		1785
1123	=item $string = $term->special_decode $text	1786	=item $string = $term->special_decode $text
1124		1787
1125	Converts rxvt-unicodes text reprsentation into a perl string. See	1788	Converts rxvt-unicodes text representation into a perl string. See
1126	C<< $term->ROW_t >> for details.	1789	C<< $term->ROW_t >> for details.
1127		1790
1128	=item $success = $term->grab_button ($button, $modifiermask)	1791	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1129		1792
		1793	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1794
1130	Registers a synchronous button grab. See the XGrabButton manpage.	1795	Register/unregister a synchronous button grab. See the XGrabButton
		1796	manpage.
1131		1797
1132	=item $success = $term->grab ($eventtime[, $sync])	1798	=item $success = $term->grab ($eventtime[, $sync])
1133		1799
1134	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1800	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1135	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1801	synchronous (C<$sync> is true). Also remembers the grab timestamp.
1136		1802
1137	=item $term->allow_events_async	1803	=item $term->allow_events_async
1138		1804
1139	Calls XAllowEvents with AsyncBoth for the most recent grab.	1805	Calls XAllowEvents with AsyncBoth for the most recent grab.
1140		1806
…		…
1151		1817
1152	Calls XUngrab for the most recent grab. Is called automatically on	1818	Calls XUngrab for the most recent grab. Is called automatically on
1153	evaluation errors, as it is better to lose the grab in the error case as	1819	evaluation errors, as it is better to lose the grab in the error case as
1154	the session.	1820	the session.
1155		1821
		1822	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1823
		1824	=item $atom_name = $term->XGetAtomName ($atom)
		1825
		1826	=item @atoms = $term->XListProperties ($window)
		1827
		1828	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1829
		1830	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1831
		1832	=item $term->XDeleteProperty ($window, $property)
		1833
		1834	=item $window = $term->DefaultRootWindow
		1835
		1836	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1837
		1838	=item $term->XMapWindow ($window)
		1839
		1840	=item $term->XUnmapWindow ($window)
		1841
		1842	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1843
		1844	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1845
		1846	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1847
		1848	Various X or X-related functions. The C<$term> object only serves as
		1849	the source of the display, otherwise those functions map more-or-less
		1850	directory onto the X functions of the same name.
		1851
1156	=back	1852	=back
1157		1853
1158	=cut	1854	=cut
1159		1855
1160	package urxvt::popup;	1856	package urxvt::popup;
…		…
1174		1870
1175	$item->{render} ||= sub { $_[0]{text} };	1871	$item->{render} ||= sub { $_[0]{text} };
1176		1872
1177	push @{ $self->{item} }, $item;	1873	push @{ $self->{item} }, $item;
1178	}	1874	}
		1875
		1876	=item $popup->add_title ($title)
		1877
		1878	Adds a non-clickable title to the popup.
		1879
		1880	=cut
		1881
		1882	sub add_title {
		1883	my ($self, $title) = @_;
		1884
		1885	$self->add_item ({
		1886	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1887	text => $title,
		1888	activate => sub { },
		1889	});
		1890	}
		1891
		1892	=item $popup->add_separator ([$sepchr])
		1893
		1894	Creates a separator, optionally using the character given as C<$sepchr>.
		1895
		1896	=cut
1179		1897
1180	sub add_separator {	1898	sub add_separator {
1181	my ($self, $sep) = @_;	1899	my ($self, $sep) = @_;
1182		1900
1183	$sep ||= "=";	1901	$sep ||= "=";
…		…
1188	render => sub { $sep x $self->{term}->ncol },	1906	render => sub { $sep x $self->{term}->ncol },
1189	activate => sub { },	1907	activate => sub { },
1190	});	1908	});
1191	}	1909	}
1192		1910
1193	sub add_title {	1911	=item $popup->add_button ($text, $cb)
1194	my ($self, $title) = @_;
1195		1912
1196	$self->add_item ({	1913	Adds a clickable button to the popup. C<$cb> is called whenever it is
1197	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1914	selected.
1198	text => $title,	1915
1199	activate => sub { },	1916	=cut
1200	});
1201	}
1202		1917
1203	sub add_button {	1918	sub add_button {
1204	my ($self, $text, $cb) = @_;	1919	my ($self, $text, $cb) = @_;
1205		1920
1206	$self->add_item ({ type => "button", text => $text, activate => $cb});	1921	$self->add_item ({ type => "button", text => $text, activate => $cb});
1207	}	1922	}
1208		1923
		1924	=item $popup->add_toggle ($text, $initial_value, $cb)
		1925
		1926	Adds a toggle/checkbox item to the popup. The callback gets called
		1927	whenever it gets toggled, with a boolean indicating its new value as its
		1928	first argument.
		1929
		1930	=cut
		1931
1209	sub add_toggle {	1932	sub add_toggle {
1210	my ($self, $text, $cb, $value) = @_;	1933	my ($self, $text, $value, $cb) = @_;
1211		1934
1212	my $item; $item = {	1935	my $item; $item = {
1213	type => "button",	1936	type => "button",
1214	text => " $text",	1937	text => " $text",
1215	value => $value,	1938	value => $value,
1216	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1939	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1217	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1940	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1218	};	1941	};
1219		1942
1220	$self->add_item ($item);	1943	$self->add_item ($item);
1221	}	1944	}
		1945
		1946	=item $popup->show
		1947
		1948	Displays the popup (which is initially hidden).
		1949
		1950	=cut
1222		1951
1223	sub show {	1952	sub show {
1224	my ($self) = @_;	1953	my ($self) = @_;
1225		1954
1226	local $urxvt::popup::self = $self;	1955	local $urxvt::popup::self = $self;
1227		1956
		1957	my $env = $self->{term}->env;
		1958	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1959	delete $env->{LC_ALL};
1228	local $ENV{LC_ALL} = $self->{term}->locale;	1960	$env->{LC_CTYPE} = $self->{term}->locale;
1229		1961
1230	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1962	urxvt::term->new ($env, "popup",
		1963	"--perl-lib" => "", "--perl-ext-common" => "",
		1964	"-pty-fd" => -1, "-sl" => 0,
		1965	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1231	"--transient-for" => $self->{term}->parent,	1966	"--transient-for" => $self->{term}->parent,
1232	"-display" => $self->{term}->display_id,	1967	"-display" => $self->{term}->display_id,
1233	"-pe" => "urxvt-popup")	1968	"-pe" => "urxvt-popup")
1234	or die "unable to create popup window\n";	1969	or die "unable to create popup window\n";
1235	}	1970	}
1236		1971
1237	sub DESTROY {	1972	sub DESTROY {
1238	my ($self) = @_;	1973	my ($self) = @_;
1239		1974
1240	delete $self->{term}{_destroy}{$self};	1975	delete $self->{term}{_destroy}{$self};
1241	$self->{term}->ungrab;	1976	$self->{term}->ungrab;
1242	}	1977	}
		1978
		1979	=back
		1980
		1981	=cut
		1982
		1983	package urxvt::watcher;
1243		1984
1244	=head2 The C<urxvt::timer> Class	1985	=head2 The C<urxvt::timer> Class
1245		1986
1246	This class implements timer watchers/events. Time is represented as a	1987	This class implements timer watchers/events. Time is represented as a
1247	fractional number of seconds since the epoch. Example:	1988	fractional number of seconds since the epoch. Example:
…		…
1286		2027
1287	=item $timer = $timer->start ($tstamp)	2028	=item $timer = $timer->start ($tstamp)
1288		2029
1289	Set the event trigger time to C<$tstamp> and start the timer.	2030	Set the event trigger time to C<$tstamp> and start the timer.
1290		2031
		2032	=item $timer = $timer->after ($delay)
		2033
		2034	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
		2035
1291	=item $timer = $timer->stop	2036	=item $timer = $timer->stop
1292		2037
1293	Stop the timer.	2038	Stop the timer.
1294		2039
1295	=back	2040	=back
…		…
1300		2045
1301	$term->{socket} = ...	2046	$term->{socket} = ...
1302	$term->{iow} = urxvt::iow	2047	$term->{iow} = urxvt::iow
1303	->new	2048	->new
1304	->fd (fileno $term->{socket})	2049	->fd (fileno $term->{socket})
1305	->events (1) # wait for read data	2050	->events (urxvt::EVENT_READ)
1306	->start	2051	->start
1307	->cb (sub {	2052	->cb (sub {
1308	my ($iow, $revents) = @_;	2053	my ($iow, $revents) = @_;
1309	# $revents must be 1 here, no need to check	2054	# $revents must be 1 here, no need to check
1310	sysread $term->{socket}, my $buf, 8192	2055	sysread $term->{socket}, my $buf, 8192
…		…
1323	Set the callback to be called when io events are triggered. C<$reventmask>	2068	Set the callback to be called when io events are triggered. C<$reventmask>
1324	is a bitset as described in the C<events> method.	2069	is a bitset as described in the C<events> method.
1325		2070
1326	=item $iow = $iow->fd ($fd)	2071	=item $iow = $iow->fd ($fd)
1327		2072
1328	Set the filedescriptor (not handle) to watch.	2073	Set the file descriptor (not handle) to watch.
1329		2074
1330	=item $iow = $iow->events ($eventmask)	2075	=item $iow = $iow->events ($eventmask)
1331		2076
1332	Set the event mask to watch. Bit #0 (value C<1>) enables watching for read	2077	Set the event mask to watch. The only allowed values are
1333	data, Bit #1 (value C<2>) enables watching for write data.	2078	C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
		2079	together, or C<urxvt::EVENT_NONE>.
1334		2080
1335	=item $iow = $iow->start	2081	=item $iow = $iow->start
1336		2082
1337	Start watching for requested events on the given handle.	2083	Start watching for requested events on the given handle.
1338		2084
1339	=item $iow = $iow->stop	2085	=item $iow = $iow->stop
1340		2086
1341	Stop watching for events on the given filehandle.	2087	Stop watching for events on the given file handle.
		2088
		2089	=back
		2090
		2091	=head2 The C<urxvt::iw> Class
		2092
		2093	This class implements idle watchers, that get called automatically when
		2094	the process is idle. They should return as fast as possible, after doing
		2095	some useful work.
		2096
		2097	=over 4
		2098
		2099	=item $iw = new urxvt::iw
		2100
		2101	Create a new idle watcher object in stopped state.
		2102
		2103	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2104
		2105	Set the callback to be called when the watcher triggers.
		2106
		2107	=item $timer = $timer->start
		2108
		2109	Start the watcher.
		2110
		2111	=item $timer = $timer->stop
		2112
		2113	Stop the watcher.
		2114
		2115	=back
		2116
		2117	=head2 The C<urxvt::pw> Class
		2118
		2119	This class implements process watchers. They create an event whenever a
		2120	process exits, after which they stop automatically.
		2121
		2122	my $pid = fork;
		2123	...
		2124	$term->{pw} = urxvt::pw
		2125	->new
		2126	->start ($pid)
		2127	->cb (sub {
		2128	my ($pw, $exit_status) = @_;
		2129	...
		2130	});
		2131
		2132	=over 4
		2133
		2134	=item $pw = new urxvt::pw
		2135
		2136	Create a new process watcher in stopped state.
		2137
		2138	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2139
		2140	Set the callback to be called when the timer triggers.
		2141
		2142	=item $pw = $timer->start ($pid)
		2143
		2144	Tells the watcher to start watching for process C<$pid>.
		2145
		2146	=item $pw = $pw->stop
		2147
		2148	Stop the watcher.
1342		2149
1343	=back	2150	=back
1344		2151
1345	=head1 ENVIRONMENT	2152	=head1 ENVIRONMENT
1346		2153
…		…
1353		2160
1354	=item == 0 - fatal messages	2161	=item == 0 - fatal messages
1355		2162
1356	=item >= 3 - script loading and management	2163	=item >= 3 - script loading and management
1357		2164
1358	=item >=10 - all events received	2165	=item >=10 - all called hooks
		2166
		2167	=item >=11 - hook return values
1359		2168
1360	=back	2169	=back
1361		2170
1362	=head1 AUTHOR	2171	=head1 AUTHOR
1363		2172
…		…
1365	http://software.schmorp.de/pkg/rxvt-unicode	2174	http://software.schmorp.de/pkg/rxvt-unicode
1366		2175
1367	=cut	2176	=cut
1368		2177
1369	1	2178	1
		2179
		2180	# vim: sw=3:

Diff Legend

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