summaryrefslogtreecommitdiffstats
path: root/kexi/plugins/scripting/kexidb/kexidbparser.h
diff options
context:
space:
mode:
Diffstat (limited to 'kexi/plugins/scripting/kexidb/kexidbparser.h')
-rw-r--r--kexi/plugins/scripting/kexidb/kexidbparser.h95
1 files changed, 95 insertions, 0 deletions
diff --git a/kexi/plugins/scripting/kexidb/kexidbparser.h b/kexi/plugins/scripting/kexidb/kexidbparser.h
new file mode 100644
index 000000000..09ac22daa
--- /dev/null
+++ b/kexi/plugins/scripting/kexidb/kexidbparser.h
@@ -0,0 +1,95 @@
+/***************************************************************************
+ * kexidbparser.h
+ * This file is part of the KDE project
+ * copyright (C)2004-2005 by Sebastian Sauer (mail@dipe.org)
+ *
+ * This program 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 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
+ * Library General Public License for more details.
+ * You should have received a copy of the GNU Library General Public License
+ * along with this program; see the file COPYING. If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
+ ***************************************************************************/
+
+#ifndef KROSS_KEXIDB_KEXIDBPARSER_H
+#define KROSS_KEXIDB_KEXIDBPARSER_H
+
+#include <qstring.h>
+
+#include <api/object.h>
+#include <api/list.h>
+#include <api/class.h>
+
+#include <kexidb/drivermanager.h>
+#include <kexidb/parser/parser.h>
+
+namespace Kross { namespace KexiDB {
+
+ // Forward declaration.
+ class KexiDBConnection;
+ class KexiDBTableSchema;
+ class KexiDBQuerySchema;
+
+ /**
+ * The KexiDBParser could be used to parse SQL-statements.
+ *
+ * Example (in Python) ;
+ * @code
+ * # First we need a parser object.
+ * parser = connection.parser()
+ * # Parse a SQL-statement.
+ * parser.parse("SELECT * from table1")
+ * # The operation could be e.g. SELECT or INSERT.
+ * if parser.operation() == 'Error':
+ * raise parser.errorMsg()
+ * # Print some feedback.
+ * print "Successfully parsed the SQL-statement %s" % parser.statement()
+ * @endcode
+ */
+ class KexiDBParser : public Kross::Api::Class<KexiDBParser>
+ {
+ public:
+ KexiDBParser(KexiDBConnection* connection, ::KexiDB::Parser* parser);
+ virtual ~KexiDBParser();
+ virtual const QString getClassName() const;
+
+ private:
+
+ /** Clears previous results and runs the parser on the SQL statement passed as an argument. */
+ bool parse(const QString& sql);
+ /** Clears parsing results. */
+ void clear();
+ /** Returns the resulting operation. */
+ const QString operation();
+
+ /** Returns the KexiDBTableSchema object on a CREATE TABLE operation. */
+ KexiDBTableSchema* table();
+ /** Returns the KexiDBQuerySchema object on a SELECT operation. */
+ KexiDBQuerySchema* query();
+ /** Returns the KexiDBConnection object pointing to the used database connection. */
+ KexiDBConnection* connection();
+ /** Returns the SQL query statement. */
+ const QString statement();
+
+ /** Returns the type string of the last error. */
+ const QString errorType();
+ /** Returns the message of the last error. */
+ const QString errorMsg();
+ /** Returns the position where the last error occurred. */
+ int errorAt();
+
+ private:
+ KexiDBConnection* m_connection;
+ ::KexiDB::Parser* m_parser;
+ };
+
+}}
+
+#endif
+