import { ByteArray } from './ByteArray';

/**
 * The IDataInput interface provides a set of methods for reading binary data.
 * This interface is the I/O counterpart to the IDataOutput interface, which
 * writes binary data.
 * <p class="- topic/p ">All IDataInput and IDataOutput operations are "bigEndian" by default (the most significant
 * byte in the sequence is stored at the lowest or first storage address),
 * and are nonblocking.
 * If insufficient data is available, an <codeph class="+ topic/ph pr-d/codeph ">EOFError</codeph> exception
 * is thrown. Use the <codeph class="+ topic/ph pr-d/codeph ">IDataInput.bytesAvailable</codeph> property to determine
 * how much data is available to read.</p><p class="- topic/p ">
 * Sign extension matters only when you read data, not when you write it. Therefore you do not need separate
 * write methods to work with <codeph class="+ topic/ph pr-d/codeph ">IDataInput.readUnsignedByte()</codeph> and
 * <codeph class="+ topic/ph pr-d/codeph ">IDataInput.readUnsignedShort()</codeph>.
 * In other words:</p><ul class="- topic/ul "><li class="- topic/li ">Use
 * <codeph class="+ topic/ph pr-d/codeph ">IDataOutput.writeByte()</codeph> with
 * <codeph class="+ topic/ph pr-d/codeph ">IDataInput.readUnsignedByte()</codeph> and
 * <codeph class="+ topic/ph pr-d/codeph ">IDataInput.readByte()</codeph>.</li>
 * <li class="- topic/li ">Use <codeph class="+ topic/ph pr-d/codeph ">
 * IDataOutput.writeShort()</codeph> with <codeph class="+ topic/ph pr-d/codeph ">
 * IDataInput.readUnsignedShort()</codeph> and
 * <codeph class="+ topic/ph pr-d/codeph ">IDataInput.readShort()</codeph>.</li></ul>
 */
export interface IDataInput
{
	/**
	 * Returns the number of bytes of data available for reading
	 * in the input buffer.
	 * User code must call bytesAvailable to ensure
	 * that sufficient data is available before trying to read
	 * it with one of the read methods.
	 */
	bytesAvailable: number;

	/**
	 * The byte order for the data, either the BIG_ENDIAN or LITTLE_ENDIAN constant
	 * from the Endian class.
	 */
	endian: string;
	/*function set endian (type:String)*/

	/**
	 * Used to determine whether the AMF3 or AMF0 format is used when writing or reading binary data using the
	 * readObject() method. The value is a constant from the ObjectEncoding class.
	 */
	objectEncoding: number;
	/*function set objectEncoding (version:uint)*/

	/**
	 * Reads a Boolean value from the file stream, byte stream, or byte array. A single byte is read
	 * and true is returned if the byte is nonzero,
	 * false otherwise.
	 * @return	A Boolean value, true if the byte is nonzero,
	 *   false otherwise.
	 * @throws	EOFError There is not sufficient data available
	 *   to read.
	 */
	readBoolean (): boolean;

	/**
	 * Reads a signed byte from the file stream, byte stream, or byte array.
	 * @return	The returned value is in the range -128 to 127.
	 * @throws	EOFError There is not sufficient data available
	 *   to read.
	 */
	readByte (): number;

	/**
	 * Reads the number of data bytes, specified by the length parameter,
	 * from the file stream, byte stream, or byte array. The bytes are read into the
	 * ByteArray objected specified by the bytes parameter, starting at
	 * the position specified by offset.
	 * @param	bytes	The ByteArray object to read
	 *   data into.
	 * @param	offset	The offset into the bytes parameter at which data
	 *   read should begin.
	 * @param	length	The number of bytes to read.  The default value
	 *   of 0 causes all available data to be read.
	 * @throws	EOFError There is not sufficient data available
	 *   to read.
	 */
	readBytes (bytes: ByteArray, offset: number, length: number);

