visitor.rs

#![cfg(feature = "std")]

use crate::{
  ast::*,
  token::Value,
  token::{ByteValue, ControlOperator},
};
use std::error::Error;

/// Visitor result
pub type Result<T> = std::result::Result<(), T>;

/// CDDL AST visitor
pub trait Visitor<'a, 'b, E: Error> {
  /// Visit CDDL
  fn visit_cddl(&mut self, cddl: &'b CDDL<'a>) -> Result<E> {
    walk_cddl(self, cddl)
  }

  /// Visit rule
  fn visit_rule(&mut self, rule: &'b Rule<'a>) -> Result<E> {
    walk_rule(self, rule)
  }

  /// Visit identifier
  fn visit_identifier(&mut self, _ident: &Identifier<'a>) -> Result<E> {
    Ok(())
  }

  /// Visit value
  fn visit_value(&mut self, _value: &Value<'a>) -> Result<E> {
    Ok(())
  }

  /// Visit type rule
  fn visit_type_rule(&mut self, tr: &'b TypeRule<'a>) -> Result<E> {
    walk_type_rule(self, tr)
  }

  /// Visit group rule
  fn visit_group_rule(&mut self, gr: &'b GroupRule<'a>) -> Result<E> {
    walk_group_rule(self, gr)
  }

  /// Visit type
  fn visit_type(&mut self, t: &'b Type<'a>) -> Result<E> {
    walk_type(self, t)
  }

  /// Visit type choice
  fn visit_type_choice(&mut self, tc: &'b TypeChoice<'a>) -> Result<E> {
    walk_type_choice(self, tc)
  }

  /// Visit type1
  fn visit_type1(&mut self, t1: &'b Type1<'a>) -> Result<E> {
    walk_type1(self, t1)
  }

  /// Visit operator
  fn visit_operator(&mut self, target: &'b Type1<'a>, o: &'b Operator<'a>) -> Result<E> {
    walk_operator(self, target, o)
  }

  /// Visit rangectlop
  fn visit_rangectlop(
    &mut self,
    op: &'b RangeCtlOp,
    target: &'b Type1<'a>,
    controller: &'b Type2<'a>,
  ) -> Result<E> {
    walk_rangectlop(self, op, target, controller)
  }

  /// Visit range
  fn visit_range(
    &mut self,
    lower: &'b Type2<'a>,
    upper: &'b Type2<'a>,
    _is_inclusive: bool,
  ) -> Result<E> {
    walk_range(self, lower, upper)
  }

  /// Visit control operator
  fn visit_control_operator(
    &mut self,
    target: &'b Type2<'a>,
    _ctrl: ControlOperator,
    controller: &'b Type2<'a>,
  ) -> Result<E> {
    walk_control_operator(self, target, controller)
  }

  /// Visit type2
  fn visit_type2(&mut self, t2: &'b Type2<'a>) -> Result<E> {
    walk_type2(self, t2)
  }

  /// Visit group
  fn visit_group(&mut self, g: &'b Group<'a>) -> Result<E> {
    walk_group(self, g)
  }

  /// Visit group choice
  fn visit_group_choice(&mut self, gc: &'b GroupChoice<'a>) -> Result<E> {
    walk_group_choice(self, gc)
  }

  /// Visit group entry
  fn visit_group_entry(&mut self, entry: &'b GroupEntry<'a>) -> Result<E> {
    walk_group_entry(self, entry)
  }

  /// Visit value member key entry
  fn visit_value_member_key_entry(&mut self, entry: &'b ValueMemberKeyEntry<'a>) -> Result<E> {
    walk_value_member_key_entry(self, entry)
  }

  /// Visit typename/groupname entry
  fn visit_type_groupname_entry(&mut self, entry: &'b TypeGroupnameEntry<'a>) -> Result<E> {
    walk_type_groupname_entry(self, entry)
  }

  /// Visit inline group entry
  fn visit_inline_group_entry(
    &mut self,
    occur: Option<&'b Occurrence<'a>>,
    g: &'b Group<'a>,
  ) -> Result<E> {
    walk_inline_group_entry(self, occur, g)
  }

  /// Visit occurrences
  fn visit_occurrence(&mut self, _o: &'b Occurrence<'a>) -> Result<E> {
    Ok(())
  }

