gecko-dev/storage/SQLCollations.h
Birunthan Mohanathas 296aa63730 Bug 1164717 - Flatten storage/src/ directory. r=mak
--HG--
rename : storage/src/FileSystemModule.cpp => storage/FileSystemModule.cpp
rename : storage/src/FileSystemModule.h => storage/FileSystemModule.h
rename : storage/src/IStorageBindingParamsInternal.h => storage/IStorageBindingParamsInternal.h
rename : storage/src/SQLCollations.cpp => storage/SQLCollations.cpp
rename : storage/src/SQLCollations.h => storage/SQLCollations.h
rename : storage/src/SQLiteMutex.h => storage/SQLiteMutex.h
rename : storage/src/StorageBaseStatementInternal.cpp => storage/StorageBaseStatementInternal.cpp
rename : storage/src/StorageBaseStatementInternal.h => storage/StorageBaseStatementInternal.h
rename : storage/src/TelemetryVFS.cpp => storage/TelemetryVFS.cpp
rename : storage/src/VacuumManager.cpp => storage/VacuumManager.cpp
rename : storage/src/VacuumManager.h => storage/VacuumManager.h
rename : storage/src/Variant.h => storage/Variant.h
rename : storage/src/Variant_inl.h => storage/Variant_inl.h
rename : storage/src/mozStorageArgValueArray.cpp => storage/mozStorageArgValueArray.cpp
rename : storage/src/mozStorageArgValueArray.h => storage/mozStorageArgValueArray.h
rename : storage/src/mozStorageAsyncStatement.cpp => storage/mozStorageAsyncStatement.cpp
rename : storage/src/mozStorageAsyncStatement.h => storage/mozStorageAsyncStatement.h
rename : storage/src/mozStorageAsyncStatementExecution.cpp => storage/mozStorageAsyncStatementExecution.cpp
rename : storage/src/mozStorageAsyncStatementExecution.h => storage/mozStorageAsyncStatementExecution.h
rename : storage/src/mozStorageAsyncStatementJSHelper.cpp => storage/mozStorageAsyncStatementJSHelper.cpp
rename : storage/src/mozStorageAsyncStatementJSHelper.h => storage/mozStorageAsyncStatementJSHelper.h
rename : storage/src/mozStorageAsyncStatementParams.cpp => storage/mozStorageAsyncStatementParams.cpp
rename : storage/src/mozStorageAsyncStatementParams.h => storage/mozStorageAsyncStatementParams.h
rename : storage/src/mozStorageBindingParams.cpp => storage/mozStorageBindingParams.cpp
rename : storage/src/mozStorageBindingParams.h => storage/mozStorageBindingParams.h
rename : storage/src/mozStorageBindingParamsArray.cpp => storage/mozStorageBindingParamsArray.cpp
rename : storage/src/mozStorageBindingParamsArray.h => storage/mozStorageBindingParamsArray.h
rename : storage/src/mozStorageConnection.cpp => storage/mozStorageConnection.cpp
rename : storage/src/mozStorageConnection.h => storage/mozStorageConnection.h
rename : storage/src/mozStorageError.cpp => storage/mozStorageError.cpp
rename : storage/src/mozStorageError.h => storage/mozStorageError.h
rename : storage/src/mozStoragePrivateHelpers.cpp => storage/mozStoragePrivateHelpers.cpp
rename : storage/src/mozStoragePrivateHelpers.h => storage/mozStoragePrivateHelpers.h
rename : storage/src/mozStorageResultSet.cpp => storage/mozStorageResultSet.cpp
rename : storage/src/mozStorageResultSet.h => storage/mozStorageResultSet.h
rename : storage/src/mozStorageRow.cpp => storage/mozStorageRow.cpp
rename : storage/src/mozStorageRow.h => storage/mozStorageRow.h
rename : storage/src/mozStorageSQLFunctions.cpp => storage/mozStorageSQLFunctions.cpp
rename : storage/src/mozStorageSQLFunctions.h => storage/mozStorageSQLFunctions.h
rename : storage/src/mozStorageService.cpp => storage/mozStorageService.cpp
rename : storage/src/mozStorageService.h => storage/mozStorageService.h
rename : storage/src/mozStorageStatement.cpp => storage/mozStorageStatement.cpp
rename : storage/src/mozStorageStatement.h => storage/mozStorageStatement.h
rename : storage/src/mozStorageStatementData.h => storage/mozStorageStatementData.h
rename : storage/src/mozStorageStatementJSHelper.cpp => storage/mozStorageStatementJSHelper.cpp
rename : storage/src/mozStorageStatementJSHelper.h => storage/mozStorageStatementJSHelper.h
rename : storage/src/mozStorageStatementParams.cpp => storage/mozStorageStatementParams.cpp
rename : storage/src/mozStorageStatementParams.h => storage/mozStorageStatementParams.h
rename : storage/src/mozStorageStatementRow.cpp => storage/mozStorageStatementRow.cpp
rename : storage/src/mozStorageStatementRow.h => storage/mozStorageStatementRow.h
rename : storage/src/variantToSQLiteT_impl.h => storage/variantToSQLiteT_impl.h
2015-05-19 10:47:33 -07:00

