[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.78 by root, Wed Jan 11 01:01:52 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
…		…
98	Displays a very simple digital clock in the upper right corner of the	99	Displays a very simple digital clock in the upper right corner of the
99	window. Illustrates overwriting the refresh callbacks to create your own	100	window. Illustrates overwriting the refresh callbacks to create your own
100	overlays or changes.	101	overlays or changes.
101		102
102	=back	103	=back
		104
		105	=head1 API DOCUMENTATION
103		106
104	=head2 General API Considerations	107	=head2 General API Considerations
105		108
106	All objects (such as terminals, time watchers etc.) are typical	109	All objects (such as terminals, time watchers etc.) are typical
107	reference-to-hash objects. The hash can be used to store anything you	110	reference-to-hash objects. The hash can be used to store anything you
…		…
120	=over 4	123	=over 4
121		124
122	=item $text	125	=item $text
123		126
124	Rxvt-unicodes special way of encoding text, where one "unicode" character	127	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.	128	always represents one screen cell. See L<ROW_t> for a discussion of this format.
126		129
127	=item $string	130	=item $string
128		131
129	A perl text string, with an emphasis on I<text>. It can store all unicode	132	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	133	characters and is to be distinguished with text encoded in a specific
…		…
340		343
341	subwindow.	344	subwindow.
342		345
343	=back	346	=back
344		347
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	348	=cut
456		349
457	package urxvt;	350	package urxvt;
458		351
459	use utf8;	352	use utf8;
…		…
470		363
471	our $LIBDIR;	364	our $LIBDIR;
472	our $RESNAME;	365	our $RESNAME;
473	our $RESCLASS;	366	our $RESCLASS;
474	our $RXVTNAME;	367	our $RXVTNAME;
		368
		369	=head2 Variables in the C<urxvt> Package
		370
		371	=over 4
		372
		373	=item $urxvt::LIBDIR
		374
		375	The rxvt-unicode library directory, where, among other things, the perl
		376	modules and scripts are stored.
		377
		378	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		379
		380	The resource class and name rxvt-unicode uses to look up X resources.
		381
		382	=item $urxvt::RXVTNAME
		383
		384	The basename of the installed binaries, usually C<urxvt>.
		385
		386	=item $urxvt::TERM
		387
		388	The current terminal. This variable stores the current C<urxvt::term>
		389	object, whenever a callback/hook is executing.
		390
		391	=back
		392
		393	=head2 Functions in the C<urxvt> Package
		394
		395	=over 4
		396
		397	=item urxvt::fatal $errormessage
		398
		399	Fatally aborts execution with the given error message. Avoid at all
		400	costs! The only time this is acceptable is when the terminal process
		401	starts up.
		402
		403	=item urxvt::warn $string
		404
		405	Calls C<rxvt_warn> with the given string which should not include a
		406	newline. The module also overwrites the C<warn> builtin with a function
		407	that calls this function.
		408
		409	Using this function has the advantage that its output ends up in the
		410	correct place, e.g. on stderr of the connecting urxvtc client.
		411
		412	Messages have a size limit of 1023 bytes currently.
		413
		414	=item $is_safe = urxvt::safe
		415
		416	Returns true when it is safe to do potentially unsafe things, such as
		417	evaluating perl code specified by the user. This is true when urxvt was
		418	started setuid or setgid.
		419
		420	=item $time = urxvt::NOW
		421
		422	Returns the "current time" (as per the event loop).
		423
		424	=item urxvt::CurrentTime
		425
		426	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		427	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		428	Button4Mask, Button5Mask, AnyModifier
		429
		430	Various constants for use in X calls and event processing.
		431
		432	=back
		433
		434	=head2 RENDITION
		435
		436	Rendition bitsets contain information about colour, font, font styles and
		437	similar information for each screen cell.
		438
		439	The following "macros" deal with changes in rendition sets. You should
		440	never just create a bitset, you should always modify an existing one,
		441	as they contain important information required for correct operation of
		442	rxvt-unicode.
		443
		444	=over 4
		445
		446	=item $rend = urxvt::DEFAULT_RSTYLE
		447
		448	Returns the default rendition, as used when the terminal is starting up or
		449	being reset. Useful as a base to start when creating renditions.
		450
		451	=item $rend = urxvt::OVERLAY_RSTYLE
		452
		453	Return the rendition mask used for overlays by default.
		454
		455	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		456
		457	Return the bit that enabled bold, italic, blink, reverse-video and
		458	underline, respectively. To enable such a style, just logically OR it into
		459	the bitset.
		460
		461	=item $foreground = urxvt::GET_BASEFG $rend
		462
		463	=item $background = urxvt::GET_BASEBG $rend
		464
		465	Return the foreground/background colour index, respectively.
		466
		467	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		468
		469	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		470
		471	Replace the foreground/background colour in the rendition mask with the
		472	specified one.
		473
		474	=item $value = urxvt::GET_CUSTOM $rend
		475
		476	Return the "custom" value: Every rendition has 5 bits for use by
		477	extensions. They can be set and changed as you like and are initially
		478	zero.
		479
		480	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		481
		482	Change the custom value.
		483
		484	=back
		485
		486	=cut
475		487
476	BEGIN {	488	BEGIN {
477	urxvt->bootstrap;	489	urxvt->bootstrap;
478		490
479	# overwrite perl's warn	491	# overwrite perl's warn
…		…
675		687
676	=head2 The C<urxvt::anyevent> Class	688	=head2 The C<urxvt::anyevent> Class
677		689
678	The sole purpose of this class is to deliver an interface to the	690	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	691	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	692	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	693	condition variables, but non-blocking condvar use is ok. What this means
682	cannot use blocking APIs, but the non-blocking variant should work.	694	is that you cannot use blocking APIs, but the non-blocking variant should
		695	work.
683		696
684	=cut	697	=cut
685		698
686	our $VERSION = 1;	699	our $VERSION = 1;
687		700
…		…
764	$proxy->enable ($name => $ref);	777	$proxy->enable ($name => $ref);
765	}	778	}
766	}	779	}
767	}	780	}
768		781
		782	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		783
		784	Creates a new terminal, very similar as if you had started it with system
		785	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		786	hash which defines the environment of the new terminal.
		787
		788	Croaks (and probably outputs an error message) if the new instance
		789	couldn't be created. Returns C<undef> if the new instance didn't
		790	initialise perl, and the terminal object otherwise. The C<init> and
		791	C<start> hooks will be called during this call.
		792
		793	=cut
		794
		795	sub new {
		796	my ($class, $env, @args) = @_;
		797
		798	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		799	}
		800
