/* -*- 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 GFX_WEBRENDERCOMMANDBUILDER_H

#define GFX_WEBRENDERCOMMANDBUILDER_H

#include "mozilla/webrender/WebRenderAPI.h"

#include "mozilla/layers/ClipManager.h"

#include "mozilla/layers/WebRenderMessages.h"

#include "mozilla/layers/WebRenderScrollData.h"

#include "mozilla/layers/WebRenderUserData.h"

#include "nsDisplayList.h"

#include "nsIFrame.h"

namespace mozilla {

namespace layers {

class CanvasLayer;

class ImageClient;

class ImageContainer;

class WebRenderBridgeChild;

class WebRenderCanvasData;

class WebRenderCanvasRendererAsync;

class WebRenderImageData;

class WebRenderFallbackData;

class WebRenderParentCommand;

class WebRenderUserData;

class WebRenderCommandBuilder {

  typedef nsTHashtable<nsRefPtrHashKey<WebRenderUserData>> WebRenderUserDataRefTable;

  typedef nsTHashtable<nsRefPtrHashKey<WebRenderCanvasData>> CanvasDataSet;

public:

  explicit WebRenderCommandBuilder(WebRenderLayerManager* aManager)

  : mManager(aManager)

  , mLastAsr(nullptr)

  , mBuilderDumpIndex(0)

  , mDumpIndent(0)

  , mDoGrouping(false)

  , mContainsSVGGroup(false)

  {}

  void Destroy();

  void EmptyTransaction();

  bool NeedsEmptyTransaction();

  void BuildWebRenderCommands(wr::DisplayListBuilder& aBuilder,

                              wr::IpcResourceUpdateQueue& aResourceUpdates,

                              nsDisplayList* aDisplayList,

                              nsDisplayListBuilder* aDisplayListBuilder,

                              WebRenderScrollData& aScrollData,

                              wr::LayoutSize& aContentSize,

                              const nsTArray<wr::WrFilterOp>& aFilters);

  void PushOverrideForASR(const ActiveScrolledRoot* aASR,

                          const Maybe<wr::WrClipId>& aClipId);

  void PopOverrideForASR(const ActiveScrolledRoot* aASR);

  Maybe<wr::ImageKey> CreateImageKey(nsDisplayItem* aItem,

                                     ImageContainer* aContainer,

                                     mozilla::wr::DisplayListBuilder& aBuilder,

                                     mozilla::wr::IpcResourceUpdateQueue& aResources,

                                     mozilla::wr::ImageRendering aRendering,

                                     const StackingContextHelper& aSc,

                                     gfx::IntSize& aSize,

                                     const Maybe<LayoutDeviceRect>& aAsyncImageBounds);

  WebRenderUserDataRefTable* GetWebRenderUserDataTable() { return &mWebRenderUserDatas; }

  bool PushImage(nsDisplayItem* aItem,

                 ImageContainer* aContainer,

                 mozilla::wr::DisplayListBuilder& aBuilder,

                 mozilla::wr::IpcResourceUpdateQueue& aResources,

                 const StackingContextHelper& aSc,

                 const LayoutDeviceRect& aRect);

  Maybe<wr::WrImageMask> BuildWrMaskImage(nsDisplayItem* aItem,

                                          wr::DisplayListBuilder& aBuilder,

                                          wr::IpcResourceUpdateQueue& aResources,

                                          const StackingContextHelper& aSc,

                                          nsDisplayListBuilder* aDisplayListBuilder,

                                          const LayoutDeviceRect& aBounds);

  bool PushItemAsImage(nsDisplayItem* aItem,

                       wr::DisplayListBuilder& aBuilder,

                       wr::IpcResourceUpdateQueue& aResources,

                       const StackingContextHelper& aSc,

                       nsDisplayListBuilder* aDisplayListBuilder);

  void CreateWebRenderCommandsFromDisplayList(nsDisplayList* aDisplayList,

                                              nsDisplayItem* aOuterItem,

                                              nsDisplayListBuilder* aDisplayListBuilder,

                                              const StackingContextHelper& aSc,

                                              wr::DisplayListBuilder& aBuilder,

                                              wr::IpcResourceUpdateQueue& aResources);

  // aWrappingItem has to be non-null.

  void DoGroupingForDisplayList(nsDisplayList* aDisplayList,

                                nsDisplayItem* aWrappingItem,

                                nsDisplayListBuilder* aDisplayListBuilder,

                                const StackingContextHelper& aSc,

                                wr::DisplayListBuilder& aBuilder,

                                wr::IpcResourceUpdateQueue& aResources);

  already_AddRefed<WebRenderFallbackData> GenerateFallbackData(nsDisplayItem* aItem,

                                                               wr::DisplayListBuilder& aBuilder,

                                                               wr::IpcResourceUpdateQueue& aResources,

                                                               const StackingContextHelper& aSc,

                                                               nsDisplayListBuilder* aDisplayListBuilder,

                                                               LayoutDeviceRect& aImageRect);

  void RemoveUnusedAndResetWebRenderUserData();

  void ClearCachedResources();

  bool ShouldDumpDisplayList();

  wr::usize GetBuilderDumpIndex() { return mBuilderDumpIndex; }

  bool GetContainsSVGGroup() { return mContainsSVGGroup; }

  // Those are data that we kept between transactions. We used to cache some

  // data in the layer. But in layers free mode, we don't have layer which

  // means we need some other place to cached the data between transaction.

  // We store the data in frame's property.

  template<class T> already_AddRefed<T>

  CreateOrRecycleWebRenderUserData(nsDisplayItem* aItem,

                                   bool* aOutIsRecycled = nullptr)

  {

    MOZ_ASSERT(aItem);

    nsIFrame* frame = aItem->Frame();

    if (aOutIsRecycled) {

      *aOutIsRecycled = true;

    }

    WebRenderUserDataTable* userDataTable =

      frame->GetProperty(WebRenderUserDataProperty::Key());

    if (!userDataTable) {

      userDataTable = new WebRenderUserDataTable();

      frame->AddProperty(WebRenderUserDataProperty::Key(), userDataTable);

    }

    RefPtr<WebRenderUserData>& data = userDataTable->GetOrInsert(WebRenderUserDataKey(aItem->GetPerFrameKey(), T::Type()));

    if (!data) {

      // To recreate a new user data, we should remove the data from the table first.

      if (data) {

        data->RemoveFromTable();

      }

      data = new T(mManager, aItem);

      mWebRenderUserDatas.PutEntry(data);

      if (aOutIsRecycled) {

        *aOutIsRecycled = false;

      }

    }

    MOZ_ASSERT(data);

    MOZ_ASSERT(data->GetType() == T::Type());

    // Mark the data as being used. We will remove unused user data in the end of EndTransaction.

    data->SetUsed(true);

    if (T::Type() == WebRenderUserData::UserDataType::eCanvas) {

      mLastCanvasDatas.PutEntry(data->AsCanvasData());

    }

    RefPtr<T> res = static_cast<T*>(data.get());

    return res.forget();

  }

Unexecuted instantiation: already_AddRefed<mozilla::layers::WebRenderCanvasData> mozilla::layers::WebRenderCommandBuilder::CreateOrRecycleWebRenderUserData<mozilla::layers::WebRenderCanvasData>(nsDisplayItem*, bool*)

Unexecuted instantiation: already_AddRefed<mozilla::layers::WebRenderAnimationData> mozilla::layers::WebRenderCommandBuilder::CreateOrRecycleWebRenderUserData<mozilla::layers::WebRenderAnimationData>(nsDisplayItem*, bool*)

  WebRenderLayerManager* mManager;

private:

  ClipManager mClipManager;

  // We use this as a temporary data structure while building the mScrollData

  // inside a layers-free transaction.

  std::vector<WebRenderLayerScrollData> mLayerScrollData;

  // We use this as a temporary data structure to track the current display

  // item's ASR as we recurse in CreateWebRenderCommandsFromDisplayList. We

  // need this so that WebRenderLayerScrollData items that deeper in the

  // tree don't duplicate scroll metadata that their ancestors already have.

  std::vector<const ActiveScrolledRoot*> mAsrStack;

  const ActiveScrolledRoot* mLastAsr;

  WebRenderUserDataRefTable mWebRenderUserDatas;

  // Store of WebRenderCanvasData objects for use in empty transactions

  CanvasDataSet mLastCanvasDatas;

  wr::usize mBuilderDumpIndex;

  wr::usize mDumpIndent;

public:

  // Whether consecutive inactive display items should be grouped into one

  // blob image.

  bool mDoGrouping;

  // True if the most recently build display list contained an svg that

  // we did grouping for.

  bool mContainsSVGGroup;

};

} // namespace layers

} // namespace mozilla

#endif /* GFX_WEBRENDERCOMMANDBUILDER_H */