Implements #509 (#504)

* Supporting MySql hit SQL_CALC_FOUND_ROWS for selecting row count.

* Supporting MySql hit SQL_CALC_FOUND_ROWS for selecting row count. - refactoring

* Supporting MySql hit SQL_CALC_FOUND_ROWS for selecting row count. - missing copyright.ˆ

* Supporting MySql hit SQL_CALC_FOUND_ROWS for selecting row count. - Modify field type to boolean for prevent memory consumption by creating object and try assertSqlCanBeParsedAndDeparsed on unit test.

Author: KyongSik-Yoon

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

@@ -0,0 +1,33 @@
+/*
+ * #%L
+ * JSQLParser library
+ * %%
+ * Copyright (C) 2004 - 2017 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;
+
+/**
+ * @author sam
+ */
+public class MySqlSqlCalcFoundRows {
+    public static final String DESCRIPTION = "SQL_CALC_FOUND_ROWS";
+
+    public String getDescription() {
+        return DESCRIPTION;
+    }
+}

src/main/java/net/sf/jsqlparser/statement/select/PlainSelect.java

@@ -21,15 +21,15 @@
  */
 package net.sf.jsqlparser.statement.select;
 
-import java.util.ArrayList;
-import java.util.Collections;
 import net.sf.jsqlparser.expression.Expression;
+import net.sf.jsqlparser.expression.OracleHierarchicalExpression;
+import net.sf.jsqlparser.expression.OracleHint;
 import net.sf.jsqlparser.schema.Table;
 
+import java.util.ArrayList;
+import java.util.Collections;
 import java.util.Iterator;
 import java.util.List;
-import net.sf.jsqlparser.expression.OracleHierarchicalExpression;
-import net.sf.jsqlparser.expression.OracleHint;
 
 /**
  * The core of a "SELECT" statement (no UNION, no ORDER BY)
@@ -58,6 +58,7 @@ public class PlainSelect implements SelectBody {
     private Table forUpdateTable = null;
     private boolean useBrackets = false;
     private Wait wait;
+    private boolean mySqlSqlCalcFoundRows = false;
 
     public boolean isUseBrackets() {
         return useBrackets;
@@ -311,6 +312,9 @@ public String toString() {
         if (top != null) {
             sql.append(top).append(" ");
         }
+        if (mySqlSqlCalcFoundRows) {
+            sql.append("SQL_CALC_FOUND_ROWS").append(" ");
+        }
         sql.append(getStringList(selectItems));
 
         if (intoTables != null) {
@@ -455,4 +459,12 @@ public static String getStringList(List<?> list, boolean useComma, boolean useBr
 
         return ans.toString();
     }
+
+    public void setMySqlSqlCalcFoundRows(boolean mySqlCalcFoundRows) {
+        this.mySqlSqlCalcFoundRows = mySqlCalcFoundRows;
+    }
+
+    public boolean getMySqlSqlCalcFoundRows() {
+        return this.mySqlSqlCalcFoundRows;
+    }
 }

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

@@ -91,11 +91,16 @@ public void visit(PlainSelect plainSelect) {
             }
 
         }
+
         Top top = plainSelect.getTop();
         if (top != null) {
             buffer.append(top).append(" ");
         }
 
+        if (plainSelect.getMySqlSqlCalcFoundRows()) {
+            buffer.append("SQL_CALC_FOUND_ROWS").append(" ");
+        }
+
         for (Iterator<SelectItem> iter = plainSelect.getSelectItems().iterator(); iter.hasNext();) {
             SelectItem selectItem = iter.next();
             selectItem.accept(this);

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

@@ -272,6 +272,7 @@ TOKEN: /* SQL Keywords. prefixed with K_ to avoid name clashes */
 |   <K_UPDATE:"UPDATE">
 |   <K_UPSERT:"UPSERT">
 |   <K_USE : "USE">
+|   <K_SQL_CALC_FOUND_ROWS: "SQL_CALC_FOUND_ROWS">
 |   <K_USING:"USING">
 |   <K_VALIDATE : "VALIDATE">
 |   <K_VALUE:"VALUE">
@@ -1059,6 +1060,7 @@ PlainSelect PlainSelect():
     List<Table> intoTables = null;
     Table updateTable = null;
     Wait wait = null;