  /// Visit memberkey
  fn visit_memberkey(&mut self, mk: &'b MemberKey<'a>) -> Result<E> {
    walk_memberkey(self, mk)
  }

  /// Visit genericargs
  fn visit_generic_args(&mut self, args: &'b GenericArgs<'a>) -> Result<E> {
    walk_generic_args(self, args)
  }

  /// Visit genericarg
  fn visit_generic_arg(&mut self, arg: &'b GenericArg<'a>) -> Result<E> {
    walk_generic_arg(self, arg)
  }

  /// Visit genericparams
  fn visit_generic_params(&mut self, params: &'b GenericParams<'a>) -> Result<E> {
    walk_generic_params(self, params)
  }

  /// visit genericparam
  fn visit_generic_param(&mut self, param: &'b GenericParam<'a>) -> Result<E> {
    walk_generic_param(self, param)
  }
  /// Visit nonmemberkey
  fn visit_nonmemberkey(&mut self, nmk: &'b NonMemberKey<'a>) -> Result<E> {
    walk_nonmemberkey(self, nmk)
  }
}

/// Walk CDDL
pub fn walk_cddl<'a, 'b, E, V>(visitor: &mut V, cddl: &'b CDDL<'a>) -> Result<E>
where
  E: Error,
  V: Visitor<'a, 'b, E> + ?Sized,
{
  for rule in cddl.rules.iter() {
    visitor.visit_rule(rule)?;
  }

  Ok(())
}

/// Walk rule
pub fn walk_rule<'a, 'b, E, V>(visitor: &mut V, rule: &'b Rule<'a>) -> Result<E>
where
  E: Error,
  V: Visitor<'a, 'b, E> + ?Sized,
{
  match rule {
    Rule::Type { rule, .. } => visitor.visit_type_rule(rule),
    Rule::Group { rule, .. } => visitor.visit_group_rule(rule),
  }
}

/// Walk type rule
pub fn walk_type_rule<'a, 'b, E, V>(visitor: &mut V, tr: &'b TypeRule<'a>) -> Result<E>
where
  E: Error,
  V: Visitor<'a, 'b, E> + ?Sized,
{
  visitor.visit_type(&tr.value)
}

/// Walk group rule
pub fn walk_group_rule<'a, 'b, E, V>(visitor: &mut V, gr: &'b GroupRule<'a>) -> Result<E>
where
  E: Error,
  V: Visitor<'a, 'b, E> + ?Sized,
{
  visitor.visit_group_entry(&gr.entry)
}

/// Walk type
pub fn walk_type<'a, 'b, E, V>(visitor: &mut V, t: &'b Type<'a>) -> Result<E>
where
  E: Error,
  V: Visitor<'a, 'b, E> + ?Sized,
{
  for tc in t.type_choices.iter() {
    visitor.visit_type_choice(tc)?;
  }

  Ok(())
}

/// Walk type choice
pub fn walk_type_choice<'a, 'b, E, V>(visitor: &mut V, tc: &'b TypeChoice<'a>) -> Result<E>
where
  E: Error,
  V: Visitor<'a, 'b, E> + ?Sized,
{
  visitor.visit_type1(&tc.type1)
}

/// Walk type1
pub fn walk_type1<'a, 'b, E, V>(visitor: &mut V, t1: &'b Type1<'a>) -> Result<E>
where
  E: Error,
  V: Visitor<'a, 'b, E> + ?Sized,
{
  if let Some(o) = &t1.operator {
    return visitor.visit_operator(t1, o);
  }

  visitor.visit_type2(&t1.type2)
}

/// Walk operator
pub fn walk_operator<'a, 'b, E, V>(
  visitor: &mut V,
  target: &'b Type1<'a>,
  o: &'b Operator<'a>,
) -> Result<E>
where
  E: Error,
  V: Visitor<'a, 'b, E> + ?Sized,
{
  visitor.visit_rangectlop(&o.operator, target, &o.type2)
}

/// Walk rangectlop
pub fn walk_rangectlop<'a, 'b, E, V>(
  visitor: &mut V,
  op: &'b RangeCtlOp,
  target: &'b Type1<'a>,
  controller: &'b Type2<'a>,
) -> Result<E>
where
  E: Error,
  V: Visitor<'a, 'b, E> + ?Sized,
{
  match op {
    RangeCtlOp::RangeOp { is_inclusive, .. } => {
      visitor.visit_range(&target.type2, controller, *is_inclusive)
    }
    RangeCtlOp::CtlOp { ctrl, .. } => {
      visitor.visit_control_operator(&target.type2, *ctrl, controller)
    }
  }
}