250 lines
10 KiB
C++

/* -*- 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 mozilla_storage_SQLCollations_h
#define mozilla_storage_SQLCollations_h
#include "mozStorageService.h"
#include "nscore.h"
#include "nsString.h"
#include "sqlite3.h"
namespace mozilla {
namespace storage {
/**
* Registers the collating sequences declared here with the specified
* database and Service.
*
* @param aDB
* The database we'll be registering the collations with.
* @param aService
* The Service that owns the nsICollation used by our collations.
* @return the SQLite status code indicating success or failure.
*/
int registerCollations(sqlite3 *aDB, Service *aService);
////////////////////////////////////////////////////////////////////////////////
//// Predefined Functions
/**
* Custom UTF-8 collating sequence that respects the application's locale.
* Comparison is case- and accent-insensitive. This is called by SQLite.
*
* @param aService
* The Service that owns the nsICollation used by this collation.
* @param aLen1
* The number of bytes in aStr1.
* @param aStr1
* The string to be compared against aStr2. It will be passed in by
* SQLite as a non-null-terminated char* buffer.
* @param aLen2
* The number of bytes in aStr2.
* @param aStr2
* The string to be compared against aStr1. It will be passed in by
* SQLite as a non-null-terminated char* buffer.
* @return aStr1 - aStr2. That is, if aStr1 < aStr2, returns a negative number.
* If aStr1 > aStr2, returns a positive number. If aStr1 == aStr2,
* returns 0.
*/
int localeCollation8(void *aService,
int aLen1,
const void *aStr1,
int aLen2,
const void *aStr2);
/**
* Custom UTF-8 collating sequence that respects the application's locale.
* Comparison is case-sensitive and accent-insensitive. This is called by
* SQLite.
*
* @param aService
* The Service that owns the nsICollation used by this collation.
* @param aLen1
* The number of bytes in aStr1.
* @param aStr1
* The string to be compared against aStr2. It will be passed in by
* SQLite as a non-null-terminated char* buffer.
* @param aLen2
* The number of bytes in aStr2.
* @param aStr2
* The string to be compared against aStr1. It will be passed in by
* SQLite as a non-null-terminated char* buffer.
* @return aStr1 - aStr2. That is, if aStr1 < aStr2, returns a negative number.
* If aStr1 > aStr2, returns a positive number. If aStr1 == aStr2,
* returns 0.
*/
int localeCollationCaseSensitive8(void *aService,
int aLen1,
const void *aStr1,
int aLen2,
const void *aStr2);
/**
* Custom UTF-8 collating sequence that respects the application's locale.
* Comparison is case-insensitive and accent-sensitive. This is called by
* SQLite.
*
* @param aService
* The Service that owns the nsICollation used by this collation.
* @param aLen1
* The number of bytes in aStr1.
* @param aStr1
* The string to be compared against aStr2. It will be passed in by
* SQLite as a non-null-terminated char* buffer.
* @param aLen2
* The number of bytes in aStr2.
* @param aStr2
* The string to be compared against aStr1. It will be passed in by
* SQLite as a non-null-terminated char* buffer.
* @return aStr1 - aStr2. That is, if aStr1 < aStr2, returns a negative number.
* If aStr1 > aStr2, returns a positive number. If aStr1 == aStr2,
* returns 0.
*/
int localeCollationAccentSensitive8(void *aService,
int aLen1,
const void *aStr1,
int aLen2,
const void *aStr2);
/**
* Custom UTF-8 collating sequence that respects the application's locale.
* Comparison is case- and accent-sensitive. This is called by SQLite.
*
* @param aService
* The Service that owns the nsICollation used by this collation.
* @param aLen1
* The number of bytes in aStr1.
* @param aStr1
* The string to be compared against aStr2. It will be passed in by
* SQLite as a non-null-terminated char* buffer.
* @param aLen2
* The number of bytes in aStr2.
* @param aStr2
* The string to be compared against aStr1. It will be passed in by
* SQLite as a non-null-terminated char* buffer.
* @return aStr1 - aStr2. That is, if aStr1 < aStr2, returns a negative number.
* If aStr1 > aStr2, returns a positive number. If aStr1 == aStr2,
* returns 0.
*/
int localeCollationCaseAccentSensitive8(void *aService,
int aLen1,
const void *aStr1,
int aLen2,
const void *aStr2);
/**
* Custom UTF-16 collating sequence that respects the application's locale.
* Comparison is case- and accent-insensitive. This is called by SQLite.
*
* @param aService
* The Service that owns the nsICollation used by this collation.
* @param aLen1
* The number of bytes (not characters) in aStr1.
* @param aStr1
* The string to be compared against aStr2. It will be passed in by
* SQLite as a non-null-terminated char16_t* buffer.
* @param aLen2
* The number of bytes (not characters) in aStr2.
* @param aStr2
* The string to be compared against aStr1. It will be passed in by
* SQLite as a non-null-terminated char16_t* buffer.
* @return aStr1 - aStr2. That is, if aStr1 < aStr2, returns a negative number.
* If aStr1 > aStr2, returns a positive number. If aStr1 == aStr2,
* returns 0.
*/
int localeCollation16(void *aService,
int aLen1,
const void *aStr1,
int aLen2,
const void *aStr2);
/**
* Custom UTF-16 collating sequence that respects the application's locale.
* Comparison is case-sensitive and accent-insensitive. This is called by
* SQLite.
*
* @param aService
* The Service that owns the nsICollation used by this collation.
* @param aLen1
* The number of bytes (not characters) in aStr1.
* @param aStr1
* The string to be compared against aStr2. It will be passed in by
* SQLite as a non-null-terminated char16_t* buffer.
* @param aLen2
* The number of bytes (not characters) in aStr2.
* @param aStr2
* The string to be compared against aStr1. It will be passed in by
* SQLite as a non-null-terminated char16_t* buffer.
* @return aStr1 - aStr2. That is, if aStr1 < aStr2, returns a negative number.
* If aStr1 > aStr2, returns a positive number. If aStr1 == aStr2,
* returns 0.
*/
int localeCollationCaseSensitive16(void *aService,
int aLen1,
const void *aStr1,
int aLen2,
const void *aStr2);
/**
* Custom UTF-16 collating sequence that respects the application's locale.
* Comparison is case-insensitive and accent-sensitive. This is called by
* SQLite.
*
* @param aService
* The Service that owns the nsICollation used by this collation.
* @param aLen1
* The number of bytes (not characters) in aStr1.
* @param aStr1
* The string to be compared against aStr2. It will be passed in by
* SQLite as a non-null-terminated char16_t* buffer.
* @param aLen2
* The number of bytes (not characters) in aStr2.
* @param aStr2
* The string to be compared against aStr1. It will be passed in by
* SQLite as a non-null-terminated char16_t* buffer.
* @return aStr1 - aStr2. That is, if aStr1 < aStr2, returns a negative number.
* If aStr1 > aStr2, returns a positive number. If aStr1 == aStr2,
* returns 0.
*/
int localeCollationAccentSensitive16(void *aService,
int aLen1,
const void *aStr1,
int aLen2,
const void *aStr2);
/**
* Custom UTF-16 collating sequence that respects the application's locale.
* Comparison is case- and accent-sensitive. This is called by SQLite.
*
* @param aService
* The Service that owns the nsICollation used by this collation.
* @param aLen1
* The number of bytes (not characters) in aStr1.
* @param aStr1
* The string to be compared against aStr2. It will be passed in by
* SQLite as a non-null-terminated char16_t* buffer.
* @param aLen2
* The number of bytes (not characters) in aStr2.
* @param aStr2
* The string to be compared against aStr1. It will be passed in by
* SQLite as a non-null-terminated char16_t* buffer.
* @return aStr1 - aStr2. That is, if aStr1 < aStr2, returns a negative number.
* If aStr1 > aStr2, returns a positive number. If aStr1 == aStr2,
* returns 0.
*/
int localeCollationCaseAccentSensitive16(void *aService,
int aLen1,
const void *aStr1,
int aLen2,
const void *aStr2);
} // namespace storage
} // namespace mozilla
#endif // mozilla_storage_SQLCollations_h