/*
 * DO NOT EDIT.  THIS FILE IS GENERATED FROM $SRCDIR/toolkit/components/places/nsIFaviconService.idl
 */

#ifndef __gen_nsIFaviconService_h__
#define __gen_nsIFaviconService_h__


#include "nsISupports.h"

#include "nsTArray.h"

#include "js/Value.h"

#include "js/GCAnnotations.h"

/* For IDL files that don't want to include root IDL files. */
#ifndef NS_NO_VTABLE
#define NS_NO_VTABLE
#endif
class nsIURI; /* forward declaration */

class nsIPrincipal; /* forward declaration */


/* starting interface:    nsIFaviconService */
#define NS_IFAVICONSERVICE_IID_STR "e81e0b0c-b9f1-4c2e-8f3c-b809933cf73c"

#define NS_IFAVICONSERVICE_IID \
  {0xe81e0b0c, 0xb9f1, 0x4c2e, \
    { 0x8f, 0x3c, 0xb8, 0x09, 0x93, 0x3c, 0xf7, 0x3c }}

class NS_NO_VTABLE MOZ_BINDING(binding_to, idl, class, XPIDL_nsIFaviconService) nsIFaviconService : public nsISupports {
 public:

  NS_INLINE_DECL_STATIC_IID(NS_IFAVICONSERVICE_IID)

  /* Used by ToJSValue to check which scriptable interface is implemented. */
  using ScriptableInterfaceType = nsIFaviconService;

  enum {
    FAVICON_LOAD_PRIVATE MOZ_BINDING(binding_to, idl, const, XPIDL_nsIFaviconService_FAVICON_LOAD_PRIVATE) = 1U,
    FAVICON_LOAD_NON_PRIVATE MOZ_BINDING(binding_to, idl, const, XPIDL_nsIFaviconService_FAVICON_LOAD_NON_PRIVATE) = 2U,
    ICONDATA_FLAGS_RICH MOZ_BINDING(binding_to, idl, const, XPIDL_nsIFaviconService_ICONDATA_FLAGS_RICH) = 1U,
    MAX_FAVICON_BUFFER_SIZE MOZ_BINDING(binding_to, idl, const, XPIDL_nsIFaviconService_MAX_FAVICON_BUFFER_SIZE) = 65536U
  };

  /* nsIURI getFaviconLinkForIcon (in nsIURI aFaviconURI); */
  MOZ_BINDING(binding_to, idl, method, XPIDL_nsIFaviconService_getFaviconLinkForIcon)
  JS_HAZ_CAN_RUN_SCRIPT NS_IMETHOD GetFaviconLinkForIcon(nsIURI *aFaviconURI, nsIURI **_retval) = 0;

  /* void expireAllFavicons (); */
  MOZ_BINDING(binding_to, idl, method, XPIDL_nsIFaviconService_expireAllFavicons)
  JS_HAZ_CAN_RUN_SCRIPT NS_IMETHOD ExpireAllFavicons(void) = 0;

  /* void setDefaultIconURIPreferredSize (in unsigned short aDefaultSize); */
  MOZ_BINDING(binding_to, idl, method, XPIDL_nsIFaviconService_setDefaultIconURIPreferredSize)
  JS_HAZ_CAN_RUN_SCRIPT NS_IMETHOD SetDefaultIconURIPreferredSize(uint16_t aDefaultSize) = 0;

  /* unsigned short preferredSizeFromURI (in nsIURI aURI); */
  MOZ_BINDING(binding_to, idl, method, XPIDL_nsIFaviconService_preferredSizeFromURI)
  JS_HAZ_CAN_RUN_SCRIPT NS_IMETHOD PreferredSizeFromURI(nsIURI *aURI, uint16_t *_retval) = 0;

  /* readonly attribute nsIURI defaultFavicon; */
  MOZ_BINDING(binding_to, idl, getter, XPIDL_nsIFaviconService_defaultFavicon)
  JS_HAZ_CAN_RUN_SCRIPT NS_IMETHOD GetDefaultFavicon(nsIURI **aDefaultFavicon) = 0;

  /* readonly attribute AUTF8String defaultFaviconMimeType; */
  MOZ_BINDING(binding_to, idl, getter, XPIDL_nsIFaviconService_defaultFaviconMimeType)
  JS_HAZ_CAN_RUN_SCRIPT NS_IMETHOD GetDefaultFaviconMimeType(nsACString& aDefaultFaviconMimeType) = 0;

