gecko-dev/dom/indexedDB/IDBEvents.h
Chris Peterson 843c954b43 Bug 1631684 - Replace MOZ_MUST_USE with [[nodiscard]] in dom/indexedDB. r=dom-workers-and-storage-reviewers,sg
Also move MOZ_MUST_USE before function declarations' specifiers and return type. While clang and gcc's __attribute__((warn_unused_result)) can appear before, between, or after function specifiers and return types, the [[nodiscard]] attribute must precede the function specifiers.

Differential Revision: https://phabricator.services.mozilla.com/D71713
2020-04-23 01:49:16 +00:00

100 lines
3.2 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_idbevents_h__
#define mozilla_dom_idbevents_h__
#include "js/RootingAPI.h"
#include "mozilla/dom/BindingDeclarations.h"
#include "mozilla/dom/Event.h"
#include "mozilla/dom/Nullable.h"
#include "nsStringFwd.h"
#define IDBVERSIONCHANGEEVENT_IID \
{ \
0x3b65d4c3, 0x73ad, 0x492e, { \
0xb1, 0x2d, 0x15, 0xf9, 0xda, 0xc2, 0x08, 0x4b \
} \
}
namespace mozilla {
class ErrorResult;
namespace dom {
class EventTarget;
class GlobalObject;
struct IDBVersionChangeEventInit;
namespace indexedDB {
enum Bubbles { eDoesNotBubble, eDoesBubble };
enum Cancelable { eNotCancelable, eCancelable };
extern const char16_t* kAbortEventType;
extern const char16_t* kBlockedEventType;
extern const char16_t* kCompleteEventType;
extern const char16_t* kErrorEventType;
extern const char16_t* kSuccessEventType;
extern const char16_t* kUpgradeNeededEventType;
extern const char16_t* kVersionChangeEventType;
extern const char16_t* kCloseEventType;
[[nodiscard]] RefPtr<Event> CreateGenericEvent(EventTarget* aOwner,
const nsDependentString& aType,
Bubbles aBubbles,
Cancelable aCancelable);
} // namespace indexedDB
class IDBVersionChangeEvent final : public Event {
uint64_t mOldVersion;
Nullable<uint64_t> mNewVersion;
public:
[[nodiscard]] static RefPtr<IDBVersionChangeEvent> Create(
EventTarget* aOwner, const nsDependentString& aName, uint64_t aOldVersion,
uint64_t aNewVersion);
[[nodiscard]] static RefPtr<IDBVersionChangeEvent> Create(
EventTarget* aOwner, const nsDependentString& aName,
uint64_t aOldVersion);
[[nodiscard]] static RefPtr<IDBVersionChangeEvent> Constructor(
const GlobalObject& aGlobal, const nsAString& aType,
const IDBVersionChangeEventInit& aOptions);
uint64_t OldVersion() const { return mOldVersion; }
Nullable<uint64_t> GetNewVersion() const { return mNewVersion; }
NS_DECLARE_STATIC_IID_ACCESSOR(IDBVERSIONCHANGEEVENT_IID)
NS_DECL_ISUPPORTS_INHERITED
virtual JSObject* WrapObjectInternal(
JSContext* aCx, JS::Handle<JSObject*> aGivenProto) override;
private:
IDBVersionChangeEvent(EventTarget* aOwner, uint64_t aOldVersion)
: Event(aOwner, nullptr, nullptr), mOldVersion(aOldVersion) {}
~IDBVersionChangeEvent() = default;
[[nodiscard]] static RefPtr<IDBVersionChangeEvent> CreateInternal(
EventTarget* aOwner, const nsAString& aType, uint64_t aOldVersion,
const Nullable<uint64_t>& aNewVersion);
};
NS_DEFINE_STATIC_IID_ACCESSOR(IDBVersionChangeEvent, IDBVERSIONCHANGEEVENT_IID)
} // namespace dom
} // namespace mozilla
#endif // mozilla_dom_idbevents_h__