/// Walk range
pub fn walk_range<'a, 'b, E, V>(
  visitor: &mut V,
  lower: &'b Type2<'a>,
  upper: &'b Type2<'a>,
) -> Result<E>
where
  E: Error,
  V: Visitor<'a, 'b, E> + ?Sized,
{
  visitor.visit_type2(lower)?;
  visitor.visit_type2(upper)
}

/// Walk control operator
pub fn walk_control_operator<'a, 'b, E, V>(
  visitor: &mut V,
  target: &'b Type2<'a>,
  controller: &'b Type2<'a>,
) -> Result<E>
where
  E: Error,
  V: Visitor<'a, 'b, E> + ?Sized,
{
  visitor.visit_type2(target)?;
  visitor.visit_type2(controller)
}

/// Walk type2
pub fn walk_type2<'a, 'b, E, V>(visitor: &mut V, t2: &'b Type2<'a>) -> Result<E>
where
  E: Error,
  V: Visitor<'a, 'b, E> + ?Sized,
{
  match t2 {
    Type2::Array { group, .. } => visitor.visit_group(group),
    Type2::Map { group, .. } => visitor.visit_group(group),
    Type2::ChoiceFromGroup {
      generic_args,
      ident,
      ..
    } => {
      if let Some(ga) = generic_args {
        visitor.visit_generic_args(ga)?;
      }

      visitor.visit_identifier(ident)
    }
    Type2::ChoiceFromInlineGroup { group, .. } => visitor.visit_group(group),
    Type2::TaggedData { t, .. } => visitor.visit_type(t),
    Type2::Typename { ident, .. } => visitor.visit_identifier(ident),
    Type2::Unwrap {
      generic_args,
      ident,
      ..
    } => {
      if let Some(ga) = generic_args {
        visitor.visit_generic_args(ga)?;
      }

      visitor.visit_identifier(ident)
    }
    Type2::ParenthesizedType { pt, .. } => visitor.visit_type(pt),
    Type2::B16ByteString { value, .. } => {
      visitor.visit_value(&Value::BYTE(ByteValue::B16(value.clone())))
    }
    Type2::B64ByteString { value, .. } => {
      visitor.visit_value(&Value::BYTE(ByteValue::B64(value.clone())))
    }
    Type2::UTF8ByteString { value, .. } => {
      visitor.visit_value(&Value::BYTE(ByteValue::UTF8(value.clone())))
    }
    Type2::FloatValue { value, .. } => visitor.visit_value(&Value::FLOAT(*value)),
    Type2::IntValue { value, .. } => visitor.visit_value(&Value::INT(*value)),
    Type2::UintValue { value, .. } => visitor.visit_value(&Value::UINT(*value)),
    Type2::TextValue { value, .. } => visitor.visit_value(&Value::TEXT(value.clone())),
    _ => Ok(()),
  }
}

/// Walk group
pub fn walk_group<'a, 'b, E, V>(visitor: &mut V, g: &'b Group<'a>) -> Result<E>
where
  E: Error,
  V: Visitor<'a, 'b, E> + ?Sized,
{
  for gc in &g.group_choices {
    visitor.visit_group_choice(gc)?;
  }

  Ok(())
}

/// Walk group choice
pub fn walk_group_choice<'a, 'b, E, V>(visitor: &mut V, gc: &'b GroupChoice<'a>) -> Result<E>
where
  E: Error,
  V: Visitor<'a, 'b, E> + ?Sized,
{
  for ge in &gc.group_entries {
    visitor.visit_group_entry(&ge.0)?;
  }

  Ok(())
}

/// Walk group entry
pub fn walk_group_entry<'a, 'b, E, V>(visitor: &mut V, entry: &'b GroupEntry<'a>) -> Result<E>
where
  E: Error,
  V: Visitor<'a, 'b, E> + ?Sized,
{
  match entry {
    GroupEntry::ValueMemberKey { ge, .. } => visitor.visit_value_member_key_entry(ge),
    GroupEntry::TypeGroupname { ge, .. } => visitor.visit_type_groupname_entry(ge),
    GroupEntry::InlineGroup { occur, group, .. } => {
      visitor.visit_inline_group_entry(occur.as_ref(), group)
    }
  }
}

