gluon_vm 0.18.3

The virtual machine for executing the gluon programming language
Documentation
use std::slice::Iter;

use crate::base::pos::Line;
use crate::base::symbol::Symbol;
use crate::base::types::ArcType;

use crate::types::VmIndex;

#[derive(Debug, Default, Eq, PartialEq, Clone, Hash)]
#[cfg_attr(feature = "serde_derive", derive(Deserialize, Serialize))]
pub struct SourceMap {
    /// The index of the first instruction for each line
    map: Vec<(usize, Line)>,
}

impl SourceMap {
    pub fn new() -> SourceMap {
        SourceMap { map: Vec::new() }
    }

    /// Defines the instruction at `instruction_index` to be at `current_line`.
    /// This function must be called with indexes in increasing order
    pub fn emit(&mut self, instruction_index: usize, current_line: Line) {
        let last_emitted_line = self.map.last().map(|&(_, x)| x);
        if last_emitted_line != Some(current_line) {
            self.map.push((instruction_index, current_line));
        }
    }

    pub fn close(&mut self, instruction_index: usize, current_line: Option<Line>) {
        // Push one final item to indicate the end of the function
        if let Some(current_line) = current_line.or_else(|| self.map.last().map(|t| t.1)) {
            self.map.push((instruction_index, current_line));
        }
    }

    /// Returns the line where the instruction at `instruction_index` were defined
    pub fn line(&self, instruction_index: usize) -> Option<Line> {
        // The line for `instruction_index` is at the last index still larger than
        // the index in `map`
        let p = self
            .map
            .iter()
            .position(|&(index, _)| index > instruction_index)
            .unwrap_or(self.map.len());
        if p == 0
            || (p == self.map.len()
                && instruction_index >= self.map.last().expect("Empty source_map").0)
        {
            // instruction_index is not valid in the function
            None
        } else {
            Some(self.map[p - 1].1)
        }
    }
}

#[derive(Debug, Eq, PartialEq, Clone, Hash)]
#[cfg_attr(feature = "serde_derive", derive(DeserializeState, SerializeState))]
#[cfg_attr(
    feature = "serde_derive",
    serde(
        deserialize_state = "crate::serialization::DeSeed<'gc>",
        de_parameters = "'gc"
    )
)]
#[cfg_attr(
    feature = "serde_derive",
    serde(serialize_state = "crate::serialization::SeSeed")
)]
pub struct Local {
    start: usize,
    end: usize,
    pub index: VmIndex,
    #[cfg_attr(
        feature = "serde_derive",
        serde(state_with = "crate::serialization::symbol")
    )]
    pub name: Symbol,
    #[cfg_attr(
        feature = "serde_derive",
        serde(state_with = "crate::serialization::borrow")
    )]
    pub typ: ArcType,
}

#[derive(Debug, Default, Eq, PartialEq, Clone, Hash)]
#[cfg_attr(feature = "serde_derive", derive(DeserializeState, SerializeState))]
#[cfg_attr(
    feature = "serde_derive",
    serde(
        deserialize_state = "crate::serialization::DeSeed<'gc>",
        de_parameters = "'gc"
    )
)]
#[cfg_attr(
    feature = "serde_derive",
    serde(serialize_state = "crate::serialization::SeSeed")
)]
pub struct LocalMap {
    // Instruction indexes marking [start, end) where the local variable `Symbol` exists
    #[cfg_attr(feature = "serde_derive", serde(state))]
    map: Vec<Local>,
}

impl LocalMap {
    pub fn new() -> LocalMap {
        LocalMap { map: Vec::new() }
    }

    /// Emits a local which is available starting from `instruction_index`. The end of each local's
    /// scope must be defined by calling `close`
    pub fn emit(&mut self, instruction_index: usize, index: VmIndex, name: Symbol, typ: ArcType) {
        self.map.push(Local {
            start: instruction_index,
            end: instruction_index,
            index: index,
            name: name,
            typ: typ,
        });
    }

    /// `close` marks the end of a variables span and should be called for each variable inserted with
    /// `emit` but in reverse order
    pub fn close(&mut self, instruction_index: usize) {
        if let Some(local) = self.map.iter_mut().rev().find(|t| t.start == t.end) {
            local.end = instruction_index;
        }
    }

    /// Returns an iterator over the variables in scope at `instruction_index`
    pub fn locals(&self, instruction_index: usize) -> LocalIter<'_> {
        LocalIter {
            locals: self.map.iter(),
            instruction_index: instruction_index,
        }
    }
}

pub struct LocalIter<'a> {
    locals: Iter<'a, Local>,
    instruction_index: usize,
}

impl<'a> LocalIter<'a> {
    pub fn empty() -> LocalIter<'a> {
        LocalIter {
            locals: [].iter(),
            instruction_index: 0,
        }
    }
}

impl<'a> Iterator for LocalIter<'a> {
    type Item = &'a Local;

    fn next(&mut self) -> Option<&'a Local> {
        while let Some(local) = self.locals.next() {
            if local.start <= self.instruction_index && self.instruction_index < local.end {
                return Some(local);
            }
        }
        None
    }
}