769	=item $term->destroy	801	=item $term->destroy
770		802
771	Destroy the terminal object (close the window, free resources etc.).	803	Destroy the terminal object (close the window, free resources
		804	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		805	watchers (timers, io watchers) are still active.
772		806
773	=item $isset = $term->option ($optval[, $set])	807	=item $isset = $term->option ($optval[, $set])
774		808
775	Returns true if the option specified by C<$optval> is enabled, and	809	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	810	optionally change it. All option values are stored by name in the hash
…		…
1034		1068
1035	=item $lines_in_scrollback = $term->nsaved	1069	=item $lines_in_scrollback = $term->nsaved
1036		1070
1037	Return various integers describing terminal characteristics.	1071	Return various integers describing terminal characteristics.
1038		1072
		1073	=item $x_display = $term->display_id
		1074
		1075	Return the DISPLAY used by rxvt-unicode.
		1076
1039	=item $lc_ctype = $term->locale	1077	=item $lc_ctype = $term->locale
1040		1078
1041	Returns the LC_CTYPE category string used by this rxvt-unicode.	1079	Returns the LC_CTYPE category string used by this rxvt-unicode.
1042		1080
1043	=item $x_display = $term->display_id	1081	=item $env = $term->env
1044		1082
1045	Return the DISPLAY used by rxvt-unicode.	1083	Returns a copy of the environment in effect for the terminal as a hashref
		1084	similar to C<\%ENV>.
		1085
		1086	=cut
		1087
		1088	sub env {
		1089	if (my $env = $_[0]->_env) {
		1090	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1091	} else {
		1092	+{ %ENV }
		1093	}
		1094	}
1046		1095
1047	=item $modifiermask = $term->ModLevel3Mask	1096	=item $modifiermask = $term->ModLevel3Mask
1048		1097
1049	=item $modifiermask = $term->ModMetaMask	1098	=item $modifiermask = $term->ModMetaMask
1050		1099
…		…
1290	$item->{render} \|\|= sub { $_[0]{text} };	1339	$item->{render} \|\|= sub { $_[0]{text} };
1291		1340
1292	push @{ $self->{item} }, $item;	1341	push @{ $self->{item} }, $item;
1293	}	1342	}
1294		1343
		1344	=item $popup->add_title ($title)
		1345
		1346	Adds a non-clickable title to the popup.
		1347
		1348	=cut
		1349
		1350	sub add_title {
		1351	my ($self, $title) = @_;
		1352
		1353	$self->add_item ({
		1354	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1355	text => $title,
		1356	activate => sub { },
		1357	});
		1358	}
		1359
		1360	=item $popup->add_separator ([$sepchr])
		1361
		1362	Creates a separator, optionally using the character given as C<$sepchr>.
		1363
		1364	=cut
		1365
