LambdaRewriter.cs 73.2 KB
Newer Older
1
// Copyright (c) Microsoft.  All Rights Reserved.  Licensed under the Apache License, Version 2.0.  See License.txt in the project root for license information.
P
Pilchie 已提交
2 3 4 5

#if DEBUG
//#define CHECK_LOCALS // define CHECK_LOCALS to help debug some rewriting problems that would otherwise cause code-gen failures

6
#endif
P
Pilchie 已提交
7 8 9 10
using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Diagnostics;
11
using Microsoft.CodeAnalysis.CodeGen;
P
Pilchie 已提交
12
using Microsoft.CodeAnalysis.CSharp.Symbols;
13
using Microsoft.CodeAnalysis.CSharp.Syntax;
P
Pilchie 已提交
14 15 16 17 18 19 20 21 22
using Roslyn.Utilities;

namespace Microsoft.CodeAnalysis.CSharp
{
    /// <summary>
    /// The rewriter for removing lambda expressions from method bodies and introducing closure classes
    /// as containers for captured variables along the lines of the example in section 6.5.3 of the
    /// C# language specification.
    /// 
T
TomasMatousek 已提交
23
    /// The entry point is the public method <see cref="Rewrite"/>.  It operates as follows:
P
Pilchie 已提交
24 25 26
    /// 
    /// First, an analysis of the whole method body is performed that determines which variables are
    /// captured, what their scopes are, and what the nesting relationship is between scopes that
27
    /// have captured variables.  The result of this analysis is left in <see cref="_analysis"/>.
P
Pilchie 已提交
28 29
    /// 
    /// Then we make a frame, or compiler-generated class, represented by an instance of
T
TomasMatousek 已提交
30
    /// <see cref="LambdaFrame"/> for each scope with captured variables.  The generated frames are kept
31
    /// in <see cref="_frames"/>.  Each frame is given a single field for each captured
32
    /// variable in the corresponding scope.  These are maintained in <see cref="MethodToClassRewriter.proxies"/>.
P
Pilchie 已提交
33 34
    /// 
    /// Finally, we walk and rewrite the input bound tree, keeping track of the following:
35 36 37
    /// (1) The current set of active frame pointers, in <see cref="_framePointers"/>
    /// (2) The current method being processed (this changes within a lambda's body), in <see cref="_currentMethod"/>
    /// (3) The "this" symbol for the current method in <see cref="_currentFrameThis"/>, and
P
Pilchie 已提交
38 39 40 41 42 43 44 45
    /// (4) The symbol that is used to access the innermost frame pointer (it could be a local variable or "this" parameter)
    /// 
    /// There are a few key transformations done in the rewriting.
    /// (1) Lambda expressions are turned into delegate creation expressions, and the body of the lambda is
    ///     moved into a new, compiler-generated method of a selected frame class.
    /// (2) On entry to a scope with captured variables, we create a frame object and store it in a local variable.
    /// (3) References to captured variables are transformed into references to fields of a frame class.
    /// 
T
TomasMatousek 已提交
46
    /// In addition, the rewriting deposits into <see cref="TypeCompilationState.SynthesizedMethods"/> a (<see cref="MethodSymbol"/>, <see cref="BoundStatement"/>)
P
Pilchie 已提交
47 48
    /// pair for each generated method.
    /// 
T
TomasMatousek 已提交
49
    /// <see cref="Rewrite"/> produces its output in two forms.  First, it returns a new bound statement
P
Pilchie 已提交
50
    /// for the caller to use for the body of the original method.  Second, it returns a collection of
T
TomasMatousek 已提交
51
    /// (<see cref="MethodSymbol"/>, <see cref="BoundStatement"/>) pairs for additional methods that the lambda rewriter produced.
P
Pilchie 已提交
52 53 54 55 56
    /// These additional methods contain the bodies of the lambdas moved into ordinary methods of their
    /// respective frame classes, and the caller is responsible for processing them just as it does with
    /// the returned bound node.  For example, the caller will typically perform iterator method and
    /// asynchronous method transformations, and emit IL instructions into an assembly.
    /// </summary>
57
    internal sealed partial class LambdaRewriter : MethodToClassRewriter
P
Pilchie 已提交
58
    {
59 60
        private readonly Analysis _analysis;
        private readonly MethodSymbol _topLevelMethod;
61
        private readonly MethodSymbol _substitutedSourceMethod;
62
        private readonly int _topLevelMethodOrdinal;
P
Pilchie 已提交
63

64 65
        // lambda frame for static lambdas. 
        // initialized lazily and could be null if there are no static lambdas
66
        private LambdaFrame _lazyStaticLambdaFrame;
67

68
        // A mapping from every lambda parameter to its corresponding method's parameter.
69
        private readonly Dictionary<ParameterSymbol, ParameterSymbol> _parameterMap = new Dictionary<ParameterSymbol, ParameterSymbol>();
70

71
        // A mapping from every local function to its lowered method
E
Evan Hauck 已提交
72 73
        private struct MappedLocalFunction
        {
74
            public readonly SynthesizedLambdaMethod Symbol;
E
Evan Hauck 已提交
75
            public readonly ClosureKind ClosureKind;
76
            public MappedLocalFunction(SynthesizedLambdaMethod symbol, ClosureKind closureKind)
E
Evan Hauck 已提交
77 78 79 80 81 82
            {
                Symbol = symbol;
                ClosureKind = closureKind;
            }
        }
        private readonly Dictionary<LocalFunctionSymbol, MappedLocalFunction> _localFunctionMap = new Dictionary<LocalFunctionSymbol, MappedLocalFunction>();
E
Evan Hauck 已提交
83

P
Pilchie 已提交
84
        // for each block with lifted (captured) variables, the corresponding frame type
85
        private readonly Dictionary<BoundNode, LambdaFrame> _frames = new Dictionary<BoundNode, LambdaFrame>();
P
Pilchie 已提交
86 87 88

        // the current set of frame pointers in scope.  Each is either a local variable (where introduced),
        // or the "this" parameter when at the top level.  Keys in this map are never constructed types.
89
        private readonly Dictionary<NamedTypeSymbol, Symbol> _framePointers = new Dictionary<NamedTypeSymbol, Symbol>();
P
Pilchie 已提交
90

91 92 93
        // True if the rewritten tree should include assignments of the
        // original locals to the lifted proxies. This is only useful for the
        // expression evaluator where the original locals are left as is.
94
        private readonly bool _assignLocals;
95

P
Pilchie 已提交
96
        // The current method or lambda being processed.
97
        private MethodSymbol _currentMethod;
P
Pilchie 已提交
98 99

        // The "this" symbol for the current method.
100
        private ParameterSymbol _currentFrameThis;
P
Pilchie 已提交
101

102
        private readonly ArrayBuilder<LambdaDebugInfo> _lambdaDebugInfoBuilder;
103

104
        // ID dispenser for field names of frame references
105
        private int _synthesizedFieldNameIdDispenser;
106

P
Pilchie 已提交
107
        // The symbol (field or local) holding the innermost frame
108
        private Symbol _innermostFramePointer;
P
Pilchie 已提交
109 110

        // The mapping of type parameters for the current lambda body
111
        private TypeMap _currentLambdaBodyTypeMap;
P
Pilchie 已提交
112 113

        // The current set of type parameters (mapped from the enclosing method's type parameters)
114
        private ImmutableArray<TypeParameterSymbol> _currentTypeParameters;
P
Pilchie 已提交
115 116 117

        // Initialization for the proxy of the upper frame if it needs to be deferred.
        // Such situation happens when lifting this in a ctor.
118
        private BoundExpression _thisProxyInitDeferred;
P
Pilchie 已提交
119 120

        // Set to true once we've seen the base (or self) constructor invocation in a constructor
121
        private bool _seenBaseCall;
P
Pilchie 已提交
122 123

        // Set to true while translating code inside of an expression lambda.
124
        private bool _inExpressionLambda;
P
Pilchie 已提交
125 126 127 128

        // When a lambda captures only 'this' of the enclosing method, we cache it in a local
        // variable.  This is the set of such local variables that must be added to the enclosing
        // method's top-level block.
129
        private ArrayBuilder<LocalSymbol> _addedLocals;
P
Pilchie 已提交
130 131 132

        // Similarly, this is the set of statements that must be added to the enclosing method's
        // top-level block initializing those variables to null.
133
        private ArrayBuilder<BoundStatement> _addedStatements;
P
Pilchie 已提交
134 135 136 137

        private LambdaRewriter(
            Analysis analysis,
            NamedTypeSymbol thisType,
T
TomasMatousek 已提交
138
            ParameterSymbol thisParameterOpt,
P
Pilchie 已提交
139
            MethodSymbol method,
140
            int methodOrdinal,
141
            MethodSymbol substitutedSourceMethod,
142
            ArrayBuilder<LambdaDebugInfo> lambdaDebugInfoBuilder,
143
            VariableSlotAllocator slotAllocatorOpt,
P
Pilchie 已提交
144 145
            TypeCompilationState compilationState,
            DiagnosticBag diagnostics,
146
            bool assignLocals)
147
            : base(slotAllocatorOpt, compilationState, diagnostics)
P
Pilchie 已提交
148
        {
T
TomasMatousek 已提交
149 150 151 152 153 154
            Debug.Assert(analysis != null);
            Debug.Assert(thisType != null);
            Debug.Assert(method != null);
            Debug.Assert(compilationState != null);
            Debug.Assert(diagnostics != null);

155
            _topLevelMethod = method;
156
            _substitutedSourceMethod = substitutedSourceMethod;
157 158 159 160 161 162 163 164 165 166 167
            _topLevelMethodOrdinal = methodOrdinal;
            _lambdaDebugInfoBuilder = lambdaDebugInfoBuilder;
            _currentMethod = method;
            _analysis = analysis;
            _assignLocals = assignLocals;
            _currentTypeParameters = method.TypeParameters;
            _currentLambdaBodyTypeMap = TypeMap.Empty;
            _innermostFramePointer = _currentFrameThis = thisParameterOpt;
            _framePointers[thisType] = thisParameterOpt;
            _seenBaseCall = method.MethodKind != MethodKind.Constructor; // only used for ctors
            _synthesizedFieldNameIdDispenser = 1;
P
Pilchie 已提交
168 169
        }

170 171
        protected override bool NeedsProxy(Symbol localOrParameter)
        {
E
Evan Hauck 已提交
172 173
            Debug.Assert(localOrParameter is LocalSymbol || localOrParameter is ParameterSymbol ||
                (localOrParameter as MethodSymbol)?.MethodKind == MethodKind.LocalFunction);
E
Evan Hauck 已提交
174
            return _analysis.CapturedVariables.ContainsKey(localOrParameter);
175 176
        }

P
Pilchie 已提交
177 178 179 180 181 182
        /// <summary>
        /// Rewrite the given node to eliminate lambda expressions.  Also returned are the method symbols and their
        /// bound bodies for the extracted lambda bodies. These would typically be emitted by the caller such as
        /// MethodBodyCompiler.  See this class' documentation
        /// for a more thorough explanation of the algorithm and its use by clients.
        /// </summary>
183
        /// <param name="loweredBody">The bound node to be rewritten</param>
P
Pilchie 已提交
184 185 186
        /// <param name="thisType">The type of the top-most frame</param>
        /// <param name="thisParameter">The "this" parameter in the top-most frame, or null if static method</param>
        /// <param name="method">The containing method of the node to be rewritten</param>
187
        /// <param name="methodOrdinal">Index of the method symbol in its containing type member list.</param>
188
        /// <param name="substitutedSourceMethod">If this is non-null, then <paramref name="method"/> will be treated as this for uses of parent symbols. For use in EE.</param>
189 190
        /// <param name="lambdaDebugInfoBuilder">Information on lambdas defined in <paramref name="method"/> needed for debugging.</param>
        /// <param name="closureDebugInfoBuilder">Information on closures defined in <paramref name="method"/> needed for debugging.</param>
191
        /// <param name="slotAllocatorOpt">Slot allocator.</param>
P
Pilchie 已提交
192 193
        /// <param name="compilationState">The caller's buffer into which we produce additional methods to be emitted by the caller</param>
        /// <param name="diagnostics">Diagnostic bag for diagnostics</param>
194
        /// <param name="assignLocals">The rewritten tree should include assignments of the original locals to the lifted proxies</param>
P
Pilchie 已提交
195
        public static BoundStatement Rewrite(
196
            BoundStatement loweredBody,
P
Pilchie 已提交
197 198 199
            NamedTypeSymbol thisType,
            ParameterSymbol thisParameter,
            MethodSymbol method,
200
            int methodOrdinal,
201
            MethodSymbol substitutedSourceMethod,
202 203
            ArrayBuilder<LambdaDebugInfo> lambdaDebugInfoBuilder,
            ArrayBuilder<ClosureDebugInfo> closureDebugInfoBuilder,
204
            VariableSlotAllocator slotAllocatorOpt,
P
Pilchie 已提交
205 206
            TypeCompilationState compilationState,
            DiagnosticBag diagnostics,
207
            bool assignLocals)
P
Pilchie 已提交
208 209 210
        {
            Debug.Assert((object)thisType != null);
            Debug.Assert(((object)thisParameter == null) || (thisParameter.Type == thisType));
211 212 213 214 215 216 217 218 219 220 221 222
            Debug.Assert(compilationState.ModuleBuilderOpt != null);

            var analysis = Analysis.Analyze(loweredBody, method);
            if (!analysis.SeenLambda)
            {
                // Unreachable anonymous functions are ignored by the analyzer.
                // No closures or lambda methods are generated.
                // E.g. 
                //   int y = 0;
                //   var b = false && from z in new X(y) select f(z + y)
                return loweredBody;
            }
P
Pilchie 已提交
223

224
            CheckLocalsDefined(loweredBody);
225 226 227 228 229
            var rewriter = new LambdaRewriter(
                analysis,
                thisType,
                thisParameter,
                method,
230
                methodOrdinal,
231
                substitutedSourceMethod,
232
                lambdaDebugInfoBuilder,
233
                slotAllocatorOpt,
234 235
                compilationState,
                diagnostics,
236
                assignLocals);
237

P
Pilchie 已提交
238
            analysis.ComputeLambdaScopesAndFrameCaptures();
239 240
            rewriter.MakeFrames(closureDebugInfoBuilder);
            var body = rewriter.AddStatementsIfNeeded((BoundStatement)rewriter.Visit(loweredBody));
P
Pilchie 已提交
241
            CheckLocalsDefined(body);
242

P
Pilchie 已提交
243 244 245
            return body;
        }

246
        private BoundStatement AddStatementsIfNeeded(BoundStatement body)
P
Pilchie 已提交
247
        {
248
            if (_addedLocals != null)
P
Pilchie 已提交
249
            {
250
                _addedStatements.Add(body);
E
Evan Hauck 已提交
251
                body = new BoundBlock(body.Syntax, _addedLocals.ToImmutableAndFree(), ImmutableArray<LocalFunctionSymbol>.Empty, _addedStatements.ToImmutableAndFree()) { WasCompilerGenerated = true };
252 253
                _addedLocals = null;
                _addedStatements = null;
P
Pilchie 已提交
254 255 256
            }
            else
            {
257
                Debug.Assert(_addedStatements == null);
P
Pilchie 已提交
258 259 260 261 262 263 264
            }

            return body;
        }

        protected override TypeMap TypeMap
        {
265
            get { return _currentLambdaBodyTypeMap; }
P
Pilchie 已提交
266 267 268 269
        }

        protected override MethodSymbol CurrentMethod
        {
270
            get { return _currentMethod; }
P
Pilchie 已提交
271 272 273 274
        }

        protected override NamedTypeSymbol ContainingType
        {
275
            get { return _topLevelMethod.ContainingType; }
P
Pilchie 已提交
276 277 278 279 280 281 282 283 284 285 286
        }

        /// <summary>
        /// Check that the top-level node is well-defined, in the sense that all
        /// locals that are used are defined in some enclosing scope.
        /// </summary>
        static partial void CheckLocalsDefined(BoundNode node);

        /// <summary>
        /// Create the frame types.
        /// </summary>
287
        private void MakeFrames(ArrayBuilder<ClosureDebugInfo> closureDebugInfo)
P
Pilchie 已提交
288 289 290
        {
            NamedTypeSymbol containingType = this.ContainingType;

E
Evan Hauck 已提交
291
            foreach (var kvp in _analysis.CapturedVariables)
P
Pilchie 已提交
292
            {
P
pgavlin 已提交
293 294
                var captured = kvp.Key;

295
                BoundNode scope;
E
Evan Hauck 已提交
296
                if (!_analysis.VariableScope.TryGetValue(captured, out scope))
P
Pilchie 已提交
297 298 299 300
                {
                    continue;
                }

301
                LambdaFrame frame = GetFrameForScope(scope, closureDebugInfo);
P
Pilchie 已提交
302

E
Evan Hauck 已提交
303
                if (captured.Kind != SymbolKind.Method)
P
Pilchie 已提交
304
                {
305
                var hoistedField = LambdaCapturedVariable.Create(frame, captured, ref _synthesizedFieldNameIdDispenser);
306
                proxies.Add(captured, new CapturedToFrameSymbolReplacement(hoistedField, isReusable: false));
307
                CompilationState.ModuleBuilderOpt.AddSynthesizedDefinition(frame, hoistedField);
E
Evan Hauck 已提交
308

309
                if (hoistedField.Type.IsRestrictedType())
P
Pilchie 已提交
310
                {
P
pgavlin 已提交
311
                    foreach (CSharpSyntaxNode syntax in kvp.Value)
P
Pilchie 已提交
312 313
                    {
                        // CS4013: Instance of type '{0}' cannot be used inside an anonymous function, query expression, iterator block or async method
314
                        this.Diagnostics.Add(ErrorCode.ERR_SpecialByRefInLambda, syntax.Location, hoistedField.Type);
P
Pilchie 已提交
315 316 317 318
                    }
                }
            }
        }
319
        }
P
Pilchie 已提交
320

321
        private LambdaFrame GetFrameForScope(BoundNode scope, ArrayBuilder<ClosureDebugInfo> closureDebugInfo)
322 323
        {
            LambdaFrame frame;
324
            if (!_frames.TryGetValue(scope, out frame))
325
            {
326 327 328
                var syntax = scope.Syntax;
                Debug.Assert(syntax != null);

329 330
                DebugId methodId = GetTopLevelMethodId();
                DebugId closureId = GetClosureId(syntax, closureDebugInfo);
331

E
Evan Hauck 已提交
332
                var canBeStruct = !_analysis.ScopesThatCantBeStructs.Contains(scope);
333

E
Evan Hauck 已提交
334
                var containingMethod = _analysis.ScopeOwner[scope];
335 336 337 338
                if (_substitutedSourceMethod != null && containingMethod == _topLevelMethod)
                {
                    containingMethod = _substitutedSourceMethod;
                }
E
Evan Hauck 已提交
339
                frame = new LambdaFrame(_topLevelMethod, containingMethod, canBeStruct, syntax, methodId, closureId);
340
                _frames.Add(scope, frame);
341

342
                CompilationState.ModuleBuilderOpt.AddSynthesizedDefinition(this.ContainingType, frame);
343 344
                if (frame.Constructor != null)
                {
345 346
                CompilationState.AddSynthesizedMethod(
                    frame.Constructor,
347 348
                    FlowAnalysisPass.AppendImplicitReturn(
                        MethodCompiler.BindMethodBody(frame.Constructor, CompilationState, null),
349 350
                    frame.Constructor));
            }
351 352 353 354 355
            }

            return frame;
        }

E
Evan Hauck 已提交
356
        private LambdaFrame GetStaticFrame(DiagnosticBag diagnostics, IBoundLambdaOrFunction lambda)
357
        {
358
            if (_lazyStaticLambdaFrame == null)
359
            {
360
                var isNonGeneric = !_topLevelMethod.IsGenericMethod;
361 362
                if (isNonGeneric)
                {
363
                    _lazyStaticLambdaFrame = CompilationState.staticLambdaFrame;
364 365
                }

366
                if (_lazyStaticLambdaFrame == null)
367
                {
368
                    DebugId methodId;
369 370
                    if (isNonGeneric)
                    {
371
                        methodId = new DebugId(DebugId.UndefinedOrdinal, CompilationState.ModuleBuilderOpt.CurrentGenerationOrdinal);
372 373 374
                    }
                    else
                    {
375
                        methodId = GetTopLevelMethodId();
376
                    }
377

E
Evan Hauck 已提交
378
                    DebugId closureId = default(DebugId);
E
Evan Hauck 已提交
379
                    // using _topLevelMethod as containing member because the static frame does not have generic parameters, except for the top level method's
380
                    var containingMethod = isNonGeneric ? null : (_substitutedSourceMethod ?? _topLevelMethod);
E
Evan Hauck 已提交
381
                    _lazyStaticLambdaFrame = new LambdaFrame(_topLevelMethod, containingMethod, isStruct: false, scopeSyntaxOpt: null, methodId: methodId, closureId: closureId);
382

383
                    // non-generic static lambdas can share the frame
384
                    if (isNonGeneric)
385
                    {
386
                        CompilationState.staticLambdaFrame = _lazyStaticLambdaFrame;
387 388
                    }

389
                    var frame = _lazyStaticLambdaFrame;
390 391 392 393

                    // add frame type
                    CompilationState.ModuleBuilderOpt.AddSynthesizedDefinition(this.ContainingType, frame);

394
                    // add its ctor (note Constructor can be null if TypeKind.Struct is passed in to LambdaFrame.ctor, but Class is passed in above)
395 396
                    CompilationState.AddSynthesizedMethod(
                        frame.Constructor,
397 398
                        FlowAnalysisPass.AppendImplicitReturn(
                            MethodCompiler.BindMethodBody(frame.Constructor, CompilationState, null),
399 400
                        frame.Constructor));

401
                    // associate the frame with the first lambda that caused it to exist. 
C
Charles Stoner 已提交
402
                    // we need to associate this with some syntax.
403 404 405 406 407 408 409 410 411 412 413 414 415 416
                    // unfortunately either containing method or containing class could be synthetic
                    // therefore could have no syntax.
                    CSharpSyntaxNode syntax = lambda.Syntax;

                    // add cctor
                    // Frame.inst = new Frame()
                    var F = new SyntheticBoundNodeFactory(frame.StaticConstructor, syntax, CompilationState, diagnostics);
                    var body = F.Block(
                            F.Assignment(
                                F.Field(null, frame.SingletonCache),
                                F.New(frame.Constructor)),
                            F.Return());

                    CompilationState.AddSynthesizedMethod(frame.StaticConstructor, body);
417 418 419
                }
            }

420
            return _lazyStaticLambdaFrame;
421 422
        }

P
Pilchie 已提交
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
        /// <summary>
        /// Produce a bound expression representing a pointer to a frame of a particular frame type.
        /// </summary>
        /// <param name="syntax">The syntax to attach to the bound nodes produced</param>
        /// <param name="frameType">The type of frame to be returned</param>
        /// <returns>A bound node that computes the pointer to the required frame</returns>
        private BoundExpression FrameOfType(CSharpSyntaxNode syntax, NamedTypeSymbol frameType)
        {
            BoundExpression result = FramePointer(syntax, frameType.OriginalDefinition);
            Debug.Assert(result.Type == frameType);
            return result;
        }

        /// <summary>
        /// Produce a bound expression representing a pointer to a frame of a particular frame class.
        /// Note that for generic frames, the frameClass parameter is the generic definition, but
        /// the resulting expression will be constructed with the current type parameters.
        /// </summary>
        /// <param name="syntax">The syntax to attach to the bound nodes produced</param>
        /// <param name="frameClass">The class type of frame to be returned</param>
        /// <returns>A bound node that computes the pointer to the required frame</returns>
        protected override BoundExpression FramePointer(CSharpSyntaxNode syntax, NamedTypeSymbol frameClass)
        {
            Debug.Assert(frameClass.IsDefinition);

            // If in an instance method of the right type, we can just return the "this" pointer.
449
            if ((object)_currentFrameThis != null && _currentFrameThis.Type == frameClass)
P
Pilchie 已提交
450 451 452 453
            {
                return new BoundThisReference(syntax, frameClass);
            }

454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
            // If the current method has by-ref struct closure parameters, and one of them is correct, use it.
            var lambda = _currentMethod as SynthesizedLambdaMethod;
            if (lambda != null)
            {
                var start = lambda.ParameterCount - lambda.ExtraSynthesizedParameterCount;
                for (var i = start; i < lambda.ParameterCount; i++)
                {
                    var potentialParameter = lambda.Parameters[i];
                    if (potentialParameter.Type.OriginalDefinition == frameClass)
                    {
                        return new BoundParameter(syntax, potentialParameter);
                    }
                }
            }

P
Pilchie 已提交
469
            // Otherwise we need to return the value from a frame pointer local variable...
470
            Symbol framePointer = _framePointers[frameClass];
P
Pilchie 已提交
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
            CapturedSymbolReplacement proxyField;
            if (proxies.TryGetValue(framePointer, out proxyField))
            {
                // However, frame pointer local variables themselves can be "captured".  In that case
                // the inner frames contain pointers to the enclosing frames.  That is, nested
                // frame pointers are organized in a linked list.
                return proxyField.Replacement(syntax, frameType => FramePointer(syntax, frameType));
            }

            var localFrame = framePointer as LocalSymbol;
            return new BoundLocal(syntax, localFrame, null, localFrame.Type);
        }

        private static void InsertAndFreePrologue(ArrayBuilder<BoundStatement> result, ArrayBuilder<BoundExpression> prologue)
        {
            foreach (var expr in prologue)
            {
                result.Add(new BoundExpressionStatement(expr.Syntax, expr));
            }

            prologue.Free();
        }

        /// <summary>
        /// Introduce a frame around the translation of the given node.
        /// </summary>
        /// <param name="node">The node whose translation should be translated to contain a frame</param>
        /// <param name="frame">The frame for the translated node</param>
        /// <param name="F">A function that computes the translation of the node.  It receives lists of added statements and added symbols</param>
        /// <returns>The translated statement, as returned from F</returns>
        private T IntroduceFrame<T>(BoundNode node, LambdaFrame frame, Func<ArrayBuilder<BoundExpression>, ArrayBuilder<LocalSymbol>, T> F)
        {
N
Neal Gafter 已提交
503
            var frameTypeParameters = ImmutableArray.Create(StaticCast<TypeSymbol>.From(_currentTypeParameters).SelectAsArray(TypeMap.TypeSymbolAsTypeWithModifiers), 0, frame.Arity);
E
Evan Hauck 已提交
504
            NamedTypeSymbol frameType = frame.ConstructIfGeneric(frameTypeParameters);
505 506

            Debug.Assert(frame.ScopeSyntaxOpt != null);
507
            LocalSymbol framePointer = new SynthesizedLocal(_topLevelMethod, frameType, SynthesizedLocalKind.LambdaDisplayClass, frame.ScopeSyntaxOpt);
P
Pilchie 已提交
508 509 510 511 512 513 514

            CSharpSyntaxNode syntax = node.Syntax;

            // assign new frame to the frame variable

            var prologue = ArrayBuilder<BoundExpression>.GetInstance();

515 516 517 518 519 520 521 522
            BoundExpression newFrame;
            if (frame.Constructor == null)
            {
                Debug.Assert(frame.TypeKind == TypeKind.Struct);
                newFrame = new BoundDefaultOperator(syntax: syntax, type: frameType);
            }
            else
            {
P
Pilchie 已提交
523 524
            MethodSymbol constructor = frame.Constructor.AsMember(frameType);
            Debug.Assert(frameType == constructor.ContainingType);
525
                newFrame = new BoundObjectCreationExpression(
P
Pilchie 已提交
526 527
                syntax: syntax,
                constructor: constructor);
528
            }
P
Pilchie 已提交
529 530 531 532 533 534 535

            prologue.Add(new BoundAssignmentOperator(syntax,
                new BoundLocal(syntax, framePointer, null, frameType),
                newFrame,
                frameType));

            CapturedSymbolReplacement oldInnermostFrameProxy = null;
536
            if ((object)_innermostFramePointer != null)
P
Pilchie 已提交
537
            {
538
                proxies.TryGetValue(_innermostFramePointer, out oldInnermostFrameProxy);
E
Evan Hauck 已提交
539
                if (_analysis.NeedsParentFrame.Contains(node))
P
Pilchie 已提交
540
                {
541
                    var capturedFrame = LambdaCapturedVariable.Create(frame, _innermostFramePointer, ref _synthesizedFieldNameIdDispenser);
P
Pilchie 已提交
542 543 544 545 546
                    FieldSymbol frameParent = capturedFrame.AsMember(frameType);
                    BoundExpression left = new BoundFieldAccess(syntax, new BoundLocal(syntax, framePointer, null, frameType), frameParent, null);
                    BoundExpression right = FrameOfType(syntax, frameParent.Type as NamedTypeSymbol);
                    BoundExpression assignment = new BoundAssignmentOperator(syntax, left, right, left.Type);

547
                    if (_currentMethod.MethodKind == MethodKind.Constructor && capturedFrame.Type == _currentMethod.ContainingType && !_seenBaseCall)
P
Pilchie 已提交
548 549 550 551 552
                    {
                        // Containing method is a constructor 
                        // Initialization statement for the "this" proxy must be inserted
                        // after the constructor initializer statement block
                        // This insertion will be done by the delegate F
553 554
                        Debug.Assert(_thisProxyInitDeferred == null);
                        _thisProxyInitDeferred = assignment;
P
Pilchie 已提交
555 556 557 558 559 560 561 562
                    }
                    else
                    {
                        prologue.Add(assignment);
                    }

                    if (CompilationState.Emitting)
                    {
E
Evan Hauck 已提交
563
                        Debug.Assert(capturedFrame.Type.IsReferenceType); // Make sure we're not accidentally capturing a struct by value
T
TomasMatousek 已提交
564
                        CompilationState.ModuleBuilderOpt.AddSynthesizedDefinition(frame, capturedFrame);
P
Pilchie 已提交
565 566
                    }

567
                    proxies[_innermostFramePointer] = new CapturedToFrameSymbolReplacement(capturedFrame, isReusable: false);
P
Pilchie 已提交
568 569 570 571
                }
            }

            // Capture any parameters of this block.  This would typically occur
572
            // at the top level of a method or lambda with captured parameters.
P
Pilchie 已提交
573
            // TODO: speed up the following by computing it in analysis.
E
Evan Hauck 已提交
574
            foreach (var variable in _analysis.CapturedVariables.Keys)
P
Pilchie 已提交
575 576
            {
                BoundNode varNode;
E
Evan Hauck 已提交
577
                if (!_analysis.VariableScope.TryGetValue(variable, out varNode) || varNode != node)
P
Pilchie 已提交
578 579 580 581
                {
                    continue;
                }

582
                InitVariableProxy(syntax, variable, framePointer, prologue);
P
Pilchie 已提交
583 584
            }

585 586
            Symbol oldInnermostFramePointer = _innermostFramePointer;
            _innermostFramePointer = framePointer;
P
Pilchie 已提交
587 588
            var addedLocals = ArrayBuilder<LocalSymbol>.GetInstance();
            addedLocals.Add(framePointer);
589
            _framePointers.Add(frame, framePointer);
P
Pilchie 已提交
590 591 592

            var result = F(prologue, addedLocals);

593 594
            _framePointers.Remove(frame);
            _innermostFramePointer = oldInnermostFramePointer;
P
Pilchie 已提交
595

596
            if ((object)_innermostFramePointer != null)
P
Pilchie 已提交
597 598 599
            {
                if (oldInnermostFrameProxy != null)
                {
600
                    proxies[_innermostFramePointer] = oldInnermostFrameProxy;
P
Pilchie 已提交
601 602 603
                }
                else
                {
604
                    proxies.Remove(_innermostFramePointer);
P
Pilchie 已提交
605 606 607 608 609 610
                }
            }

            return result;
        }

611
        private void InitVariableProxy(CSharpSyntaxNode syntax, Symbol symbol, LocalSymbol framePointer, ArrayBuilder<BoundExpression> prologue)
P
Pilchie 已提交
612 613
        {
            CapturedSymbolReplacement proxy;
614
            if (proxies.TryGetValue(symbol, out proxy))
P
Pilchie 已提交
615
            {
616 617
                BoundExpression value;
                switch (symbol.Kind)
618
                {
619 620 621
                    case SymbolKind.Parameter:
                        var parameter = (ParameterSymbol)symbol;
                        ParameterSymbol parameterToUse;
622
                        if (!_parameterMap.TryGetValue(parameter, out parameterToUse))
623 624
                        {
                            parameterToUse = parameter;
625
                        }
626 627

                        value = new BoundParameter(syntax, parameterToUse);
628
                        break;
629

630
                    case SymbolKind.Local:
631
                        if (!_assignLocals)
632 633 634
                        {
                            return;
                        }
635

636 637 638 639 640 641 642 643
                        var local = (LocalSymbol)symbol;
                        LocalSymbol localToUse;
                        if (!localMap.TryGetValue(local, out localToUse))
                        {
                            localToUse = local;
                        }

                        value = new BoundLocal(syntax, localToUse, null, localToUse.Type);
644
                        break;
E
Evan Hauck 已提交
645

646 647 648
                    default:
                        throw ExceptionUtilities.UnexpectedValue(symbol.Kind);
                }
P
Pilchie 已提交
649

E
Evan Hauck 已提交
650 651 652
                var left = proxy.Replacement(syntax, frameType1 => new BoundLocal(syntax, framePointer, null, framePointer.Type));
                var assignToProxy = new BoundAssignmentOperator(syntax, left, value, value.Type);
                prologue.Add(assignToProxy);
P
Pilchie 已提交
653 654 655 656 657
            }
        }

        #region Visit Methods

658 659 660
        protected override BoundNode VisitUnhoistedParameter(BoundParameter node)
        {
            ParameterSymbol replacementParameter;
661
            if (_parameterMap.TryGetValue(node.ParameterSymbol, out replacementParameter))
662 663 664 665 666 667 668
            {
                return new BoundParameter(node.Syntax, replacementParameter, replacementParameter.Type, node.HasErrors);
            }

            return base.VisitUnhoistedParameter(node);
        }

P
Pilchie 已提交
669 670 671 672 673 674 675 676 677 678 679 680
        public override BoundNode VisitThisReference(BoundThisReference node)
        {
            // "topLevelMethod.ThisParameter == null" can occur in a delegate creation expression because the method group
            // in the argument can have a "this" receiver even when "this"
            // is not captured because a static method is selected.  But we do preserve
            // the method group and its receiver in the bound tree.
            // No need to capture "this" in such case.

            // TODO: Why don't we drop "this" while lowering if method is static? 
            //       Actually, considering that method group expression does not evaluate to a particular value 
            //       why do we have it in the lowered tree at all?

681
            return (_currentMethod == _topLevelMethod || _topLevelMethod.ThisParameter == null ?
682 683
                node :
                FramePointer(node.Syntax, (NamedTypeSymbol)node.Type));
P
Pilchie 已提交
684 685 686 687
        }

        public override BoundNode VisitBaseReference(BoundBaseReference node)
        {
688
            return (!_currentMethod.IsStatic && _currentMethod.ContainingType == _topLevelMethod.ContainingType)
P
Pilchie 已提交
689
                ? node
690
                : FramePointer(node.Syntax, _topLevelMethod.ContainingType); // technically, not the correct static type
P
Pilchie 已提交
691
        }
692

E
Evan Hauck 已提交
693 694 695 696 697 698 699 700
        private void RemapLambdaOrLocalFunction(
            CSharpSyntaxNode syntax,
            MethodSymbol originalMethod,
            ImmutableArray<TypeSymbol> typeArgumentsOpt,
            ClosureKind closureKind,
            ref MethodSymbol synthesizedMethod,
            out BoundExpression receiver,
            out NamedTypeSymbol constructedFrame)
E
Evan Hauck 已提交
701
        {
E
Evan Hauck 已提交
702 703
            var translatedLambdaContainer = synthesizedMethod.ContainingType;
            var containerAsFrame = translatedLambdaContainer as LambdaFrame;
704

705
            // All of _currentTypeParameters might not be preserved here due to recursively calling upwards in the chain of local functions/lambdas
E
Evan Hauck 已提交
706
            Debug.Assert((typeArgumentsOpt.IsDefault && !originalMethod.IsGenericMethod) || (typeArgumentsOpt.Length == originalMethod.Arity));
707
            var totalTypeArgumentCount = (containerAsFrame?.Arity ?? 0) + synthesizedMethod.Arity;
E
Evan Hauck 已提交
708 709
            var realTypeArguments = ImmutableArray.Create(StaticCast<TypeSymbol>.From(_currentTypeParameters), 0, totalTypeArgumentCount - originalMethod.Arity);
            if (!typeArgumentsOpt.IsDefault)
710
            {
E
Evan Hauck 已提交
711
                realTypeArguments = realTypeArguments.Concat(typeArgumentsOpt);
712 713
            }

E
Evan Hauck 已提交
714 715 716 717 718 719 720 721 722 723
            if (containerAsFrame != null && containerAsFrame.Arity != 0)
            {
                var containerTypeArguments = ImmutableArray.Create(realTypeArguments, 0, containerAsFrame.Arity);
                realTypeArguments = ImmutableArray.Create(realTypeArguments, containerAsFrame.Arity, realTypeArguments.Length - containerAsFrame.Arity);
                constructedFrame = containerAsFrame.Construct(containerTypeArguments);
            }
            else
            {
                constructedFrame = translatedLambdaContainer;
            }
E
Evan Hauck 已提交
724 725 726

            // for instance lambdas, receiver is the frame
            // for static lambdas, get the singleton receiver
727
            if (closureKind == ClosureKind.Singleton)
E
Evan Hauck 已提交
728 729 730 731
            {
                var field = containerAsFrame.SingletonCache.AsMember(constructedFrame);
                receiver = new BoundFieldAccess(syntax, null, field, constantValueOpt: null);
            }
732 733 734 735 736 737 738 739
            else if (closureKind == ClosureKind.Static)
            {
                receiver = null;
            }
            else // ThisOnly and General
            {
                receiver = FrameOfType(syntax, constructedFrame);
            }
740

E
Evan Hauck 已提交
741 742 743 744 745 746
            synthesizedMethod = synthesizedMethod.AsMember(constructedFrame);
            if (synthesizedMethod.IsGenericMethod)
            {
                synthesizedMethod = synthesizedMethod.Construct(StaticCast<TypeSymbol>.From(realTypeArguments));
            }
            else
E
Evan Hauck 已提交
747
            {
E
Evan Hauck 已提交
748
                Debug.Assert(realTypeArguments.Length == 0);
E
Evan Hauck 已提交
749
            }
750
        }
P
Pilchie 已提交
751

E
Evan Hauck 已提交
752 753 754
        private void RemapLocalFunction(
            CSharpSyntaxNode syntax, MethodSymbol symbol,
            out BoundExpression receiver, out MethodSymbol method,
755
            ref ImmutableArray<BoundExpression> parameters,
E
Evan Hauck 已提交
756 757 758 759 760 761 762
            ImmutableArray<TypeSymbol> typeArguments = default(ImmutableArray<TypeSymbol>))
        {
            Debug.Assert(symbol.MethodKind == MethodKind.LocalFunction);

            var constructed = symbol as ConstructedMethodSymbol;
            if (constructed != null)
            {
N
Neal Gafter 已提交
763
                RemapLocalFunction(syntax, constructed.ConstructedFrom, out receiver, out method, ref parameters, this.TypeMap.SubstituteTypes(constructed.TypeArguments).SelectAsArray(t => t.Type));
E
Evan Hauck 已提交
764 765 766 767 768
                return;
            }

            var mappedLocalFunction = _localFunctionMap[(LocalFunctionSymbol)symbol];

769 770 771 772 773 774 775 776 777 778
            var lambda = mappedLocalFunction.Symbol;
            var frameCount = lambda.ExtraSynthesizedParameterCount;
            if (frameCount != 0)
            {
                Debug.Assert(!parameters.IsDefault);
                var builder = ArrayBuilder<BoundExpression>.GetInstance();
                builder.AddRange(parameters);
                var start = lambda.ParameterCount - frameCount;
                for (int i = start; i < lambda.ParameterCount; i++)
                {
E
Evan Hauck 已提交
779 780 781 782 783 784 785 786 787
                    // will always be a LambdaFrame, it's always a closure class
                    var frameType = (NamedTypeSymbol)lambda.Parameters[i].Type.OriginalDefinition;
                    if (frameType.IsGenericType)
                    {
                        var typeParameters = ((LambdaFrame)frameType).ConstructedFromTypeParameters;
                        var subst = this.TypeMap.SubstituteTypeParameters(typeParameters);
                        frameType = frameType.Construct(subst);
                    }
                    var frame = FrameOfType(syntax, frameType);
788 789 790 791 792 793
                    builder.Add(frame);
                }
                parameters = builder.ToImmutableAndFree();
            }

            method = lambda;
E
Evan Hauck 已提交
794 795 796 797
            NamedTypeSymbol constructedFrame;
            RemapLambdaOrLocalFunction(syntax, symbol, typeArguments, mappedLocalFunction.ClosureKind, ref method, out receiver, out constructedFrame);
        }

P
Pilchie 已提交
798 799
        public override BoundNode VisitCall(BoundCall node)
        {
E
Evan Hauck 已提交
800 801 802 803
            if (node.Method.MethodKind == MethodKind.LocalFunction)
            {
                BoundExpression receiver;
                MethodSymbol method;
804 805 806
                var arguments = node.Arguments;
                RemapLocalFunction(node.Syntax, node.Method, out receiver, out method, ref arguments);
                node = node.Update(receiver, method, arguments);
E
Evan Hauck 已提交
807 808
            }
            var visited = base.VisitCall(node);
P
Pilchie 已提交
809 810 811 812 813 814 815 816
            if (visited.Kind != BoundKind.Call)
            {
                return visited;
            }

            var rewritten = (BoundCall)visited;

            // Check if we need to init the 'this' proxy in a ctor call
817
            if (!_seenBaseCall)
P
Pilchie 已提交
818
            {
819 820
                _seenBaseCall = _currentMethod == _topLevelMethod && node.IsConstructorInitializer();
                if (_seenBaseCall && _thisProxyInitDeferred != null)
P
Pilchie 已提交
821 822 823 824 825 826 827
                {
                    // Insert the this proxy assignment after the ctor call.
                    // Create bound sequence: { ctor call, thisProxyInitDeferred }
                    return new BoundSequence(
                        syntax: node.Syntax,
                        locals: ImmutableArray<LocalSymbol>.Empty,
                        sideEffects: ImmutableArray.Create<BoundExpression>(rewritten),
828
                        value: _thisProxyInitDeferred,
P
Pilchie 已提交
829 830 831 832 833 834 835 836 837
                        type: rewritten.Type);
                }
            }

            return rewritten;
        }

        private BoundSequence RewriteSequence(BoundSequence node, ArrayBuilder<BoundExpression> prologue, ArrayBuilder<LocalSymbol> newLocals)
        {
838
            RewriteLocals(node.Locals, newLocals);
P
Pilchie 已提交
839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855

            foreach (var expr in node.SideEffects)
            {
                var replacement = (BoundExpression)this.Visit(expr);
                if (replacement != null) prologue.Add(replacement);
            }

            var newValue = (BoundExpression)this.Visit(node.Value);
            var newType = this.VisitType(node.Type);

            return node.Update(newLocals.ToImmutableAndFree(), prologue.ToImmutableAndFree(), newValue, newType);
        }

        public override BoundNode VisitBlock(BoundBlock node)
        {
            LambdaFrame frame;
            // Test if this frame has captured variables and requires the introduction of a closure class.
856
            if (_frames.TryGetValue(node, out frame))
P
Pilchie 已提交
857 858 859 860 861 862 863 864 865 866
            {
                return IntroduceFrame(node, frame, (ArrayBuilder<BoundExpression> prologue, ArrayBuilder<LocalSymbol> newLocals) =>
                    RewriteBlock(node, prologue, newLocals));
            }
            else
            {
                return RewriteBlock(node, ArrayBuilder<BoundExpression>.GetInstance(), ArrayBuilder<LocalSymbol>.GetInstance());
            }
        }

867
        private BoundBlock RewriteBlock(BoundBlock node, ArrayBuilder<BoundExpression> prologue, ArrayBuilder<LocalSymbol> newLocals)
P
Pilchie 已提交
868
        {
869
            RewriteLocals(node.Locals, newLocals);
P
Pilchie 已提交
870 871 872

            var newStatements = ArrayBuilder<BoundStatement>.GetInstance();

873 874 875 876 877 878 879
            if (prologue.Count > 0)
            {
                newStatements.Add(new BoundSequencePoint(null, null) { WasCompilerGenerated = true });
            }

            InsertAndFreePrologue(newStatements, prologue);

P
Pilchie 已提交
880 881 882 883 884 885 886 887 888 889
            foreach (var statement in node.Statements)
            {
                var replacement = (BoundStatement)this.Visit(statement);
                if (replacement != null)
                {
                    newStatements.Add(replacement);
                }
            }

            // TODO: we may not need to update if there was nothing to rewrite.
E
Evan Hauck 已提交
890
            return node.Update(newLocals.ToImmutableAndFree(), node.LocalFunctions, newStatements.ToImmutableAndFree());
P
Pilchie 已提交
891 892 893 894 895 896
        }

        public override BoundNode VisitCatchBlock(BoundCatchBlock node)
        {
            // Test if this frame has captured variables and requires the introduction of a closure class.
            LambdaFrame frame;
897
            if (_frames.TryGetValue(node, out frame))
P
Pilchie 已提交
898 899 900 901 902 903 904 905 906 907 908 909 910 911
            {
                return IntroduceFrame(node, frame, (ArrayBuilder<BoundExpression> prologue, ArrayBuilder<LocalSymbol> newLocals) =>
                {
                    return RewriteCatch(node, prologue, newLocals);
                });
            }
            else
            {
                return RewriteCatch(node, ArrayBuilder<BoundExpression>.GetInstance(), ArrayBuilder<LocalSymbol>.GetInstance());
            }
        }

        private BoundNode RewriteCatch(BoundCatchBlock node, ArrayBuilder<BoundExpression> prologue, ArrayBuilder<LocalSymbol> newLocals)
        {
912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933
            LocalSymbol newLocal;
            if ((object)node.LocalOpt != null && TryRewriteLocal(node.LocalOpt, out newLocal))
            {
                newLocals.Add(newLocal);
            }

            LocalSymbol rewrittenCatchLocal;

            if (newLocals.Count > 0)
            {
                // If the original LocalOpt was lifted into a closure,
                // the newLocals will contain a frame reference. In this case, 
                // instead of an actual local, catch will own the frame reference.

                Debug.Assert((object)node.LocalOpt != null && newLocals.Count == 1);
                rewrittenCatchLocal = newLocals[0];
            }
            else
            {
                Debug.Assert((object)node.LocalOpt == null);
                rewrittenCatchLocal = null;
            }
P
Pilchie 已提交
934 935 936

            // If exception variable got lifted, IntroduceFrame will give us frame init prologue.
            // It needs to run before the exception variable is accessed.
937
            // To ensure that, we will make exception variable a sequence that performs prologue as its side-effects.
P
Pilchie 已提交
938
            BoundExpression rewrittenExceptionSource = null;
939
            var rewrittenFilter = (BoundExpression)this.Visit(node.ExceptionFilterOpt);
P
Pilchie 已提交
940 941 942 943 944 945 946 947 948 949 950 951 952
            if (node.ExceptionSourceOpt != null)
            {
                rewrittenExceptionSource = (BoundExpression)Visit(node.ExceptionSourceOpt);
                if (prologue.Count > 0)
                {
                    rewrittenExceptionSource = new BoundSequence(
                        rewrittenExceptionSource.Syntax,
                        ImmutableArray.Create<LocalSymbol>(),
                        prologue.ToImmutable(),
                        rewrittenExceptionSource,
                        rewrittenExceptionSource.Type);
                }
            }
953 954 955 956 957 958 959 960 961 962
            else if (prologue.Count > 0)
            {
                Debug.Assert(rewrittenFilter != null);
                rewrittenFilter = new BoundSequence(
                    rewrittenFilter.Syntax,
                    ImmutableArray.Create<LocalSymbol>(),
                    prologue.ToImmutable(),
                    rewrittenFilter,
                    rewrittenFilter.Type);
            }
P
Pilchie 已提交
963

964
            // done with this.
965
            newLocals.Free();
P
Pilchie 已提交
966 967 968 969 970 971 972 973
            prologue.Free();

            // rewrite filter and body
            // NOTE: this will proxy all accesses to exception local if that got lifted.
            var exceptionTypeOpt = this.VisitType(node.ExceptionTypeOpt);
            var rewrittenBlock = (BoundBlock)this.Visit(node.Body);

            return node.Update(
974
                rewrittenCatchLocal,
P
Pilchie 已提交
975 976 977
                rewrittenExceptionSource,
                exceptionTypeOpt,
                rewrittenFilter,
978 979
                rewrittenBlock,
                node.IsSynthesizedAsyncCatchAll);
P
Pilchie 已提交
980 981 982 983 984 985
        }

        public override BoundNode VisitSequence(BoundSequence node)
        {
            LambdaFrame frame;
            // Test if this frame has captured variables and requires the introduction of a closure class.
986
            if (_frames.TryGetValue(node, out frame))
P
Pilchie 已提交
987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003
            {
                return IntroduceFrame(node, frame, (ArrayBuilder<BoundExpression> prologue, ArrayBuilder<LocalSymbol> newLocals) =>
                {
                    return RewriteSequence(node, prologue, newLocals);
                });
            }
            else
            {
                return RewriteSequence(node, ArrayBuilder<BoundExpression>.GetInstance(), ArrayBuilder<LocalSymbol>.GetInstance());
            }
        }

        public override BoundNode VisitStatementList(BoundStatementList node)
        {
            LambdaFrame frame;
            // Test if this frame has captured variables and requires the introduction of a closure class.
            // That can occur for a BoundStatementList if it is the body of a method with captured parameters.
1004
            if (_frames.TryGetValue(node, out frame))
P
Pilchie 已提交
1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015
            {
                return IntroduceFrame(node, frame, (ArrayBuilder<BoundExpression> prologue, ArrayBuilder<LocalSymbol> newLocals) =>
                {
                    var newStatements = ArrayBuilder<BoundStatement>.GetInstance();
                    InsertAndFreePrologue(newStatements, prologue);

                    foreach (var s in node.Statements)
                    {
                        newStatements.Add((BoundStatement)this.Visit(s));
                    }

E
Evan Hauck 已提交
1016
                    return new BoundBlock(node.Syntax, newLocals.ToImmutableAndFree(), ImmutableArray<LocalFunctionSymbol>.Empty, newStatements.ToImmutableAndFree(), node.HasErrors);
P
Pilchie 已提交
1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
                });
            }
            else
            {
                return base.VisitStatementList(node);
            }
        }

        public override BoundNode VisitSwitchStatement(BoundSwitchStatement node)
        {
            LambdaFrame frame;
            // Test if this frame has captured variables and requires the introduction of a closure class.
1029
            if (_frames.TryGetValue(node, out frame))
P
Pilchie 已提交
1030 1031 1032 1033 1034 1035 1036
            {
                return IntroduceFrame(node, frame, (ArrayBuilder<BoundExpression> prologue, ArrayBuilder<LocalSymbol> newLocals) =>
                {
                    var newStatements = ArrayBuilder<BoundStatement>.GetInstance();
                    InsertAndFreePrologue(newStatements, prologue);
                    newStatements.Add((BoundStatement)base.VisitSwitchStatement(node));

E
Evan Hauck 已提交
1037
                    return new BoundBlock(node.Syntax, newLocals.ToImmutableAndFree(), ImmutableArray<LocalFunctionSymbol>.Empty, newStatements.ToImmutableAndFree(), node.HasErrors);
P
Pilchie 已提交
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055
                });
            }
            else
            {
                return base.VisitSwitchStatement(node);
            }
        }

        public override BoundNode VisitDelegateCreationExpression(BoundDelegateCreationExpression node)
        {
            // A delegate creation expression of the form "new Action( ()=>{} )" is treated exactly like
            // (Action)(()=>{})
            if (node.Argument.Kind == BoundKind.Lambda)
            {
                return RewriteLambdaConversion((BoundLambda)node.Argument);
            }
            else
            {
E
Evan Hauck 已提交
1056 1057 1058 1059
                if (node.MethodOpt?.MethodKind == MethodKind.LocalFunction)
                {
                    BoundExpression receiver;
                    MethodSymbol method;
1060 1061
                    var arguments = default(ImmutableArray<BoundExpression>);
                    RemapLocalFunction(node.Syntax, node.MethodOpt, out receiver, out method, ref arguments);
E
Evan Hauck 已提交
1062 1063 1064
                    var result = new BoundDelegateCreationExpression(node.Syntax, receiver, method, isExtensionMethod: false, type: node.Type);
                    return result;
                }
P
Pilchie 已提交
1065 1066 1067 1068 1069 1070 1071 1072 1073
                return base.VisitDelegateCreationExpression(node);
            }
        }

        public override BoundNode VisitConversion(BoundConversion conversion)
        {
            if (conversion.ConversionKind == ConversionKind.AnonymousFunction)
            {
                var result = (BoundExpression)RewriteLambdaConversion((BoundLambda)conversion.Operand);
1074
                return _inExpressionLambda && conversion.ExplicitCastInCode
1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087
                    ? new BoundConversion(
                        syntax: conversion.Syntax,
                        operand: result,
                        conversionKind: conversion.ConversionKind,
                        resultKind: conversion.ResultKind,
                        isBaseConversion: false,
                        symbolOpt: null,
                        @checked: false,
                        explicitCastInCode: true,
                        isExtensionMethod: false,
                        isArrayIndex: false,
                        constantValueOpt: conversion.ConstantValueOpt,
                        type: conversion.Type)
P
Pilchie 已提交
1088 1089 1090 1091
                    : result;
            }
            else
            {
E
Evan Hauck 已提交
1092
                if (conversion.ConversionKind == ConversionKind.MethodGroup && conversion.SymbolOpt?.MethodKind == MethodKind.LocalFunction)
E
Evan Hauck 已提交
1093 1094 1095
                {
                    BoundExpression receiver;
                    MethodSymbol method;
1096 1097
                    var arguments = default(ImmutableArray<BoundExpression>);
                    RemapLocalFunction(conversion.Syntax, conversion.SymbolOpt, out receiver, out method, ref arguments);
E
Evan Hauck 已提交
1098 1099 1100
                    var result = new BoundDelegateCreationExpression(conversion.Syntax, receiver, method, isExtensionMethod: false, type: conversion.Type);
                    return result;
                }
P
Pilchie 已提交
1101 1102 1103 1104
                return base.VisitConversion(conversion);
            }
        }

1105 1106
        public override BoundNode VisitLocalFunctionStatement(BoundLocalFunctionStatement node)
        {
E
Evan Hauck 已提交
1107
            ClosureKind closureKind;
1108 1109
            NamedTypeSymbol translatedLambdaContainer;
            LambdaFrame containerAsFrame;
E
Evan Hauck 已提交
1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120
            BoundNode lambdaScope;
            DebugId topLevelMethodId;
            DebugId lambdaId;
            RewriteLambdaOrLocalFunction(
                node,
                out closureKind,
                out translatedLambdaContainer,
                out containerAsFrame,
                out lambdaScope,
                out topLevelMethodId,
                out lambdaId);
1121 1122 1123 1124

            return new BoundNoOpStatement(node.Syntax, NoOpStatementFlavor.Default);
        }

1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
        private DebugId GetTopLevelMethodId()
        {
            return slotAllocatorOpt?.MethodId ?? new DebugId(_topLevelMethodOrdinal, CompilationState.ModuleBuilderOpt.CurrentGenerationOrdinal);
        }

        private DebugId GetClosureId(SyntaxNode syntax, ArrayBuilder<ClosureDebugInfo> closureDebugInfo)
        {
            Debug.Assert(syntax != null);

            DebugId closureId;
            DebugId previousClosureId;
            if (slotAllocatorOpt != null && slotAllocatorOpt.TryGetPreviousClosure(syntax, out previousClosureId))
            {
                closureId = previousClosureId;
            }
            else
            {
                closureId = new DebugId(closureDebugInfo.Count, CompilationState.ModuleBuilderOpt.CurrentGenerationOrdinal);
            }

            int syntaxOffset = _topLevelMethod.CalculateLocalSyntaxOffset(syntax.SpanStart, syntax.SyntaxTree);
T
Tomas Matousek 已提交
1146
            closureDebugInfo.Add(new ClosureDebugInfo(syntaxOffset, closureId));
1147 1148 1149 1150 1151

            return closureId;
        }

        private DebugId GetLambdaId(SyntaxNode syntax, ClosureKind closureKind, int closureOrdinal)
1152 1153 1154 1155 1156
        {
            Debug.Assert(syntax != null);

            SyntaxNode lambdaOrLambdaBodySyntax;
            var anonymousFunction = syntax as AnonymousFunctionExpressionSyntax;
1157
            var localFunction = syntax as LocalFunctionStatementSyntax;
1158 1159
            bool isLambdaBody;

1160 1161 1162
            if (anonymousFunction != null)
            {
                lambdaOrLambdaBodySyntax = anonymousFunction.Body;
1163
                isLambdaBody = true;
1164
            }
1165 1166 1167 1168 1169
            else if (localFunction != null)
            {
                lambdaOrLambdaBodySyntax = (SyntaxNode)localFunction.Body ?? localFunction.ExpressionBody;
                isLambdaBody = true;
            }
1170
            else if (LambdaUtilities.IsQueryPairLambda(syntax))
1171 1172 1173
            {
                // "pair" query lambdas
                lambdaOrLambdaBodySyntax = syntax;
1174
                isLambdaBody = false;
1175
                Debug.Assert(closureKind == ClosureKind.Singleton);
1176 1177 1178 1179 1180
            }
            else
            {
                // query lambdas
                lambdaOrLambdaBodySyntax = syntax;
1181
                isLambdaBody = true;
1182 1183
            }

1184
            Debug.Assert(!isLambdaBody || LambdaUtilities.IsLambdaBody(lambdaOrLambdaBodySyntax));
1185

1186
            // determine lambda ordinal and calculate syntax offset
1187

1188 1189 1190
            DebugId lambdaId;
            DebugId previousLambdaId;
            if (slotAllocatorOpt != null && slotAllocatorOpt.TryGetPreviousLambda(lambdaOrLambdaBodySyntax, isLambdaBody, out previousLambdaId))
1191
            {
1192
                lambdaId = previousLambdaId;
1193 1194 1195
            }
            else
            {
1196
                lambdaId = new DebugId(_lambdaDebugInfoBuilder.Count, CompilationState.ModuleBuilderOpt.CurrentGenerationOrdinal);
1197
            }
1198 1199

            int syntaxOffset = _topLevelMethod.CalculateLocalSyntaxOffset(lambdaOrLambdaBodySyntax.SpanStart, lambdaOrLambdaBodySyntax.SyntaxTree);
T
Tomas Matousek 已提交
1200
            _lambdaDebugInfoBuilder.Add(new LambdaDebugInfo(syntaxOffset, lambdaId, closureOrdinal));
1201
            return lambdaId;
1202 1203
        }

E
Evan Hauck 已提交
1204 1205 1206 1207 1208 1209 1210 1211
        private SynthesizedLambdaMethod RewriteLambdaOrLocalFunction(
            IBoundLambdaOrFunction node,
            out ClosureKind closureKind,
            out NamedTypeSymbol translatedLambdaContainer,
            out LambdaFrame containerAsFrame,
            out BoundNode lambdaScope,
            out DebugId topLevelMethodId,
            out DebugId lambdaId)
P
Pilchie 已提交
1212
        {
1213
            ImmutableArray<TypeSymbol> structClosures;
1214
            int closureOrdinal;
E
Evan Hauck 已提交
1215
            if (_analysis.LambdaScopes.TryGetValue(node.Symbol, out lambdaScope))
P
Pilchie 已提交
1216
            {
1217 1218 1219 1220 1221
                containerAsFrame = _frames[lambdaScope];
                var structClosureParamBuilder = ArrayBuilder<TypeSymbol>.GetInstance();
                while (containerAsFrame != null && containerAsFrame.IsValueType)
                {
                    structClosureParamBuilder.Add(containerAsFrame);
E
Evan Hauck 已提交
1222
                    if (this._analysis.NeedsParentFrame.Contains(lambdaScope))
1223
                    {
E
Evan Hauck 已提交
1224 1225 1226 1227 1228 1229 1230
                        var found = false;
                        while (this._analysis.ScopeParent.TryGetValue(lambdaScope, out lambdaScope))
                        {
                            if (_frames.TryGetValue(lambdaScope, out containerAsFrame))
                            {
                                found = true;
                                break;
P
Pilchie 已提交
1231
            }
E
Evan Hauck 已提交
1232 1233 1234 1235 1236
                        }
                        if (found)
                        {
                            continue;
                        }
1237
                    }
E
Evan Hauck 已提交
1238 1239 1240
                    // can happen when scope no longer needs parent frame, or we're at the outermost level and the "parent frame" is top level "this".
                    lambdaScope = null;
                    containerAsFrame = null;
1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251
                }
                // Reverse it because we're going from inner to outer, and parameters are in order of outer to inner
                structClosureParamBuilder.ReverseContents();
                structClosures = structClosureParamBuilder.ToImmutableAndFree();
                if (containerAsFrame == null)
                {
                    closureKind = ClosureKind.Static; // not exactly... but we've rewritten the receiver to be a by-ref parameter
                    translatedLambdaContainer = _topLevelMethod.ContainingType;
                    closureOrdinal = LambdaDebugInfo.StaticClosureOrdinal;
                }
                else
P
Pilchie 已提交
1252
            {
1253
                closureKind = ClosureKind.General;
1254
                    translatedLambdaContainer = containerAsFrame;
1255
                closureOrdinal = containerAsFrame.ClosureOrdinal;
P
Pilchie 已提交
1256 1257
            }
            }
E
Evan Hauck 已提交
1258
            else if (_analysis.CapturedVariablesByLambda[node.Symbol].Count == 0)
1259
            {
1260
                if (_analysis.MethodsConvertedToDelegates.Contains(node.Symbol))
1261
            {
1262
                translatedLambdaContainer = containerAsFrame = GetStaticFrame(Diagnostics, node);
1263 1264 1265 1266 1267 1268 1269
                    closureKind = ClosureKind.Singleton;
                    closureOrdinal = LambdaDebugInfo.StaticClosureOrdinal;
                }
                else
                {
                    containerAsFrame = null;
                    translatedLambdaContainer = _topLevelMethod.ContainingType;
1270
                closureKind = ClosureKind.Static;
1271
                closureOrdinal = LambdaDebugInfo.StaticClosureOrdinal;
1272
            }
1273
                structClosures = default(ImmutableArray<TypeSymbol>);
1274
            }
P
Pilchie 已提交
1275 1276
            else
            {
1277
                containerAsFrame = null;
1278
                translatedLambdaContainer = _topLevelMethod.ContainingType;
1279
                closureKind = ClosureKind.ThisOnly;
1280
                closureOrdinal = LambdaDebugInfo.ThisOnlyClosureOrdinal;
1281
                structClosures = default(ImmutableArray<TypeSymbol>);
P
Pilchie 已提交
1282 1283 1284
            }

            // Move the body of the lambda to a freshly generated synthetic method on its frame.
E
Evan Hauck 已提交
1285 1286
            topLevelMethodId = GetTopLevelMethodId();
            lambdaId = GetLambdaId(node.Syntax, closureKind, closureOrdinal);
1287

1288
            var synthesizedMethod = new SynthesizedLambdaMethod(translatedLambdaContainer, structClosures, closureKind, _topLevelMethod, topLevelMethodId, node, lambdaId);
1289
            CompilationState.ModuleBuilderOpt.AddSynthesizedDefinition(translatedLambdaContainer, synthesizedMethod);
P
Pilchie 已提交
1290

1291
            foreach (var parameter in node.Symbol.Parameters)
P
Pilchie 已提交
1292
            {
1293
                _parameterMap.Add(parameter, synthesizedMethod.Parameters[parameter.Ordinal]);
P
Pilchie 已提交
1294 1295
            }

E
Evan Hauck 已提交
1296 1297
            if (node is BoundLocalFunctionStatement)
            {
E
Evan Hauck 已提交
1298
                _localFunctionMap[((BoundLocalFunctionStatement)node).Symbol] = new MappedLocalFunction(synthesizedMethod, closureKind);
E
Evan Hauck 已提交
1299 1300
            }

P
Pilchie 已提交
1301
            // rewrite the lambda body as the generated method's body
1302 1303 1304 1305 1306 1307 1308 1309 1310
            var oldMethod = _currentMethod;
            var oldFrameThis = _currentFrameThis;
            var oldTypeParameters = _currentTypeParameters;
            var oldInnermostFramePointer = _innermostFramePointer;
            var oldTypeMap = _currentLambdaBodyTypeMap;
            var oldAddedStatements = _addedStatements;
            var oldAddedLocals = _addedLocals;
            _addedStatements = null;
            _addedLocals = null;
P
Pilchie 已提交
1311 1312 1313

            // switch to the generated method

1314
            _currentMethod = synthesizedMethod;
1315
            if (closureKind == ClosureKind.Static || closureKind == ClosureKind.Singleton)
P
Pilchie 已提交
1316 1317
            {
                // no link from a static lambda to its container
1318
                _innermostFramePointer = _currentFrameThis = null;
P
Pilchie 已提交
1319 1320 1321
            }
            else
            {
1322 1323 1324
                _currentFrameThis = synthesizedMethod.ThisParameter;
                _innermostFramePointer = null;
                _framePointers.TryGetValue(translatedLambdaContainer, out _innermostFramePointer);
P
Pilchie 已提交
1325 1326
            }

E
Evan Hauck 已提交
1327
            _currentTypeParameters = containerAsFrame?.TypeParameters.Concat(synthesizedMethod.TypeParameters) ?? synthesizedMethod.TypeParameters;
E
Evan Hauck 已提交
1328
            _currentLambdaBodyTypeMap = synthesizedMethod.TypeMap;
P
Pilchie 已提交
1329 1330 1331

            var body = AddStatementsIfNeeded((BoundStatement)VisitBlock(node.Body));
            CheckLocalsDefined(body);
T
TomasMatousek 已提交
1332
            CompilationState.AddSynthesizedMethod(synthesizedMethod, body);
P
Pilchie 已提交
1333 1334 1335

            // return to the old method

1336 1337 1338 1339 1340 1341 1342
            _currentMethod = oldMethod;
            _currentFrameThis = oldFrameThis;
            _currentTypeParameters = oldTypeParameters;
            _innermostFramePointer = oldInnermostFramePointer;
            _currentLambdaBodyTypeMap = oldTypeMap;
            _addedLocals = oldAddedLocals;
            _addedStatements = oldAddedStatements;
P
Pilchie 已提交
1343

E
Evan Hauck 已提交
1344
            return synthesizedMethod;
1345
            }
E
Evan Hauck 已提交
1346 1347

        private BoundNode RewriteLambdaConversion(BoundLambda node)
1348
            {
E
Evan Hauck 已提交
1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376
            var wasInExpressionLambda = _inExpressionLambda;
            _inExpressionLambda = _inExpressionLambda || node.Type.IsExpressionTree();

            if (_inExpressionLambda)
            {
                var newType = VisitType(node.Type);
                var newBody = (BoundBlock)Visit(node.Body);
                node = node.Update(node.Symbol, newBody, node.Diagnostics, node.Binder, newType);
                var result0 = wasInExpressionLambda ? node : ExpressionLambdaRewriter.RewriteLambda(node, CompilationState, TypeMap, Diagnostics);
                _inExpressionLambda = wasInExpressionLambda;
                return result0;
            }

            ClosureKind closureKind;
            NamedTypeSymbol translatedLambdaContainer;
            LambdaFrame containerAsFrame;
            BoundNode lambdaScope;
            DebugId topLevelMethodId;
            DebugId lambdaId;
            SynthesizedLambdaMethod synthesizedMethod = RewriteLambdaOrLocalFunction(
                node,
                out closureKind,
                out translatedLambdaContainer,
                out containerAsFrame,
                out lambdaScope,
                out topLevelMethodId,
                out lambdaId);

E
Evan Hauck 已提交
1377
            MethodSymbol referencedMethod = synthesizedMethod;
1378
            BoundExpression receiver;
E
Evan Hauck 已提交
1379 1380
            NamedTypeSymbol constructedFrame;
            RemapLambdaOrLocalFunction(node.Syntax, node.Symbol, default(ImmutableArray<TypeSymbol>), closureKind, ref referencedMethod, out receiver, out constructedFrame);
1381

E
Evan Hauck 已提交
1382
            // Rewrite the lambda expression (and the enclosing anonymous method conversion) as a delegate creation expression
1383

P
Pilchie 已提交
1384
            TypeSymbol type = this.VisitType(node.Type);
1385

1386 1387
            // static lambdas are emitted as instance methods on a singleton receiver
            // delegates invoke dispatch is optimized for instance delegates so 
1388
            // it is preferable to emit lambdas as instance methods even when lambdas 
1389
            // do not capture anything
P
Pilchie 已提交
1390 1391 1392 1393
            BoundExpression result = new BoundDelegateCreationExpression(
                node.Syntax,
                receiver,
                referencedMethod,
1394
                isExtensionMethod: false,
P
Pilchie 已提交
1395 1396 1397 1398 1399
                type: type);

            // if the block containing the lambda is not the innermost block,
            // or the lambda is static, then the lambda object should be cached in its frame.
            // NOTE: we are not caching static lambdas in static ctors - cannot reuse such cache.
1400
            var shouldCacheForStaticMethod = closureKind == ClosureKind.Singleton &&
1401
                _currentMethod.MethodKind != MethodKind.StaticConstructor &&
P
Pilchie 已提交
1402 1403 1404 1405 1406
                !referencedMethod.IsGenericMethod;

            // NOTE: We require "lambdaScope != null". 
            //       We do not want to introduce a field into an actual user's class (not a synthetic frame).
            var shouldCacheInLoop = lambdaScope != null &&
E
Evan Hauck 已提交
1407
                lambdaScope != _analysis.ScopeParent[node.Body] &&
P
Pilchie 已提交
1408 1409 1410 1411
                InLoopOrLambda(node.Syntax, lambdaScope.Syntax);

            if (shouldCacheForStaticMethod || shouldCacheInLoop)
            {
1412
                // replace the expression "new Delegate(frame.M)" with "frame.cache ?? (frame.cache = new Delegate(frame.M));
1413
                var F = new SyntheticBoundNodeFactory(_currentMethod, node.Syntax, CompilationState, Diagnostics);
P
Pilchie 已提交
1414 1415
                try
                {
T
TomasMatousek 已提交
1416
                    BoundExpression cache;
1417
                    if (shouldCacheForStaticMethod || shouldCacheInLoop && (object)containerAsFrame != null)
P
Pilchie 已提交
1418
                    {
1419 1420 1421
                        // Since the cache variable will be in a container with possibly alpha-rewritten generic parameters, we need to
                        // substitute the original type according to the type map for that container. That substituted type may be
                        // different from the local variable `type`, which has the node's type substituted for the current container.
1422
                        var cacheVariableType = containerAsFrame.TypeMap.SubstituteType(node.Type).Type;
1423

1424
                        var cacheVariableName = GeneratedNames.MakeLambdaCacheFieldName(
1425 1426
                            // If we are generating the field into a display class created exclusively for the lambda the lambdaOrdinal itself is unique already, 
                            // no need to include the top-level method ordinal in the field name.
1427 1428
                            (closureKind == ClosureKind.General) ? -1 : topLevelMethodId.Ordinal,
                            topLevelMethodId.Generation,
1429 1430
                            lambdaId.Ordinal,
                            lambdaId.Generation);
1431

1432
                        var cacheField = new SynthesizedLambdaCacheFieldSymbol(translatedLambdaContainer, cacheVariableType, cacheVariableName, _topLevelMethod, isReadOnly: false, isStatic: closureKind == ClosureKind.Singleton);
T
TomasMatousek 已提交
1433
                        CompilationState.ModuleBuilderOpt.AddSynthesizedDefinition(translatedLambdaContainer, cacheField);
T
TomasMatousek 已提交
1434
                        cache = F.Field(receiver, cacheField.AsMember(constructedFrame)); //NOTE: the field was added to the unconstructed frame type.
P
Pilchie 已提交
1435 1436 1437 1438
                    }
                    else
                    {
                        // the lambda captures at most the "this" of the enclosing method.  We cache its delegate in a local variable.
1439
                        var cacheLocal = F.SynthesizedLocal(type, kind: SynthesizedLocalKind.CachedAnonymousMethodDelegate);
1440 1441 1442
                        if (_addedLocals == null) _addedLocals = ArrayBuilder<LocalSymbol>.GetInstance();
                        _addedLocals.Add(cacheLocal);
                        if (_addedStatements == null) _addedStatements = ArrayBuilder<BoundStatement>.GetInstance();
T
TomasMatousek 已提交
1443
                        cache = F.Local(cacheLocal);
1444
                        _addedStatements.Add(F.Assignment(cache, F.Null(type)));
P
Pilchie 已提交
1445 1446
                    }

T
TomasMatousek 已提交
1447
                    result = F.Coalesce(cache, F.AssignmentExpression(cache, result));
P
Pilchie 已提交
1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490
                }
                catch (SyntheticBoundNodeFactory.MissingPredefinedMember ex)
                {
                    Diagnostics.Add(ex.Diagnostic);
                    return new BoundBadExpression(F.Syntax, LookupResultKind.Empty, ImmutableArray<Symbol>.Empty, ImmutableArray.Create<BoundNode>(node), node.Type);
                }
            }

            return result;
        }

        // This helper checks syntactically whether there is a loop or lambda expression
        // between given lambda syntax and the syntax that corresponds to its closure.
        // we use this heuristic as a hint that the lambda delegate may be created 
        // multiple times with same closure.
        // In such cases it makes sense to cache the delegate.
        //
        // Examples:
        //            int x = 123;
        //            for (int i = 1; i< 10; i++)
        //            {
        //                if (i< 2)
        //                {
        //                    arr[i].Execute(arg => arg + x);  // delegate should be cached
        //                }
        //            }

        //            for (int i = 1; i< 10; i++)
        //            {
        //                var val = i;
        //                if (i< 2)
        //                {
        //                    int y = i + i;
        //                    System.Console.WriteLine(y);
        //                    arr[i].Execute(arg => arg + val);  // delegate should NOT be cached (closure created inside the loop)
        //                }
        //            }
        //
        private static bool InLoopOrLambda(SyntaxNode lambdaSyntax, SyntaxNode scopeSyntax)
        {
            var curSyntax = lambdaSyntax.Parent;
            while (curSyntax != null && curSyntax != scopeSyntax)
            {
1491
                switch (curSyntax.Kind())
P
Pilchie 已提交
1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513
                {
                    case SyntaxKind.ForStatement:
                    case SyntaxKind.ForEachStatement:
                    case SyntaxKind.WhileStatement:
                    case SyntaxKind.DoStatement:
                    case SyntaxKind.SimpleLambdaExpression:
                    case SyntaxKind.ParenthesizedLambdaExpression:
                        return true;
                }

                curSyntax = curSyntax.Parent;
            }

            return false;
        }

        public override BoundNode VisitLambda(BoundLambda node)
        {
            // these nodes have been handled in the context of the enclosing anonymous method conversion.
            throw ExceptionUtilities.Unreachable;
        }

E
Evan Hauck 已提交
1514
        #endregion
P
Pilchie 已提交
1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604

#if CHECK_LOCALS
        /// <summary>
        /// Ensure that local variables are always in scope where used in bound trees
        /// </summary>
        /// <param name="node"></param>
        static partial void CheckLocalsDefined(BoundNode node)
        {
            LocalsDefinedScanner.INSTANCE.Visit(node);
        }

        class LocalsDefinedScanner : BoundTreeWalker
        {
            internal static LocalsDefinedScanner INSTANCE = new LocalsDefinedScanner();

            HashSet<Symbol> localsDefined = new HashSet<Symbol>();

            public override BoundNode VisitLocal(BoundLocal node)
            {
                Debug.Assert(node.LocalSymbol.IsConst || localsDefined.Contains(node.LocalSymbol));
                return base.VisitLocal(node);
            }

            public override BoundNode VisitSequence(BoundSequence node)
            {
                try
                {
                    if (!node.Locals.IsNullOrEmpty)
                        foreach (var l in node.Locals)
                            localsDefined.Add(l);
                    return base.VisitSequence(node);
                }
                finally
                {
                    if (!node.Locals.IsNullOrEmpty)
                        foreach (var l in node.Locals)
                            localsDefined.Remove(l);
                }
            }

            public override BoundNode VisitCatchBlock(BoundCatchBlock node)
            {
                try
                {
                    if ((object)node.LocalOpt != null) localsDefined.Add(node.LocalOpt);
                    return base.VisitCatchBlock(node);
                }
                finally
                {
                    if ((object)node.LocalOpt != null) localsDefined.Remove(node.LocalOpt);
                }
            }

            public override BoundNode VisitSwitchStatement(BoundSwitchStatement node)
            {
                try
                {
                    if (!node.LocalsOpt.IsNullOrEmpty)
                        foreach (var l in node.LocalsOpt)
                            localsDefined.Add(l);
                    return base.VisitSwitchStatement(node);
                }
                finally
                {
                    if (!node.LocalsOpt.IsNullOrEmpty)
                        foreach (var l in node.LocalsOpt)
                            localsDefined.Remove(l);
                }
            }

            public override BoundNode VisitBlock(BoundBlock node)
            {
                try
                {
                    if (!node.LocalsOpt.IsNullOrEmpty)
                        foreach (var l in node.LocalsOpt)
                            localsDefined.Add(l);
                    return base.VisitBlock(node);
                }
                finally
                {
                    if (!node.LocalsOpt.IsNullOrEmpty)
                        foreach (var l in node.LocalsOpt)
                            localsDefined.Remove(l);
                }
            }
        }
#endif
    }
}