summaryrefslogtreecommitdiffstats
path: root/parser/xml/nsISAXErrorHandler.idl
diff options
context:
space:
mode:
authorMatt A. Tobin <mattatobin@localhost.localdomain>2018-02-02 04:16:08 -0500
committerMatt A. Tobin <mattatobin@localhost.localdomain>2018-02-02 04:16:08 -0500
commit5f8de423f190bbb79a62f804151bc24824fa32d8 (patch)
tree10027f336435511475e392454359edea8e25895d /parser/xml/nsISAXErrorHandler.idl
parent49ee0794b5d912db1f95dce6eb52d781dc210db5 (diff)
downloadUXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.gz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.lz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.xz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.zip
Add m-esr52 at 52.6.0
Diffstat (limited to 'parser/xml/nsISAXErrorHandler.idl')
-rw-r--r--parser/xml/nsISAXErrorHandler.idl95
1 files changed, 95 insertions, 0 deletions
diff --git a/parser/xml/nsISAXErrorHandler.idl b/parser/xml/nsISAXErrorHandler.idl
new file mode 100644
index 000000000..ea8af79ce
--- /dev/null
+++ b/parser/xml/nsISAXErrorHandler.idl
@@ -0,0 +1,95 @@
+/* -*- 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 nsISAXLocator;
+
+/**
+ * Basic interface for SAX error handlers.
+ *
+ * If a SAX application needs to implement customized error
+ * handling, it must implement this interface and then register an
+ * instance with the XML reader. The parser will then report all
+ * errors and warnings through this interface.
+ *
+ * WARNING: If an application does not register an ErrorHandler,
+ * XML parsing errors will go unreported. In order to detect validity
+ * errors, an ErrorHandler that does something with error() calls must
+ * be registered.
+ *
+ */
+[scriptable, uuid(e02b6693-6cca-11da-be43-001422106990)]
+interface nsISAXErrorHandler: nsISupports {
+
+ /**
+ * Receive notification of a recoverable error.
+ *
+ * This corresponds to the definition of "error" in section 1.2
+ * of the W3C XML 1.0 Recommendation. For example, a validating
+ * parser would use this callback to report the violation of a
+ * validity constraint. The default behaviour is to take no
+ * action.
+ *
+ * The SAX parser must continue to provide normal parsing events
+ * after invoking this method: it should still be possible for the
+ * application to process the document through to the end. If the
+ * application cannot do so, then the parser should report a fatal
+ * error even if the XML recommendation does not require it to do
+ * so.
+ *
+ * Filters may use this method to report other, non-XML errors as
+ * well.
+ *
+ * @param locator The locator object for the error (may be null).
+ * @param error The error message.
+ */
+ void error(in nsISAXLocator locator, in AString error);
+
+ /**
+ * Receive notification of a non-recoverable error.
+ *
+ * There is an apparent contradiction between the documentation
+ * for this method and the documentation for
+ * ContentHandler.endDocument(). Until this ambiguity is resolved in
+ * a future major release, clients should make no assumptions about
+ * whether endDocument() will or will not be invoked when the parser
+ * has reported a fatalError() or thrown an exception.
+ *
+ * This corresponds to the definition of "fatal error" in section
+ * 1.2 of the W3C XML 1.0 Recommendation. For example, a parser
+ * would use this callback to report the violation of a
+ * well-formedness constraint.
+ *
+ * The application must assume that the document is unusable
+ * after the parser has invoked this method, and should continue (if
+ * at all) only for the sake of collecting additional error
+ * messages: in fact, SAX parsers are free to stop reporting any
+ * other events once this method has been invoked.
+ *
+ * @param locator The locator object for the error (may be null).
+ * @param error The error message.
+ */
+ void fatalError(in nsISAXLocator locator, in AString error);
+
+ /**
+ * Receive notification of a warning.
+ *
+ * SAX parsers will use this method to report conditions that are
+ * not errors or fatal errors as defined by the XML
+ * recommendation. The default behaviour is to take no action.
+ *
+ * The SAX parser must continue to provide normal parsing events
+ * after invoking this method: it should still be possible for the
+ * application to process the document through to the end.
+ *
+ * Filters may use this method to report other, non-XML warnings
+ * as well.
+ *
+ * @param locator The locator object for the warning (may be null).
+ * @param error The warning message.
+ */
+ void ignorableWarning(in nsISAXLocator locator, in AString error);
+};