/* 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 DOM_QUOTA_ORIGINOPERATIONBASE_H_
#define DOM_QUOTA_ORIGINOPERATIONBASE_H_

#include "ErrorList.h"
#include "mozilla/NotNull.h"
#include "mozilla/RefPtr.h"
#include "mozilla/dom/quota/BackgroundThreadObject.h"
#include "mozilla/dom/quota/Config.h"
#include "mozilla/dom/quota/ForwardDecls.h"
#include "mozilla/dom/quota/OriginOperationCallbacks.h"
#include "mozilla/dom/quota/StringifyUtils.h"
#include "nsISupportsImpl.h"

namespace mozilla::dom::quota {

class QuotaManager;

class OriginOperationBase : public BackgroundThreadObject,
                            public OriginOperationCallbackHolders,
                            public Stringifyable {
 protected:
  const NotNull<RefPtr<QuotaManager>> mQuotaManager;
  nsresult mResultCode;

 private:
#ifdef QM_COLLECTING_OPERATION_TELEMETRY
  const char* mName = nullptr;
#endif

 public:
  NS_INLINE_DECL_PURE_VIRTUAL_REFCOUNTING

#ifdef QM_COLLECTING_OPERATION_TELEMETRY
  const char* Name() const { return mName; }
#endif

  void RunImmediately();

  OriginOperationCallbacks GetCallbacks(
      const OriginOperationCallbackOptions& aCallbackOptions);

 protected:
  OriginOperationBase(MovingNotNull<RefPtr<QuotaManager>>&& aQuotaManager,
                      const char* aName);

  // Reference counted.
  virtual ~OriginOperationBase();

  virtual nsresult DoInit(QuotaManager& aQuotaManager);

  virtual RefPtr<BoolPromise> Open() = 0;

#ifdef DEBUG
  virtual nsresult DirectoryOpen();
#endif

  virtual nsresult DoDirectoryWork(QuotaManager& aQuotaManager) = 0;

  virtual void UnblockOpen() = 0;

 private:
  void DoStringify(nsACString& aData) override {}
};

}  // namespace mozilla::dom::quota

#endif  // DOM_QUOTA_ORIGINOPERATIONBASE_H_