parser/htmlparser/public/nsIExtendedExpatSink.idl

Fri, 16 Jan 2015 18:13:44 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Fri, 16 Jan 2015 18:13:44 +0100
branch
TOR_BUG_9701
changeset 14
925c144e1f1f
permissions
-rw-r--r--

Integrate suggestion from review to improve consistency with existing code.

michael@0 1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
michael@0 2 /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0 3 * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0 4 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0 5
michael@0 6 #include "nsIExpatSink.idl"
michael@0 7
michael@0 8 /**
michael@0 9 * This interface provides notification of syntax-level events.
michael@0 10 */
michael@0 11 [scriptable, uuid(146E194B-333D-4283-8CF6-4BC3EE9B5DFF)]
michael@0 12 interface nsIExtendedExpatSink : nsIExpatSink
michael@0 13 {
michael@0 14 /**
michael@0 15 * Called at the beginning of the DTD, before any entity or notation
michael@0 16 * events.
michael@0 17 * @param aDoctypeName The document type name.
michael@0 18 * @param aSysid The declared system identifier for the external DTD subset,
michael@0 19 * or null if none was declared.
michael@0 20 * @param aPubid The declared public identifier for the external DTD subset,
michael@0 21 * or null if none was declared.
michael@0 22 */
michael@0 23 void handleStartDTD(in wstring aDoctypeName,
michael@0 24 in wstring aSysid,
michael@0 25 in wstring aPubid);
michael@0 26
michael@0 27 /**
michael@0 28 * Called when a prefix mapping starts to be in-scope, before any
michael@0 29 * startElement events.
michael@0 30 * @param aPrefix The Namespace prefix being declared. An empty string
michael@0 31 * is used for the default element namespace, which has
michael@0 32 * no prefix.
michael@0 33 * @param aUri The Namespace URI the prefix is mapped to.
michael@0 34 */
michael@0 35 void handleStartNamespaceDecl(in wstring aPrefix,
michael@0 36 in wstring aUri);
michael@0 37
michael@0 38 /**
michael@0 39 * Called when a prefix mapping is no longer in-scope, after any
michael@0 40 * endElement events.
michael@0 41 * @param aPrefix The prefix that was being mapped. This is the empty string
michael@0 42 * when a default mapping scope ends.
michael@0 43 */
michael@0 44 void handleEndNamespaceDecl(in wstring aPrefix);
michael@0 45
michael@0 46 /**
michael@0 47 * This is called for a declaration of notation. The base argument is
michael@0 48 * whatever was set by XML_SetBase. aNotationName will never be
michael@0 49 * null. The other arguments can be.
michael@0 50 * @param aNotationName The notation name.
michael@0 51 * @param aSysId The notation's system identifier, or null if none was given.
michael@0 52 * @param aPubId The notation's pubilc identifier, or null if none was given.
michael@0 53 */
michael@0 54 void handleNotationDecl(in wstring aNotationName,
michael@0 55 in wstring aSysid,
michael@0 56 in wstring aPubid);
michael@0 57
michael@0 58 /**
michael@0 59 * This is called for a declaration of an unparsed (NDATA) entity.
michael@0 60 * aName, aSysid and aNotationName arguments will never be
michael@0 61 * null. The other arguments may be.
michael@0 62 * @param aName The unparsed entity's name.
michael@0 63 * @param aSysId The notation's system identifier.
michael@0 64 * @param aPubId The notation's pubilc identifier, or null if none was given.
michael@0 65 * @param aNotationName The name of the associated notation.
michael@0 66 */
michael@0 67 void handleUnparsedEntityDecl(in wstring aName,
michael@0 68 in wstring aSysid,
michael@0 69 in wstring aPubid,
michael@0 70 in wstring aNotationName);
michael@0 71
michael@0 72 };

mercurial