storage/src/mozStorageStatement.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is Oracle Corporation code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  *  Oracle Corporation
  19  * Portions created by the Initial Developer are Copyright (C) 2004
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Vladimir Vukicevic <vladimir.vukicevic@oracle.com>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #ifndef _MOZSTORAGESTATEMENT_H_
  40 #define _MOZSTORAGESTATEMENT_H_
  41
  42 #include "nsAutoPtr.h"
  43 #include "nsString.h"
  44
  45 #include "nsVoidArray.h"
  46
  47 #include "mozIStorageStatement.h"
  48
  49 #include <sqlite3.h>
  50
  51 class mozStorageConnection;
  52 class nsIXPConnectJSObjectHolder;
  53 class mozStorageStatementJSHelper;
  54
  55 class mozStorageStatement : public mozIStorageStatement
  56 {
  57 public:
  58     mozStorageStatement();
  59
  60     // interfaces
  61     NS_DECL_ISUPPORTS
  62     NS_DECL_MOZISTORAGESTATEMENT
  63     NS_DECL_MOZISTORAGEVALUEARRAY
  64
  65     /**
  66      * Initializes the object on aDBConnection by preparing the SQL statement
  67      * given by aSQLStatement.
  68      *
  69      * @param aDBConnection
  70      *        The mozStorageConnection object this statement is associated with.
  71      * @param aSQLStatement
  72      *        The SQL statement to prepare that this object will represent.
  73      */
  74     nsresult Initialize(mozStorageConnection *aDBConnection,
  75                         const nsACString &aSQLStatement);
  76
  77
  78     /**
  79      * Obtains the native statement pointer.
  80      */
  81     inline sqlite3_stmt *NativeStatement() { return mDBStatement; }
  82
  83 private:
  84     ~mozStorageStatement();
  85
  86 protected:
  87     nsRefPtr<mozStorageConnection> mDBConnection;
  88     sqlite3_stmt *mDBStatement;
  89     PRUint32 mParamCount;
  90     PRUint32 mResultColumnCount;
  91     nsCStringArray mColumnNames;
  92     PRBool mExecuting;
  93
  94     /**
  95      * The following two members are only used with the JS helper.  They cache
  96      * the row and params objects.
  97      */
  98     nsCOMPtr<nsIXPConnectJSObjectHolder> mStatementParamsHolder;
  99     nsCOMPtr<nsIXPConnectJSObjectHolder> mStatementRowHolder;
 100
 101     friend class mozStorageStatementJSHelper;
 102 };
 103
 104 #endif /* _MOZSTORAGESTATEMENT_H_ */