1295	sub add_separator {	1366	sub add_separator {
1296	my ($self, $sep) = @_;	1367	my ($self, $sep) = @_;
1297		1368
1298	$sep \|\|= "=";	1369	$sep \|\|= "=";
1299		1370
…		…
1303	render => sub { $sep x $self->{term}->ncol },	1374	render => sub { $sep x $self->{term}->ncol },
1304	activate => sub { },	1375	activate => sub { },
1305	});	1376	});
1306	}	1377	}
1307		1378
1308	sub add_title {	1379	=item $popup->add_button ($text, $cb)
1309	my ($self, $title) = @_;
1310		1380
1311	$self->add_item ({	1381	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" },	1382	selected.
1313	text => $title,	1383
1314	activate => sub { },	1384	=cut
1315	});
1316	}
1317		1385
1318	sub add_button {	1386	sub add_button {
1319	my ($self, $text, $cb) = @_;	1387	my ($self, $text, $cb) = @_;
1320		1388
1321	$self->add_item ({ type => "button", text => $text, activate => $cb});	1389	$self->add_item ({ type => "button", text => $text, activate => $cb});
1322	}	1390	}
		1391
		1392	=item $popup->add_toggle ($text, $cb, $initial_value)
		1393
		1394	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1395	whenever it gets toggled, with a boolean indicating its value as its first
		1396	argument.
		1397
		1398	=cut
1323		1399
1324	sub add_toggle {	1400	sub add_toggle {
1325	my ($self, $text, $cb, $value) = @_;	1401	my ($self, $text, $cb, $value) = @_;
1326		1402
1327	my $item; $item = {	1403	my $item; $item = {
1328	type => "button",	1404	type => "button",
1329	text => " $text",	1405	text => " $text",
1330	value => $value,	1406	value => $value,
1331	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1407	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1332	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1408	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1333	};	1409	};
1334		1410
1335	$self->add_item ($item);	1411	$self->add_item ($item);
1336	}	1412	}
		1413
		1414	=item $popup->show
		1415
		1416	Displays the popup (which is initially hidden).
		1417
		1418	=cut
1337		1419
1338	sub show {	1420	sub show {
1339	my ($self) = @_;	1421	my ($self) = @_;
1340		1422
1341	local $urxvt::popup::self = $self;	1423	local $urxvt::popup::self = $self;
1342		1424
		1425	my $env = $self->{term}->env;
		1426	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1427	delete $env->{LC_ALL};
1343	local $ENV{LC_ALL} = $self->{term}->locale;	1428	$env->{LC_CTYPE} = $self->{term}->locale;
1344		1429
		1430	urxvt::term->new ($env, $self->{term}->resource ("name"),
1345	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1431	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1346	"--transient-for" => $self->{term}->parent,	1432	"--transient-for" => $self->{term}->parent,
1347	"-display" => $self->{term}->display_id,	1433	"-display" => $self->{term}->display_id,
1348	"-pe" => "urxvt-popup")	1434	"-pe" => "urxvt-popup")
1349	or die "unable to create popup window\n";	1435	or die "unable to create popup window\n";
1350	}	1436	}
1351		1437
1352	sub DESTROY {	1438	sub DESTROY {
1353	my ($self) = @_;	1439	my ($self) = @_;
1354		1440
1355	delete $self->{term}{_destroy}{$self};	1441	delete $self->{term}{_destroy}{$self};
1356	$self->{term}->ungrab;	1442	$self->{term}->ungrab;
1357	}	1443	}
		1444
		1445	=back
1358		1446
1359	=head2 The C<urxvt::timer> Class	1447	=head2 The C<urxvt::timer> Class
1360		1448
1361	This class implements timer watchers/events. Time is represented as a	1449	This class implements timer watchers/events. Time is represented as a
1362	fractional number of seconds since the epoch. Example:	1450	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.78 by root, Wed Jan 11 01:01:52 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.78 by root, Wed Jan 11 01:01:52 2006 UTC