/*
 * DO NOT EDIT.  THIS FILE IS GENERATED FROM nsIBinaryInputStream.idl
 */

#ifndef __gen_nsIBinaryInputStream_h__
#define __gen_nsIBinaryInputStream_h__

#include "nsIInputStream.h"
#include "nsrootidl.h"

#include "nsString.h"

/* starting interface:    nsIBinaryInputStream */
#define NS_IBINARYINPUTSTREAM_IID_STR "7b456cb0-8772-11d3-90cf-0040056a906e"

#define NS_IBINARYINPUTSTREAM_IID \
  {0x7b456cb0, 0x8772, 0x11d3, \
    { 0x90, 0xcf, 0x00, 0x40, 0x05, 0x6a, 0x90, 0x6e }}

/**
 * This interface allows consumption of primitive data types from a "binary
 * stream" containing untagged, big-endian binary data, i.e. as produced by an
 * implementation of nsIBinaryOutputStream.  This might be used, for example,
 * to implement network protocols or to read from architecture-neutral disk
 * files, i.e. ones that can be read and written by both big-endian and
 * little-endian platforms.
 *
 * @See nsIBinaryOutputStream
 */
class NS_NO_VTABLE nsIBinaryInputStream : public nsIInputStream {
 public: 

  NS_DEFINE_STATIC_IID_ACCESSOR(NS_IBINARYINPUTSTREAM_IID)

  /* void setInputStream (in nsIInputStream aInputStream); */
  NS_IMETHOD SetInputStream(nsIInputStream *aInputStream) = 0;

  /* PRBool readBoolean (); */
  NS_IMETHOD ReadBoolean(PRBool *_retval) = 0;

  /* PRUint8 read8 (); */
  NS_IMETHOD Read8(PRUint8 *_retval) = 0;

  /* PRUint16 read16 (); */
  NS_IMETHOD Read16(PRUint16 *_retval) = 0;

  /* PRUint32 read32 (); */
  NS_IMETHOD Read32(PRUint32 *_retval) = 0;

  /* PRUint64 read64 (); */
  NS_IMETHOD Read64(PRUint64 *_retval) = 0;

  /* float readFloat (); */
  NS_IMETHOD ReadFloat(float *_retval) = 0;

  /* double readDouble (); */
  NS_IMETHOD ReadDouble(double *_retval) = 0;

  /**
     * Read a NUL-terminated 8-bit char* string from a binary stream.
     */
  /* string readStringZ (); */
  NS_IMETHOD ReadStringZ(char **_retval) = 0;

  /**
     * Read a NUL-terminated 16-bit PRUnichar* string from a binary stream.
     */
  /* wstring readWStringZ (); */
  NS_IMETHOD ReadWStringZ(PRUnichar **_retval) = 0;

  /**
     * Read a NUL-terminated UTF8-encoded string from a binary stream, producing
     * a NUL-terminated 16-bit PRUnichar* string argument as a result.
     */
  /* wstring readUtf8Z (); */
  NS_IMETHOD ReadUtf8Z(PRUnichar **_retval) = 0;

  /**
     * Read an opaque byte array from a binary stream.
     */
  /* void readBytes ([size_is (aLength)] out string aString, in PRUint32 aLength); */
  NS_IMETHOD ReadBytes(char **aString, PRUint32 aLength) = 0;

  /**
     * Read a string (possibly containing embedded NULs) from a binary stream.
     */
  /* [noscript] nsString readString (); */
  NS_IMETHOD ReadString(nsString * *_retval) = 0;

};

/* Use this macro when declaring classes that implement this interface. */
#define NS_DECL_NSIBINARYINPUTSTREAM \
  NS_IMETHOD SetInputStream(nsIInputStream *aInputStream); \
  NS_IMETHOD ReadBoolean(PRBool *_retval); \
  NS_IMETHOD Read8(PRUint8 *_retval); \
  NS_IMETHOD Read16(PRUint16 *_retval); \
  NS_IMETHOD Read32(PRUint32 *_retval); \
  NS_IMETHOD Read64(PRUint64 *_retval); \
  NS_IMETHOD ReadFloat(float *_retval); \
  NS_IMETHOD ReadDouble(double *_retval); \
  NS_IMETHOD ReadStringZ(char **_retval); \
  NS_IMETHOD ReadWStringZ(PRUnichar **_retval); \
  NS_IMETHOD ReadUtf8Z(PRUnichar **_retval); \
  NS_IMETHOD ReadBytes(char **aString, PRUint32 aLength); \
  NS_IMETHOD ReadString(nsString * *_retval); 

