quil_rs/program/

type_check.rs

//! Type check Quil programs.
//!
//! See the [Quil spec](https://quil-lang.github.io/).

// TODO (#452): Address large result types.
#![allow(clippy::result_large_err)]

use std::fmt::Debug;

use indexmap::IndexMap;
use thiserror::Error;

use crate::{
    expression::{Expression, FunctionCallExpression, InfixExpression, PrefixExpression},
    instruction::{
        Arithmetic, ArithmeticOperand, ArithmeticOperator, BinaryLogic, BinaryOperand,
        BinaryOperator, Comparison, ComparisonOperand, ComparisonOperator, Exchange, Instruction,
        Load, MemoryReference, Move, ScalarType, SetFrequency, SetPhase, SetScale, ShiftFrequency,
        ShiftPhase, Store, UnaryLogic, UnaryOperator,
    },
    program::MemoryRegion,
    quil::Quil,
    Program,
};

/// Different types of errors that can occur during type checking.
#[derive(Debug, Error)]
pub enum TypeError {
    #[error("In instruction {instruction}: undefined memory reference {reference}.", instruction=.instruction.to_quil_or_debug())]
    UndefinedMemoryReference {
        instruction: Instruction,
        reference: String,
    },

    #[error(
        "In instruction {instruction}: data type mismatch; {dst} is of type {dst_type}, while {src} is of type {src_type}.", instruction=.instruction.to_quil_or_debug()
    )]
    DataTypeMismatch {
        instruction: Instruction,
        dst: String,
        dst_type: String,
        src: String,
        src_type: String,
    },

    #[error(
        "In instruction {instruction}: required a real value, but {value} has type {data_type}.", instruction=.instruction.to_quil_or_debug()
    )]
    RealValueRequired {
        instruction: Instruction,
        value: String,
        data_type: String,
    },

    #[error(
        "In instruction {instruction}: {operator} can only work with {correct_type} data, but operand {operand} has type {data_type}.", instruction=.instruction.to_quil_or_debug()
    )]
    OperatorOperandMismatch {
        instruction: Instruction,
        operator: String,
        correct_type: String,
        operand: String,
        data_type: String,
    },
}

pub type TypeResult<T> = Result<T, TypeError>;

/// Check that the instructions of the given program obey the spec with regards to data types.
///
/// See the [Quil spec](https://quil-lang.github.io/).
pub fn type_check(program: &Program) -> TypeResult<()> {
    for instruction in &program.instructions {
        match instruction {
            Instruction::SetFrequency(SetFrequency { frequency, .. }) => {
                should_be_real(instruction, frequency, &program.memory_regions)?
            }
            Instruction::SetPhase(SetPhase { phase, .. }) => {
                should_be_real(instruction, phase, &program.memory_regions)?
            }
            Instruction::SetScale(SetScale { scale, .. }) => {
                should_be_real(instruction, scale, &program.memory_regions)?
            }
            Instruction::ShiftFrequency(ShiftFrequency { frequency, .. }) => {
                should_be_real(instruction, frequency, &program.memory_regions)?
            }
            Instruction::ShiftPhase(ShiftPhase { phase, .. }) => {
                should_be_real(instruction, phase, &program.memory_regions)?
            }
            Instruction::Arithmetic(Arithmetic {
                operator,
                destination,
                source,
            }) => type_check_arithmetic(
                instruction,
                operator,
                destination,
                source,
                &program.memory_regions,
            )?,
            Instruction::Comparison(Comparison {
                operator,
                destination,
                lhs,
                rhs,
            }) => type_check_comparison(
                instruction,
                operator,
                destination,
                lhs,
                rhs,
                &program.memory_regions,
            )?,
            Instruction::BinaryLogic(BinaryLogic {
                operator,
                destination,
                source,
            }) => type_check_binary_logic(
                instruction,
                operator,
                destination,
                source,
                &program.memory_regions,
            )?,
            Instruction::UnaryLogic(UnaryLogic { operator, operand }) => {
                type_check_unary_logic(instruction, operator, operand, &program.memory_regions)?
            }
            Instruction::Move(Move {
                destination,
                source,
            }) => type_check_move(instruction, destination, source, &program.memory_regions)?,
            Instruction::Exchange(Exchange { left, right }) => {
                type_check_exchange(instruction, left, right, &program.memory_regions)?
            }
            Instruction::Load(Load {
                destination,
                source,
                offset,
            }) => type_check_load(
                instruction,
                destination,
                source,
                offset,
                &program.memory_regions,
            )?,
            Instruction::Store(Store {
                destination,
                offset,
                source,
            }) => type_check_store(
                instruction,
                destination,
                offset,
                source,
                &program.memory_regions,
            )?,
            _ => {}
        }
    }
    Ok(())
}

