mirror of
https://github.com/imjasonh/nescript
synced 2026-07-09 17:28:00 +00:00
Analyzer extensions: - Call graph construction from function bodies and state handlers - DFS-based recursion detection (direct and mutual) with E0402 errors - Max call depth computation per entry point with E0401 enforcement - Function declarations registered as symbols (E0503 for undefined calls) - Collects calls from all statement/expression types recursively Optimizer (new module): - Constant folding: evaluate known-constant arithmetic at compile time - Dead code elimination: remove ops with unused destination temps - Both operate per-basic-block in a single pass 171 tests total (22 new: 6 analyzer + 11 IR lowering + 5 optimizer) https://claude.ai/code/session_01W6eQFStA66EuMKHUFo2rx3
648 lines
21 KiB
Rust
648 lines
21 KiB
Rust
#[cfg(test)]
|
|
mod tests;
|
|
|
|
use std::collections::{HashMap, HashSet};
|
|
|
|
use crate::errors::{Diagnostic, ErrorCode};
|
|
use crate::lexer::Span;
|
|
use crate::parser::ast::*;
|
|
|
|
/// Symbol information stored in the scope.
|
|
#[derive(Debug, Clone)]
|
|
pub struct Symbol {
|
|
pub name: String,
|
|
pub sym_type: NesType,
|
|
pub is_const: bool,
|
|
pub span: Span,
|
|
}
|
|
|
|
/// Memory assignment for a variable.
|
|
#[derive(Debug, Clone)]
|
|
pub struct VarAllocation {
|
|
pub name: String,
|
|
pub address: u16,
|
|
pub size: u16,
|
|
}
|
|
|
|
/// Result of semantic analysis.
|
|
pub struct AnalysisResult {
|
|
pub symbols: HashMap<String, Symbol>,
|
|
pub var_allocations: Vec<VarAllocation>,
|
|
pub diagnostics: Vec<Diagnostic>,
|
|
pub call_graph: HashMap<String, Vec<String>>,
|
|
pub max_depths: HashMap<String, u32>,
|
|
}
|
|
|
|
/// Default call stack depth limit for the NES runtime.
|
|
const DEFAULT_STACK_DEPTH: u32 = 8;
|
|
|
|
/// Analyze a parsed program for semantic errors.
|
|
pub fn analyze(program: &Program) -> AnalysisResult {
|
|
let mut analyzer = Analyzer {
|
|
symbols: HashMap::new(),
|
|
var_allocations: Vec::new(),
|
|
diagnostics: Vec::new(),
|
|
next_ram_addr: 0x0300, // $0300 is first usable RAM after OAM buffer
|
|
next_zp_addr: 0x10, // $10 is first usable zero-page after reserved area
|
|
call_graph: HashMap::new(),
|
|
max_depths: HashMap::new(),
|
|
stack_depth_limit: DEFAULT_STACK_DEPTH,
|
|
};
|
|
analyzer.analyze_program(program);
|
|
|
|
AnalysisResult {
|
|
symbols: analyzer.symbols,
|
|
var_allocations: analyzer.var_allocations,
|
|
diagnostics: analyzer.diagnostics,
|
|
call_graph: analyzer.call_graph,
|
|
max_depths: analyzer.max_depths,
|
|
}
|
|
}
|
|
|
|
struct Analyzer {
|
|
symbols: HashMap<String, Symbol>,
|
|
var_allocations: Vec<VarAllocation>,
|
|
diagnostics: Vec<Diagnostic>,
|
|
next_ram_addr: u16,
|
|
next_zp_addr: u8,
|
|
call_graph: HashMap<String, Vec<String>>,
|
|
max_depths: HashMap<String, u32>,
|
|
stack_depth_limit: u32,
|
|
}
|
|
|
|
impl Analyzer {
|
|
fn analyze_program(&mut self, program: &Program) {
|
|
// Register constants
|
|
for c in &program.constants {
|
|
self.register_const(c);
|
|
}
|
|
|
|
// Register and allocate globals
|
|
for var in &program.globals {
|
|
self.register_var(var);
|
|
}
|
|
|
|
// Register functions as symbols
|
|
for fun in &program.functions {
|
|
self.register_fun(fun);
|
|
}
|
|
|
|
// Register state-local variables
|
|
for state in &program.states {
|
|
for var in &state.locals {
|
|
self.register_var(var);
|
|
}
|
|
}
|
|
|
|
// Validate state references
|
|
let state_names: Vec<&str> = program.states.iter().map(|s| s.name.as_str()).collect();
|
|
|
|
// Check start state exists
|
|
if !state_names.contains(&program.start_state.as_str()) {
|
|
self.diagnostics.push(Diagnostic::error(
|
|
ErrorCode::E0404,
|
|
format!("start state '{}' is not defined", program.start_state),
|
|
program.span,
|
|
));
|
|
}
|
|
|
|
// Type-check all state bodies
|
|
for state in &program.states {
|
|
if let Some(block) = &state.on_enter {
|
|
self.check_block(block, &state_names);
|
|
}
|
|
if let Some(block) = &state.on_exit {
|
|
self.check_block(block, &state_names);
|
|
}
|
|
if let Some(block) = &state.on_frame {
|
|
self.check_block(block, &state_names);
|
|
}
|
|
}
|
|
|
|
// Type-check function bodies
|
|
for fun in &program.functions {
|
|
self.check_block(&fun.body, &state_names);
|
|
}
|
|
|
|
// Build call graph
|
|
self.build_call_graph(program);
|
|
|
|
// Detect recursion
|
|
let recursive_fns = detect_recursion(&self.call_graph);
|
|
for name in &recursive_fns {
|
|
self.diagnostics.push(Diagnostic::error(
|
|
ErrorCode::E0402,
|
|
format!("recursion detected in function '{name}'"),
|
|
program.span,
|
|
));
|
|
}
|
|
|
|
// Compute max call depths from entry points (state handlers)
|
|
self.compute_max_depths(program);
|
|
}
|
|
|
|
fn register_const(&mut self, c: &ConstDecl) {
|
|
if self.symbols.contains_key(&c.name) {
|
|
self.diagnostics.push(Diagnostic::error(
|
|
ErrorCode::E0501,
|
|
format!("duplicate declaration of '{}'", c.name),
|
|
c.span,
|
|
));
|
|
return;
|
|
}
|
|
self.symbols.insert(
|
|
c.name.clone(),
|
|
Symbol {
|
|
name: c.name.clone(),
|
|
sym_type: c.const_type.clone(),
|
|
is_const: true,
|
|
span: c.span,
|
|
},
|
|
);
|
|
}
|
|
|
|
fn register_var(&mut self, var: &VarDecl) {
|
|
if self.symbols.contains_key(&var.name) {
|
|
self.diagnostics.push(Diagnostic::error(
|
|
ErrorCode::E0501,
|
|
format!("duplicate declaration of '{}'", var.name),
|
|
var.span,
|
|
));
|
|
return;
|
|
}
|
|
|
|
let size = type_size(&var.var_type);
|
|
let address = self.allocate_ram(size);
|
|
|
|
self.symbols.insert(
|
|
var.name.clone(),
|
|
Symbol {
|
|
name: var.name.clone(),
|
|
sym_type: var.var_type.clone(),
|
|
is_const: false,
|
|
span: var.span,
|
|
},
|
|
);
|
|
|
|
self.var_allocations.push(VarAllocation {
|
|
name: var.name.clone(),
|
|
address,
|
|
size,
|
|
});
|
|
}
|
|
|
|
fn register_fun(&mut self, fun: &FunDecl) {
|
|
if self.symbols.contains_key(&fun.name) {
|
|
self.diagnostics.push(Diagnostic::error(
|
|
ErrorCode::E0501,
|
|
format!("duplicate declaration of '{}'", fun.name),
|
|
fun.span,
|
|
));
|
|
return;
|
|
}
|
|
let sym_type = fun.return_type.clone().unwrap_or(NesType::U8);
|
|
self.symbols.insert(
|
|
fun.name.clone(),
|
|
Symbol {
|
|
name: fun.name.clone(),
|
|
sym_type,
|
|
is_const: false,
|
|
span: fun.span,
|
|
},
|
|
);
|
|
}
|
|
|
|
fn allocate_ram(&mut self, size: u16) -> u16 {
|
|
// For M1: simple linear allocator using zero-page for u8 vars
|
|
if size == 1 && self.next_zp_addr < 0xFF {
|
|
let addr = u16::from(self.next_zp_addr);
|
|
self.next_zp_addr = self.next_zp_addr.wrapping_add(1);
|
|
addr
|
|
} else {
|
|
let addr = self.next_ram_addr;
|
|
self.next_ram_addr += size;
|
|
addr
|
|
}
|
|
}
|
|
|
|
fn build_call_graph(&mut self, program: &Program) {
|
|
// Record calls from each function body
|
|
for fun in &program.functions {
|
|
let callees = collect_calls(&fun.body);
|
|
self.call_graph.insert(fun.name.clone(), callees);
|
|
}
|
|
|
|
// Record calls from each state handler
|
|
for state in &program.states {
|
|
if let Some(block) = &state.on_enter {
|
|
let key = format!("{}::enter", state.name);
|
|
let callees = collect_calls(block);
|
|
self.call_graph.insert(key, callees);
|
|
}
|
|
if let Some(block) = &state.on_exit {
|
|
let key = format!("{}::exit", state.name);
|
|
let callees = collect_calls(block);
|
|
self.call_graph.insert(key, callees);
|
|
}
|
|
if let Some(block) = &state.on_frame {
|
|
let key = format!("{}::frame", state.name);
|
|
let callees = collect_calls(block);
|
|
self.call_graph.insert(key, callees);
|
|
}
|
|
}
|
|
}
|
|
|
|
fn compute_max_depths(&mut self, program: &Program) {
|
|
let mut cache = HashMap::new();
|
|
|
|
// Entry points are state handlers
|
|
for state in &program.states {
|
|
let handler_keys: Vec<String> = [
|
|
state
|
|
.on_enter
|
|
.as_ref()
|
|
.map(|_| format!("{}::enter", state.name)),
|
|
state
|
|
.on_exit
|
|
.as_ref()
|
|
.map(|_| format!("{}::exit", state.name)),
|
|
state
|
|
.on_frame
|
|
.as_ref()
|
|
.map(|_| format!("{}::frame", state.name)),
|
|
]
|
|
.into_iter()
|
|
.flatten()
|
|
.collect();
|
|
|
|
for key in handler_keys {
|
|
let mut visited = HashSet::new();
|
|
let depth = compute_depth(&key, &self.call_graph, &mut visited, &mut cache);
|
|
self.max_depths.insert(key.clone(), depth);
|
|
|
|
if depth > self.stack_depth_limit {
|
|
self.diagnostics.push(Diagnostic::error(
|
|
ErrorCode::E0401,
|
|
format!(
|
|
"call depth {depth} in handler '{key}' exceeds stack limit {}",
|
|
self.stack_depth_limit
|
|
),
|
|
program.span,
|
|
));
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
fn check_block(&mut self, block: &Block, state_names: &[&str]) {
|
|
for stmt in &block.statements {
|
|
self.check_statement(stmt, state_names);
|
|
}
|
|
}
|
|
|
|
fn check_statement(&mut self, stmt: &Statement, state_names: &[&str]) {
|
|
match stmt {
|
|
Statement::VarDecl(var) => {
|
|
self.register_var(var);
|
|
if let Some(init) = &var.init {
|
|
self.check_expr_type(init, &var.var_type);
|
|
}
|
|
}
|
|
Statement::Assign(lvalue, _, expr, span) => {
|
|
let ltype = self.lvalue_type(lvalue, *span);
|
|
if let Some(lt) = ltype {
|
|
self.check_expr_type(expr, <);
|
|
}
|
|
}
|
|
Statement::If(cond, then_block, else_ifs, else_block, _) => {
|
|
self.check_expr_type(cond, &NesType::Bool);
|
|
self.check_block(then_block, state_names);
|
|
for (cond, block) in else_ifs {
|
|
self.check_expr_type(cond, &NesType::Bool);
|
|
self.check_block(block, state_names);
|
|
}
|
|
if let Some(block) = else_block {
|
|
self.check_block(block, state_names);
|
|
}
|
|
}
|
|
Statement::While(cond, body, _) => {
|
|
self.check_expr_type(cond, &NesType::Bool);
|
|
self.check_block(body, state_names);
|
|
}
|
|
Statement::Loop(body, _) => {
|
|
self.check_block(body, state_names);
|
|
}
|
|
Statement::Transition(name, span) => {
|
|
if !state_names.contains(&name.as_str()) {
|
|
self.diagnostics.push(Diagnostic::error(
|
|
ErrorCode::E0404,
|
|
format!("transition to undefined state '{name}'"),
|
|
*span,
|
|
));
|
|
}
|
|
}
|
|
Statement::Draw(draw) => {
|
|
self.check_expr_type(&draw.x, &NesType::U8);
|
|
self.check_expr_type(&draw.y, &NesType::U8);
|
|
if let Some(frame) = &draw.frame {
|
|
self.check_expr_type(frame, &NesType::U8);
|
|
}
|
|
}
|
|
Statement::Return(Some(expr), _) => {
|
|
// For M1, just validate the expression without checking return type
|
|
let _ = self.infer_type(expr);
|
|
}
|
|
Statement::Call(name, _args, span) => {
|
|
if !self.symbols.contains_key(name) {
|
|
self.diagnostics.push(Diagnostic::error(
|
|
ErrorCode::E0503,
|
|
format!("undefined function '{name}'"),
|
|
*span,
|
|
));
|
|
}
|
|
}
|
|
Statement::Break(_)
|
|
| Statement::Continue(_)
|
|
| Statement::WaitFrame(_)
|
|
| Statement::Return(None, _) => {}
|
|
}
|
|
}
|
|
|
|
fn lvalue_type(&self, lvalue: &LValue, _span: Span) -> Option<NesType> {
|
|
match lvalue {
|
|
LValue::Var(name) => self.symbols.get(name).map(|s| s.sym_type.clone()),
|
|
LValue::ArrayIndex(name, _) => {
|
|
self.symbols.get(name).and_then(|sym| match &sym.sym_type {
|
|
NesType::Array(elem, _) => Some(elem.as_ref().clone()),
|
|
_ => None,
|
|
})
|
|
}
|
|
}
|
|
}
|
|
|
|
fn check_expr_type(&mut self, expr: &Expr, expected: &NesType) {
|
|
let actual = self.infer_type(expr);
|
|
if let Some(actual) = actual {
|
|
// Allow numeric comparisons to produce bool
|
|
if *expected == NesType::Bool && actual == NesType::Bool {
|
|
return;
|
|
}
|
|
// For M1: be lenient about integer types in conditions
|
|
// button reads produce bool
|
|
if *expected == NesType::Bool {
|
|
match expr {
|
|
Expr::ButtonRead(..)
|
|
| Expr::BinaryOp(
|
|
_,
|
|
BinOp::Eq
|
|
| BinOp::NotEq
|
|
| BinOp::Lt
|
|
| BinOp::Gt
|
|
| BinOp::LtEq
|
|
| BinOp::GtEq,
|
|
_,
|
|
_,
|
|
)
|
|
| Expr::UnaryOp(UnaryOp::Not, _, _)
|
|
| Expr::BinaryOp(_, BinOp::And | BinOp::Or, _, _) => return,
|
|
_ => {}
|
|
}
|
|
}
|
|
if actual != *expected {
|
|
// Allow implicit u8/i8/u16 in assignments for M1 simplicity
|
|
if is_integer_type(&actual) && is_integer_type(expected) {
|
|
return;
|
|
}
|
|
self.diagnostics.push(
|
|
Diagnostic::error(
|
|
ErrorCode::E0201,
|
|
format!("type mismatch: expected {expected}, found {actual}"),
|
|
expr.span(),
|
|
)
|
|
.with_help(format!("use 'as {expected}' for explicit conversion")),
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
fn infer_type(&self, expr: &Expr) -> Option<NesType> {
|
|
match expr {
|
|
Expr::IntLiteral(v, _) => {
|
|
if *v <= 255 {
|
|
Some(NesType::U8)
|
|
} else {
|
|
Some(NesType::U16)
|
|
}
|
|
}
|
|
Expr::BoolLiteral(_, _) => Some(NesType::Bool),
|
|
Expr::Ident(name, _) => self.symbols.get(name).map(|s| s.sym_type.clone()),
|
|
Expr::ButtonRead(_, _, _) => Some(NesType::Bool),
|
|
Expr::BinaryOp(_, op, _, _) => match op {
|
|
BinOp::Eq
|
|
| BinOp::NotEq
|
|
| BinOp::Lt
|
|
| BinOp::Gt
|
|
| BinOp::LtEq
|
|
| BinOp::GtEq
|
|
| BinOp::And
|
|
| BinOp::Or => Some(NesType::Bool),
|
|
_ => Some(NesType::U8), // Simplified for M1
|
|
},
|
|
Expr::UnaryOp(UnaryOp::Not, _, _) => Some(NesType::Bool),
|
|
Expr::UnaryOp(_, _, _) => Some(NesType::U8),
|
|
Expr::Call(_, _, _) => Some(NesType::U8), // Simplified for M1
|
|
Expr::ArrayIndex(name, _, _) => {
|
|
self.symbols.get(name).and_then(|s| match &s.sym_type {
|
|
NesType::Array(elem, _) => Some(elem.as_ref().clone()),
|
|
_ => None,
|
|
})
|
|
}
|
|
Expr::ArrayLiteral(_, _) => Some(NesType::U8), // element type inferred from context
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Collect all function/call names from a block.
|
|
fn collect_calls(block: &Block) -> Vec<String> {
|
|
let mut calls = Vec::new();
|
|
for stmt in &block.statements {
|
|
collect_calls_stmt(stmt, &mut calls);
|
|
}
|
|
calls
|
|
}
|
|
|
|
fn collect_calls_stmt(stmt: &Statement, calls: &mut Vec<String>) {
|
|
match stmt {
|
|
Statement::Call(name, args, _) => {
|
|
calls.push(name.clone());
|
|
for arg in args {
|
|
collect_calls_expr(arg, calls);
|
|
}
|
|
}
|
|
Statement::If(cond, then_b, elifs, else_b, _) => {
|
|
collect_calls_expr(cond, calls);
|
|
collect_calls_block(then_b, calls);
|
|
for (c, b) in elifs {
|
|
collect_calls_expr(c, calls);
|
|
collect_calls_block(b, calls);
|
|
}
|
|
if let Some(b) = else_b {
|
|
collect_calls_block(b, calls);
|
|
}
|
|
}
|
|
Statement::While(cond, body, _) => {
|
|
collect_calls_expr(cond, calls);
|
|
collect_calls_block(body, calls);
|
|
}
|
|
Statement::Loop(body, _) => {
|
|
collect_calls_block(body, calls);
|
|
}
|
|
Statement::Assign(_, _, expr, _) => {
|
|
collect_calls_expr(expr, calls);
|
|
}
|
|
Statement::VarDecl(var) => {
|
|
if let Some(init) = &var.init {
|
|
collect_calls_expr(init, calls);
|
|
}
|
|
}
|
|
Statement::Return(Some(expr), _) => {
|
|
collect_calls_expr(expr, calls);
|
|
}
|
|
Statement::Draw(draw) => {
|
|
collect_calls_expr(&draw.x, calls);
|
|
collect_calls_expr(&draw.y, calls);
|
|
if let Some(f) = &draw.frame {
|
|
collect_calls_expr(f, calls);
|
|
}
|
|
}
|
|
Statement::Return(None, _)
|
|
| Statement::Transition(_, _)
|
|
| Statement::WaitFrame(_)
|
|
| Statement::Break(_)
|
|
| Statement::Continue(_) => {}
|
|
}
|
|
}
|
|
|
|
fn collect_calls_block(block: &Block, calls: &mut Vec<String>) {
|
|
for stmt in &block.statements {
|
|
collect_calls_stmt(stmt, calls);
|
|
}
|
|
}
|
|
|
|
fn collect_calls_expr(expr: &Expr, calls: &mut Vec<String>) {
|
|
match expr {
|
|
Expr::Call(name, args, _) => {
|
|
calls.push(name.clone());
|
|
for arg in args {
|
|
collect_calls_expr(arg, calls);
|
|
}
|
|
}
|
|
Expr::BinaryOp(lhs, _, rhs, _) => {
|
|
collect_calls_expr(lhs, calls);
|
|
collect_calls_expr(rhs, calls);
|
|
}
|
|
Expr::UnaryOp(_, inner, _) => {
|
|
collect_calls_expr(inner, calls);
|
|
}
|
|
Expr::ArrayIndex(_, idx, _) => {
|
|
collect_calls_expr(idx, calls);
|
|
}
|
|
Expr::ArrayLiteral(elems, _) => {
|
|
for e in elems {
|
|
collect_calls_expr(e, calls);
|
|
}
|
|
}
|
|
Expr::IntLiteral(_, _)
|
|
| Expr::BoolLiteral(_, _)
|
|
| Expr::Ident(_, _)
|
|
| Expr::ButtonRead(_, _, _) => {}
|
|
}
|
|
}
|
|
|
|
/// Detect cycles in the call graph using DFS. Returns the names of all
|
|
/// functions that participate in a cycle (direct or mutual recursion).
|
|
fn detect_recursion(graph: &HashMap<String, Vec<String>>) -> Vec<String> {
|
|
let mut recursive = Vec::new();
|
|
let mut visited = HashSet::new();
|
|
let mut on_stack = HashSet::new();
|
|
|
|
for node in graph.keys() {
|
|
if !visited.contains(node) {
|
|
detect_recursion_dfs(node, graph, &mut visited, &mut on_stack, &mut recursive);
|
|
}
|
|
}
|
|
|
|
recursive.sort();
|
|
recursive.dedup();
|
|
recursive
|
|
}
|
|
|
|
fn detect_recursion_dfs(
|
|
node: &str,
|
|
graph: &HashMap<String, Vec<String>>,
|
|
visited: &mut HashSet<String>,
|
|
on_stack: &mut HashSet<String>,
|
|
recursive: &mut Vec<String>,
|
|
) {
|
|
visited.insert(node.to_string());
|
|
on_stack.insert(node.to_string());
|
|
|
|
if let Some(callees) = graph.get(node) {
|
|
for callee in callees {
|
|
if on_stack.contains(callee) {
|
|
// Found a cycle — mark the callee (the one we recursed back to)
|
|
recursive.push(callee.clone());
|
|
} else if !visited.contains(callee) {
|
|
detect_recursion_dfs(callee, graph, visited, on_stack, recursive);
|
|
}
|
|
}
|
|
}
|
|
|
|
on_stack.remove(node);
|
|
}
|
|
|
|
/// Compute the maximum call depth starting from a given node in the call graph.
|
|
/// Returns `None` if a cycle is encountered (handled separately by recursion detection).
|
|
fn compute_depth(
|
|
node: &str,
|
|
graph: &HashMap<String, Vec<String>>,
|
|
visited: &mut HashSet<String>,
|
|
cache: &mut HashMap<String, u32>,
|
|
) -> u32 {
|
|
if let Some(&depth) = cache.get(node) {
|
|
return depth;
|
|
}
|
|
if visited.contains(node) {
|
|
// Cycle — return 0 to avoid infinite recursion; the cycle itself
|
|
// is flagged by detect_recursion.
|
|
return 0;
|
|
}
|
|
visited.insert(node.to_string());
|
|
let mut max_child: u32 = 0;
|
|
if let Some(callees) = graph.get(node) {
|
|
for callee in callees {
|
|
let child = compute_depth(callee, graph, visited, cache);
|
|
max_child = max_child.max(child);
|
|
}
|
|
}
|
|
visited.remove(node);
|
|
let depth = if graph.get(node).is_none_or(Vec::is_empty) {
|
|
0
|
|
} else {
|
|
1 + max_child
|
|
};
|
|
cache.insert(node.to_string(), depth);
|
|
depth
|
|
}
|
|
|
|
fn type_size(t: &NesType) -> u16 {
|
|
match t {
|
|
NesType::U8 | NesType::I8 | NesType::Bool => 1,
|
|
NesType::U16 => 2,
|
|
NesType::Array(elem, count) => type_size(elem) * count,
|
|
}
|
|
}
|
|
|
|
fn is_integer_type(t: &NesType) -> bool {
|
|
matches!(t, NesType::U8 | NesType::I8 | NesType::U16)
|
|
}
|