Add option to treat [] as parentheses

Blake-Madden · Blake-Madden · commit 8e3b67c57d21 · 2024-03-02T08:02:47.000-05:00
Also fix unit tests when not compiling as C++20. Blake-Madden#13
diff --git a/docs/manual/compile-time-options.qmd b/docs/manual/compile-time-options.qmd
@@ -16,6 +16,13 @@ This flag will also disable all bitwise functions and operators.
 By default, the operators `&`, `|`, and `^` represent logical AND, logical OR, and exponentiation. If `TE_BITWISE_OPERATORS` is defined,
 then they will represent bitwise AND, OR, and XOR.
 
+## `TE_BRACKETS_AS_PARENS` {-}
+
+Define this flag to treat `[]` pairs the same as `()`.
+This can be useful if using the parser for a debugger's watch window.
+For example, an expression such as `[rsp+1000]` would be evaluated as `1000` being added with the variable `rsp`.
+In this context, `rsp` could represent a memory address in the debugger.
+
 ## `TE_NO_BOOKKEEPING` {-}
 
 By default, the parser will keep track of all functions and variables used in the last expression it evaluated.
diff --git a/docs/manual/operators.qmd b/docs/manual/operators.qmd
@@ -38,7 +38,7 @@ For operators, the order of precedence is:
 
 | Operator | Description |
 | :-- | :-- |
-| ( ) | Instructions in parentheses are executed first. |
+| ( ) | Instructions in parentheses are executed first. (If `TE_BRACKETS_AS_PARENS` is defined, then `[]` are treated the same way.) |
 | \+ and - | Positive or negative sign for a value. |
 | ^   | Exponentiation. |
 | \*, /, and % | Multiplication, division, and modulus. |
diff --git a/tests/CMakeLists.txt b/tests/CMakeLists.txt
@@ -63,6 +63,13 @@ else()
     message(STATUS "Extended bitwise operators: disabled")
 endif(TE_BITWISE_OPERATORS)
 
+if(TE_BRACKETS_AS_PARENS)
+    message(STATUS "[] being treats as (): enabled")
+    add_definitions(-DTE_BRACKETS_AS_PARENS)
+else()
+    message(STATUS "[] being treats as (): disabled")
+endif(TE_BRACKETS_AS_PARENS)
+
 # place Catch2 at the same folder level as this repo if it isn't installed
 # (you will need to do this on Windows or macOS or if version 3 of Catch2 isn't installed)
 get_filename_component(_fullpath "${_dir}" REALPATH)
diff --git a/tests/tetests.cpp b/tests/tetests.cpp
@@ -758,6 +758,20 @@ TEST_CASE("Zeros", "[zeros]")
     CHECK(std::isnan(tep.evaluate("(1%0)%1")));
     }
 
+
+TEST_CASE("Braces", "[braces]")
+    {
+    te_type x{ 100 };
+
+    te_parser tep;
+    tep.set_variables_and_functions({ {"x", &x} });
+#ifdef TE_BRACKETS_AS_PARENS
+    CHECK(tep.evaluate("[x+86]") == 186);
+#else
+    CHECK(std::isnan(tep.evaluate("[x+86]")));
+#endif
+    }
+
 TEST_CASE("Functions", "[functions]")
     {
     te_type x{ 0 }, y{ 0 };
@@ -2307,7 +2321,9 @@ TEST_CASE("Rotate operators", "[rotate]")
         CHECK(tep.evaluate("BITRROTATE64(4294967295, -1)") == std::rotr(i, -1));
         }
     }
+#endif
 
+#ifndef TE_FLOAT
 TEST_CASE("Shift operators", "[shift]")
     {
     te_parser tep;
@@ -2403,7 +2419,7 @@ TEST_CASE("Shift operators", "[shift]")
         CHECK(tep.get_last_error_message().empty());
         }
     }
-#else
+#elif defined(TE_FLOAT)
     // just make sure bitwise operators cause an error as they aren't supported for float
     TEST_CASE("Bitwise operators null", "[shift,rotate]")
         {
diff --git a/tinyexpr.cpp b/tinyexpr.cpp
@@ -1195,11 +1195,19 @@ void te_parser::next_token(te_parser::state* theState)
                     theState->m_type = te_parser::state::token_type::TOK_INFIX;
                     theState->m_value = te_builtins::te_modulus;
                     }
