llir 0.2.2

use llvm_sys::core::*;
use llvm_sys::prelude::{LLVMBasicBlockRef, LLVMValueRef};
use std::marker::PhantomData;

use crate::values::*;
use crate::*;

/// A block inside of function
#[derive(Copy, Clone, PartialEq, Eq, Hash)]
pub struct Block<'ctx>(LLVMBasicBlockRef, PhantomData<&'ctx ()>);

impl<'ctx> std::fmt::Debug for Block<'ctx> {
  fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
    f.debug_tuple("Block").field(&self.0).finish()
  }
}

impl_send_sync!(Block);

impl<'ctx> GetDebugMetadata<'ctx> for Block<'ctx> {}

impl<'ctx> Block<'ctx> {
  /// Get the function containing this block
  pub fn parent_function(&self) -> Function<'ctx> {
    let func_ptr = unsafe { LLVMGetBasicBlockParent(self.0) };
    Function::from_llvm(func_ptr)
  }

  /// Iterate the instructions inside this block
  ///
  /// ```
  /// for instr in blk.iter_instructions() {
  ///   // Do things to instr...
  /// }
  /// ```
  pub fn iter_instructions(&self) -> BlockInstructionIterator<'ctx> {
    let first_instr = unsafe { LLVMGetFirstInstruction(self.0) };
    if first_instr.is_null() {
      BlockInstructionIterator {
        curr_instr: None,
        marker: PhantomData,
      }
    } else {
      BlockInstructionIterator {
        curr_instr: Some(first_instr),
        marker: PhantomData,
      }
    }
  }

  /// Get the first instruction inside this block
  pub fn first_instruction(&self) -> Option<Instruction<'ctx>> {
    let first_instr = unsafe { LLVMGetFirstInstruction(self.0) };
    if first_instr.is_null() {
      None
    } else {
      Some(Instruction::from_llvm(first_instr))
    }
  }

  /// Get the last instruction inside this block
  pub fn last_instruction(&self) -> Option<Instruction<'ctx>> {
    let last_instr = unsafe { LLVMGetLastInstruction(self.0) };
    if last_instr.is_null() {
      None
    } else {
      Some(Instruction::from_llvm(last_instr))
    }
  }

  /// Get the name of the block
  pub fn name(&self) -> String {
    unsafe { utils::raw_to_string(LLVMGetBasicBlockName(self.0)) }
  }

  /// Get the destination blocks that can be reached
  pub fn destination_blocks(&self) -> Vec<Block<'ctx>> {
    if let Some(term) = self.last_instruction() {
      match term {
        Instruction::Branch(br) => br.destinations(),
        Instruction::Switch(sw) => sw.destinations(),
        _ => vec![],
      }
    } else {
      vec![]
    }
  }

  /// Checking if a block is a loop entry block
  ///
  /// Will iterate through all blocks inside the function and see if there is an
  /// loop based unconditional branch going to this block. This function is relying
  /// on the debug symbol `llvm.loop`
  pub fn is_loop_entry_block(&self) -> bool {
    for blk in self.parent_function().iter_blocks() {
      match blk.last_instruction() {
        Some(Instruction::Branch(BranchInstruction::Unconditional(un))) => {
          if let Some(is_loop_jump) = un.is_loop_jump() {
            if is_loop_jump && un.destination() == *self {
              return true;
            }
          }
        }
        _ => {}
      }
    }
    return false;
  }
}

impl<'ctx> BlockRef for Block<'ctx> {
  fn block_ref(&self) -> LLVMBasicBlockRef {
    self.0
  }
}

impl<'ctx> ValueRef for Block<'ctx> {
  fn value_ref(&self) -> LLVMValueRef {
    unsafe { LLVMBasicBlockAsValue(self.0) }
  }
}

impl<'ctx> FromLLVMBlock for Block<'ctx> {
  fn from_llvm(ptr: LLVMBasicBlockRef) -> Self {
    Block(ptr, PhantomData)
  }
}

#[doc(hidden)]
pub struct BlockInstructionIterator<'ctx> {
  curr_instr: Option<LLVMValueRef>,
  marker: PhantomData<&'ctx ()>,
}

impl<'ctx> Iterator for BlockInstructionIterator<'ctx> {
  type Item = Instruction<'ctx>;

  fn next(&mut self) -> Option<Self::Item> {
    match self.curr_instr {
      Some(curr_instr_ptr) => {
        let result = Some(Instruction::from_llvm(curr_instr_ptr));
        let next_ptr = unsafe { LLVMGetNextInstruction(curr_instr_ptr) };
        if next_ptr.is_null() {
          self.curr_instr = None;
        } else {
          self.curr_instr = Some(next_ptr);
        }
        result
      }
      None => None,
    }
  }
}