image/decoders/icon/gtk/nsIconChannel.h

   1 /* -*- Mode: C++; tab-width: 20; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #ifndef mozilla_image_decoders_icon_gtk_nsIconChannel_h
   7 #define mozilla_image_decoders_icon_gtk_nsIconChannel_h
   8
   9 #include "mozilla/Attributes.h"
  10
  11 #include "nsIChannel.h"
  12 #include "nsIURI.h"
  13 #include "nsIIconURI.h"
  14 #include "nsCOMPtr.h"
  15
  16 namespace mozilla::ipc {
  17 class ByteBuf;
  18 }
  19
  20 /// This class is the GTK implementation of nsIconChannel.  It asks
  21 /// GTK for the icon, translates the pixel data in-memory into
  22 /// nsIconDecoder format, and proxies the nsChannel interface to a new
  23 /// channel returning that image.
  24 class nsIconChannel final : public nsIChannel {
  25  public:
  26   NS_DECL_ISUPPORTS
  27   NS_FORWARD_NSIREQUEST(mRealChannel->)
  28   NS_FORWARD_NSICHANNEL(mRealChannel->)
  29
  30   nsIconChannel() {}
  31
  32   static void Shutdown();
  33
  34   /// Called by nsIconProtocolHandler after it creates this channel.
  35   /// Must be called before calling any other function on this object.
  36   /// If this method fails, no other function must be called on this object.
  37   nsresult Init(nsIURI* aURI);
  38
  39   /// Obtains an icon, in nsIconDecoder format, as a ByteBuf instead
  40   /// of a channel.  For use with IPC.
  41   static nsresult GetIcon(nsIURI* aURI, mozilla::ipc::ByteBuf* aDataOut);
  42
  43  private:
  44   ~nsIconChannel() {}
  45   /// The input stream channel which will yield the image.
  46   /// Will always be non-null after a successful Init.
  47   nsCOMPtr<nsIChannel> mRealChannel;
  48
  49   static nsresult GetIconWithGIO(nsIMozIconURI* aIconURI,
  50                                  mozilla::ipc::ByteBuf* aDataOut);
  51 };
  52
  53 #endif  // mozilla_image_decoders_icon_gtk_nsIconChannel_h