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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC vs.
Revision 1.81 by root, Thu Jan 12 00:12:40 2006 UTC

…		…
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
31	=head2 Prepackaged Extensions	31	=head1 PREPACKAGED EXTENSIONS
32		32
33	This section describes the extensiosn delivered with this version. You can	33	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
39		39
40	=over 4	40	=over 4
41		41
42	=item selection (enabled by default)	42	=item selection (enabled by default)
43		43
44	Intelligent selection. This extension tries to be more intelligent when	44	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	45	when the user extends selections (double-click). Right now, it tries to
46	urls and complete shell-quoted arguments, which is very convenient, too,	46	select urls and complete shell-quoted arguments, which is very convenient,
47	if your F<ls> supports C<--quoting-style=shell>.	47	too, if your F<ls> supports C<--quoting-style=shell>.
48		48
49	It also offers the following bindable event:	49	It also offers the following bindable keyboard command:
50		50
51	=over 4	51	=over 4
52		52
53	=item rot13	53	=item rot13
54		54
…		…
64	runtime.	64	runtime.
65		65
66	=item selection-popup (enabled by default)	66	=item selection-popup (enabled by default)
67		67
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	69	text into various other formats/action (such as uri unescaping, perl
		70	evalution, web-browser starting etc.), depending on content.
70		71
71	=item searchable-scrollback<hotkey> (enabled by default)	72	=item searchable-scrollback<hotkey> (enabled by default)
72		73
73	Adds regex search functionality to the scrollback buffer, triggered	74	Adds regex search functionality to the scrollback buffer, triggered
74	by a hotkey (default: C<M-s>). When in search mode, normal terminal	75	by a hotkey (default: C<M-s>). When in search mode, normal terminal
…		…
83		84
84	Displays a digital clock using the built-in overlay.	85	Displays a digital clock using the built-in overlay.
85		86
86	=item mark-urls	87	=item mark-urls
87		88
88	Uses per-line display filtering (C<on_line_update>) to underline urls.	89	Uses per-line display filtering (C<on_line_update>) to underline urls and
		90	make them clickable. When clicked, the program specified in the resource
		91	C<urlLauncher> (default C<x-www-browser>) will be started.
89		92
90	=item block-graphics-to-ascii	93	=item block-graphics-to-ascii
91		94
92	A not very useful example of filtering all text output to the terminal,	95	A not very useful example of filtering all text output to the terminal,
93	by replacing all line-drawing characters (U+2500 .. U+259F) by a	96	by replacing all line-drawing characters (U+2500 .. U+259F) by a
…		…
98	Displays a very simple digital clock in the upper right corner of the	101	Displays a very simple digital clock in the upper right corner of the
99	window. Illustrates overwriting the refresh callbacks to create your own	102	window. Illustrates overwriting the refresh callbacks to create your own
100	overlays or changes.	103	overlays or changes.
101		104
102	=back	105	=back
		106
		107	=head1 API DOCUMENTATION
