LinqExpressionNormalizer.cs source code in C# .NET

Source code for the .NET framework in C#

                        

Code:

/ 4.0 / 4.0 / untmp / DEVDIV_TFS / Dev10 / Releases / RTMRel / ndp / fx / src / DataEntity / System / Data / Objects / ELinq / LinqExpressionNormalizer.cs / 1305376 / LinqExpressionNormalizer.cs

                            //---------------------------------------------------------------------- 
// 
//      Copyright (c) Microsoft Corporation.  All rights reserved.
// 
// 
// @owner  [....], [....]
//--------------------------------------------------------------------- 
 
using System.Linq.Expressions;
using System.Diagnostics; 
using System.Collections.Generic;
using System.Reflection;
namespace System.Data.Objects.ELinq
{ 
    /// 
    /// Replaces expression patterns produced by the compiler with approximations 
    /// used in query translation. For instance, the following VB code: 
    ///
    ///     x = y 
    ///
    /// becomes the expression
    ///
    ///     Equal(MethodCallExpression(Microsoft.VisualBasic.CompilerServices.Operators.CompareString(x, y, False), 0) 
    ///
    /// which is normalized to 
    /// 
    ///     Equal(x, y)
    /// 
    /// Comment convention:
    ///
    ///     CODE(Lang): _VB or C# coding pattern being simplified_
    ///     ORIGINAL: _original LINQ expression_ 
    ///     NORMALIZED: _normalized LINQ expression_
    ///  
    internal class LinqExpressionNormalizer : EntityExpressionVisitor 
    {
        ///  
        /// If we encounter a MethodCallExpression, we never need to lift to lift to null. This capability
        /// exists to translate certain patterns in the language. In this case, the user (or compiler)
        /// has explicitly asked for a method invocation (at which point, lifting can no longer occur).
        ///  
        private const bool LiftToNull = false;
 
        ///  
        /// Gets a dictionary mapping from LINQ expressions to matched by those expressions. Used
        /// to identify composite expression patterns. 
        /// 
        private readonly Dictionary _patterns = new Dictionary();

        ///  
        /// Handle binary patterns:
        /// 
        /// - VB 'Is' operator 
        /// - Compare patterns
        ///  
        internal override Expression VisitBinary(BinaryExpression b)
        {
            b = (BinaryExpression)base.VisitBinary(b);
 
            // CODE(VB): x Is y
            // ORIGINAL: Equal(Convert(x, typeof(object)), Convert(y, typeof(object)) 
            // NORMALIZED: Equal(x, y) 
            if (b.NodeType == ExpressionType.Equal)
            { 
                Expression normalizedLeft = UnwrapObjectConvert(b.Left);
                Expression normalizedRight = UnwrapObjectConvert(b.Right);
                if (normalizedLeft != b.Left || normalizedRight != b.Right)
                { 
                    b = CreateRelationalOperator(ExpressionType.Equal, normalizedLeft, normalizedRight);
                } 
            } 

            // CODE(VB): x = y 
            // ORIGINAL: Equal(Microsoft.VisualBasic.CompilerServices.Operators.CompareString(x, y, False), 0)
            // NORMALIZED: Equal(x, y)
            Pattern pattern;
            if (_patterns.TryGetValue(b.Left, out pattern) && pattern.Kind == PatternKind.Compare && IsConstantZero(b.Right)) 
            {
                ComparePattern comparePattern = (ComparePattern)pattern; 
                // handle relational operators 
                BinaryExpression relationalExpression;
                if (TryCreateRelationalOperator(b.NodeType, comparePattern.Left, comparePattern.Right, out relationalExpression)) 
                {
                    b = relationalExpression;
                }
            } 

            return b; 
        } 

        ///  
        /// CODE: x
        /// ORIGINAL: Convert(x, typeof(object))
        /// ORIGINAL(Funcletized): Constant(x, typeof(object))
        /// NORMALIZED: x 
        /// 
        private static Expression UnwrapObjectConvert(Expression input) 
        { 
            // recognize funcletized (already evaluated) Converts
            if (input.NodeType == ExpressionType.Constant && 
               input.Type == typeof(object))
            {
                ConstantExpression constant = (ConstantExpression)input;
 
                // we will handle nulls later, so just bypass those
                if (constant.Value != null && 
                    constant.Value.GetType() != typeof(object)) 
                {
                    return Expression.Constant(constant.Value, constant.Value.GetType()); 
                }
            }

            // unwrap object converts 
            while (ExpressionType.Convert == input.NodeType && typeof(object) == input.Type)
            { 
                input = ((UnaryExpression)input).Operand; 
            }
            return input; 
        }