  /* [implicit_jscontext,must_use] Promise setFaviconForPage (in nsIURI aPageURI, in nsIURI aFaviconURI, in nsIURI aDataURL, [optional] in PRTime aExpiration, [optional] in boolean isRichIcon); */
  MOZ_BINDING(binding_to, idl, method, XPIDL_nsIFaviconService_setFaviconForPage)
  JS_HAZ_CAN_RUN_SCRIPT [[nodiscard]] NS_IMETHOD SetFaviconForPage(nsIURI *aPageURI, nsIURI *aFaviconURI, nsIURI *aDataURL, PRTime aExpiration, bool isRichIcon, JSContext* cx, ::mozilla::dom::Promise * * _retval) = 0;

  /* [implicit_jscontext,must_use] Promise getFaviconForPage (in nsIURI aPageURI, [optional] in unsigned short aPreferredWidth); */
  MOZ_BINDING(binding_to, idl, method, XPIDL_nsIFaviconService_getFaviconForPage)
  JS_HAZ_CAN_RUN_SCRIPT [[nodiscard]] NS_IMETHOD GetFaviconForPage(nsIURI *aPageURI, uint16_t aPreferredWidth, JSContext* cx, ::mozilla::dom::Promise * * _retval) = 0;

  /* [implicit_jscontext,must_use] Promise expireFaviconsForPage (in nsIURI aPageURI); */
  MOZ_BINDING(binding_to, idl, method, XPIDL_nsIFaviconService_expireFaviconsForPage)
  JS_HAZ_CAN_RUN_SCRIPT [[nodiscard]] NS_IMETHOD ExpireFaviconsForPage(nsIURI *aPageURI, JSContext* cx, ::mozilla::dom::Promise * * _retval) = 0;

  /* [implicit_jscontext,must_use] Promise tryCopyFavicons (in nsIURI aFromPageURI, in nsIURI aToPageURI, in unsigned long aFaviconLoadType); */
  MOZ_BINDING(binding_to, idl, method, XPIDL_nsIFaviconService_tryCopyFavicons)
  JS_HAZ_CAN_RUN_SCRIPT [[nodiscard]] NS_IMETHOD TryCopyFavicons(nsIURI *aFromPageURI, nsIURI *aToPageURI, uint32_t aFaviconLoadType, JSContext* cx, ::mozilla::dom::Promise * * _retval) = 0;

};


/* Use this macro when declaring classes that implement this interface. */
#define NS_DECL_NSIFAVICONSERVICE \
  NS_IMETHOD GetFaviconLinkForIcon(nsIURI *aFaviconURI, nsIURI **_retval) override; \
  NS_IMETHOD ExpireAllFavicons(void) override; \
  NS_IMETHOD SetDefaultIconURIPreferredSize(uint16_t aDefaultSize) override; \
  NS_IMETHOD PreferredSizeFromURI(nsIURI *aURI, uint16_t *_retval) override; \
  NS_IMETHOD GetDefaultFavicon(nsIURI **aDefaultFavicon) override; \
  NS_IMETHOD GetDefaultFaviconMimeType(nsACString& aDefaultFaviconMimeType) override; \
  [[nodiscard]] NS_IMETHOD SetFaviconForPage(nsIURI *aPageURI, nsIURI *aFaviconURI, nsIURI *aDataURL, PRTime aExpiration, bool isRichIcon, JSContext* cx, ::mozilla::dom::Promise * * _retval) override; \
  [[nodiscard]] NS_IMETHOD GetFaviconForPage(nsIURI *aPageURI, uint16_t aPreferredWidth, JSContext* cx, ::mozilla::dom::Promise * * _retval) override; \
  [[nodiscard]] NS_IMETHOD ExpireFaviconsForPage(nsIURI *aPageURI, JSContext* cx, ::mozilla::dom::Promise * * _retval) override; \
  [[nodiscard]] NS_IMETHOD TryCopyFavicons(nsIURI *aFromPageURI, nsIURI *aToPageURI, uint32_t aFaviconLoadType, JSContext* cx, ::mozilla::dom::Promise * * _retval) override; 

/* Use this macro when declaring the members of this interface when the
   class doesn't implement the interface. This is useful for forwarding. */
