third_party/blink/renderer/platform/bindings/exception_context.h

// Copyright 2021 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef THIRD_PARTY_BLINK_RENDERER_PLATFORM_BINDINGS_EXCEPTION_CONTEXT_H_
#define THIRD_PARTY_BLINK_RENDERER_PLATFORM_BINDINGS_EXCEPTION_CONTEXT_H_

#include "base/dcheck_is_on.h"
#include "base/macros.h"
#include "base/notreached.h"
#include "third_party/blink/renderer/platform/platform_export.h"
#include "third_party/blink/renderer/platform/wtf/allocator/allocator.h"
#include "third_party/blink/renderer/platform/wtf/text/wtf_string.h"

namespace blink {

// ExceptionContext stores context information about what Web API throws an
// exception.
//
// Note that ExceptionContext accepts only string literals as its string
// parameters.
class PLATFORM_EXPORT ExceptionContext final {
  DISALLOW_NEW();

 public:
  enum class Context : int16_t {
    kEmpty,
    kUnknown,  // TODO(crbug.com/270033): Remove this item.
    // IDL Interface, IDL Namespace
    kAttributeGet,
    kAttributeSet,
    kConstantGet,
    kConstructorOperationInvoke,
    kOperationInvoke,
    kIndexedPropertyGet,
    kIndexedPropertySet,
    kIndexedPropertyDefine,
    kIndexedPropertyDelete,
    kIndexedPropertyQuery,
    kIndexedPropertyEnumerate,
    kNamedPropertyGet,
    kNamedPropertySet,
    kNamedPropertyDefine,
    kNamedPropertyDelete,
    kNamedPropertyQuery,
    kNamedPropertyEnumerate,
    // IDL Dictionary
    kDictionaryMemberGet,
    kDictionaryMemberSet,
    // IDL Callback Function
    kCallbackFunctionConstruct,
    kCallbackFunctionInvoke,
    // IDL Callback Interface
    kCallbackInterfaceOperationInvoke,
    // Operating on a function argument
    kFunctionArgument,
  };

  ExceptionContext() = default;

  // Note `class_name` and `property_name` accept only string literals.
  explicit ExceptionContext(Context context,
                            const char* class_name,
                            const char* property_name)
      : context_(context),
        class_name_(class_name),
        property_name_(property_name) {
#if DCHECK_IS_ON()
    switch (context) {
      case Context::kAttributeGet:
      case Context::kAttributeSet:
      case Context::kConstantGet:
      case Context::kOperationInvoke:
      case Context::kDictionaryMemberGet:
      case Context::kDictionaryMemberSet:
      case Context::kCallbackInterfaceOperationInvoke:
        DCHECK(class_name);
        DCHECK(property_name);
        break;
      case Context::kConstructorOperationInvoke:
      case Context::kIndexedPropertyGet:
      case Context::kIndexedPropertySet:
      case Context::kIndexedPropertyDefine:
      case Context::kIndexedPropertyDelete:
      case Context::kIndexedPropertyQuery:
      case Context::kIndexedPropertyEnumerate:
      case Context::kNamedPropertyGet:
      case Context::kNamedPropertySet:
      case Context::kNamedPropertyDefine:
      case Context::kNamedPropertyDelete:
      case Context::kNamedPropertyQuery:
      case Context::kNamedPropertyEnumerate:
      case Context::kCallbackFunctionConstruct:
      case Context::kCallbackFunctionInvoke:
        DCHECK(class_name);
        break;
      case Context::kEmpty:
      case Context::kFunctionArgument:
        NOTREACHED();
        break;
      case Context::kUnknown:
        break;
    }
#endif  // DCHECK_IS_ON()
  }

  explicit ExceptionContext(Context context, const char* class_name)
      : ExceptionContext(context, class_name, nullptr) {}

  explicit ExceptionContext(Context context, int16_t argument_index)
      : context_(context), argument_index_(argument_index) {
    DCHECK_EQ(Context::kFunctionArgument, context);
  }

  ExceptionContext(const ExceptionContext&) = default;
  ExceptionContext(ExceptionContext&&) = default;
  ExceptionContext& operator=(const ExceptionContext&) = default;
  ExceptionContext& operator=(ExceptionContext&&) = default;

  ~ExceptionContext() = default;

  Context GetContext() const { return context_; }
  const char* GetClassName() const { return class_name_; }
  const char* GetPropertyName() const { return property_name_; }
  int16_t GetArgumentIndex() const { return argument_index_; }

 private:
  Context context_ = Context::kEmpty;
  int16_t argument_index_ = 0;
  const char* class_name_ = nullptr;
  const char* property_name_ = nullptr;
};

}  // namespace blink

#endif  // THIRD_PARTY_BLINK_RENDERER_PLATFORM_BINDINGS_EXCEPTION_CONTEXT_H_