/// A convenient way to construct a TypeError.
fn undefined_memory_reference(instruction: &Instruction, reference: impl Debug) -> TypeResult<()> {
    Err(TypeError::UndefinedMemoryReference {
        instruction: instruction.clone(),
        reference: format!("{reference:#?}"),
    })
}

/// A convenient way to construct a TypeError.
fn data_type_mismatch(
    instruction: &Instruction,
    dst: impl Debug,
    dst_type: impl Debug,
    src: impl Debug,
    src_type: impl Debug,
) -> TypeResult<()> {
    Err(TypeError::DataTypeMismatch {
        instruction: instruction.clone(),
        dst: format!("{dst:#?}"),
        dst_type: format!("{dst_type:#?}"),
        src: format!("{src:#?}"),
        src_type: format!("{src_type:#?}"),
    })
}

/// A convenient way to construct a TypeError.
fn real_value_required(
    instruction: &Instruction,
    value: impl Debug,
    data_type: impl Debug,
) -> TypeResult<()> {
    Err(TypeError::RealValueRequired {
        instruction: instruction.clone(),
        value: format!("{value:#?}"),
        data_type: format!("#{data_type:#?}"),
    })
}

/// A convenient way to construct a TypeError.
fn operator_operand_mismatch(
    instruction: &Instruction,
    operator: impl Debug,
    correct_type: impl Debug,
    operand: impl Debug,
    data_type: impl Debug,
) -> TypeResult<()> {
    Err(TypeError::OperatorOperandMismatch {
        instruction: instruction.clone(),
        operator: format!("{operator:#?}"),
        correct_type: format!("{correct_type:#?}"),
        operand: format!("{operand:#?}"),
        data_type: format!("{data_type:#?}"),
    })
}

/// In the [Instruction], the given [Expression] should be real-valued.
fn should_be_real(
    instruction: &Instruction,
    this_expression: &Expression,
    memory_regions: &IndexMap<String, MemoryRegion>,
) -> TypeResult<()> {
    match this_expression {
        Expression::Address(reference) => {
            if let Some(MemoryRegion { size, .. }) = memory_regions.get(&reference.name) {
                let dt = &size.data_type;
                if dt == &ScalarType::Real {
                    Ok(())
                } else {
                    real_value_required(instruction, reference, dt)
                }
            } else {
                undefined_memory_reference(instruction, reference)
            }
        }
        Expression::FunctionCall(FunctionCallExpression { expression, .. }) => {
            should_be_real(instruction, expression, memory_regions)
        }
        Expression::Infix(InfixExpression { left, right, .. }) => should_be_real(
            instruction,
            left,
            memory_regions,
        )
        .and(should_be_real(instruction, right, memory_regions)),
        Expression::Number(value) => {
            if value.im.abs() > f64::EPSILON {
                real_value_required(instruction, this_expression, "`imaginary`")
            } else {
                Ok(())
            }
        }
        Expression::PiConstant() => Ok(()),
        Expression::Prefix(PrefixExpression { expression, .. }) => {
            should_be_real(instruction, expression, memory_regions)
        }
        Expression::Variable(_) => real_value_required(instruction, this_expression, "`variable`"),
    }
}