#define NS_DECL_NON_VIRTUAL_NSIFAVICONSERVICE \
  MOZ_BINDING(binding_to, idl, method, XPIDL_nsIFaviconService_getFaviconLinkForIcon)\
  nsresult GetFaviconLinkForIcon(nsIURI *aFaviconURI, nsIURI **_retval); \
  MOZ_BINDING(binding_to, idl, method, XPIDL_nsIFaviconService_expireAllFavicons)\
  nsresult ExpireAllFavicons(void); \
  MOZ_BINDING(binding_to, idl, method, XPIDL_nsIFaviconService_setDefaultIconURIPreferredSize)\
  nsresult SetDefaultIconURIPreferredSize(uint16_t aDefaultSize); \
  MOZ_BINDING(binding_to, idl, method, XPIDL_nsIFaviconService_preferredSizeFromURI)\
  nsresult PreferredSizeFromURI(nsIURI *aURI, uint16_t *_retval); \
  MOZ_BINDING(binding_to, idl, getter, XPIDL_nsIFaviconService_defaultFavicon)\
  nsresult GetDefaultFavicon(nsIURI **aDefaultFavicon); \
  MOZ_BINDING(binding_to, idl, getter, XPIDL_nsIFaviconService_defaultFaviconMimeType)\
  nsresult GetDefaultFaviconMimeType(nsACString& aDefaultFaviconMimeType); \
  MOZ_BINDING(binding_to, idl, method, XPIDL_nsIFaviconService_setFaviconForPage)\
  [[nodiscard]] nsresult SetFaviconForPage(nsIURI *aPageURI, nsIURI *aFaviconURI, nsIURI *aDataURL, PRTime aExpiration, bool isRichIcon, JSContext* cx, ::mozilla::dom::Promise * * _retval); \
  MOZ_BINDING(binding_to, idl, method, XPIDL_nsIFaviconService_getFaviconForPage)\
  [[nodiscard]] nsresult GetFaviconForPage(nsIURI *aPageURI, uint16_t aPreferredWidth, JSContext* cx, ::mozilla::dom::Promise * * _retval); \
  MOZ_BINDING(binding_to, idl, method, XPIDL_nsIFaviconService_expireFaviconsForPage)\
  [[nodiscard]] nsresult ExpireFaviconsForPage(nsIURI *aPageURI, JSContext* cx, ::mozilla::dom::Promise * * _retval); \
  MOZ_BINDING(binding_to, idl, method, XPIDL_nsIFaviconService_tryCopyFavicons)\
  [[nodiscard]] nsresult TryCopyFavicons(nsIURI *aFromPageURI, nsIURI *aToPageURI, uint32_t aFaviconLoadType, JSContext* cx, ::mozilla::dom::Promise * * _retval); 

/* Use this macro to declare functions that forward the behavior of this interface to another object. */
#define NS_FORWARD_NSIFAVICONSERVICE(_to) \
  NS_IMETHOD GetFaviconLinkForIcon(nsIURI *aFaviconURI, nsIURI **_retval) override { return _to GetFaviconLinkForIcon(aFaviconURI, _retval); } \
  NS_IMETHOD ExpireAllFavicons(void) override { return _to ExpireAllFavicons(); } \
  NS_IMETHOD SetDefaultIconURIPreferredSize(uint16_t aDefaultSize) override { return _to SetDefaultIconURIPreferredSize(aDefaultSize); } \
  NS_IMETHOD PreferredSizeFromURI(nsIURI *aURI, uint16_t *_retval) override { return _to PreferredSizeFromURI(aURI, _retval); } \
  NS_IMETHOD GetDefaultFavicon(nsIURI **aDefaultFavicon) override { return _to GetDefaultFavicon(aDefaultFavicon); } \
  NS_IMETHOD GetDefaultFaviconMimeType(nsACString& aDefaultFaviconMimeType) override { return _to GetDefaultFaviconMimeType(aDefaultFaviconMimeType); } \
  [[nodiscard]] NS_IMETHOD SetFaviconForPage(nsIURI *aPageURI, nsIURI *aFaviconURI, nsIURI *aDataURL, PRTime aExpiration, bool isRichIcon, JSContext* cx, ::mozilla::dom::Promise * * _retval) override { return _to SetFaviconForPage(aPageURI, aFaviconURI, aDataURL, aExpiration, isRichIcon, cx, _retval); } \
  [[nodiscard]] NS_IMETHOD GetFaviconForPage(nsIURI *aPageURI, uint16_t aPreferredWidth, JSContext* cx, ::mozilla::dom::Promise * * _retval) override { return _to GetFaviconForPage(aPageURI, aPreferredWidth, cx, _retval); } \
  [[nodiscard]] NS_IMETHOD ExpireFaviconsForPage(nsIURI *aPageURI, JSContext* cx, ::mozilla::dom::Promise * * _retval) override { return _to ExpireFaviconsForPage(aPageURI, cx, _retval); } \
  [[nodiscard]] NS_IMETHOD TryCopyFavicons(nsIURI *aFromPageURI, nsIURI *aToPageURI, uint32_t aFaviconLoadType, JSContext* cx, ::mozilla::dom::Promise * * _retval) override { return _to TryCopyFavicons(aFromPageURI, aToPageURI, aFaviconLoadType, cx, _retval); } 

/* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
#define NS_FORWARD_SAFE_NSIFAVICONSERVICE(_to) \
  NS_IMETHOD GetFaviconLinkForIcon(nsIURI *aFaviconURI, nsIURI **_retval) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetFaviconLinkForIcon(aFaviconURI, _retval); } \
  NS_IMETHOD ExpireAllFavicons(void) override { return !_to ? NS_ERROR_NULL_POINTER : _to->ExpireAllFavicons(); } \
  NS_IMETHOD SetDefaultIconURIPreferredSize(uint16_t aDefaultSize) override { return !_to ? NS_ERROR_NULL_POINTER : _to->SetDefaultIconURIPreferredSize(aDefaultSize); } \
  NS_IMETHOD PreferredSizeFromURI(nsIURI *aURI, uint16_t *_retval) override { return !_to ? NS_ERROR_NULL_POINTER : _to->PreferredSizeFromURI(aURI, _retval); } \
  NS_IMETHOD GetDefaultFavicon(nsIURI **aDefaultFavicon) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetDefaultFavicon(aDefaultFavicon); } \
  NS_IMETHOD GetDefaultFaviconMimeType(nsACString& aDefaultFaviconMimeType) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetDefaultFaviconMimeType(aDefaultFaviconMimeType); } \
  [[nodiscard]] NS_IMETHOD SetFaviconForPage(nsIURI *aPageURI, nsIURI *aFaviconURI, nsIURI *aDataURL, PRTime aExpiration, bool isRichIcon, JSContext* cx, ::mozilla::dom::Promise * * _retval) override { return !_to ? NS_ERROR_NULL_POINTER : _to->SetFaviconForPage(aPageURI, aFaviconURI, aDataURL, aExpiration, isRichIcon, cx, _retval); } \
  [[nodiscard]] NS_IMETHOD GetFaviconForPage(nsIURI *aPageURI, uint16_t aPreferredWidth, JSContext* cx, ::mozilla::dom::Promise * * _retval) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetFaviconForPage(aPageURI, aPreferredWidth, cx, _retval); } \
  [[nodiscard]] NS_IMETHOD ExpireFaviconsForPage(nsIURI *aPageURI, JSContext* cx, ::mozilla::dom::Promise * * _retval) override { return !_to ? NS_ERROR_NULL_POINTER : _to->ExpireFaviconsForPage(aPageURI, cx, _retval); } \
  [[nodiscard]] NS_IMETHOD TryCopyFavicons(nsIURI *aFromPageURI, nsIURI *aToPageURI, uint32_t aFaviconLoadType, JSContext* cx, ::mozilla::dom::Promise * * _retval) override { return !_to ? NS_ERROR_NULL_POINTER : _to->TryCopyFavicons(aFromPageURI, aToPageURI, aFaviconLoadType, cx, _retval); } 


/* starting interface:    nsIFavicon */
#define NS_IFAVICON_IID_STR "c23c74d6-9c36-4223-a9c4-c8b95526f4d3"

#define NS_IFAVICON_IID \
  {0xc23c74d6, 0x9c36, 0x4223, \
    { 0xa9, 0xc4, 0xc8, 0xb9, 0x55, 0x26, 0xf4, 0xd3 }}

class NS_NO_VTABLE MOZ_BINDING(binding_to, idl, class, XPIDL_nsIFavicon) nsIFavicon : public nsISupports {
 public:

  NS_INLINE_DECL_STATIC_IID(NS_IFAVICON_IID)

  /* Used by ToJSValue to check which scriptable interface is implemented. */
  using ScriptableInterfaceType = nsIFavicon;

  /* readonly attribute nsIURI uri; */
  MOZ_BINDING(binding_to, idl, getter, XPIDL_nsIFavicon_uri)
  JS_HAZ_CAN_RUN_SCRIPT NS_IMETHOD GetUri(nsIURI **aUri) = 0;

  /* readonly attribute nsIURI dataURI; */
  MOZ_BINDING(binding_to, idl, getter, XPIDL_nsIFavicon_dataURI)
  JS_HAZ_CAN_RUN_SCRIPT NS_IMETHOD GetDataURI(nsIURI **aDataURI) = 0;

