mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-01 14:45:29 +00:00
89 lines
3.1 KiB
Plaintext
89 lines
3.1 KiB
Plaintext
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* ***** 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 code.
|
|
*
|
|
* The Initial Developer of the Original Code is Robert Sayre.
|
|
* Portions created by the Initial Developer are Copyright (C) 2006
|
|
* 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 "nsIStreamListener.idl"
|
|
|
|
interface nsIURI;
|
|
interface nsIFeedResultListener;
|
|
interface nsIInputStream;
|
|
|
|
/**
|
|
* An nsIFeedProcessor parses feeds, triggering callbacks based on
|
|
* their contents.
|
|
*/
|
|
[scriptable, uuid(8a0b2908-21b0-45d7-b14d-30df0f92afc7)]
|
|
interface nsIFeedProcessor : nsIStreamListener {
|
|
|
|
/**
|
|
* The listener that will respond to feed events.
|
|
*/
|
|
attribute nsIFeedResultListener listener;
|
|
|
|
// Level is where to listen for the extension, a constant: FEED,
|
|
// ENTRY, BOTH.
|
|
//
|
|
// XXX todo void registerExtensionHandler(in
|
|
// nsIFeedExtensionHandler, in long level);
|
|
|
|
/**
|
|
* Parse a feed from an nsIInputStream.
|
|
*
|
|
* @param stream The input stream.
|
|
* @param uri The base URI.
|
|
*/
|
|
void parseFromStream(in nsIInputStream stream, in nsIURI uri);
|
|
|
|
/**
|
|
* Parse a feed from a string.
|
|
*
|
|
* @param str The string to parse.
|
|
* @param uri The base URI.
|
|
*/
|
|
void parseFromString(in AString str, in nsIURI uri);
|
|
|
|
/**
|
|
* Parse a feed asynchronously. The caller must then call the
|
|
* nsIFeedProcessor's nsIStreamListener methods to drive the
|
|
* parse. Do not call the other parse methods during an asynchronous
|
|
* parse.
|
|
*
|
|
* @param requestObserver The observer to notify on start/stop. This
|
|
* argument can be null.
|
|
* @param uri The base URI.
|
|
*/
|
|
void parseAsync(in nsIRequestObserver requestObserver, in nsIURI uri);
|
|
};
|