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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.90 by root, Thu Jan 12 12:15:10 2006 UTC vs.
Revision 1.140 by root, Mon Jul 3 19:10:09 2006 UTC

…		…
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
		40	Or by adding them to the resource for extensions loaded by default:
		41
		42	URxvt.perl-ext-common: default,automove-background,selection-autotransform
39		43
40	=over 4	44	=over 4
41		45
42	=item selection (enabled by default)	46	=item selection (enabled by default)
43		47
…		…
63	the match. For example, the followign adds a regex that matches everything	67	the match. For example, the followign adds a regex that matches everything
64	between two vertical bars:	68	between two vertical bars:
65		69
66	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|	70	URxvt.selection.pattern-0: \\\|([^\|]+)\\\|
67		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
68	You can look at the source of the selection extension to see more	79	You can look at the source of the selection extension to see more
69	interesting uses, such as parsing a line from beginning to end.	80	interesting uses, such as parsing a line from beginning to end.
70		81
71	This extension also offers the following bindable keyboard command:	82	This extension also offers following bindable keyboard commands:
72		83
73	=over 4	84	=over 4
74		85
75	=item rot13	86	=item rot13
76		87
…		…
83	=item option-popup (enabled by default)	94	=item option-popup (enabled by default)
84		95
85	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
86	runtime.	97	runtime.
87		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
88	=item selection-popup (enabled by default)	116	=item selection-popup (enabled by default)
89		117
90	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
91	text into various other formats/action (such as uri unescaping, perl	119	text into various other formats/action (such as uri unescaping, perl
92	evalution, web-browser starting etc.), depending on content.	120	evaluation, web-browser starting etc.), depending on content.
		121
		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.
		125
		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 wether 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<$_>.
		131
		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:
		135
		136	push @{ $self->{term}{selection_popup_hook} }, sub {
		137	/a/ ? ("a to be" => sub { s/a/b/g }
		138	: ()
		139	};
93		140
94	=item searchable-scrollback<hotkey> (enabled by default)	141	=item searchable-scrollback<hotkey> (enabled by default)
95		142
96	Adds regex search functionality to the scrollback buffer, triggered	143	Adds regex search functionality to the scrollback buffer, triggered
97	by a hotkey (default: C<M-s>). While in search mode, normal terminal	144	by a hotkey (default: C<M-s>). While in search mode, normal terminal
…		…
104	bottom. C<Escape> leaves search mode and returns to the point where search	151	bottom. C<Escape> leaves search mode and returns to the point where search
105	was started, while C<Enter> or C<Return> stay at the current position and	152	was started, while C<Enter> or C<Return> stay at the current position and
106	additionally stores the first match in the current line into the primary	153	additionally stores the first match in the current line into the primary
107	selection.	154	selection.
108		155
		156	=item readline (enabled by default)
		157
		158	A support package that tries to make editing with readline easier. At
		159	the moment, it reacts to clicking shift-left mouse button by trying to
		160	move the text cursor to this position. It does so by generating as many
		161	cursor-left or cursor-right keypresses as required (the this only works
		162	for programs that correctly support wide characters).
		163
		164	To avoid too many false positives, this is only done when:
		165
		166	=over 4
		167
		168	=item - the tty is in ICANON state.
		169
		170	=item - the text cursor is visible.
		171
		172	=item - the primary screen is currently being displayed.
		173
		174	=item - the mouse is on the same (multi-row-) line as the text cursor.
		175
		176	=back
		177
		178	The normal selection mechanism isn't disabled, so quick successive clicks
		179	might interfere with selection creation in harmless ways.
		180
109	=item selection-autotransform	181	=item selection-autotransform
110		182
111	This selection allows you to do automatic transforms on a selection	183	This selection allows you to do automatic transforms on a selection
112	whenever a selection is made.	184	whenever a selection is made.
113		185
…		…
120		192
121	For example, the following will transform selections of the form	193	For example, the following will transform selections of the form
122	C<filename:number>, often seen in compiler messages, into C<vi +$filename	194	C<filename:number>, often seen in compiler messages, into C<vi +$filename
123	$word>:	195	$word>:
124		196
125	URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/	197	URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126		198
127	And this example matches the same,but replaces it with vi-commands you can	199	And this example matches the same,but replaces it with vi-commands you can
128	paste directly into your (vi :) editor:	200	paste directly into your (vi :) editor:
129		201
130	URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/	202	URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
131		203
132	Of course, this can be modified to suit your needs and your editor :)	204	Of course, this can be modified to suit your needs and your editor :)
		205
		206	To expand the example above to typical perl error messages ("XXX at
		207	FILENAME line YYY."), you need a slightly more elaborate solution:
		208
		209	URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
		210	URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
		211
		212	The first line tells the selection code to treat the unchanging part of
		213	every error message as a selection pattern, and the second line transforms
		214	the message into vi commands to load the file.
		215
		216	=item tabbed
		217
		218	This transforms the terminal into a tabbar with additional terminals, that
		219	is, it implements what is commonly refered to as "tabbed terminal". The topmost line
		220	displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
		221	button per tab.
		222
		223	Clicking a button will activate that tab. Pressing B<Shift-Left> and
		224	B<Shift-Right> will switch to the tab left or right of the current one,
		225	while B<Shift-Down> creates a new tab.
		226
		227	The tabbar itself can be configured similarly to a normal terminal, but
		228	with a resource class of C<URxvt.tabbed>. In addition, it supports the
		229	following four resources (shown with defaults):
		230
		231	URxvt.tabbed.tabbar-fg: <colour-index, default 3>
		232	URxvt.tabbed.tabbar-bg: <colour-index, default 0>
		233	URxvt.tabbed.tab-fg: <colour-index, default 0>
		234	URxvt.tabbed.tab-bg: <colour-index, default 1>
		235
		236	See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
		237	indices.
133		238
134	=item mark-urls	239	=item mark-urls
135		240
136	Uses per-line display filtering (C<on_line_update>) to underline urls and	241	Uses per-line display filtering (C<on_line_update>) to underline urls and
137	make them clickable. When middle-clicked, the program specified in the	242	make them clickable. When middle-clicked, the program specified in the
138	resource C<urlLauncher> (default C<x-www-browser>) will be started with	243	resource C<urlLauncher> (default C<x-www-browser>) will be started with
139	the URL as first argument.	244	the URL as first argument.
140		245
		246	=item xim-onthespot
		247
		248	This (experimental) perl extension implements OnTheSpot editing. It does
		249	not work perfectly, and some input methods don't seem to work well with
		250	OnTheSpot editing in general, but it seems to work at leats for SCIM and
		251	kinput2.
		252
		253	You enable it by specifying this extension and a preedit style of
		254	C<OnTheSpot>, i.e.:
		255
		256	@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
		257
		258	=item automove-background
		259
		260	This is basically a very small extension that dynamically changes the
		261	background pixmap offset to the window position, in effect creating the
		262	same effect as pseudo transparency with a custom pixmap. No scaling is
		263	supported in this mode. Exmaple:
		264
		265	@@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
		266
141	=item block-graphics-to-ascii	267	=item block-graphics-to-ascii
142		268
143	A not very useful example of filtering all text output to the terminal,	269	A not very useful example of filtering all text output to the terminal,
144	by replacing all line-drawing characters (U+2500 .. U+259F) by a	270	by replacing all line-drawing characters (U+2500 .. U+259F) by a
145	similar-looking ascii character.	271	similar-looking ascii character.
146		272
147	=item digital-clock	273	=item digital-clock
148		274
149	Displays a digital clock using the built-in overlay.	275	Displays a digital clock using the built-in overlay.
		276
		277	=item remote-clipboard
		278
		279	Somewhat of a misnomer, this extension adds two menu entries to the
		280	selection popup that allows one ti run external commands to store the
		281	selection somewhere and fetch it again.
		282
		283	We use it to implement a "distributed selection mechanism", which just
		284	means that one command uploads the file to a remote server, and another
		285	reads it.
		286
		287	The commands can be set using the C<URxvt.remote-selection.store> and
		288	C<URxvt.remote-selection.fetch> resources. The first should read the
		289	selection to store from STDIN (always in UTF-8), the second should provide
		290	the selection data on STDOUT (also in UTF-8).
		291
		292	The defaults (which are likely useless to you) use rsh and cat:
		293
		294	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
		295	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
		296
		297	=item selection-pastebin
		298
		299	This is a little rarely useful extension that Uploads the selection as
		300	textfile to a remote site (or does other things). (The implementation is
		301	not currently secure for use in a multiuser environment as it writes to
		302	F</tmp> directly.).
		303
		304	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
		305	i.e.
		306
		307	URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
		308
		309	Pressing this combination runs a command with C<%> replaced by the name of
		310	the textfile. This command can be set via a resource:
		311
		312	URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
		313
		314	And the default is likely not useful to anybody but the few people around
		315	here :)
		316
		317	The name of the textfile is the hex encoded md5 sum of the selection, so
		318	the same content should lead to the same filename.
		319
		320	After a successful upload the selection will be replaced by the text given
		321	in the C<selection-pastebin-url> resource (again, the % is the placeholder
		322	for the filename):
		323
		324	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
