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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.75 by root, Tue Jan 10 05:00:13 2006 UTC vs.
Revision 1.82 by root, Thu Jan 12 01:30:53 2006 UTC

…		…
84		84
85	Displays a digital clock using the built-in overlay.	85	Displays a digital clock using the built-in overlay.
86		86
87	=item mark-urls	87	=item mark-urls
88		88
89	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.
90		92
91	=item block-graphics-to-ascii	93	=item block-graphics-to-ascii
92		94
93	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,
94	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
…		…
123	=over 4	125	=over 4
124		126
125	=item $text	127	=item $text
126		128
127	Rxvt-unicodes special way of encoding text, where one "unicode" character	129	Rxvt-unicodes special way of encoding text, where one "unicode" character
128	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.
129		131
130	=item $string	132	=item $string
131		133
132	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
133	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
…		…
343		345
344	subwindow.	346	subwindow.
345		347
346	=back	348	=back
347		349
348	=head2 Variables in the C<urxvt> Package
349
350	=over 4
351
352	=item $urxvt::LIBDIR
353
354	The rxvt-unicode library directory, where, among other things, the perl
355	modules and scripts are stored.
356
357	=item $urxvt::RESCLASS, $urxvt::RESCLASS
358
359	The resource class and name rxvt-unicode uses to look up X resources.
360
361	=item $urxvt::RXVTNAME
362
363	The basename of the installed binaries, usually C<urxvt>.
364
365	=item $urxvt::TERM
366
367	The current terminal. This variable stores the current C<urxvt::term>
368	object, whenever a callback/hook is executing.
369
370	=item
371
372	=back
373
374	=head2 Functions in the C<urxvt> Package
375
376	=over 4
377
378	=item $term = new urxvt [arg...]
379
380	Creates a new terminal, very similar as if you had started it with
381	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
382	if the new instance couldn't be created. Returns C<undef> if the new
383	instance didn't initialise perl, and the terminal object otherwise. The
384	C<init> and C<start> hooks will be called during the call.
385
386	=item urxvt::fatal $errormessage
387
388	Fatally aborts execution with the given error message. Avoid at all
389	costs! The only time this is acceptable is when the terminal process
390	starts up.
391
392	=item urxvt::warn $string
393
394	Calls C<rxvt_warn> with the given string which should not include a
395	newline. The module also overwrites the C<warn> builtin with a function
396	that calls this function.
397
398	Using this function has the advantage that its output ends up in the
399	correct place, e.g. on stderr of the connecting urxvtc client.
400
401	=item $is_safe = urxvt::safe
402
403	Returns true when it is safe to do potentially unsafe things, such as
404	evaluating perl code specified by the user. This is true when urxvt was
405	started setuid or setgid.
406
407	=item $time = urxvt::NOW
408
409	Returns the "current time" (as per the event loop).
410
411	=item urxvt::CurrentTime
412
413	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
414	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
415	Button4Mask, Button5Mask, AnyModifier
416
417	Various constants for use in X calls and event processing.
418
419	=back
420
421	=head2 RENDITION
422
423	Rendition bitsets contain information about colour, font, font styles and
424	similar information for each screen cell.
425
426	The following "macros" deal with changes in rendition sets. You should
427	never just create a bitset, you should always modify an existing one,
428	as they contain important information required for correct operation of
429	rxvt-unicode.
430
431	=over 4
432
433	=item $rend = urxvt::DEFAULT_RSTYLE
434
435	Returns the default rendition, as used when the terminal is starting up or
436	being reset. Useful as a base to start when creating renditions.
437
438	=item $rend = urxvt::OVERLAY_RSTYLE
439
440	Return the rendition mask used for overlays by default.
441
442	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
443
444	Return the bit that enabled bold, italic, blink, reverse-video and
445	underline, respectively. To enable such a style, just logically OR it into
446	the bitset.
447
448	=item $foreground = urxvt::GET_BASEFG $rend
449
450	=item $background = urxvt::GET_BASEBG $rend
451
452	Return the foreground/background colour index, respectively.
453
454	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
455
456	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
457
458	Replace the foreground/background colour in the rendition mask with the
459	specified one.
460
461	=item $value = urxvt::GET_CUSTOM $rend
462
463	Return the "custom" value: Every rendition has 5 bits for use by
464	extensions. They can be set and changed as you like and are initially
465	zero.
466
467	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
468
469	Change the custom value.
470
471	=back
472
473	=cut	350	=cut
474		351
475	package urxvt;	352	package urxvt;
476		353
477	use utf8;	354	use utf8;
…		…
488		365
489	our $LIBDIR;	366	our $LIBDIR;
490	our $RESNAME;	367	our $RESNAME;
491	our $RESCLASS;	368	our $RESCLASS;
492	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
493		489
494	BEGIN {	490	BEGIN {
495	urxvt->bootstrap;	491	urxvt->bootstrap;
496		492
497	# overwrite perl's warn	493	# overwrite perl's warn
…		…
500	$msg .= "\n"	496	$msg .= "\n"
501	unless $msg =~ /\n$/;	497	unless $msg =~ /\n$/;
502	urxvt::warn ($msg);	498	urxvt::warn ($msg);
503	};	499	};
504		500
		501	# %ENV is the original startup environment
