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

#include <string>

#include "mozilla/Maybe.h"
#include "mozilla/WeakPtr.h"
#include "mozilla/dom/PWebGLChild.h"
#include "mozilla/ipc/BigBuffer.h"

namespace mozilla {

class ClientWebGLContext;

namespace dom {

struct FlushedCmdInfo final {
  size_t flushes = 0;
  // Store a number of flushes since last IPC congestion check.
  // It is reset to 0, when current IPC congestion check is done.
  size_t flushesSinceLastCongestionCheck = 0;
  // Incremented for each IPC congestion check.
  size_t congestionCheckGeneration = 0;
  size_t flushedCmdBytes = 0;
  size_t overhead = 0;
};

class WebGLChild final : public PWebGLChild, public SupportsWeakPtr {
  const WeakPtr<ClientWebGLContext> mContext;
  const size_t mDefaultCmdsShmemSize;
  mozilla::ipc::BigBuffer mPendingCmdsShmem;
  size_t mPendingCmdsPos = 0;
  size_t mPendingCmdsAlignmentOverhead = 0;
  FlushedCmdInfo mFlushedCmdInfo;

 public:
  NS_INLINE_DECL_THREADSAFE_REFCOUNTING(WebGLChild, override);

  explicit WebGLChild(ClientWebGLContext&);

  Maybe<Range<uint8_t>> AllocPendingCmdBytes(size_t,
                                             size_t fyiAlignmentOverhead);
  void FlushPendingCmds();
  void Destroy();
  void ActorDestroy(ActorDestroyReason why) override;

  FlushedCmdInfo& GetFlushedCmdInfo() { return mFlushedCmdInfo; }

 private:
  friend PWebGLChild;
  virtual ~WebGLChild();

 public:
  mozilla::ipc::IPCResult RecvJsWarning(const std::string&) const;
  mozilla::ipc::IPCResult RecvOnContextLoss(webgl::ContextLossReason) const;
  mozilla::ipc::IPCResult RecvOnSyncComplete(webgl::ObjectId) const;
};

}  // namespace dom
}  // namespace mozilla

#endif  // WEBGLCHILD_H_