/* Use this macro to declare functions that forward the behavior of this interface to another object. */
#define NS_FORWARD_NSIBINARYINPUTSTREAM(_to) \
  NS_IMETHOD SetInputStream(nsIInputStream *aInputStream) { return _to ## SetInputStream(aInputStream); } \
  NS_IMETHOD ReadBoolean(PRBool *_retval) { return _to ## ReadBoolean(_retval); } \
  NS_IMETHOD Read8(PRUint8 *_retval) { return _to ## Read8(_retval); } \
  NS_IMETHOD Read16(PRUint16 *_retval) { return _to ## Read16(_retval); } \
  NS_IMETHOD Read32(PRUint32 *_retval) { return _to ## Read32(_retval); } \
  NS_IMETHOD Read64(PRUint64 *_retval) { return _to ## Read64(_retval); } \
  NS_IMETHOD ReadFloat(float *_retval) { return _to ## ReadFloat(_retval); } \
  NS_IMETHOD ReadDouble(double *_retval) { return _to ## ReadDouble(_retval); } \
  NS_IMETHOD ReadStringZ(char **_retval) { return _to ## ReadStringZ(_retval); } \
  NS_IMETHOD ReadWStringZ(PRUnichar **_retval) { return _to ## ReadWStringZ(_retval); } \
  NS_IMETHOD ReadUtf8Z(PRUnichar **_retval) { return _to ## ReadUtf8Z(_retval); } \
  NS_IMETHOD ReadBytes(char **aString, PRUint32 aLength) { return _to ## ReadBytes(aString, aLength); } \
  NS_IMETHOD ReadString(nsString * *_retval) { return _to ## ReadString(_retval); } 

#if 0
/* Use the code below as a template for the implementation class for this interface. */

/* Header file */
class nsBinaryInputStream : public nsIBinaryInputStream
{
public:
  NS_DECL_ISUPPORTS
  NS_DECL_NSIBINARYINPUTSTREAM

  nsBinaryInputStream();
  virtual ~nsBinaryInputStream();
  /* additional members */
};

/* Implementation file */
NS_IMPL_ISUPPORTS1(nsBinaryInputStream, nsIBinaryInputStream)

nsBinaryInputStream::nsBinaryInputStream()
{
  NS_INIT_ISUPPORTS();
  /* member initializers and constructor code */
}

nsBinaryInputStream::~nsBinaryInputStream()
{
  /* destructor code */
}

/* void setInputStream (in nsIInputStream aInputStream); */
NS_IMETHODIMP nsBinaryInputStream::SetInputStream(nsIInputStream *aInputStream)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* PRBool readBoolean (); */
NS_IMETHODIMP nsBinaryInputStream::ReadBoolean(PRBool *_retval)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* PRUint8 read8 (); */
NS_IMETHODIMP nsBinaryInputStream::Read8(PRUint8 *_retval)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* PRUint16 read16 (); */
NS_IMETHODIMP nsBinaryInputStream::Read16(PRUint16 *_retval)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* PRUint32 read32 (); */
NS_IMETHODIMP nsBinaryInputStream::Read32(PRUint32 *_retval)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* PRUint64 read64 (); */
NS_IMETHODIMP nsBinaryInputStream::Read64(PRUint64 *_retval)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* float readFloat (); */
NS_IMETHODIMP nsBinaryInputStream::ReadFloat(float *_retval)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* double readDouble (); */
NS_IMETHODIMP nsBinaryInputStream::ReadDouble(double *_retval)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* string readStringZ (); */
NS_IMETHODIMP nsBinaryInputStream::ReadStringZ(char **_retval)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* wstring readWStringZ (); */
NS_IMETHODIMP nsBinaryInputStream::ReadWStringZ(PRUnichar **_retval)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* wstring readUtf8Z (); */
NS_IMETHODIMP nsBinaryInputStream::ReadUtf8Z(PRUnichar **_retval)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* void readBytes ([size_is (aLength)] out string aString, in PRUint32 aLength); */
NS_IMETHODIMP nsBinaryInputStream::ReadBytes(char **aString, PRUint32 aLength)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* [noscript] nsString readString (); */
NS_IMETHODIMP nsBinaryInputStream::ReadString(nsString * *_retval)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* End of implementation class template. */
#endif

NS_COM nsresult
NS_NewBinaryInputStream(nsIBinaryInputStream* *aResult, nsIInputStream* aSrcStream);

#endif /* __gen_nsIBinaryInputStream_h__ */
