storage/src/IStorageBindingParamsInternal.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  * vim: sw=2 ts=2 sts=2 expandtab
   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 mozilla.org code.
  17  *
  18  * The Initial Developer of the Original Code is the Mozilla Foundation.
  19  * Portions created by the Initial Developer are Copyright (C) 2010
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Andrew Sutherland <asutherland@asutherland.org>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #ifndef mozilla_storage_IStorageBindingParamsInternal_h_
  40 #define mozilla_storage_IStorageBindingParamsInternal_h_
  41
  42 #include "nsISupports.h"
  43
  44 struct sqlite3_stmt;
  45 class mozIStorageError;
  46
  47 namespace mozilla {
  48 namespace storage {
  49
  50 #define ISTORAGEBINDINGPARAMSINTERNAL_IID \
  51   {0x4c43d33a, 0xc620, 0x41b8, {0xba, 0x1d, 0x50, 0xc5, 0xb1, 0xe9, 0x1a, 0x04}}
  52
  53 /**
  54  * Implementation-only interface for mozIStorageBindingParams.  This defines the
  55  * set of methods required by the asynchronous execution code in order to
  56  * consume the contents stored in mozIStorageBindingParams instances.
  57  */
  58 class IStorageBindingParamsInternal : public nsISupports
  59 {
  60 public:
  61   NS_DECLARE_STATIC_IID_ACCESSOR(ISTORAGEBINDINGPARAMSINTERNAL_IID)
  62
  63   /**
  64    * Binds our stored data to the statement.
  65    *
  66    * @param aStatement
  67    *        The statement to bind our data to.
  68    * @return nsnull on success, or a mozIStorageError object if an error
  69    *         occurred.
  70    */
  71   virtual already_AddRefed<mozIStorageError> bind(sqlite3_stmt *aStatement) = 0;
  72 };
  73
  74 NS_DEFINE_STATIC_IID_ACCESSOR(IStorageBindingParamsInternal,
  75                               ISTORAGEBINDINGPARAMSINTERNAL_IID)
  76
  77 #define NS_DECL_ISTORAGEBINDINGPARAMSINTERNAL \
  78   already_AddRefed<mozIStorageError> bind(sqlite3_stmt *aStatement);
  79
  80 } // storage
  81 } // mozilla
  82
  83 #endif // mozilla_storage_IStorageBindingParamsInternal_h_