DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Implementation

Mercurial (920bcf17a9e1)

VCS Links

Line Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
/* -*- 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>
 *   Lev Serebryakov <lev@serebryakov.spb.ru>
 *
 * 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 _MOZSTORAGECONNECTION_H_
#define _MOZSTORAGECONNECTION_H_

#include "nsCOMPtr.h"
#include "nsAutoLock.h"

#include "nsString.h"
#include "nsInterfaceHashtable.h"
#include "mozIStorageProgressHandler.h"
#include "mozIStorageConnection.h"

#include "nsIMutableArray.h"

#include <sqlite3.h>

class nsIFile;
class nsIEventTarget;
class nsIThread;
class mozIStorageService;

class mozStorageConnection : public mozIStorageConnection
{
public:

    mozStorageConnection(mozIStorageService* aService);

    NS_IMETHOD Initialize(nsIFile *aDatabaseFile);

    // interfaces
    NS_DECL_ISUPPORTS
    NS_DECL_MOZISTORAGECONNECTION

    // fetch the native handle
    sqlite3 *GetNativeConnection() { return mDBConn; }

    /**
     * Lazily creates and returns a background execution thread.  In the future,
     * the thread may be re-claimed if left idle, so you should call this
     * method just before you dispatch and not save the reference.
     * 
     * @returns an event target suitable for asynchronous statement execution.
     */
    already_AddRefed<nsIEventTarget> getAsyncExecutionTarget();

private:
    ~mozStorageConnection();

protected:
    struct FindFuncEnumArgs {
        nsISupports *mTarget;
        PRBool       mFound;
    };

    void HandleSqliteError(const char *aSqlStatement);
    static PLDHashOperator s_FindFuncEnum(const nsACString &aKey,
                                          nsISupports* aData, void* userArg);
    PRBool FindFunctionByInstance(nsISupports *aInstance);

    static int s_ProgressHelper(void *arg);
    // Generic progress handler
    // Dispatch call to registered progress handler,
    // if there is one. Do nothing in other cases.
    int ProgressHandler();

    sqlite3 *mDBConn;
    nsCOMPtr<nsIFile> mDatabaseFile;

    /**
     * Protects access to mAsyncExecutionThread.
     */
    PRLock *mAsyncExecutionMutex;

    /**
     * Lazily created thread for asynchronous statement execution.  Consumers
     * should use getAsyncExecutionTarget rather than directly accessing this
     * field.
     */
    nsCOMPtr<nsIThread> mAsyncExecutionThread;
    /**
     * Set to true by Close() prior to actually shutting down the thread.  This
     * lets getAsyncExecutionTarget() know not to hand out any more thread
     * references (or to create the thread in the first place).  This variable
     * should be accessed while holding the mAsyncExecutionMutex.
     */
    PRBool mAsyncExecutionThreadShuttingDown;

    PRLock *mTransactionMutex;
    PRBool mTransactionInProgress;

    PRLock *mFunctionsMutex;
    nsInterfaceHashtable<nsCStringHashKey, nsISupports> mFunctions;

    PRLock *mProgressHandlerMutex;
    nsCOMPtr<mozIStorageProgressHandler> mProgressHandler;

    // This isn't accessed but is used to make sure that the connections do
    // not outlive the service. The service, for example, owns certain locks
    // in mozStorageAsyncIO file that the connections depend on.
    nsCOMPtr<mozIStorageService> mStorageService;
};

#endif /* _MOZSTORAGECONNECTION_H_ */