MappingInfo.hpp

Go to the documentation of this file.

/* 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_DSC_MAPPING_INFO_H
#define LIEF_DSC_MAPPING_INFO_H
#include "LIEF/compiler_attributes.hpp"
#include "LIEF/visibility.h"
#include "LIEF/iterators.hpp"
 
#include <memory>
#include <cstdint>
 
namespace LIEF {
namespace dsc {
 
namespace details {
class MappingInfo;
class MappingInfoIt;
}

class LIEF_API MappingInfo {
  public:
  class LIEF_API Iterator
    : public iterator_facade_base<Iterator, std::random_access_iterator_tag,
                                  MappingInfo, std::ptrdiff_t, const MappingInfo*,
                                  const MappingInfo&> {
    public:
    using implementation = details::MappingInfoIt;
 
    Iterator();
 
    Iterator(std::unique_ptr<details::MappingInfoIt> impl);
    Iterator(const Iterator&);
    Iterator& operator=(const Iterator&);
 
    Iterator(Iterator&&) noexcept;
    Iterator& operator=(Iterator&&) noexcept;
 
    ~Iterator();
    bool operator<(const Iterator& rhs) const;
 
    std::ptrdiff_t operator-(const Iterator& R) const;
 
    Iterator& operator+=(std::ptrdiff_t n);
    Iterator& operator-=(std::ptrdiff_t n);
 
    friend LIEF_API bool operator==(const Iterator& LHS, const Iterator& RHS);
 
    friend LIEF_API bool operator!=(const Iterator& LHS, const Iterator& RHS) {
      return !(LHS == RHS);
    }
 
    const MappingInfo& operator*() const LIEF_LIFETIMEBOUND;
 
    // NOLINTNEXTLINE(bugprone-derived-method-shadowing-base-method)
    const MappingInfo* operator->() const LIEF_LIFETIMEBOUND;

    std::unique_ptr<MappingInfo> yield();
 
    private:
    void load() const;
 
    std::unique_ptr<details::MappingInfoIt> impl_;
    mutable std::unique_ptr<MappingInfo> cached_;
  };
 
  MappingInfo(std::unique_ptr<details::MappingInfo> impl);
  ~MappingInfo();

  uint64_t address() const;

  uint64_t size() const;

  uint64_t end_address() const {
    return address() + size();
  }

  uint64_t file_offset() const;

  uint32_t max_prot() const;

  uint32_t init_prot() const;
 
  private:
  std::unique_ptr<details::MappingInfo> impl_;
};
 
}
}
#endif