2001-09-25 01:32:19 +00:00
|
|
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
|
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
2004-04-17 21:52:36 +00:00
|
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
2000-05-08 14:29:44 +00:00
|
|
|
*
|
2004-04-17 21:52:36 +00:00
|
|
|
* 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/
|
2000-05-08 14:29:44 +00:00
|
|
|
*
|
2001-09-25 01:32:19 +00:00
|
|
|
* 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.
|
2000-05-08 14:29:44 +00:00
|
|
|
*
|
|
|
|
|
* The Original Code is Mozilla Communicator client code.
|
|
|
|
|
*
|
2004-04-17 21:52:36 +00:00
|
|
|
* The Initial Developer of the Original Code is
|
2001-09-25 01:32:19 +00:00
|
|
|
* Netscape Communications Corporation.
|
|
|
|
|
* Portions created by the Initial Developer are Copyright (C) 1998
|
|
|
|
|
* the Initial Developer. All Rights Reserved.
|
2000-05-08 14:29:44 +00:00
|
|
|
*
|
2001-09-25 01:32:19 +00:00
|
|
|
* Contributor(s):
|
|
|
|
|
*
|
|
|
|
|
* Alternatively, the contents of this file may be used under the terms of
|
2004-04-17 21:52:36 +00:00
|
|
|
* 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"),
|
2001-09-25 01:32:19 +00:00
|
|
|
* 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
|
2004-04-17 21:52:36 +00:00
|
|
|
* use your version of this file under the terms of the MPL, indicate your
|
2001-09-25 01:32:19 +00:00
|
|
|
* 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
|
2004-04-17 21:52:36 +00:00
|
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
2001-09-25 01:32:19 +00:00
|
|
|
*
|
|
|
|
|
* ***** END LICENSE BLOCK ***** */
|
2000-05-08 14:29:44 +00:00
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* nsINodeInfo is an interface to node info, such as name, prefix, namespace
|
2000-08-30 00:35:43 +00:00
|
|
|
* ID and possibly other data that is shared between nodes (elements
|
2000-05-08 14:29:44 +00:00
|
|
|
* and attributes) that have the same name, prefix and namespace ID within
|
|
|
|
|
* the same document.
|
|
|
|
|
*
|
2004-06-25 12:26:02 +00:00
|
|
|
* nsNodeInfoManager's are internal objects that manage a list of
|
2000-05-08 14:29:44 +00:00
|
|
|
* nsINodeInfo's, every document object should hold a strong reference to
|
2004-06-25 12:26:02 +00:00
|
|
|
* a nsNodeInfoManager and every nsINodeInfo also holds a strong reference
|
2000-05-08 14:29:44 +00:00
|
|
|
* to their owning manager. When a nsINodeInfo is no longer used it will
|
|
|
|
|
* automatically remove itself from its owner manager, and when all
|
2004-06-25 12:26:02 +00:00
|
|
|
* nsINodeInfo's have been removed from a nsNodeInfoManager and all external
|
|
|
|
|
* references are released the nsNodeInfoManager deletes itself.
|
2000-05-08 14:29:44 +00:00
|
|
|
*
|
|
|
|
|
* -- jst@netscape.com
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifndef nsINodeInfo_h___
|
|
|
|
|
#define nsINodeInfo_h___
|
|
|
|
|
|
|
|
|
|
#include "nsISupports.h"
|
2002-01-03 04:51:02 +00:00
|
|
|
#include "nsIAtom.h"
|
2004-04-01 19:44:17 +00:00
|
|
|
#include "nsDOMString.h"
|
2002-01-03 04:51:02 +00:00
|
|
|
#include "nsINameSpaceManager.h"
|
2003-11-15 05:27:37 +00:00
|
|
|
#include "nsCOMPtr.h"
|
2005-09-24 18:43:15 +00:00
|
|
|
#include "nsNodeInfoManager.h"
|
2000-05-08 14:29:44 +00:00
|
|
|
|
|
|
|
|
// Forward declarations
|
Landing the XPCDOM_20010329_BRANCH branch, changes mostly done by jband@netscape.com and jst@netscape.com, also some changes done by shaver@mozilla.org, peterv@netscape.com and markh@activestate.com. r= and sr= by vidur@netscape.com, jband@netscape.com, jst@netscpae.com, danm@netscape.com, hyatt@netscape.com, shaver@mozilla.org, dbradley@netscape.com, rpotts@netscape.com.
2001-05-08 16:46:42 +00:00
|
|
|
class nsIDocument;
|
2002-07-23 22:16:45 +00:00
|
|
|
class nsIURI;
|
2002-07-30 21:26:32 +00:00
|
|
|
class nsIPrincipal;
|
2000-05-08 14:29:44 +00:00
|
|
|
|
|
|
|
|
// IID for the nsINodeInfo interface
|
2005-09-24 18:43:15 +00:00
|
|
|
// b24fd4ad-7d94-40ea-b09b-9262f58bc28a
|
2004-06-25 12:26:02 +00:00
|
|
|
#define NS_INODEINFO_IID \
|
2005-09-24 18:43:15 +00:00
|
|
|
{ 0xb24fd4ad, 0x7d94, 0x40ea, \
|
|
|
|
|
{ 0xb0, 0x9b, 0x92, 0x62, 0xf5, 0x8b, 0xc2, 0x8a } }
|
2003-11-15 05:27:37 +00:00
|
|
|
|
2000-05-08 14:29:44 +00:00
|
|
|
class nsINodeInfo : public nsISupports
|
|
|
|
|
{
|
|
|
|
|
public:
|
2005-11-11 14:36:26 +00:00
|
|
|
NS_DECLARE_STATIC_IID_ACCESSOR(NS_INODEINFO_IID)
|
2000-05-08 14:29:44 +00:00
|
|
|
|
2002-01-03 04:51:02 +00:00
|
|
|
nsINodeInfo()
|
2003-11-15 05:27:37 +00:00
|
|
|
: mInner(nsnull, nsnull, kNameSpaceID_None),
|
|
|
|
|
mOwnerManager(nsnull)
|
2002-01-03 04:51:02 +00:00
|
|
|
{
|
|
|
|
|
}
|
|
|
|
|
|
2000-05-08 14:29:44 +00:00
|
|
|
/*
|
|
|
|
|
* Get the name from this node as a string, this does not include the prefix.
|
|
|
|
|
*
|
|
|
|
|
* For the HTML element "<body>" this will return "body" and for the XML
|
|
|
|
|
* element "<html:body>" this will return "body".
|
|
|
|
|
*/
|
2003-11-15 05:27:37 +00:00
|
|
|
void GetName(nsAString& aName) const
|
2002-01-03 04:51:02 +00:00
|
|
|
{
|
|
|
|
|
mInner.mName->ToString(aName);
|
|
|
|
|
}
|
2000-05-08 14:29:44 +00:00
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Get the name from this node as an atom, this does not include the prefix.
|
|
|
|
|
* This function never returns a null atom.
|
|
|
|
|
*
|
|
|
|
|
* For the HTML element "<body>" this will return the "body" atom and for
|
|
|
|
|
* the XML element "<html:body>" this will return the "body" atom.
|
|
|
|
|
*/
|
2003-11-15 05:27:37 +00:00
|
|
|
nsIAtom* NameAtom() const
|
2002-01-03 04:51:02 +00:00
|
|
|
{
|
2003-06-13 20:10:01 +00:00
|
|
|
return mInner.mName;
|
2002-01-03 04:51:02 +00:00
|
|
|
}
|
2000-05-08 14:29:44 +00:00
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Get the qualified name from this node as a string, the qualified name
|
|
|
|
|
* includes the prefix, if one exists.
|
|
|
|
|
*
|
|
|
|
|
* For the HTML element "<body>" this will return "body" and for the XML
|
|
|
|
|
* element "<html:body>" this will return "html:body".
|
|
|
|
|
*/
|
2003-11-15 05:27:37 +00:00
|
|
|
virtual void GetQualifiedName(nsAString& aQualifiedName) const = 0;
|
2000-05-08 14:29:44 +00:00
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Get the local name from this node as a string, GetLocalName() gets the
|
|
|
|
|
* same string as GetName() but only if the node has a prefix and/or a
|
|
|
|
|
* namespace URI. If the node has neither a prefix nor a namespace URI the
|
|
|
|
|
* local name is a null string.
|
|
|
|
|
*
|
|
|
|
|
* For the HTML element "<body>" in a HTML document this will return a null
|
|
|
|
|
* string and for the XML element "<html:body>" this will return "body".
|
|
|
|
|
*/
|
2003-11-15 05:27:37 +00:00
|
|
|
virtual void GetLocalName(nsAString& aLocalName) const = 0;
|
2000-05-08 14:29:44 +00:00
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Get the prefix from this node as a string.
|
|
|
|
|
*
|
|
|
|
|
* For the HTML element "<body>" this will return a null string and for
|
|
|
|
|
* the XML element "<html:body>" this will return the string "html".
|
|
|
|
|
*/
|
2003-11-15 05:27:37 +00:00
|
|
|
void GetPrefix(nsAString& aPrefix) const
|
2002-01-03 04:51:02 +00:00
|
|
|
{
|
|
|
|
|
if (mInner.mPrefix) {
|
|
|
|
|
mInner.mPrefix->ToString(aPrefix);
|
|
|
|
|
} else {
|
|
|
|
|
SetDOMStringToNull(aPrefix);
|
|
|
|
|
}
|
|
|
|
|
}
|
2000-05-08 14:29:44 +00:00
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Get the prefix from this node as an atom.
|
|
|
|
|
*
|
|
|
|
|
* For the HTML element "<body>" this will return a null atom and for
|
|
|
|
|
* the XML element "<html:body>" this will return the "html" atom.
|
|
|
|
|
*/
|
2003-11-15 05:27:37 +00:00
|
|
|
nsIAtom* GetPrefixAtom() const
|
2002-01-03 04:51:02 +00:00
|
|
|
{
|
2003-06-13 20:10:01 +00:00
|
|
|
return mInner.mPrefix;
|
2002-01-03 04:51:02 +00:00
|
|
|
}
|
2000-05-08 14:29:44 +00:00
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Get the namespace URI for a node, if the node has a namespace URI.
|
|
|
|
|
*
|
|
|
|
|
* For the HTML element "<body>" in a HTML document this will return a null
|
|
|
|
|
* string and for the XML element "<html:body>" (assuming that this element,
|
|
|
|
|
* or one of it's ancestors has an
|
2000-06-15 09:54:41 +00:00
|
|
|
* xmlns:html='http://www.w3.org/1999/xhtml' attribute) this will return
|
|
|
|
|
* the string "http://www.w3.org/1999/xhtml".
|
2000-05-08 14:29:44 +00:00
|
|
|
*/
|
2003-11-15 05:27:37 +00:00
|
|
|
virtual nsresult GetNamespaceURI(nsAString& aNameSpaceURI) const = 0;
|
2000-05-08 14:29:44 +00:00
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Get the namespace ID for a node if the node has a namespace, if not this
|
|
|
|
|
* returns kNameSpaceID_None.
|
|
|
|
|
*
|
|
|
|
|
* For the HTML element "<body>" in a HTML document this will return
|
|
|
|
|
* kNameSpaceID_None and for the XML element "<html:body>" (assuming that
|
|
|
|
|
* this element, or one of it's ancestors has an
|
2000-06-15 09:54:41 +00:00
|
|
|
* xmlns:html='http://www.w3.org/1999/xhtml' attribute) this will return
|
|
|
|
|
* the namespace ID for "http://www.w3.org/1999/xhtml".
|
2000-05-08 14:29:44 +00:00
|
|
|
*/
|
2003-11-15 05:27:37 +00:00
|
|
|
PRInt32 NamespaceID() const
|
2002-01-03 04:51:02 +00:00
|
|
|
{
|
2003-06-13 20:10:01 +00:00
|
|
|
return mInner.mNamespaceID;
|
2002-01-03 04:51:02 +00:00
|
|
|
}
|
2000-05-08 14:29:44 +00:00
|
|
|
|
2000-08-30 00:35:43 +00:00
|
|
|
/*
|
2002-01-03 04:51:02 +00:00
|
|
|
* Get and set the ID attribute atom for this node.
|
2000-08-30 00:35:43 +00:00
|
|
|
* See http://www.w3.org/TR/1998/REC-xml-19980210#sec-attribute-types
|
|
|
|
|
* for the definition of an ID attribute.
|
|
|
|
|
*
|
|
|
|
|
*/
|
2003-11-15 05:27:37 +00:00
|
|
|
nsIAtom* GetIDAttributeAtom() const
|
|
|
|
|
{
|
|
|
|
|
return mIDAttributeAtom;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
void SetIDAttributeAtom(nsIAtom* aID)
|
|
|
|
|
{
|
|
|
|
|
mIDAttributeAtom = aID;
|
|
|
|
|
}
|
2000-08-30 00:35:43 +00:00
|
|
|
|
2004-06-25 12:26:02 +00:00
|
|
|
/**
|
|
|
|
|
* Get the owning node info manager. Only to be used inside Gecko, you can't
|
|
|
|
|
* really do anything with the pointer outside Gecko anyway.
|
2000-05-08 14:29:44 +00:00
|
|
|
*/
|
2004-06-25 12:26:02 +00:00
|
|
|
nsNodeInfoManager *NodeInfoManager() const
|
2003-11-15 05:27:37 +00:00
|
|
|
{
|
|
|
|
|
return mOwnerManager;
|
|
|
|
|
}
|
2000-05-08 14:29:44 +00:00
|
|
|
|
|
|
|
|
/*
|
2000-08-30 00:35:43 +00:00
|
|
|
* Utility functions that can be used to check if a nodeinfo holds a specific
|
2000-05-08 14:29:44 +00:00
|
|
|
* name, name and prefix, name and prefix and namespace ID, or just
|
|
|
|
|
* namespace ID.
|
|
|
|
|
*/
|
2002-01-03 04:51:02 +00:00
|
|
|
PRBool Equals(nsINodeInfo *aNodeInfo) const
|
|
|
|
|
{
|
|
|
|
|
return aNodeInfo == this || aNodeInfo->Equals(mInner.mName, mInner.mPrefix,
|
|
|
|
|
mInner.mNamespaceID);
|
|
|
|
|
}
|
|
|
|
|
|
2002-03-27 00:13:57 +00:00
|
|
|
PRBool NameAndNamespaceEquals(nsINodeInfo *aNodeInfo) const
|
|
|
|
|
{
|
|
|
|
|
return aNodeInfo == this || aNodeInfo->Equals(mInner.mName,
|
|
|
|
|
mInner.mNamespaceID);
|
|
|
|
|
}
|
|
|
|
|
|
2002-01-03 04:51:02 +00:00
|
|
|
PRBool Equals(nsIAtom *aNameAtom) const
|
|
|
|
|
{
|
|
|
|
|
return mInner.mName == aNameAtom;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
PRBool Equals(nsIAtom *aNameAtom, nsIAtom *aPrefixAtom) const
|
|
|
|
|
{
|
|
|
|
|
return (mInner.mName == aNameAtom) && (mInner.mPrefix == aPrefixAtom);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
PRBool Equals(nsIAtom *aNameAtom, PRInt32 aNamespaceID) const
|
|
|
|
|
{
|
|
|
|
|
return ((mInner.mName == aNameAtom) &&
|
|
|
|
|
(mInner.mNamespaceID == aNamespaceID));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
PRBool Equals(nsIAtom *aNameAtom, nsIAtom *aPrefixAtom,
|
2004-06-25 12:26:02 +00:00
|
|
|
PRInt32 aNamespaceID) const
|
2002-01-03 04:51:02 +00:00
|
|
|
{
|
|
|
|
|
return ((mInner.mName == aNameAtom) &&
|
|
|
|
|
(mInner.mPrefix == aPrefixAtom) &&
|
|
|
|
|
(mInner.mNamespaceID == aNamespaceID));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
PRBool NamespaceEquals(PRInt32 aNamespaceID) const
|
|
|
|
|
{
|
|
|
|
|
return mInner.mNamespaceID == aNamespaceID;
|
|
|
|
|
}
|
|
|
|
|
|
2003-11-15 05:27:37 +00:00
|
|
|
virtual PRBool Equals(const nsAString& aName) const = 0;
|
|
|
|
|
virtual PRBool Equals(const nsAString& aName,
|
|
|
|
|
const nsAString& aPrefix) const = 0;
|
|
|
|
|
virtual PRBool Equals(const nsAString& aName,
|
|
|
|
|
PRInt32 aNamespaceID) const = 0;
|
|
|
|
|
virtual PRBool Equals(const nsAString& aName, const nsAString& aPrefix,
|
|
|
|
|
PRInt32 aNamespaceID) const = 0;
|
|
|
|
|
virtual PRBool NamespaceEquals(const nsAString& aNamespaceURI) const = 0;
|
2003-03-25 18:55:59 +00:00
|
|
|
// switch to UTF8 - this allows faster access for consumers
|
2003-11-15 05:27:37 +00:00
|
|
|
virtual PRBool QualifiedNameEquals(const nsACString& aQualifiedName) const = 0;
|
2000-05-08 14:29:44 +00:00
|
|
|
|
Landing the XPCDOM_20010329_BRANCH branch, changes mostly done by jband@netscape.com and jst@netscape.com, also some changes done by shaver@mozilla.org, peterv@netscape.com and markh@activestate.com. r= and sr= by vidur@netscape.com, jband@netscape.com, jst@netscpae.com, danm@netscape.com, hyatt@netscape.com, shaver@mozilla.org, dbradley@netscape.com, rpotts@netscape.com.
2001-05-08 16:46:42 +00:00
|
|
|
/*
|
|
|
|
|
* Retrieve a pointer to the document that owns this node info.
|
|
|
|
|
*/
|
2005-09-24 18:43:15 +00:00
|
|
|
nsIDocument* GetDocument() const
|
|
|
|
|
{
|
|
|
|
|
return mOwnerManager->GetDocument();
|
|
|
|
|
}
|
2002-01-03 04:51:02 +00:00
|
|
|
|
2002-07-30 21:26:32 +00:00
|
|
|
/*
|
|
|
|
|
* Retrieve a pointer to the principal for the document of this node info.
|
|
|
|
|
*/
|
2004-06-25 12:26:02 +00:00
|
|
|
virtual nsIPrincipal *GetDocumentPrincipal() const = 0;
|
2002-07-30 21:26:32 +00:00
|
|
|
|
2002-01-03 04:51:02 +00:00
|
|
|
protected:
|
|
|
|
|
/*
|
|
|
|
|
* nsNodeInfoInner is used for two things:
|
|
|
|
|
*
|
|
|
|
|
* 1. as a member in nsNodeInfo for holding the name, prefix and
|
|
|
|
|
* namespace ID
|
|
|
|
|
* 2. as the hash key in the hash table in nsNodeInfoManager
|
|
|
|
|
*
|
|
|
|
|
* nsNodeInfoInner does not do any kind of reference counting,
|
|
|
|
|
* that's up to the user of this class. Since nsNodeInfoInner is
|
|
|
|
|
* typically used as a member of nsNodeInfo, the hash table doesn't
|
|
|
|
|
* need to delete the keys. When the value (nsNodeInfo) is deleted
|
|
|
|
|
* the key is automatically deleted.
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
class nsNodeInfoInner
|
|
|
|
|
{
|
|
|
|
|
public:
|
|
|
|
|
nsNodeInfoInner(nsIAtom *aName, nsIAtom *aPrefix, PRInt32 aNamespaceID)
|
|
|
|
|
: mName(aName), mPrefix(aPrefix), mNamespaceID(aNamespaceID)
|
|
|
|
|
{
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
nsIAtom* mName;
|
|
|
|
|
nsIAtom* mPrefix;
|
|
|
|
|
PRInt32 mNamespaceID;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
// nsNodeInfoManager needs to pass mInner to the hash table.
|
|
|
|
|
friend class nsNodeInfoManager;
|
|
|
|
|
|
|
|
|
|
nsNodeInfoInner mInner;
|
2000-05-08 14:29:44 +00:00
|
|
|
|
2003-11-15 05:27:37 +00:00
|
|
|
nsCOMPtr<nsIAtom> mIDAttributeAtom;
|
2004-06-25 12:26:02 +00:00
|
|
|
nsNodeInfoManager* mOwnerManager; // Strong reference!
|
2000-05-08 14:29:44 +00:00
|
|
|
};
|
|
|
|
|
|
2005-11-11 14:36:26 +00:00
|
|
|
NS_DEFINE_STATIC_IID_ACCESSOR(nsINodeInfo, NS_INODEINFO_IID)
|
|
|
|
|
|
2000-05-08 14:29:44 +00:00
|
|
|
#endif /* nsINodeInfo_h___ */
|