103		108
104	=head2 General API Considerations	109	=head2 General API Considerations
105		110
106	All objects (such as terminals, time watchers etc.) are typical	111	All objects (such as terminals, time watchers etc.) are typical
107	reference-to-hash objects. The hash can be used to store anything you	112	reference-to-hash objects. The hash can be used to store anything you
…		…
120	=over 4	125	=over 4
121		126
122	=item $text	127	=item $text
123		128
124	Rxvt-unicodes special way of encoding text, where one "unicode" character	129	Rxvt-unicodes special way of encoding text, where one "unicode" character
125	always represents one screen cell. See L<row_t> for a discussion of this format.	130	always represents one screen cell. See L<ROW_t> for a discussion of this format.
126		131
127	=item $string	132	=item $string
128		133
129	A perl text string, with an emphasis on I<text>. It can store all unicode	134	A perl text string, with an emphasis on I<text>. It can store all unicode
130	characters and is to be distinguished with text encoded in a specific	135	characters and is to be distinguished with text encoded in a specific
…		…
340		345
341	subwindow.	346	subwindow.
342		347
343	=back	348	=back
344		349
345	=head2 Variables in the C<urxvt> Package
346
347	=over 4
348
349	=item $urxvt::TERM
350
351	The current terminal. This variable stores the current C<urxvt::term>
352	object, whenever a callback/hook is executing.
353
354	=back
355
356	=head2 Functions in the C<urxvt> Package
357
358	=over 4
359
360	=item $term = new urxvt [arg...]
361
362	Creates a new terminal, very similar as if you had started it with
363	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
364	if the new instance couldn't be created. Returns C<undef> if the new
365	instance didn't initialise perl, and the terminal object otherwise. The
366	C<init> and C<start> hooks will be called during the call.
367
368	=item urxvt::fatal $errormessage
369
370	Fatally aborts execution with the given error message. Avoid at all
371	costs! The only time this is acceptable is when the terminal process
372	starts up.
373
374	=item urxvt::warn $string
375
376	Calls C<rxvt_warn> with the given string which should not include a
377	newline. The module also overwrites the C<warn> builtin with a function
378	that calls this function.
379
380	Using this function has the advantage that its output ends up in the
381	correct place, e.g. on stderr of the connecting urxvtc client.
382
383	=item $is_safe = urxvt::safe
384
385	Returns true when it is safe to do potentially unsafe things, such as
386	evaluating perl code specified by the user. This is true when urxvt was
387	started setuid or setgid.
388
389	=item $time = urxvt::NOW
390
391	Returns the "current time" (as per the event loop).
392
393	=item urxvt::CurrentTime
394
395	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
396	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
397	Button4Mask, Button5Mask, AnyModifier
398
399	Various constants for use in X calls and event processing.
400
401	=back
402
403	=head2 RENDITION
404
405	Rendition bitsets contain information about colour, font, font styles and
406	similar information for each screen cell.
407
408	The following "macros" deal with changes in rendition sets. You should
409	never just create a bitset, you should always modify an existing one,
410	as they contain important information required for correct operation of
411	rxvt-unicode.
412
413	=over 4
414
415	=item $rend = urxvt::DEFAULT_RSTYLE
416
417	Returns the default rendition, as used when the terminal is starting up or
418	being reset. Useful as a base to start when creating renditions.
419
420	=item $rend = urxvt::OVERLAY_RSTYLE
421
422	Return the rendition mask used for overlays by default.
423
424	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
425
426	Return the bit that enabled bold, italic, blink, reverse-video and
427	underline, respectively. To enable such a style, just logically OR it into
428	the bitset.
429
430	=item $foreground = urxvt::GET_BASEFG $rend
431
432	=item $background = urxvt::GET_BASEBG $rend
433
434	Return the foreground/background colour index, respectively.
435
436	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
437
438	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
439
440	Replace the foreground/background colour in the rendition mask with the
441	specified one.
442
443	=item $value = urxvt::GET_CUSTOM ($rend)
444
445	Return the "custom" value: Every rendition has 5 bits for use by
446	extensions. They can be set and changed as you like and are initially
447	zero.
448
449	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
450
451	Change the custom value.
452
453	=back
454
455	=cut	350	=cut
456		351
457	package urxvt;	352	package urxvt;
458		353
459	use utf8;	354	use utf8;
…		…
470		365
471	our $LIBDIR;	366	our $LIBDIR;
472	our $RESNAME;	367	our $RESNAME;
473	our $RESCLASS;	368	our $RESCLASS;
474	our $RXVTNAME;	369	our $RXVTNAME;
		370
		371	=head2 Variables in the C<urxvt> Package
		372
		373	=over 4
		374
		375	=item $urxvt::LIBDIR
		376
		377	The rxvt-unicode library directory, where, among other things, the perl
		378	modules and scripts are stored.
		379
		380	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		381
		382	The resource class and name rxvt-unicode uses to look up X resources.
		383
		384	=item $urxvt::RXVTNAME
		385
		386	The basename of the installed binaries, usually C<urxvt>.
		387
		388	=item $urxvt::TERM
		389
		390	The current terminal. This variable stores the current C<urxvt::term>
		391	object, whenever a callback/hook is executing.
		392
		393	=back
		394
		395	=head2 Functions in the C<urxvt> Package
		396
		397	=over 4
		398
		399	=item urxvt::fatal $errormessage
		400
		401	Fatally aborts execution with the given error message. Avoid at all
		402	costs! The only time this is acceptable is when the terminal process
		403	starts up.
		404
		405	=item urxvt::warn $string
		406
		407	Calls C<rxvt_warn> with the given string which should not include a
		408	newline. The module also overwrites the C<warn> builtin with a function
		409	that calls this function.
		410
		411	Using this function has the advantage that its output ends up in the
		412	correct place, e.g. on stderr of the connecting urxvtc client.
		413
		414	Messages have a size limit of 1023 bytes currently.
		415
		416	=item $is_safe = urxvt::safe
		417
		418	Returns true when it is safe to do potentially unsafe things, such as
		419	evaluating perl code specified by the user. This is true when urxvt was
		420	started setuid or setgid.
		421
		422	=item $time = urxvt::NOW
		423
		424	Returns the "current time" (as per the event loop).
		425
		426	=item urxvt::CurrentTime
		427
		428	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		429	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		430	Button4Mask, Button5Mask, AnyModifier
		431
		432	Various constants for use in X calls and event processing.
		433
		434	=back
		435
		436	=head2 RENDITION
		437
		438	Rendition bitsets contain information about colour, font, font styles and
		439	similar information for each screen cell.
		440
		441	The following "macros" deal with changes in rendition sets. You should
		442	never just create a bitset, you should always modify an existing one,
		443	as they contain important information required for correct operation of
		444	rxvt-unicode.
		445
		446	=over 4
		447
		448	=item $rend = urxvt::DEFAULT_RSTYLE
		449
		450	Returns the default rendition, as used when the terminal is starting up or
		451	being reset. Useful as a base to start when creating renditions.
		452
		453	=item $rend = urxvt::OVERLAY_RSTYLE
		454
		455	Return the rendition mask used for overlays by default.
		456
		457	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		458
		459	Return the bit that enabled bold, italic, blink, reverse-video and
		460	underline, respectively. To enable such a style, just logically OR it into
		461	the bitset.
		462
		463	=item $foreground = urxvt::GET_BASEFG $rend
		464
		465	=item $background = urxvt::GET_BASEBG $rend
		466
		467	Return the foreground/background colour index, respectively.
		468
		469	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		470
		471	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		472
		473	Replace the foreground/background colour in the rendition mask with the
		474	specified one.
		475
		476	=item $value = urxvt::GET_CUSTOM $rend
		477
		478	Return the "custom" value: Every rendition has 5 bits for use by
		479	extensions. They can be set and changed as you like and are initially
		480	zero.
		481
		482	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		483
		484	Change the custom value.
		485
		486	=back
		487
		488	=cut
