xpcom/io/nsIConverterInputStream.idl

   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.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
  38 #include "nsIUnicharInputStream.idl"
  39
  40 interface nsIInputStream;
  41
  42 /**
  43  * A unichar input stream that wraps an input stream.
  44  * This allows reading unicode strings from a stream, automatically converting
  45  * the bytes from a selected character encoding.
  46  */
  47 [scriptable, uuid(FC66FFB6-5404-4908-A4A3-27F92FA0579D)]
  48 interface nsIConverterInputStream : nsIUnicharInputStream {
  49     /**
  50      * Default replacement char value, U+FFFD REPLACEMENT CHARACTER.
  51      */
  52     const PRUnichar DEFAULT_REPLACEMENT_CHARACTER = 0xFFFD;
  53
  54     /**
  55      * Initialize this stream.
  56      * @param aStream
  57      *        The underlying stream to read from.
  58      * @param aCharset
  59      *        The character encoding to use for converting the bytes of the
  60      *        stream. A null charset will be interpreted as UTF-8.
  61      * @param aBufferSize
  62      *        How many bytes to buffer.
  63      * @param aReplacementChar
  64      *        The character to replace unknown byte sequences in the stream
  65      *        with. The standard replacement character is U+FFFD.
  66      *        A value of 0x0000 will cause an exception to be thrown if unknown
  67      *        byte sequences are encountered in the stream.
  68      */
  69     void init (in nsIInputStream aStream, in string aCharset,
  70                in long aBufferSize, in PRUnichar aReplacementChar);
  71 };
  72