Back to index

lightning-sunbird  0.9+nobinonly
nsIBinaryInputStream.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
00002  * ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is Mozilla Communicator client code, released
00016  * March 31, 1998.
00017  *
00018  * The Initial Developer of the Original Code is
00019  * Netscape Communications Corporation.
00020  * Portions created by the Initial Developer are Copyright (C) 1998-1999
00021  * the Initial Developer. All Rights Reserved.
00022  *
00023  * Contributor(s):
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either of the GNU General Public License Version 2 or later (the "GPL"),
00027  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #include "nsIInputStream.idl"
00040 #include "nsrootidl.idl"
00041 
00053 [scriptable, uuid(7b456cb0-8772-11d3-90cf-0040056a906e)]
00054 interface nsIBinaryInputStream : nsIInputStream {
00055     void setInputStream(in nsIInputStream aInputStream);
00056     
00057     PRBool readBoolean();
00058 
00059     PRUint8 read8();
00060     PRUint16 read16();
00061     PRUint32 read32();
00062     PRUint64 read64();
00063 
00064     float readFloat();
00065     double readDouble();
00066 
00070     ACString readCString();
00071 
00075     AString readString();
00076 
00080     void readBytes(in PRUint32 aLength,
00081                    [size_is(aLength), retval] out string aString);
00082 
00087     void readByteArray(in PRUint32 aLength,
00088                        [array, size_is(aLength), retval] out PRUint8 aBytes);
00089 };
00090 
00091 %{C++
00092 
00093 #ifdef MOZILLA_INTERNAL_API
00094 #include "nsString.h"
00095 
00096 inline nsresult
00097 NS_ReadOptionalCString(nsIBinaryInputStream* aStream, nsACString& aResult)
00098 {
00099     PRBool nonnull;
00100     nsresult rv = aStream->ReadBoolean(&nonnull);
00101     if (NS_SUCCEEDED(rv)) {
00102         if (nonnull)
00103             rv = aStream->ReadCString(aResult);
00104         else
00105             aResult.Truncate();
00106     }
00107     return rv;
00108 }
00109 
00110 inline nsresult
00111 NS_ReadOptionalString(nsIBinaryInputStream* aStream, nsAString& aResult)
00112 {
00113     PRBool nonnull;
00114     nsresult rv = aStream->ReadBoolean(&nonnull);
00115     if (NS_SUCCEEDED(rv)) {
00116         if (nonnull)
00117             rv = aStream->ReadString(aResult);
00118         else
00119             aResult.Truncate();
00120     }
00121     return rv;
00122 }
00123 #endif
00124 
00125 %}