475		489
476	BEGIN {	490	BEGIN {
477	urxvt->bootstrap;	491	urxvt->bootstrap;
478		492
479	# overwrite perl's warn	493	# overwrite perl's warn
…		…
675		689
676	=head2 The C<urxvt::anyevent> Class	690	=head2 The C<urxvt::anyevent> Class
677		691
678	The sole purpose of this class is to deliver an interface to the	692	The sole purpose of this class is to deliver an interface to the
679	C<AnyEvent> module - any module using it will work inside urxvt without	693	C<AnyEvent> module - any module using it will work inside urxvt without
680	further work. The only exception is that you cannot wait on condition	694	further programming. The only exception is that you cannot wait on
681	variables, but non-blocking condvar use is ok. What this means is that you	695	condition variables, but non-blocking condvar use is ok. What this means
682	cannot use blocking APIs, but the non-blocking variant should work.	696	is that you cannot use blocking APIs, but the non-blocking variant should
		697	work.
683		698
684	=cut	699	=cut
685		700
686	our $VERSION = 1;	701	our $VERSION = 1;
687		702
…		…
764	$proxy->enable ($name => $ref);	779	$proxy->enable ($name => $ref);
765	}	780	}
766	}	781	}
767	}	782	}
768		783
		784	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		785
		786	Creates a new terminal, very similar as if you had started it with system
		787	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		788	hash which defines the environment of the new terminal.
		789
		790	Croaks (and probably outputs an error message) if the new instance
		791	couldn't be created. Returns C<undef> if the new instance didn't
		792	initialise perl, and the terminal object otherwise. The C<init> and
		793	C<start> hooks will be called during this call.
		794
		795	=cut
		796
		797	sub new {
		798	my ($class, $env, @args) = @_;
		799
		800	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		801	}
		802
