1 /* -*- Mode: C++; tab-width: 8; 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 Robert Sayre.
18 * Portions created by the Initial Developer are Copyright (C) 2006
19 * the Initial Developer. All Rights Reserved.
20 *
21 * Contributor(s):
22 *
23 * Alternatively, the contents of this file may be used under the terms of
24 * either the GNU General Public License Version 2 or later (the "GPL"), or
25 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
26 * in which case the provisions of the GPL or the LGPL are applicable instead
27 * of those above. If you wish to allow use of your version of this file only
28 * under the terms of either the GPL or the LGPL, and not to allow others to
29 * use your version of this file under the terms of the MPL, indicate your
30 * decision by deleting the provisions above and replace them with the notice
31 * and other provisions required by the GPL or the LGPL. If you do not delete
32 * the provisions above, a recipient may use your version of this file under
33 * the terms of any one of the MPL, the GPL or the LGPL.
34 *
35 * ***** END LICENSE BLOCK ***** */
36
37 #include "nsIStreamListener.idl"
38
39 interface nsIURI;
40 interface nsIFeedResultListener;
41 interface nsIInputStream;
42
43 /**
44 * An nsIFeedProcessor parses feeds, triggering callbacks based on
45 * their contents.
46 */
47 [scriptable, uuid(8a0b2908-21b0-45d7-b14d-30df0f92afc7)]
48 interface nsIFeedProcessor : nsIStreamListener {
49
50 /**
51 * The listener that will respond to feed events.
52 */
53 attribute nsIFeedResultListener listener;
54
55 // Level is where to listen for the extension, a constant: FEED,
56 // ENTRY, BOTH.
57 //
58 // XXX todo void registerExtensionHandler(in
59 // nsIFeedExtensionHandler, in long level);
60
61 /**
62 * Parse a feed from an nsIInputStream.
63 *
64 * @param stream The input stream.
65 * @param uri The base URI.
66 */
67 void parseFromStream(in nsIInputStream stream, in nsIURI uri);
68
69 /**
70 * Parse a feed from a string.
71 *
72 * @param str The string to parse.
73 * @param uri The base URI.
74 */
75 void parseFromString(in AString str, in nsIURI uri);
76
77 /**
78 * Parse a feed asynchronously. The caller must then call the
79 * nsIFeedProcessor's nsIStreamListener methods to drive the
80 * parse. Do not call the other parse methods during an asynchronous
81 * parse.
82 *
83 * @param requestObserver The observer to notify on start/stop. This
84 * argument can be null.
85 * @param uri The base URI.
86 */
87 void parseAsync(in nsIRequestObserver requestObserver, in nsIURI uri);
88 };