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

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

#define nsChromeRegistryChrome_h

#include "nsCOMArray.h"

#include "nsChromeRegistry.h"

#include "nsTArray.h"

#include "mozilla/Move.h"

#include "nsClassHashtable.h"

namespace mozilla {

namespace dom {

class PContentParent;

}  // namespace dom

}  // namespace mozilla

class nsIPrefBranch;

struct ChromePackage;

class nsChromeRegistryChrome : public nsChromeRegistry {

 public:

  nsChromeRegistryChrome();

  ~nsChromeRegistryChrome();

  nsresult Init() override;

  NS_IMETHOD CheckForNewChrome() override;

  NS_IMETHOD CheckForOSAccessibility() override;

  NS_IMETHOD GetLocalesForPackage(const nsACString& aPackage,

                                  nsIUTF8StringEnumerator** aResult) override;

  NS_IMETHOD IsLocaleRTL(const nsACString& package, bool* aResult) override;

  NS_IMETHOD GetSelectedLocale(const nsACString& aPackage, bool aAsBCP47,

                               nsACString& aLocale) override;

  NS_IMETHOD Observe(nsISupports* aSubject, const char* aTopic,

                     const char16_t* someData) override;

#ifdef MOZ_XUL

  NS_IMETHOD GetXULOverlays(nsIURI* aURI,

                            nsISimpleEnumerator** _retval) override;

  NS_IMETHOD GetStyleOverlays(nsIURI* aURI,

                              nsISimpleEnumerator** _retval) override;

#endif

  // If aChild is non-null then it is a new child to notify. If aChild is

  // null, then we have installed new chrome and we are resetting all of our

  // children's registered chrome.

  void SendRegisteredChrome(mozilla::dom::PContentParent* aChild);

 private:

  struct PackageEntry;

  static void ChromePackageFromPackageEntry(const nsACString& aPackageName,

                                            PackageEntry* aPackage,

                                            ChromePackage* aChromePackage,

                                            const nsCString& aSelectedSkin);

  nsresult OverrideLocalePackage(const nsACString& aPackage,

                                 nsACString& aOverride);

  nsIURI* GetBaseURIFromPackage(const nsCString& aPackage,

                                const nsCString& aProvider,

                                const nsCString& aPath) override;

  nsresult GetFlagsFromPackage(const nsCString& aPackage,

                               uint32_t* aFlags) override;

  struct ProviderEntry {

    ProviderEntry(const nsACString& aProvider, nsIURI* aBase)

        : provider(aProvider), baseURI(aBase) {}

    nsCString provider;

    nsCOMPtr<nsIURI> baseURI;

  };

  class nsProviderArray {

   public:

    nsProviderArray() : mArray(1) {}

    ~nsProviderArray() {}

    // When looking up locales and skins, the "selected" locale is not always

    // available. This enum identifies what kind of match is desired/found.

    enum MatchType {

      EXACT = 0,

      LOCALE = 1,  // "en-GB" is selected, we found "en-US"

      ANY = 2

    };

    nsIURI* GetBase(const nsACString& aPreferred, MatchType aType);

    const nsACString& GetSelected(const nsACString& aPreferred,

                                  MatchType aType);

    void SetBase(const nsACString& aProvider, nsIURI* base);

    void EnumerateToArray(nsTArray<nsCString>* a);

   private:

    ProviderEntry* GetProvider(const nsACString& aPreferred, MatchType aType);

    nsTArray<ProviderEntry> mArray;

  };

  struct PackageEntry : public PLDHashEntryHdr {

    PackageEntry() : flags(0) {}

    ~PackageEntry() {}

    nsCOMPtr<nsIURI> baseURI;

    uint32_t flags;

    nsProviderArray locales;

    nsProviderArray skins;

  };

  class OverlayListEntry : public nsURIHashKey {

   public:

    typedef nsURIHashKey::KeyType KeyType;

    typedef nsURIHashKey::KeyTypePointer KeyTypePointer;

    explicit OverlayListEntry(KeyTypePointer aKey) : nsURIHashKey(aKey) {}

    OverlayListEntry(OverlayListEntry&& toMove)

        : nsURIHashKey(mozilla::Move(toMove)),

          mArray(mozilla::Move(toMove.mArray)) {}

    ~OverlayListEntry() {}

    void AddURI(nsIURI* aURI);

    nsCOMArray<nsIURI> mArray;

  };

  class OverlayListHash {

   public:

    OverlayListHash() {}

    ~OverlayListHash() {}

    void Add(nsIURI* aBase, nsIURI* aOverlay);

    void Clear() { mTable.Clear(); }

    const nsCOMArray<nsIURI>* GetArray(nsIURI* aBase);

   private:

    nsTHashtable<OverlayListEntry> mTable;

  };

  // Hashes on the file to be overlaid (chrome://browser/content/browser.xul)

  // to a list of overlays/stylesheets

  OverlayListHash mOverlayHash;

  OverlayListHash mStyleHash;

  bool mProfileLoaded;

  bool mDynamicRegistration;

  nsCString mSelectedSkin;

  // Hash of package names ("global") to PackageEntry objects

  nsClassHashtable<nsCStringHashKey, PackageEntry> mPackagesHash;

  virtual void ManifestContent(ManifestProcessingContext& cx, int lineno,

                               char* const* argv, int flags) override;

  virtual void ManifestLocale(ManifestProcessingContext& cx, int lineno,

                              char* const* argv, int flags) override;

  virtual void ManifestSkin(ManifestProcessingContext& cx, int lineno,

                            char* const* argv, int flags) override;

  virtual void ManifestOverlay(ManifestProcessingContext& cx, int lineno,

                               char* const* argv, int flags) override;

  virtual void ManifestStyle(ManifestProcessingContext& cx, int lineno,

                             char* const* argv, int flags) override;

  virtual void ManifestOverride(ManifestProcessingContext& cx, int lineno,

                                char* const* argv, int flags) override;

  virtual void ManifestResource(ManifestProcessingContext& cx, int lineno,

                                char* const* argv, int flags) override;

};

#endif  // nsChromeRegistryChrome_h