/src/mozilla-central/storage/mozStoragePrivateHelpers.h

Source (jump to first uncovered line)
/* -*- 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 http://mozilla.org/MPL/2.0/. */

#ifndef mozStoragePrivateHelpers_h
#define mozStoragePrivateHelpers_h

/**
 * This file contains convenience methods for mozStorage.
 */

#include "sqlite3.h"
#include "nsIVariant.h"
#include "nsError.h"
#include "nsAutoPtr.h"
#include "js/TypeDecls.h"
#include "Variant.h"

class mozIStorageCompletionCallback;
class nsIRunnable;

namespace mozilla {
namespace storage {

////////////////////////////////////////////////////////////////////////////////
//// Macros

#define ENSURE_INDEX_VALUE(aIndex, aCount) \
  NS_ENSURE_TRUE(aIndex < aCount, NS_ERROR_INVALID_ARG)

////////////////////////////////////////////////////////////////////////////////
//// 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 JS::Value 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, const JS::Value& aValue);

/**
 * Convert a provided nsIVariant implementation to our own thread-safe
 * refcounting implementation, if needed.
 *
 * @param aValue
 *        The original nsIVariant to be converted.
 * @return a thread-safe refcounting nsIVariant implementation.
 */
Variant_base *convertVariantToStorageVariant(nsIVariant *aVariant);

/**
 * 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
);

/**
 * Utility method to get a Blob as a string value.  The string expects
 * the interface exposed by nsAString/nsACString/etc.
 */
template<class T, class V>
nsresult
DoGetBlobAsString(T* aThis, uint32_t aIndex, V& aValue)
{
  typedef typename V::char_type char_type;

  uint32_t size;
  char_type* blob;
  nsresult rv =
    aThis->GetBlob(aIndex, &size, reinterpret_cast<uint8_t**>(&blob));
  NS_ENSURE_SUCCESS(rv, rv);

  aValue.Assign(blob, size / sizeof(char_type));
  delete[] blob;
  return NS_OK;
}

/**
 * Utility method to bind a string value as a Blob.  The string expects
 * the interface exposed by nsAString/nsACString/etc.
 */
template<class T, class V>
nsresult
DoBindStringAsBlobByName(T* aThis, const nsACString& aName, const V& aValue)
{
  typedef typename V::char_type char_type;
  return aThis->BindBlobByName(aName,
                        reinterpret_cast<const uint8_t*>(aValue.BeginReading()),
                        aValue.Length() * sizeof(char_type));
}

/**
 * Utility method to bind a string value as a Blob.  The string expects
 * the interface exposed by nsAString/nsACString/etc.
 */
template<class T, class V>
nsresult
DoBindStringAsBlobByIndex(T* aThis, uint32_t aIndex, const V& aValue)
{
  typedef typename V::char_type char_type;
  return aThis->BindBlobByIndex(aIndex,
                        reinterpret_cast<const uint8_t*>(aValue.BeginReading()),
                        aValue.Length() * sizeof(char_type));
}

} // namespace storage
} // namespace mozilla

#endif // mozStoragePrivateHelpers_h