        /// 
        /// Returns true if the given expression is a constant '0'. 
        /// 
        private bool IsConstantZero(Expression expression) 
        { 
            return expression.NodeType == ExpressionType.Constant &&
                ((ConstantExpression)expression).Value.Equals(0); 
        }

        /// 
        /// Handles MethodCall patterns: 
        ///
        /// - Operator overloads 
        /// - VB operators 
        /// 
        internal override Expression VisitMethodCall(MethodCallExpression m) 
        {
            m = (MethodCallExpression)base.VisitMethodCall(m);

            if (m.Method.IsStatic) 
            {
                // handle operator overloads 
                if (m.Method.Name.StartsWith("op_", StringComparison.Ordinal)) 
                {
                    // handle binary operator overloads 
                    if (m.Arguments.Count == 2)
                    {
                        // CODE(C#): x == y
                        // ORIGINAL: MethodCallExpression(, x, y) 
                        // NORMALIZED: Equal(x, y)
                        switch (m.Method.Name) 
                        { 
                            case "op_Equality":
                                return Expression.Equal(m.Arguments[0], m.Arguments[1], LiftToNull, m.Method); 

                            case "op_Inequality":
                                return Expression.NotEqual(m.Arguments[0], m.Arguments[1], LiftToNull, m.Method);
 
                            case "op_GreaterThan":
                                return Expression.GreaterThan(m.Arguments[0], m.Arguments[1], LiftToNull, m.Method); 
 
                            case "op_GreaterThanOrEqual":
                                return Expression.GreaterThanOrEqual(m.Arguments[0], m.Arguments[1], LiftToNull, m.Method); 

                            case "op_LessThan":
                                return Expression.LessThan(m.Arguments[0], m.Arguments[1], LiftToNull, m.Method);
 
                            case "op_LessThanOrEqual":
                                return Expression.LessThanOrEqual(m.Arguments[0], m.Arguments[1], LiftToNull, m.Method); 
 
                            case "op_Multiply":
                                return Expression.Multiply(m.Arguments[0], m.Arguments[1], m.Method); 

                            case "op_Subtraction":
                                return Expression.Subtract(m.Arguments[0], m.Arguments[1], m.Method);
 
                            case "op_Addition":
                                return Expression.Add(m.Arguments[0], m.Arguments[1], m.Method); 
 
                            case "op_Division":
                                return Expression.Divide(m.Arguments[0], m.Arguments[1], m.Method); 

                            case "op_Modulus":
                                return Expression.Modulo(m.Arguments[0], m.Arguments[1], m.Method);
 
                            case "op_BitwiseAnd":
                                return Expression.And(m.Arguments[0], m.Arguments[1], m.Method); 
 
                            case "op_BitwiseOr":
                                return Expression.Or(m.Arguments[0], m.Arguments[1], m.Method); 

                            case "op_ExclusiveOr":
                                return Expression.ExclusiveOr(m.Arguments[0], m.Arguments[1], m.Method);
 
                            default:
                                break; 
                        } 
                    }
 
                    // handle unary operator overloads
                    if (m.Arguments.Count == 1)
                    {
                        // CODE(C#): +x 
                        // ORIGINAL: MethodCallExpression(, x)
                        // NORMALIZED: UnaryPlus(x) 
                        switch (m.Method.Name) 
                        {
                            case "op_UnaryNegation": 
                                return Expression.Negate(m.Arguments[0], m.Method);

                            case "op_UnaryPlus":
                                return Expression.UnaryPlus(m.Arguments[0], m.Method); 

                            case "op_Explicit": 
                            case "op_Implicit": 
                                return Expression.Convert(m.Arguments[0], m.Type, m.Method);
 
                            case "op_OnesComplement":
                            case "op_False":
                                return Expression.Not(m.Arguments[0], m.Method);
 
                            default:
                                break; 
                        } 
                    }
                } 

                // check for static Equals method
                if (m.Method.Name == "Equals" && m.Arguments.Count > 1)
                { 
                    // CODE(C#): Object.Equals(x, y)
                    // ORIGINAL: MethodCallExpression(, x, y) 
                    // NORMALIZED: Equal(x, y) 
                    return Expression.Equal(m.Arguments[0], m.Arguments[1], false, m.Method);
                } 

                // check for Microsoft.VisualBasic.CompilerServices.Operators.CompareString method
                if (m.Method.Name == "CompareString" && m.Method.DeclaringType.FullName == "Microsoft.VisualBasic.CompilerServices.Operators")
                { 
                    // CODE(VB): x = y; where x and y are strings, a part of the expression looks like:
                    // ORIGINAL: MethodCallExpression(Microsoft.VisualBasic.CompilerServices.Operators.CompareString(x, y, False) 
                    // NORMALIZED: see CreateCompareExpression method 
                    return CreateCompareExpression(m.Arguments[0], m.Arguments[1]);
                } 

                // check for static Compare method
                if (m.Method.Name == "Compare" && m.Arguments.Count > 1 && m.Method.ReturnType == typeof(int))
                { 
                    // CODE(C#): Class.Compare(x, y)
                    // ORIGINAL: MethodCallExpression(, x, y) 
                    // NORMALIZED: see CreateCompareExpression method 
                    return CreateCompareExpression(m.Arguments[0], m.Arguments[1]);
                } 
            }
            else
            {
                // check for instance Equals method 
                if (m.Method.Name == "Equals" && m.Arguments.Count > 0)
                { 
                    // CODE(C#): x.Equals(y) 
                    // ORIGINAL: MethodCallExpression(x, , y)
                    // NORMALIZED: Equal(x, y) 
                    return CreateRelationalOperator(ExpressionType.Equal, m.Object, m.Arguments[0]);
                }

                // check for instance CompareTo method 
                if (m.Method.Name == "CompareTo" && m.Arguments.Count == 1 && m.Method.ReturnType == typeof(int))
                { 
                    // CODE(C#): x.CompareTo(y) 
                    // ORIGINAL: MethodCallExpression(x.CompareTo(y))
                    // NORMALIZED: see CreateCompareExpression method 
                    return CreateCompareExpression(m.Object, m.Arguments[0]);
                }

                // check for List<> instance Contains method 
                if (m.Method.Name == "Contains" && m.Arguments.Count == 1) {
                    Type declaringType = m.Method.DeclaringType; 
                    if (declaringType.IsGenericType && declaringType.GetGenericTypeDefinition() == typeof(List<>)) 
                    {
                        // CODE(C#): List x.Contains(y) 
                        // ORIGINAL: MethodCallExpression(x.Contains(y))
                        // NORMALIZED: IEnumerable.Contains(x, y)

                        MethodInfo containsMethod; 
                        if (ReflectionUtil.TryLookupMethod(SequenceMethod.Contains, out containsMethod))
                        { 
                            MethodInfo enumerableContainsMethod = containsMethod.MakeGenericMethod(declaringType.GetGenericArguments()); 
                            return Expression.Call(enumerableContainsMethod, m.Object, m.Arguments[0]);
                        } 
                    }
                }
            }
 
            // check for coalesce operators added by the VB compiler to predicate arguments
            return NormalizePredicateArgument(m); 
        } 

 