/// Type check an [Instruction::Arithmetic].
fn type_check_arithmetic(
    instruction: &Instruction,
    operator: &ArithmeticOperator,
    destination: &MemoryReference,
    source: &ArithmeticOperand,
    memory_regions: &IndexMap<String, MemoryRegion>,
) -> TypeResult<()> {
    if let Some(dest_region) = memory_regions.get(&destination.name) {
        let dt = &dest_region.size.data_type;
        match (source, dt) {
            (ArithmeticOperand::LiteralInteger(_), ScalarType::Integer) => Ok(()),
            (ArithmeticOperand::LiteralReal(_), ScalarType::Real) => Ok(()),
            (ArithmeticOperand::LiteralInteger(_), ScalarType::Real) => {
                data_type_mismatch(instruction, destination, dt, source, "`literal integer`")
            }
            (ArithmeticOperand::LiteralReal(_), _) => {
                data_type_mismatch(instruction, destination, dt, source, "`literal real`")
            }
            (_, ScalarType::Bit) | (_, ScalarType::Octet) => operator_operand_mismatch(
                instruction,
                operator,
                "real or integral-valued",
                destination,
                dt,
            ),
            (ArithmeticOperand::MemoryReference(src_ref), _) => {
                if let Some(src_region) = memory_regions.get(&src_ref.name) {
                    let st = &src_region.size.data_type;
                    match st {
                        ScalarType::Bit | ScalarType::Octet => operator_operand_mismatch(
                            instruction,
                            operator,
                            "real or integral-valued",
                            src_ref,
                            st,
                        ),
                        st if dt != st => {
                            data_type_mismatch(instruction, destination, dt, src_ref, st)
                        }
                        _ => Ok(()),
                    }
                } else {
                    undefined_memory_reference(instruction, src_ref)
                }
            }
        }
    } else {
        undefined_memory_reference(instruction, destination)
    }
}

/// Type check an [Instruction::Comparison].
fn type_check_comparison(
    instruction: &Instruction,
    operator: &ComparisonOperator,
    destination: &MemoryReference,
    lhs: &MemoryReference,
    rhs: &ComparisonOperand,
    memory_regions: &IndexMap<String, MemoryRegion>,
) -> TypeResult<()> {
    match (
        memory_regions.get(&destination.name),
        memory_regions.get(&lhs.name),
    ) {
        (None, _) => undefined_memory_reference(instruction, destination),
        (_, None) => undefined_memory_reference(instruction, lhs),
        (Some(destination_region), Some(lhs_region)) => {
            match destination_region.size.data_type {
                ScalarType::Bit => (),
                destination_ty @ (ScalarType::Integer | ScalarType::Octet | ScalarType::Real) => {
                    operator_operand_mismatch(
                        instruction,
                        operator,
                        "bit",
                        destination,
                        destination_ty,
                    )?
                }
            };
            let lhs_ty = &lhs_region.size.data_type;
            match (lhs_ty, rhs) {
                (ScalarType::Real, ComparisonOperand::LiteralInteger(_)) => {
                    data_type_mismatch(instruction, lhs, lhs_ty, rhs, "`literal integer`")
                }
                (_, ComparisonOperand::LiteralReal(_)) if lhs_ty != &ScalarType::Real => {
                    data_type_mismatch(instruction, lhs, lhs_ty, rhs, "`literal real`")
                }
                (_, ComparisonOperand::MemoryReference(rhs_ref)) => {
                    if let Some(rhs_region) = memory_regions.get(&rhs_ref.name) {
                        let rhs_ty = &rhs_region.size.data_type;
                        if lhs_ty != rhs_ty {
                            data_type_mismatch(instruction, lhs, lhs_ty, rhs, rhs_ty)
                        } else {
                            Ok(())
                        }
                    } else {
                        undefined_memory_reference(instruction, rhs_ref)
                    }
                }
                _ => Ok(()),
            }
        }
    }
}

fn type_check_binary_logic_memory_reference(
    instruction: &Instruction,
    operator: &BinaryOperator,
    reference: &MemoryReference,
    memory_regions: &IndexMap<String, MemoryRegion>,
) -> TypeResult<()> {
    if let Some(region) = memory_regions.get(&reference.name) {
        match &region.size.data_type {
            ScalarType::Bit | ScalarType::Integer | ScalarType::Octet => Ok(()),
            ty @ ScalarType::Real => {
                operator_operand_mismatch(instruction, operator, "integral", reference, ty)
            }
        }
    } else {
        undefined_memory_reference(instruction, reference)
    }
}

/// Type check an [Instruction::BinaryLogic].
fn type_check_binary_logic(
    instruction: &Instruction,
    operator: &BinaryOperator,
    destination: &MemoryReference,
    source: &BinaryOperand,
    memory_regions: &IndexMap<String, MemoryRegion>,
) -> TypeResult<()> {
    type_check_binary_logic_memory_reference(instruction, operator, destination, memory_regions)?;
    match source {
        BinaryOperand::LiteralInteger(_) => Ok(()),
        BinaryOperand::MemoryReference(source_ref) => type_check_binary_logic_memory_reference(
            instruction,
            operator,
            source_ref,
            memory_regions,
        ),
    }
}

