95 lines
3.9 KiB
Plaintext
95 lines
3.9 KiB
Plaintext
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
|
* Version: NPL 1.1/GPL 2.0/LGPL 2.1
|
|
*
|
|
* The contents of this file are subject to the Netscape 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/NPL/
|
|
*
|
|
* 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 code.
|
|
*
|
|
* The Initial Developer of the Original Code is
|
|
* Netscape Communications Corporation.
|
|
* Portions created by the Initial Developer are Copyright (C) 1998
|
|
* 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 NPL, 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 NPL, the GPL or the LGPL.
|
|
*
|
|
* ***** END LICENSE BLOCK ***** */
|
|
|
|
#include "nsIInputStream.idl"
|
|
|
|
interface nsIBuffer;
|
|
|
|
%{C++
|
|
/**
|
|
* The signature of the writer function passed to ReadSegments. This
|
|
* specifies where the data should go that gets read from the buffer.
|
|
* Implementers should return the following:
|
|
* @return NS_OK and writeCount - if successfully wrote something
|
|
* @return NS_BASE_STREAM_CLOSED - if no more can be written
|
|
* @return NS_BASE_STREAM_WOULD_BLOCK - if there is currently space to write (in
|
|
* a non-blocking mode)
|
|
* @return <other-error> - on failure
|
|
*/
|
|
typedef NS_CALLBACK(nsWriteSegmentFun)(void* closure,
|
|
const char* fromRawSegment,
|
|
PRUint32 toOffset,
|
|
PRUint32 count,
|
|
PRUint32 *writeCount);
|
|
%}
|
|
|
|
// native nsWriteSegmentFun(nsWriteSegmentFun);
|
|
|
|
[scriptable, uuid(93e9a230-1955-11d3-933b-000064657374)]
|
|
interface nsIBufferInputStream : nsIInputStream
|
|
{
|
|
/**
|
|
* Returns the buffer underlying this input stream.
|
|
*/
|
|
readonly attribute nsIBuffer Buffer;
|
|
|
|
|
|
[noscript] unsigned long ReadSegments(in nsWriteSegmentFun writer,
|
|
in voidPtr closure,
|
|
in unsigned long count);
|
|
|
|
/**
|
|
* Searches for a string in the input stream. Since the stream has a notion
|
|
* of EOF, it is possible that the string may at some time be in the
|
|
* buffer, but is is not currently found up to some offset. Consequently,
|
|
* both the found and not found cases return an offset:
|
|
* if found, return offset where it was found
|
|
* if not found, return offset of the first byte not searched
|
|
* In the case the stream is at EOF and the string is not found, the first
|
|
* byte not searched will correspond to the length of the buffer.
|
|
*/
|
|
void Search(in string forString,
|
|
in boolean ignoreCase,
|
|
out boolean found,
|
|
out unsigned long offsetSearchedTo);
|
|
|
|
/**
|
|
* Set this attribute to put the stream in non-blocking mode.
|
|
*/
|
|
attribute boolean NonBlocking;
|
|
};
|