xpcom/ds/nsHashPropertyBag.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is Oracle Corporation code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  *  Oracle Corporation
  19  * Portions created by the Initial Developer are Copyright (C) 2004
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Vladimir Vukicevic <vladimir.vukicevic@oracle.com>
  24  *   Christian Biesinger <cbiesinger@web.de>
  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 nsHashPropertyBag_h___
  41 #define nsHashPropertyBag_h___
  42
  43 #include "nsCOMPtr.h"
  44 #include "nsCOMArray.h"
  45 #include "nsVoidArray.h"
  46
  47 #include "nsIVariant.h"
  48 #include "nsIWritablePropertyBag.h"
  49 #include "nsIWritablePropertyBag2.h"
  50 #include "nsInterfaceHashtable.h"
  51
  52 // Set IMETHOD_VISIBILITY to empty so that the class-level NS_COM declaration
  53 // controls member method visibility.
  54 #undef  IMETHOD_VISIBILITY
  55 #define IMETHOD_VISIBILITY
  56
  57 class NS_COM nsHashPropertyBag : public nsIWritablePropertyBag
  58                                , public nsIWritablePropertyBag2
  59 {
  60 public:
  61     nsHashPropertyBag() { }
  62     virtual ~nsHashPropertyBag() {}
  63
  64     nsresult Init();
  65
  66     NS_DECL_ISUPPORTS
  67
  68     NS_DECL_NSIPROPERTYBAG
  69
  70     NS_DECL_NSIPROPERTYBAG2
  71
  72     NS_DECL_NSIWRITABLEPROPERTYBAG
  73
  74     NS_DECL_NSIWRITABLEPROPERTYBAG2
  75
  76 protected:
  77     // a hash table of string -> nsIVariant
  78     nsInterfaceHashtable<nsStringHashKey, nsIVariant> mPropertyHash;
  79 };
  80
  81 #undef  IMETHOD_VISIBILITY
  82 #define IMETHOD_VISIBILITY NS_VISIBILITY_HIDDEN
  83
  84 // Note: NS_NewHashPropertyBag returns a HPB that
  85 // uses a non-thread-safe internal hash
  86 extern "C" NS_COM nsresult
  87 NS_NewHashPropertyBag(nsIWritablePropertyBag* *_retval);
  88
  89 #endif /* nsHashPropertyBag_h___ */