Rename AST option flags.

src/ast/expr.rs

@@ -378,9 +378,9 @@ pub enum Expr {
     Stmt(Box<StmtBlock>),
     /// func `(` expr `,` ... `)`
     FnCall(Box<FnCallExpr>, Position),
-    /// lhs `.` rhs - bool variable is a dummy
+    /// lhs `.` rhs - boolean variable is a dummy
     Dot(Box<BinaryExpr>, bool, Position),
-    /// expr `[` expr `]` - boolean indicates whether the dotting/indexing chain stops
+    /// lhs `[` rhs `]` - boolean indicates whether the dotting/indexing chain stops
     Index(Box<BinaryExpr>, bool, Position),
     /// lhs `&&` rhs
     And(Box<BinaryExpr>, Position),

src/ast/flags.rs

@@ -13,8 +13,12 @@ pub enum FnAccess {
     Private,
 }
 
-/// A type that holds a configuration option with bit-flags.
-/// Exported under the `internals` feature only.
+/// A type that holds a configuration option with bit-flags. Exported under the `internals` feature
+/// only.
+///
+/// Functionality-wise, this type is a naive and simplistic implementation of
+/// [`bit_flags`](https://crates.io/crates/bitflags).  It is re-implemented to avoid pulling in yet
+/// one more dependency.
 #[derive(PartialEq, Eq, Copy, Clone, Hash, Default)]
 pub struct OptionFlags(u8);
 
@@ -120,19 +124,20 @@ pub mod AST_OPTION_FLAGS {
     /// _(internals)_ The [`AST`][crate::AST] node is constant.
     /// Exported under the `internals` feature only.
     pub const AST_OPTION_CONSTANT: OptionFlags = OptionFlags(0b0000_0001);
-    /// _(internals)_ The [`AST`][crate::AST] node is public.
+    /// _(internals)_ The [`AST`][crate::AST] node is exported to the outside (i.e. public).
     /// Exported under the `internals` feature only.
-    pub const AST_OPTION_PUBLIC: OptionFlags = OptionFlags(0b0000_0010);
-    /// _(internals)_ The [`AST`][crate::AST] node is in negated mode.
+    pub const AST_OPTION_EXPORTED: OptionFlags = OptionFlags(0b0000_0010);
+    /// _(internals)_ The [`AST`][crate::AST] node is in negated mode
+    /// (meaning whatever information is the opposite).
     /// Exported under the `internals` feature only.
     pub const AST_OPTION_NEGATED: OptionFlags = OptionFlags(0b0000_0100);
     /// _(internals)_ The [`AST`][crate::AST] node breaks out of normal control flow.
     /// Exported under the `internals` feature only.
-    pub const AST_OPTION_BREAK_OUT: OptionFlags = OptionFlags(0b0000_1000);
+    pub const AST_OPTION_BREAK: OptionFlags = OptionFlags(0b0000_1000);
     /// _(internals)_ Mask of all options.
     /// Exported under the `internals` feature only.
     pub(crate) const AST_OPTION_ALL: OptionFlags = OptionFlags(
-        AST_OPTION_CONSTANT.0 | AST_OPTION_PUBLIC.0 | AST_OPTION_NEGATED.0 | AST_OPTION_BREAK_OUT.0,
+        AST_OPTION_CONSTANT.0 | AST_OPTION_EXPORTED.0 | AST_OPTION_NEGATED.0 | AST_OPTION_BREAK.0,
     );
 
     impl std::fmt::Debug for OptionFlags {
@@ -158,9 +163,9 @@ pub mod AST_OPTION_FLAGS {
 
             f.write_str("(")?;
             write_option(self, f, num_flags, AST_OPTION_CONSTANT, "Constant")?;
-            write_option(self, f, num_flags, AST_OPTION_PUBLIC, "Public")?;
+            write_option(self, f, num_flags, AST_OPTION_EXPORTED, "Exported")?;
             write_option(self, f, num_flags, AST_OPTION_NEGATED, "Negated")?;
-            write_option(self, f, num_flags, AST_OPTION_BREAK_OUT, "Break")?;
+            write_option(self, f, num_flags, AST_OPTION_BREAK, "Break")?;
             f.write_str(")")?;
 
             Ok(())

src/ast/stmt.rs

@@ -1,6 +1,6 @@
 //! Module defining script statements.
 
-use super::{ASTNode, Expr, FnCallExpr, Ident, OptionFlags, AST_OPTION_FLAGS};
+use super::{ASTNode, Expr, FnCallExpr, Ident, OptionFlags, AST_OPTION_FLAGS::*};
 use crate::engine::KEYWORD_EVAL;
 use crate::tokenizer::Token;
 use crate::{calc_fn_hash, Position, StaticVec, INT};
@@ -228,8 +228,8 @@ pub enum Stmt {
     ///
     /// ### Option Flags
     ///
-    /// * [`AST_OPTION_NONE`][AST_OPTION_FLAGS::AST_OPTION_NONE] = `while`
-    /// * [`AST_OPTION_NEGATED`][AST_OPTION_FLAGS::AST_OPTION_NEGATED] = `until`
+    /// * [`AST_OPTION_NONE`] = `while`
+    /// * [`AST_OPTION_NEGATED`] = `until`
     Do(Box<StmtBlock>, Expr, OptionFlags, Position),
     /// `for` `(` id `,` counter `)` `in` expr `{` stmt `}`
     For(Expr, Box<(Ident, Option<Ident>, StmtBlock)>, Position),
@@ -237,8 +237,8 @@ pub enum Stmt {
     ///
     /// ### Option Flags
     ///
-    /// * [`AST_OPTION_PUBLIC`][AST_OPTION_FLAGS::AST_OPTION_PUBLIC] = `export`
-    /// * [`AST_OPTION_CONSTANT`][AST_OPTION_FLAGS::AST_OPTION_CONSTANT] = `const`
+    /// * [`AST_OPTION_EXPORTED`] = `export`
+    /// * [`AST_OPTION_CONSTANT`] = `const`
     Var(Expr, Box<Ident>, OptionFlags, Position),
     /// expr op`=` expr
     Assignment(Box<(Expr, Option<OpAssignment<'static>>, Expr)>, Position),
@@ -257,15 +257,15 @@ pub enum Stmt {
     ///
     /// ### Option Flags
     ///
-    /// * [`AST_OPTION_NONE`][AST_OPTION_FLAGS::AST_OPTION_NONE] = `continue`
-    /// * [`AST_OPTION_BREAK_OUT`][AST_OPTION_FLAGS::AST_OPTION_BREAK_OUT] = `break`
+    /// * [`AST_OPTION_NONE`] = `continue`
+    /// * [`AST_OPTION_BREAK`] = `break`
     BreakLoop(OptionFlags, Position),
     /// `return`/`throw`
     ///
     /// ### Option Flags
     ///
-    /// * [`AST_OPTION_NONE`][AST_OPTION_FLAGS::AST_OPTION_NONE] = `return`
-    /// * [`AST_OPTION_BREAK_OUT`][AST_OPTION_FLAGS::AST_OPTION_BREAK_OUT] = `throw`
+    /// * [`AST_OPTION_NONE`] = `return`
+    /// * [`AST_OPTION_BREAK`] = `throw`
     Return(OptionFlags, Option<Expr>, Position),
     /// `import` expr `as` var
     ///
@@ -459,7 +459,7 @@ impl Stmt {
             // Loops that exit can be pure because it can never be infinite.
             Self::While(Expr::BoolConstant(false, _), _, _) => true,
             Self::Do(body, Expr::BoolConstant(x, _), options, _)
-                if *x == options.contains(AST_OPTION_FLAGS::AST_OPTION_NEGATED) =>
+                if *x == options.contains(AST_OPTION_NEGATED) =>
             {
                 body.iter().all(Stmt::is_pure)
             }