150		325
151	=item example-refresh-hooks	326	=item example-refresh-hooks
152		327
153	Displays a very simple digital clock in the upper right corner of the	328	Displays a very simple digital clock in the upper right corner of the
154	window. Illustrates overwriting the refresh callbacks to create your own	329	window. Illustrates overwriting the refresh callbacks to create your own
…		…
194		369
195	=back	370	=back
196		371
197	=head2 Extension Objects	372	=head2 Extension Objects
198		373
199	Very perl extension is a perl class. A separate perl object is created	374	Every perl extension is a perl class. A separate perl object is created
200	for each terminal and each extension and passed as the first parameter to	375	for each terminal and each extension and passed as the first parameter to
201	hooks. So extensions can use their C<$self> object without having to think	376	hooks. So extensions can use their C<$self> object without having to think
202	about other extensions, with the exception of methods and members that	377	about other extensions, with the exception of methods and members that
203	begin with an underscore character C<_>: these are reserved for internal	378	begin with an underscore character C<_>: these are reserved for internal
204	use.	379	use.
…		…
233	called whenever the relevant event happens.	408	called whenever the relevant event happens.
234		409
235	The first argument passed to them is an extension oject as described in	410	The first argument passed to them is an extension oject as described in
236	the in the C<Extension Objects> section.	411	the in the C<Extension Objects> section.
237		412
238	B<All> of these hooks must return a boolean value. If it is true, then the	413	B<All> of these hooks must return a boolean value. If any of the called
239	event counts as being I<consumed>, and the invocation of other hooks is	414	hooks returns true, then the event counts as being I<consumed>, and the
240	skipped, and the relevant action might not be carried out by the C++ code.	415	relevant action might not be carried out by the C++ code.
241		416
242	I<< When in doubt, return a false value (preferably C<()>). >>	417	I<< When in doubt, return a false value (preferably C<()>). >>
243		418
244	=over 4	419	=over 4
245		420
246	=item on_init $term	421	=item on_init $term
247		422
248	Called after a new terminal object has been initialized, but before	423	Called after a new terminal object has been initialized, but before
249	windows are created or the command gets run. Most methods are unsafe to	424	windows are created or the command gets run. Most methods are unsafe to
250	call or deliver senseless data, as terminal size and other characteristics	425	call or deliver senseless data, as terminal size and other characteristics
251	have not yet been determined. You can safely query and change resources,	426	have not yet been determined. You can safely query and change resources
252	though.	427	and options, though. For many purposes the C<on_start> hook is a better
		428	place.
		429
		430	=item on_start $term
		431
		432	Called at the very end of initialisation of a new terminal, just before
		433	trying to map (display) the toplevel and returning to the mainloop.
		434
		435	=item on_destroy $term
		436
		437	Called whenever something tries to destroy terminal, when the terminal is
		438	still fully functional (not for long, though).
253		439
254	=item on_reset $term	440	=item on_reset $term
255		441
256	Called after the screen is "reset" for any reason, such as resizing or	442	Called after the screen is "reset" for any reason, such as resizing or
257	control sequences. Here is where you can react on changes to size-related	443	control sequences. Here is where you can react on changes to size-related
258	variables.	444	variables.
259		445
260	=item on_start $term	446	=item on_child_start $term, $pid
261		447
262	Called at the very end of initialisation of a new terminal, just before	448	Called just after the child process has been C<fork>ed.
263	returning to the mainloop.	449
		450	=item on_child_exit $term, $status
		451
		452	Called just after the child process has exited. C<$status> is the status
		453	from C<waitpid>.