/// Type check an [Instruction::UnaryLogic].
fn type_check_unary_logic(
    instruction: &Instruction,
    operator: &UnaryOperator,
    operand: &MemoryReference,
    memory_regions: &IndexMap<String, MemoryRegion>,
) -> TypeResult<()> {
    if let Some(MemoryRegion { size, .. }) = memory_regions.get(&operand.name) {
        let dt = &size.data_type;
        match (dt, operator) {
            (ScalarType::Real, UnaryOperator::Not) => {
                operator_operand_mismatch(instruction, operator, "integral", operand, dt)
            }
            (ScalarType::Bit, UnaryOperator::Neg) | (ScalarType::Octet, UnaryOperator::Neg) => {
                operator_operand_mismatch(
                    instruction,
                    operator,
                    "real or integral-valued",
                    operand,
                    dt,
                )
            }
            (ScalarType::Real, UnaryOperator::Neg) | (ScalarType::Integer, UnaryOperator::Neg) => {
                Ok(())
            }
            (ScalarType::Integer, UnaryOperator::Not)
            | (ScalarType::Bit, UnaryOperator::Not)
            | (ScalarType::Octet, UnaryOperator::Not) => Ok(()),
        }
    } else {
        undefined_memory_reference(instruction, operand)
    }
}

/// Type check an [Instruction::Move].
fn type_check_move(
    instruction: &Instruction,
    destination: &MemoryReference,
    source: &ArithmeticOperand,
    memory_regions: &IndexMap<String, MemoryRegion>,
) -> TypeResult<()> {
    if let Some(dest_region) = memory_regions.get(&destination.name) {
        let dt = &dest_region.size.data_type;
        match (source, dt) {
            (ArithmeticOperand::LiteralInteger(_), ScalarType::Real) => {
                data_type_mismatch(instruction, destination, dt, source, "`literal integer`")
            }
            (ArithmeticOperand::LiteralReal(_), st) if st != &ScalarType::Real => {
                data_type_mismatch(instruction, destination, dt, source, "`literal real`")
            }
            (ArithmeticOperand::MemoryReference(src_ref), dt) => {
                if let Some(src_region) = memory_regions.get(&src_ref.name) {
                    let st = &src_region.size.data_type;
                    if st != dt {
                        data_type_mismatch(instruction, destination, dt, source, st)
                    } else {
                        Ok(())
                    }
                } else {
                    undefined_memory_reference(instruction, src_ref)
                }
            }
            _ => Ok(()),
        }
    } else {
        undefined_memory_reference(instruction, destination)
    }
}

/// Type check an [Instruction::Exchange].
fn type_check_exchange(
    instruction: &Instruction,
    left: &MemoryReference,
    right: &MemoryReference,
    memory_regions: &IndexMap<String, MemoryRegion>,
) -> TypeResult<()> {
    match (
        memory_regions.get(&left.name),
        memory_regions.get(&right.name),
    ) {
        (None, _) => undefined_memory_reference(instruction, left),
        (_, None) => undefined_memory_reference(instruction, right),
        (Some(left_region), Some(right_region)) => {
            let (lt, rt) = (&left_region.size.data_type, &right_region.size.data_type);
            if lt != rt {
                data_type_mismatch(instruction, left, lt, right, rt)
            } else {
                Ok(())
            }
        }
    }
}

/// Type check an [Instruction::Load].
fn type_check_load(
    instruction: &Instruction,
    destination: &MemoryReference,
    source: &str,
    offset: &MemoryReference,
    memory_regions: &IndexMap<String, MemoryRegion>,
) -> TypeResult<()> {
    match (
        memory_regions.get(&destination.name),
        memory_regions.get(source),
        memory_regions.get(&offset.name),
    ) {
        (None, _, _) => undefined_memory_reference(instruction, destination),
        (_, None, _) => undefined_memory_reference(instruction, source),
        (_, _, None) => undefined_memory_reference(instruction, offset),
        (Some(dest_region), Some(src_region), Some(offset_region)) => {
            let (dt, st, ot) = (
                &dest_region.size.data_type,
                &src_region.size.data_type,
                &offset_region.size.data_type,
            );
            if ot != &ScalarType::Integer {
                operator_operand_mismatch(instruction, "LOAD", "integral", offset, ot)
            } else if dt != st {
                data_type_mismatch(instruction, destination, dt, source, st)
            } else {
                Ok(())
            }
        }
    }
}

