storage/src/mozStorageSQLFunctions.h

   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  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is unicode functions code.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Mozilla Corporation.
  20  * Portions created by the Initial Developer are Copyright (C) 2007
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *   Shawn Wilsher <me@shawnwilsher.com> (Original Author)
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either the GNU General Public License Version 2 or later (the "GPL"), or
  28  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #ifndef mozStorageSQLFunctions_h
  41 #define mozStorageSQLFunctions_h
  42
  43 #include "sqlite3.h"
  44 #include "nscore.h"
  45
  46 namespace mozilla {
  47 namespace storage {
  48
  49 /**
  50  * Registers the functions declared here with the specified database.
  51  *
  52  * @param aDB
  53  *        The database we'll be registering the functions with.
  54  * @return the SQLite status code indicating success or failure.
  55  */
  56 NS_HIDDEN_(int) registerFunctions(sqlite3 *aDB);
  57
  58 ////////////////////////////////////////////////////////////////////////////////
  59 //// Predefined Functions
  60
  61 /**
  62  * Overridden function to perform the SQL functions UPPER and LOWER.  These
  63  * support unicode, which the default implementations do not do.
  64  *
  65  * @param aCtx
  66  *        The sqlite_context that this function is being called on.
  67  * @param aArgc
  68  *        The number of arguments the function is being called with.
  69  * @param aArgv
  70  *        An array of the arguments the functions is being called with.
  71  */
  72 NS_HIDDEN_(void) caseFunction(sqlite3_context *aCtx,
  73                               int aArgc,
  74                               sqlite3_value **aArgv);
  75
  76 /**
  77  * Overridden function to perform the SQL function LIKE.  This supports unicode,
  78  * which the default implementation does not do.
  79  *
  80  * @param aCtx
  81  *        The sqlite_context that this function is being called on.
  82  * @param aArgc
  83  *        The number of arguments the function is being called with.
  84  * @param aArgv
  85  *        An array of the arguments the functions is being called with.
  86  */
  87 NS_HIDDEN_(void) likeFunction(sqlite3_context *aCtx,
  88                               int aArgc,
  89                               sqlite3_value **aArgv);
  90
  91 /**
  92  * An implementation of the Levenshtein Edit Distance algorithm for use in
  93  * Sqlite queries.
  94  *
  95  * @param aCtx
  96  *        The sqlite_context that this function is being called on.
  97  * @param aArgc
  98  *        The number of arguments the function is being called with.
  99  * @param aArgv
 100  *        An array of the arguments the functions is being called with.
 101  */
 102 NS_HIDDEN_(void) levenshteinDistanceFunction(sqlite3_context *aCtx,
 103                                              int aArgc,
 104                                              sqlite3_value **aArgv);
 105
 106 } // namespace storage
 107 } // namespace mozilla
 108
 109 #endif // mozStorageSQLFunctions_h