769	=item $term->destroy	803	=item $term->destroy
770		804
771	Destroy the terminal object (close the window, free resources etc.).	805	Destroy the terminal object (close the window, free resources
		806	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		807	watchers (timers, io watchers) are still active.
772		808
773	=item $isset = $term->option ($optval[, $set])	809	=item $isset = $term->option ($optval[, $set])
774		810
775	Returns true if the option specified by C<$optval> is enabled, and	811	Returns true if the option specified by C<$optval> is enabled, and
776	optionally change it. All option values are stored by name in the hash	812	optionally change it. All option values are stored by name in the hash
…		…
826	my ($self, $name) = (shift, shift);	862	my ($self, $name) = (shift, shift);
827	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	863	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
828	&urxvt::term::_resource	864	&urxvt::term::_resource
829	}	865	}
830		866
		867	=item $value = $term->x_resource ($pattern)
		868
		869	Returns the X-Resource for the given pattern, excluding the program or
		870	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		871	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		872	resource with that pattern exists.
		873
		874	This method should only be called during the C<on_start> hook, as there is
		875	only one resource database per display, and later invocations might return
		876	the wrong resources.
		877
831	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	878	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
832		879
833	Adds a keymap translation exactly as specified via a resource. See the	880	Adds a keymap translation exactly as specified via a resource. See the
834	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	881	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
835		882
…		…
1034		1081
1035	=item $lines_in_scrollback = $term->nsaved	1082	=item $lines_in_scrollback = $term->nsaved
1036		1083
1037	Return various integers describing terminal characteristics.	1084	Return various integers describing terminal characteristics.
1038		1085
		1086	=item $x_display = $term->display_id
		1087
		1088	Return the DISPLAY used by rxvt-unicode.
		1089
1039	=item $lc_ctype = $term->locale	1090	=item $lc_ctype = $term->locale
1040		1091
1041	Returns the LC_CTYPE category string used by this rxvt-unicode.	1092	Returns the LC_CTYPE category string used by this rxvt-unicode.
1042		1093
1043	=item $x_display = $term->display_id	1094	=item $env = $term->env
1044		1095
1045	Return the DISPLAY used by rxvt-unicode.	1096	Returns a copy of the environment in effect for the terminal as a hashref
		1097	similar to C<\%ENV>.
		1098
		1099	=cut
		1100
		1101	sub env {
		1102	if (my $env = $_[0]->_env) {
		1103	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1104	} else {
		1105	+{ %ENV }
		1106	}
		1107	}
1046		1108
1047	=item $modifiermask = $term->ModLevel3Mask	1109	=item $modifiermask = $term->ModLevel3Mask
1048		1110
1049	=item $modifiermask = $term->ModMetaMask	1111	=item $modifiermask = $term->ModMetaMask
1050		1112
…		…
1290	$item->{render} \|\|= sub { $_[0]{text} };	1352	$item->{render} \|\|= sub { $_[0]{text} };
1291		1353
1292	push @{ $self->{item} }, $item;	1354	push @{ $self->{item} }, $item;
1293	}	1355	}
1294		1356
		1357	=item $popup->add_title ($title)
		1358
		1359	Adds a non-clickable title to the popup.
		1360
		1361	=cut
		1362
		1363	sub add_title {
		1364	my ($self, $title) = @_;
		1365
		1366	$self->add_item ({
		1367	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1368	text => $title,
		1369	activate => sub { },
		1370	});
		1371	}
		1372
		1373	=item $popup->add_separator ([$sepchr])
		1374
		1375	Creates a separator, optionally using the character given as C<$sepchr>.
		1376
		1377	=cut
		1378
