Instruction.hpp

Go to the documentation of this file.

/* Copyright 2022 - 2024 R. Thomas
 *
 * 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_ASM_INST_H
#define LIEF_ASM_INST_H
#include "LIEF/visibility.h"
#include "LIEF/iterators.hpp"
#include "LIEF/errors.hpp"
 
#include <ostream>
#include <memory>
#include <string>
 
namespace llvm {
class MCInst;
}
 
namespace LIEF {
namespace assembly {
 
namespace details {
class Instruction;
class InstructionIt;
}
class LIEF_API Instruction {
  public:  class Iterator final :
    public iterator_facade_base<Iterator, std::forward_iterator_tag, std::unique_ptr<Instruction>,
                                std::ptrdiff_t, Instruction*, std::unique_ptr<Instruction>>
  {
    public:
    using implementation = details::InstructionIt;
 
    LIEF_API Iterator();
 
    LIEF_API Iterator(std::unique_ptr<details::InstructionIt> impl);
    LIEF_API Iterator(const Iterator&);
    LIEF_API Iterator& operator=(const Iterator&);
 
    LIEF_API Iterator(Iterator&&) noexcept;
    LIEF_API Iterator& operator=(Iterator&&) noexcept;
 
    LIEF_API ~Iterator();
 
    LIEF_API Iterator& operator++();
 
    friend LIEF_API bool operator==(const Iterator& LHS, const Iterator& RHS);
 
    friend bool operator!=(const Iterator& LHS, const Iterator& RHS) {
      return !(LHS == RHS);
    }
    LIEF_API std::unique_ptr<Instruction> operator*() const;
 
    private:
    std::unique_ptr<details::InstructionIt> impl_;
  };

public: enum class MemoryAccess : uint8_t {

NONE = 0,

READ = 1 << 0,

WRITE = 1 << 1,

READ_WRITE = READ | WRITE,

};