FatBinary.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_MACHO_FAT_BINARY_H
#define LIEF_MACHO_FAT_BINARY_H
#include <string>
#include <vector>
#include <memory>
 
#include "LIEF/visibility.h"
#include "LIEF/iterators.hpp"
#include "LIEF/MachO/Header.hpp"
 
namespace LIEF {
class Parser;
namespace MachO {
 
class Parser;
class Builder;
class Binary;

class LIEF_API FatBinary {
  friend class LIEF::Parser;
  friend class Parser;
  friend class Builder;
 
  public:

  using binaries_t = std::vector<std::unique_ptr<Binary>>;

  using it_binaries = ref_iterator<binaries_t&, Binary*>;

  using it_const_binaries = const_ref_iterator<const binaries_t&, Binary*>;
 
  FatBinary(const FatBinary&) = delete;
  FatBinary& operator=(const FatBinary&) = delete;

  static std::unique_ptr<FatBinary> create(binaries_t binaries);
 
  virtual ~FatBinary();

  size_t size() const {
    return binaries_.size();
  }

  bool empty() const {
    return binaries_.empty();
  }
 
  it_binaries begin() {
    return binaries_;
  }
  it_const_binaries begin() const {
    return binaries_;
  }
 
  it_binaries end() {
    return it_binaries(binaries_).end();
  }
 
  it_const_binaries end() const {
    return it_const_binaries(binaries_).end();
  }
 
  void release_all_binaries() {
    for (auto& bin : binaries_) {
      bin.release(); // NOLINT(bugprone-unused-return-value)
    }
  }

  std::unique_ptr<Binary> pop_back();

  Binary* at(size_t index) {
    return const_cast<Binary*>(static_cast<const FatBinary*>(this)->at(index));
  }
 
  const Binary* at(size_t index) const {
    if (index >= size()) {
      return nullptr;
    }
    return binaries_[index].get();
  }
 
  Binary* back() {
    return const_cast<Binary*>(static_cast<const FatBinary*>(this)->back());
  }
  const Binary* back() const {
    return binaries_.empty() ? nullptr : binaries_.back().get();
  }
 
  Binary* front() {
    return const_cast<Binary*>(static_cast<const FatBinary*>(this)->front());
  }
 
  const Binary* front() const {
    return binaries_.empty() ? nullptr : binaries_.front().get();
  }
 
  Binary* operator[](size_t index) {
    return at(index);
  }
  const Binary* operator[](size_t index) const {
    return at(index);
  }

  std::unique_ptr<Binary> take(size_t index);

  std::unique_ptr<Binary> take(Header::CPU_TYPE cpu);

  void write(const std::string& filename);

  std::vector<uint8_t> raw();
 
  Binary* get(Header::CPU_TYPE cpu) {
    return const_cast<Binary*>(static_cast<const FatBinary*>(this)->get(cpu));
  }

  const Binary* get(Header::CPU_TYPE cpu) const;
 
  Binary* operator[](Header::CPU_TYPE cpu) {
    return get(cpu);
  }
 
  const Binary* operator[](Header::CPU_TYPE cpu) const {
    return get(cpu);
  }
 
  LIEF_API friend std::ostream& operator<<(std::ostream& os, const FatBinary& fatbinary);
 
  private:
  LIEF_LOCAL FatBinary();
  LIEF_LOCAL FatBinary(binaries_t binaries);
  binaries_t binaries_;
};
 
} // namespace MachO
} // namespace LIEF
#endif