support named parameters (#702)

ted-johnson · wumpz · commit eacb161fe848 · 2018-10-25T12:52:41.000+02:00
diff --git a/src/main/java/net/sf/jsqlparser/expression/ExpressionVisitorAdapter.java b/src/main/java/net/sf/jsqlparser/expression/ExpressionVisitorAdapter.java
@@ -346,6 +346,14 @@ public void visit(ExpressionList expressionList) {
         }
     }
 
+    @Override
+    public void visit(NamedExpressionList namedExpressionList) {
+        for (Expression expr : namedExpressionList.getExpressions()) {
+            expr.accept(this);
+        }
+    }
+
+
     @Override
     public void visit(MultiExpressionList multiExprList) {
         for (ExpressionList list : multiExprList.getExprList()) {
diff --git a/src/main/java/net/sf/jsqlparser/expression/Function.java b/src/main/java/net/sf/jsqlparser/expression/Function.java
@@ -22,6 +22,7 @@
 package net.sf.jsqlparser.expression;
 
 import net.sf.jsqlparser.expression.operators.relational.ExpressionList;
+import net.sf.jsqlparser.expression.operators.relational.NamedExpressionList;
 import net.sf.jsqlparser.parser.ASTNodeAccessImpl;
 
 /**
@@ -31,6 +32,7 @@ public class Function extends ASTNodeAccessImpl implements Expression {
 
     private String name;
     private ExpressionList parameters;
+    private NamedExpressionList namedParameters;
     private boolean allColumns = false;
     private boolean distinct = false;
     private boolean isEscaped = false;
@@ -95,6 +97,20 @@ public void setParameters(ExpressionList list) {
         parameters = list;
     }
 
+    /**
+     * the parameters might be named parameters, e.g. substring('foobar' from 2 for 3)
+     *
+     * @return the list of named parameters of the function (if any, else null)
+     */
+
+    public NamedExpressionList getNamedParameters() {
+        return namedParameters;
+    }
+
+    public void setNamedParameters(NamedExpressionList list) {
+        namedParameters = list;
+    }
+
     /**
      * Return true if it's in the form "{fn function_body() }"
      *
@@ -128,12 +144,16 @@ public void setKeep(KeepExpression keep) {
     public String toString() {
         String params;
 
-        if (parameters != null) {
-            params = parameters.toString();
-            if (isDistinct()) {
-                params = params.replaceFirst("\\(", "(DISTINCT ");
-            } else if (isAllColumns()) {
-                params = params.replaceFirst("\\(", "(ALL ");
+        if (parameters != null || namedParameters != null) {
+            if(parameters != null){
+                params = parameters.toString();
+                if (isDistinct()) {
+                    params = params.replaceFirst("\\(", "(DISTINCT ");
+                } else if (isAllColumns()) {
+                    params = params.replaceFirst("\\(", "(ALL ");
+                }
+            } else{
+                params = namedParameters.toString();
             }
         } else if (isAllColumns()) {
             params = "(*)";
diff --git a/src/main/java/net/sf/jsqlparser/expression/operators/relational/ItemsListVisitor.java b/src/main/java/net/sf/jsqlparser/expression/operators/relational/ItemsListVisitor.java
@@ -29,5 +29,7 @@ public interface ItemsListVisitor {
 
     void visit(ExpressionList expressionList);
 
+    void visit(NamedExpressionList namedExpressionList);
+
     void visit(MultiExpressionList multiExprList);
 }
diff --git a/src/main/java/net/sf/jsqlparser/expression/operators/relational/ItemsListVisitorAdapter.java b/src/main/java/net/sf/jsqlparser/expression/operators/relational/ItemsListVisitorAdapter.java
@@ -30,6 +30,11 @@ public void visit(SubSelect subSelect) {
 
     }
 
+    @Override
+    public void visit(NamedExpressionList namedExpressionList) {
+
+    }
+
     @Override
     public void visit(ExpressionList expressionList) {
 
diff --git a/src/main/java/net/sf/jsqlparser/expression/operators/relational/NamedExpressionList.java b/src/main/java/net/sf/jsqlparser/expression/operators/relational/NamedExpressionList.java
@@ -0,0 +1,91 @@
+/*
+ * #%L
+ * JSQLParser library
+ * %%
+ * Copyright (C) 2004 - 2013 JSQLParser
+ * %%
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as 
+ * published by the Free Software Foundation, either version 2.1 of the 
+ * License, or (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Lesser Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Lesser Public 
+ * License along with this program.  If not, see
+ * <http://www.gnu.org/licenses/lgpl-2.1.html>.
+ * #L%
+ */
+package net.sf.jsqlparser.expression.operators.relational;
+
+import java.util.Arrays;
+import java.util.List;
+
+import net.sf.jsqlparser.expression.Expression;
+
+/**
+ * A list of named expressions, as in 
+ * as in select substr('xyzzy' from 2 for 3)
+ */
+public class NamedExpressionList implements ItemsList {
+
+    private List<Expression> expressions;
+    private List<String> names;
+
+    public NamedExpressionList() {
+    }
+
+    public NamedExpressionList(List<Expression> expressions) {
+        this.expressions = expressions;
+    }
+    
+    public NamedExpressionList(Expression ... expressions) {
+        this.expressions = Arrays.asList(expressions);
+    }
+
+    public List<Expression> getExpressions() {
+        return expressions;
+    }
+
+    public List<String> getNames() {
+        return names;
+    }
+
+
+    public void setExpressions(List<Expression> list) {
+        expressions = list;
+    }
+
+    public void setNames(List<String> list) {
+        names = list;
+    }
+
+
+    @Override
+    public void accept(ItemsListVisitor itemsListVisitor) {
+        itemsListVisitor.visit(this);
+    }
+
+    @Override
+    public String toString() {
+
+        StringBuilder ret = new StringBuilder();
+        ret.append("(");
+        for(int i=0; i<expressions.size(); i++){
+            if(i>0){
+                ret.append(" ");
+            }
+            if(! names.get(i).equals("")){
+                ret.append(names.get(i)).append(" ").append(expressions.get(i));
+            }else{
+                ret.append(expressions.get(i));
+            }
+        }
+        ret.append(")");
+
+        return ret.toString();
+    }
+}
diff --git a/src/main/java/net/sf/jsqlparser/util/TablesNamesFinder.java b/src/main/java/net/sf/jsqlparser/util/TablesNamesFinder.java
@@ -77,6 +77,7 @@
 import net.sf.jsqlparser.expression.operators.relational.EqualsTo;
 import net.sf.jsqlparser.expression.operators.relational.ExistsExpression;
 import net.sf.jsqlparser.expression.operators.relational.ExpressionList;
+import net.sf.jsqlparser.expression.operators.relational.NamedExpressionList;
 import net.sf.jsqlparser.expression.operators.relational.GreaterThan;
 import net.sf.jsqlparser.expression.operators.relational.GreaterThanEquals;
 import net.sf.jsqlparser.expression.operators.relational.InExpression;
@@ -409,6 +410,13 @@ public void visit(ExpressionList expressionList) {
         }
     }
 
+    @Override
+    public void visit(NamedExpressionList namedExpressionList) {
+        for (Expression expression : namedExpressionList.getExpressions()) {
+            expression.accept(this);
+        }
+    }
+
     @Override
     public void visit(DateValue dateValue) {
     }
diff --git a/src/main/java/net/sf/jsqlparser/util/deparser/ExpressionDeParser.java b/src/main/java/net/sf/jsqlparser/util/deparser/ExpressionDeParser.java
@@ -77,6 +77,7 @@
 import net.sf.jsqlparser.expression.operators.relational.EqualsTo;
 import net.sf.jsqlparser.expression.operators.relational.ExistsExpression;
 import net.sf.jsqlparser.expression.operators.relational.ExpressionList;
+import net.sf.jsqlparser.expression.operators.relational.NamedExpressionList;
 import net.sf.jsqlparser.expression.operators.relational.GreaterThan;
 import net.sf.jsqlparser.expression.operators.relational.GreaterThanEquals;
 import net.sf.jsqlparser.expression.operators.relational.InExpression;
@@ -435,7 +436,7 @@ public void visit(Function function) {
         buffer.append(function.getName());
         if (function.isAllColumns() && function.getParameters() == null) {
             buffer.append("(*)");
-        } else if (function.getParameters() == null) {
+        } else if (function.getParameters() == null && function.getNamedParameters() == null) {
             buffer.append("()");
         } else {
             boolean oldUseBracketsInExprList = useBracketsInExprList;
@@ -446,7 +447,12 @@ public void visit(Function function) {
                 useBracketsInExprList = false;
                 buffer.append("(ALL ");
             }
-            visit(function.getParameters());
+            if(function.getNamedParameters() != null){
+                visit(function.getNamedParameters());
+            }
+            if(function.getParameters() != null){
+                visit(function.getParameters());
+            }
             useBracketsInExprList = oldUseBracketsInExprList;
             if (function.isDistinct() || function.isAllColumns()) {
                 buffer.append(")");
@@ -482,6 +488,29 @@ public void visit(ExpressionList expressionList) {
         }
     }
 
+    @Override
+    public void visit(NamedExpressionList namedExpressionList) {
+        if (useBracketsInExprList) {
+            buffer.append("(");
+        }
+        List<String> names = namedExpressionList.getNames();
+        List<Expression> expressions = namedExpressionList.getExpressions();
+        for (int i=0; i<names.size(); i++){
+            if(i>0){
+                buffer.append(" ");
+            }
+            String name = names.get(i);
+            if(! name.equals("")){
+                buffer.append(name);
+                buffer.append(" ");
+            }
+            expressions.get(i).accept(this);
+        }
+        if (useBracketsInExprList) {
+            buffer.append(")");
+        }
+    }
+
     public SelectVisitor getSelectVisitor() {
         return selectVisitor;
     }
diff --git a/src/main/java/net/sf/jsqlparser/util/deparser/InsertDeParser.java b/src/main/java/net/sf/jsqlparser/util/deparser/InsertDeParser.java
@@ -26,6 +26,7 @@
 import net.sf.jsqlparser.expression.Expression;
 import net.sf.jsqlparser.expression.ExpressionVisitor;
 import net.sf.jsqlparser.expression.operators.relational.ExpressionList;
+import net.sf.jsqlparser.expression.operators.relational.NamedExpressionList;
 import net.sf.jsqlparser.expression.operators.relational.ItemsListVisitor;
 import net.sf.jsqlparser.expression.operators.relational.MultiExpressionList;
 import net.sf.jsqlparser.schema.Column;
@@ -174,6 +175,12 @@ public void visit(ExpressionList expressionList) {
         buffer.append(")");
     }
 
+// not used in a top-level insert statement
+    @Override
+    public void visit(NamedExpressionList NamedExpressionList) {
+
+    }
+
     @Override
     public void visit(MultiExpressionList multiExprList) {
         buffer.append(" VALUES ");
diff --git a/src/main/java/net/sf/jsqlparser/util/deparser/ReplaceDeParser.java b/src/main/java/net/sf/jsqlparser/util/deparser/ReplaceDeParser.java
@@ -26,6 +26,7 @@
 import net.sf.jsqlparser.expression.Expression;
 import net.sf.jsqlparser.expression.ExpressionVisitor;
 import net.sf.jsqlparser.expression.operators.relational.ExpressionList;
+import net.sf.jsqlparser.expression.operators.relational.NamedExpressionList;
 import net.sf.jsqlparser.expression.operators.relational.ItemsListVisitor;
 import net.sf.jsqlparser.expression.operators.relational.MultiExpressionList;
 import net.sf.jsqlparser.schema.Column;
@@ -125,6 +126,11 @@ public void visit(ExpressionList expressionList) {
         buffer.append(")");
     }
 
+// NamedExpressionList not use by top-level Replace
+    @Override
+    public void visit(NamedExpressionList namedExpressionList) {
+    }
+
     @Override
     public void visit(SubSelect subSelect) {
         subSelect.getSelectBody().accept(selectVisitor);
diff --git a/src/main/java/net/sf/jsqlparser/util/deparser/UpsertDeParser.java b/src/main/java/net/sf/jsqlparser/util/deparser/UpsertDeParser.java
@@ -26,6 +26,7 @@
 import net.sf.jsqlparser.expression.Expression;
 import net.sf.jsqlparser.expression.ExpressionVisitor;
 import net.sf.jsqlparser.expression.operators.relational.ExpressionList;
+import net.sf.jsqlparser.expression.operators.relational.NamedExpressionList;
 import net.sf.jsqlparser.expression.operators.relational.ItemsListVisitor;
 import net.sf.jsqlparser.expression.operators.relational.MultiExpressionList;
 import net.sf.jsqlparser.schema.Column;
@@ -149,6 +150,11 @@ public void visit(ExpressionList expressionList) {
         buffer.append(")");
     }
 
+// not used by top-level upsert
+    @Override
+    public void visit(NamedExpressionList namedExpressionList) {
+    }
+
     @Override
     public void visit(MultiExpressionList multiExprList) {
         buffer.append(" VALUES ");
diff --git a/src/main/jjtree/net/sf/jsqlparser/parser/JSqlParserCC.jjt b/src/main/jjtree/net/sf/jsqlparser/parser/JSqlParserCC.jjt
diff --git a/src/test/java/net/sf/jsqlparser/statement/select/SelectTest.java b/src/test/java/net/sf/jsqlparser/statement/select/SelectTest.java

Original file line number	Diff line number	Diff line change
`@@ -346,6 +346,14 @@ public void visit(ExpressionList expressionList) {`
`346`	`346`	`}`
`347`	`347`	`}`
`348`	`348`
	`349`	`+ @Override`
	`350`	`+ public void visit(NamedExpressionList namedExpressionList) {`
	`351`	`+ for (Expression expr : namedExpressionList.getExpressions()) {`
	`352`	`+ expr.accept(this);`
	`353`	`+ }`
	`354`	`+ }`
	`355`	`+`
	`356`	`+`
`349`	`357`	`@Override`
`350`	`358`	`public void visit(MultiExpressionList multiExprList) {`
`351`	`359`	`for (ExpressionList list : multiExprList.getExprList()) {`
Original file line number	Diff line number	Diff line change
`@@ -29,5 +29,7 @@ public interface ItemsListVisitor {`
`29`	`29`
`30`	`30`	`void visit(ExpressionList expressionList);`
`31`	`31`
	`32`	`+ void visit(NamedExpressionList namedExpressionList);`
	`33`	`+`
`32`	`34`	`void visit(MultiExpressionList multiExprList);`
`33`	`35`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,11 @@ public void visit(SubSelect subSelect) {`
`30`	`30`
`31`	`31`	`}`
`32`	`32`
	`33`	`+ @Override`
	`34`	`+ public void visit(NamedExpressionList namedExpressionList) {`
	`35`	`+`
	`36`	`+ }`
	`37`	`+`
`33`	`38`	`@Override`
`34`	`39`	`public void visit(ExpressionList expressionList) {`
`35`	`40`