Line	Count	Source (jump to first uncovered line)
1		/* -- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 --
2		* vim: sw=2 ts=2 et lcs=trail\:.,tab\:>~ :
3		* This Source Code Form is subject to the terms of the Mozilla Public
4		* License, v. 2.0. If a copy of the MPL was not distributed with this
5		* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
6
7		#ifndef mozStoragePrivateHelpers_h
8		#define mozStoragePrivateHelpers_h
9
10		/**
11		* This file contains convenience methods for mozStorage.
12		*/
13
14		#include "sqlite3.h"
15		#include "nsIVariant.h"
16		#include "nsError.h"
17		#include "nsAutoPtr.h"
18		#include "js/TypeDecls.h"
19		#include "Variant.h"
20
21		class mozIStorageCompletionCallback;
22		class nsIRunnable;
23
24		namespace mozilla {
25		namespace storage {
26
27		////////////////////////////////////////////////////////////////////////////////
28		//// Macros
29
30		#define ENSURE_INDEX_VALUE(aIndex, aCount) \
31	0	NS_ENSURE_TRUE(aIndex < aCount, NS_ERROR_INVALID_ARG)
32
33		////////////////////////////////////////////////////////////////////////////////
34		//// Functions
35
36		/**
37		* Converts a SQLite return code to an nsresult return code.
38		*
39		* @param aSQLiteResultCode
40		* The SQLite return code to convert.
41		* @returns the corresponding nsresult code for aSQLiteResultCode.
42		*/
43		nsresult convertResultCode(int aSQLiteResultCode);
44
45		/**
46		* Checks the performance of a SQLite statement and logs a warning with
47		* NS_WARNING. Currently this only checks the number of sort operations done
48		* on a statement, and if more than zero have been done, the statement can be
49		* made faster with the careful use of an index.
50		*
51		* @param aStatement
52		* The sqlite3_stmt object to check.
53		*/
54		void checkAndLogStatementPerformance(sqlite3_stmt *aStatement);
55
56		/**
57		* Convert the provided JS::Value into a variant representation if possible.
58		*
59		* @param aCtx
60		* The JSContext the value is from.
61		* @param aValue
62		* The JavaScript value to convert. All primitive types are supported,
63		* but only Date objects are supported from the Date family. Date
64		* objects are coerced to PRTime (nanoseconds since epoch) values.
65		* @return the variant if conversion was successful, nullptr if conversion
66		* failed. The caller is responsible for addref'ing if non-null.
67		*/
68		nsIVariant convertJSValToVariant(JSContext aCtx, const JS::Value& aValue);
69
70		/**
71		* Convert a provided nsIVariant implementation to our own thread-safe
72		* refcounting implementation, if needed.
73		*
74		* @param aValue
75		* The original nsIVariant to be converted.
76		* @return a thread-safe refcounting nsIVariant implementation.
77		*/
78		Variant_base convertVariantToStorageVariant(nsIVariant aVariant);
79
80		/**
81		* Obtains an event that will notify a completion callback about completion.
82		*
83		* @param aCallback
84		* The callback to be notified.
85		* @return an nsIRunnable that can be dispatched to the calling thread.
86		*/
87		already_AddRefed<nsIRunnable> newCompletionEvent(
88		mozIStorageCompletionCallback *aCallback
89		);
90
91		/**
92		* Utility method to get a Blob as a string value. The string expects
93		* the interface exposed by nsAString/nsACString/etc.
94		*/
95		template<class T, class V>
96		nsresult
97		DoGetBlobAsString(T* aThis, uint32_t aIndex, V& aValue)
98	0	{
99	0	typedef typename V::char_type char_type;
100	0
101	0	uint32_t size;
102	0	char_type* blob;
103	0	nsresult rv =
104	0	aThis->GetBlob(aIndex, &size, reinterpret_cast<uint8_t**>(&blob));
105	0	NS_ENSURE_SUCCESS(rv, rv);
106	0
107	0	aValue.Assign(blob, size / sizeof(char_type));
108	0	delete[] blob;
109	0	return NS_OK;
110	0	} Unexecuted instantiation: nsresult mozilla::storage::DoGetBlobAsString<mozilla::storage::ArgValueArray, nsTSubstring<char16_t> >(mozilla::storage::ArgValueArray, unsigned int, nsTSubstring<char16_t>&) Unexecuted instantiation: nsresult mozilla::storage::DoGetBlobAsString<mozilla::storage::ArgValueArray, nsTSubstring<char> >(mozilla::storage::ArgValueArray, unsigned int, nsTSubstring<char>&) Unexecuted instantiation: nsresult mozilla::storage::DoGetBlobAsString<mozilla::storage::Row, nsTSubstring<char16_t> >(mozilla::storage::Row, unsigned int, nsTSubstring<char16_t>&) Unexecuted instantiation: nsresult mozilla::storage::DoGetBlobAsString<mozilla::storage::Row, nsTSubstring<char> >(mozilla::storage::Row, unsigned int, nsTSubstring<char>&) Unexecuted instantiation: nsresult mozilla::storage::DoGetBlobAsString<mozilla::storage::Statement, nsTSubstring<char16_t> >(mozilla::storage::Statement, unsigned int, nsTSubstring<char16_t>&) Unexecuted instantiation: nsresult mozilla::storage::DoGetBlobAsString<mozilla::storage::Statement, nsTSubstring<char> >(mozilla::storage::Statement, unsigned int, nsTSubstring<char>&)
111
112		/**
113		* Utility method to bind a string value as a Blob. The string expects
114		* the interface exposed by nsAString/nsACString/etc.
115		*/
116		template<class T, class V>
117		nsresult
118		DoBindStringAsBlobByName(T* aThis, const nsACString& aName, const V& aValue)
119	0	{
120	0	typedef typename V::char_type char_type;
121	0	return aThis->BindBlobByName(aName,
122	0	reinterpret_cast<const uint8_t*>(aValue.BeginReading()),
123	0	aValue.Length() * sizeof(char_type));
124	0	} Unexecuted instantiation: nsresult mozilla::storage::DoBindStringAsBlobByName<mozilla::storage::BindingParams, nsTSubstring<char16_t> >(mozilla::storage::BindingParams, nsTSubstring<char> const&, nsTSubstring<char16_t> const&) Unexecuted instantiation: nsresult mozilla::storage::DoBindStringAsBlobByName<mozilla::storage::BindingParams, nsTSubstring<char> >(mozilla::storage::BindingParams, nsTSubstring<char> const&, nsTSubstring<char> const&)
125
126		/**
127		* Utility method to bind a string value as a Blob. The string expects
128		* the interface exposed by nsAString/nsACString/etc.
129		*/
130		template<class T, class V>
131		nsresult
132		DoBindStringAsBlobByIndex(T* aThis, uint32_t aIndex, const V& aValue)
133	0	{
134	0	typedef typename V::char_type char_type;
135	0	return aThis->BindBlobByIndex(aIndex,
136	0	reinterpret_cast<const uint8_t*>(aValue.BeginReading()),
137	0	aValue.Length() * sizeof(char_type));
138	0	} Unexecuted instantiation: nsresult mozilla::storage::DoBindStringAsBlobByIndex<mozilla::storage::BindingParams, nsTSubstring<char16_t> >(mozilla::storage::BindingParams, unsigned int, nsTSubstring<char16_t> const&) Unexecuted instantiation: nsresult mozilla::storage::DoBindStringAsBlobByIndex<mozilla::storage::BindingParams, nsTSubstring<char> >(mozilla::storage::BindingParams, unsigned int, nsTSubstring<char> const&)
139
140		} // namespace storage
141		} // namespace mozilla
142
143		#endif // mozStoragePrivateHelpers_h

Coverage Report

Created: 2018-09-25 14:53