/// type check an [Instruction::Store].
fn type_check_store(
    instruction: &Instruction,
    destination: &str,
    offset: &MemoryReference,
    source: &ArithmeticOperand,
    memory_regions: &IndexMap<String, MemoryRegion>,
) -> TypeResult<()> {
    let dest_region =
        memory_regions
            .get(destination)
            .ok_or(TypeError::UndefinedMemoryReference {
                instruction: instruction.clone(),
                reference: destination.to_string(),
            })?;
    memory_regions
        .get(&offset.name)
        .ok_or(TypeError::UndefinedMemoryReference {
            instruction: instruction.clone(),
            reference: offset.name.clone(),
        })
        .and_then(|m| {
            if m.size.data_type != ScalarType::Integer {
                operator_operand_mismatch(
                    instruction,
                    "STORE",
                    "integral",
                    offset,
                    m.size.data_type,
                )
            } else {
                Ok(())
            }
        })?;

    match (source, &dest_region.size.data_type) {
        (ArithmeticOperand::MemoryReference(source_ref), dt) => {
            match memory_regions.get(&source_ref.name) {
                None => undefined_memory_reference(instruction, offset),
                Some(source_region) => {
                    // https://quil-lang.github.io/#6-5Classical-Instructions
                    // # Perform an indirect store of a to x offset by n.
                    // STORE    x n a          # x[n] := a
                    //      <oct*> <int> <oct>
                    //      <oct*> <int> <!int>
                    //      <int*> <int> <int>
                    //      <int*> <int> <!int>
                    //      <real*> <int> <real>
                    //      <real*> <int> <!real>
                    //      <bit*> <int> <bit>
                    //      <bit*> <int> <!int>

                    // <d*> <int> <s>  => check that d & s match
                    let st = &source_region.size.data_type;
                    if st == dt {
                        Ok(())
                    } else {
                        data_type_mismatch(instruction, source_ref, st, destination, dt)
                    }
                }
            }
        }
        (ArithmeticOperand::LiteralInteger(_), ScalarType::Octet) => Ok(()),
        // <int*> <int> <!int>
        (ArithmeticOperand::LiteralInteger(_), ScalarType::Integer) => Ok(()),
        // <real*> <int> <!real>
        (ArithmeticOperand::LiteralReal(_), ScalarType::Real) => Ok(()),
        // <bit*> <int> <!bit>
        (ArithmeticOperand::LiteralInteger(_), ScalarType::Bit) => Ok(()),
        // Mismatches
        (ArithmeticOperand::LiteralInteger(_), dt) => {
            data_type_mismatch(instruction, source, "`literal integer`", destination, dt)
        }
        (ArithmeticOperand::LiteralReal(_), dt) => {
            data_type_mismatch(instruction, source, "`literal real`", destination, dt)
        }
    }
}

#[cfg(test)]
#[allow(clippy::too_many_arguments)]
mod tests {
    use super::*;
    use crate::Program;
    use rstest::*;
    use std::str::FromStr;

