File indexing completed on 2024-12-01 04:18:57

 /* This file is part of the KDE project
    Copyright (C) 2004-2016 Jarosław Staniek <staniek@kde.org>
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.
 
    This library 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
    Library General Public License for more details.
 
    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  * Boston, MA 02110-1301, USA.
 */
 
 #ifndef KDB_PARSER_P_H
 #define KDB_PARSER_P_H
 
 #include "KDbParser.h"
 #include "KDbSqlTypes.h"
 
 #include <QList>
 #include <QHash>
 #include <QCache>
 #include <QString>
 
 class KDbQuerySchema;
 class KDbTableSchema;
 class KDbConnection;
 class KDbExpression;
 
 //! @internal
 class KDbParserPrivate
 {
 public:
     KDbParserPrivate();
     ~KDbParserPrivate();
 
     void reset();
 
     //! For use by parser's low level C functions
     inline static KDbParserPrivate* get(KDbParser *parser) {
         return parser->d;
     }
 
     /**
      * Sets the type of statement.
      */
     void setStatementType(KDbParser::StatementType type);
 
     /**
      * Sets @a table schema object.
      */
     void setTableSchema(KDbTableSchema *table);
 
     /**
      * Sets @a query schema object.
      */
     //! @todo Add other query types
     void setQuerySchema(KDbQuerySchema *query);
 
     /**
      * Sets a error.
      */
     void setError(const KDbParserError &err);
 
     /**
      * Creates a new query or provides the one provided by KDbParser::parse().
      */
     Q_REQUIRED_RESULT KDbQuerySchema *createQuery();
 
     friend class KDbParser;
 
 private:
     KDbParser::StatementType statementType;
     KDbTableSchema *table;
 
     //! Query created as a result of parse() (createQuery()); can be also predefined - passed as
     //! argument of parse()
     KDbQuerySchema *query;
 
     KDbConnection *connection;
     KDbEscapedString sql;
     KDbParserError error;
     bool initialized;
     Q_DISABLE_COPY(KDbParserPrivate)
 };
 
 /*! Info used on parsing. */
 class KDB_TESTING_EXPORT KDbParseInfo
 {
 public:
     ~KDbParseInfo();
 
     //! @return positions of tables/aliases having the same name @a tableOrAliasName.
     //! First tries to use information provided by appendPositionForTableOrAliasName(),
     //! then information from the query schema.
     QList<int> tablesAndAliasesForName(const QString &tableOrAliasName) const;
 
     //! @return query schema for this parsing
     KDbQuerySchema* querySchema() const;
 
     //! @return error message for the parsing process
     QString errorMessage() const;
 
     //! Sets error message for the parsing process to @a message
     void setErrorMessage(const QString &message);
 
     //! @return detailed error description for the parsing process
     QString errorDescription() const;
 
     //! Sets detailed error description for the parsing process to @a description
     void setErrorDescription(const QString &description);
 
 protected:
     //! Constructs parse info structure for query @a query.
     explicit KDbParseInfo(KDbQuerySchema *query);
 
     class Private;
     Private * const d;
 private:
     Q_DISABLE_COPY(KDbParseInfo)
 };
 
 class Q_DECL_HIDDEN KDbParseInfo::Private
 {
 public:
     Private() {}
     ~Private() {
         qDeleteAll(repeatedTablesAndAliases);
     }
 
     //! collects positions of tables/aliases with the same names
     QHash< QString, QList<int>* > repeatedTablesAndAliases;
 
     QString errorMessage, errorDescription; // helpers
 
     KDbQuerySchema *querySchema;
 private:
     Q_DISABLE_COPY(Private)
 };
 
 /*! Internal info used on parsing (writable). */
 class KDB_TESTING_EXPORT KDbParseInfoInternal : public KDbParseInfo
 {
 public:
     //! Constructs parse info structure for query @a query.
     explicit KDbParseInfoInternal(KDbQuerySchema *query);
 
     ~KDbParseInfoInternal();
 
     //! Appends position @a pos for table or alias @a tableOrAliasName.
     void appendPositionForTableOrAliasName(const QString &tableOrAliasName, int pos);
 
 private:
     Q_DISABLE_COPY(KDbParseInfoInternal)
 };
 
 KDB_TESTING_EXPORT const char* g_tokenName(unsigned int offset);
 
 void yyerror(const char *str);
 
 void setError(const QString& errName, const QString& errDesc);
 
 void setError(const QString& errDesc);
 
 bool addColumn(KDbParseInfo* parseInfo, KDbExpression* columnExpr);
 
 KDbQuerySchema* buildSelectQuery(
     KDbQuerySchema* querySchema, KDbNArgExpression* colViews,
     KDbNArgExpression* tablesList = nullptr, SelectOptionsInternal * options = nullptr);
 
 extern KDbParser *globalParser;
 extern KDbField *globalField;
 
 #endif