2009-05-08 17:29:56 -07:00
|
|
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
|
|
|
* vim: sw=2 ts=2 et lcs=trail\:.,tab\:>~ :
|
2007-06-12 15:01:05 -07:00
|
|
|
* ***** 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>
|
|
|
|
* Shawn Wilsher <me@shawnwilsher.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 ***** */
|
|
|
|
|
2009-05-08 17:29:56 -07:00
|
|
|
#ifndef _mozStoragePrivateHelpers_h_
|
|
|
|
#define _mozStoragePrivateHelpers_h_
|
2008-10-30 15:50:00 -07:00
|
|
|
|
2007-06-12 15:01:05 -07:00
|
|
|
/**
|
|
|
|
* This file contains convenience methods for mozStorage.
|
|
|
|
*/
|
|
|
|
|
2009-05-08 17:29:57 -07:00
|
|
|
#include "sqlite3.h"
|
|
|
|
#include "nsIVariant.h"
|
2009-05-08 17:29:56 -07:00
|
|
|
#include "mozStorage.h"
|
2009-07-22 15:31:03 -07:00
|
|
|
#include "jsapi.h"
|
|
|
|
|
|
|
|
class mozIStorageStatement;
|
2009-05-08 17:29:56 -07:00
|
|
|
|
2009-05-08 17:29:56 -07:00
|
|
|
namespace mozilla {
|
|
|
|
namespace storage {
|
|
|
|
|
2009-05-08 17:29:56 -07:00
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
//// Macros
|
|
|
|
|
|
|
|
#define ENSURE_INDEX_VALUE(aIndex, aCount) \
|
|
|
|
NS_ENSURE_TRUE(aIndex < aCount, NS_ERROR_INVALID_ARG)
|
|
|
|
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
//// Functions
|
|
|
|
|
2007-06-12 15:01:05 -07:00
|
|
|
/**
|
|
|
|
* Converts a SQLite return code to an nsresult return code.
|
|
|
|
*
|
2009-03-12 11:30:15 -07:00
|
|
|
* @param aSQLiteResultCode
|
|
|
|
* The SQLite return code to convert.
|
|
|
|
* @returns the corresponding nsresult code for aSQLiteResultCode.
|
2007-06-12 15:01:05 -07:00
|
|
|
*/
|
2009-05-08 17:29:56 -07:00
|
|
|
nsresult convertResultCode(int aSQLiteResultCode);
|
2007-06-12 15:01:05 -07:00
|
|
|
|
2009-03-12 11:30:15 -07:00
|
|
|
/**
|
|
|
|
* 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.
|
|
|
|
*/
|
2009-05-08 17:29:56 -07:00
|
|
|
void checkAndLogStatementPerformance(sqlite3_stmt *aStatement);
|
2007-06-12 15:01:05 -07:00
|
|
|
|
2009-07-22 15:31:03 -07:00
|
|
|
/**
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
bool
|
|
|
|
bindJSValue(JSContext *aCtx,
|
|
|
|
mozIStorageStatement *aStatement,
|
|
|
|
int aIdx,
|
|
|
|
jsval aValue);
|
|
|
|
|
2009-05-08 17:29:57 -07:00
|
|
|
/**
|
|
|
|
* Used to convert an nsIVariant to the proper SQLite type.
|
|
|
|
*/
|
|
|
|
template <typename T>
|
|
|
|
int variantToSQLiteT(T aObj, nsIVariant *aValue);
|
|
|
|
#include "variantToSQLiteT_impl.h" // To keep this file easier to read.
|
|
|
|
|
2009-05-08 17:29:56 -07:00
|
|
|
} // namespace storage
|
|
|
|
} // namespace mozilla
|
2007-06-12 15:01:05 -07:00
|
|
|
|
2009-05-08 17:29:56 -07:00
|
|
|
#endif // _mozStoragePrivateHelpers_h_
|