    #[rstest]
    fn test_sets_and_shifts(
        #[values("x", "y")] declared: &str,
        #[values("REAL", "INTEGER", "BIT", "OCTET")] datatype: &str,
        #[values(
            "SET-FREQUENCY",
            "SET-PHASE",
            "SET-SCALE",
            "SHIFT-FREQUENCY",
            "SHIFT-PHASE"
        )]
        command: &str,
        #[values("x", "y")] referenced: &str,
    ) {
        let p = Program::from_str(&format!(
            r#"
DECLARE {declared} {datatype}
{command} 0 "xy" {referenced}
"#
        )).unwrap_or_else(|_| panic!("Bad program with (declared, datatype, command, referenced) = ({declared}, {datatype}, {command}, {referenced})."));
        assert_eq!(
            type_check(&p).is_ok(),
            declared == referenced && datatype == "REAL"
        );
    }

    #[rstest]
    fn test_arithmetic_memory_references(
        #[values("REAL", "INTEGER", "BIT", "OCTET")] dst_type: &str,
        #[values("REAL", "INTEGER", "BIT", "OCTET")] src_type: &str,
        #[values("ADD", "SUB", "MUL", "DIV")] command: &str,
    ) {
        let p = Program::from_str(&format!(
            r#"
DECLARE destination {dst_type}
DECLARE source {src_type}
{command} destination source
"#
        )).unwrap_or_else(|_| panic!("Bad arithmetic program with (command, dst_type, src_type) = ({command}, {dst_type}, {src_type})."));
        assert_eq!(
            type_check(&p).is_ok(),
            dst_type == src_type && ["REAL", "INTEGER"].contains(&dst_type)
        );
    }

    #[rstest]
    fn test_arithmetic_immediate_values(
        #[values("REAL", "INTEGER", "BIT", "OCTET")] dst_type: &str,
        #[values("ADD", "SUB", "MUL", "DIV")] command: &str,
        #[values("1", "1.0")] value: &str,
    ) {
        let p = Program::from_str(&format!(
                r#"
DECLARE destination {dst_type}
{command} destination {value}
"#
        )).unwrap_or_else(|_| panic!("Bad ARITHMETIC program with (command, dst_type, value) = ({command}, {dst_type}, {value})."));
        let (f, i) = (f64::from_str(value), i64::from_str(value));
        assert_eq!(
            type_check(&p).is_ok(),
            (dst_type == "REAL" && f.is_ok() && i.is_err()) || (dst_type == "INTEGER" && i.is_ok())
        );
    }

    #[rstest]
    fn test_comparison_memory_references(
        #[values("REAL", "INTEGER", "BIT", "OCTET")] dst_type: &str,
        #[values("REAL", "INTEGER", "BIT", "OCTET")] left_type: &str,
        #[values("REAL", "INTEGER", "BIT", "OCTET")] right_type: &str,
        #[values("EQ", "GT", "GE", "LT", "LE")] comparison: &str,
    ) {
        let p = Program::from_str(&format!(
                                r#"
DECLARE destination {dst_type}
DECLARE left {left_type}
DECLARE right {right_type}
{comparison} destination left right
"#
        )).unwrap_or_else(|_| panic!("Bad comparison program with (dst_type, left_type, right_type, comparison) = ({dst_type}, {left_type}, {right_type}, {comparison})."));
        assert_eq!(
            type_check(&p).is_ok(),
            dst_type == "BIT" && left_type == right_type
        );
    }

    #[rstest]
    fn test_comparison_immediate_values(
        #[values("REAL", "INTEGER", "BIT", "OCTET")] dst_type: &str,
        #[values("REAL", "INTEGER", "BIT", "OCTET")] left_type: &str,
        #[values("EQ", "GT", "GE", "LT", "LE")] comparison: &str,
        #[values("1.0", "1")] value: &str,
    ) {
        let p = Program::from_str(&format!(
                                r#"
DECLARE destination {dst_type}
DECLARE left {left_type}
{comparison} destination left {value}
"#
        )).unwrap_or_else(|_| panic!("Bad comparison program with (dst_type, left_type, comparison, value) = ({dst_type}, {left_type}, {comparison}, {value})."));
        let (f, i) = (f64::from_str(value), i64::from_str(value));
        assert_eq!(
            type_check(&p).is_ok(),
            dst_type == "BIT"
                && ((left_type == "REAL" && f.is_ok() && i.is_err())
                    || (left_type != "REAL" && i.is_ok()))
        );
    }

    #[rstest]
    fn test_binary_logic_memory_references(
        #[values("x")] dst_decl: &str,
        #[values("REAL", "INTEGER", "BIT", "OCTET")] dst_type: &str,
        #[values("y")] src_decl: &str,
        #[values("REAL", "INTEGER", "BIT", "OCTET")] src_type: &str,
        #[values("AND", "IOR", "XOR")] operator: &str,
        #[values("x", "not_x")] dst_ref: &str,
        #[values("y", "not_y")] src_ref: &str,
    ) {
        let p = Program::from_str(&format!(
                r#"
DECLARE {dst_decl} {dst_type}
DECLARE {src_decl} {src_type}
{operator} {dst_ref} {src_ref}
"#
        )).unwrap_or_else(|_| panic!("Bad bianry logic program with (dst_decl, dst_type, src_decl, src_type, operator, dst_ref, src_ref) = ({dst_decl}, {dst_type}, {src_decl}, {src_type}, {operator}, {dst_ref}, {src_ref})."));
        assert_eq!(
            type_check(&p).is_ok(),
            dst_type != "REAL" && src_type != "REAL" && dst_decl == dst_ref && src_decl == src_ref
        );
    }

    #[rstest]
    fn test_binary_logic_immediate_values(
        #[values("x")] dst_decl: &str,
        #[values("REAL", "INTEGER", "BIT", "OCTET")] dst_type: &str,
        #[values("AND", "IOR", "XOR")] operator: &str,
        #[values("x", "not_x")] dst_ref: &str,
    ) {
        let p = Program::from_str(&format!(
                r#"
DECLARE {dst_decl} {dst_type}
{operator} {dst_ref} 1
"#
            )).unwrap_or_else(|_| panic!("Bad binary logic program with (dst_decl, dst_type, operator, dst_ref) = ({dst_decl}, {dst_type}, {operator}, {dst_ref})."));
        assert_eq!(
            type_check(&p).is_ok(),
            dst_type != "REAL" && dst_ref == dst_decl
        );
    }

    #[rstest]
    fn test_unary_logic(
        #[values("x")] destination: &str,
        #[values("REAL", "INTEGER", "BIT", "OCTET")] datatype: &str,
        #[values("NEG", "NOT")] operator: &str,
        #[values("x", "not_x")] reference: &str,
    ) {
        let p = Program::from_str(&format!(
                r#"
DECLARE {destination} {datatype}
{operator} {reference}
"#
        )).unwrap_or_else(|_| panic!("Bad unary program with (destination, datatype, operator, reference) = ({destination}, {datatype}, {operator}, {reference}"));
        assert_eq!(
            type_check(&p).is_ok(),
            destination == reference
                && ((["REAL", "INTEGER"].contains(&datatype) && operator == "NEG")
                    || (["INTEGER", "BIT", "OCTET"].contains(&datatype) && operator == "NOT"))
        );
    }

    #[rstest]
    fn test_move_memory_references(
        #[values("x")] dst_decl: &str,
        #[values("REAL", "INTEGER", "BIT", "OCTET")] dst_type: &str,
        #[values("y")] src_decl: &str,
        #[values("REAL", "INTEGER", "BIT", "OCTET")] src_type: &str,
        #[values("x", "not_x")] dst_ref: &str,
        #[values("y", "not_y")] src_ref: &str,
    ) {
        let p = Program::from_str(&format!(
            r#"
DECLARE {dst_decl} {dst_type}
DECLARE {src_decl} {src_type}
MOVE {dst_ref} {src_ref}
"#
        )).unwrap_or_else(|_| panic!("Bad MOVE program with (dst_decl, dst_type, src_decl, src_type, dst_ref, src_ref) = ({dst_decl}, {dst_type}, {src_decl}, {src_type}, {dst_ref}, {src_ref})."));
        assert_eq!(
            type_check(&p).is_ok(),
            dst_type == src_type && dst_decl == dst_ref && src_decl == src_ref
        );
    }

    #[rstest]
    fn test_move_immediate_values(
        #[values("REAL", "INTEGER", "BIT", "OCTET")] dst_type: &str,
        #[values("1", "1.0")] value: &str,
    ) {
        let p = Program::from_str(&format!(
            r#"
DECLARE destination {dst_type}
MOVE destination {value}
"#
        ))
        .unwrap_or_else(|_| {
            panic!("Bad MOVE program with (dst_type, source) = ({dst_type}, {value}).")
        });
        let (f, i) = (f64::from_str(value), i64::from_str(value));
        assert_eq!(
            type_check(&p).is_ok(),
            (dst_type == "REAL" && f.is_ok() && i.is_err()) || (dst_type != "REAL" && i.is_ok())
        );
    }

    #[rstest]
    fn test_exchange(
        #[values("x")] left_decl: &str,
        #[values("REAL", "INTEGER", "BIT", "OCTET")] left_type: &str,
        #[values("y")] right_decl: &str,
        #[values("REAL", "INTEGER", "BIT", "OCTET")] right_type: &str,
        #[values("x", "not_x")] left_ref: &str,
        #[values("y", "not_y")] right_ref: &str,
    ) {
        let p = Program::from_str(&format!(
                r#"
DECLARE {left_decl} {left_type}
DECLARE {right_decl} {right_type}
EXCHANGE {left_ref} {right_ref}
"#
        )).unwrap_or_else(|_| panic!("Bad EXCHANGE program with (left_decl, left_type, right_decl, right_type, left_ref, right_ref) = ({left_decl}, {left_type}, {right_decl}, {right_type}, {left_ref}, {right_ref})."));
        assert_eq!(
            type_check(&p).is_ok(),
            left_decl == left_ref && right_decl == right_ref && left_type == right_type
        );
    }

    #[rstest]
    fn test_load(
        #[values("x")] dst_decl: &str,
        #[values("REAL", "INTEGER", "BIT", "OCTET")] dst_type: &str,
        #[values("y")] src_decl: &str,
        #[values("REAL", "INTEGER", "BIT", "OCTET")] src_type: &str,
        #[values("z")] offset_decl: &str,
        #[values("REAL", "INTEGER", "BIT", "OCTET")] offset_type: &str,
        #[values("x", "not_z")] dst_ref: &str,
        #[values("y", "not_y")] src_ref: &str,
        #[values("z", "not_z")] offset_ref: &str,
    ) {
        let p = Program::from_str(&format!(
                r#"
DECLARE {dst_decl} {dst_type}
DECLARE {src_decl} {src_type}
DECLARE {offset_decl} {offset_type}
LOAD {dst_ref} {src_ref} {offset_ref}
"#
        )).unwrap_or_else(|_| panic!("Bad LOAD program with (dst_decl, dst_type, src_decl, src_type, offset_decl, offset_type, dst_ref, src_ref, offset_ref) = ({dst_decl}, {dst_type}, {src_decl}, {src_type}, {offset_decl}, {offset_type}, {dst_ref}, {src_ref}, {offset_ref})."));
        assert_eq!(
            type_check(&p).is_ok(),
            (dst_decl == dst_ref && src_decl == src_ref && offset_decl == offset_ref)
                && (dst_type == src_type)
                && (offset_type == "INTEGER")
        );
    }

    #[rstest]
    fn test_store_memory_references(
        #[values("x")] dst_decl: &str,
        #[values("REAL", "INTEGER", "BIT", "OCTET")] dst_type: &str,
        #[values("y")] src_decl: &str,
        #[values("REAL", "INTEGER", "BIT", "OCTET")] src_type: &str,
        #[values("z")] offset_decl: &str,
        #[values("REAL", "INTEGER", "BIT", "OCTET")] offset_type: &str,
        #[values("x", "not_z")] dst_ref: &str,
        #[values("y", "not_y")] src_ref: &str,
        #[values("z", "not_z")] offset_ref: &str,
    ) {
        let p = Program::from_str(&format!(
                r#"
DECLARE {dst_decl} {dst_type}
DECLARE {src_decl} {src_type}
DECLARE {offset_decl} {offset_type}
STORE {dst_ref} {offset_ref} {src_ref}
"#
        )).unwrap_or_else(|_| panic!("Bad STORE program with (dst_decl, dst_type, src_decl, src_type, offset_decl, offset_type, dst_ref, src_ref, offset_ref) = ({dst_decl}, {dst_type}, {src_decl}, {src_type}, {offset_decl}, {offset_type}, {dst_ref}, {src_ref}, {offset_ref})."));
        assert_eq!(
            type_check(&p).is_ok(),
            (dst_decl == dst_ref && src_decl == src_ref && offset_decl == offset_ref)
                && (dst_type == src_type)
                && (offset_type == "INTEGER")
        );
    }

    #[rstest]
    fn test_store_immediate_values(
        #[values("x")] dst_decl: &str,
        #[values("REAL", "INTEGER", "BIT", "OCTET")] dst_type: &str,
        #[values("1.0", "1")] value: &str,
        #[values("z")] offset_decl: &str,
        #[values("REAL", "INTEGER", "BIT", "OCTET")] offset_type: &str,
        #[values("x", "not_z")] dst_ref: &str,
        #[values("z", "not_z")] offset_ref: &str,
    ) {
        let p = Program::from_str(&format!(
                r#"
DECLARE {dst_decl} {dst_type}
DECLARE {offset_decl} {offset_type}
STORE {dst_ref} {offset_ref} {value}
"#
        )).unwrap_or_else(|e| panic!("Bad STORE program with (dst_decl, dst_type, value, offset_decl, offset_type, dst_ref, offset_ref) = ({dst_decl}, {dst_type}, {value}, {offset_decl}, {offset_type}, {dst_ref}, {offset_ref}).: {e}"));
        let (f, i) = (f64::from_str(value), i64::from_str(value));
        assert_eq!(
            type_check(&p).is_ok(),
            (dst_decl == dst_ref && offset_decl == offset_ref)
                && ((dst_type == "REAL" && f.is_ok() && i.is_err())
                    || (dst_type != "REAL" && i.is_ok()))
                && (offset_type == "INTEGER")
        );
    }
}