schala/schala-lang/language/src/ast.rs

use std::rc::Rc;
use std::convert::From;

use crate::derivative::Derivative;
use crate::symbol_table::FullyQualifiedSymbolName;

mod operators;
pub use operators::*;

/// An abstract identifier for an AST node
#[derive(Debug, PartialEq, Eq, Hash, Clone)]
pub struct ItemId {
  idx: u32,
}

impl ItemId {
  fn new(n: u32) -> ItemId {
    ItemId { idx: n }
  }
}

pub struct ItemIdStore {
  last_idx: u32
}

impl ItemIdStore {
  pub fn new() -> ItemIdStore {
    ItemIdStore { last_idx: 0 }
  }
  /// Always returns an ItemId with internal value zero
  #[cfg(test)]
  pub fn new_id() -> ItemId {
    ItemId { idx: 0 }
  }

  /// This limits the size of the AST to 2^32 tree elements
  pub fn fresh(&mut self) -> ItemId {
    let idx = self.last_idx;
    self.last_idx += 1;
    ItemId::new(idx)
  }
}


#[derive(Clone, Debug, PartialEq)]
pub struct Meta<T> {
  pub n: T,
  pub fqsn: Option<FullyQualifiedSymbolName>
}

impl<T> Meta<T> {
  pub fn new(n: T) -> Meta<T> {
    Meta { n,
    fqsn: None,
    }
  }

  pub fn node(&self) -> &T {
    &self.n
  }

  pub fn mut_node(&mut self) -> &mut T {
    &mut self.n
  }
}

//TODO this PartialEq is here to make tests work - find a way to make it not necessary
#[derive(Clone, Debug, Default, PartialEq)]
struct SourceMap {
}

impl From<Expression> for Meta<Expression> {
  fn from(expr: Expression) -> Meta<Expression> {
    Meta::new(expr)
  }
}

#[derive(Derivative, Debug)]
#[derivative(PartialEq)]
pub struct AST {
  #[derivative(PartialEq="ignore")]
  pub id: ItemId,
  pub statements: Vec<Meta<Statement>>
}

#[derive(Derivative, Debug, Clone)]
#[derivative(PartialEq)]
pub struct Statement {
  #[derivative(PartialEq="ignore")]
  pub id: ItemId,
  pub kind: StatementKind,
}

#[derive(Debug, PartialEq, Clone)]
pub enum StatementKind {
  Expression(Meta<Expression>),
  Declaration(Declaration), //TODO Declaration should also be Meta-wrapped; only Expression and Declaration are Meta-wrapped maybe?
}

pub type Block = Vec<Meta<Statement>>;
pub type ParamName = Rc<String>;

#[derive(Debug, Derivative, Clone)]
#[derivative(PartialEq)]
pub struct QualifiedName {
  #[derivative(PartialEq="ignore")]
  pub id: ItemId,
  pub components: Vec<Rc<String>>,
}

#[derive(Debug, PartialEq, Clone)]
pub struct FormalParam {
  pub name: ParamName,
  pub default: Option<Meta<Expression>>,
  pub anno: Option<TypeIdentifier>
}

#[derive(Debug, PartialEq, Clone)]
pub enum Declaration {
  FuncSig(Signature),
  FuncDecl(Signature, Block),
  TypeDecl {
    name: TypeSingletonName,
    body: TypeBody,
    mutable: bool
  },
  TypeAlias(Rc<String>, Rc<String>), //should have TypeSingletonName in it, or maybe just String, not sure
  Binding {
    name: Rc<String>,
    constant: bool,
    type_anno: Option<TypeIdentifier>,
    expr: Meta<Expression>,
  },
  Impl {
    type_name: TypeIdentifier,
    interface_name: Option<TypeSingletonName>,
    block: Vec<Declaration>,
  },
  Interface {
    name: Rc<String>,
    signatures: Vec<Signature>
  }
}

#[derive(Debug, PartialEq, Clone)]
pub struct Signature {
  pub name: Rc<String>,
  pub operator: bool,
  pub params: Vec<FormalParam>,
  pub type_anno: Option<TypeIdentifier>,
}

#[derive(Debug, PartialEq, Clone)]
pub struct TypeBody(pub Vec<Variant>);

#[derive(Debug, PartialEq, Clone)]
pub enum Variant {
  UnitStruct(Rc<String>),
  TupleStruct(Rc<String>, Vec<TypeIdentifier>),
  Record {
    name: Rc<String>,
    members: Vec<(Rc<String>, TypeIdentifier)>,
  }
}