	/**
	 * Reads an IEEE 754 double-precision floating point number from the file stream, byte stream, or byte array.
	 * @return	An IEEE 754 double-precision floating point number.
	 * @throws	EOFError There is not sufficient data available
	 *   to read.
	 */
	readDouble (): number;

	/**
	 * Reads an IEEE 754 single-precision floating point number from the file stream, byte stream, or byte array.
	 * @return	An IEEE 754 single-precision floating point number.
	 * @throws	EOFError There is not sufficient data available
	 *   to read.
	 */
	readFloat (): number;

	/**
	 * Reads a signed 32-bit integer from the file stream, byte stream, or byte array.
	 * @return	The returned value is in the range -2147483648 to 2147483647.
	 * @throws	EOFError There is not sufficient data available
	 *   to read.
	 */
	readInt (): number;

	/**
	 * Reads a multibyte string of specified length from the file stream, byte stream, or byte array using the
	 * specified character set.
	 * @param	length	The number of bytes from the byte stream to read.
	 * @param	charSet	The string denoting the character set to use to interpret the bytes.
	 *   Possible character set strings include "shift-jis", "cn-gb",
	 *   "iso-8859-1", and others.
	 *   For a complete list, see Supported Character Sets.
	 *
	 *     Note: If the value for the charSet parameter is not recognized by the current
	 *   system, then Adobe® Flash® Player or
	 *   Adobe® AIR® uses the system's default
	 *   code page as the character set. For example, a value for the charSet parameter, as in
	 *   myTest.readMultiByte(22, "iso-8859-01"), that uses  01 instead of
	 *   1 might work on your development system, but not on another system. On the other
	 *   system, Flash Player or the AIR runtime will use the system's
	 *   default code page.
	 * @return	UTF-8 encoded string.
	 * @throws	EOFError There is not sufficient data available
	 *   to read.
	 */
	readMultiByte (length: number, charSet: string): string;

	/**
	 * Reads an object from the file stream, byte stream, or byte array, encoded in AMF
	 * serialized format.
	 * @return	The deserialized object
	 * @throws	EOFError There is not sufficient data available
	 *   to read.
	 */
	readObject (): any;

	/**
	 * Reads a signed 16-bit integer from the file stream, byte stream, or byte array.
	 * @return	The returned value is in the range -32768 to 32767.
	 * @throws	EOFError There is not sufficient data available
	 *   to read.
	 */
	readShort (): number;

	/**
	 * Reads an unsigned byte from the file stream, byte stream, or byte array.
	 * @return	The returned value is in the range 0 to 255.
	 * @throws	EOFError There is not sufficient data available
	 *   to read.
	 */
	readUnsignedByte (): number;

	/**
	 * Reads an unsigned 32-bit integer from the file stream, byte stream, or byte array.
	 * @return	The returned value is in the range 0 to 4294967295.
	 * @throws	EOFError There is not sufficient data available
	 *   to read.
	 */
	readUnsignedInt (): number;

	/**
	 * Reads an unsigned 16-bit integer from the file stream, byte stream, or byte array.
	 * @return	The returned value is in the range 0 to 65535.
	 * @throws	EOFError There is not sufficient data available
	 *   to read.
	 */
	readUnsignedShort (): number;

	/**
	 * Reads a UTF-8 string from the file stream, byte stream, or byte array.  The string
	 * is assumed to be prefixed with an unsigned short indicating
	 * the length in bytes.
	 *
	 *   This method is similar to the readUTF()
	 * method in the Java® IDataInput interface.
	 * @return	A UTF-8 string produced by the byte representation of characters.
	 * @throws	EOFError There is not sufficient data available
	 *   to read.
	 */
	readUTF (): string;

	/**
	 * Reads a sequence of UTF-8 bytes from the byte stream or byte array and returns a string.
	 * @param	length	The number of bytes to read.
	 * @return	A UTF-8 string produced by the byte representation of characters of the specified length.
	 * @throws	EOFError There is not sufficient data available
	 *   to read.
	 */
	readUTFBytes (length: number): string;
}