/* Copyright 2017 - 2026 R. Thomas
 * Copyright 2017 - 2026 Quarkslab
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
#ifndef LIEF_MACHO_TWO_LEVEL_HINTS_H
#define LIEF_MACHO_TWO_LEVEL_HINTS_H
#include <memory>
#include <ostream>
#include <vector>

#include "LIEF/compiler_attributes.hpp"
#include "LIEF/iterators.hpp"
#include "LIEF/span.hpp"
#include "LIEF/visibility.h"

#include "LIEF/MachO/LoadCommand.hpp"


namespace LIEF::MachO {

class BinaryParser;
class Builder;
class LinkEdit;

namespace details {
struct twolevel_hints_command;
}

/// Class which represents the `LC_TWOLEVEL_HINTS` command
class LIEF_API TwoLevelHints : public LoadCommand {
  friend class BinaryParser;
  friend class LinkEdit;
  friend class Builder;

  public:
  using hints_list_t = std::vector<uint32_t>;
  using it_hints_t = ref_iterator<hints_list_t&>;
  using it_const_hints_t = const_ref_iterator<const hints_list_t&>;

  TwoLevelHints() = default;
  TwoLevelHints(const details::twolevel_hints_command& cmd);

  TwoLevelHints& operator=(const TwoLevelHints& copy) = default;
  TwoLevelHints(const TwoLevelHints& copy) = default;

  std::unique_ptr<LoadCommand> clone() const override {
    return std::make_unique<TwoLevelHints>(*this);
  }

  /// Original payload of the command
  span<const uint8_t> content() const LIEF_LIFETIMEBOUND {
    return content_;
  }
  span<uint8_t> content() LIEF_LIFETIMEBOUND {
    return content_;
  }

  /// Iterator over the hints (`uint32_t` integers)
  it_hints_t hints() {
    return hints_;
  }
  it_const_hints_t hints() const {
    return hints_;
  }

  /// Original offset of the command. It should point in the
  /// `__LINKEDIT` segment
  uint32_t offset() const {
    return offset_;
  }
  void offset(uint32_t offset) {
    offset_ = offset;
  }

  uint32_t original_nb_hints() const {
    return original_nb_hints_;
  }

  ~TwoLevelHints() override = default;

  void accept(Visitor& visitor) const override;

  std::ostream& print(std::ostream& os) const override;

  static bool classof(const LoadCommand* cmd) {
    return cmd->command() == LoadCommand::TYPE::TWOLEVEL_HINTS;
  }

  private:
  uint32_t offset_ = 0;
  hints_list_t hints_;
  span<uint8_t> content_;
  uint32_t original_nb_hints_ = 0;
};

}

#endif