#[derive(Debug, Derivative, Clone)]
#[derivative(PartialEq)]
pub struct Expression {
  #[derivative(PartialEq="ignore")]
  pub id: ItemId,
  pub kind: ExpressionKind,
  pub type_anno: Option<TypeIdentifier>
}

impl Expression {
  pub fn new(id: ItemId, kind: ExpressionKind) -> Expression {
    Expression { id, kind, type_anno: None }
  }

  pub fn with_anno(id: ItemId, kind: ExpressionKind, type_anno: TypeIdentifier) -> Expression {
    Expression { id, kind, type_anno: Some(type_anno) }
  }
}

#[derive(Debug, PartialEq, Clone)]
pub enum TypeIdentifier {
  Tuple(Vec<TypeIdentifier>),
  Singleton(TypeSingletonName)
}

#[derive(Debug, PartialEq, Clone)]
pub struct TypeSingletonName {
  pub name: Rc<String>,
  pub params: Vec<TypeIdentifier>,
}

#[derive(Debug, PartialEq, Clone)]
pub enum ExpressionKind {
  NatLiteral(u64),
  FloatLiteral(f64),
  StringLiteral(Rc<String>),
  BoolLiteral(bool),
  BinExp(BinOp, Box<Meta<Expression>>, Box<Meta<Expression>>),
  PrefixExp(PrefixOp, Box<Meta<Expression>>),
  TupleLiteral(Vec<Meta<Expression>>),
  Value(QualifiedName),
  NamedStruct {
    name: Meta<QualifiedName>,
    fields: Vec<(Rc<String>, Meta<Expression>)>,
  },
  Call {
    f: Box<Meta<Expression>>,
    arguments: Vec<InvocationArgument>,
  },
  Index {
    indexee: Box<Meta<Expression>>,
    indexers: Vec<Meta<Expression>>,
  },
  IfExpression {
    discriminator: Box<Discriminator>,
    body: Box<IfExpressionBody>,
  },
  WhileExpression {
    condition: Option<Box<Meta<Expression>>>,
    body: Block,
  },
  ForExpression {
    enumerators: Vec<Enumerator>,
    body: Box<ForBody>,
  },
  Lambda {
    params: Vec<FormalParam>,
    type_anno: Option<TypeIdentifier>,
    body: Block,
  },
  ListLiteral(Vec<Meta<Expression>>),
}

#[derive(Debug, PartialEq, Clone)]
pub enum InvocationArgument {
  Positional(Meta<Expression>),
  Keyword {
    name: Rc<String>,
    expr: Meta<Expression>,
  },
  Ignored
}

#[derive(Debug, PartialEq, Clone)]
pub enum Discriminator {
  Simple(Meta<Expression>),
  BinOp(Meta<Expression>, BinOp)
}

#[derive(Debug, PartialEq, Clone)]
pub enum IfExpressionBody {
  SimpleConditional(Block, Option<Block>),
  SimplePatternMatch(Pattern, Block, Option<Block>),
  GuardList(Vec<GuardArm>)
}

#[derive(Debug, PartialEq, Clone)]
pub struct GuardArm {
  pub guard: Guard,
  pub body: Block,
}

#[derive(Debug, PartialEq, Clone)]
pub enum Guard {
  Pat(Pattern),
  HalfExpr(HalfExpr)
}

#[derive(Debug, PartialEq, Clone)]
pub struct HalfExpr {
  pub op: Option<BinOp>,
  pub expr: ExpressionKind,
}

#[derive(Debug, PartialEq, Clone)]
pub enum Pattern {
  Ignored,
  TuplePattern(Vec<Pattern>),
  Literal(PatternLiteral),
  TupleStruct(QualifiedName, Vec<Pattern>),
  Record(QualifiedName, Vec<(Rc<String>, Pattern)>),
  VarOrName(QualifiedName),
}

#[derive(Debug, PartialEq, Clone)]
pub enum PatternLiteral {
  NumPattern {
    neg: bool,
    num: ExpressionKind,
  },
  StringPattern(Rc<String>),
  BoolPattern(bool),
}

#[derive(Debug, PartialEq, Clone)]
pub struct Enumerator {
  pub id: Rc<String>,
  pub generator: Meta<Expression>,
}

#[derive(Debug, PartialEq, Clone)]
pub enum ForBody {
  MonadicReturn(Meta<Expression>),
  StatementBlock(Block),
}