parser

Huff Parser

A parser for the Huff Language.

The Huff Parser accepts a vector of Tokens during instantiation.

Once instantiated, the parser will construct an AST from the Token Vector when the parse method is called.

It also exposes a number of practical methods for accessing information about the source code throughout lexing.

Usage

The following example steps through the lexing of a simple, single-line source code macro definition.

use huff_neo_utils::prelude::*;
use huff_neo_lexer::{Lexer};
use huff_neo_parser::{Parser};
use std::collections::HashSet;
use std::sync::{Arc, Mutex};
use indexmap::IndexMap;

fn example() {
    
    // Create a Lexer from the source code
    let source = "#define macro HELLO_WORLD() = takes(0) returns(0) {}";
    let flattened_source = FullFileSource { source, file: None, spans: vec![] };
    let mut lexer = Lexer::new(flattened_source);
    
    // Grab the tokens from the lexer
    let tokens = lexer.into_iter().map(|x| x.unwrap()).collect::<Vec<Token>>();
    
    // Parser incantation
    let mut parser = Parser::new(tokens, None);
    
    // Parse into an AST
    let unwrapped_contract = parser.parse().unwrap();
    assert_eq!(parser.current_token.kind, TokenKind::Eof);
    
    // Validate the unwrapped contract
    let expected_contract = Contract {
      macros: IndexMap::from([("HELLO_WORLD".to_string(),
        MacroDefinition {
          name: "HELLO_WORLD".to_string(),
          decorator: None,
          parameters: vec![],
          statements: vec![],
          takes: 0,
          returns: 0,
          span: AstSpan(vec![Span { start: 0, end: 6, file: None }, Span { start: 8, end: 12, file: None }, Span { start: 14, end: 24, file: None }, Span { start: 25, end: 25, file: None }, Span { start: 26, end: 26, file: None }, Span { start: 28, end: 28, file: None }, Span { start: 30, end: 34, file: None }, Span { start: 35, end: 35, file: None }, Span { start: 36, end: 36, file: None }, Span { start: 37, end: 37, file: None }, Span { start: 39, end: 45, file: None }, Span { start: 46, end: 46, file: None }, Span { start: 47, end: 47, file: None }, Span { start: 48, end: 48, file: None }, Span { start: 50, end: 50, file: None }, Span { start: 51, end: 51, file: None }]),
          outlined: false,
          test: false,
        }
      )]),
      invocations: vec![],
      imports: vec![],
      constants: Arc::new(Mutex::new(vec![])),
      errors: vec![],
      functions: vec![],
      events: vec![],
      tables: vec![],
      labels: HashSet::new(),
      flattened_source: None,
      source_files: vec![],
      source_map: vec![],
      runtime_size: None,
    };
    assert_eq!(unwrapped_contract.macros, expected_contract.macros);
}