Add support for global variables without type annotation #548

Merged
sb10q merged 4 commits from enhance/global-var into master 2024-10-08 09:05:38 +08:00
6 changed files with 131 additions and 108 deletions

View File

@ -1,6 +1,6 @@
use std::rc::Rc; use std::rc::Rc;
use nac3parser::ast::{fold::Fold, ExprKind}; use nac3parser::ast::{fold::Fold, ExprKind, Ident};
use super::*; use super::*;
use crate::{ use crate::{
@ -382,32 +382,66 @@ impl TopLevelComposer {
)) ))
} }
ast::StmtKind::Assign { .. } => {
// Assignment statements can assign to (and therefore create) more than one
// variable, but this function only allows returning one set of symbol information.
Outdated
Review

It's rather confusing why there is such a difference between Assign and AnnAssign. Maybe further code comments would help?

It's rather confusing why there is such a difference between Assign and AnnAssign. Maybe further code comments would help?

Added a code comment explaining why the difference in behavior.

Added a code comment explaining why the difference in behavior.
// We want to avoid changing this to return a `Vec` of symbol info, as this would
// require `iter().next().unwrap()` on every variable created from a non-Assign
// statement.
//
// Make callers use `register_top_level_var` instead, as it provides more
// fine-grained control over which symbols to register, while also simplifying the
// usage of this function.
panic!("Registration of top-level Assign statements must use TopLevelComposer::register_top_level_var (at {})", ast.location);
}
ast::StmtKind::AnnAssign { target, annotation, .. } => { ast::StmtKind::AnnAssign { target, annotation, .. } => {
let ExprKind::Name { id: name, .. } = target.node else { let ExprKind::Name { id: name, .. } = target.node else {
return Err(format!( return Err(format!(
"global variable declaration must be an identifier (at {})", "global variable declaration must be an identifier (at {})",
ast.location target.location
)); ));
}; };
if self.keyword_list.contains(&name) { self.register_top_level_var(
return Err(format!(
"cannot use keyword `{}` as a class name (at {})",
name, name,
ast.location Some(annotation.as_ref().clone()),
)); resolver,
mod_path,
target.location,
)
} }
let global_var_name = if mod_path.is_empty() { _ => Err(format!(
name.to_string() "registrations of constructs other than top level classes/functions/variables are not supported (at {})",
} else {
format!("{mod_path}.{name}")
};
if !defined_names.insert(global_var_name.clone()) {
return Err(format!(
"global variable `{}` defined twice (at {})",
global_var_name,
ast.location ast.location
)),
}
}
/// Registers a top-level variable with the given `name` into the composer.
///
/// `annotation` - The type annotation of the top-level variable, or [`None`] if no type
/// annotation is provided.
/// `location` - The location of the top-level variable.
pub fn register_top_level_var(
&mut self,
name: Ident,
annotation: Option<Expr>,
resolver: Option<Arc<dyn SymbolResolver + Send + Sync>>,
mod_path: &str,
location: Location,
) -> Result<(StrRef, DefinitionId, Option<Type>), String> {
if self.keyword_list.contains(&name) {
return Err(format!("cannot use keyword `{name}` as a class name (at {location})"));
}
let global_var_name =
if mod_path.is_empty() { name.to_string() } else { format!("{mod_path}.{name}") };
if !self.defined_names.insert(global_var_name.clone()) {
return Err(format!(
"global variable `{global_var_name}` defined twice (at {location})"
)); ));
} }
@ -418,25 +452,15 @@ impl TopLevelComposer {
name, name,
// dummy here, unify with correct type later, // dummy here, unify with correct type later,
ty_to_be_unified, ty_to_be_unified,
*(annotation.clone()), annotation,
resolver, resolver,
Some(ast.location), Some(location),
)).into(), ))
.into(),
None, None,
)); ));
Ok(( Ok((name, DefinitionId(self.definition_ast_list.len() - 1), Some(ty_to_be_unified)))
name,
DefinitionId(self.definition_ast_list.len() - 1),
Some(ty_to_be_unified),
))
}
_ => Err(format!(
"registrations of constructs other than top level classes/functions/variables are not supported (at {})",
ast.location
)),
}
} }
pub fn start_analysis(&mut self, inference: bool) -> Result<(), HashSet<String>> { pub fn start_analysis(&mut self, inference: bool) -> Result<(), HashSet<String>> {
@ -2249,9 +2273,8 @@ impl TopLevelComposer {
let primitives_store = &self.primitives_ty; let primitives_store = &self.primitives_ty;
let mut analyze = |variable_def: &Arc<RwLock<TopLevelDef>>| -> Result<_, HashSet<String>> { let mut analyze = |variable_def: &Arc<RwLock<TopLevelDef>>| -> Result<_, HashSet<String>> {
let variable_def = &mut *variable_def.write(); let TopLevelDef::Variable { ty: dummy_ty, ty_decl, resolver, loc, .. } =
&*variable_def.read()
let TopLevelDef::Variable { ty: dummy_ty, ty_decl, resolver, loc, .. } = variable_def
else { else {
// not top level variable def, skip // not top level variable def, skip
return Ok(()); return Ok(());
@ -2259,6 +2282,7 @@ impl TopLevelComposer {
let resolver = &**resolver.as_ref().unwrap(); let resolver = &**resolver.as_ref().unwrap();
if let Some(ty_decl) = ty_decl {
let ty_annotation = parse_ast_to_type_annotation_kinds( let ty_annotation = parse_ast_to_type_annotation_kinds(
resolver, resolver,
&temp_def_list, &temp_def_list,
@ -2278,6 +2302,8 @@ impl TopLevelComposer {
unifier.unify(*dummy_ty, ty_from_ty_annotation).map_err(|e| { unifier.unify(*dummy_ty, ty_from_ty_annotation).map_err(|e| {
HashSet::from([e.at(Some(loc.unwrap())).to_display(unifier).to_string()]) HashSet::from([e.at(Some(loc.unwrap())).to_display(unifier).to_string()])
})?; })?;
}
Ok(()) Ok(())
}; };

View File

@ -600,7 +600,7 @@ impl TopLevelComposer {
name: String, name: String,
simple_name: StrRef, simple_name: StrRef,
ty: Type, ty: Type,
ty_decl: Expr, ty_decl: Option<Expr>,
resolver: Option<Arc<dyn SymbolResolver + Send + Sync>>, resolver: Option<Arc<dyn SymbolResolver + Send + Sync>>,
loc: Option<Location>, loc: Option<Location>,
) -> TopLevelDef { ) -> TopLevelDef {

View File

@ -158,8 +158,8 @@ pub enum TopLevelDef {
/// Type of the global variable. /// Type of the global variable.
ty: Type, ty: Type,
/// The declared type of the global variable. /// The declared type of the global variable, or [`None`] if no type annotation is provided.
ty_decl: Expr, ty_decl: Option<Expr>,
/// Symbol resolver of the module defined the class. /// Symbol resolver of the module defined the class.
resolver: Option<Arc<dyn SymbolResolver + Send + Sync>>, resolver: Option<Arc<dyn SymbolResolver + Send + Sync>>,

View File

@ -36,7 +36,7 @@ impl<'a> Inferencer<'a> {
ExprKind::Name { id, .. } => { ExprKind::Name { id, .. } => {
// If `id` refers to a declared symbol, reject this assignment if it is used in the // If `id` refers to a declared symbol, reject this assignment if it is used in the
// context of an (implicit) global variable // context of an (implicit) global variable
if let Some(id_info) = self.defined_identifiers.get(id) { if let Some(id_info) = defined_identifiers.get(id) {
if matches!( if matches!(
id_info.source, id_info.source,
DeclarationSource::Global { is_explicit: Some(false) } DeclarationSource::Global { is_explicit: Some(false) }

View File

@ -7,7 +7,7 @@ def output_int64(x: int64):
... ...
X: int32 = 0 X: int32 = 0
Y: int64 = int64(1) Y = int64(1)
def f(): def f():
global X, Y global X, Y

View File

@ -174,46 +174,49 @@ fn handle_typevar_definition(
fn handle_assignment_pattern( fn handle_assignment_pattern(
targets: &[Expr], targets: &[Expr],
value: &Expr, value: &Expr,
resolver: &(dyn SymbolResolver + Send + Sync), resolver: Arc<dyn SymbolResolver + Send + Sync>,
internal_resolver: &ResolverInternal, internal_resolver: &ResolverInternal,
def_list: &[Arc<RwLock<TopLevelDef>>], composer: &mut TopLevelComposer,
unifier: &mut Unifier,
primitives: &PrimitiveStore,
) -> Result<(), String> { ) -> Result<(), String> {
if targets.len() == 1 { if targets.len() == 1 {
match &targets[0].node { let target = &targets[0];
match &target.node {
ExprKind::Name { id, .. } => { ExprKind::Name { id, .. } => {
let def_list = composer.extract_def_list();
let unifier = &mut composer.unifier;
let primitives = &composer.primitives_ty;
if let Ok(var) = if let Ok(var) =
handle_typevar_definition(value, resolver, def_list, unifier, primitives) handle_typevar_definition(value, &*resolver, &def_list, unifier, primitives)
{ {
internal_resolver.add_id_type(*id, var); internal_resolver.add_id_type(*id, var);
Ok(()) Ok(())
} else if let Ok(val) = parse_parameter_default_value(value, resolver) { } else if let Ok(val) = parse_parameter_default_value(value, &*resolver) {
internal_resolver.add_module_global(*id, val); internal_resolver.add_module_global(*id, val);
let (name, def_id, _) = composer
.register_top_level_var(
*id,
None,
Some(resolver.clone()),
"__main__",
target.location,
)
.unwrap();
internal_resolver.add_id_def(name, def_id);
Ok(()) Ok(())
} else { } else {
Err(format!("fails to evaluate this expression `{:?}` as a constant or generic parameter at {}", Err(format!("fails to evaluate this expression `{:?}` as a constant or generic parameter at {}",
targets[0].node, target.node,
targets[0].location, target.location,
)) ))
} }
} }
ExprKind::List { elts, .. } | ExprKind::Tuple { elts, .. } => { ExprKind::List { elts, .. } | ExprKind::Tuple { elts, .. } => {
handle_assignment_pattern( handle_assignment_pattern(elts, value, resolver, internal_resolver, composer)?;
elts,
value,
resolver,
internal_resolver,
def_list,
unifier,
primitives,
)?;
Ok(()) Ok(())
} }
_ => Err(format!( _ => Err(format!("assignment to {target:?} is not supported at {}", target.location)),
"assignment to {:?} is not supported at {}",
targets[0], targets[0].location
)),
} }
} else { } else {
match &value.node { match &value.node {
@ -223,11 +226,9 @@ fn handle_assignment_pattern(
handle_assignment_pattern( handle_assignment_pattern(
std::slice::from_ref(tar), std::slice::from_ref(tar),
val, val,
resolver, resolver.clone(),
internal_resolver, internal_resolver,
def_list, composer,
unifier,
primitives,
)?; )?;
} }
Ok(()) Ok(())
@ -248,8 +249,9 @@ fn handle_assignment_pattern(
fn handle_global_var( fn handle_global_var(
target: &Expr, target: &Expr,
value: Option<&Expr>, value: Option<&Expr>,
resolver: &(dyn SymbolResolver + Send + Sync), resolver: &Arc<dyn SymbolResolver + Send + Sync>,
internal_resolver: &ResolverInternal, internal_resolver: &ResolverInternal,
composer: &mut TopLevelComposer,
) -> Result<(), String> { ) -> Result<(), String> {
let ExprKind::Name { id, .. } = target.node else { let ExprKind::Name { id, .. } = target.node else {
return Err(format!( return Err(format!(
@ -262,8 +264,12 @@ fn handle_global_var(
return Err(format!("global variable `{id}` must be initialized in its definition")); return Err(format!("global variable `{id}` must be initialized in its definition"));
}; };
if let Ok(val) = parse_parameter_default_value(value, resolver) { if let Ok(val) = parse_parameter_default_value(value, &**resolver) {
internal_resolver.add_module_global(id, val); internal_resolver.add_module_global(id, val);
let (name, def_id, _) = composer
.register_top_level_var(id, None, Some(resolver.clone()), "__main__", target.location)
.unwrap();
internal_resolver.add_id_def(name, def_id);
Ok(()) Ok(())
} else { } else {
Err(format!( Err(format!(
@ -355,17 +361,12 @@ fn main() {
for stmt in parser_result { for stmt in parser_result {
match &stmt.node { match &stmt.node {
StmtKind::Assign { targets, value, .. } => { StmtKind::Assign { targets, value, .. } => {
let def_list = composer.extract_def_list();
let unifier = &mut composer.unifier;
let primitives = &composer.primitives_ty;
if let Err(err) = handle_assignment_pattern( if let Err(err) = handle_assignment_pattern(
targets, targets,
value, value,
resolver.as_ref(), resolver.clone(),
internal_resolver.as_ref(), internal_resolver.as_ref(),
&def_list, &mut composer,
unifier,
primitives,
) { ) {
panic!("{err}"); panic!("{err}");
} }
@ -375,16 +376,12 @@ fn main() {
if let Err(err) = handle_global_var( if let Err(err) = handle_global_var(
target, target,
value.as_ref().map(Box::as_ref), value.as_ref().map(Box::as_ref),
resolver.as_ref(), &resolver,
internal_resolver.as_ref(), internal_resolver.as_ref(),
&mut composer,
) { ) {
panic!("{err}"); panic!("{err}");
} }
let (name, def_id, _) = composer
.register_top_level(stmt, Some(resolver.clone()), "__main__", true)
.unwrap();
internal_resolver.add_id_def(name, def_id);
} }
// allow (and ignore) "from __future__ import annotations" // allow (and ignore) "from __future__ import annotations"