/*
** Copyright (c) 2020 LunarG, Inc.
**
** Permission is hereby granted, free of charge, to any person obtaining a
** copy of this software and associated documentation files (the "Software"),
** to deal in the Software without restriction, including without limitation
** the rights to use, copy, modify, merge, publish, distribute, sublicense,
** and/or sell copies of the Software, and to permit persons to whom the
** Software is furnished to do so, subject to the following conditions:
**
** The above copyright notice and this permission notice shall be included in
** all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
** IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
** FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
** AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
** LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
** FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
** DEALINGS IN THE SOFTWARE.
*/

#ifndef GFXRECON_FILE_OPTIMIZER_H
#define GFXRECON_FILE_OPTIMIZER_H

#include "decode/file_transformer.h"
#include "util/defines.h"

#include <unordered_set>

GFXRECON_BEGIN_NAMESPACE(gfxrecon)

class FileOptimizer : public decode::FileTransformer
{
  public:
    FileOptimizer(const std::unordered_set<format::HandleId>& unreferenced_ids,
                  const std::unordered_set<uint64_t>&         unreferenced_blocks);

    [[nodiscard]] uint32_t GetNumRemovedBlocks() const { return num_removed_blocks_; }

  protected:
    bool ProcessFunctionCall(decode::ParsedBlock& parsed_block) override;
    bool ProcessMethodCall(decode::ParsedBlock& parsed_block) override;
    bool ProcessMetaData(decode::ParsedBlock& parsed_block) override;
    bool WriteAnnotation(std::string_view label, std::string_view message);

  private:
    VisitResult FilterMetaData(const decode::InitBufferArgs& args);
    VisitResult FilterMetaData(const decode::InitImageArgs& args);

    template <typename Args>
    VisitResult FilterMetaData(const Args& args)
    {
        return kNeedsPassthrough;
    }

    [[nodiscard]] bool FilterMethodCall(const decode::MethodCallArgs& args) const;

  protected:
    const std::unordered_set<format::HandleId>& unreferenced_ids_;
    const std::unordered_set<uint64_t>&         unreferenced_blocks_;
    uint32_t                                    num_removed_blocks_ = 0;
};

GFXRECON_END_NAMESPACE(gfxrecon)

#endif // GFXRECON_FILE_OPTIMIZER_H