+#ifdef TE_BRACKETS_AS_PARENS
+                else if (tok == '(' || tok == '[')
+#else
                 else if (tok == '(')
+#endif
                     {
                     theState->m_type = te_parser::state::token_type::TOK_OPEN;
                     }
+#ifdef TE_BRACKETS_AS_PARENS
+                else if (tok == ')' || tok == ']')
+#else
                 else if (tok == ')')
+#endif
                     {
                     theState->m_type = te_parser::state::token_type::TOK_CLOSE;
                     }

Original file line number	Diff line number	Diff line change
`@@ -758,6 +758,20 @@ TEST_CASE("Zeros", "[zeros]")`
`758`	`758`	`CHECK(std::isnan(tep.evaluate("(1%0)%1")));`
`759`	`759`	`}`
`760`	`760`
	`761`	`+`
	`762`	`+TEST_CASE("Braces", "[braces]")`
	`763`	`+ {`
	`764`	`+ te_type x{ 100 };`
	`765`	`+`
	`766`	`+ te_parser tep;`
	`767`	`+ tep.set_variables_and_functions({ {"x", &x} });`
	`768`	`+#ifdef TE_BRACKETS_AS_PARENS`
	`769`	`+ CHECK(tep.evaluate("[x+86]") == 186);`
	`770`	`+#else`
	`771`	`+ CHECK(std::isnan(tep.evaluate("[x+86]")));`
	`772`	`+#endif`
	`773`	`+ }`
	`774`	`+`
`761`	`775`	`TEST_CASE("Functions", "[functions]")`
`762`	`776`	`{`
`763`	`777`	`te_type x{ 0 }, y{ 0 };`
`@@ -2307,7 +2321,9 @@ TEST_CASE("Rotate operators", "[rotate]")`
`2307`	`2321`	`CHECK(tep.evaluate("BITRROTATE64(4294967295, -1)") == std::rotr(i, -1));`
`2308`	`2322`	`}`
`2309`	`2323`	`}`
	`2324`	`+#endif`
`2310`	`2325`
	`2326`	`+#ifndef TE_FLOAT`
`2311`	`2327`	`TEST_CASE("Shift operators", "[shift]")`
`2312`	`2328`	`{`
`2313`	`2329`	`te_parser tep;`
`@@ -2403,7 +2419,7 @@ TEST_CASE("Shift operators", "[shift]")`
`2403`	`2419`	`CHECK(tep.get_last_error_message().empty());`
`2404`	`2420`	`}`
`2405`	`2421`	`}`
`2406`		`-#else`
	`2422`	`+#elif defined(TE_FLOAT)`
`2407`	`2423`	`// just make sure bitwise operators cause an error as they aren't supported for float`
`2408`	`2424`	`TEST_CASE("Bitwise operators null", "[shift,rotate]")`
`2409`	`2425`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1195,11 +1195,19 @@ void te_parser::next_token(te_parser::state* theState)`
`1195`	`1195`	`theState->m_type = te_parser::state::token_type::TOK_INFIX;`
`1196`	`1196`	`theState->m_value = te_builtins::te_modulus;`
`1197`	`1197`	`}`
	`1198`	`+#ifdef TE_BRACKETS_AS_PARENS`
	`1199`	`+ else if (tok == '(' \|\| tok == '[')`
	`1200`	`+#else`
`1198`	`1201`	`else if (tok == '(')`
	`1202`	`+#endif`
`1199`	`1203`	`{`
`1200`	`1204`	`theState->m_type = te_parser::state::token_type::TOK_OPEN;`
`1201`	`1205`	`}`
	`1206`	`+#ifdef TE_BRACKETS_AS_PARENS`
	`1207`	`+ else if (tok == ')' \|\| tok == ']')`
	`1208`	`+#else`
`1202`	`1209`	`else if (tok == ')')`
	`1210`	`+#endif`
`1203`	`1211`	`{`
`1204`	`1212`	`theState->m_type = te_parser::state::token_type::TOK_CLOSE;`
`1205`	`1213`	`}`