mcs/class/dlr/Runtime/Microsoft.Scripting.Core/Actions/GetIndexBinder.cs

   1 /* ****************************************************************************
   2  *
   3  * Copyright (c) Microsoft Corporation.
   4  *
   5  * This source code is subject to terms and conditions of the Microsoft Public License. A
   6  * copy of the license can be found in the License.html file at the root of this distribution. If
   7  * you cannot locate the  Microsoft Public License, please send an email to
   8  * dlr@microsoft.com. By using this source code in any fashion, you are agreeing to be bound
   9  * by the terms of the Microsoft Public License.
  10  *
  11  * You must not remove this notice, or any other, from this software.
  12  *
  13  *
  14  * ***************************************************************************/
  15
  16 using System.Dynamic.Utils;
  17
  18 namespace System.Dynamic {
  19
  20     /// <summary>
  21     /// Represents the dynamic get index operation at the call site, providing the binding semantic and the details about the operation.
  22     /// </summary>
  23     public abstract class GetIndexBinder : DynamicMetaObjectBinder {
  24         private readonly CallInfo _callInfo;
  25
  26         /// <summary>
  27         /// Initializes a new instance of the <see cref="GetIndexBinder" />.
  28         /// </summary>
  29         /// <param name="callInfo">The signature of the arguments at the call site.</param>
  30         protected GetIndexBinder(CallInfo callInfo) {
  31             ContractUtils.RequiresNotNull(callInfo, "callInfo");
  32             _callInfo = callInfo;
  33         }
  34
  35         /// <summary>
  36         /// The result type of the operation.
  37         /// </summary>
  38         public override sealed Type ReturnType {
  39             get { return typeof(object); }
  40         }
  41
  42         /// <summary>
  43         /// Gets the signature of the arguments at the call site.
  44         /// </summary>
  45         public CallInfo CallInfo {
  46             get { return _callInfo; }
  47         }
  48
  49         /// <summary>
  50         /// Performs the binding of the dynamic get index operation.
  51         /// </summary>
  52         /// <param name="target">The target of the dynamic get index operation.</param>
  53         /// <param name="args">An array of arguments of the dynamic get index operation.</param>
  54         /// <returns>The <see cref="DynamicMetaObject"/> representing the result of the binding.</returns>
  55         public sealed override DynamicMetaObject Bind(DynamicMetaObject target, DynamicMetaObject[] args) {
  56             ContractUtils.RequiresNotNull(target, "target");
  57             ContractUtils.RequiresNotNullItems(args, "args");
  58
  59             return target.BindGetIndex(this, args);
  60         }
  61
  62         // this is a standard DynamicMetaObjectBinder
  63         internal override sealed bool IsStandardBinder {
  64             get {
  65                 return true;
  66             }
  67         }
  68
  69         /// <summary>
  70         /// Performs the binding of the dynamic get index operation if the target dynamic object cannot bind.
  71         /// </summary>
  72         /// <param name="target">The target of the dynamic get index operation.</param>
  73         /// <param name="indexes">The arguments of the dynamic get index operation.</param>
  74         /// <returns>The <see cref="DynamicMetaObject"/> representing the result of the binding.</returns>
  75         public DynamicMetaObject FallbackGetIndex(DynamicMetaObject target, DynamicMetaObject[] indexes) {
  76             return FallbackGetIndex(target, indexes, null);
  77         }
  78
  79         /// <summary>
  80         /// When overridden in the derived class, performs the binding of the dynamic get index operation if the target dynamic object cannot bind.
  81         /// </summary>
  82         /// <param name="target">The target of the dynamic get index operation.</param>
  83         /// <param name="indexes">The arguments of the dynamic get index operation.</param>
  84         /// <param name="errorSuggestion">The binding result to use if binding fails, or null.</param>
  85         /// <returns>The <see cref="DynamicMetaObject"/> representing the result of the binding.</returns>
  86         public abstract DynamicMetaObject FallbackGetIndex(DynamicMetaObject target, DynamicMetaObject[] indexes, DynamicMetaObject errorSuggestion);
  87     }
  88 }