505	delete $ENV{IFS};	502	delete $ENV{IFS};
506	delete $ENV{CDPATH};	503	delete $ENV{CDPATH};
507	delete $ENV{BASH_ENV};	504	delete $ENV{BASH_ENV};
508	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";	505	$ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
509	}	506	}
…		…
781	for my $name (@HOOKNAME) {	778	for my $name (@HOOKNAME) {
782	if (my $ref = $pkg->can ("on_" . lc $name)) {	779	if (my $ref = $pkg->can ("on_" . lc $name)) {
783	$proxy->enable ($name => $ref);	780	$proxy->enable ($name => $ref);
784	}	781	}
785	}	782	}
		783	}
		784
		785	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		786
		787	Creates a new terminal, very similar as if you had started it with system
		788	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		789	hash which defines the environment of the new terminal.
		790
		791	Croaks (and probably outputs an error message) if the new instance
		792	couldn't be created. Returns C<undef> if the new instance didn't
		793	initialise perl, and the terminal object otherwise. The C<init> and
		794	C<start> hooks will be called during this call.
		795
		796	=cut
		797
		798	sub new {
		799	my ($class, $env, @args) = @_;
		800
		801	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
786	}	802	}
787		803
788	=item $term->destroy	804	=item $term->destroy
789		805
790	Destroy the terminal object (close the window, free resources	806	Destroy the terminal object (close the window, free resources
…		…
847	my ($self, $name) = (shift, shift);	863	my ($self, $name) = (shift, shift);
848	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);	864	unshift @_, $self, $name, ($name =~ s/\s\+\s(\d+)$// ? $1 : 0);
849	&urxvt::term::_resource	865	&urxvt::term::_resource
850	}	866	}
851		867
		868	=item $value = $term->x_resource ($pattern)
		869
		870	Returns the X-Resource for the given pattern, excluding the program or
		871	class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
		872	same value as used by this instance of rxvt-unicode. Returns C<undef> if no
		873	resource with that pattern exists.
		874
		875	This method should only be called during the C<on_start> hook, as there is
		876	only one resource database per display, and later invocations might return
		877	the wrong resources.
		878
852	=item $success = $term->parse_keysym ($keysym_spec, $command_string)	879	=item $success = $term->parse_keysym ($keysym_spec, $command_string)
853		880
854	Adds a keymap translation exactly as specified via a resource. See the	881	Adds a keymap translation exactly as specified via a resource. See the
855	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.	882	C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
856		883
…		…
1055		1082
1056	=item $lines_in_scrollback = $term->nsaved	1083	=item $lines_in_scrollback = $term->nsaved
1057		1084
1058	Return various integers describing terminal characteristics.	1085	Return various integers describing terminal characteristics.
1059		1086
		1087	=item $x_display = $term->display_id
		1088
		1089	Return the DISPLAY used by rxvt-unicode.
		1090
1060	=item $lc_ctype = $term->locale	1091	=item $lc_ctype = $term->locale
1061		1092
1062	Returns the LC_CTYPE category string used by this rxvt-unicode.	1093	Returns the LC_CTYPE category string used by this rxvt-unicode.
1063		1094
1064	=item $x_display = $term->display_id	1095	=item $env = $term->env
1065		1096
1066	Return the DISPLAY used by rxvt-unicode.	1097	Returns a copy of the environment in effect for the terminal as a hashref
		1098	similar to C<\%ENV>.
		1099
		1100	=cut
		1101
		1102	sub env {
		1103	if (my $env = $_[0]->_env) {
		1104	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1105	} else {
		1106	+{ %ENV }
		1107	}
		1108	}
1067		1109
1068	=item $modifiermask = $term->ModLevel3Mask	1110	=item $modifiermask = $term->ModLevel3Mask
1069		1111
1070	=item $modifiermask = $term->ModMetaMask	1112	=item $modifiermask = $term->ModMetaMask
1071		1113
…		…
1311	$item->{render} \|\|= sub { $_[0]{text} };	1353	$item->{render} \|\|= sub { $_[0]{text} };
1312		1354
1313	push @{ $self->{item} }, $item;	1355	push @{ $self->{item} }, $item;
1314	}	1356	}
1315		1357
		1358	=item $popup->add_title ($title)
		1359
		1360	Adds a non-clickable title to the popup.
		1361
		1362	=cut
		1363
		1364	sub add_title {
		1365	my ($self, $title) = @_;
		1366
		1367	$self->add_item ({
		1368	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1369	text => $title,
		1370	activate => sub { },
		1371	});
		1372	}
		1373
		1374	=item $popup->add_separator ([$sepchr])
		1375
		1376	Creates a separator, optionally using the character given as C<$sepchr>.
		1377
		1378	=cut
		1379
1316	sub add_separator {	1380	sub add_separator {
1317	my ($self, $sep) = @_;	1381	my ($self, $sep) = @_;
1318		1382
1319	$sep \|\|= "=";	1383	$sep \|\|= "=";
1320		1384
…		…
1324	render => sub { $sep x $self->{term}->ncol },	1388	render => sub { $sep x $self->{term}->ncol },
1325	activate => sub { },	1389	activate => sub { },
1326	});	1390	});
1327	}	1391	}
1328		1392
1329	sub add_title {	1393	=item $popup->add_button ($text, $cb)
1330	my ($self, $title) = @_;
1331		1394
1332	$self->add_item ({	1395	Adds a clickable button to the popup. C<$cb> is called whenever it is
1333	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1396	selected.
1334	text => $title,	1397
1335	activate => sub { },	1398	=cut
1336	});
1337	}
1338		1399
1339	sub add_button {	1400	sub add_button {
1340	my ($self, $text, $cb) = @_;	1401	my ($self, $text, $cb) = @_;
1341		1402
1342	$self->add_item ({ type => "button", text => $text, activate => $cb});	1403	$self->add_item ({ type => "button", text => $text, activate => $cb});
1343	}	1404	}
		1405
		1406	=item $popup->add_toggle ($text, $cb, $initial_value)
		1407
		1408	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1409	whenever it gets toggled, with a boolean indicating its value as its first
		1410	argument.
		1411
		1412	=cut
1344		1413
1345	sub add_toggle {	1414	sub add_toggle {
1346	my ($self, $text, $cb, $value) = @_;	1415	my ($self, $text, $cb, $value) = @_;
1347		1416
1348	my $item; $item = {	1417	my $item; $item = {
1349	type => "button",	1418	type => "button",
1350	text => " $text",	1419	text => " $text",
1351	value => $value,	1420	value => $value,
1352	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1421	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1353	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1422	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1354	};	1423	};
1355		1424
1356	$self->add_item ($item);	1425	$self->add_item ($item);
1357	}	1426	}
		1427
		1428	=item $popup->show
		1429
		1430	Displays the popup (which is initially hidden).
		1431
		1432	=cut
1358		1433
1359	sub show {	1434	sub show {
1360	my ($self) = @_;	1435	my ($self) = @_;
1361		1436
1362	local $urxvt::popup::self = $self;	1437	local $urxvt::popup::self = $self;
1363		1438
		1439	my $env = $self->{term}->env;
		1440	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1441	delete $env->{LC_ALL};
1364	local $ENV{LC_ALL} = $self->{term}->locale;	1442	$env->{LC_CTYPE} = $self->{term}->locale;
1365		1443
		1444	urxvt::term->new ($env, $self->{term}->resource ("name"),
1366	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1445	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1367	"--transient-for" => $self->{term}->parent,	1446	"--transient-for" => $self->{term}->parent,
1368	"-display" => $self->{term}->display_id,	1447	"-display" => $self->{term}->display_id,
1369	"-pe" => "urxvt-popup")	1448	"-pe" => "urxvt-popup")
1370	or die "unable to create popup window\n";	1449	or die "unable to create popup window\n";
1371	}	1450	}
1372		1451
1373	sub DESTROY {	1452	sub DESTROY {
1374	my ($self) = @_;	1453	my ($self) = @_;
1375		1454
1376	delete $self->{term}{_destroy}{$self};	1455	delete $self->{term}{_destroy}{$self};
1377	$self->{term}->ungrab;	1456	$self->{term}->ungrab;
1378	}	1457	}
		1458
		1459	=back
1379		1460
1380	=head2 The C<urxvt::timer> Class	1461	=head2 The C<urxvt::timer> Class
1381		1462
1382	This class implements timer watchers/events. Time is represented as a	1463	This class implements timer watchers/events. Time is represented as a
1383	fractional number of seconds since the epoch. Example:	1464	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.75 by root, Tue Jan 10 05:00:13 2006 UTC vs. Revision 1.82 by root, Thu Jan 12 01:30:53 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.75 by root, Tue Jan 10 05:00:13 2006 UTC vs.
Revision 1.82 by root, Thu Jan 12 01:30:53 2006 UTC