mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-08 20:47:44 +00:00
141 lines
4.4 KiB
Plaintext
141 lines
4.4 KiB
Plaintext
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
|
|
* ***** BEGIN LICENSE BLOCK *****
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
*
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
* the License. You may obtain a copy of the License at
|
|
* http://www.mozilla.org/MPL/
|
|
*
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
* for the specific language governing rights and limitations under the
|
|
* License.
|
|
*
|
|
* The Original Code is Mozilla Communicator client code, released
|
|
* March 31, 1998.
|
|
*
|
|
* The Initial Developer of the Original Code is
|
|
* Netscape Communications Corporation.
|
|
* Portions created by the Initial Developer are Copyright (C) 1998-1999
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
*
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
* either of the GNU General Public License Version 2 or later (the "GPL"),
|
|
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
* use your version of this file under the terms of the MPL, indicate your
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
* the provisions above, a recipient may use your version of this file under
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
*
|
|
* ***** END LICENSE BLOCK ***** */
|
|
|
|
#include "nsIInputStream.idl"
|
|
#include "nsrootidl.idl"
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
|
|
[scriptable, uuid(7b456cb0-8772-11d3-90cf-0040056a906e)]
|
|
interface nsIBinaryInputStream : nsIInputStream {
|
|
void setInputStream(in nsIInputStream aInputStream);
|
|
|
|
/**
|
|
* Read 8-bits from the stream.
|
|
*
|
|
* @return that byte to be treated as a boolean.
|
|
*/
|
|
PRBool readBoolean();
|
|
|
|
PRUint8 read8();
|
|
PRUint16 read16();
|
|
PRUint32 read32();
|
|
PRUint64 read64();
|
|
|
|
float readFloat();
|
|
double readDouble();
|
|
|
|
/**
|
|
* Read an 8-bit pascal style string from the stream.
|
|
* 32-bit length field, followed by length 8-bit chars.
|
|
*/
|
|
ACString readCString();
|
|
|
|
/**
|
|
* Read an 16-bit pascal style string from the stream.
|
|
* 32-bit length field, followed by length PRUnichars.
|
|
*/
|
|
AString readString();
|
|
|
|
/**
|
|
* Read an opaque byte array from the stream.
|
|
*
|
|
* @param aLength the number of bytes that must be read.
|
|
*
|
|
* @throws NS_ERROR_FAILURE if it can't read aLength bytes
|
|
*/
|
|
void readBytes(in PRUint32 aLength,
|
|
[size_is(aLength), retval] out string aString);
|
|
|
|
/**
|
|
* Read an opaque byte array from the stream, storing the results
|
|
* as an array of PRUint8s.
|
|
*
|
|
* @param aLength the number of bytes that must be read.
|
|
*
|
|
* @throws NS_ERROR_FAILURE if it can't read aLength bytes
|
|
*/
|
|
void readByteArray(in PRUint32 aLength,
|
|
[array, size_is(aLength), retval] out PRUint8 aBytes);
|
|
};
|
|
|
|
%{C++
|
|
|
|
#ifdef MOZILLA_INTERNAL_API
|
|
#include "nsString.h"
|
|
|
|
inline nsresult
|
|
NS_ReadOptionalCString(nsIBinaryInputStream* aStream, nsACString& aResult)
|
|
{
|
|
PRBool nonnull;
|
|
nsresult rv = aStream->ReadBoolean(&nonnull);
|
|
if (NS_SUCCEEDED(rv)) {
|
|
if (nonnull)
|
|
rv = aStream->ReadCString(aResult);
|
|
else
|
|
aResult.Truncate();
|
|
}
|
|
return rv;
|
|
}
|
|
|
|
inline nsresult
|
|
NS_ReadOptionalString(nsIBinaryInputStream* aStream, nsAString& aResult)
|
|
{
|
|
PRBool nonnull;
|
|
nsresult rv = aStream->ReadBoolean(&nonnull);
|
|
if (NS_SUCCEEDED(rv)) {
|
|
if (nonnull)
|
|
rv = aStream->ReadString(aResult);
|
|
else
|
|
aResult.Truncate();
|
|
}
|
|
return rv;
|
|
}
|
|
#endif
|
|
|
|
%}
|