1 : /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 : /* vim: set sw=2 ts=2 et tw=80: */
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.com code.
17 : *
18 : * The Initial Developer of the Original Code is
19 : * Mozilla Corporation.
20 : * Portions created by the Initial Developer are Copyright (C) 2006
21 : * the Initial Developer. All Rights Reserved.
22 : *
23 : * Contributor(s):
24 : * Johnny Stenback <jst@mozilla.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 __nsPIDOMStorage_h_
41 : #define __nsPIDOMStorage_h_
42 :
43 : #include "nsISupports.h"
44 : #include "nsTArray.h"
45 :
46 : class nsIDOMStorageObsolete;
47 : class nsIURI;
48 : class nsIPrincipal;
49 :
50 : // {BAFFCEB1-FD40-4ea9-8378-3509DD79204A}
51 : #define NS_PIDOMSTORAGE_IID \
52 : { 0xbaffceb1, 0xfd40, 0x4ea9, \
53 : { 0x83, 0x78, 0x35, 0x9, 0xdd, 0x79, 0x20, 0x4a } }
54 :
55 : class nsPIDOMStorage : public nsISupports
56 40 : {
57 : public:
58 : NS_DECLARE_STATIC_IID_ACCESSOR(NS_PIDOMSTORAGE_IID)
59 :
60 : typedef enum {
61 : Unknown = 0,
62 : LocalStorage = 1,
63 : SessionStorage = 2
64 : } nsDOMStorageType;
65 :
66 : virtual nsresult InitAsSessionStorage(nsIPrincipal *aPrincipal, const nsSubstring &aDocumentURI) = 0;
67 : virtual nsresult InitAsLocalStorage(nsIPrincipal *aPrincipal, const nsSubstring &aDocumentURI) = 0;
68 :
69 : virtual already_AddRefed<nsIDOMStorage> Clone() = 0;
70 : virtual already_AddRefed<nsIDOMStorage> Fork(const nsSubstring &aDocumentURI) = 0;
71 : virtual bool IsForkOf(nsIDOMStorage* aThat) = 0;
72 :
73 : virtual nsTArray<nsString> *GetKeys() = 0;
74 :
75 : virtual nsIPrincipal* Principal() = 0;
76 : virtual bool CanAccess(nsIPrincipal *aPrincipal) = 0;
77 :
78 : virtual nsDOMStorageType StorageType() = 0;
79 :
80 : virtual void BroadcastChangeNotification(const nsSubstring &aKey,
81 : const nsSubstring &aOldValue,
82 : const nsSubstring &aNewValue) = 0;
83 : };
84 :
85 : NS_DEFINE_STATIC_IID_ACCESSOR(nsPIDOMStorage, NS_PIDOMSTORAGE_IID)
86 :
87 : #endif // __nsPIDOMStorage_h_
|