  /* readonly attribute Array<octet> rawData; */
  MOZ_BINDING(binding_to, idl, getter, XPIDL_nsIFavicon_rawData)
  JS_HAZ_CAN_RUN_SCRIPT NS_IMETHOD GetRawData(nsTArray<uint8_t >& aRawData) = 0;

  /* readonly attribute ACString mimeType; */
  MOZ_BINDING(binding_to, idl, getter, XPIDL_nsIFavicon_mimeType)
  JS_HAZ_CAN_RUN_SCRIPT NS_IMETHOD GetMimeType(nsACString& aMimeType) = 0;

  /* readonly attribute unsigned short width; */
  MOZ_BINDING(binding_to, idl, getter, XPIDL_nsIFavicon_width)
  JS_HAZ_CAN_RUN_SCRIPT NS_IMETHOD GetWidth(uint16_t *aWidth) = 0;

};


/* Use this macro when declaring classes that implement this interface. */
#define NS_DECL_NSIFAVICON \
  NS_IMETHOD GetUri(nsIURI **aUri) override; \
  NS_IMETHOD GetDataURI(nsIURI **aDataURI) override; \
  NS_IMETHOD GetRawData(nsTArray<uint8_t >& aRawData) override; \
  NS_IMETHOD GetMimeType(nsACString& aMimeType) override; \
  NS_IMETHOD GetWidth(uint16_t *aWidth) override; 

/* Use this macro when declaring the members of this interface when the
   class doesn't implement the interface. This is useful for forwarding. */
#define NS_DECL_NON_VIRTUAL_NSIFAVICON \
  MOZ_BINDING(binding_to, idl, getter, XPIDL_nsIFavicon_uri)\
  nsresult GetUri(nsIURI **aUri); \
  MOZ_BINDING(binding_to, idl, getter, XPIDL_nsIFavicon_dataURI)\
  nsresult GetDataURI(nsIURI **aDataURI); \
  MOZ_BINDING(binding_to, idl, getter, XPIDL_nsIFavicon_rawData)\
  nsresult GetRawData(nsTArray<uint8_t >& aRawData); \
  MOZ_BINDING(binding_to, idl, getter, XPIDL_nsIFavicon_mimeType)\
  nsresult GetMimeType(nsACString& aMimeType); \
  MOZ_BINDING(binding_to, idl, getter, XPIDL_nsIFavicon_width)\
  nsresult GetWidth(uint16_t *aWidth); 

/* Use this macro to declare functions that forward the behavior of this interface to another object. */
#define NS_FORWARD_NSIFAVICON(_to) \
  NS_IMETHOD GetUri(nsIURI **aUri) override { return _to GetUri(aUri); } \
  NS_IMETHOD GetDataURI(nsIURI **aDataURI) override { return _to GetDataURI(aDataURI); } \
  NS_IMETHOD GetRawData(nsTArray<uint8_t >& aRawData) override { return _to GetRawData(aRawData); } \
  NS_IMETHOD GetMimeType(nsACString& aMimeType) override { return _to GetMimeType(aMimeType); } \
  NS_IMETHOD GetWidth(uint16_t *aWidth) override { return _to GetWidth(aWidth); } 

/* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
#define NS_FORWARD_SAFE_NSIFAVICON(_to) \
  NS_IMETHOD GetUri(nsIURI **aUri) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetUri(aUri); } \
  NS_IMETHOD GetDataURI(nsIURI **aDataURI) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetDataURI(aDataURI); } \
  NS_IMETHOD GetRawData(nsTArray<uint8_t >& aRawData) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetRawData(aRawData); } \
  NS_IMETHOD GetMimeType(nsACString& aMimeType) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetMimeType(aMimeType); } \
  NS_IMETHOD GetWidth(uint16_t *aWidth) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetWidth(aWidth); } 

// %{C++:203-213

/**
 * Notification sent when all favicons are expired.
 */
#define NS_PLACES_FAVICONS_EXPIRED_TOPIC_ID "places-favicons-expired"

#define FAVICON_DEFAULT_URL "chrome://global/skin/icons/defaultFavicon.svg"
#define FAVICON_DEFAULT_MIMETYPE "image/svg+xml"

#define FAVICON_ERRORPAGE_URL "chrome://global/skin/icons/info.svg"
#define FAVICON_CERTERRORPAGE_URL "chrome://global/skin/icons/warning.svg"
// %}

#endif /* __gen_nsIFaviconService_h__ */