vrl/compiler/expression/
variable.rs

use crate::diagnostic::{DiagnosticMessage, Label};
use crate::value::Value;
use std::fmt;

use crate::compiler::state::{TypeInfo, TypeState};
use crate::compiler::{
    expression::{levenstein, Resolved},
    parser::ast::Ident,
    state::LocalEnv,
    Context, Expression, Span, TypeDef,
};

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Variable {
    ident: Ident,
}

impl Variable {
    pub(crate) fn new(span: Span, ident: Ident, local: &LocalEnv) -> Result<Self, Error> {
        if local.variable(&ident).is_none() {
            let idents = local
                .variable_idents()
                .map(std::clone::Clone::clone)
                .collect::<Vec<_>>();

            return Err(Error::undefined(ident, span, idents));
        }

        Ok(Self { ident })
    }

    #[must_use]
    pub fn ident(&self) -> &Ident {
        &self.ident
    }
}

impl Expression for Variable {
    fn resolve(&self, ctx: &mut Context) -> Resolved {
        Ok(ctx
            .state()
            .variable(&self.ident)
            .cloned()
            .unwrap_or(Value::Null))
    }

    fn resolve_constant(&self, state: &TypeState) -> Option<Value> {
        state
            .local
            .variable(self.ident())
            .and_then(|details| details.value.clone())
    }

    fn type_info(&self, state: &TypeState) -> TypeInfo {
        let result = state
            .local
            .variable(&self.ident)
            .map_or_else(|| TypeDef::undefined().infallible(), |d| d.type_def.clone());

        TypeInfo::new(state, result)
    }
}

impl fmt::Display for Variable {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        self.ident.fmt(f)
    }
}

#[derive(Debug)]
pub(crate) struct Error {
    variant: ErrorVariant,
    ident: Ident,
    span: Span,
}

impl Error {
    fn undefined(ident: Ident, span: Span, idents: Vec<Ident>) -> Self {
        Error {
            variant: ErrorVariant::Undefined { idents },
            ident,
            span,
        }
    }
}

#[derive(thiserror::Error, Debug)]
pub(crate) enum ErrorVariant {
    #[error("call to undefined variable")]
    Undefined { idents: Vec<Ident> },
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{:#}", self.variant)
    }
}

impl std::error::Error for Error {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        Some(&self.variant)
    }
}

impl DiagnosticMessage for Error {
    fn code(&self) -> usize {
        use ErrorVariant::Undefined;

        match &self.variant {
            Undefined { .. } => 701,
        }
    }

    fn labels(&self) -> Vec<Label> {
        use ErrorVariant::Undefined;

        match &self.variant {
            Undefined { idents } => {
                let mut vec = vec![Label::primary("undefined variable", self.span)];
                let ident_chars = self.ident.as_ref().chars().collect::<Vec<_>>();

                let mut builtin = vec![Ident::new("null"), Ident::new("true"), Ident::new("false")];
                let mut idents = idents.clone();

                idents.append(&mut builtin);

                if let Some((idx, _)) = idents
                    .iter()
                    .map(|possible| {
                        let possible_chars = possible.chars().collect::<Vec<_>>();
                        levenstein::distance(&ident_chars, &possible_chars)
                    })
                    .enumerate()
                    .min_by_key(|(_, score)| *score)
                {
                    {
                        let guessed = &idents[idx];
                        vec.push(Label::context(
                            format!(r#"did you mean "{guessed}"?"#),
                            self.span,
                        ));
                    }
                }

                vec
            }
        }
    }
}

#[cfg(test)]
mod test {
    use crate::compiler::type_def::Details;

    use super::*;

    #[test]
    fn test_resolve_const() {
        let mut state = TypeState::default();
        state.local.insert_variable(
            Ident::new("foo"),
            Details {
                type_def: TypeDef::integer(),
                value: Some(Value::Integer(42)),
            },
        );

        let var = Variable::new((0, 0).into(), Ident::new("foo"), &state.local).unwrap();
        assert_eq!(var.resolve_constant(&state), Some(Value::Integer(42)));
    }
}
vrl/compiler/expression/variable.rs

vrl/compiler/expression/
variable.rs
