/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */

/* vim: set ts=8 sts=2 et sw=2 tw=80: */

/* This Source Code Form is subject to the terms of the Mozilla Public

 * License, v. 2.0. If a copy of the MPL was not distributed with this

 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

/*

 * A class for handing out nodeinfos and ensuring sharing of them as needed.

 */

#ifndef nsNodeInfoManager_h___

#define nsNodeInfoManager_h___

#include "mozilla/Attributes.h"           // for final

#include "mozilla/dom/NodeInfo.h"

#include "mozilla/MruCache.h"

#include "nsCOMPtr.h"                     // for member

#include "nsCycleCollectionParticipant.h" // for NS_DECL_CYCLE_*

#include "nsDataHashtable.h"

#include "nsStringFwd.h"

class nsBindingManager;

class nsAtom;

class nsIDocument;

class nsIPrincipal;

class nsWindowSizes;

template<class T> struct already_AddRefed;

class nsNodeInfoManager final

{

private:

  ~nsNodeInfoManager();

public:

  nsNodeInfoManager();

  NS_DECL_CYCLE_COLLECTION_SKIPPABLE_NATIVE_CLASS(nsNodeInfoManager)

  NS_INLINE_DECL_CYCLE_COLLECTING_NATIVE_REFCOUNTING(nsNodeInfoManager)

  /**

   * Initialize the nodeinfo manager with a document.

   */

  nsresult Init(nsIDocument *aDocument);

  /**

   * Release the reference to the document, this will be called when

   * the document is going away.

   */

  void DropDocumentReference();

  /**

   * Methods for creating nodeinfo's from atoms and/or strings.

   */

  already_AddRefed<mozilla::dom::NodeInfo>

  GetNodeInfo(nsAtom *aName, nsAtom *aPrefix, int32_t aNamespaceID,

              uint16_t aNodeType, nsAtom* aExtraName = nullptr);

  nsresult GetNodeInfo(const nsAString& aName, nsAtom *aPrefix,

                       int32_t aNamespaceID, uint16_t aNodeType,

                       mozilla::dom::NodeInfo** aNodeInfo);

  nsresult GetNodeInfo(const nsAString& aName, nsAtom *aPrefix,

                       const nsAString& aNamespaceURI, uint16_t aNodeType,

                       mozilla::dom::NodeInfo** aNodeInfo);

  /**

   * Returns the nodeinfo for text nodes. Can return null if OOM.

   */

  already_AddRefed<mozilla::dom::NodeInfo> GetTextNodeInfo();

  /**

   * Returns the nodeinfo for comment nodes. Can return null if OOM.

   */

  already_AddRefed<mozilla::dom::NodeInfo> GetCommentNodeInfo();

  /**

   * Returns the nodeinfo for the document node. Can return null if OOM.

   */

  already_AddRefed<mozilla::dom::NodeInfo> GetDocumentNodeInfo();

  /**

   * Retrieve a pointer to the document that owns this node info

   * manager.

   */

  nsIDocument* GetDocument() const

  {

    return mDocument;

  }

  /**

   * Gets the principal of the document this nodeinfo manager belongs to.

   */

  nsIPrincipal *DocumentPrincipal() const {

    NS_ASSERTION(mPrincipal, "How'd that happen?");

    return mPrincipal;

  }

  void RemoveNodeInfo(mozilla::dom::NodeInfo *aNodeInfo);

  nsBindingManager* GetBindingManager() const

  {

    return mBindingManager;

  }

  enum Tri

  {

    eTriUnset = 0,

    eTriFalse,

    eTriTrue

  };

  /**

   * Returns true if SVG nodes in this document have real SVG semantics.

   */

  bool SVGEnabled()

  {

    return mSVGEnabled == eTriTrue

             ? true

             : mSVGEnabled == eTriFalse ? false : InternalSVGEnabled();

  }

  /**

   * Returns true if MathML nodes in this document have real MathML semantics.

   */

  bool MathMLEnabled()

  {

    return mMathMLEnabled == eTriTrue

             ? true

             : mMathMLEnabled == eTriFalse ? false : InternalMathMLEnabled();

  }

  void AddSizeOfIncludingThis(nsWindowSizes& aSizes) const;

protected:

  friend class nsIDocument;

  friend class nsXULPrototypeDocument;

  /**

   * Sets the principal of the document this nodeinfo manager belongs to.

   */

  void SetDocumentPrincipal(nsIPrincipal *aPrincipal);

private:

  bool InternalSVGEnabled();

  bool InternalMathMLEnabled();

  class NodeInfoInnerKey :

    public nsPtrHashKey<mozilla::dom::NodeInfo::NodeInfoInner>

  {

  public:

    explicit NodeInfoInnerKey(KeyTypePointer aKey) : nsPtrHashKey(aKey) {}

    NodeInfoInnerKey(NodeInfoInnerKey&&) = default;

    ~NodeInfoInnerKey() = default;

    bool KeyEquals(KeyTypePointer aKey) const { return *mKey == *aKey; }

    static PLDHashNumber HashKey(KeyTypePointer aKey) { return aKey->Hash(); }

  };

  struct NodeInfoCache : public mozilla::MruCache<

                              mozilla::dom::NodeInfo::NodeInfoInner,

                              mozilla::dom::NodeInfo*,

                              NodeInfoCache>

  {

    static mozilla::HashNumber Hash(

        const mozilla::dom::NodeInfo::NodeInfoInner& aKey)

    {

      return aKey.Hash();

    }

    static bool Match(const mozilla::dom::NodeInfo::NodeInfoInner& aKey,

                      const mozilla::dom::NodeInfo* aVal)

    {

      return aKey == aVal->mInner;

    }

  };

  nsDataHashtable<NodeInfoInnerKey, mozilla::dom::NodeInfo*> mNodeInfoHash;

  nsIDocument * MOZ_NON_OWNING_REF mDocument; // WEAK

  uint32_t mNonDocumentNodeInfos;

  nsCOMPtr<nsIPrincipal> mPrincipal; // Never null after Init() succeeds.

  nsCOMPtr<nsIPrincipal> mDefaultPrincipal; // Never null after Init() succeeds

  mozilla::dom::NodeInfo * MOZ_NON_OWNING_REF mTextNodeInfo; // WEAK to avoid circular ownership

  mozilla::dom::NodeInfo * MOZ_NON_OWNING_REF mCommentNodeInfo; // WEAK to avoid circular ownership

  mozilla::dom::NodeInfo * MOZ_NON_OWNING_REF mDocumentNodeInfo; // WEAK to avoid circular ownership

  RefPtr<nsBindingManager> mBindingManager;

  NodeInfoCache mRecentlyUsedNodeInfos;

  Tri mSVGEnabled;

  Tri mMathMLEnabled;

};

#endif /* nsNodeInfoManager_h___ */