| 1 | /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|---|
| 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.org 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) 1998
|
|---|
| 20 | * the Initial Developer. All Rights Reserved.
|
|---|
| 21 | *
|
|---|
| 22 | * Contributor(s):
|
|---|
| 23 | *
|
|---|
| 24 | * Alternatively, the contents of this file may be used under the terms of
|
|---|
| 25 | * either of the GNU General Public License Version 2 or later (the "GPL"),
|
|---|
| 26 | * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|---|
| 27 | * in which case the provisions of the GPL or the LGPL are applicable instead
|
|---|
| 28 | * of those above. If you wish to allow use of your version of this file only
|
|---|
| 29 | * under the terms of either the GPL or the LGPL, and not to allow others to
|
|---|
| 30 | * use your version of this file under the terms of the MPL, indicate your
|
|---|
| 31 | * decision by deleting the provisions above and replace them with the notice
|
|---|
| 32 | * and other provisions required by the GPL or the LGPL. If you do not delete
|
|---|
| 33 | * the provisions above, a recipient may use your version of this file under
|
|---|
| 34 | * the terms of any one of the MPL, the GPL or the LGPL.
|
|---|
| 35 | *
|
|---|
| 36 | * ***** END LICENSE BLOCK ***** */
|
|---|
| 37 | #ifndef nsIUnicharInputStream_h___
|
|---|
| 38 | #define nsIUnicharInputStream_h___
|
|---|
| 39 |
|
|---|
| 40 | #include "nsIInputStream.h"
|
|---|
| 41 | #include "nsString.h"
|
|---|
| 42 | #include "nscore.h"
|
|---|
| 43 |
|
|---|
| 44 | class nsIUnicharInputStream;
|
|---|
| 45 |
|
|---|
| 46 | typedef NS_CALLBACK(nsWriteUnicharSegmentFun)(nsIUnicharInputStream *aInStream,
|
|---|
| 47 | void *aClosure,
|
|---|
| 48 | const PRUnichar *aFromSegment,
|
|---|
| 49 | PRUint32 aToOffset,
|
|---|
| 50 | PRUint32 aCount,
|
|---|
| 51 | PRUint32 *aWriteCount);
|
|---|
| 52 | /* c4bcf6ee-3a79-4d77-8d48-f17be3199b3b */
|
|---|
| 53 | #define NS_IUNICHAR_INPUT_STREAM_IID \
|
|---|
| 54 | { 0xc4bcf6ee, 0x3a79, 0x4d77, \
|
|---|
| 55 | {0x8d, 0x48, 0xf1, 0x7b, 0xe3, 0x19, 0x9b, 0x3b} }
|
|---|
| 56 |
|
|---|
| 57 | /** Abstract unicode character input stream
|
|---|
| 58 | * @see nsIInputStream
|
|---|
| 59 | */
|
|---|
| 60 | class NS_NO_VTABLE nsIUnicharInputStream : public nsISupports {
|
|---|
| 61 | public:
|
|---|
| 62 | NS_DEFINE_STATIC_IID_ACCESSOR(NS_IUNICHAR_INPUT_STREAM_IID)
|
|---|
| 63 |
|
|---|
| 64 | NS_IMETHOD Read(PRUnichar* aBuf,
|
|---|
| 65 | PRUint32 aCount,
|
|---|
| 66 | PRUint32 *aReadCount) = 0;
|
|---|
| 67 | NS_IMETHOD Close() = 0;
|
|---|
| 68 | NS_IMETHOD ReadSegments(nsWriteUnicharSegmentFun aWriter,
|
|---|
| 69 | void* aClosure,
|
|---|
| 70 | PRUint32 aCount,
|
|---|
| 71 | PRUint32 *aReadCount) = 0;
|
|---|
| 72 | };
|
|---|
| 73 |
|
|---|
| 74 | /**
|
|---|
| 75 | * Create a nsIUnicharInputStream that wraps up a string. Data is fed
|
|---|
| 76 | * from the string out until the done. When this object is destroyed
|
|---|
| 77 | * it destroyes the string (so make a copy if you don't want it doing
|
|---|
| 78 | * that)
|
|---|
| 79 | */
|
|---|
| 80 | extern NS_COM nsresult
|
|---|
| 81 | NS_NewStringUnicharInputStream(nsIUnicharInputStream** aInstancePtrResult,
|
|---|
| 82 | nsString* aString);
|
|---|
| 83 |
|
|---|
| 84 | /** Create a new nsUnicharInputStream that provides a converter for the
|
|---|
| 85 | * byte input stream aStreamToWrap. If no converter can be found then
|
|---|
| 86 | * nsnull is returned and the error code is set to
|
|---|
| 87 | * NS_INPUTSTREAM_NO_CONVERTER.
|
|---|
| 88 | */
|
|---|
| 89 | extern NS_COM nsresult
|
|---|
| 90 | NS_NewUTF8ConverterStream(nsIUnicharInputStream** aInstancePtrResult,
|
|---|
| 91 | nsIInputStream* aStreamToWrap,
|
|---|
| 92 | PRInt32 aBufferSize = 0);
|
|---|
| 93 |
|
|---|
| 94 | #endif /* nsUnicharInputStream_h___ */
|
|---|
