Skip to content

Latest commit

 

History

History
31 lines (25 loc) · 1.09 KB

structure_design.md

File metadata and controls

31 lines (25 loc) · 1.09 KB
Raw
README

Structure & Design

Structure

The following should be different modules (not final names):

  • lib (general traits and utility functions, etc.)
  • input/source provider
  • tokenizer
  • astler
  • llvm compiler (with optional clang call, in a separate module)

These components will be called in series by the main compiler module (except for lib).

Flow (in compiler.rs)

(each step returns a Result, which is omitted in this diagram)

  • source::Source::from_file(file) -> Source
  • tokens::tokenize(Source) -> Tokens
  • ast::parse(Tokens) -> Ast (probably Module)
  • llvm::build_llvmir(Ast) -> LLVMModuleRef
  • llvm::build_exe(LLVMModuleRef) -> fp: String

Design

Module Directories: foo/mod.rs vs foo.rs

I will try (unlike previous times) a mod.rs approach since it seems to make the root directory far less cluttered. Regardless of whether this will change in the future, it will be handled uniformly and not mixed between the two approaches.

pub vs pub(crate)

Everything will initially be pub(crate) or private.