//----------------------------------------------------------------------
//
// Copyright (c) Microsoft Corporation. All rights reserved.
//
//
// @owner [....]
// @backupOwner [....]
//---------------------------------------------------------------------
using System.Collections.Generic;
using System.Data.Common.Utils.Boolean;
using System.Text;
using System.Data.Common.Utils;
using System.Diagnostics;
using System.Data.Mapping.ViewGeneration.Utils;
using System.Data.Metadata.Edm;
using System.Linq;
namespace System.Data.Mapping.ViewGeneration.Structures
{
using DomainBoolExpr = BoolExpr>;
using DomainTermExpr = TermExpr>;
using System.Data.Entity;
// An abstract class that denotes the boolean expression: "var in values"
// An object of this type can be partially or fully done -- A partially
// done object is one whose domain was not created with all possible
// values. Partially done classes have a limited set of methods that can
// be called
internal abstract class MemberRestriction : BoolLiteral
{
#region Constructors
// effects: Creates a "partial" oneOfConst with the meaning "slot = value". "Partial" means
// that the CellConstantDomain in this is partial - hence the operations on "this" are limited
protected MemberRestriction(MemberProjectedSlot slot, Constant value)
: this(slot, new Constant[] { value })
{
}
// effects: Creates a "partial" oneOfConst with the meaning "slot in values"
protected MemberRestriction(MemberProjectedSlot slot, IEnumerable values)
{
m_restrictedMemberSlot = slot;
m_domain = new Domain(values, values);
}
// effects: Creates an expression of the form "slot in domain"
protected MemberRestriction(MemberProjectedSlot slot, Domain domain)
{
m_restrictedMemberSlot = slot;
m_domain = domain;
m_isFullyDone = true;
Debug.Assert(m_domain.Count != 0, "If you want a boolean that evaluates to false, " +
"use the ConstantBool abstraction");
}
// effects: Creates an expression of the form "slot = value"
// possibleValues are all the values that slot can take
protected MemberRestriction(MemberProjectedSlot slot, Constant value, IEnumerable possibleValues) :
this(slot, new Domain(value, possibleValues))
{
Debug.Assert(possibleValues != null);
}
// effects: Creates an expression of the form "slot in domain"
private static MemberRestriction Factory(MemberProjectedSlot slot, Domain domain, bool isTypeConstant)
{
if (isTypeConstant)
{
return new TypeRestriction(slot, domain);
}
else
{
return new ScalarRestriction(slot, domain);
}
}
// effects: Creates an expression of the form "node in values"
// possibleValues are all the values that slot can take
protected MemberRestriction(MemberProjectedSlot slot, IEnumerable values,
IEnumerable possibleValues) :
this(slot, new Domain(values, possibleValues))
{
}
#endregion
#region Fields
// State to keep track of "m_slot in m_values"
private MemberProjectedSlot m_restrictedMemberSlot;
private Domain m_domain;
private bool m_isFullyDone;
#endregion
#region Properties
internal bool IsFullyDone
{
get { return m_isFullyDone; }
}
// effects: Returns the variable in this
internal MemberProjectedSlot RestrictedMemberSlot
{
get { return m_restrictedMemberSlot; }
}
// effects: Returns the values that it is being checked for
internal Domain Domain
{
get { return m_domain; }
}
#endregion
#region BoolLiteral Members
// effects: Returns a boolean expression that is domain-aware and
// ready for optimizations etc. domainMap maps members to the values
// that each member can take -- it can be null in which case the
// possible and actual values are the same
internal override DomainBoolExpr GetDomainBoolExpression(MemberDomainMap domainMap)
{
// Get the variable name from the slot's memberpath and the possible domain values from the slot
DomainTermExpr result;
if (domainMap != null)
{
// Look up the domain from the domainMap
IEnumerable domain = domainMap.GetDomain(m_restrictedMemberSlot.MemberPath);
result = MakeTermExpression(this, domain, m_domain.Values);
}
else
{
result = MakeTermExpression(this, m_domain.AllPossibleValues, m_domain.Values);
}
return result;
}
// oneOfConst can be partial
// effects: Creates a OneOfConst based on existing oneofconst with
// possible values for the domain being given by possibleValues
internal static MemberRestriction CreateFullOneOfConst(MemberRestriction restriction, IEnumerable possibleValues)
{
if (restriction is TypeRestriction)
{
return new TypeRestriction(restriction.RestrictedMemberSlot, new Domain(restriction.Domain.Values, possibleValues));
}
else
{
return new ScalarRestriction(restriction.RestrictedMemberSlot, new Domain(restriction.Domain.Values, possibleValues));
}
}
// effects: See BoolLiteral.GetRequiredSlots
internal override void GetRequiredSlots(MemberProjectionIndex projectedSlotMap, bool[] requiredSlots)
{
// Simply get the slot for the variable var in "var in values"
MemberPath member = RestrictedMemberSlot.MemberPath;
int slotNum = projectedSlotMap.IndexOf(member);
requiredSlots[slotNum] = true;
}
// oneOfConst can be partial
// effects: see BoolLiteral.IsEqualTo
protected override bool IsEqualTo(BoolLiteral right)
{
MemberRestriction rightOneOfConst = right as MemberRestriction;
if (rightOneOfConst == null)
{
return false;
}
if (object.ReferenceEquals(this, rightOneOfConst))
{
return true;
}
if (false == MemberProjectedSlot.EqualityComparer.Equals(m_restrictedMemberSlot, rightOneOfConst.m_restrictedMemberSlot))
{
return false;
}
return m_domain.IsEqualTo(rightOneOfConst.m_domain);
}
// effects: see BoolLiteral.RemapBool
internal override BoolLiteral RemapBool(Dictionary remap)
{
MemberProjectedSlot newVar = (MemberProjectedSlot)RestrictedMemberSlot.RemapSlot(remap);
return MemberRestriction.Factory(newVar, Domain, this.GetType() == typeof(TypeRestriction));
}
// oneOfConst can be partial
// effects: see BoolLiteral.GetHash
protected override int GetHash()
{
int result = MemberProjectedSlot.EqualityComparer.GetHashCode(m_restrictedMemberSlot);
result ^= m_domain.GetHash();
return result;
}
// oneOfConst can be partial
// effects: see BoolLiteral.IsIdentifierEqualTo
protected override bool IsIdentifierEqualTo(BoolLiteral right)
{
MemberRestriction rightOneOfConst = right as MemberRestriction;
if (rightOneOfConst == null)
{
return false;
}
if (object.ReferenceEquals(this, rightOneOfConst))
{
return true;
}
return MemberProjectedSlot.EqualityComparer.Equals(m_restrictedMemberSlot, rightOneOfConst.m_restrictedMemberSlot);
}
// oneOfConst can be partial
// effects: see BoolLiteral.GetIdentifierHash
protected override int GetIdentifierHash()
{
int result = MemberProjectedSlot.EqualityComparer.GetHashCode(m_restrictedMemberSlot);
return result;
}
#endregion
#region Other Methods
// effects: Converts this to a user-understandable
// string. invertOutput indicates whether the text needs to say "x in
// .. or x in NOT ... (i.e., the latter if invertOutput is true)
[System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")]
internal void ToUserString(bool invertOutput, StringBuilder builder, MetadataWorkspace workspace)
{
// If there is a negated cell constant, get the inversion of the domain
NegatedConstant negatedConstant = null;
foreach (Constant constant in Domain.Values)
{
negatedConstant = constant as NegatedConstant;
if (negatedConstant != null)
{
break;
}
}
Set constants;
if (negatedConstant != null)
{
// Invert the domain and invert "invertOutput"
invertOutput = !invertOutput;
// Add all the values to negatedConstant's values to get the
// final set of constants
constants = new Set(negatedConstant.Elements, Constant.EqualityComparer);
foreach (Constant constant in Domain.Values)
{
if (!(constant is NegatedConstant))
{
Debug.Assert(constants.Contains(constant), "Domain of negated constant does not have positive constant");
constants.Remove(constant);
}
}
}
else
{
constants = new Set(Domain.Values, Constant.EqualityComparer);
}
// Determine the resource to use
Debug.Assert(constants.Count > 0, "one of const is false?");
bool isNull = constants.Count == 1 && constants.Single().IsNull();
bool isTypeConstant = this is TypeRestriction;
Func