Tag
Hash :
7df3c151
Author :
Date :
2003-02-02T10:09:25
* lib/Automake/DisjConditions.pm (_permutations_worker) (permutations): Remove, so that people aren't tempted to use it. * lib/Automake/tests/DisjConditions.pl (tests_permutations): Remove.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708
# Copyright (C) 1997, 2001, 2002, 2003 Free Software Foundation, Inc.
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2, or (at your option)
# any later version.
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
# 02111-1307, USA.
package Automake::DisjConditions;
use Carp;
use strict;
use Automake::Condition qw/TRUE FALSE/;
=head1 NAME
Automake::DisjConditions - record a disjunction of Conditions
=head1 SYNOPSIS
use Automake::Condition;
use Automake::DisjConditions;
# Create a Condition to represent "COND1 and not COND2".
my $cond = new Automake::Condition "COND1_TRUE", "COND2_FALSE";
# Create a Condition to represent "not COND3".
my $other = new Automake::Condition "COND3_FALSE";
# Create a DisjConditions to represent
# "(COND1 and not COND2) or (not COND3)"
my $set = new Automake::DisjConditions $cond, $other;
# Return the list of Conditions involved in $set.
my @conds = $set->conds;
# Return one of the Condition involved in $set.
my $cond = $set->one_cond;
# Return true iff $set is always true (i.e. its subconditions
# conver all cases).
if ($set->true) { ... }
# Return false iff $set is always false (i.e. is empty, or contains
# only false conditions).
if ($set->false) { ... }
# Return a string representing the DisjConditions.
# "COND1_TRUE COND2_FALSE | COND3_FALSE"
my $str = $set->string;
# Return a human readable string representing the DisjConditions.
# "(COND1 and !COND2) or (!COND3)"
my $str = $set->human;
# Invert a DisjConditions, i.e., create a new DisjConditions
# that complements $set.
my $inv = $set->invert;
# Multiply two DisjConditions.
my $prod = $set1->multiply ($set2)
# Return the subconditions of a DisjConditions with respect to
# a Condition. See the description for a real example.
my $subconds = $set->sub_conditions ($cond)
=head1 DESCRIPTION
A C<DisjConditions> is a disjunction of C<Condition>s. In Automake
they are used to represent the conditions into which Makefile
variables and Makefile rules are defined.
If the variable C<VAR> is defined as
if COND1
if COND2
VAR = value1
endif
endif
if !COND3
if COND4
VAR = value2
endif
endif
then it will be associated a C<DisjConditions> created with
the following statement.
new Automake::DisjConditions
(new Automake::Condition ("COND1_TRUE", "COND2_TRUE"),
new Automake::Condition ("COND3_FALSE", "COND4_TRUE"));
As you can see, a C<DisjConditions> is made from a list of
C<Condition>s. Since C<DisjConditions> is a disjunction, and
C<Condition> is a conjunction, the above can be read as
follows.
(COND1 and COND2) or ((not COND3) and COND4)
That's indeed the condition into which C<VAR> has a value.
Like C<Condition> objects, a C<DisjConditions> object is unique
with respect to its conditions. Two C<DisjConditions> objects created
for the same set of conditions will have the same adress. This makes
it easy to compare C<DisjConditions>s: just compare the references.
=head2 Methods
=over 4
=item C<$set = new Automake::DisjConditions [@conds]>
Create a C<DisjConditions> object from the list of C<Condition>
objects passed in arguments.
If the C<@conds> list is empty, the C<DisjConditions> is assumed to be
false.
As explained previously, the reference (object) returned is unique
with respect to C<@conds>. For this purpose, duplicate elements are
ignored.
=cut
# Keys in this hash are DisjConditions strings. Values are the
# associated object DisjConditions. This is used by `new' to reuse
# DisjConditions objects with identical conditions.
use vars '%_disjcondition_singletons';
sub new ($;@)
{
my ($class, @conds) = @_;
my $self = {
hash => {},
};
bless $self, $class;
for my $cond (@conds)
{
confess "`$cond' isn't a reference" unless ref $cond;
confess "`$cond' isn't an Automake::Condition"
unless $cond->isa ("Automake::Condition");
# This is a disjunction of conditions, so we drop
# false conditions. We'll always treat an "empty"
# DisjConditions as false for this reason.
next if $cond->false;
# Store conditions as keys AND as values, because blessed
# objects are converted to string when used as keys (so
# at least we still have the value when we need to call
# a method).
$self->{'hash'}{$cond} = $cond;
}
my $key = $self->string;
if (exists $_disjcondition_singletons{$key})
{
return $_disjcondition_singletons{$key};
}
$_disjcondition_singletons{$key} = $self;
return $self;
}
=item C<@conds = $set-E<gt>conds>
Return the list of C<Condition> objects involved in C<$set>.
=cut
sub conds ($ )
{
my ($self) = @_;
return @{$self->{'conds'}} if exists $self->{'conds'};
my @conds = values %{$self->{'hash'}};
@conds = sort { $a->string cmp $b->string } @conds;
$self->{'conds'} = [@conds];
return @conds;
}
=item C<$cond = $set-E<gt>one_cond>
Return one C<Condition> object involved in C<$set>.
=cut
sub one_cond ($)
{
my ($self) = @_;
return (%{$self->{'hash'}},)[1];
}
=item C<$et = $set-E<gt>false>
Return 1 iff the C<DisjConditions> object is always false (i.e., if it
is empty, or if it contains only false C<Condition>s). Return 0
otherwise.
=cut
sub false ($ )
{
my ($self) = @_;
return 0 == keys %{$self->{'hash'}};
}
=item C<$et = $set-E<gt>true>
Return 1 iff the C<DisjConditions> object is always true (i.e. covers all
conditions). Return 0 otherwise.
=cut
sub true ($ )
{
my ($self) = @_;
# We cache 'true' so that simplify() can use the value if it's available.
return $self->{'true'} if defined $self->{'true'};
my $res = $self->invert->false;
$self->{'true'} = $res;
return $res;
}
=item C<$str = $set-E<gt>string>
Build a string which denotes the C<DisjConditions>.
=cut
sub string ($ )
{
my ($self) = @_;
return $self->{'string'} if defined $self->{'string'};
my $res = '';
if ($self->false)
{
$res = 'FALSE';
}
else
{
$res = join (' | ', map { $_->string } $self->conds);
}
$self->{'string'} = $res;
return $res;
}
=item C<$cond-E<gt>human>
Build a human readable string which denotes the C<DisjConditions>.
=cut
sub human ($ )
{
my ($self) = @_;
return $self->{'human'} if defined $self->{'human'};
my $res = '';
if ($self->false)
{
$res = 'FALSE';
}
else
{
my @c = $self->conds;
if (1 == @c)
{
$res = $self->human;
}
else
{
$res = '(' . join (') or (', map { $_->human } $self->conds) . ')';
}
}
$self->{'human'} = $res;
return $res;
}
=item C<$prod = $set1->multiply ($set2)>
Multiply two conditional sets.
my $set1 = new Automake::DisjConditions
(new Automake::Condition ("A_TRUE"),
new Automake::Condition ("B_TRUE"));
my $set2 = new Automake::DisjConditions
(new Automake::Condition ("C_FALSE"),
new Automake::Condition ("D_FALSE"));
C<$set1-E<gt>multiply ($set2)> will return
new Automake::DisjConditions
(new Automake::Condition ("A_TRUE", "C_FALSE"),
new Automake::Condition ("B_TRUE", "C_FALSE"),;
new Automake::Condition ("A_TRUE", "D_FALSE"),
new Automake::Condition ("B_TRUE", "D_FALSE"));
The argument can also be a C<Condition>.
=cut
# Same as multiply() but take a list of Conditonals as second argument.
# We use this in invert().
sub _multiply ($@)
{
my ($self, @set) = @_;
my @res = ();
foreach my $selfcond ($self->conds)
{
foreach my $setcond (@set)
{
push @res, $selfcond->merge ($setcond);
}
}
return new Automake::DisjConditions @res;
}
sub multiply ($$)
{
my ($self, $set) = @_;
return $self->_multiply ($set) if $set->isa('Automake::Condition');
return $self->_multiply ($set->conds);
}
=item C<$inv = $set-E<gt>invert>
Invert a C<DisjConditions>. Return a C<DisjConditions> which is true
when C<$set> is false, and vice-versa.
my $set = new Automake::DisjConditions
(new Automake::Condition ("A_TRUE", "B_TRUE"),
new Automake::Condition ("A_FALSE", "B_FALSE"));
Calling C<$set-E<gt>invert> will return the following C<DisjConditions>.
new Automake::DisjConditions
(new Automake::Condition ("A_TRUE", "B_FALSE"),
new Automake::Condition ("A_FALSE", "B_TRUE"));
=cut
sub invert($ )
{
my ($self) = @_;
return $self->{'invert'} if defined $self->{'invert'};
# The invert of an empty DisjConditions is TRUE.
my $res = new Automake::DisjConditions TRUE;
# !((a.b)+(c.d)+(e.f))
# = (!a+!b).(!c+!d).(!e+!f)
# We develop this into a sum of product iteratively, starting from TRUE:
# 1) TRUE
# 2) TRUE.!a + TRUE.!b
# 3) TRUE.!a.!c + TRUE.!b.!c + TRUE.!a.!d + TRUE.!b.!d
# 4) TRUE.!a.!c.!e + TRUE.!b.!c.!e + TRUE.!a.!d.!e + TRUE.!b.!d.!e
# + TRUE.!a.!c.!f + TRUE.!b.!c.!f + TRUE.!a.!d.!f + TRUE.!b.!d.!f
foreach my $cond ($self->conds)
{
$res = $res->_multiply ($cond->not);
}
# Cache result.
$self->{'invert'} = $res;
# It's tempting to also set $res->{'invert'} to $self, but that
# is a bad idea as $self hasn't been normalized in any way.
# (Different inputs can produce the same inverted set.)
return $res;
}
=item C<$simp = $set->simplify>
Find prime implicants and return a simplified C<DisjConditions>.
=cut
sub _simplify ($) # Based on Quine-McCluskey's algorithm.
{
my ($self) = @_;
# If we know this DisjConditions is always true, we have nothing to do.
# Use the cached value if true if available. Never call true()
# as this would call invert() which can be slow.
return new Automake::DisjConditions TRUE
if $self->{'hash'}{&TRUE} || $self->{'true'};
my $nvars = 0;
my %var_rank;
my @rank_var;
# Initialization.
# Translate and-terms into bit string pairs: [$true, $false].
#
# Each variable is given a bit position in the strings.
#
# The first string in the pair tells wether a variable is
# uncomplemented in the term.
# The second string tells whether a variable is complemented.
# If a variable does not appear in the term, then its
# corresponding bit is unset in both strings.
# Order the resulting bit string pairs by the number of
# variables involved:
# @{$subcubes[2]} is the list of string pairs involving two variables.
# (Level 0 is used for "TRUE".)
my @subcubes;
for my $and_conds ($self->conds)
{
my $true = 0; # Bit string for uncomplemented variables.
my $false = 0; # Bit string for complemented variables.
my @conds = $and_conds->conds;
for my $cond (@conds)
{
# Which variable is this conditional about?
confess "can't parse `$cond'"
unless $cond =~ /^(.*_)(FALSE|TRUE)$/;
# Get the variabe's rank, or assign it a new one.
my $rank = $var_rank{$1};
if (! defined $rank)
{
$rank = $nvars++;
# FIXME: simplify() cannot work with more that 31 variables.
# We need a bitset implementation to allow more variables.
# For now we just return the input, as is, not simplified.
return $self if $rank >= 31;
$var_rank{$1} = $rank;
$rank_var[$rank] = $1;
}
# Fire the relevant bit in the strings.
if ($2 eq 'FALSE')
{
$false |= 1 << $rank;
}
else
{
$true |= 1 << $rank;
}
}
# Register this term.
push @{$subcubes[1 + $#conds]}, [$true, $false];
}
# Real work. Let's combine terms.
# Process terms in diminishing size order. Those
# involving the maximum number of variables first.
for (my $m = $#subcubes; $m > 0; --$m)
{
my $m_subcubes = $#{$subcubes[$m]};
# Consider all terms with $m variables.
for (my $j = 0; $j <= $m_subcubes; ++$j)
{
my $tj = $subcubes[$m][$j];
my $jtrue = $tj->[0];
my $jfalse = $tj->[1];
# Compare them with all other terms with $m variables.
COMBINATION:
for (my $k = $j + 1; $k <= $m_subcubes; ++$k)
{
my $tk = $subcubes[$m][$k];
my $ktrue = $tk->[0];
my $kfalse = $tk->[1];
# Two terms can combine if they differ only by one variable
# (i.e., a bit here), which is complemented in one term
# and uncomplemented in the other.
my $true = $jtrue ^ $ktrue;
my $false = $jfalse ^ $kfalse;
next COMBINATION if $true != $false;
# There should be exactly one bit set.
# (`$true & ($true - 1)' unsets the rightmost 1 bit in $true.)
next COMBINATION if $true == 0 || $true & ($true - 1);
# At this point we know we can combine the two terms.
# Mark these two terms as "combined", so they will be
# deleted after we have processed all other combinations.
$tj->[2] = 1;
$tk->[2] = 1;
# Actually combine the two terms.
my $ctrue = $jtrue & $ktrue;
my $cfalse = $jfalse & $kfalse;
# Don't add the combined term if it already exists.
DUP_SEARCH:
for my $c (@{$subcubes[$m - 1]})
{
next DUP_SEARCH if $ctrue != $c->[0];
next COMBINATION if $cfalse == $c->[1];
}
push @{$subcubes[$m - 1]}, [$ctrue, $cfalse];
}
}
# Delete all covered terms.
for (my $j = 0; $j <= $m_subcubes; ++$j)
{
delete $subcubes[$m][$j] if $subcubes[$m][$j][2];
}
}
# Finally merge bit strings back into a Automake::DisjConditions.
# If level 0 has been filled, we've found `TRUE'. No need to translate
# anything.
return new Automake::DisjConditions TRUE if $#{$subcubes[0]} >= 0;
# Otherwise, translate uncombined terms in other levels.
my @or_conds = ();
# Process terms in diminishing size order. Those
# involving the maximum number of variables first.
for (my $m = 1; $m <= $#subcubes; ++$m)
{
my $m_subcubes = $#{$subcubes[$m]};
# Consider all terms with $m variables.
for (my $j = 0; $j <= $m_subcubes; ++$j)
{
my $tj = $subcubes[$m][$j];
next unless $tj; # Skip deleted terms.
my $jtrue = $tj->[0];
my $jfalse = $tj->[1];
# Filter-out implied terms.
#
# An and-term at level N might cover and-terms at level M>N.
# We need to mark all these covered terms so that they are
# not output in the result formula.
#
# If $tj was generated by combining two terms at level N+1,
# there two terms are already marked. However there might be
# implied terms deeper.
#
# For instance consider this input: "A_TRUE | A_TRUE C_FALSE".
#
# This can also occur with and-term generated by the
# combining algorith. E.g., consider
# "A_TRUE B_TRUE" | "A_TRUE B_FALSE" | "A_TRUE C_FALSE D_FALSE"
# - at level 3 we can't combine "A_TRUE C_FALSE D_FALSE"
# - at level 2 we can combine "A_TRUE B_TRUE" | "A_TRUE B_FALSE"
# into "A_TRUE
# - at level 1 we an't combine "A_TRUE"
# so without more simplification we would output
# "A_TRUE | A_TRUE C_FALSE D_FALSE"
#
# So let's filter-out and-terms which are implied by other
# and-terms. An and-term $tk is implied by an and-term $tj if $k
# involves more variables than $tj (i.e., N>M) and if
# all variables occurring in $tk also occur in A in the
# same state (complemented or uncomplemented.)
for (my $n = $m + 1; $n <= $#subcubes; ++$n)
{
my $n_subcubes = $#{$subcubes[$n]};
for (my $k = 0; $k <= $n_subcubes; ++$k)
{
my $tk = $subcubes[$n][$k];
next unless $tk; # Skip deleted terms.
my $ktrue = $tk->[0];
my $kfalse = $tk->[1];
next unless $ktrue == ($ktrue | $jtrue);
next unless $kfalse == ($kfalse | $jfalse);
delete $subcubes[$n][$k];
}
}
# Translate $tj.
my @and_conds = ();
my $rank = 0;
while ($jtrue > 0)
{
if ($jtrue & 1)
{
push @and_conds, $rank_var[$rank] . 'TRUE';
}
$jtrue >>= 1;
++$rank;
}
$rank = 0;
while ($jfalse > 0)
{
if ($jfalse & 1)
{
push @and_conds, $rank_var[$rank] . 'FALSE';
}
$jfalse >>= 1;
++$rank;
}
push @or_conds, new Automake::Condition @and_conds if @and_conds;
}
}
return new Automake::DisjConditions @or_conds;
}
sub simplify ($)
{
my ($self) = @_;
return $self->{'simplify'} if defined $self->{'simplify'};
my $res = $self->_simplify ;
$self->{'simplify'} = $res;
return $res;
}
=item C<$self-E<gt>sub_conditions ($cond)>
Return the subconditions of C<$self> that contains C<$cond>, with
C<$cond> stripped.
For instance, consider:
my $a = new Automake::DisjConditions
(new Automake::Condition ("A_TRUE", "B_TRUE"),
new Automake::Condition ("A_TRUE", "C_FALSE"),
new Automake::Condition ("A_TRUE", "B_FALSE", "C_TRUE"),
new Automake::Condition ("A_FALSE"));
my $b = new Automake::DisjConditions
(new Automake::Condition ("A_TRUE", "B_FALSE"));
Calling C<$a-E<gt>sub_conditions ($b)> will return the following
C<DisjConditions>.
new Automake::DisjConditions
(new Automake::Condition ("C_FALSE"), # From A_TRUE C_FALSE
new Automake::Condition ("C_TRUE")); # From A_TRUE B_FALSE C_TRUE"
=cut
sub sub_conditions ($$)
{
my ($self, $subcond) = @_;
# Make $subcond blindingly apparent in the DisjConditions.
# For instance `$a->_multiply($b)' (from the POD example) is:
# new Automake::DisjConditions
# (new Automake::Condition ("FALSE"),
# new Automake::Condition ("A_TRUE", "B_FALSE", "C_FALSE"),
# new Automake::Condition ("A_TRUE", "B_FALSE", "C_TRUE"),
# new Automake::Condition ("FALSE"));
my $prod = $self->_multiply ($subcond);
# Now, strip $subcond from the remaining (i.e., non-false) Conditions.
my @res;
foreach my $c ($prod->conds)
{
push @res, $c->strip ($subcond) unless $c->false;
}
return new Automake::DisjConditions @res;
}
=head1 SEE ALSO
L<Automake::Condition>.
=head1 HISTORY
C<AM_CONDITIONAL>s and supporting code were added to Automake 1.1o by
Ian Lance Taylor <ian@cygnus.org> in 1997. Since then it has been
improved by Tom Tromey <tromey@redhat.com>, Richard Boulton
<richard@tartarus.org>, Raja R Harinath <harinath@cs.umn.edu>, Akim
Demaille <akim@epita.fr>, Pavel Roskin <proski@gnu.org>, and
Alexandre Duret-Lutz <adl@gnu.org>.
=cut
1;
### Setup "GNU" style for perl-mode and cperl-mode.
## Local Variables:
## perl-indent-level: 2
## perl-continued-statement-offset: 2
## perl-continued-brace-offset: 0
## perl-brace-offset: 0
## perl-brace-imaginary-offset: 0
## perl-label-offset: -2
## cperl-indent-level: 2
## cperl-brace-offset: 0
## cperl-continued-brace-offset: 0
## cperl-label-offset: -2
## cperl-extra-newline-before-brace: t
## cperl-merge-trailing-else: nil
## cperl-continued-statement-offset: 2
## End: