storage/src/mozStorageStatement.h
author Fred Jendrzejewski <fred.jen@web.de>
Thu, 22 Jan 2009 17:15:34 +1300
changeset 24031 d001c3ce1598df1c0a348112292d328cd5f2c8d7
parent 19194 37298927e98bc94bb2d427128e92f8ae7fd6a419
child 26431 b48482c54995ef7fb8b6d6506da910a7c4d4c815
permissions -rw-r--r--
Bug 466622. Replace nsCStringArray with nsTArray<nsCString> for more consistent code and fewer heap allocations. r+sr=roc,r=bsmedberg

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* ***** 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
 * http://www.mozilla.org/MPL/
 *
 * 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 Oracle Corporation code.
 *
 * The Initial Developer of the Original Code is
 *  Oracle Corporation
 * Portions created by the Initial Developer are Copyright (C) 2004
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Vladimir Vukicevic <vladimir.vukicevic@oracle.com>
 *
 * 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 _MOZSTORAGESTATEMENT_H_
#define _MOZSTORAGESTATEMENT_H_

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

#include "nsTArray.h"

#include "mozIStorageStatement.h"

#include <sqlite3.h>

class mozStorageConnection;
class nsIXPConnectJSObjectHolder;
class mozStorageStatementJSHelper;

class mozStorageStatement : public mozIStorageStatement
{
public:
    mozStorageStatement();

    // interfaces
    NS_DECL_ISUPPORTS
    NS_DECL_MOZISTORAGESTATEMENT
    NS_DECL_MOZISTORAGEVALUEARRAY

    /**
     * Initializes the object on aDBConnection by preparing the SQL statement
     * given by aSQLStatement.
     *
     * @param aDBConnection
     *        The mozStorageConnection object this statement is associated with.
     * @param aSQLStatement
     *        The SQL statement to prepare that this object will represent.
     */
    nsresult Initialize(mozStorageConnection *aDBConnection,
                        const nsACString &aSQLStatement);


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

private:
    ~mozStorageStatement();

protected:
    nsRefPtr<mozStorageConnection> mDBConnection;
    sqlite3_stmt *mDBStatement;
    PRUint32 mParamCount;
    PRUint32 mResultColumnCount;
    nsTArray<nsCString> mColumnNames;
    PRBool mExecuting;

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

    friend class mozStorageStatementJSHelper;
};

#endif /* _MOZSTORAGESTATEMENT_H_ */