264		454
265	=item on_sel_make $term, $eventtime	455	=item on_sel_make $term, $eventtime
266		456
267	Called whenever a selection has been made by the user, but before the	457	Called whenever a selection has been made by the user, but before the
268	selection text is copied, so changes to the beginning, end or type of the	458	selection text is copied, so changes to the beginning, end or type of the
…		…
304		494
305	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,	495	It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
306	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total	496	$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
307	number of lines that will be in the scrollback buffer.	497	number of lines that will be in the scrollback buffer.
308		498
		499	=item on_osc_seq $term, $op, $args
		500
		501	Called on every OSC sequence and can be used to suppress it or modify its
		502	behaviour. The default should be to return an empty list. A true value
		503	suppresses execution of the request completely. Make sure you don't get
		504	confused by recursive invocations when you output an osc sequence within
		505	this callback.
		506
		507	C<on_osc_seq_perl> should be used for new behaviour.
		508
309	=item on_osc_seq $term, $string	509	=item on_osc_seq_perl $term, $string
310		510
311	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =	511	Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
312	operating system command) is processed. Cursor position and other state	512	operating system command) is processed. Cursor position and other state
313	information is up-to-date when this happens. For interoperability, the	513	information is up-to-date when this happens. For interoperability, the
314	string should start with the extension name and a colon, to distinguish	514	string should start with the extension name and a colon, to distinguish
…		…
355		555
356	=item on_refresh_end $term	556	=item on_refresh_end $term
357		557
358	Called just after the screen gets redrawn. See C<on_refresh_begin>.	558	Called just after the screen gets redrawn. See C<on_refresh_begin>.
359		559
360	=item on_keyboard_command $term, $string	560	=item on_user_command $term, $string
361		561
362	Called whenever the user presses a key combination that has a	562	Called whenever the a user-configured event is being activated (e.g. via
363	C<perl:string> action bound to it (see description of the B<keysym>	563	a C<perl:string> action bound to a key, see description of the B<keysym>
364	resource in the @@RXVT_NAME@@(1) manpage).	564	resource in the @@RXVT_NAME@@(1) manpage).
		565
		566	The event is simply the action string. This interface is assumed to change
		567	slightly in the future.
		568
		569	=item on_resize_all_windows $tern, $new_width, $new_height
		570
		571	Called just after the new window size has been calculcated, but before
		572	windows are actually being resized or hints are being set. If this hook
		573	returns TRUE, setting of the window hints is being skipped.
		574
		575	=item on_x_event $term, $event
		576
		577	Called on every X event received on the vt window (and possibly other
		578	windows). Should only be used as a last resort. Most event structure
		579	members are not passed.
365		580
366	=item on_focus_in $term	581	=item on_focus_in $term
367		582
368	Called whenever the window gets the keyboard focus, before rxvt-unicode	583	Called whenever the window gets the keyboard focus, before rxvt-unicode
369	does focus in processing.	584	does focus in processing.
…		…
371	=item on_focus_out $term	586	=item on_focus_out $term
372		587
373	Called wheneever the window loses keyboard focus, before rxvt-unicode does	588	Called wheneever the window loses keyboard focus, before rxvt-unicode does
374	focus out processing.	589	focus out processing.
375		590
		591	=item on_configure_notify $term, $event
		592
		593	=item on_property_notify $term, $event
		594
