forked from mirrors/gecko-dev
2ecc5e3af1
This implements the base class for proxy handler of observable array exotic objects, it implments the proxy behaviour define in https://webidl.spec.whatwg.org/#es-observable-arrays, the virtual functions , OnDeleteItem() and OnSetItem(), are for SetAlgorithm and DeleteAlgorithm that are defined and implemented per interface. Depends on D112277 Differential Revision: https://phabricator.services.mozilla.com/D112278
108 lines
4.3 KiB
C++
108 lines
4.3 KiB
C++
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
* You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
#ifndef mozilla_dom_ObservableArrayProxyHandler_h
|
|
#define mozilla_dom_ObservableArrayProxyHandler_h
|
|
|
|
#include "js/TypeDecls.h"
|
|
#include "js/Wrapper.h"
|
|
|
|
namespace mozilla {
|
|
namespace dom {
|
|
|
|
/**
|
|
* Proxy handler for observable array exotic object.
|
|
*
|
|
* The indexed properties are stored in the backing list object in reserved slot
|
|
* of the proxy object with special treatment intact.
|
|
*
|
|
* The additional properties are stored in the proxy target object.
|
|
*/
|
|
|
|
class ObservableArrayProxyHandler : public js::ForwardingProxyHandler {
|
|
public:
|
|
explicit constexpr ObservableArrayProxyHandler()
|
|
: js::ForwardingProxyHandler(&family) {}
|
|
|
|
// Implementations of methods that can be implemented in terms of
|
|
// other lower-level methods.
|
|
bool defineProperty(JSContext* aCx, JS::HandleObject aProxy, JS::HandleId aId,
|
|
JS::Handle<JS::PropertyDescriptor> aDesc,
|
|
JS::ObjectOpResult& aResult) const override;
|
|
|
|
bool delete_(JSContext* aCx, JS::HandleObject aProxy, JS::HandleId aId,
|
|
JS::ObjectOpResult& aResult) const override;
|
|
|
|
bool get(JSContext* aCx, JS::HandleObject aProxy, JS::HandleValue aReceiver,
|
|
JS::HandleId aId, JS::MutableHandleValue aVp) const override;
|
|
|
|
bool getOwnPropertyDescriptor(
|
|
JSContext* aCx, JS::HandleObject aProxy, JS::HandleId aId,
|
|
JS::MutableHandle<Maybe<JS::PropertyDescriptor>> aDesc) const override;
|
|
|
|
bool has(JSContext* aCx, JS::HandleObject aProxy, JS::HandleId aId,
|
|
bool* aBp) const override;
|
|
|
|
bool ownPropertyKeys(JSContext* aCx, JS::HandleObject aProxy,
|
|
JS::MutableHandleVector<jsid> aProps) const override;
|
|
|
|
bool preventExtensions(JSContext* aCx, JS::HandleObject aProxy,
|
|
JS::ObjectOpResult& aResult) const override;
|
|
|
|
bool set(JSContext* aCx, JS::HandleObject aProxy, JS::HandleId aId,
|
|
JS::HandleValue aV, JS::HandleValue aReceiver,
|
|
JS::ObjectOpResult& aResult) const override;
|
|
|
|
bool SetLength(JSContext* aCx, JS::HandleObject aProxy,
|
|
uint32_t aLength) const;
|
|
|
|
static const char family;
|
|
|
|
protected:
|
|
bool GetBackingListObject(JSContext* aCx, JS::HandleObject aProxy,
|
|
JS::MutableHandleObject aBackingListObject) const;
|
|
|
|
bool GetBackingListLength(JSContext* aCx, JS::HandleObject aProxy,
|
|
uint32_t* aLength) const;
|
|
|
|
bool SetLength(JSContext* aCx, JS::HandleObject aProxy,
|
|
JS::HandleObject aBackingList, uint32_t aLength,
|
|
JS::ObjectOpResult& aResult) const;
|
|
|
|
bool SetLength(JSContext* aCx, JS::HandleObject aProxy,
|
|
JS::HandleObject aBackingList, JS::HandleValue aValue,
|
|
JS::ObjectOpResult& aResult) const;
|
|
|
|
// Hook for subclasses to invoke the setting the indexed value steps which
|
|
// would invoke DeleteAlgorithm/SetAlgorithm defined and implemented per
|
|
// interface. Returns false and throw exception on failure.
|
|
virtual bool SetIndexedValue(JSContext* aCx, JS::HandleObject aProxy,
|
|
JS::HandleObject aBackingList, uint32_t aIndex,
|
|
JS::HandleValue aValue,
|
|
JS::ObjectOpResult& aResult) const = 0;
|
|
|
|
// Hook for subclasses to invoke the DeleteAlgorithm defined and implemented
|
|
// per interface. Returns false and throw exception on failure.
|
|
virtual bool OnDeleteItem(JSContext* aCx, JS::HandleObject aProxy,
|
|
JS::HandleValue aValue, uint32_t aIndex) const = 0;
|
|
};
|
|
|
|
inline bool IsObservableArrayProxy(JSObject* obj) {
|
|
return js::IsProxy(obj) && js::GetProxyHandler(obj)->family() ==
|
|
&ObservableArrayProxyHandler::family;
|
|
}
|
|
|
|
inline const ObservableArrayProxyHandler* GetObservableArrayProxyHandler(
|
|
JSObject* obj) {
|
|
MOZ_ASSERT(IsObservableArrayProxy(obj));
|
|
return static_cast<const ObservableArrayProxyHandler*>(
|
|
js::GetProxyHandler(obj));
|
|
}
|
|
|
|
} // namespace dom
|
|
} // namespace mozilla
|
|
|
|
#endif /* mozilla_dom_ObservableArrayProxyHandler_h */
|