author Matt Howell <>
Sun, 02 Oct 2016 10:48:47 -0700
changeset 316391 f3f755f8c1e472b093b053688f7431eb3e8933e4
parent 268184 e8c7dfe727cd970e2c3294934e2927b14143c205
permissions -rw-r--r--
Bug 1306699 - Only invoke attribution code functionality in desktop Firefox; r=gfritzsche MozReview-Commit-ID: JMGuP9kI6gD

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 * vim: sw=2 ts=2 et lcs=trail\:.,tab\:>~ :
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at */

#ifndef mozStorageStatement_h
#define mozStorageStatement_h

#include "nsAutoPtr.h"
#include "nsString.h"

#include "nsTArray.h"

#include "mozStorageBindingParamsArray.h"
#include "mozStorageStatementData.h"
#include "mozIStorageStatement.h"
#include "mozIStorageValueArray.h"
#include "StorageBaseStatementInternal.h"
#include "mozilla/Attributes.h"

class nsIXPConnectJSObjectHolder;
struct sqlite3_stmt;

namespace mozilla {
namespace storage {
class StatementJSHelper;
class Connection;

class Statement final : public mozIStorageStatement
                      , public mozIStorageValueArray
                      , public StorageBaseStatementInternal
  // NS_DECL_MOZISTORAGEVALUEARRAY (methods in mozIStorageStatement)


   * Initializes the object on aDBConnection by preparing the SQL statement
   * given by aSQLStatement.
   * @param aDBConnection
   *        The Connection object this statement is associated with.
   * @param aNativeConnection
   *        The native Sqlite connection this statement is associated with.
   * @param aSQLStatement
   *        The SQL statement to prepare that this object will represent.
  nsresult initialize(Connection *aDBConnection,
                      sqlite3* aNativeConnection,
                      const nsACString &aSQLStatement);

   * Obtains the native statement pointer.
  inline sqlite3_stmt *nativeStatement() { return mDBStatement; }

   * Obtains and transfers ownership of the array of parameters that are bound
   * to this statment.  This can be null.
  inline already_AddRefed<BindingParamsArray> bindingParamsArray()
    return mParamsArray.forget();


    sqlite3_stmt *mDBStatement;
    uint32_t mParamCount;
    uint32_t mResultColumnCount;
    nsTArray<nsCString> mColumnNames;
    bool mExecuting;

     * @return a pointer to the BindingParams object to use with our Bind*
     *         method.
    mozIStorageBindingParams *getParams();

     * Holds the array of parameters to bind to this statement when we execute
     * it asynchronously.
    RefPtr<BindingParamsArray> mParamsArray;

     * The following two members are only used with the JS helper.  They cache
     * the row and params objects.
    nsMainThreadPtrHandle<nsIXPConnectJSObjectHolder> mStatementParamsHolder;
    nsMainThreadPtrHandle<nsIXPConnectJSObjectHolder> mStatementRowHolder;

   * Internal version of finalize that allows us to tell it if it is being
   * called from the destructor so it can know not to dispatch events that
   * require a reference to us.
   * @param aDestructing
   *        Is the destructor calling?
  nsresult internalFinalize(bool aDestructing);

  friend class StatementJSHelper;

} // namespace storage
} // namespace mozilla

#endif // mozStorageStatement_h