376	=item on_key_press $term, $event, $keysym, $octets	595	=item on_key_press $term, $event, $keysym, $octets
377		596
378	=item on_key_release $term, $event, $keysym	597	=item on_key_release $term, $event, $keysym
379		598
380	=item on_button_press $term, $event	599	=item on_button_press $term, $event
…		…
389		608
390	Called whenever the corresponding X event is received for the terminal If	609	Called whenever the corresponding X event is received for the terminal If
391	the hook returns true, then the even will be ignored by rxvt-unicode.	610	the hook returns true, then the even will be ignored by rxvt-unicode.
392		611
393	The event is a hash with most values as named by Xlib (see the XEvent	612	The event is a hash with most values as named by Xlib (see the XEvent
394	manpage), with the additional members C<row> and C<col>, which are the row	613	manpage), with the additional members C<row> and C<col>, which are the
395	and column under the mouse cursor.	614	(real, not screen-based) row and column under the mouse cursor.
396		615
397	C<on_key_press> additionally receives the string rxvt-unicode would	616	C<on_key_press> additionally receives the string rxvt-unicode would
398	output, if any, in locale-specific encoding.	617	output, if any, in locale-specific encoding.
399		618
400	subwindow.	619	subwindow.
		620
		621	=item on_client_message $term, $event
		622
		623	=item on_wm_protocols $term, $event
		624
		625	=item on_wm_delete_window $term, $event
		626
		627	Called when various types of ClientMessage events are received (all with
		628	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
401		629
402	=back	630	=back
403		631
404	=cut	632	=cut
405		633
…		…
411	use Scalar::Util ();	639	use Scalar::Util ();
412	use List::Util ();	640	use List::Util ();
413		641
414	our $VERSION = 1;	642	our $VERSION = 1;
415	our $TERM;	643	our $TERM;
		644	our @TERM_INIT;
		645	our @TERM_EXT;
416	our @HOOKNAME;	646	our @HOOKNAME;
417	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	647	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
418	our %OPTION;	648	our %OPTION;
419		649
420	our $LIBDIR;	650	our $LIBDIR;
421	our $RESNAME;	651	our $RESNAME;
422	our $RESCLASS;	652	our $RESCLASS;
423	our $RXVTNAME;	653	our $RXVTNAME;
424		654
		655	our $NOCHAR = chr 0xffff;
		656
425	=head2 Variables in the C<urxvt> Package	657	=head2 Variables in the C<urxvt> Package
426		658
427	=over 4	659	=over 4
428		660
429	=item $urxvt::LIBDIR	661	=item $urxvt::LIBDIR
…		…
441		673
442	=item $urxvt::TERM	674	=item $urxvt::TERM
443		675
444	The current terminal. This variable stores the current C<urxvt::term>	676	The current terminal. This variable stores the current C<urxvt::term>
445	object, whenever a callback/hook is executing.	677	object, whenever a callback/hook is executing.
		678
		679	=item @urxvt::TERM_INIT
		680
		681	All coderefs in this array will be called as methods of the next newly
		682	created C<urxvt::term> object (during the C<on_init> phase). The array
		683	gets cleared before the codereferences that were in it are being executed,
		684	so coderefs can push themselves onto it again if they so desire.
		685
		686	This complements to the perl-eval commandline option, but gets executed
		687	first.
		688
		689	=item @urxvt::TERM_EXT
		690
		691	Works similar to C<@TERM_INIT>, but contains perl package/class names, which
		692	get registered as normal extensions after calling the hooks in C<@TERM_INIT>
		693	but before other extensions. Gets cleared just like C<@TERM_INIT>.
446		694
447	=back	695	=back
448		696
449	=head2 Functions in the C<urxvt> Package	697	=head2 Functions in the C<urxvt> Package
450		698
…		…
465	Using this function has the advantage that its output ends up in the	713	Using this function has the advantage that its output ends up in the
466	correct place, e.g. on stderr of the connecting urxvtc client.	714	correct place, e.g. on stderr of the connecting urxvtc client.
467		715
468	Messages have a size limit of 1023 bytes currently.	716	Messages have a size limit of 1023 bytes currently.
469		717
470	=item $is_safe = urxvt::safe	718	=item @terms = urxvt::termlist
471		719
472	Returns true when it is safe to do potentially unsafe things, such as	720	Returns all urxvt::term objects that exist in this process, regardless of
473	evaluating perl code specified by the user. This is true when urxvt was	721	wether they are started, being destroyed etc., so be careful. Only term
474	started setuid or setgid.	722	objects that have perl extensions attached will be returned (because there
		723	is no urxvt::term objet associated with others).
475		724
476	=item $time = urxvt::NOW	725	=item $time = urxvt::NOW
477		726
478	Returns the "current time" (as per the event loop).	727	Returns the "current time" (as per the event loop).
479		728
480	=item urxvt::CurrentTime	729	=item urxvt::CurrentTime
481		730
482	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,	731	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
483	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,	732	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
484	Button4Mask, Button5Mask, AnyModifier	733	Button4Mask, Button5Mask, AnyModifier
		734
		735	=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
		736	ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
		737	PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
		738	Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
		739	KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
		740	ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
		741	FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
		742
		743	=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
		744	EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
		745	GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
		746	UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
		747	ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
		748	CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
		749	SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
485		750
486	Various constants for use in X calls and event processing.	751	Various constants for use in X calls and event processing.
487		752
488	=back	753	=back
489		754
…		…
522		787
523	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour	788	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
524		789
525	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour	790	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
526		791
		792	=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
		793
527	Replace the foreground/background colour in the rendition mask with the	794	Replace the foreground/background colour in the rendition mask with the
528	specified one.	795	specified one.
529		796
530	=item $value = urxvt::GET_CUSTOM $rend	797	=item $value = urxvt::GET_CUSTOM $rend
531		798
…		…
540	=back	807	=back
541		808
542	=cut	809	=cut
543		810
544	BEGIN {	811	BEGIN {
545	urxvt->bootstrap;
546
547	# overwrite perl's warn	812	# overwrite perl's warn
548	*CORE::GLOBAL::warn = sub {	813	*CORE::GLOBAL::warn = sub {
549	my $msg = join "", @_;	814	my $msg = join "", @_;
550	$msg .= "\n"	815	$msg .= "\n"
551	unless $msg =~ /\n$/;	816	unless $msg =~ /\n$/;
552	urxvt::warn ($msg);	817	urxvt::warn ($msg);
553	};	818	};
554
555	# %ENV is the original startup environment
556	delete $ENV{IFS};
557	delete $ENV{CDPATH};
558	delete $ENV{BASH_ENV};
559	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
560	}	819	}
561		820
562	my @hook_count;	821	no warnings 'utf8';
		822
563	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};	823	my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
564		824
565	sub verbose {	825	sub verbose {
566	my ($level, $msg) = @_;	826	my ($level, $msg) = @_;
567	warn "$msg\n" if $level <= $verbosity;	827	warn "$msg\n" if $level <= $verbosity;
568	}	828	}
569		829
570	my $extension_pkg = "extension0000";
571	my %extension_pkg;	830	my %extension_pkg;
572		831
573	# load a single script into its own package, once only	832	# load a single script into its own package, once only
574	sub extension_package($) {	833	sub extension_package($) {
575	my ($path) = @_;	834	my ($path) = @_;
576		835
577	$extension_pkg{$path} \|\|= do {	836	$extension_pkg{$path} \|\|= do {
578	my $pkg = "urxvt::" . ($extension_pkg++);	837	$path =~ /([^\/\\]+)$/;
		838	my $pkg = $1;
		839	$pkg =~ s/[^[:word:]]/_/g;
		840	$pkg = "urxvt::ext::$pkg";
579		841
580	verbose 3, "loading extension '$path' into package '$pkg'";	842	verbose 3, "loading extension '$path' into package '$pkg'";
581		843
582	open my $fh, "<:raw", $path	844	open my $fh, "<:raw", $path
583	or die "$path: $!";	845	or die "$path: $!";
584		846
585	my $source = untaint	847	my $source =
586	"package $pkg; use strict; use utf8;\n"	848	"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
587	. "use base urxvt::term::extension::;\n"
588	. "#line 1 \"$path\"\n{\n"	849	. "#line 1 \"$path\"\n{\n"
589	. (do { local $/; <$fh> })	850	. (do { local $/; <$fh> })
590	. "\n};\n1";	851	. "\n};\n1";
591		852
592	eval $source	853	eval $source
…		…
606	if ($htype == 0) { # INIT	867	if ($htype == 0) { # INIT
607	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");	868	my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
608		869
609	my %ext_arg;	870	my %ext_arg;
610		871
		872	{
		873	my @init = @TERM_INIT;
		874	@TERM_INIT = ();
		875	$_->($TERM) for @init;
		876	my @pkg = @TERM_EXT;
		877	@TERM_EXT = ();
		878	$TERM->register_package ($_) for @pkg;
		879	}
		880
611	for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {	881	for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
612	if ($_ eq "default") {	882	if ($_ eq "default") {
613	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback);	883	$ext_arg{$_} \|\|= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
614	} elsif (/^-(.*)$/) {	884	} elsif (/^-(.*)$/) {
615	delete $ext_arg{$1};	885	delete $ext_arg{$1};
616	} elsif (/^([^<]+)<(.*)>$/) {	886	} elsif (/^([^<]+)<(.*)>$/) {
617	push @{ $ext_arg{$1} }, $2;	887	push @{ $ext_arg{$1} }, $2;
618	} else {	888	} else {
619	$ext_arg{$_} \|\|= [];	889	$ext_arg{$_} \|\|= [];
620	}	890	}
621	}	891	}
622		892
623	while (my ($ext, $argv) = each %ext_arg) {	893	for my $ext (sort keys %ext_arg) {
624	my @files = grep -f $_, map "$_/$ext", @dirs;	894	my @files = grep -f $_, map "$_/$ext", @dirs;
625		895
626	if (@files) {	896	if (@files) {
627	$TERM->register_package (extension_package $files[0], $argv);	897	$TERM->register_package (extension_package $files[0], $ext_arg{$ext});
628	} else {	898	} else {
629	warn "perl extension '$ext' not found in perl library search path\n";	899	warn "perl extension '$ext' not found in perl library search path\n";
630	}	900	}
631	}	901	}
632		902
…		…
638		908
639	if (my $cb = $TERM->{_hook}[$htype]) {	909	if (my $cb = $TERM->{_hook}[$htype]) {
640	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"	910	verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
641	if $verbosity >= 10;	911	if $verbosity >= 10;
642		912
643	keys %$cb;	913	for my $pkg (keys %$cb) {
644
645	while (my ($pkg, $cb) = each %$cb) {
646	$retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }	914	my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
647	and last;	915	$retval \|\|= $retval_;
648		916
649	if ($@) {	917	if ($@) {
650	$TERM->ungrab; # better to lose the grab than the session	918	$TERM->ungrab; # better to lose the grab than the session
651	warn $@;	919	warn $@;
652	}	920	}
…		…
655	verbose 11, "$HOOKNAME[$htype] returning <$retval>"	923	verbose 11, "$HOOKNAME[$htype] returning <$retval>"
656	if $verbosity >= 11;	924	if $verbosity >= 11;
657	}	925	}
658		926
659	if ($htype == 1) { # DESTROY	927	if ($htype == 1) { # DESTROY
660	if (my $hook = delete $TERM->{_hook}) {
661	for my $htype (0..$#$hook) {
662	$hook_count[$htype] -= scalar keys %{ $hook->[$htype] \|\| {} }
663	or set_should_invoke $htype, 0;
664	}
665	}
666
667	# clear package objects	928	# clear package objects
668	%$_ = () for values %{ $TERM->{_pkg} };	929	%$_ = () for values %{ $TERM->{_pkg} };
669		930
670	# clear package	931	# clear package
671	%$TERM = ();	932	%$TERM = ();
672	}	933	}
673		934
674	$retval	935	$retval
675	}	936	}
676		937
677	sub exec_async(@) {	938	sub SET_COLOR($$$) {
678	my $pid = fork;	939	SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
679
680	return
681	if !defined $pid or $pid;
682
683	%ENV = %{ $TERM->env };
684
685	exec @_;
686	_exit 255;
687	}	940	}
688		941
689	# urxvt::term::extension	942	# urxvt::term::extension
690		943
691	package urxvt::term::extension;	944	package urxvt::term::extension;
…		…
697	while (my ($name, $cb) = each %hook) {	950	while (my ($name, $cb) = each %hook) {
698	my $htype = $HOOKTYPE{uc $name};	951	my $htype = $HOOKTYPE{uc $name};
699	defined $htype	952	defined $htype
700	or Carp::croak "unsupported hook type '$name'";	953	or Carp::croak "unsupported hook type '$name'";
701		954
		955	$self->set_should_invoke ($htype, +1)
702	unless (exists $self->{term}{_hook}[$htype]{$pkg}) {	956	unless exists $self->{term}{_hook}[$htype]{$pkg};
703	$hook_count[$htype]++
704	or urxvt::set_should_invoke $htype, 1;
705	}
706		957
707	$self->{term}{_hook}[$htype]{$pkg} = $cb;	958	$self->{term}{_hook}[$htype]{$pkg} = $cb;
708	}	959	}
709	}	960	}
710		961
…		…
715	for my $name (@hook) {	966	for my $name (@hook) {
716	my $htype = $HOOKTYPE{uc $name};	967	my $htype = $HOOKTYPE{uc $name};
717	defined $htype	968	defined $htype
718	or Carp::croak "unsupported hook type '$name'";	969	or Carp::croak "unsupported hook type '$name'";
719		970
		971	$self->set_should_invoke ($htype, -1)
720	if (delete $self->{term}{_hook}[$htype]{$pkg}) {	972	if delete $self->{term}{_hook}[$htype]{$pkg};
721	--$hook_count[$htype]
722	or urxvt::set_should_invoke $htype, 0;
723	}
724	}	973	}
725	}	974	}
726		975
727	our $AUTOLOAD;	976	our $AUTOLOAD;
728		977
…		…
834	# find on_xxx subs in the package and register them	1083	# find on_xxx subs in the package and register them
835	# as hooks	1084	# as hooks
836	sub register_package {	1085	sub register_package {
837	my ($self, $pkg, $argv) = @_;	1086	my ($self, $pkg, $argv) = @_;
838		1087
		1088	no strict 'refs';
		1089
		1090	urxvt::verbose 6, "register package $pkg to $self";
		1091
		1092	@{"$pkg\::ISA"} = urxvt::term::extension::;
		1093
839	my $proxy = bless {	1094	my $proxy = bless {
840	_pkg => $pkg,	1095	_pkg => $pkg,
841	argv => $argv,	1096	argv => $argv,
842	}, $pkg;	1097	}, $pkg;
843	Scalar::Util::weaken ($proxy->{term} = $self);	1098	Scalar::Util::weaken ($proxy->{term} = $self);
…		…
858	hash which defines the environment of the new terminal.	1113	hash which defines the environment of the new terminal.
859		1114
860	Croaks (and probably outputs an error message) if the new instance	1115	Croaks (and probably outputs an error message) if the new instance
861	couldn't be created. Returns C<undef> if the new instance didn't	1116	couldn't be created. Returns C<undef> if the new instance didn't
862	initialise perl, and the terminal object otherwise. The C<init> and	1117	initialise perl, and the terminal object otherwise. The C<init> and
863	C<start> hooks will be called during this call.	1118	C<start> hooks will be called before this call returns, and are free to
		1119	refer to global data (which is race free).
864		1120
865	=cut	1121	=cut
866		1122
867	sub new {	1123	sub new {
868	my ($class, $env, @args) = @_;	1124	my ($class, $env, @args) = @_;
869		1125
		1126	$env or Carp::croak "environment hash missing in call to urxvt::term->new";
		1127	@args or Carp::croak "name argument missing in call to urxvt::term->new";
		1128
870	_new ([ map "$_=$env->{$_}", keys %$env ], @args);	1129	_new ([ map "$_=$env->{$_}", keys %$env ], \@args);
871	}	1130	}
872		1131
873	=item $term->destroy	1132	=item $term->destroy
874		1133
875	Destroy the terminal object (close the window, free resources	1134	Destroy the terminal object (close the window, free resources
876	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event	1135	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
877	watchers (timers, io watchers) are still active.	1136	watchers (timers, io watchers) are still active.
878		1137
		1138	=item $term->exec_async ($cmd[, @args])
		1139
		1140	Works like the combination of the C<fork>/C<exec> builtins, which executes
		1141	("starts") programs in the background. This function takes care of setting
		1142	the user environment before exec'ing the command (e.g. C<PATH>) and should
		1143	be preferred over explicit calls to C<exec> or C<system>.
		1144
		1145	Returns the pid of the subprocess or C<undef> on error.
		1146
		1147	=cut
		1148
		1149	sub exec_async {
		1150	my $self = shift;
		1151
		1152	my $pid = fork;
		1153
		1154	return $pid
		1155	if !defined $pid or $pid;
		1156
		1157	%ENV = %{ $self->env };
		1158
		1159	exec @_;
		1160	urxvt::_exit 255;
		1161	}
		1162
879	=item $isset = $term->option ($optval[, $set])	1163	=item $isset = $term->option ($optval[, $set])
880		1164
881	Returns true if the option specified by C<$optval> is enabled, and	1165	Returns true if the option specified by C<$optval> is enabled, and
882	optionally change it. All option values are stored by name in the hash	1166	optionally change it. All option values are stored by name in the hash
883	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.	1167	C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
…		…
885	Here is a a likely non-exhaustive list of option names, please see the	1169	Here is a a likely non-exhaustive list of option names, please see the
886	source file F</src/optinc.h> to see the actual list:	1170	source file F</src/optinc.h> to see the actual list:
887		1171
888	borderLess console cursorBlink cursorUnderline hold iconic insecure	1172	borderLess console cursorBlink cursorUnderline hold iconic insecure
889	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage	1173	intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
890	pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating	1174	override-redirect pastableTabs pointerBlank reverseVideo scrollBar
891	scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer	1175	scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
892	secondaryScreen secondaryScroll skipBuiltinGlyphs transparent	1176	scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
893	tripleclickwords utmpInhibit visualBell	1177	transparent tripleclickwords utmpInhibit visualBell
894		1178
895	=item $value = $term->resource ($name[, $newval])	1179	=item $value = $term->resource ($name[, $newval])
896		1180
897	Returns the current resource value associated with a given name and	1181	Returns the current resource value associated with a given name and
898	optionally sets a new value. Setting values is most useful in the C<init>	1182	optionally sets a new value. Setting values is most useful in the C<init>
…		…
915		1199
916	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1200	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
917	borderLess color cursorBlink cursorUnderline cutchars delete_key	1201	borderLess color cursorBlink cursorUnderline cutchars delete_key
918	display_name embed ext_bwidth fade font geometry hold iconName	1202	display_name embed ext_bwidth fade font geometry hold iconName
919	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1203	imFont imLocale inputMethod insecure int_bwidth intensityStyles
920	italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier	1204	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
921	mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2	1205	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
922	perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd	1206	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
923	reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating	1207	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
924	scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput	1208	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
925	scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle	1209	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
926	shade term_name title transparent transparent_all tripleclickwords	1210	secondaryScreen secondaryScroll selectstyle shade term_name title
927	utmpInhibit visualBell	1211	transient_for transparent transparent_all tripleclickwords utmpInhibit
		1212	visualBell
928		1213
929	=cut	1214	=cut
930		1215
931	sub resource($$;$) {	1216	sub resource($$;$) {
932	my ($self, $name) = (shift, shift);	1217	my ($self, $name) = (shift, shift);
…		…
1106		1391
1107	Normally its not a good idea to use this function, as programs might be	1392	Normally its not a good idea to use this function, as programs might be
1108	confused by changes in cursor position or scrolling. Its useful inside a	1393	confused by changes in cursor position or scrolling. Its useful inside a
1109	C<on_add_lines> hook, though.	1394	C<on_add_lines> hook, though.
1110		1395
		1396	=item $term->scr_change_screen ($screen)
		1397
		1398	Switch to given screen - 0 primary, 1 secondary.
		1399
1111	=item $term->cmd_parse ($octets)	1400	=item $term->cmd_parse ($octets)
1112		1401
1113	Similar to C<scr_add_lines>, but the argument must be in the	1402	Similar to C<scr_add_lines>, but the argument must be in the
1114	locale-specific encoding of the terminal and can contain command sequences	1403	locale-specific encoding of the terminal and can contain command sequences
1115	(escape codes) that will be interpreted.	1404	(escape codes) that will be interpreted.
…		…
1125	Replaces the event mask of the pty watcher by the given event mask. Can	1414	Replaces the event mask of the pty watcher by the given event mask. Can
1126	be used to suppress input and output handling to the pty/tty. See the	1415	be used to suppress input and output handling to the pty/tty. See the
1127	description of C<< urxvt::timer->events >>. Make sure to always restore	1416	description of C<< urxvt::timer->events >>. Make sure to always restore
1128	the previous value.	1417	the previous value.
1129		1418
		1419	=item $fd = $term->pty_fd
		1420
		1421	Returns the master file descriptor for the pty in use, or C<-1> if no pty
		1422	is used.
		1423
1130	=item $windowid = $term->parent	1424	=item $windowid = $term->parent
1131		1425
1132	Return the window id of the toplevel window.	1426	Return the window id of the toplevel window.
1133		1427
1134	=item $windowid = $term->vt	1428	=item $windowid = $term->vt
1135		1429
1136	Return the window id of the terminal window.	1430	Return the window id of the terminal window.
1137		1431
		1432	=item $term->vt_emask_add ($x_event_mask)
		1433
		1434	Adds the specified events to the vt event mask. Useful e.g. when you want
		1435	to receive pointer events all the times:
		1436
		1437	$term->vt_emask_add (urxvt::PointerMotionMask);
		1438
		1439	=item $term->focus_in
		1440
		1441	=item $term->focus_out
		1442
		1443	=item $term->key_press ($state, $keycode[, $time])
		1444
		1445	=item $term->key_release ($state, $keycode[, $time])
		1446
		1447	Deliver various fake events to to terminal.
		1448
1138	=item $window_width = $term->width	1449	=item $window_width = $term->width
1139		1450
1140	=item $window_height = $term->height	1451	=item $window_height = $term->height
1141		1452
1142	=item $font_width = $term->fwidth	1453	=item $font_width = $term->fwidth
…		…
1155		1466
1156	=item $max_scrollback = $term->saveLines	1467	=item $max_scrollback = $term->saveLines
1157		1468
1158	=item $nrow_plus_saveLines = $term->total_rows	1469	=item $nrow_plus_saveLines = $term->total_rows
1159		1470
1160	=item $lines_in_scrollback = $term->nsaved	1471	=item $topmost_scrollback_row = $term->top_row
1161		1472
1162	Return various integers describing terminal characteristics.	1473	Return various integers describing terminal characteristics.
1163		1474
1164	=item $x_display = $term->display_id	1475	=item $x_display = $term->display_id
1165		1476
…		…
1172	=item $env = $term->env	1483	=item $env = $term->env
1173		1484
1174	Returns a copy of the environment in effect for the terminal as a hashref	1485	Returns a copy of the environment in effect for the terminal as a hashref
1175	similar to C<\%ENV>.	1486	similar to C<\%ENV>.
1176		1487
		1488	=item @envv = $term->envv
		1489
		1490	Returns the environment as array of strings of the form C<VAR=VALUE>.
		1491
		1492	=item @argv = $term->argv
		1493
		1494	Return the argument vector as this terminal, similar to @ARGV, but
		1495	includes the program name as first element.
		1496
1177	=cut	1497	=cut
1178		1498
1179	sub env {	1499	sub env {
1180	if (my $env = $_[0]->_env) {
1181	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }	1500	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1182	} else {
1183	+{ %ENV }
1184	}
1185	}	1501	}
1186		1502
1187	=item $modifiermask = $term->ModLevel3Mask	1503	=item $modifiermask = $term->ModLevel3Mask
1188		1504
1189	=item $modifiermask = $term->ModMetaMask	1505	=item $modifiermask = $term->ModMetaMask
…		…
1191	=item $modifiermask = $term->ModNumLockMask	1507	=item $modifiermask = $term->ModNumLockMask
1192		1508
1193	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often	1509	Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1194	AltGr), the meta key (often Alt) and the num lock key, if applicable.	1510	AltGr), the meta key (often Alt) and the num lock key, if applicable.
1195		1511
		1512	=item $screen = $term->current_screen
		1513
		1514	Returns the currently displayed screen (0 primary, 1 secondary).
		1515
		1516	=item $cursor_is_hidden = $term->hidden_cursor
		1517
		1518	Returns wether the cursor is currently hidden or not.
		1519
1196	=item $view_start = $term->view_start ([$newvalue])	1520	=item $view_start = $term->view_start ([$newvalue])
1197		1521
1198	Returns the negative row number of the topmost line. Minimum value is	1522	Returns the row number of the topmost displayed line. Maximum value is
1199	C<0>, which displays the normal terminal contents. Larger values scroll	1523	C<0>, which displays the normal terminal contents. Lower values scroll
1200	this many lines into the scrollback buffer.	1524	this many lines into the scrollback buffer.
1201		1525
1202	=item $term->want_refresh	1526	=item $term->want_refresh
1203		1527
1204	Requests a screen refresh. At the next opportunity, rxvt-unicode will	1528	Requests a screen refresh. At the next opportunity, rxvt-unicode will
…		…
1219	line, starting at column C<$start_col> (default C<0>), which is useful	1543	line, starting at column C<$start_col> (default C<0>), which is useful
1220	to replace only parts of a line. The font index in the rendition will	1544	to replace only parts of a line. The font index in the rendition will
1221	automatically be updated.	1545	automatically be updated.
1222		1546
1223	C<$text> is in a special encoding: tabs and wide characters that use more	1547	C<$text> is in a special encoding: tabs and wide characters that use more
1224	than one cell when displayed are padded with urxvt::NOCHAR characters	1548	than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1225	(C<chr 65535>). Characters with combining characters and other characters	1549	characters. Characters with combining characters and other characters that
1226	that do not fit into the normal tetx encoding will be replaced with	1550	do not fit into the normal tetx encoding will be replaced with characters
1227	characters in the private use area.	1551	in the private use area.
1228		1552
1229	You have to obey this encoding when changing text. The advantage is	1553	You have to obey this encoding when changing text. The advantage is
1230	that C<substr> and similar functions work on screen cells and not on	1554	that C<substr> and similar functions work on screen cells and not on
1231	characters.	1555	characters.
1232		1556
…		…
1379	=item $string = $term->special_decode $text	1703	=item $string = $term->special_decode $text
1380		1704
1381	Converts rxvt-unicodes text reprsentation into a perl string. See	1705	Converts rxvt-unicodes text reprsentation into a perl string. See
1382	C<< $term->ROW_t >> for details.	1706	C<< $term->ROW_t >> for details.
1383		1707
1384	=item $success = $term->grab_button ($button, $modifiermask)	1708	=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1385		1709
		1710	=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
		1711
1386	Registers a synchronous button grab. See the XGrabButton manpage.	1712	Register/unregister a synchronous button grab. See the XGrabButton
		1713	manpage.
1387		1714
1388	=item $success = $term->grab ($eventtime[, $sync])	1715	=item $success = $term->grab ($eventtime[, $sync])
1389		1716
1390	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or	1717	Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1391	synchronous (C<$sync> is true). Also remembers the grab timestampe.	1718	synchronous (C<$sync> is true). Also remembers the grab timestampe.
…		…
1406	=item $term->ungrab	1733	=item $term->ungrab
1407		1734
1408	Calls XUngrab for the most recent grab. Is called automatically on	1735	Calls XUngrab for the most recent grab. Is called automatically on
1409	evaluation errors, as it is better to lose the grab in the error case as	1736	evaluation errors, as it is better to lose the grab in the error case as
1410	the session.	1737	the session.
		1738
		1739	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
		1740
		1741	=item $atom_name = $term->XGetAtomName ($atom)
		1742
		1743	=item @atoms = $term->XListProperties ($window)
		1744
		1745	=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
		1746
		1747	=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
		1748
		1749	=item $term->XDeleteProperty ($window, $property)
		1750
		1751	=item $window = $term->DefaultRootWindow
		1752
		1753	=item $term->XReparentWindow ($window, $parent, [$x, $y])
		1754
		1755	=item $term->XMapWindow ($window)
		1756
		1757	=item $term->XUnmapWindow ($window)
		1758
		1759	=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
		1760
		1761	=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
		1762
		1763	=item $term->XChangeInput ($window, $add_events[, $del_events])
		1764
		1765	Various X or X-related functions. The C<$term> object only serves as
		1766	the source of the display, otherwise those functions map more-or-less
		1767	directory onto the X functions of the same name.
1411		1768
1412	=back	1769	=back
1413		1770
1414	=cut	1771	=cut
1415		1772
…		…
1479	my ($self, $text, $cb) = @_;	1836	my ($self, $text, $cb) = @_;
1480		1837
1481	$self->add_item ({ type => "button", text => $text, activate => $cb});	1838	$self->add_item ({ type => "button", text => $text, activate => $cb});
1482	}	1839	}
1483		1840
1484	=item $popup->add_toggle ($text, $cb, $initial_value)	1841	=item $popup->add_toggle ($text, $initial_value, $cb)
1485		1842
1486	Adds a toggle/checkbox item to the popup. Teh callback gets called	1843	Adds a toggle/checkbox item to the popup. The callback gets called
1487	whenever it gets toggled, with a boolean indicating its value as its first	1844	whenever it gets toggled, with a boolean indicating its new value as its
1488	argument.	1845	first argument.
1489		1846
1490	=cut	1847	=cut
1491		1848
1492	sub add_toggle {	1849	sub add_toggle {
1493	my ($self, $text, $cb, $value) = @_;	1850	my ($self, $text, $value, $cb) = @_;
1494		1851
1495	my $item; $item = {	1852	my $item; $item = {
1496	type => "button",	1853	type => "button",
1497	text => " $text",	1854	text => " $text",
1498	value => $value,	1855	value => $value,
…		…
1517	my $env = $self->{term}->env;	1874	my $env = $self->{term}->env;
1518	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.	1875	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1519	delete $env->{LC_ALL};	1876	delete $env->{LC_ALL};
1520	$env->{LC_CTYPE} = $self->{term}->locale;	1877	$env->{LC_CTYPE} = $self->{term}->locale;
1521		1878
1522	urxvt::term->new ($env, $self->{term}->resource ("name"),	1879	urxvt::term->new ($env, "popup",
1523	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1880	"--perl-lib" => "", "--perl-ext-common" => "",
		1881	"-pty-fd" => -1, "-sl" => 0,
		1882	"-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1524	"--transient-for" => $self->{term}->parent,	1883	"--transient-for" => $self->{term}->parent,
1525	"-display" => $self->{term}->display_id,	1884	"-display" => $self->{term}->display_id,
1526	"-pe" => "urxvt-popup")	1885	"-pe" => "urxvt-popup")
1527	or die "unable to create popup window\n";	1886	or die "unable to create popup window\n";
1528	}	1887	}
…		…
1533	delete $self->{term}{_destroy}{$self};	1892	delete $self->{term}{_destroy}{$self};
1534	$self->{term}->ungrab;	1893	$self->{term}->ungrab;
1535	}	1894	}
1536		1895
1537	=back	1896	=back
		1897
		1898	=cut
		1899
		1900	package urxvt::watcher;
		1901
		1902	@urxvt::timer::ISA = __PACKAGE__;
		1903	@urxvt::iow::ISA = __PACKAGE__;
		1904	@urxvt::pw::ISA = __PACKAGE__;
		1905	@urxvt::iw::ISA = __PACKAGE__;
1538		1906
1539	=head2 The C<urxvt::timer> Class	1907	=head2 The C<urxvt::timer> Class
1540		1908
1541	This class implements timer watchers/events. Time is represented as a	1909	This class implements timer watchers/events. Time is represented as a
1542	fractional number of seconds since the epoch. Example:	1910	fractional number of seconds since the epoch. Example:
…		…
1580	Start the timer.	1948	Start the timer.
1581		1949
1582	=item $timer = $timer->start ($tstamp)	1950	=item $timer = $timer->start ($tstamp)
1583		1951
1584	Set the event trigger time to C<$tstamp> and start the timer.	1952	Set the event trigger time to C<$tstamp> and start the timer.
		1953
		1954	=item $timer = $timer->after ($delay)
		1955
		1956	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1585		1957
1586	=item $timer = $timer->stop	1958	=item $timer = $timer->stop
1587		1959
1588	Stop the timer.	1960	Stop the timer.
1589		1961
…		…
1636		2008
1637	Stop watching for events on the given filehandle.	2009	Stop watching for events on the given filehandle.
1638		2010
1639	=back	2011	=back
1640		2012
		2013	=head2 The C<urxvt::iw> Class
		2014
		2015	This class implements idle watchers, that get called automatically when
		2016	the process is idle. They should return as fast as possible, after doing
		2017	some useful work.
		2018
		2019	=over 4
		2020
		2021	=item $iw = new urxvt::iw
		2022
		2023	Create a new idle watcher object in stopped state.
		2024
		2025	=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
		2026
		2027	Set the callback to be called when the watcher triggers.
		2028
		2029	=item $timer = $timer->start
		2030
		2031	Start the watcher.
		2032
		2033	=item $timer = $timer->stop
		2034
		2035	Stop the watcher.
		2036
		2037	=back
		2038
		2039	=head2 The C<urxvt::pw> Class
		2040
		2041	This class implements process watchers. They create an event whenever a
		2042	process exits, after which they stop automatically.
		2043
		2044	my $pid = fork;
		2045	...
		2046	$term->{pw} = urxvt::pw
		2047	->new
		2048	->start ($pid)
		2049	->cb (sub {
		2050	my ($pw, $exit_status) = @_;
		2051	...
		2052	});
		2053
		2054	=over 4
		2055
		2056	=item $pw = new urxvt::pw
		2057
		2058	Create a new process watcher in stopped state.
		2059
		2060	=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
		2061
		2062	Set the callback to be called when the timer triggers.
		2063
		2064	=item $pw = $timer->start ($pid)
		2065
		2066	Tells the wqtcher to start watching for process C<$pid>.
		2067
		2068	=item $pw = $pw->stop
		2069
		2070	Stop the watcher.
		2071
		2072	=back
		2073
1641	=head1 ENVIRONMENT	2074	=head1 ENVIRONMENT
1642		2075
1643	=head2 URXVT_PERL_VERBOSITY	2076	=head2 URXVT_PERL_VERBOSITY
1644		2077
1645	This variable controls the verbosity level of the perl extension. Higher	2078	This variable controls the verbosity level of the perl extension. Higher

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.90 by root, Thu Jan 12 12:15:10 2006 UTC vs. Revision 1.140 by root, Mon Jul 3 19:10:09 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.90 by root, Thu Jan 12 12:15:10 2006 UTC vs.
Revision 1.140 by root, Mon Jul 3 19:10:09 2006 UTC