1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

use std::fmt;
use address::Address;

/// An assembly instruction, bytecode operation, VM operation, etc.
///
/// This trait will be implemented for a variety of backends and
/// provides the general means by which the rest of the code in this
/// library can be re-used.
pub trait Instruction: fmt::Debug {
    /// The address of this `Instruction`.
    fn address(&self) -> Address;

    /// Does this instruction terminate a `BasicBlock`?
    fn is_block_terminator(&self) -> bool {
        self.is_call() || self.is_local_jump() || self.is_return()
    }

    /// Does this instruction represent a call?
    fn is_call(&self) -> bool;

    /// Does this instruction represent a local jump?
    fn is_local_jump(&self) -> bool;

    /// Does this instruction represent a function return?
    fn is_return(&self) -> bool;
}