author Jan Varga <>
Tue, 26 Mar 2013 12:13:17 +0100
changeset 136642 8d558e07caf4c6f9ef6660f2000f54754894e814
parent 107762 a1cb80516a0061cc0e0e3312e93b6a2585689367
child 156778 dba0f0715b188190b2fe9a924f613ea02af9bf3e
permissions -rw-r--r--
Bug 767944 - Implement a manager for centralized quota and storage handling. r=bent

/* -*- 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 mozStoragePrivateHelpers_h
#define mozStoragePrivateHelpers_h

 * This file contains convenience methods for mozStorage.

#include "sqlite3.h"
#include "nsIVariant.h"
#include "nsError.h"
#include "jsapi.h"
#include "nsAutoPtr.h"

class mozIStorageCompletionCallback;
class mozIStorageBaseStatement;
class mozIStorageBindingParams;
class nsIRunnable;

namespace mozilla {
namespace storage {

//// Macros

#define ENSURE_INDEX_VALUE(aIndex, aCount) \

//// Functions

 * Converts a SQLite return code to an nsresult return code.
 * @param aSQLiteResultCode
 *        The SQLite return code to convert.
 * @returns the corresponding nsresult code for aSQLiteResultCode.
nsresult convertResultCode(int aSQLiteResultCode);

 * Checks the performance of a SQLite statement and logs a warning with
 * NS_WARNING.  Currently this only checks the number of sort operations done
 * on a statement, and if more than zero have been done, the statement can be
 * made faster with the careful use of an index.
 * @param aStatement
 *        The sqlite3_stmt object to check.
void checkAndLogStatementPerformance(sqlite3_stmt *aStatement);

 * Convert the provided jsval into a variant representation if possible.
 * @param aCtx
 *        The JSContext the value is from.
 * @param aValue
 *        The JavaScript value to convert.  All primitive types are supported,
 *        but only Date objects are supported from the Date family.  Date
 *        objects are coerced to PRTime (nanoseconds since epoch) values.
 * @return the variant if conversion was successful, nullptr if conversion
 *         failed.  The caller is responsible for addref'ing if non-null.
nsIVariant *convertJSValToVariant(JSContext *aCtx, jsval aValue);

 * Obtains an event that will notify a completion callback about completion.
 * @param aCallback
 *        The callback to be notified.
 * @return an nsIRunnable that can be dispatched to the calling thread.
already_AddRefed<nsIRunnable> newCompletionEvent(
  mozIStorageCompletionCallback *aCallback

} // namespace storage
} // namespace mozilla

#endif // mozStoragePrivateHelpers_h