Back to index

lightning-sunbird  0.9+nobinonly
nsIObjectOutputStream.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 FastLoad code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 2001
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Brendan Eich <brendan@mozilla.org> (original author)
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 "nsIBinaryOutputStream.idl"
00040 #include "nsrootidl.idl"
00041 
00047 [scriptable, uuid(92c898ac-5fde-4b99-87b3-5d486422094b)]
00048 interface nsIObjectOutputStream : nsIBinaryOutputStream
00049 {
00064     void writeObject(in nsISupports aObject, in PRBool aIsStrongRef);
00065 
00071     void writeSingleRefObject(in nsISupports aObject);
00072 
00081     void writeCompoundObject(in nsISupports aObject,
00082                              in nsIIDRef aIID,
00083                              in PRBool aIsStrongRef);
00084 
00085     void writeID(in nsIDRef aID);
00086 
00090     [notxpcom] charPtr getBuffer(in PRUint32 aLength, in PRUint32 aAlignMask);
00091     [notxpcom] void    putBuffer(in charPtr aBuffer, in PRUint32 aLength);
00092 };
00093 
00094 %{C++
00095 
00096 inline nsresult
00097 NS_WriteOptionalObject(nsIObjectOutputStream* aStream, nsISupports* aObject,
00098                        PRBool aIsStrongRef)
00099 {
00100     PRBool nonnull = (aObject != nsnull);
00101     nsresult rv = aStream->WriteBoolean(nonnull);
00102     if (NS_SUCCEEDED(rv) && nonnull)
00103         rv = aStream->WriteObject(aObject, aIsStrongRef);
00104     return rv;
00105 }
00106 
00107 inline nsresult
00108 NS_WriteOptionalSingleRefObject(nsIObjectOutputStream* aStream,
00109                                 nsISupports* aObject)
00110 {
00111     PRBool nonnull = (aObject != nsnull);
00112     nsresult rv = aStream->WriteBoolean(nonnull);
00113     if (NS_SUCCEEDED(rv) && nonnull)
00114         rv = aStream->WriteSingleRefObject(aObject);
00115     return rv;
00116 }
00117 
00118 inline nsresult
00119 NS_WriteOptionalCompoundObject(nsIObjectOutputStream* aStream,
00120                                nsISupports* aObject,
00121                                const nsIID& aIID,
00122                                PRBool aIsStrongRef)
00123 {
00124     PRBool nonnull = (aObject != nsnull);
00125     nsresult rv = aStream->WriteBoolean(nonnull);
00126     if (NS_SUCCEEDED(rv) && nonnull)
00127         rv = aStream->WriteCompoundObject(aObject, aIID, aIsStrongRef);
00128     return rv;
00129 }
00130 
00131 %}