Add support for boolean 'XOR' operator (#1193)

* Add support for boolean 'XOR' operator

* XorExpression added to the ReflectionModelTest

* XorExpression case added to the SelectTest

* XorExpression cases added for Validation

* Additional tests added for code coverage.

* Code style fixed.

* Separate test case for XOR added.

* Imports explicitly added to avoid namespace pollution.

* Additional tests cases for precedence and associativity.

Co-authored-by: Szabó Miklós <[email protected]>

Author: arh-eu

src/main/java/net/sf/jsqlparser/expression/ExpressionVisitor.java

@@ -12,6 +12,7 @@
 import net.sf.jsqlparser.expression.operators.arithmetic.*;
 import net.sf.jsqlparser.expression.operators.conditional.AndExpression;
 import net.sf.jsqlparser.expression.operators.conditional.OrExpression;
+import net.sf.jsqlparser.expression.operators.conditional.XorExpression;
 import net.sf.jsqlparser.expression.operators.relational.*;
 import net.sf.jsqlparser.schema.Column;
 import net.sf.jsqlparser.statement.select.SubSelect;
@@ -62,6 +63,8 @@ public interface ExpressionVisitor {
 
     void visit(OrExpression orExpression);
 
+    void visit(XorExpression orExpression);
+
     void visit(Between between);
 
     void visit(EqualsTo equalsTo);

src/main/java/net/sf/jsqlparser/expression/ExpressionVisitorAdapter.java

@@ -12,6 +12,7 @@
 import net.sf.jsqlparser.expression.operators.arithmetic.*;
 import net.sf.jsqlparser.expression.operators.conditional.AndExpression;
 import net.sf.jsqlparser.expression.operators.conditional.OrExpression;
+import net.sf.jsqlparser.expression.operators.conditional.XorExpression;
 import net.sf.jsqlparser.expression.operators.relational.*;
 import net.sf.jsqlparser.schema.Column;
 import net.sf.jsqlparser.statement.select.AllColumns;
@@ -147,6 +148,11 @@ public void visit(OrExpression expr) {
         visitBinaryExpression(expr);
     }
 
+    @Override
+    public void visit(XorExpression expr) {
+        visitBinaryExpression(expr);
+    }
+
     @Override
     public void visit(Between expr) {
         expr.getLeftExpression().accept(this);

src/main/java/net/sf/jsqlparser/expression/operators/conditional/XorExpression.java

@@ -0,0 +1,47 @@
+/*-
+ * #%L
+ * JSQLParser library
+ * %%
+ * Copyright (C) 2004 - 2021 JSQLParser
+ * %%
+ * Dual licensed under GNU LGPL 2.1 or Apache License 2.0
+ * #L%
+ */
+package net.sf.jsqlparser.expression.operators.conditional;
+
+import net.sf.jsqlparser.expression.BinaryExpression;
+import net.sf.jsqlparser.expression.Expression;
+import net.sf.jsqlparser.expression.ExpressionVisitor;
+
+public class XorExpression extends BinaryExpression {
+
+    public XorExpression() {
+        // nothing
+    }
+
+    public XorExpression(Expression leftExpression, Expression rightExpression) {
+        setLeftExpression(leftExpression);
+        setRightExpression(rightExpression);
+    }
+
+    @Override
+    public XorExpression withLeftExpression(Expression expression) {
+        return (XorExpression) super.withLeftExpression(expression);
+    }
+
+    @Override
+    public XorExpression withRightExpression(Expression expression) {
+        return (XorExpression) super.withRightExpression(expression);
+    }
+
+    @Override
+    public void accept(ExpressionVisitor expressionVisitor) {
+        expressionVisitor.visit(this);
+    }
+
+    @Override
+    public String getStringExpression() {
+        return "XOR";
+    }
+
+}

src/main/java/net/sf/jsqlparser/util/TablesNamesFinder.java

@@ -58,6 +58,7 @@
 import net.sf.jsqlparser.expression.operators.arithmetic.*;
 import net.sf.jsqlparser.expression.operators.conditional.AndExpression;
 import net.sf.jsqlparser.expression.operators.conditional.OrExpression;
+import net.sf.jsqlparser.expression.operators.conditional.XorExpression;
 import net.sf.jsqlparser.expression.operators.relational.*;
 import net.sf.jsqlparser.schema.Column;
 import net.sf.jsqlparser.schema.Table;
@@ -349,6 +350,11 @@ public void visit(OrExpression orExpression) {
         visitBinaryExpression(orExpression);
     }
 
+    @Override
+    public void visit(XorExpression xorExpression) {
+        visitBinaryExpression(xorExpression);
+    }
+
     @Override
     public void visit(Parenthesis parenthesis) {
         parenthesis.getExpression().accept(this);

src/main/java/net/sf/jsqlparser/util/deparser/ExpressionDeParser.java

@@ -72,6 +72,7 @@
 import net.sf.jsqlparser.expression.operators.arithmetic.Subtraction;
 import net.sf.jsqlparser.expression.operators.conditional.AndExpression;
 import net.sf.jsqlparser.expression.operators.conditional.OrExpression;
+import net.sf.jsqlparser.expression.operators.conditional.XorExpression;
 import net.sf.jsqlparser.expression.operators.relational.Between;
 import net.sf.jsqlparser.expression.operators.relational.EqualsTo;
 import net.sf.jsqlparser.expression.operators.relational.ExistsExpression;
@@ -398,6 +399,11 @@ public void visit(NullValue nullValue) {
     public void visit(OrExpression orExpression) {
         visitBinaryExpression(orExpression, " OR ");
 
+    }
+    @Override
+    public void visit(XorExpression xorExpression) {
+        visitBinaryExpression(xorExpression, " XOR ");
+
     }
 
     @Override

src/main/java/net/sf/jsqlparser/util/validation/validator/ExpressionValidator.java

@@ -69,6 +69,7 @@
 import net.sf.jsqlparser.expression.operators.arithmetic.Subtraction;
 import net.sf.jsqlparser.expression.operators.conditional.AndExpression;
 import net.sf.jsqlparser.expression.operators.conditional.OrExpression;
+import net.sf.jsqlparser.expression.operators.conditional.XorExpression;
 import net.sf.jsqlparser.expression.operators.relational.Between;
 import net.sf.jsqlparser.expression.operators.relational.EqualsTo;
 import net.sf.jsqlparser.expression.operators.relational.ExistsExpression;
@@ -275,6 +276,12 @@ public void visit(OrExpression orExpression) {
 
     }
 
+    @Override
+    public void visit(XorExpression xorExpression) {
+        visitBinaryExpression(xorExpression, " XOR ");
+
+    }
+
     @Override
     public void visit(Parenthesis parenthesis) {
         parenthesis.getExpression().accept(this);

src/main/jjtree/net/sf/jsqlparser/parser/JSqlParserCC.jjt

@@ -2,7 +2,7 @@
  * #%L
  * JSQLParser library
  * %%
- * Copyright (C) 2004 - 2019 JSQLParser
+ * Copyright (C) 2004 - 2021 JSQLParser
  * %%
  * Dual licensed under GNU LGPL 2.1 or Apache License 2.0
  * #L%
@@ -361,6 +361,7 @@ TOKEN: /* SQL Keywords. prefixed with K_ to avoid name clashes */
 |   <K_WITHIN:"WITHIN">
 |   <K_WITHOUT:"WITHOUT">
 |   <K_XML:"XML">
+|   <K_XOR:"XOR">
 |   <K_XMLSERIALIZE:"XMLSERIALIZE">
 |   <K_XMLAGG:"XMLAGG">
 |   <K_XMLTEXT:"XMLTEXT">
@@ -2621,11 +2622,30 @@ Expression Expression() #Expression :
     Expression retval = null;
 }
 {
-    retval=OrExpression()
+    retval=XorExpression()
 
     { return retval; }
 }
 
+Expression XorExpression():
+{
+    Expression left, right, result;
+}
+{
+    left=OrExpression() { result = left; }
+    (
+        <K_XOR>
+        right=OrExpression()
+        {
+            result = new XorExpression(left, right);
+            left = result;
+        }
+     )*
+     {
+         return result;
+     }
+}
+
 Expression OrExpression():
 {
     Expression left, right, result;
@@ -2658,7 +2678,7 @@ Expression AndExpression() :
         left=Condition()
         |
         [ <K_NOT> { not=true; } | "!" { not=true; exclamationMarkNot=true; } ]
-        "(" left=OrExpression() ")" {left = new Parenthesis(left); if (not) { left = new NotExpression(left, exclamationMarkNot); not = false; } }
+        "(" left=XorExpression() ")" {left = new Parenthesis(left); if (not) { left = new NotExpression(left, exclamationMarkNot); not = false; } }
     )
     { result = left; }
 
@@ -2670,7 +2690,7 @@ Expression AndExpression() :
             right=Condition()
             |
             [ <K_NOT> { not=true; } | "!" { not=true; exclamationMarkNot=true; } ]
-            "(" right=OrExpression() ")" {right = new Parenthesis(right); if (not) { right = new NotExpression(right, exclamationMarkNot); not = false; } }
+            "(" right=XorExpression() ")" {right = new Parenthesis(right); if (not) { right = new NotExpression(right, exclamationMarkNot); not = false; } }
         )
         {
             result = new AndExpression(left, right);

src/test/java/net/sf/jsqlparser/expression/ExpressionVisitorAdapterTest.java

@@ -11,6 +11,8 @@
 
 import java.util.ArrayList;
 import java.util.List;
+
+import net.sf.jsqlparser.expression.operators.conditional.XorExpression;
 import org.junit.After;
 import org.junit.AfterClass;
 import org.junit.Before;
@@ -31,7 +33,6 @@
 import net.sf.jsqlparser.statement.select.SelectVisitorAdapter;
 
 /**
- * 
  * @author tw
  */
 public class ExpressionVisitorAdapterTest {
@@ -100,6 +101,30 @@ public void visit(InExpression expr) {
         assertTrue(exprList.get(2) instanceof ItemsList);
     }
 
+    @Test
+    public void testXorExpression() throws JSQLParserException {
+        final List<Expression> exprList = new ArrayList<>();
+        Select select = (Select) CCJSqlParserUtil.
+                parse("SELECT * FROM table WHERE foo XOR bar");
+        PlainSelect plainSelect = (PlainSelect) select.getSelectBody();
+        Expression where = plainSelect.getWhere();
+        where.accept(new ExpressionVisitorAdapter() {
+
+            @Override
+            public void visit(XorExpression expr) {
+                super.visit(expr);
+                exprList.add(expr.getLeftExpression());
+                exprList.add(expr.getRightExpression());
+            }
+        });
+
+        assertEquals(2, exprList.size());
+        assertTrue(exprList.get(0) instanceof Column);
+        assertEquals("foo", ((Column) exprList.get(0)).getColumnName());
+        assertTrue(exprList.get(1) instanceof Column);
+        assertEquals("bar", ((Column) exprList.get(1)).getColumnName());
+    }
+
     @Test
     public void testOracleHintExpressions() throws JSQLParserException {
         testOracleHintExpression("select --+ MYHINT \n * from foo", "MYHINT", true);