summaryrefslogtreecommitdiffstats
path: root/dom/base/nsIDOMParser.idl
diff options
context:
space:
mode:
Diffstat (limited to 'dom/base/nsIDOMParser.idl')
-rw-r--r--dom/base/nsIDOMParser.idl102
1 files changed, 102 insertions, 0 deletions
diff --git a/dom/base/nsIDOMParser.idl b/dom/base/nsIDOMParser.idl
new file mode 100644
index 000000000..370eaa27b
--- /dev/null
+++ b/dom/base/nsIDOMParser.idl
@@ -0,0 +1,102 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#include "nsISupports.idl"
+
+interface nsIInputStream;
+interface nsIDOMDocument;
+interface nsIURI;
+interface nsIPrincipal;
+interface nsIGlobalObject;
+
+/**
+ * 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.
+ */
+[uuid(70b9600e-8622-4c93-9ad8-22c28058dc44)]
+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 uint32_t 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 nsIGlobalObject scriptObject);
+};
+
+%{ 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"
+%}