        /// 
        /// Identifies and normalizes any predicate argument in the given call expression. If no changes
        /// are needed, returns the existing expression. Otherwise, returns a new call expression 
        /// with a normalized predicate argument.
        ///  
        private static MethodCallExpression NormalizePredicateArgument(MethodCallExpression callExpression) 
        {
            MethodCallExpression result; 

            int argumentOrdinal;
            Expression normalizedArgument;
            if (HasPredicateArgument(callExpression, out argumentOrdinal) && 
                TryMatchCoalescePattern(callExpression.Arguments[argumentOrdinal], out normalizedArgument))
            { 
                List normalizedArguments = new List(callExpression.Arguments); 

                // replace the predicate argument with the normalized version 
                normalizedArguments[argumentOrdinal] = normalizedArgument;

                result = Expression.Call(callExpression.Object, callExpression.Method, normalizedArguments);
            } 
            else
            { 
                // nothing has changed 
                result = callExpression;
            } 

            return result;
        }
 
        /// 
        /// Determines whether the given call expression has a 'predicate' argument (e.g. Where(source, predicate)) 
        /// and returns the ordinal for the predicate. 
        /// 
        ///  
        /// Obviously this method will need to be replaced if we ever encounter a method with multiple predicates.
        /// 
        private static bool HasPredicateArgument(MethodCallExpression callExpression, out int argumentOrdinal)
        { 
            argumentOrdinal = default(int);
            bool result = false; 
 
            // It turns out all supported methods taking a predicate argument have it as the second
            // argument. As a result, we always set argumentOrdinal to 1 when there is a match and 
            // we can safely ignore all methods taking fewer than 2 arguments
            SequenceMethod sequenceMethod;
            if (2 <= callExpression.Arguments.Count &&
                ReflectionUtil.TryIdentifySequenceMethod(callExpression.Method, out sequenceMethod)) 
            {
                switch (sequenceMethod) 
                { 
                    case SequenceMethod.FirstPredicate:
                    case SequenceMethod.FirstOrDefaultPredicate: 
                    case SequenceMethod.SinglePredicate:
                    case SequenceMethod.SingleOrDefaultPredicate:
                    case SequenceMethod.LastPredicate:
                    case SequenceMethod.LastOrDefaultPredicate: 
                    case SequenceMethod.Where:
                    case SequenceMethod.WhereOrdinal: 
                    case SequenceMethod.CountPredicate: 
                    case SequenceMethod.LongCountPredicate:
                    case SequenceMethod.AnyPredicate: 
                    case SequenceMethod.All:
                    case SequenceMethod.SkipWhile:
                    case SequenceMethod.SkipWhileOrdinal:
                    case SequenceMethod.TakeWhile: 
                    case SequenceMethod.TakeWhileOrdinal:
                        argumentOrdinal = 1; // the second argument is always the one 
                        result = true; 
                        break;
                } 
            }

            return result;
        } 

