rdf/base/idl/nsIRDFXMLParser.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
   2  *
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is mozilla.org Code.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Netscape Communications Corporation.
  20  * Portions created by the Initial Developer are Copyright (C) 1999
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *   Chris Waterson <waterson@netscape.com>
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either of the GNU General Public License Version 2 or later (the "GPL"),
  28  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #include "nsISupports.idl"
  41 #include "nsIRDFDataSource.idl"
  42 #include "nsIStreamListener.idl"
  43 #include "nsIURI.idl"
  44
  45 [scriptable, uuid(1831dd2e-1dd2-11b2-bdb3-86b7b50b70b5)]
  46 interface nsIRDFXMLParser : nsISupports
  47 {
  48     /**
  49      * Create a stream listener that can be used to asynchronously
  50      * parse RDF/XML.
  51      * @param aSink the RDF datasource the will receive the data
  52      * @param aBaseURI the base URI used to resolve relative
  53      *   references in the RDF/XML
  54      * @return an nsIStreamListener object to handle the data
  55      */
  56     nsIStreamListener parseAsync(in nsIRDFDataSource aSink, in nsIURI aBaseURI);
  57
  58     /**
  59      * Parse a string of RDF/XML
  60      * @param aSink the RDF datasource that will receive the data
  61      * @param aBaseURI the base URI used to resolve relative
  62      *   references in the RDF/XML
  63      * @param aSource a UTF8 string containing RDF/XML data.
  64      */
  65     void parseString(in nsIRDFDataSource aSink, in nsIURI aBaseURI, in AUTF8String aSource);
  66 };