1295	sub add_separator {	1379	sub add_separator {
1296	my ($self, $sep) = @_;	1380	my ($self, $sep) = @_;
1297		1381
1298	$sep \|\|= "=";	1382	$sep \|\|= "=";
1299		1383
…		…
1303	render => sub { $sep x $self->{term}->ncol },	1387	render => sub { $sep x $self->{term}->ncol },
1304	activate => sub { },	1388	activate => sub { },
1305	});	1389	});
1306	}	1390	}
1307		1391
1308	sub add_title {	1392	=item $popup->add_button ($text, $cb)
1309	my ($self, $title) = @_;
1310		1393
1311	$self->add_item ({	1394	Adds a clickable button to the popup. C<$cb> is called whenever it is
1312	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1395	selected.
1313	text => $title,	1396
1314	activate => sub { },	1397	=cut
1315	});
1316	}
1317		1398
1318	sub add_button {	1399	sub add_button {
1319	my ($self, $text, $cb) = @_;	1400	my ($self, $text, $cb) = @_;
1320		1401
1321	$self->add_item ({ type => "button", text => $text, activate => $cb});	1402	$self->add_item ({ type => "button", text => $text, activate => $cb});
1322	}	1403	}
		1404
		1405	=item $popup->add_toggle ($text, $cb, $initial_value)
		1406
		1407	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1408	whenever it gets toggled, with a boolean indicating its value as its first
		1409	argument.
		1410
		1411	=cut
1323		1412
1324	sub add_toggle {	1413	sub add_toggle {
1325	my ($self, $text, $cb, $value) = @_;	1414	my ($self, $text, $cb, $value) = @_;
1326		1415
1327	my $item; $item = {	1416	my $item; $item = {
1328	type => "button",	1417	type => "button",
1329	text => " $text",	1418	text => " $text",
1330	value => $value,	1419	value => $value,
1331	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1420	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1332	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1421	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1333	};	1422	};
1334		1423
1335	$self->add_item ($item);	1424	$self->add_item ($item);
1336	}	1425	}
		1426
		1427	=item $popup->show
		1428
		1429	Displays the popup (which is initially hidden).
		1430
		1431	=cut
1337		1432
1338	sub show {	1433	sub show {
1339	my ($self) = @_;	1434	my ($self) = @_;
1340		1435
1341	local $urxvt::popup::self = $self;	1436	local $urxvt::popup::self = $self;
1342		1437
		1438	my $env = $self->{term}->env;
		1439	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1440	delete $env->{LC_ALL};
1343	local $ENV{LC_ALL} = $self->{term}->locale;	1441	$env->{LC_CTYPE} = $self->{term}->locale;
1344		1442
		1443	urxvt::term->new ($env, $self->{term}->resource ("name"),
1345	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1444	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1346	"--transient-for" => $self->{term}->parent,	1445	"--transient-for" => $self->{term}->parent,
1347	"-display" => $self->{term}->display_id,	1446	"-display" => $self->{term}->display_id,
1348	"-pe" => "urxvt-popup")	1447	"-pe" => "urxvt-popup")
1349	or die "unable to create popup window\n";	1448	or die "unable to create popup window\n";
1350	}	1449	}
1351		1450
1352	sub DESTROY {	1451	sub DESTROY {
1353	my ($self) = @_;	1452	my ($self) = @_;
1354		1453
1355	delete $self->{term}{_destroy}{$self};	1454	delete $self->{term}{_destroy}{$self};
1356	$self->{term}->ungrab;	1455	$self->{term}->ungrab;
1357	}	1456	}
		1457
		1458	=back
1358		1459
1359	=head2 The C<urxvt::timer> Class	1460	=head2 The C<urxvt::timer> Class
1360		1461
1361	This class implements timer watchers/events. Time is represented as a	1462	This class implements timer watchers/events. Time is represented as a
1362	fractional number of seconds since the epoch. Example:	1463	fractional number of seconds since the epoch. Example:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC vs. Revision 1.81 by root, Thu Jan 12 00:12:40 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.74 by root, Tue Jan 10 04:26:54 2006 UTC vs.
Revision 1.81 by root, Thu Jan 12 00:12:40 2006 UTC