Adding upstream version 110.0.1.upstream/110.0.1upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 186 insertions, 0 deletions

diff --git a/parser/htmlparser/nsIParser.h b/parser/htmlparser/nsIParser.h
new file mode 100644
index 0000000000..8cf3940ffb
--- /dev/null
+++ b/parser/htmlparser/nsIParser.h
@@ -0,0 +1,186 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim: set ts=2 sw=2 et tw=78: */
+/* 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/. */
+#ifndef NS_IPARSER___
+#define NS_IPARSER___
+
+/**
+ * This GECKO-INTERNAL interface is on track to being REMOVED (or refactored
+ * to the point of being near-unrecognizable).
+ *
+ * Please DO NOT #include this file in comm-central code, in your XULRunner
+ * app or binary extensions.
+ *
+ * Please DO NOT #include this into new files even inside Gecko. It is more
+ * likely than not that #including this header is the wrong thing to do.
+ */
+
+#include "nsISupports.h"
+#include "nsIStreamListener.h"
+#include "nsIDTD.h"
+#include "nsString.h"
+#include "nsTArray.h"
+#include "nsAtom.h"
+#include "nsParserBase.h"
+#include "mozilla/NotNull.h"
+
+#define NS_IPARSER_IID                               \
+  {                                                  \
+    0x2c4ad90a, 0x740e, 0x4212, {                    \
+      0xba, 0x3f, 0xfe, 0xac, 0xda, 0x4b, 0x92, 0x9e \
+    }                                                \
+  }
+
+class nsIContentSink;
+class nsIRequestObserver;
+class nsIURI;
+class nsIChannel;
+namespace mozilla {
+class Encoding;
+}
+
+enum eParserCommands { eViewNormal, eViewSource, eViewFragment, eViewErrors };
+
+enum eParserDocType { eUnknown = 0, eXML, eHTML_Quirks, eHTML_Strict };
+
+enum eStreamState { eNone, eOnStart, eOnDataAvail, eOnStop };
+
+/**
+ * This GECKO-INTERNAL interface is on track to being REMOVED (or refactored
+ * to the point of being near-unrecognizable).
+ *
+ * Please DO NOT #include this file in comm-central code, in your XULRunner
+ * app or binary extensions.
+ *
+ * Please DO NOT #include this into new files even inside Gecko. It is more
+ * likely than not that #including this header is the wrong thing to do.
+ */
+class nsIParser : public nsParserBase {
+ protected:
+  using Encoding = mozilla::Encoding;
+  template <typename T>
+  using NotNull = mozilla::NotNull<T>;
+
+ public:
+  NS_DECLARE_STATIC_IID_ACCESSOR(NS_IPARSER_IID)
+
+  /**
+   * Select given content sink into parser for parser output
+   * @update	gess5/11/98
+   * @param   aSink is the new sink to be used by parser
+   * @return
+   */
+  NS_IMETHOD_(void) SetContentSink(nsIContentSink* aSink) = 0;
+
+  /**
+   * retrieve the sink set into the parser
+   * @update	gess5/11/98
+   * @return  current sink
+   */
+  NS_IMETHOD_(nsIContentSink*) GetContentSink(void) = 0;
+
+  /**
+   *  Call this method once you've created a parser, and want to instruct it
+   *  about the command which caused the parser to be constructed. For example,
+   *  this allows us to select a DTD which can do, say, view-source.
+   *
+   *  @update  gess 3/25/98
+   *  @param   aCommand -- ptrs to string that contains command
+   *  @return	 nada
+   */
+  NS_IMETHOD_(void) GetCommand(nsCString& aCommand) = 0;
+  NS_IMETHOD_(void) SetCommand(const char* aCommand) = 0;
+  NS_IMETHOD_(void) SetCommand(eParserCommands aParserCommand) = 0;
+
+  /**
+   *  Call this method once you've created a parser, and want to instruct it
+   *  about what charset to load
+   *
+   *  @update  ftang 4/23/99
+   *  @param   aCharset- the charest of a document
+   *  @param   aCharsetSource- the soure of the chares
+   *  @param   aForceAutoDetection- whether Repair Text Encoding menu item was
+   * invoked
+   *  @return	 nada
+   */
+  virtual void SetDocumentCharset(NotNull<const Encoding*> aCharset,
+                                  int32_t aSource,
+                                  bool aForceAutoDetection = false) = 0;
+
+  /**
+   * Get the nsIStreamListener for this parser
+   */
+  virtual nsIStreamListener* GetStreamListener() = 0;
+
+  /**************************************************************************
+   *  Parse methods always begin with an input source, and perform
+   *  conversions until you wind up being emitted to the given contentsink
+   *  (which may or may not be a proxy for the NGLayout content model).
+   ************************************************************************/
+
+  // Call this method to resume the parser from an unblocked state.
+  // This can happen, for example, if parsing was interrupted and then the
+  // consumer needed to restart the parser without waiting for more data.
+  // This also happens after loading scripts, which unblock the parser in
+  // order to process the output of document.write() and then need to
+  // continue on with the page load on an enabled parser.
+  NS_IMETHOD ContinueInterruptedParsing() = 0;
+
+  // Stops parsing temporarily.
+  NS_IMETHOD_(void) BlockParser() = 0;
+
+  // Open up the parser for tokenization, building up content
+  // model..etc. However, this method does not resume parsing
+  // automatically. It's the callers' responsibility to restart
+  // the parsing engine.
+  NS_IMETHOD_(void) UnblockParser() = 0;
+
+  /**
+   * Asynchronously continues parsing.
+   */
+  NS_IMETHOD_(void) ContinueInterruptedParsingAsync() = 0;
+
+  NS_IMETHOD_(bool) IsParserEnabled() override = 0;
+  NS_IMETHOD_(bool) IsComplete() = 0;
+
+  NS_IMETHOD Parse(nsIURI* aURL) = 0;
+
+  NS_IMETHOD Terminate(void) = 0;
+
+  /**
+   * True if the insertion point (per HTML5) is defined.
+   */
+  virtual bool IsInsertionPointDefined() = 0;
+
+  /**
+   * Call immediately before starting to evaluate a parser-inserted script or
+   * in general when the spec says to increment the script nesting level.
+   */
+  virtual void IncrementScriptNestingLevel() = 0;
+
+  /**
+   * Call immediately after having evaluated a parser-inserted script or
+   * generally want to restore to the state before the last
+   * IncrementScriptNestingLevel call.
+   */
+  virtual void DecrementScriptNestingLevel() = 0;
+
+  /**
+   * True if this is an HTML5 parser whose script nesting level (in
+   * the sense of
+   * <https://html.spec.whatwg.org/multipage/parsing.html#script-nesting-level>)
+   * is nonzero.
+   */
+  virtual bool HasNonzeroScriptNestingLevel() const = 0;
+
+  /**
+   * True if this is a script-created HTML5 parser.
+   */
+  virtual bool IsScriptCreated() = 0;
+};
+
+NS_DEFINE_STATIC_IID_ACCESSOR(nsIParser, NS_IPARSER_IID)
+
+#endif