+    boolean mySqlSqlCalcFoundRows = false;
 }
 {
     <K_SELECT>
@@ -1080,6 +1082,10 @@ PlainSelect PlainSelect():
             (
                 <K_UNIQUE> { Distinct distinct = new Distinct(true); plainSelect.setDistinct(distinct); }
             )
+        |
+            (
+                <K_SQL_CALC_FOUND_ROWS> { plainSelect.setMySqlSqlCalcFoundRows(true); }
+            )
     ]
 
     [top = Top() { plainSelect.setTop(top);    } ]

src/test/java/net/sf/jsqlparser/expression/mysql/MySqlSqlCalcFoundRowRef.java

@@ -0,0 +1,33 @@
+/*
+ * #%L
+ * JSQLParser library
+ * %%
+ * Copyright (C) 2004 - 2017 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.mysql;
+
+/**
+ * @author sam
+ */
+public class MySqlSqlCalcFoundRowRef {
+    public boolean sqlCalcFoundRows = false;
+
+    public MySqlSqlCalcFoundRowRef(boolean sqlCalcFoundRows) {
+        this.sqlCalcFoundRows = sqlCalcFoundRows;
+    }
+}

src/test/java/net/sf/jsqlparser/expression/mysql/MySqlSqlCalcFoundRowsTest.java

@@ -0,0 +1,56 @@
+/*
+ * #%L
+ * JSQLParser library
+ * %%
+ * Copyright (C) 2004 - 2017 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.mysql;
+
+import net.sf.jsqlparser.JSQLParserException;
+import net.sf.jsqlparser.parser.CCJSqlParserUtil;
+import net.sf.jsqlparser.statement.Statement;
+import org.junit.Test;
+
+import static net.sf.jsqlparser.test.TestUtils.assertSqlCanBeParsedAndDeparsed;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+
+/**
+ * @author sam
+ */
+public class MySqlSqlCalcFoundRowsTest {
+    @Test
+    public void testPossibleParsingWithSqlCalcFoundRowsHint() throws JSQLParserException {
+        MySqlSqlCalcFoundRowRef ref = new MySqlSqlCalcFoundRowRef(false);
+        String sqlCalcFoundRowsContainingSql = "SELECT SQL_CALC_FOUND_ROWS * FROM TABLE";
+        String generalSql = "SELECT * FROM TABLE";
+
+        accept(CCJSqlParserUtil.parse(sqlCalcFoundRowsContainingSql), ref);
+        assertTrue(ref.sqlCalcFoundRows);
+
+        accept(CCJSqlParserUtil.parse(generalSql), ref);
+        assertFalse(ref.sqlCalcFoundRows);
+
+        assertSqlCanBeParsedAndDeparsed(sqlCalcFoundRowsContainingSql);
+        assertSqlCanBeParsedAndDeparsed(generalSql);
+    }
+
+    public void accept(Statement statement, MySqlSqlCalcFoundRowRef ref) {
+        statement.accept(SqlCalcFoundRowsStatementVisitorFactory.create(ref));
+    }
+}

src/test/java/net/sf/jsqlparser/expression/mysql/SelectVisitorUsingSqlCalcFoundRowsFactory.java

@@ -0,0 +1,51 @@
+/*
+ * #%L
+ * JSQLParser library
+ * %%
+ * Copyright (C) 2004 - 2017 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.mysql;
+
+import net.sf.jsqlparser.statement.select.PlainSelect;
+import net.sf.jsqlparser.statement.select.SelectVisitor;
+import net.sf.jsqlparser.statement.select.SetOperationList;
+import net.sf.jsqlparser.statement.select.WithItem;
+
+/**
+ * @author sam
+ */
+public class SelectVisitorUsingSqlCalcFoundRowsFactory {
+    public static SelectVisitor create(final MySqlSqlCalcFoundRowRef ref) {
+        return new SelectVisitor() {
+            @Override
+            public void visit(PlainSelect plainSelect) {
+                ref.sqlCalcFoundRows = plainSelect.getMySqlSqlCalcFoundRows();
+            }
+
+            @Override
+            public void visit(SetOperationList setOpList) {
+
+            }
+
+            @Override
+            public void visit(WithItem withItem) {
+
+            }
+        };
+    }
+}