semdemo.rs

// Copyright contributors to the openqasm-parser project
// SPDX-License-Identifier: Apache-2.0

use clap::{Parser, Subcommand};
use std::fs;
use std::path::PathBuf;

use oq3_lexer::{tokenize, Token};
use oq3_parser::SyntaxKind;
use oq3_semantics::syntax_to_semantics;
use oq3_source_file::SourceTrait;
use oq3_syntax::{parse_text, GreenNode, SourceFile};
use rowan::NodeOrToken; // TODO: this can be accessed from a higher level

#[derive(Parser)]
#[command(name = "demotest")]
#[command(about = "Demo of parser that parses and prints tokens or trees to stdout.")]
#[command(long_about = "
Demo of parser that parses and prints tokens or trees to stdout.

Commands are `lex`, `parse-green`, `parse`, `semantic`, `semantic-string`, `semantic-pretty`.
`lex` prints a stream of tokens. `parse-green` prints the green tree. `parse` prints the (syntactic) red tree.
`semantic` prints the semantic abstract semantic graph (ASG). This structure includes types and resolved symbols.
")]
struct Cli {
    #[command(subcommand)]
    /// This is the Cli command doc
    command: Option<Commands>,
}

// `value_name` expects bare word, not flag.
#[derive(Subcommand)]
enum Commands {
    /// Parse file to ASG
    Semantic {
        #[arg(value_name = "FILENAME")]
        /// file name to read
        file_name: PathBuf,
    },

    /// Same as `semantic`, but test the parse_from_string interface
    SemanticString {
        #[arg(value_name = "FILENAME")]
        /// file name to read
        file_name: PathBuf,
    },

    /// Same as `semantic`, but pretty-print the ASG
    SemanticPretty {
        #[arg(value_name = "FILENAME")]
        /// file name to read
        file_name: PathBuf,
    },

    /// Parse file to `SyntaxNode`
    Parse {
        #[arg(value_name = "FILENAME")]
        /// file name to read
        file_name: PathBuf,
    },

    /// Parse file to `GreenNode`
    ParseGreen {
        #[arg(value_name = "FILENAME")]
        file_name: PathBuf,
    },

    /// Lex file to `Token`s
    Lex {
        #[arg(value_name = "FILENAME")]
        file_name: PathBuf,
    },
}

fn main() {
    let cli = Cli::parse();

    // You can check for the existence of subcommands, and if found use their
    // matches just as you would the top level cmd
    match &cli.command {
        Some(Commands::SemanticString { file_name }) => {
            let source = read_example_source(file_name);
            let file_name = Some("giraffe");
            let result =
                syntax_to_semantics::parse_source_string(source, file_name, None::<&[PathBuf]>);
            if result.any_errors() {
                result.print_errors();
            }
            result.program().print_asg_debug();
        }

        #[allow(clippy::dbg_macro)]
        Some(Commands::Semantic { file_name }) => {
            let result = syntax_to_semantics::parse_source_file(file_name, None::<&[PathBuf]>);
            if result.any_errors() {
                println!("Found errors:");
                result.print_errors();
            } else {
                println!("No errors found.");
            }
            println!("{} statements in program:", result.program().len());
            result.program().print_asg_debug();
            dbg!(oq3_semantics::validate::count_symbol_errors(
                result.program(),
                result.symbol_table()
            ));
            //            result.take_context().symbol_table().dump();
        }

        Some(Commands::SemanticPretty { file_name }) => {
            let result = syntax_to_semantics::parse_source_file(file_name, None::<&[PathBuf]>);
            if result.any_errors() {
                println!("Found errors:");
                result.print_errors();
            } else {
                println!("No errors found.");
            }
            result.print_errors();
            result.program().print_asg_debug_pretty();
        }

        Some(Commands::Parse { file_name }) => {
            let parsed_source = oq3_source_file::parse_source_file(file_name, None::<&[PathBuf]>);
            let ast = parsed_source.syntax_ast();
            let num_stmts = if ast.have_parse() {
                ast.tree().statements().count()
            } else {
                0
            };
            println!("Found {num_stmts} stmts");
            let syntax_errors = ast.errors();
            println!(
                "Found {} parse errors:\n{:?}\n",
                syntax_errors.len(),
                syntax_errors
            );
            if ast.have_parse() {
                print_tree(ast.tree());
            }
        }

        Some(Commands::ParseGreen { file_name }) => {
            let (green_node, syntax_errors) = parse_text(&read_example_source(file_name));
            println!("{:?}", green_node);
            println!("{:?}", green_node.kind());
            print_node_or_token(green_node, 0);
            println!(
                "\nFound {} parse errors:\n{:?}",
                syntax_errors.len(),
                syntax_errors
            );
        }

        Some(Commands::Lex { file_name }) => {
            let tokens: Vec<Token> = tokenize(&read_example_source(file_name)).collect();
            for tok in tokens {
                println!("{:?}", tok);
            }
        }

        None => {
            // TODO should print usage here.
            println!("Commands are semantic, parse, parse-green, and lex")
        }
    }
}

fn read_example_source(file_path: &PathBuf) -> String {
    fs::read_to_string(file_path.clone())
        .unwrap_or_else(|_| panic!("Unable to read file {:?}", file_path))
}

fn print_tree(file: SourceFile) {
    use oq3_syntax::ast::AstNode;
    for item in file.syntax().descendants() {
        println!("{:?}: {:}", item, item);
    }
}

fn print_node_or_token(item: GreenNode, depth: usize) {
    let spcs = " ".repeat(depth);
    for child in item.children() {
        //        println!("{}{}: {} : {:?}", spcs, i, child, child);
        match child {
            NodeOrToken::Node(node) => {
                print_node_or_token(node.to_owned(), depth + 1);
            }
            NodeOrToken::Token(token) => {
                let sk = SyntaxKind::from(token.kind().0);
                println!("{}  {:?} {:?}", spcs, sk, token.text());
            }
        };
    }
    println!("{}<", spcs);
}