        ///  
        /// Determines whether the given expression of the form Lambda(Coalesce(left, Constant(false)), ...), a pattern 
        /// introduced by the VB compiler for predicate arguments. Returns the 'normalized' version of the expression
        /// Lambda((bool)left, ...) 
        /// 
        private static bool TryMatchCoalescePattern(Expression expression, out Expression normalized)
        {
            normalized = null; 
            bool result = false;
 
            if (expression.NodeType == ExpressionType.Quote) 
            {
                // try to normalize the quoted expression 
                UnaryExpression quote = (UnaryExpression)expression;
                if (TryMatchCoalescePattern(quote.Operand, out normalized))
                {
                    result = true; 
                    normalized = Expression.Quote(normalized);
                } 
            } 
            else if (expression.NodeType == ExpressionType.Lambda)
            { 
                LambdaExpression lambda = (LambdaExpression)expression;

                // collapse coalesce lambda expressions
                // CODE(VB): where a.NullableInt = 1 
                // ORIGINAL: Lambda(Coalesce(expr, Constant(false)), a)
                // NORMALIZED: Lambda(expr, a) 
                if (lambda.Body.NodeType == ExpressionType.Coalesce && lambda.Body.Type == typeof(bool)) 
                {
                    BinaryExpression coalesce = (BinaryExpression)lambda.Body; 
                    if (coalesce.Right.NodeType == ExpressionType.Constant && false.Equals(((ConstantExpression)coalesce.Right).Value))
                    {
                        normalized = Expression.Lambda(lambda.Type, Expression.Convert(coalesce.Left, typeof(bool)), lambda.Parameters);
                        result = true; 
                    }
                } 
            } 

            return result; 
        }

        private static readonly MethodInfo s_relationalOperatorPlaceholderMethod = typeof(LinqExpressionNormalizer).GetMethod("RelationalOperatorPlaceholder", BindingFlags.Static | BindingFlags.NonPublic);
        ///  
        /// This method exists solely to support creation of valid relational operator LINQ expressions that are not natively supported
        /// by the CLR (e.g. String > String). This method must not be invoked. 
        ///  
        private static bool RelationalOperatorPlaceholder(TLeft left, TRight right)
        { 
            Debug.Fail("This method should never be called. It exists merely to support creation of relational LINQ expressions.");
            return object.ReferenceEquals(left, right);
        }
 
