storage/src/mozStorageUnicodeFunctions.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  * vim: sw=2 ts=2 sts=2
   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 _mozStorageUnicodeFunctions_h_
  41 #define _mozStorageUnicodeFunctions_h_
  42
  43 #include "sqlite3.h"
  44 #include "nscore.h"
  45
  46 namespace StorageUnicodeFunctions {
  47
  48   /**
  49    * Registers the functions with sqlite.
  50    *
  51    * @param aDB
  52    *        The database we'll be registering the functions with.
  53    * @return the sqlite status code.
  54    */
  55   NS_HIDDEN_(int) RegisterFunctions(sqlite3 *aDB);
  56
  57   /**
  58    * Does the upper and lowercase conversions for the SQL functions upper() and
  59    * lower().
  60    *
  61    * @param p
  62    *        The sqlite_context that this function is being called on.
  63    * @param aArgc
  64    *        The number of arguments the function is being called with.
  65    * @param aArgv
  66    *        An array of the arguments the functions is being called with.
  67    */
  68   NS_HIDDEN_(void) caseFunction(sqlite3_context *p,
  69                                 int aArgc,
  70                                 sqlite3_value **aArgv);
  71
  72   /**
  73    * Performs the LIKE comparison in sqlite.
  74    *
  75    * @param p
  76    *        The sqlite_context that this function is being called on.
  77    * @param aArgc
  78    *        The number of arguments the function is being called with.
  79    * @param aArgv
  80    *        An array of the arguments the functions is being called with.
  81    */
  82   NS_HIDDEN_(void) likeFunction(sqlite3_context *p,
  83                                 int aArgc,
  84                                 sqlite3_value **aArgv);
  85 }
  86
  87 #endif // _mozStorageUnicodeFunctions_h_