mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-01 06:35:42 +00:00
2e7e16befb
nsIConverterInputStream scriptable, and adds nsIUnicharOutputStream and nsIConverterOutputStream (together with implementations). r=jshin sr=darin a=chofmann
80 lines
2.9 KiB
Plaintext
80 lines
2.9 KiB
Plaintext
/* vim:set expandtab ts=4 sw=4 sts=4 cin: */
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
*
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
* the License. You may obtain a copy of the License at
|
|
* http://www.mozilla.org/MPL/
|
|
*
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
* for the specific language governing rights and limitations under the
|
|
* License.
|
|
*
|
|
* The Original Code is mozilla.org unicode stream converter code.
|
|
*
|
|
* The Initial Developer of the Original Code is
|
|
* Christian Biesinger <cbiesinger@web.de>.
|
|
* Portions created by the Initial Developer are Copyright (C) 2005
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
*
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
|
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
* use your version of this file under the terms of the MPL, indicate your
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
* the provisions above, a recipient may use your version of this file under
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
*
|
|
* ***** END LICENSE BLOCK ***** */
|
|
|
|
#include "nsISupports.idl"
|
|
|
|
/**
|
|
* An interface that allows writing unicode data.
|
|
*/
|
|
[scriptable, uuid(2d00b1bb-8b21-4a63-bcc6-7213f513ac2e)]
|
|
interface nsIUnicharOutputStream : nsISupports
|
|
{
|
|
/**
|
|
* Write a single character to the stream. When writing many characters,
|
|
* prefer the string-taking write method.
|
|
*
|
|
* @retval true The character was written successfully
|
|
* @retval false Not all bytes of the character could be written.
|
|
*/
|
|
boolean write(in unsigned long aCount,
|
|
[const, array, size_is(aCount)] in PRUnichar c);
|
|
|
|
/**
|
|
* Write a string to the stream.
|
|
*
|
|
* @retval true The string was written successfully
|
|
* @retval false Not all bytes of the string could be written.
|
|
*/
|
|
boolean writeString(in AString str);
|
|
|
|
/**
|
|
* Flush the stream. This finishes the conversion and writes any bytes that
|
|
* finish the current byte sequence.
|
|
*
|
|
* It does NOT flush the underlying stream.
|
|
*
|
|
* @see nsIUnicodeEncoder::Finish
|
|
*/
|
|
void flush();
|
|
|
|
/**
|
|
* Close the stream and free associated resources. This also closes the
|
|
* underlying stream.
|
|
*/
|
|
void close();
|
|
};
|