| 1 | /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|---|
| 2 | /* ***** BEGIN LICENSE BLOCK *****
|
|---|
| 3 | * Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|---|
| 4 | *
|
|---|
| 5 | * The contents of this file are subject to the Mozilla Public License Version
|
|---|
| 6 | * 1.1 (the "License"); you may not use this file except in compliance with
|
|---|
| 7 | * the License. You may obtain a copy of the License at
|
|---|
| 8 | * http://www.mozilla.org/MPL/
|
|---|
| 9 | *
|
|---|
| 10 | * Software distributed under the License is distributed on an "AS IS" basis,
|
|---|
| 11 | * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|---|
| 12 | * for the specific language governing rights and limitations under the
|
|---|
| 13 | * License.
|
|---|
| 14 | *
|
|---|
| 15 | * The Original Code is Mozilla FastLoad code.
|
|---|
| 16 | *
|
|---|
| 17 | * The Initial Developer of the Original Code is
|
|---|
| 18 | * Netscape Communications Corporation.
|
|---|
| 19 | * Portions created by the Initial Developer are Copyright (C) 2001
|
|---|
| 20 | * the Initial Developer. All Rights Reserved.
|
|---|
| 21 | *
|
|---|
| 22 | * Contributor(s):
|
|---|
| 23 | * Brendan Eich <[email protected]> (original author)
|
|---|
| 24 | *
|
|---|
| 25 | * Alternatively, the contents of this file may be used under the terms of
|
|---|
| 26 | * either of the GNU General Public License Version 2 or later (the "GPL"),
|
|---|
| 27 | * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|---|
| 28 | * in which case the provisions of the GPL or the LGPL are applicable instead
|
|---|
| 29 | * of those above. If you wish to allow use of your version of this file only
|
|---|
| 30 | * under the terms of either the GPL or the LGPL, and not to allow others to
|
|---|
| 31 | * use your version of this file under the terms of the MPL, indicate your
|
|---|
| 32 | * decision by deleting the provisions above and replace them with the notice
|
|---|
| 33 | * and other provisions required by the GPL or the LGPL. If you do not delete
|
|---|
| 34 | * the provisions above, a recipient may use your version of this file under
|
|---|
| 35 | * the terms of any one of the MPL, the GPL or the LGPL.
|
|---|
| 36 | *
|
|---|
| 37 | * ***** END LICENSE BLOCK ***** */
|
|---|
| 38 |
|
|---|
| 39 | #include "nsIBinaryInputStream.idl"
|
|---|
| 40 | #include "nsrootidl.idl"
|
|---|
| 41 |
|
|---|
| 42 | /**
|
|---|
| 43 | * @see nsIObjectOutputStream
|
|---|
| 44 | * @see nsIBinaryInputStream
|
|---|
| 45 | */
|
|---|
| 46 |
|
|---|
| 47 | [scriptable, uuid(6c248606-4eae-46fa-9df0-ba58502368eb)]
|
|---|
| 48 | interface nsIObjectInputStream : nsIBinaryInputStream
|
|---|
| 49 | {
|
|---|
| 50 | /**
|
|---|
| 51 | * Read an object from this stream to satisfy a strong or weak reference
|
|---|
| 52 | * to one of its interfaces. If the interface was not along the primary
|
|---|
| 53 | * inheritance chain ending in the "root" or XPCOM-identity nsISupports,
|
|---|
| 54 | * readObject will QueryInterface from the deserialized object root to the
|
|---|
| 55 | * correct interface, which was specified when the object was serialized.
|
|---|
| 56 | *
|
|---|
| 57 | * @see nsIObjectOutputStream
|
|---|
| 58 | */
|
|---|
| 59 | nsISupports readObject(in PRBool aIsStrongRef);
|
|---|
| 60 |
|
|---|
| 61 | [notxpcom] nsresult readID(out nsID aID);
|
|---|
| 62 |
|
|---|
| 63 | /**
|
|---|
| 64 | * Optimized deserialization support -- see nsIStreamBufferAccess.idl.
|
|---|
| 65 | */
|
|---|
| 66 | [notxpcom] charPtr getBuffer(in PRUint32 aLength, in PRUint32 aAlignMask);
|
|---|
| 67 | [notxpcom] void putBuffer(in charPtr aBuffer, in PRUint32 aLength);
|
|---|
| 68 | };
|
|---|
| 69 |
|
|---|
| 70 | %{C++
|
|---|
| 71 |
|
|---|
| 72 | inline nsresult
|
|---|
| 73 | NS_ReadOptionalObject(nsIObjectInputStream* aStream, PRBool aIsStrongRef,
|
|---|
| 74 | nsISupports* *aResult)
|
|---|
| 75 | {
|
|---|
| 76 | PRBool nonnull;
|
|---|
| 77 | nsresult rv = aStream->ReadBoolean(&nonnull);
|
|---|
| 78 | if (NS_SUCCEEDED(rv)) {
|
|---|
| 79 | if (nonnull)
|
|---|
| 80 | rv = aStream->ReadObject(aIsStrongRef, aResult);
|
|---|
| 81 | else
|
|---|
| 82 | *aResult = nsnull;
|
|---|
| 83 | }
|
|---|
| 84 | return rv;
|
|---|
| 85 | }
|
|---|
| 86 |
|
|---|
| 87 | %}
|
|---|
