Move QgsSpatiaLiteExpressionCompiler class to core as QgsSQLiteExpressionCompiler so it can be reused by the OGR provider as well

rouault · rouault · commit 5ed41e38da32 · 2016-04-26T11:46:19.000+02:00
diff --git a/src/core/CMakeLists.txt b/src/core/CMakeLists.txt
@@ -188,6 +188,7 @@ SET(QGIS_CORE_SRCS
   qgssnappingutils.cpp
   qgsspatialindex.cpp
   qgssqlexpressioncompiler.cpp
+  qgssqliteexpressioncompiler.cpp
   qgsstatisticalsummary.cpp
   qgsstringutils.cpp
   qgstextlabelfeature.cpp
diff --git a/src/core/qgssqliteexpressioncompiler.cpp b/src/core/qgssqliteexpressioncompiler.cpp
@@ -1,5 +1,5 @@
 /***************************************************************************
-                             qgsspatialiteexpressioncompiler.cpp
+                             qgssqliteexpressioncompiler.cpp
                              -----------------------------------
     begin                : November 2015
     copyright            : (C) 2015 Nyall Dawson
@@ -13,16 +13,15 @@
  *                                                                         *
  ***************************************************************************/
 
-#include "qgsspatialiteexpressioncompiler.h"
+#include "qgssqliteexpressioncompiler.h"
 #include "qgssqlexpressioncompiler.h"
-#include "qgsspatialiteprovider.h"
 
-QgsSpatiaLiteExpressionCompiler::QgsSpatiaLiteExpressionCompiler( QgsSpatiaLiteFeatureSource* source )
-    : QgsSqlExpressionCompiler( source->mFields, QgsSqlExpressionCompiler::LikeIsCaseInsensitive )
+QgsSQLiteExpressionCompiler::QgsSQLiteExpressionCompiler( const QgsFields& fields )
+    : QgsSqlExpressionCompiler( fields, QgsSqlExpressionCompiler::LikeIsCaseInsensitive )
 {
 }
 
-QgsSqlExpressionCompiler::Result QgsSpatiaLiteExpressionCompiler::compileNode( const QgsExpression::Node* node, QString& result )
+QgsSqlExpressionCompiler::Result QgsSQLiteExpressionCompiler::compileNode( const QgsExpression::Node* node, QString& result )
 {
   switch ( node->nodeType() )
   {
@@ -47,12 +46,14 @@ QgsSqlExpressionCompiler::Result QgsSpatiaLiteExpressionCompiler::compileNode( c
   return QgsSqlExpressionCompiler::compileNode( node, result );
 }
 
-QString QgsSpatiaLiteExpressionCompiler::quotedIdentifier( const QString& identifier )
+QString QgsSQLiteExpressionCompiler::quotedIdentifier( const QString& identifier )
 {
-  return QgsSpatiaLiteProvider::quotedIdentifier( identifier );
+  QString id( identifier );
+  id.replace( '\"', "\"\"" );
+  return id.prepend( '\"' ).append( '\"' );
 }
 
-QString QgsSpatiaLiteExpressionCompiler::quotedValue( const QVariant& value, bool& ok )
+QString QgsSQLiteExpressionCompiler::quotedValue( const QVariant& value, bool& ok )
 {
   ok = true;
 
@@ -73,10 +74,10 @@ QString QgsSpatiaLiteExpressionCompiler::quotedValue( const QVariant& value, boo
     default:
     case QVariant::String:
       QString v = value.toString();
-      v.replace( '\'', "''" );
-      if ( v.contains( '\\' ) )
-        return v.replace( '\\', "\\\\" ).prepend( "E'" ).append( '\'' );
-      else
-        return v.prepend( '\'' ).append( '\'' );
+      // https://www.sqlite.org/lang_expr.html :
+      // """A string constant is formed by enclosing the string in single quotes (').
+      // A single quote within the string can be encoded by putting two single quotes
+      // in a row - as in Pascal. C-style escapes using the backslash character are not supported because they are not standard SQL. """
+      return v.replace( '\'', "''" ).prepend( '\'' ).append( '\'' );
   }
 }
diff --git a/src/core/qgssqliteexpressioncompiler.h b/src/core/qgssqliteexpressioncompiler.h
@@ -1,5 +1,5 @@
 /***************************************************************************
-                             qgsspatialiteexpressioncompiler.h
+                             qgssqliteexpressioncompiler.h
                              ---------------------------------
     begin                : November 2015
     copyright            : (C) 2015 Nyall Dawson
@@ -13,18 +13,30 @@
  *                                                                         *
  ***************************************************************************/
 
-#ifndef QGSSPATIALITEEXPRESSIONCOMPILER_H
-#define QGSSPATIALITEEXPRESSIONCOMPILER_H
+#ifndef QGSSQLITEEXPRESSIONCOMPILER_H
+#define QGSSQLITEEXPRESSIONCOMPILER_H
 
 #include "qgssqlexpressioncompiler.h"
 #include "qgsexpression.h"
-#include "qgsspatialitefeatureiterator.h"
 
-class QgsSpatiaLiteExpressionCompiler : public QgsSqlExpressionCompiler
+/** \ingroup core
+ * \class QgsSQLiteExpressionCompiler
+ * \brief Expression compiler for translation to SQlite SQL WHERE clauses.
+ *
+ * This class is designed to be used by spatialite and OGR providers.
+ * \note Added in version 2.16
+ * \note Not part of stable API, may change in future versions of QGIS
+ * \note Not available in Python bindings
+ */
+
+class CORE_EXPORT QgsSQLiteExpressionCompiler : public QgsSqlExpressionCompiler
 {
   public:
 
-    explicit QgsSpatiaLiteExpressionCompiler( QgsSpatiaLiteFeatureSource* source );
+    /** Constructor for expression compiler.
+     * @param fields fields from provider
+     */
+    explicit QgsSQLiteExpressionCompiler( const QgsFields& fields );
 
   protected:
 
@@ -34,4 +46,4 @@ class QgsSpatiaLiteExpressionCompiler : public QgsSqlExpressionCompiler
 
 };
 
-#endif // QGSSPATIALITEEXPRESSIONCOMPILER_H
+#endif // QGSSQLITEEXPRESSIONCOMPILER_H
diff --git a/src/providers/spatialite/CMakeLists.txt b/src/providers/spatialite/CMakeLists.txt
@@ -10,7 +10,6 @@ SET(SPATIALITE_SRCS
   qgsspatialitedataitems.cpp
   qgsspatialiteconnection.cpp
   qgsspatialiteconnpool.cpp
-  qgsspatialiteexpressioncompiler.cpp
   qgsspatialitefeatureiterator.cpp
   qgsspatialitesourceselect.cpp
   qgsspatialitetablemodel.cpp
diff --git a/src/providers/spatialite/qgsspatialitefeatureiterator.cpp b/src/providers/spatialite/qgsspatialitefeatureiterator.cpp
@@ -17,7 +17,7 @@
 #include "qgsspatialiteconnection.h"
 #include "qgsspatialiteconnpool.h"
 #include "qgsspatialiteprovider.h"
-#include "qgsspatialiteexpressioncompiler.h"
+#include "qgssqliteexpressioncompiler.h"
 
 #include "qgsgeometry.h"
 #include "qgslogger.h"
@@ -98,7 +98,7 @@ QgsSpatiaLiteFeatureIterator::QgsSpatiaLiteFeatureIterator( QgsSpatiaLiteFeature
 
     if ( QSettings().value( "/qgis/compileExpressions", true ).toBool() )
     {
-      QgsSpatiaLiteExpressionCompiler compiler = QgsSpatiaLiteExpressionCompiler( source );
+      QgsSQLiteExpressionCompiler compiler = QgsSQLiteExpressionCompiler( source->mFields );
 
       QgsSqlExpressionCompiler::Result result = compiler.compile( request.filterExpression() );
 
@@ -139,7 +139,7 @@ QgsSpatiaLiteFeatureIterator::QgsSpatiaLiteFeatureIterator( QgsSpatiaLiteFeature
   {
     Q_FOREACH ( const QgsFeatureRequest::OrderByClause& clause, request.orderBy() )
     {
-      QgsSpatiaLiteExpressionCompiler compiler = QgsSpatiaLiteExpressionCompiler( source );
+      QgsSQLiteExpressionCompiler compiler = QgsSQLiteExpressionCompiler( source->mFields );
       QgsExpression expression = clause.expression();
       if ( compiler.compile( &expression ) == QgsSqlExpressionCompiler::Complete )
       {

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`/***************************************************************************`
`2`		`- qgsspatialiteexpressioncompiler.cpp`
	`2`	`+ qgssqliteexpressioncompiler.cpp`
`3`	`3`	`-----------------------------------`
`4`	`4`	`begin : November 2015`
`5`	`5`	`copyright : (C) 2015 Nyall Dawson`
`@@ -13,16 +13,15 @@`
`13`	`13`	`* *`
`14`	`14`	`***************************************************************************/`
`15`	`15`
`16`		`-#include "qgsspatialiteexpressioncompiler.h"`
	`16`	`+#include "qgssqliteexpressioncompiler.h"`
`17`	`17`	`#include "qgssqlexpressioncompiler.h"`
`18`		`-#include "qgsspatialiteprovider.h"`
`19`	`18`
`20`		`-QgsSpatiaLiteExpressionCompiler::QgsSpatiaLiteExpressionCompiler( QgsSpatiaLiteFeatureSource* source )`
`21`		`- : QgsSqlExpressionCompiler( source->mFields, QgsSqlExpressionCompiler::LikeIsCaseInsensitive )`
	`19`	`+QgsSQLiteExpressionCompiler::QgsSQLiteExpressionCompiler( const QgsFields& fields )`
	`20`	`+ : QgsSqlExpressionCompiler( fields, QgsSqlExpressionCompiler::LikeIsCaseInsensitive )`
`22`	`21`	`{`
`23`	`22`	`}`
`24`	`23`
`25`		`-QgsSqlExpressionCompiler::Result QgsSpatiaLiteExpressionCompiler::compileNode( const QgsExpression::Node* node, QString& result )`
	`24`	`+QgsSqlExpressionCompiler::Result QgsSQLiteExpressionCompiler::compileNode( const QgsExpression::Node* node, QString& result )`
`26`	`25`	`{`
`27`	`26`	`switch ( node->nodeType() )`
`28`	`27`	`{`
`@@ -47,12 +46,14 @@ QgsSqlExpressionCompiler::Result QgsSpatiaLiteExpressionCompiler::compileNode( c`
`47`	`46`	`return QgsSqlExpressionCompiler::compileNode( node, result );`
`48`	`47`	`}`
`49`	`48`
`50`		`-QString QgsSpatiaLiteExpressionCompiler::quotedIdentifier( const QString& identifier )`
	`49`	`+QString QgsSQLiteExpressionCompiler::quotedIdentifier( const QString& identifier )`
`51`	`50`	`{`
`52`		`- return QgsSpatiaLiteProvider::quotedIdentifier( identifier );`
	`51`	`+ QString id( identifier );`
	`52`	`+ id.replace( '\"', "\"\"" );`
	`53`	`+ return id.prepend( '\"' ).append( '\"' );`
`53`	`54`	`}`
`54`	`55`
`55`		`-QString QgsSpatiaLiteExpressionCompiler::quotedValue( const QVariant& value, bool& ok )`
	`56`	`+QString QgsSQLiteExpressionCompiler::quotedValue( const QVariant& value, bool& ok )`
`56`	`57`	`{`
`57`	`58`	`ok = true;`
`58`	`59`
`@@ -73,10 +74,10 @@ QString QgsSpatiaLiteExpressionCompiler::quotedValue( const QVariant& value, boo`
`73`	`74`	`default:`
`74`	`75`	`case QVariant::String:`
`75`	`76`	`QString v = value.toString();`
`76`		`- v.replace( '\'', "''" );`
`77`		`- if ( v.contains( '\\' ) )`
`78`		`- return v.replace( '\\', "\\\\" ).prepend( "E'" ).append( '\'' );`
`79`		`- else`
`80`		`- return v.prepend( '\'' ).append( '\'' );`
	`77`	`+ // https://www.sqlite.org/lang_expr.html :`
	`78`	`+ // """A string constant is formed by enclosing the string in single quotes (').`
	`79`	`+ // A single quote within the string can be encoded by putting two single quotes`
	`80`	`+ // in a row - as in Pascal. C-style escapes using the backslash character are not supported because they are not standard SQL. """`
	`81`	`+ return v.replace( '\'', "''" ).prepend( '\'' ).append( '\'' );`
`81`	`82`	`}`
`82`	`83`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`	`#include "qgsspatialiteconnection.h"`
`18`	`18`	`#include "qgsspatialiteconnpool.h"`
`19`	`19`	`#include "qgsspatialiteprovider.h"`
`20`		`-#include "qgsspatialiteexpressioncompiler.h"`
	`20`	`+#include "qgssqliteexpressioncompiler.h"`
`21`	`21`
`22`	`22`	`#include "qgsgeometry.h"`
`23`	`23`	`#include "qgslogger.h"`
`@@ -98,7 +98,7 @@ QgsSpatiaLiteFeatureIterator::QgsSpatiaLiteFeatureIterator( QgsSpatiaLiteFeature`
`98`	`98`
`99`	`99`	`if ( QSettings().value( "/qgis/compileExpressions", true ).toBool() )`
`100`	`100`	`{`
`101`		`- QgsSpatiaLiteExpressionCompiler compiler = QgsSpatiaLiteExpressionCompiler( source );`
	`101`	`+ QgsSQLiteExpressionCompiler compiler = QgsSQLiteExpressionCompiler( source->mFields );`
`102`	`102`
`103`	`103`	`QgsSqlExpressionCompiler::Result result = compiler.compile( request.filterExpression() );`
`104`	`104`
`@@ -139,7 +139,7 @@ QgsSpatiaLiteFeatureIterator::QgsSpatiaLiteFeatureIterator( QgsSpatiaLiteFeature`
`139`	`139`	`{`
`140`	`140`	`Q_FOREACH ( const QgsFeatureRequest::OrderByClause& clause, request.orderBy() )`
`141`	`141`	`{`
`142`		`- QgsSpatiaLiteExpressionCompiler compiler = QgsSpatiaLiteExpressionCompiler( source );`
	`142`	`+ QgsSQLiteExpressionCompiler compiler = QgsSQLiteExpressionCompiler( source->mFields );`
`143`	`143`	`QgsExpression expression = clause.expression();`
`144`	`144`	`if ( compiler.compile( &expression ) == QgsSqlExpressionCompiler::Complete )`
`145`	`145`	`{`