        /// 
        /// Create an operator relating 'left' and 'right' given a relational operator. 
        ///  
        private static BinaryExpression CreateRelationalOperator(ExpressionType op, Expression left, Expression right)
        { 
            BinaryExpression result;
            if (!TryCreateRelationalOperator(op, left, right, out result))
            {
                Debug.Fail("CreateRelationalOperator has unknown op " + op); 
            }
            return result; 
        } 

        ///  
        /// Try to create an operator relating 'left' and 'right' using the given operator. If the given operator
        /// does not define a known relation, returns false.
        /// 
        private static bool TryCreateRelationalOperator(ExpressionType op, Expression left, Expression right, out BinaryExpression result) 
        {
            MethodInfo relationalOperatorPlaceholderMethod = s_relationalOperatorPlaceholderMethod.MakeGenericMethod(left.Type, right.Type); 
 
            switch (op)
            { 
                case ExpressionType.Equal:
                    result = Expression.Equal(left, right, LiftToNull, relationalOperatorPlaceholderMethod);
                    return true;
 
                case ExpressionType.NotEqual:
                    result = Expression.NotEqual(left, right, LiftToNull, relationalOperatorPlaceholderMethod); 
                    return true; 

                case ExpressionType.LessThan: 
                    result = Expression.LessThan(left, right, LiftToNull, relationalOperatorPlaceholderMethod);
                    return true;

                case ExpressionType.LessThanOrEqual: 
                    result = Expression.LessThanOrEqual(left, right, LiftToNull, relationalOperatorPlaceholderMethod);
                    return true; 
 
                case ExpressionType.GreaterThan:
                    result = Expression.GreaterThan(left, right, LiftToNull, relationalOperatorPlaceholderMethod); 
                    return true;

                case ExpressionType.GreaterThanOrEqual:
                    result = Expression.GreaterThanOrEqual(left, right, LiftToNull, relationalOperatorPlaceholderMethod); 
                    return true;
 
                default: 
                    result = null;
                    return false; 
            }
        }

        ///  
        /// CODE(C#): Class.Compare(left, right)
        /// ORIGINAL: MethodCallExpression(Compare, left, right) 
        /// NORMALIZED: Condition(Equal(left, right), 0, Condition(left > right, 1, -1)) 
        ///
        /// Why is this an improvement? We know how to evaluate Condition in the store, but we don't 
        /// know how to evaluate MethodCallExpression... Where the CompareTo appears within a larger expression,
        /// e.g. left.CompareTo(right) > 0, we can further simplify to left > right (we register the "ComparePattern"
        /// to make this possible).
        ///  
        private Expression CreateCompareExpression(Expression left, Expression right)
        { 
            Expression result = Expression.Condition( 
                CreateRelationalOperator(ExpressionType.Equal, left, right),
                Expression.Constant(0), 
                Expression.Condition(
                    CreateRelationalOperator(ExpressionType.GreaterThan, left, right),
                    Expression.Constant(1),
                    Expression.Constant(-1))); 

            // Remember that this node matches the pattern 
            _patterns[result] = new ComparePattern(left, right); 

            return result; 
        }

        /// 
        /// Encapsulates an expression matching some pattern. 
        /// 
        private abstract class Pattern 
        { 
            /// 
            /// Gets pattern kind. 
            /// 
            internal abstract PatternKind Kind { get; }
        }
 
        /// 
        /// Gets pattern kind. 
        ///  
        private enum PatternKind
        { 
            Compare,
        }

        ///  
        /// Matches expression of the form x.CompareTo(y) or Class.CompareTo(x, y)
        ///  
        private sealed class ComparePattern : Pattern 
        {
            internal ComparePattern(Expression left, Expression right) 
            {
                this.Left = left;
                this.Right = right;
            } 

            ///  
            /// Gets left-hand argument to Compare operation. 
            /// 
            internal readonly Expression Left; 

            /// 
            /// Gets right-hand argument to Compare operation.
            ///  
            internal readonly Expression Right;
 
 
            internal override PatternKind Kind
            { 
                get { return PatternKind.Compare; }
            }
        }
    } 
}

// File provided for Reference Use Only by Microsoft Corporation (c) 2007.
                        

Link Menu

Network programming in C#, Network Programming in VB.NET, Network Programming in .NET
This book is available now!
Buy at Amazon US or
Buy at Amazon UK