fune/dom/bindings/test/TestInterfaceObservableArray.h
Edgar Chen 74c8ac1951 Bug 1683281 - Part 6-2: C++ helper function for ObservableArray; r=peterv
Generate helper function for C++ to perform operations on backing objects for
each observable array attribute,
- ElementAt: Get the item at that index. Throw error if fail to get the element.
- ReplaceElementAt: Replace the item at the index, this will also trigger OnDelete
  and OnSet callback. Throw error if fail to replace the element.
- AppendElement: Append one element to the end of the array, this will also trigger
  OnSet callback. Throw error if fail to append the element.
- RemoveLastElement: Remove the element at the last index, this will also trigger
  OnDelete callback. Throw error if fail to remove the element.
- Length: Get the number of the indexd value. Throw error if fail to get the length.

Depends on D113728

Differential Revision: https://phabricator.services.mozilla.com/D113862
2022-03-10 22:44:29 +00:00

115 lines
4.6 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_TestInterfaceObservableArray_h
#define mozilla_dom_TestInterfaceObservableArray_h
#include "nsCOMPtr.h"
#include "nsWrapperCache.h"
#include "nsTArray.h"
class nsPIDOMWindowInner;
namespace mozilla {
class ErrorResult;
namespace dom {
class GlobalObject;
class SetDeleteBooleanCallback;
class SetDeleteInterfaceCallback;
class SetDeleteObjectCallback;
struct ObservableArrayCallbacks;
// Implementation of test binding for webidl ObservableArray type, using
// primitives for value type
class TestInterfaceObservableArray final : public nsISupports,
public nsWrapperCache {
public:
NS_DECL_CYCLE_COLLECTING_ISUPPORTS
NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS(TestInterfaceObservableArray)
nsPIDOMWindowInner* GetParentObject() const;
virtual JSObject* WrapObject(JSContext* aCx,
JS::Handle<JSObject*> aGivenProto) override;
static already_AddRefed<TestInterfaceObservableArray> Constructor(
const GlobalObject& aGlobal, const ObservableArrayCallbacks& aCallbacks,
ErrorResult& rv);
MOZ_CAN_RUN_SCRIPT_BOUNDARY
void OnSetObservableArrayObject(JSContext* aCx, JS::Handle<JSObject*> aValue,
uint32_t aIndex, ErrorResult& aRv);
MOZ_CAN_RUN_SCRIPT_BOUNDARY
void OnDeleteObservableArrayObject(JSContext* aCx,
JS::Handle<JSObject*> aValue,
uint32_t aIndex, ErrorResult& aRv);
MOZ_CAN_RUN_SCRIPT_BOUNDARY
void OnSetObservableArrayBoolean(bool aValue, uint32_t aIndex,
ErrorResult& aRv);
MOZ_CAN_RUN_SCRIPT_BOUNDARY
void OnDeleteObservableArrayBoolean(bool aValue, uint32_t aIndex,
ErrorResult& aRv);
MOZ_CAN_RUN_SCRIPT_BOUNDARY
void OnSetObservableArrayInterface(TestInterfaceObservableArray* aValue,
uint32_t aIndex, ErrorResult& aRv);
MOZ_CAN_RUN_SCRIPT_BOUNDARY
void OnDeleteObservableArrayInterface(TestInterfaceObservableArray* aValue,
uint32_t aIndex, ErrorResult& aRv);
bool BooleanElementAtInternal(uint32_t aIndex, ErrorResult& aRv);
void ObjectElementAtInternal(JSContext* aCx, uint32_t aIndex,
JS::MutableHandle<JSObject*> aValue,
ErrorResult& aRv);
already_AddRefed<TestInterfaceObservableArray> InterfaceElementAtInternal(
uint32_t aIndex, ErrorResult& aRv);
void BooleanReplaceElementAtInternal(uint32_t aIndex, bool aValue,
ErrorResult& aRv);
void ObjectReplaceElementAtInternal(JSContext* aCx, uint32_t aIndex,
JS::Handle<JSObject*> aValue,
ErrorResult& aRv);
void InterfaceReplaceElementAtInternal(uint32_t aIndex,
TestInterfaceObservableArray& aValue,
ErrorResult& aRv);
void BooleanAppendElementInternal(bool aValue, ErrorResult& aRv);
void ObjectAppendElementInternal(JSContext* aCx, JS::Handle<JSObject*> aValue,
ErrorResult& aRv);
void InterfaceAppendElementInternal(TestInterfaceObservableArray& aValue,
ErrorResult& aRv);
void BooleanRemoveLastElementInternal(ErrorResult& aRv);
void ObjectRemoveLastElementInternal(ErrorResult& aRv);
void InterfaceRemoveLastElementInternal(ErrorResult& aRv);
uint32_t BooleanLengthInternal(ErrorResult& aRv);
uint32_t ObjectLengthInternal(ErrorResult& aRv);
uint32_t InterfaceLengthInternal(ErrorResult& aRv);
private:
explicit TestInterfaceObservableArray(
nsPIDOMWindowInner* aParent, const ObservableArrayCallbacks& aCallbacks);
virtual ~TestInterfaceObservableArray() = default;
nsCOMPtr<nsPIDOMWindowInner> mParent;
RefPtr<SetDeleteBooleanCallback> mSetBooleanCallback;
RefPtr<SetDeleteBooleanCallback> mDeleteBooleanCallback;
RefPtr<SetDeleteObjectCallback> mSetObjectCallback;
RefPtr<SetDeleteObjectCallback> mDeleteObjectCallback;
RefPtr<SetDeleteInterfaceCallback> mSetInterfaceCallback;
RefPtr<SetDeleteInterfaceCallback> mDeleteInterfaceCallback;
};
} // namespace dom
} // namespace mozilla
#endif // mozilla_dom_TestInterfaceObservableArray_h