author Justin Lebar <>
Wed, 12 Oct 2011 20:15:28 -0400
changeset 80010 66f1de1d9cbaab1183aae2e28d6eeb493f171dd9
parent 79146 e7854b4d29ba905ae3994f821b160c989bac4260
child 98529 f4157e8c410708d76703f19e4dfb61859bfe32d8
permissions -rw-r--r--
Bug 683777 - Back out bug 646641 on suspicion of causing crashes. rs=smaug

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 * vim: sw=2 ts=2 sts=2 et
 * ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 * The Original Code is code.
 * The Initial Developer of the Original Code is
 * the Mozilla Foundation.
 * Portions created by the Initial Developer are Copyright (C) 2009
 * the Initial Developer. All Rights Reserved.
 * Contributor(s):
 *   Shawn Wilsher <> (Original Author)
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 * ***** END LICENSE BLOCK ***** */

#ifndef mozStorageStatementData_h
#define mozStorageStatementData_h

#include "sqlite3.h"

#include "nsAutoPtr.h"
#include "nsTArray.h"
#include "nsIEventTarget.h"
#include "mozilla/Util.h"
#include "nsThreadUtils.h"

#include "mozStorageBindingParamsArray.h"
#include "mozIStorageBaseStatement.h"
#include "mozStorageConnection.h"
#include "StorageBaseStatementInternal.h"

struct sqlite3_stmt;

namespace mozilla {
namespace storage {

class StatementData
  StatementData(sqlite3_stmt *aStatement,
                already_AddRefed<BindingParamsArray> aParamsArray,
                StorageBaseStatementInternal *aStatementOwner)
  : mStatement(aStatement)
  , mParamsArray(aParamsArray)
  , mStatementOwner(aStatementOwner)
    NS_PRECONDITION(mStatementOwner, "Must have a statement owner!");
  StatementData(const StatementData &aSource)
  : mStatement(aSource.mStatement)
  , mParamsArray(aSource.mParamsArray)
  , mStatementOwner(aSource.mStatementOwner)
    NS_PRECONDITION(mStatementOwner, "Must have a statement owner!");

   * Return the sqlite statement, fetching it from the storage statement.  In
   * the case of AsyncStatements this may actually create the statement 
  inline int getSqliteStatement(sqlite3_stmt **_stmt)
    if (!mStatement) {
      int rc = mStatementOwner->getAsyncStatement(&mStatement);
      NS_ENSURE_TRUE(rc == SQLITE_OK, rc);
    *_stmt = mStatement;
    return SQLITE_OK;

  operator BindingParamsArray *() const { return mParamsArray; }

   * Provide the ability to coerce back to a sqlite3 * connection for purposes 
   * of getting an error message out of it.
  operator sqlite3 *() const
    return mStatementOwner->getOwner()->GetNativeConnection();

   * NULLs out our sqlite3_stmt (it is held by the owner) after reseting it and
   * clear all bindings to it.  This is expected to occur on the async thread.
  inline void finalize()
    NS_PRECONDITION(mStatementOwner, "Must have a statement owner!");
#ifdef DEBUG
      nsCOMPtr<nsIEventTarget> asyncThread =
      // It's possible that we are shutting down the async thread, and this
      // method would return NULL as a result.
      if (asyncThread) {
        bool onAsyncThread;
        NS_ASSERTION(NS_SUCCEEDED(asyncThread->IsOnCurrentThread(&onAsyncThread)) && onAsyncThread,
                     "This should only be running on the async thread!");
    // In the AsyncStatement case we may never have populated mStatement if the
    // AsyncExecuteStatements got canceled or a failure occurred in constructing
    // the statement.
    if (mStatement) {
      mStatement = NULL;

   * Indicates if this statement has parameters to be bound before it is
   * executed.
   * @return true if the statement has parameters to bind against, false
   *         otherwise.
  inline bool hasParametersToBeBound() const { return !!mParamsArray; }
   * Indicates the number of implicit statements generated by this statement
   * requiring a transaction for execution.  For example a single statement
   * with N BindingParams will execute N implicit staments.
   * @return number of statements requiring a transaction for execution.
   * @note In the case of AsyncStatements this may actually create the
   *       statement.
  inline PRUint32 needsTransaction()
    // Be sure to use the getSqliteStatement helper, since sqlite3_stmt_readonly
    // can only analyze prepared statements and AsyncStatements are prepared
    // lazily.
    sqlite3_stmt *stmt;
    int rc = getSqliteStatement(&stmt);
    if (SQLITE_OK != rc || ::sqlite3_stmt_readonly(stmt)) {
      return 0;
    return mParamsArray ? mParamsArray->length() : 1;

  sqlite3_stmt *mStatement;
  nsRefPtr<BindingParamsArray> mParamsArray;

   * We hold onto a reference of the statement's owner so it doesn't get
   * destroyed out from under us.
  nsCOMPtr<StorageBaseStatementInternal> mStatementOwner;

} // namespace storage
} // namespace mozilla

#endif // mozStorageStatementData_h