Boolean Macros

Macros Evaluating To Boolean

Most of Allowl's macros only evaluate to a boolean result. This is true of the following:

• Boolean_Macro_LogicalNot – Logical opposite of input
• Boolean_Macro_LogicalAnd – True when no input is false
• Boolean_Macro_LogicalOr – True if any input is true
• Boolean_Macro_GreaterThan – Is A > B?
• Boolean_Macro_GreaterThanOrEqual – Is A >= B?
• Boolean_Macro_LessThan – Is A < B?
• Boolean_Macro_LessThanOrEqual – Is A <= B?
• Boolean_Macro_Equal – Is A == B?
• Boolean_Macro_NotEqual – Is A != B?
• Boolean_Macro_Inclusion – True if B == any element of A?
• Boolean_Macro_Any – Is expression B true for any element of A?

Boolean_Macro_LogicalNot

The simplest of the boolean macros is the logical NOT. It takes a boolean value as input and evaluates to its boolean opposite. The input can be any boolean value including a literal true or false or a nested operation that returns a boolean result. This macro only accepts this one parameter.

Referenced by: Boolean_Macro

Refers to: Boolean_Value

Logical Not Example #1

{"query": {"not": true }}

{"result": false}

Logical Not Example #2

{"query": {"not": {"not": true }}}

{"result": true}

Boolean_Macro_LogicalAnd

The logical AND macro only accepts a single array parameter containing zero or more boolean values. Each element of the array may be either a boolean literal or nested operation that returns a boolean result. The macro returns true if none of the elements of the array evaluate to false. It otherwise returns false. Note that an empty array would evaluate to true.

Referenced by: Boolean_Macro

Refers to: Array_OfBoolean

Boolean_Macro_LogicalOr

The logical OR macro only accepts a single array parameter containing zero or more boolean values. Each element of the array may be either a boolean literal or nested operation that returns a boolean result. The macro returns true if at least one element of the array evaluates to true. It otherwise returns false. Note that an empty array would evaluate to false.

Referenced by: Boolean_Macro

Refers to: Array_OfBoolean

Nested Logic Example

Consider the following example:

{"query": {"and":[true,{"or":[{"not":false}]}]}}

{"result": true}

Starting with the innermost operation, the logical NOT evaluates to true because this is the opposite of its input parameter. The logical OR evaluates to true because its input is a single element array that meets the requirement of having at least one element that evaluates to true. The outermost logical AND operation evaluates to true because its input is an array of two elements, none of which evaluate to false. The evaluation of this query input expression yields the result of its outermost logical AND operation.

Boolean_Macro_GreaterThan

The Greater Than macro only accepts a single array parameter containing exactly two elements that must evaluate to numeric values. The macro returns true if the evaluation of first element is larger than the value of the second. It otherwise returns false.

Referenced by: Boolean_Macro

Refers to: Array_OfNumericPair

Boolean_Macro_GreaterThanOrEqual

The Greater Than Or Equal macro only accepts a single array parameter containing exactly two elements that must evaluate to numeric values. The macro returns true if the evaluation of first element is larger than or equal to the value of the second. It otherwise returns false.

Referenced by: Boolean_Macro

Refers to: Array_OfNumericPair

Boolean_Macro_LessThan

The Less Than macro only accepts a single array parameter containing exactly two elements that must evaluate to numeric values. The macro returns true if the evaluation of first element is less than the value of the second. It otherwise returns false.

Referenced by: Boolean_Macro

Refers to: Array_OfNumericPair

Boolean_Macro_LessThanOrEqual

The Less Than Or Equal macro only accepts a single array parameter containing exactly two elements that must evaluate to numeric values. The macro returns true if the evaluation of first element is less than or equal to the value of the second. It otherwise returns false.

Referenced by: Boolean_Macro

Refers to: Array_OfNumericPair

Examples With > , >= , < , <=

{"query": {"gt":[-1, 0]}}

{"result": false}

{"query": {"gte":[3, 3]}}

{"result": true}

{"query": {"lt":[-1, 0]}}

{"result": true}

{"query": {"lte":[-1, 0]}}

{"result": true}

Boolean_Macro_Equal

The Equal macro only accepts a single array parameter containing exactly two elements that either both evaluate to numeric values or both evaluate to string values. The macro returns true if the evaluation of first element is equal to the value of the second. It otherwise returns false.

Referenced by: Boolean_Macro

Refers to: Array_OfNumericPair, Array_OfStringPair

Boolean_Macro_NotEqual

The Equal macro only accepts a single array parameter containing exactly two elements that either both evaluate to numeric values or both evaluate to string values. The macro returns true if the evaluation of first element is not equal to the value of the second. It otherwise returns false.

Referenced by: Boolean_Macro

Refers to: Array_OfNumericPair, Array_OfStringPair

Examples With == , !=

{"query": {"eq":["AA", "AAA"]}}

{"result": false}

{"query": {"neq":[-1, 0]}}

{"result": true}

Boolean_Macro_Inclusion

The Inclusion macro requires two parameters:

• an array of anything – value following the macro name key
• any expression – value following the key named "of"

The macro returns true if the evaluation of any element of the array in the first parameter is equal to the evaluation of the second parameter. It otherwise returns false.

Referenced by: Boolean_Macro

Refers to: Array_OfAnything, Expression

Inclusion Example #1

{"query": {"inclusion":["A","A","B","C"],"of":"Z"}}

{"result": false}

Inclusion Example #2

{"query": {"inclusion":["A","A","B","C"],"of":"B"}}

{"result": true}

Boolean_Macro_Any

The Any macro requires two parameters:

• an array of anything – value following the macro name key
• a boolean value – value following the key named "by"

Each element of the array given by the first parameter is temporarily assigned to the It_Environment_Variable "$it" and the second parameter is reevaluated. If the second parameter evaluates to true in any of these cases, the macro returns true. It otherwise returns false.

Referenced by: Boolean_Macro

Refers to: Array_OfAnything, Boolean_Value

Boolean_Macro_Any Example #1

{"query": {"any":[1,2,3],"by":{"gt": ["$it", 3]}}}

{"result": false}

Boolean_Macro_Any Example #1

{"query": {"any":[1,2,3],"by":{"gte": ["$it", 3]}}}

{"result": true}

Credits

Grammar consistency testing and generation of images representing elements of the Allowl grammar were aided by Gunther Rademacher's open source Railroad Diagram Generator program. An online version is hosted at bottlecaps.de/rr/. The software was used with permission and according to its Apache License terms.