1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
/* * ****************************************************************************************** * Copyright (c) 2019 Pascal Kuthe. This file is part of the OpenVAF project. * It is subject to the license terms in the LICENSE file found in the top-level directory * of this distribution and at https://gitlab.com/DSPOM/OpenVAF/blob/master/LICENSE. * No part of OpenVAF, including this file, may be copied, modified, propagated, or * distributed except according to the terms contained in the LICENSE file. * ***************************************************************************************** */ use crate::ast::HierarchicalId; use crate::ast_lowering::error::Type::NotAScope; use crate::ast_lowering::error::*; #[doc(inline)] pub use crate::resolve; #[doc(inline)] pub use crate::resolve_hierarchical; use crate::symbol::Ident; use crate::symbol_table::{SymbolDeclaration, SymbolTable}; use crate::Ast; /// A macro that hides the boiler plate required for name resolution using the resolver struct /// It is defined in the [`name_resolution`](crate::ast_lowering::name_resolution) module but due to limitations of rustdoc can't be shown there in the documentation /// If `$name` wasn't found or doesn't math any [`SymbolDeclaration`](crate::symbol_table::SymbolDeclaration)::`$declaration` the appropriate errors are added to `$self`.errors and execution continuous after the macro /// /// # Arguments /// /// * `$self` - reference to an ast fold (implementation of the [`Fold`](crate::ast_lowering::ast_to_hir_fold::Fold) trait) /// /// * `$name` - The Identifier (type [`Ident`](crate::symbol::Ident)) that should be resolved /// /// The following three arguments can be repeated as often as necessary (like in a match block) /// /// * `$declaration` An identifier of an [`SymbolDeclaration`](crate::symbol_table::SymbolDeclaration) variant which you wish to resolve `$name`as /// /// * `$id` The identifier under which the ID of the resolved declaration will be available inside the associated `$block /// /// * `$block` A block (`{`statements`}`) which will be executed when `$name` is resolved as a [`SymbolDeclaration`](crate::symbol_table::SymbolDeclaration)::`$declaration` /// /// # Examples /// /// The following tries to resolve ident as a Nature /// ``` /// use OpenVAF::symbol_table::SymbolDeclaration::Nature; /// use OpenVAF::symbol_table::SymbolDeclaration::Discipline; /// /// resolve!(fold; ident as /// Nature(id) => { /// println!("Resolved nature") /// } /// Discipline(id) => { /// println!("Resolved a discipline") /// } /// ); /// /// println!("Not found or not a discipline/nature") /// ``` #[doc(inline)] #[macro_export] macro_rules! resolve { ($fold:expr; $name:ident as $($declaration:ident($id:ident) => $block:block),+) => { match $fold.resolver.resolve(&$name) { $(Ok($crate::symbol_table::SymbolDeclaration::$declaration($id)) => $block),+ Err(error) => { $fold.error(error); } Ok(found) => { use $crate::ast_lowering::error; $fold.error(Error { error_type: error::Type::DeclarationTypeMismatch { found, expected: vec![$(error::MockSymbolDeclaration::$declaration),+], }, source: $name.span, }); } } }; } /// A macro that hides the boiler plate required for name resolution of hieraichal Identifiers using the resolver struct /// It is defined in the [`name_resolution`](crate::ast_lowering::name_resolution) module but due to limitations of rustdoc can't be shown there in the documentation /// If `$name` wasn't found or doesn't math any [`SymbolDeclaration`](crate::symbol_table::SymbolDeclaration)::`$declaration` the appropriate errors are added to `$self`.errors and execution continuous after the macro /// /// # Arguments /// /// * `$fold` - identifer refering to an [`Fold`](crate::ast_lowering::ast_to_hir_fold::Fold) instance /// /// * `$name` - The Identifier (type [`Ident`](crate::symbol::Ident)) that should be resolved /// /// The following three arguments can be repeated as often as necessary (like in a match block) /// /// * `$declaration` An identifier of an [`SymbolDeclaration`](crate::symbol_table::SymbolDeclaration) variant which you wish to resolve `$name`as /// /// * `$id` The identifier under which the ID of the resolved declaration will be available inside the associated `$block /// /// * `$block` A block (`{`statements`}`) which will be executed when `$name` is resolved as a [`SymbolDeclaration`](crate::symbol_table::SymbolDeclaration)::`$declaration` /// /// # Examples /// /// The following tries to resolve ident as a Nature /// ``` /// use OpenVAF::symbol_table::SymbolDeclaration::Net; /// use OpenVAF::symbol_table::SymbolDeclaration::Port; /// /// resolve_hierarchical!(fold; ident as /// Net(id) => { /// print!("Resolved net") /// } /// Port(id) => { /// print!("Resolved port") /// } /// ); /// /// println!("Not found or not a port/net") /// ``` #[macro_export] macro_rules! resolve_hierarchical { ($fold:expr; $name:ident as $($declaration:ident($id:ident) => $block:block),+) => { match $fold.resolver.resolve_hierarchical($name) { $(Ok($crate::symbol_table::SymbolDeclaration::$declaration($id)) => $block),+ Err(error) => { $fold.error(error); } Ok(found) => { use $crate::ast_lowering::error::*; $fold.error(Error { error_type: Type::DeclarationTypeMismatch { found, expected: vec![$(MockSymbolDeclaration::$declaration),+], }, source: $name.span(), }); } } }; } /// Allows name resolution with the [`resolve`](crate::ast_lowering::name_resolution::Resolver::resolve)/[`resolve_hierarchical`](crate::ast_lowering::name_resolution::Resolver::resolve_hierarchical) methods pub struct Resolver<'lt> { pub scope_stack: Vec<&'lt SymbolTable>, ast: &'lt Ast, inside_function: bool, } impl<'lt> Resolver<'lt> { pub fn new(ast: &'lt Ast) -> Self { Self { scope_stack: Vec::with_capacity(8), ast, inside_function: false, } } pub fn enter_function(&mut self, function_symbol_table: &'lt SymbolTable) { debug_assert!(!self.inside_function, "Already inside a function!"); self.inside_function = true; self.enter_scope(function_symbol_table); } pub fn exit_function(&mut self) -> Option<&'lt SymbolTable> { debug_assert!(self.inside_function, "Not yet inside a function!"); self.inside_function = false; self.exit_scope() } /// Tries to resolve the Identifier `ident` /// /// This functions first tries to find `ident in the current scope, then in the previous scope and so on /// If it can't find ident in the global (first) Scope it returns an NotFound Error pub fn resolve(&self, ident: &Ident) -> Result<SymbolDeclaration> { let mut depth = 0; for scope in self.scope_stack.iter().rev() { if let Some(res) = scope.get(&ident.name) { if self.inside_function && depth > 0 && !matches!(res,SymbolDeclaration::Parameter(_)|SymbolDeclaration::Module(_)) { return Err(Error { error_type: Type::NotAllowedInFunction( NotAllowedInFunction::NonLocalAccess, ), source: ident.span, }); } return Ok(*res); } depth += 1; } Err(Error { error_type: Type::NotFound(ident.name), source: ident.span, }) } /// Tries to resolve the Hierarchical Identifer `hierarchical_ident` /// /// This functions tires to resolve the first identifier using the [`resolve`](crate::ast_lowering::name_resolution::Resolver::resolve) function /// Afterwards it tries to resolve all following identifier inside the scope of the previously resolved Identifier pub fn resolve_hierarchical( &self, hierarchical_ident: &HierarchicalId, ) -> Result<SymbolDeclaration> { let mut identifiers = hierarchical_ident.names.iter(); let (mut current_span, mut current_declaration) = { let first_ident = identifiers.next().unwrap(); (first_ident.span, self.resolve(first_ident)?) }; for ident in identifiers { let symbol_table = match current_declaration { SymbolDeclaration::Module(module) => &self.ast[module].contents.symbol_table, SymbolDeclaration::Block(_) if self.inside_function => { return Err(Error { error_type: Type::NotAllowedInFunction( NotAllowedInFunction::NonLocalAccess, ), source: current_span, }); } SymbolDeclaration::Block(block_id) => { if let Some(scope) = &self.ast[block_id].contents.scope { &scope.symbols } else { return Err(Error { error_type: Type::NotFound(ident.name), source: current_span, }); } } item_without_scope => { return Err(Error { error_type: NotAScope { declaration: item_without_scope.span(self.ast), name: item_without_scope.name(self.ast), }, source: current_span, }); } }; if let Some(found) = symbol_table.get(&ident.name) { current_declaration = *found; current_span = found.span(self.ast); if self.inside_function && !matches!(found,SymbolDeclaration::Parameter(_)|SymbolDeclaration::Module(_)) { return Err(Error { error_type: Type::NotAllowedInFunction( NotAllowedInFunction::NonLocalAccess, ), source: ident.span, }); } } else { return Err(Error { error_type: Type::NotFound(ident.name), source: ident.span, }); } } Ok(current_declaration) } /// Enter a new Scope /// /// This scope will be the first to be searched for identifiers until it is overshadowed by another enter_scope call or it is removed using [`exit_scope`](crate::ast_lowering::name_resolution::Resolver::exit_scope) /// /// # Arguments /// * `scope_symbol_table` - Symbol table in which the resolver will look for definitions in this scope pub fn enter_scope(&mut self, scope_symbol_table: &'lt SymbolTable) { self.scope_stack.push(scope_symbol_table) } /// Leave the current Scope /// /// Items defined in the current scope will not be resolved anymore by this resolver after this method has been called /// /// # Returns /// /// * None if the Resolver doesn't hold any Scopes /// * The Symbol_Table of the removed Scope pub fn exit_scope(&mut self) -> Option<&'lt SymbolTable> { self.scope_stack.pop() } }