| /* -*- Mode: C++; tab-width: 2; 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 |
| * 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 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" |
| |
| interface nsIInputStream; |
| interface nsIDOMDocument; |
| interface nsIURI; |
| interface nsIPrincipal; |
| interface nsIScriptGlobalObject; |
| |
| /** |
| * The nsIDOMParser interface is a non-SAX interface that can be used |
| * to parse a string or byte stream containing XML or HTML content |
| * to a DOM document. Parsing is always synchronous - a document is always |
| * returned from the parsing methods. This is as opposed to loading and |
| * parsing with the XMLHttpRequest interface, which can be used for |
| * asynchronous (callback-based) loading. |
| */ |
| [scriptable, uuid(5677f36e-1842-4c6f-a39c-2e5576ab8b40)] |
| interface nsIDOMParser : nsISupports |
| { |
| /** |
| * The string passed in is parsed into a DOM document. |
| * |
| * @param str The UTF16 string to be parsed |
| * @param contentType The content type of the string (see parseFromStream) |
| * @returns The DOM document created as a result of parsing the |
| * string |
| */ |
| nsIDOMDocument parseFromString(in wstring str, in string contentType); |
| |
| /** |
| * The buffer is parsed into a DOM document. |
| * The charset is determined from the xml entity decl. |
| * |
| * @param buf The octet array data to be parsed |
| * @param bufLen Length (in bytes) of the data |
| * @param contentType The content type of the data (see parseFromStream) |
| * @returns The DOM document created as a result of parsing the |
| * string |
| */ |
| nsIDOMDocument parseFromBuffer([const,array,size_is(bufLen)] in octet buf, |
| in PRUint32 bufLen, in string contentType); |
| |
| /** |
| * The byte stream passed in is parsed into a DOM document. |
| * |
| * Not accessible from web content. |
| * |
| * @param stream The byte stream whose contents are parsed |
| * @param charset The character set that was used to encode the byte |
| * stream. NULL if not specified. |
| * @param contentLength The number of bytes in the input stream. |
| * @param contentType The content type of the string - either text/xml, |
| * application/xml, or application/xhtml+xml. |
| * Must not be NULL. |
| * @returns The DOM document created as a result of parsing the |
| * stream |
| */ |
| nsIDOMDocument parseFromStream(in nsIInputStream stream, |
| in string charset, |
| in long contentLength, |
| in string contentType); |
| |
| /** |
| * Initialize the principal and document and base URIs that the parser should |
| * use for documents it creates. If this is not called, then a null |
| * principal and its URI will be used. When creating a DOMParser via the JS |
| * constructor, this will be called automatically. This method may only be |
| * called once. If this method fails, all following parse attempts will |
| * fail. |
| * |
| * @param principal The principal to use for documents we create. |
| * If this is null, a codebase principal will be created |
| * based on documentURI; in that case the documentURI must |
| * be non-null. |
| * @param documentURI The documentURI to use for the documents we create. |
| * If null, the principal's URI will be used; |
| * in that case, the principal must be non-null and its |
| * URI must be non-null. |
| * @param baseURI The baseURI to use for the documents we create. |
| * If null, the documentURI will be used. |
| * @param scriptObject The object from which the context for event handling |
| * can be got. |
| */ |
| [noscript] void init(in nsIPrincipal principal, |
| in nsIURI documentURI, |
| in nsIURI baseURI, |
| in nsIScriptGlobalObject scriptObject); |
| }; |
| |
| /** |
| * The nsIDOMParserJS interface provides a scriptable way of calling init(). |
| * Do NOT use this interface from languages other than JavaScript. |
| */ |
| [scriptable, uuid(dca92fe9-ae7a-44b7-80aa-d151216698ac)] |
| interface nsIDOMParserJS : nsISupports |
| { |
| /** |
| * Just like nsIDOMParser.init, but callable from JS. It'll pick up the args |
| * from XPConnect. |
| */ |
| void init(); |
| }; |
| |
| %{ C++ |
| #define NS_DOMPARSER_CID \ |
| { /* 3a8a3a50-512c-11d4-9a54-000064657374 */ \ |
| 0x3a8a3a50, 0x512c, 0x11d4, \ |
| {0x9a, 0x54, 0x00, 0x00, 0x64, 0x65, 0x73, 0x74} } |
| #define NS_DOMPARSER_CONTRACTID \ |
| "@mozilla.org/xmlextras/domparser;1" |
| %} |