/// Walk value member key entry
pub fn walk_value_member_key_entry<'a, 'b, E, V>(
  visitor: &mut V,
  entry: &'b ValueMemberKeyEntry<'a>,
) -> Result<E>
where
  E: Error,
  V: Visitor<'a, 'b, E> + ?Sized,
{
  if let Some(occur) = &entry.occur {
    visitor.visit_occurrence(occur)?;
  }

  if let Some(mk) = &entry.member_key {
    visitor.visit_memberkey(mk)?;
  }

  visitor.visit_type(&entry.entry_type)
}

/// Walk typename/groupname entry
pub fn walk_type_groupname_entry<'a, 'b, E, V>(
  visitor: &mut V,
  entry: &'b TypeGroupnameEntry<'a>,
) -> Result<E>
where
  E: Error,
  V: Visitor<'a, 'b, E> + ?Sized,
{
  if let Some(o) = &entry.occur {
    visitor.visit_occurrence(o)?;
  }

  if let Some(ga) = &entry.generic_args {
    visitor.visit_generic_args(ga)?;
  }

  visitor.visit_identifier(&entry.name)
}

/// Walk inline group entry
pub fn walk_inline_group_entry<'a, 'b, E, V>(
  visitor: &mut V,
  occur: Option<&'b Occurrence<'a>>,
  g: &'b Group<'a>,
) -> Result<E>
where
  E: Error,
  V: Visitor<'a, 'b, E> + ?Sized,
{
  if let Some(o) = occur {
    visitor.visit_occurrence(o)?;
  }

  visitor.visit_group(g)
}

/// Walk memberkey
pub fn walk_memberkey<'a, 'b, E, V>(visitor: &mut V, mk: &'b MemberKey<'a>) -> Result<E>
where
  E: Error,
  V: Visitor<'a, 'b, E> + ?Sized,
{
  match mk {
    MemberKey::Type1 { t1, .. } => visitor.visit_type1(t1),
    MemberKey::Bareword { ident, .. } => visitor.visit_identifier(ident),
    MemberKey::Value { value, .. } => visitor.visit_value(value),
    MemberKey::NonMemberKey { non_member_key, .. } => visitor.visit_nonmemberkey(non_member_key),
  }
}

/// Walk genericargs
pub fn walk_generic_args<'a, 'b, E, V>(visitor: &mut V, args: &'b GenericArgs<'a>) -> Result<E>
where
  E: Error,
  V: Visitor<'a, 'b, E> + ?Sized,
{
  for arg in args.args.iter() {
    visitor.visit_generic_arg(arg)?;
  }

  Ok(())
}

/// Walk genericarg
pub fn walk_generic_arg<'a, 'b, E, V>(visitor: &mut V, arg: &'b GenericArg<'a>) -> Result<E>
where
  E: Error,
  V: Visitor<'a, 'b, E> + ?Sized,
{
  visitor.visit_type1(&arg.arg)
}

/// Walk genericparams
pub fn walk_generic_params<'a, 'b, E, V>(
  visitor: &mut V,
  params: &'b GenericParams<'a>,
) -> Result<E>
where
  E: Error,
  V: Visitor<'a, 'b, E> + ?Sized,
{
  for param in params.params.iter() {
    visitor.visit_generic_param(param)?;
  }

  Ok(())
}

/// Walk genericparams
pub fn walk_generic_param<'a, 'b, E, V>(visitor: &mut V, param: &GenericParam<'a>) -> Result<E>
where
  E: Error,
  V: Visitor<'a, 'b, E> + ?Sized,
{
  visitor.visit_identifier(&param.param)
}

/// Walk nonmemberkey
pub fn walk_nonmemberkey<'a, 'b, E, V>(visitor: &mut V, nmk: &'b NonMemberKey<'a>) -> Result<E>
where
  E: Error,
  V: Visitor<'a, 'b, E> + ?Sized,
{
  match nmk {
    NonMemberKey::Group(group) => visitor.visit_group(group),
    NonMemberKey::Type(t) => visitor.visit_type(t),
  }
}