/* -*- 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/. */

#ifndef nsNameSpaceManager_h___

#define nsNameSpaceManager_h___

#include "nsDataHashtable.h"

#include "nsHashKeys.h"

#include "nsAtom.h"

#include "nsIDocument.h"

#include "nsStringFwd.h"

#include "nsTArray.h"

#include "mozilla/StaticPtr.h"

/**

 * The Name Space Manager tracks the association between a NameSpace

 * URI and the int32_t runtime id. Mappings between NameSpaces and

 * NameSpace prefixes are managed by nsINameSpaces.

 *

 * All NameSpace URIs are stored in a global table so that IDs are

 * consistent accross the app. NameSpace IDs are only consistent at runtime

 * ie: they are not guaranteed to be consistent accross app sessions.

 *

 * The nsNameSpaceManager needs to have a live reference for as long as

 * the NameSpace IDs are needed.

 *

 */

class nsNameSpaceManager final

{

public:

  NS_INLINE_DECL_REFCOUNTING(nsNameSpaceManager)

  virtual nsresult RegisterNameSpace(const nsAString& aURI,

                                     int32_t& aNameSpaceID);

  nsresult RegisterNameSpace(already_AddRefed<nsAtom> aURI,

                             int32_t& aNameSpaceID);

  virtual nsresult GetNameSpaceURI(int32_t aNameSpaceID, nsAString& aURI);

  // Returns the atom for the namespace URI associated with the given ID. The

  // ID must be within range and not be kNameSpaceID_None (i.e. zero);

  //

  // NB: The requirement of mapping from the first entry to the empty atom is

  // necessary for Servo, though it can be removed if needed adding a branch in

  // GeckoElement::get_namespace().

  nsAtom* NameSpaceURIAtom(int32_t aNameSpaceID) {

    MOZ_ASSERT(aNameSpaceID > 0);

    MOZ_ASSERT((int64_t) aNameSpaceID < (int64_t) mURIArray.Length());

    return mURIArray.ElementAt(aNameSpaceID);

  }

  int32_t GetNameSpaceID(const nsAString& aURI,

                         bool aInChromeDoc);

  int32_t GetNameSpaceID(nsAtom* aURI,

                         bool aInChromeDoc);

  bool HasElementCreator(int32_t aNameSpaceID);

  static nsNameSpaceManager* GetInstance();

  bool mMathMLDisabled;

  bool mSVGDisabled;

private:

  void PrefChanged(const char* aPref);

  bool Init();

  nsresult AddNameSpace(already_AddRefed<nsAtom> aURI, const int32_t aNameSpaceID);

  nsresult AddDisabledNameSpace(already_AddRefed<nsAtom> aURI, const int32_t aNameSpaceID);

  ~nsNameSpaceManager() {};

  nsDataHashtable<nsRefPtrHashKey<nsAtom>, int32_t> mURIToIDTable;

  nsDataHashtable<nsRefPtrHashKey<nsAtom>, int32_t> mDisabledURIToIDTable;

  nsTArray<RefPtr<nsAtom>> mURIArray;

  static mozilla::StaticRefPtr<nsNameSpaceManager> sInstance;

};

#endif // nsNameSpaceManager_h___