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 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
//! Generic Abstract Syntax Support Module
//!
//! Rustlr allows any type that implements the Default trait to be used as
//! the abstract syntax type (grammar directive absyntype). However, this
//! module defines custom smart pointers [LBox] and [LRc] that simplify the
//! construction of abstract syntax trees. LBox/LRc keep the line and column
//! numbers of each syntatic construct, as these are often
//! needed during later stages of code analysis post-parsing.
//!
//! For example, an abstract syntax type can be defined by
//!```text
//! enum Expr {
//! Val(i64),
//! PlusExpr(LBox<Expr>,LBox<Expr>),
//! ...
//! }
//!```
//!```text
//! fn check(e:&Expr) {
//! match e {
//! PlusExpr(a,b) => {
//! println!("checking expressions on lines {} and {}",a.line(),b.line());
//! check(a); check(b); // Deref coercion used here
//! },
//! ...
//!```
//! The [ZCParser::lbx] function can be called from the semantic actions
//! of a grammar
//! to create LBoxed-values that include line/column information. LBox<T>
//! implements the Default trait if T does, so an LBox type can also serve
//! as the absyntract syntax type for a grammar.
//! It is also possible to use `LBox<dyn Any>` as the abstract syntax type
//! along with the [LBox::upcast] and [LBox::downcast] functions and
//! convenience macros [lbup] and [lbdown].
//!
//! Sufficient functionality has also been implemented to allow the use of
//! `LBox<dyn Any>` as the abstract syntax type of Grammars.
//! This effectively allows grammar symbols to carray values of different types
//! as Any-trait objects. The functions [LBox::upcast], [LBox::downcast], [ZCParser::lba],
//! and the convenience macros [lbup], [lbdown] and [lbget]
//! are intended to support this usage. A simplified, sample grammar using
//! `LBox<dyn Any>` as the abstract syntax type returned by the parser is
//! found [here](https://cs.hofstra.edu/~cscccl/rustlr_project/simple.grammar),
//! which generates this LALR [parser](https://cs.hofstra.edu/~cscccl/rustlr_project/simpleparser.rs).
//!
//! Equivalent functions are available for [LRc].
#![allow(dead_code)]
#![allow(unused_variables)]
#![allow(unused_parens)]
#![allow(unused_imports)]
#![allow(unused_mut)]
#![allow(unused_macros)]
#![allow(non_snake_case)]
#![allow(non_camel_case_types)]
#![allow(non_upper_case_globals)]
use std::rc::Rc;
use std::ops::{Deref,DerefMut};
use std::collections::{HashMap,HashSet};
use std::any::Any;
use crate::zc_parser;
use crate::zc_parser::ZCParser;
//use crate::RuntimeParser;
//use crate::GenAbsyn::*;
/// custom smart pointer that encapsulates line number and column. Source
/// ID information is kept at the parser (RuntimeParser or ZCParser) level (since version 0.2.0).
/// For warnings and error messages after the parsing stage. Implements
/// [Deref] and [DerefMut] so the encapsulated expression can be accessed as
/// in a standard Box.
pub struct LBox<T:?Sized>
{
pub exp:Box<T>,
pub line:u32,
pub column:u32,
// must refer to information kept externally
//pub src_id:usize,
}
impl<T> LBox<T>
{
pub fn new(e:T,ln:usize,col:usize /*,src:usize*/) -> LBox<T>
{ LBox { exp:Box::new(e), line:ln as u32, column:col as u32 } }
///should be used to create a new LBoxed expression that inherits
/// lexical information from existing LBox
pub fn transfer<U>(&self,e:U) -> LBox<U>
{
LBox::new(e,self.line(),self.column() /*,self.src_id*/)
}
/// Since version 0.2.4, Rustlr now stores the line and column
/// information internally as u32 values instead of usize, and
/// the [LBox::line] and [LBox::column] functions are provided for
/// interface
pub fn line(&self)-> usize {self.line as usize}
pub fn column(&self)->usize {self.column as usize}
}//impl LBox
impl<T> Deref for LBox<T>
{
type Target = T;
fn deref(&self) -> &Self::Target {
&self.exp
}
}
impl<T> DerefMut for LBox<T>
{
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.exp
}
}
impl<T:Default> Default for LBox<T>
{
fn default() -> Self {LBox::new(T::default(),0,0/*,0*/)}
}
impl<T:Clone> Clone for LBox<T>
{
fn clone(&self) -> Self
{
LBox {
exp : self.exp.clone(),
line: self.line,
column: self.column,
//src_id: self.src_id,
}
}//clone
}
impl<'t> LBox<dyn Any+'t>
{
/// emulates [Box::downcast] function, when `LBox<dyn Any>` is used as
/// the abstract syntax type. Note that unlike Box::downcast, an Option
/// is returned here instead of a result.
pub fn downcast<U:'t>(self) -> Option<LBox<U>>
{
let boxdown = self.exp.downcast::<U>();
if let Err(_) = boxdown {return None;}
Some(LBox {
exp : boxdown.unwrap(),
line: self.line,
column: self.column,
//src_id: self.src_id,
})
}
/// do not try to create a `LBox<dyn Any>` structure with something like
///```
/// let lb:LBox<dyn Any> = LBox::new(String::from("abc"),0,0);
///```
/// This does not work as LBox is simply borrowing the underlying mechanics of
/// [Box] instead of re-creating them. Do instead:
///```
/// let lb:LBox<dyn Any> = LBox::upcast(LBox::new(String::from("abc"),0,0));
///```
/// upcast always returns a `LBox<dyn Any>`.
pub fn upcast<T:'t>(lb:LBox<T>) -> Self
{
let bx:Box<dyn Any+'t> = lb.exp; // this requires Any+'static ??
LBox { exp:bx, line:lb.line, column:lb.column, /*src_id:lb.src_id,*/ }
}
}// downcast/upcast for LBox
///this is provided so `LBox<dyn Any>` can be used for the abstract syntax type.
/// the default is a Lbox containing a static string.
impl Default for LBox<dyn Any>
{
fn default() -> Self {LBox::upcast(LBox::new("LBox<dyn Any> defaults to this string",0,0/*,0*/))}
}
impl<T:std::fmt::Debug> std::fmt::Debug for LBox<T> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
std::fmt::Debug::fmt(&**self, f)
// f.debug_struct("LBox")
// .field("exp", &self.exp)
// .field("y", &self.y)
// .finish()
}
}
///Like LBox but encapsulates an Rc. Implements [Deref] and emulates the
///[Rc::clone] function.
pub struct LRc<T:?Sized>
{
pub exp:Rc<T>,
pub line:u32,
pub column:u32,
//pub src_id:usize,
}
impl<T> LRc<T>
{
pub fn new(e:T,ln:usize,col:usize /*,src:usize*/) -> LRc<T>
{ LRc { exp:Rc::new(e), line:ln as u32, column:col as u32, /*src_id:src*/ } }
//pub fn set_src_id(&mut self, id:usize) {self.src_id=id;}
///should be used to create a new LRc-expression that inherits
/// lexical information from existing LRc
pub fn transfer<U>(&self,e:U) -> LRc<U>
{
LRc::new(e,self.line(),self.column() /*,self.src_id*/)
}
///uses [Rc::clone] to increase reference count of encapsulated Rc,
///copies line, column and source_id information.
pub fn clone(lrc:&LRc<T>) -> LRc<T>
{
LRc {
exp: Rc::clone(&lrc.exp),
line: lrc.line,
column: lrc.column,
//src_id: lrc.src_id,
}
}//clone
pub fn line(&self) -> usize {self.line as usize}
//self.line.try_into().unwrap()}
pub fn column(&self) -> usize {self.column as usize}
}
impl<T:Clone> Clone for LRc<T>
{
fn clone(&self) -> Self
{
LRc::clone(self)
}//clone
}
impl<T> Deref for LRc<T>
{
type Target = T;
fn deref(&self) -> &Self::Target {
&self.exp
}
}
/* DerefMut is not implemented for Rc<T>
impl<T> DerefMut for LRc<T>
{
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.exp
}
}
*/
impl<T:Default> Default for LRc<T>
{
fn default() -> Self {LRc::new(T::default(),0,0/*,0*/)}
}
impl LRc<dyn Any+'static>
{
/// emulates [LRc::downcast] function. Note that unlike Box::downcast,
///an Option is returned here instead of a result.
pub fn downcast<U:'static>(self) -> Option<LRc<U>>
{
let rcdown = self.exp.downcast::<U>();
if let Err(_) = rcdown {return None;}
Some(LRc {
exp : rcdown.unwrap(),
line: self.line,
column: self.column,
//src_id: self.src_id,
})
}
/// upcasts `LRc<T>` to `LRc<dyn Any>`
pub fn upcast<T:'static>(lb:LRc<T>) -> Self
{
let bx:Rc<dyn Any> = lb.exp;
LRc { exp:bx, line:lb.line, column:lb.column, /*src_id:lb.src_id,*/ }
}
}// downcast/upcast for LRc
///this is required if `LRc<dyn Any>` is used for the abstract syntax type
impl Default for LRc<dyn Any+'static>
{
fn default() -> Self {LRc::upcast(LRc::new("LRc<dyn Any> defaults to this string",0,0 /*,0*/))}
}
impl<T:std::fmt::Debug> std::fmt::Debug for LRc<T> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
std::fmt::Debug::fmt(&**self, f)
}
}
// [LBox] specific to [GenAbsyn] type, implements [Debug] and [Clone],
// unlike a generic LBox
type ABox = LBox<GenAbsyn>;
/// Generic Abstract Syntax type: Rustlr offers the user the option
/// of using a ready-made abstract syntax type that should be suitable for
/// ordinary situations. Incorporates the usage of LBox so that abstract
/// syntax trees always carry line/column information for error reporting and
/// warnings. Rustlr will implement an option to produce a parser that
/// uses GenAbsyn in conjunction with [ABox], and a custom parse_generic function
/// that should simplify the process of parsing into abstract syntax.
#[derive(Clone,Debug)]
enum GenAbsyn
{
Integer(i64),
BigInteger(String),
Float(f64),
Symbol(&'static str),
Keyword(&'static str),
Alphanum(String),
Stringlit(String),
Verbatim(String),
Uniop(usize,ABox),
Binop(usize,ABox,ABox),
Ternop(usize,ABox,ABox,ABox),
Sequence(usize,Vec<ABox>),
Partial(ABox,String), // error result, line/column/msg
NewLine,
Whitespaces(usize),
Nothing,
}
impl GenAbsyn
{
fn is_complete(&self) -> bool
{
match self
{
GenAbsyn::Partial(_,_) => false,
GenAbsyn::Uniop(_,s) => {
println!("s.line {}{}",s.line,s.column);
s.is_complete()
},
GenAbsyn::Binop(_,a,b) => a.is_complete() && b.is_complete(),
GenAbsyn::Ternop(_,a,b,c) => a.is_complete() && b.is_complete() && c.is_complete(),
GenAbsyn::Sequence(_,v) => {
for x in v { if !x.is_complete() {return false; } }
true
}
_ => true,
}
}//is_complete
}//impl GenAbsyn
impl Default for GenAbsyn
{
fn default() -> Self { GenAbsyn::Nothing }
}//impl Default
//const KEYWORDS:[&'static str;4] = ["if","while","let","lambda"];
//const SYMBOLS:[&'static str;4] = ["==","(",")",":"];
// don't know what to do with this yet
/// Structure for configuring specific use of [GenAbsyn] type, which
/// provides generic representations of binary, unary, ternary and
/// vectorized operators. GenAbsyn also distinguishes keywords from
/// other alphanumeric and non-alphanumeric symbols. Since these are
/// provided from source code, &'static str is used instead of owned
/// strings. The index of the corresponding &'static str in
/// the static array OPERATORS will determine
/// the usize index that identifies each Binop, Uniop, etc.
struct Absyn_Statics<const N:usize,const M:usize,const P:usize>
{
pub KEYWORDS: [&'static str; N],
pub SYMBOLS: [&'static str; M],
/// indices determine usize identifier of Binop, Uniop, Ternop, etc.
pub OPERATORS: [&'static str; P],
/// maps each string to corresponding index in KEYWORDS
pub Keyhash:HashMap<&'static str,usize>,
pub Symhash:HashMap<&'static str,usize>,
pub Ophash: HashMap<&'static str,usize>,
}
impl<const N:usize,const M:usize,const P:usize> Absyn_Statics<N,M,P>
{
fn new(k:[&'static str; N],s:[&'static str;M],p:[&'static str;P])
-> Absyn_Statics<N,M,P>
{
let mut newas = Absyn_Statics {
KEYWORDS: k,
SYMBOLS: s,
OPERATORS:p,
Keyhash: HashMap::with_capacity(N),
Symhash: HashMap::with_capacity(M),
Ophash: HashMap::with_capacity(P),
};
for i in 0..N { newas.Keyhash.insert(k[i],i); }
for i in 0..M { newas.Symhash.insert(s[i],i); }
for i in 0..P { newas.Ophash.insert(p[i],i); }
return newas;
}//new
pub fn is_keyword(&self,k:&str) -> bool
{ self.Keyhash.contains_key(k) }
pub fn is_symbol(&self,k:&str) -> bool
{ self.Symhash.contains_key(k) }
pub fn is_operator(&self,k:&str) -> bool
{ self.Ophash.contains_key(k) }
}//impl Absyn_Statics
/* //testing - did compile
fn check(e:&GenAbsyn) -> bool {
match e {
Binop(3,x,_) => {
println!("Binop 3 not allowed on line {}, column {}",x.line,x.column);
false
},
Binop(i,a,b) => { check(a) && check(b) },
_ => true
}
}
*/
/*
///macro for creating [LBox] structures, for use in grammar semantic actions: each semantic action associated
/// with a grammar rule is a Rust lambda expression of the form
/// __|parser|{...}__
/// of type __fn(&mut RuntimeParser) -> AT__ where AT is the type of the abstract
/// syntax value defined for the grammar. __lbox!(e)__ expands to **parser.lb(e)**, calling the [RuntimeParser::lb] function.
// The macro can also form an [ABox], which is an alias for LBox<GenAbsyn>
#[macro_export]
macro_rules! lbox {
( $parser:expr,$x:expr ) => {
$parser.lb($x)
};
}
*/
///macro for creating `LBox<dyn Any>` structures that can encapsulate any type
///as abstract syntax. **Must** be called from within the semantic actions of
///a grammar production rule.
#[macro_export]
macro_rules! lbup {
( $x:expr ) => {
LBox::upcast($x)
};
}
/// macro for downcasting `LBox<dyn Any>` to `LBox<A>` for some
/// concrete type A. Must be called
/// from within the semantic actions of grammar productions. **Warning:**
/// **unwrap** is called within the macro
#[macro_export]
macro_rules! lbdown {
( $x:expr,$t:ty ) => {
$x.downcast::<$t>().unwrap()
};
}
/// similar to [lbdown], but also extracts the boxed expression
#[macro_export]
macro_rules! lbget {
( $x:expr,$t:ty ) => {
*$x.downcast::<$t>().unwrap().exp
};
}
/// just extract value from LBox
#[macro_export]
macro_rules! unbox {
( $x:expr ) => {
*$x.exp
};
}
/// macro for creating an [LBox] from a [crate::StackedItem] ($si) popped from
/// the parse stack; should be called from within the semantics actions of
/// a grammar to accurately encode lexical information.
#[macro_export]
macro_rules! makelbox {
($si:expr, $e:expr) => {
LBox::new($e,$si.line,$si.column)
};
}
/// similar to [makelbox] but creates an [LRc] from lexical information
/// inside stack item $si
#[macro_export]
macro_rules! makelrc {
($si:expr, $e:expr) => {
LRc::new($e,$si.line,$si.column)
};
}
/*
// just to see if it compiles
struct BB(usize);
fn testing()
{
let bb1:&dyn Any = &BB(1);
let bb2:Box<dyn Any> = Box::new(BB(2));
let bx:Box<dyn Any> = Box::new(String::from("abc"));
//let b1:LBox<dyn Any> = LBox::new(BB(1),0,0,0); // doesn't work
//let b3:LBox<dyn Any> = LBox::frombox(bb2,0,0,0); // works!
let b5:LBox<BB> = LBox::new(BB(100),0,0,0);
let b6:LBox<dyn Any> = LBox::upcast(b5);
let b4:LBox<BB> = b6.downcast::<BB>().unwrap();
let lb:LBox<dyn Any> = LBox::upcast(LBox::new(String::from("abc"),0,0,0));
//let lbd:LBox<dyn Default> = LBox::upcast(LBox::new(String::from("ab"),0,0,0));
}
*/