Trying again to land support for content node properties (bug 253888). r=jst, sr=dbaron.

git-svn-id: svn://10.0.0.236/trunk@161182 18797224-902f-48f8-a5cc-f745e15eee43

mozilla/content/base/src/nsPropertyTable.h

@@ -0,0 +1,138 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
+ * vim:cindent:ts=2:et:sw=2:
+ *
+ * ***** BEGIN LICENSE BLOCK *****
+ * Version: MPL 1.1/GPL 2.0/LGPL 2.1
+ *
+ * The contents of this file are subject to the Mozilla Public License Version
+ * 1.1 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ * http://www.mozilla.org/MPL/
+ *
+ * Software distributed under the License is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+ * for the specific language governing rights and limitations under the
+ * License.
+ *
+ * The Original Code is mozilla.org code.
+ *
+ * The Initial Developer of the Original Code is
+ * Netscape Communications Corporation.
+ * Portions created by the Initial Developer are Copyright (C) 1998
+ * the Initial Developer. All Rights Reserved.
+ *
+ * Contributor(s):
+ *
+ * Alternatively, the contents of this file may be used under the terms of
+ * either of the GNU General Public License Version 2 or later (the "GPL"),
+ * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
+ * in which case the provisions of the GPL or the LGPL are applicable instead
+ * of those above. If you wish to allow use of your version of this file only
+ * under the terms of either the GPL or the LGPL, and not to allow others to
+ * use your version of this file under the terms of the MPL, indicate your
+ * decision by deleting the provisions above and replace them with the notice
+ * and other provisions required by the GPL or the LGPL. If you do not delete
+ * the provisions above, a recipient may use your version of this file under
+ * the terms of any one of the MPL, the GPL or the LGPL.
+ *
+ * ***** END LICENSE BLOCK *****
+ *
+ * This Original Code has been modified by IBM Corporation. Modifications made by IBM 
+ * described herein are Copyright (c) International Business Machines Corporation, 2000.
+ * Modifications to Mozilla code or documentation identified per MPL Section 3.3
+ *
+ * Date             Modified by     Description of modification
+ * 04/20/2000       IBM Corp.      OS/2 VisualAge build.
+ */
+
+/**
+ * nsPropertyTable allows a set of arbitrary key/value pairs to be stored
+ * for any number of nodes, in a global hashtable rather than on the nodes
+ * themselves.  Nodes can be any type of object; the hashtable keys are
+ * nsIAtom pointers, and the values are void pointers.
+ */
+
+#ifndef nsPropertyTable_h_
+#define nsPropertyTable_h_
+
+#include "nscore.h"
+
+class nsIAtom;
+
+/**
+ * Callback type for property destructors.  |aObject| is the object
+ * the property is being removed for, |aPropertyName| is the property
+ * being removed, |aPropertyValue| is the value of the property, and |aData|
+ * is the opaque destructor data that was passed to SetProperty().
+ **/
+typedef void
+(*NSPropertyDtorFunc)(void           *aObject,
+                      nsIAtom        *aPropertyName,
+                      void           *aPropertyValue,
+                      void           *aData);
+
+class nsPropertyTable
+{
+ public:
+  /**
+   * Get the value of the property |aPropertyName| for node |aObject|.
+   * |aResult|, if supplied, is filled in with a return status code.
+   **/
+  void* GetProperty(const void *aObject,
+                    nsIAtom    *aPropertyName,
+                    nsresult   *aResult = nsnull)
+  { return GetPropertyInternal(aObject, aPropertyName, PR_FALSE, aResult); }
+
+  /**
+   * Set the value of the property |aPropertyName| to |aPropertyValue|
+   * for node |aObject|.  |aDtor| is a destructor for the property value
+   * to be called if the property is removed.  It can be null if no
+   * destructor is required.  |aDtorData| is an optional opaque context to
+   * be passed to the property destructor.  Note that the destructor is
+   * global for each property name regardless of node; it is an error
+   * to set a given property with a different destructor than was used before
+   * (this will return NS_ERROR_INVALID_ARG).
+   **/
+  NS_HIDDEN_(nsresult) SetProperty(const void         *aObject,
+                                   nsIAtom            *aPropertyName,
+                                   void               *aPropertyValue,
+                                   NSPropertyDtorFunc  aDtor,
+                                   void               *aDtorData);
+
+  /**
+   * Delete the property |aPropertyName| for object |aObject|.
+   * The property's destructor function will be called.
+   **/
+  NS_HIDDEN_(nsresult) DeleteProperty(const void *aObject,
+                                      nsIAtom    *aPropertyName);
+
+  /**
+   * Unset the property |aPropertyName| for object |aObject|, but do not
+   * call the property's destructor function.  The property value is returned.
+   **/
+  void* UnsetProperty(const void *aObject,
+                      nsIAtom    *aPropertyName,
+                      nsresult   *aStatus = nsnull)
+  { return GetPropertyInternal(aObject, aPropertyName, PR_TRUE, aStatus); }
+
+  /**
+   * Deletes all of the properties for object |aObject|, calling the
+   * destructor function for each property.
+   **/
+  NS_HIDDEN_(void) DeleteAllPropertiesFor(const void *aObject);
+
+  ~nsPropertyTable() NS_HIDDEN;
+
+  struct PropertyList;
+
+ private:
+  NS_HIDDEN_(void) DestroyPropertyList();
+  NS_HIDDEN_(PropertyList*) GetPropertyListFor(nsIAtom *aPropertyName) const;
+  NS_HIDDEN_(void*) GetPropertyInternal(const void *aObject,
+                                        nsIAtom    *aPropertyName,
+                                        PRBool      aRemove,
+                                        nsresult   *aStatus);
+
+  PropertyList *mPropertyList;
+};
+#endif