src/dawn/replay/ReplayImpl.h

// Copyright 2025 The Dawn & Tint Authors
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this
//    list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its
//    contributors may be used to endorse or promote products derived from
//    this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#ifndef SRC_DAWN_REPLAY_REPLAYIMPL_H_
#define SRC_DAWN_REPLAY_REPLAYIMPL_H_

#include <memory>
#include <string>
#include <string_view>

#include "dawn/replay/Replay.h"
#include "src/dawn/replay/CaptureWalker.h"

namespace dawn::replay {

class CaptureImpl;
class DawnRootCommandVisitor;

// Replays a capture. For now we only support replaying the entire capture.
// In the future we'd like to be able to replay up to a certain point.
class ReplayImpl : public Replay {
  public:
    static std::unique_ptr<ReplayImpl> Create(wgpu::Device device,
                                              std::unique_ptr<Capture> capture);

    MaybeError Play();

    // Gets the first object of type T with the given label, or nullptr if not
    // found. Note: We don't too much care this is slow as mostly used for
    // testing and debugging.
    template <typename T>
    T GetObjectByLabel(std::string_view label) const;

    template <typename T>
    T GetObjectById(schema::ObjectId id) const;

    template <typename T>
    const std::string& GetLabel(const T& object) const;

    const std::string& GetLabel(schema::ObjectId id) const;

  private:
    ReplayImpl(wgpu::Device device, std::unique_ptr<CaptureImpl> capture);

    std::unique_ptr<DawnRootCommandVisitor> mVisitor;
    std::unique_ptr<CaptureImpl> mCapture;
};

}  // namespace dawn::replay

#endif  // SRC_DAWN_REPLAY_REPLAYIMPL_H_