2007-08-10 16:19:57 +00:00
|
|
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
2009-04-13 16:29:41 +00:00
|
|
|
* vim: sw=2 ts=2 et lcs=trail\:.,tab\:>~ :
|
2007-08-10 16:19:57 +00: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 unicode functions code.
|
|
|
|
*
|
|
|
|
* The Initial Developer of the Original Code is
|
2009-04-20 14:59:52 +00:00
|
|
|
* Mozilla Corporation.
|
2007-08-10 16:19:57 +00:00
|
|
|
* Portions created by the Initial Developer are Copyright (C) 2007
|
|
|
|
* the Initial Developer. All Rights Reserved.
|
|
|
|
*
|
|
|
|
* Contributor(s):
|
|
|
|
* Shawn Wilsher <me@shawnwilsher.com> (Original Author)
|
|
|
|
*
|
|
|
|
* 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-04-20 14:59:52 +00:00
|
|
|
#ifndef _mozStorageSQLFunctions_h_
|
2009-07-15 17:49:05 +00:00
|
|
|
#define _mozStorageSQLFunctions_h_
|
2007-08-10 16:19:57 +00:00
|
|
|
|
|
|
|
#include "sqlite3.h"
|
|
|
|
#include "nscore.h"
|
|
|
|
|
2009-04-20 14:59:52 +00:00
|
|
|
namespace mozilla {
|
|
|
|
namespace storage {
|
2007-08-10 16:19:57 +00:00
|
|
|
|
2009-04-20 14:59:52 +00:00
|
|
|
/**
|
|
|
|
* Registers the functions declared here with the specified database.
|
|
|
|
*
|
|
|
|
* @param aDB
|
|
|
|
* The database we'll be registering the functions with.
|
|
|
|
* @return the SQLite status code indicating success or failure.
|
|
|
|
*/
|
|
|
|
NS_HIDDEN_(int) registerFunctions(sqlite3 *aDB);
|
|
|
|
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
//// Predefined Functions
|
2007-08-10 16:19:57 +00:00
|
|
|
|
2009-04-20 14:59:52 +00:00
|
|
|
/**
|
|
|
|
* Overridden function to perform the SQL functions UPPER and LOWER. These
|
|
|
|
* support unicode, which the default implementations do not do.
|
|
|
|
*
|
|
|
|
* @param aCtx
|
|
|
|
* The sqlite_context that this function is being called on.
|
|
|
|
* @param aArgc
|
|
|
|
* The number of arguments the function is being called with.
|
|
|
|
* @param aArgv
|
|
|
|
* An array of the arguments the functions is being called with.
|
|
|
|
*/
|
|
|
|
NS_HIDDEN_(void) caseFunction(sqlite3_context *aCtx,
|
|
|
|
int aArgc,
|
|
|
|
sqlite3_value **aArgv);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Overridden function to perform the SQL function LIKE. This supports unicode,
|
|
|
|
* which the default implementation does not do.
|
|
|
|
*
|
|
|
|
* @param aCtx
|
|
|
|
* The sqlite_context that this function is being called on.
|
|
|
|
* @param aArgc
|
|
|
|
* The number of arguments the function is being called with.
|
|
|
|
* @param aArgv
|
|
|
|
* An array of the arguments the functions is being called with.
|
|
|
|
*/
|
|
|
|
NS_HIDDEN_(void) likeFunction(sqlite3_context *aCtx,
|
|
|
|
int aArgc,
|
|
|
|
sqlite3_value **aArgv);
|
2007-08-10 16:19:57 +00:00
|
|
|
|
2009-07-24 15:39:34 +00:00
|
|
|
/**
|
|
|
|
* An implementation of the Levenshtein Edit Distance algorithm for use in
|
|
|
|
* Sqlite queries.
|
|
|
|
*
|
|
|
|
* @param aCtx
|
|
|
|
* The sqlite_context that this function is being called on.
|
|
|
|
* @param aArgc
|
|
|
|
* The number of arguments the function is being called with.
|
|
|
|
* @param aArgv
|
|
|
|
* An array of the arguments the functions is being called with.
|
|
|
|
*/
|
|
|
|
NS_HIDDEN_(void) levenshteinDistanceFunction(sqlite3_context *aCtx,
|
|
|
|
int aArgc,
|
|
|
|
sqlite3_value **aArgv);
|
|
|
|
|
2009-04-20 14:59:52 +00:00
|
|
|
} // namespace storage
|
|
|
|
} // namespace mozilla
|
2007-08-10 16:19:57 +00:00
|
|
|
|
2009-04-20 14:59:52 +00:00
|
|
|
#endif // _mozStorageSQLFunctions_h_
|