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

Diff Legend

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