summaryrefslogtreecommitdiffstats
path: root/parser/htmlparser/nsIDTD.h
diff options
context:
space:
mode:
Diffstat (limited to 'parser/htmlparser/nsIDTD.h')
-rw-r--r--parser/htmlparser/nsIDTD.h88
1 files changed, 88 insertions, 0 deletions
diff --git a/parser/htmlparser/nsIDTD.h b/parser/htmlparser/nsIDTD.h
new file mode 100644
index 0000000000..67f7af4ec2
--- /dev/null
+++ b/parser/htmlparser/nsIDTD.h
@@ -0,0 +1,88 @@
+/* -*- Mode: C++; tab-width: 4; 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/. */
+
+#ifndef nsIDTD_h___
+#define nsIDTD_h___
+
+/**
+ * MODULE NOTES:
+ * @update gess 7/20/98
+ *
+ * This interface defines standard interface for DTD's. Note that this
+ * isn't HTML specific. DTD's have several functions within the parser
+ * system:
+ * 1) To coordinate the consumption of an input stream via the
+ * parser
+ * 2) To serve as proxy to represent the containment rules of the
+ * underlying document
+ * 3) To offer autodetection services to the parser (mainly for doc
+ * conversion)
+ * */
+
+#include "nsISupports.h"
+#include "nsString.h"
+
+#define NS_IDTD_IID \
+ { \
+ 0x3de05873, 0xefa7, 0x410d, { \
+ 0xa4, 0x61, 0x80, 0x33, 0xaf, 0xd9, 0xe3, 0x26 \
+ } \
+ }
+
+enum eAutoDetectResult {
+ eUnknownDetect,
+ ePrimaryDetect,
+};
+
+enum nsDTDMode {
+ eDTDMode_quirks, // pre 4.0 versions
+ eDTDMode_full_standards,
+ eDTDMode_autodetect
+};
+
+class nsIContentSink;
+class CParserContext;
+
+class nsIDTD : public nsISupports {
+ public:
+ NS_DECLARE_STATIC_IID_ACCESSOR(NS_IDTD_IID)
+
+ /**
+ * Called by the parser after the parsing process has concluded
+ */
+ virtual void DidBuildModel() = 0;
+
+ /**
+ * Called (possibly repeatedly) by the parser to parse tokens and construct
+ * the document model via the sink provided to WillBuildModel.
+ *
+ * @param aCountLines - informs the DTD whether to count newlines
+ * (not wanted, e.g., when handling document.write)
+ * @param aCharsetPtr - address of an nsCString containing the charset
+ * that the DTD should use (pointer in case the DTD
+ * opts to ignore this parameter)
+ */
+ NS_IMETHOD BuildModel(nsIContentSink* aSink) = 0;
+
+ /**
+ * Use this id you want to stop the building content model
+ * --------------[ Sets DTD to STOP mode ]----------------
+ * It's recommended to use this method in accordance with
+ * the parser's terminate() method.
+ *
+ * @update harishd 07/22/99
+ * @param
+ * @return
+ */
+ NS_IMETHOD_(void) Terminate() = 0;
+};
+
+NS_DEFINE_STATIC_IID_ACCESSOR(nsIDTD, NS_IDTD_IID)
+
+#define NS_DECL_NSIDTD \
+ void DidBuildModel() override; \
+ NS_IMETHOD BuildModel(nsIContentSink* aSink) override; \
+ NS_IMETHOD_(void) Terminate() override;
+#endif /* nsIDTD_h___ */