Back to index

lightning-sunbird  0.9+nobinonly
nsIBinaryOutputStream.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 "nsIOutputStream.idl"
00040 #include "nsrootidl.idl"
00041 
00054 [scriptable, uuid(204ee610-8765-11d3-90cf-0040056a906e)]
00055 interface nsIBinaryOutputStream : nsIOutputStream {
00056     void setOutputStream(in nsIOutputStream aOutputStream);
00057     
00058     void writeBoolean(in PRBool aBoolean);
00059 
00060     void write8(in PRUint8 aByte);
00061     void write16(in PRUint16 a16);
00062     void write32(in PRUint32 a32);
00063     void write64(in PRUint64 a64);
00064 
00065     void writeFloat(in float aFloat);
00066     void writeDouble(in double aDouble);
00067 
00071     void writeStringZ(in string aString);
00072 
00076     void writeWStringZ(in wstring aString);
00077 
00082     void writeUtf8Z(in wstring aString);
00083 
00087     void writeBytes([size_is(aLength)] in string aString, in PRUint32 aLength);
00088 
00092     void writeByteArray([array, size_is(aLength)] in PRUint8 aBytes,
00093                         in PRUint32 aLength);
00094 
00095 };
00096 
00097 %{C++
00098 
00099 inline nsresult
00100 NS_WriteOptionalStringZ(nsIBinaryOutputStream* aStream, const char* aString)
00101 {
00102     PRBool nonnull = (aString != nsnull);
00103     nsresult rv = aStream->WriteBoolean(nonnull);
00104     if (NS_SUCCEEDED(rv) && nonnull)
00105         rv = aStream->WriteStringZ(aString);
00106     return rv;
00107 }
00108 
00109 inline nsresult
00110 NS_WriteOptionalWStringZ(nsIBinaryOutputStream* aStream, const PRUnichar* aString)
00111 {
00112     PRBool nonnull = (aString != nsnull);
00113     nsresult rv = aStream->WriteBoolean(nonnull);
00114     if (NS_SUCCEEDED(rv) && nonnull)
00115         rv = aStream->WriteWStringZ(aString);
00116     return rv;
00117 }
00118 
00119 %}