/* -*- 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 mozilla_dom_FallbackEncoding_h_
#define mozilla_dom_FallbackEncoding_h_

#include "mozilla/NotNull.h"
#include "mozilla/StaticPtr.h"
#include "nsIObserver.h"
#include "nsString.h"
#include "nsWeakReference.h"

namespace mozilla {
class Encoding;
namespace dom {

class FallbackEncoding : public nsIObserver, nsSupportsWeakReference {
 public:
  NS_DECL_ISUPPORTS
  NS_DECL_NSIOBSERVER

  /**
   * Whether FromTopLevelDomain() should be used.
   */
  static bool sGuessFallbackFromTopLevelDomain;

  /**
   * Gets the locale-dependent fallback encoding for legacy HTML and plain
   * text content.
   *
   * @param aFallback the outparam for the fallback encoding
   */
  static NotNull<const Encoding*> FromLocale();

  /**
   * Checks if it is appropriate to call FromTopLevelDomain() for a given TLD.
   *
   * @param aTLD the top-level domain (in Punycode)
   * @return true if OK to call FromTopLevelDomain()
   */
  static bool IsParticipatingTopLevelDomain(const nsACString& aTLD);

  /**
   * Gets a top-level domain-depedendent fallback encoding for legacy HTML
   * and plain text content
   *
   * @param aTLD the top-level domain (in Punycode)
   * @param aFallback the outparam for the fallback encoding
   */
  static NotNull<const Encoding*> FromTopLevelDomain(const nsACString& aTLD);

  // public API ends here!

  /**
   * Allocate sInstance used by FromLocale().
   * To be called from nsLayoutStatics only.
   */
  static void Initialize();

  /**
   * Delete sInstance used by FromLocale().
   * To be called from nsLayoutStatics only.
   */
  static void Shutdown();

 private:
  /**
   * The fallback cache.
   */
  static StaticRefPtr<FallbackEncoding> sInstance;

  FallbackEncoding();
  virtual ~FallbackEncoding(){};

  /**
   * Invalidates the cache.
   */
  void Invalidate() { mFallback = nullptr; }

  static void PrefChanged(const char*, void*);

  /**
   * Gets the fallback encoding label.
   * @param aFallback the fallback encoding
   */
  NotNull<const Encoding*> Get();

  const Encoding* mFallback;
};

}  // namespace dom
}  // namespace mozilla

#endif  // mozilla_dom_FallbackEncoding_h_