/* 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_PE_IMPORT_ENTRY_H
#define LIEF_PE_IMPORT_ENTRY_H
#include <ostream>
#include <string>

#include "LIEF/Abstract/Symbol.hpp"
#include "LIEF/Object.hpp"
#include "LIEF/visibility.h"

#include "LIEF/PE/enums.hpp"


namespace LIEF::PE {
class Parser;
class Builder;

/// Class that represents an entry (i.e. an import) in the import table (Import).
///
/// It extends the LIEF::Symbol generic class that exposes the LIEF::Symbol::name
/// and LIEF::Symbol::value API
class LIEF_API ImportEntry : public LIEF::Symbol {
  friend class Parser;
  friend class Builder;

  public:
  ImportEntry() = default;

  ImportEntry(uint64_t data, PE_TYPE type) :
    data_(data),
    type_(type) {}

  ImportEntry(std::string name) {
    this->name(std::move(name));
  }

  ImportEntry(const ImportEntry&) = default;
  ImportEntry& operator=(const ImportEntry&) = default;
  ~ImportEntry() override = default;

  /// Demangled representation of the symbol or an empty string if it can't
  /// be demangled
  std::string demangled_name() const;

  /// `True` if it is an import by ordinal
  bool is_ordinal() const;

  /// The ordinal value
  uint16_t ordinal() const {
    static constexpr auto MASK = 0xFFFF;
    return is_ordinal() ? (data_ & MASK) : 0;
  }

  /// @see ImportEntry::data
  uint64_t hint_name_rva() const {
    return data();
  }

  /// Index into the Export::entries that is used to speed-up
  /// the symbol resolution.
  uint16_t hint() const {
    return hint_;
  }

  /// Value of the current entry in the Import Address Table.
  /// It should match the lookup table value
  uint64_t iat_value() const {
    return iat_value_;
  }

  void iat_value(uint64_t value) {
    iat_value_ = value;
  }

  /// Original value in the import lookup table.
  /// This value should match the iat_value().
  uint64_t ilt_value() const {
    return ilt_value_;
  }

  void ilt_value(uint64_t value) {
    ilt_value_ = value;
  }

  /// Raw value
  uint64_t data() const {
    return data_;
  }

  /// **Original** address of the entry in the Import Address Table
  uint64_t iat_address() const {
    return rva_;
  }

  void data(uint64_t data) {
    data_ = data;
  }

  void accept(Visitor& visitor) const override;

  LIEF_API friend std::ostream& operator<<(std::ostream& os,
                                           const ImportEntry& entry);

  /// @private Internal use **only**
  LIEF_LOCAL void iat_address(uint64_t rva) {
    rva_ = rva;
  }

  private:
  uint64_t data_ = 0;
  uint16_t hint_ = 0;
  uint64_t iat_value_ = 0;
  uint64_t ilt_value_ = 0;
  uint64_t rva_ = 0;
  PE_TYPE type_ = PE_TYPE::PE32_PLUS;
};

}


#endif
