parser/htmlparser/public/nsIExtendedExpatSink.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is Robert Sayre.
  18  *
  19  * Portions created by the Initial Developer are Copyright (C) 2006
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsIExpatSink.idl"
  39
  40 /**
  41  * This interface provides notification of syntax-level events.
  42  */
  43 [scriptable, uuid(0C2DC80F-7AA4-467A-9454-B89DBA0E0779)]
  44 interface nsIExtendedExpatSink : nsIExpatSink
  45 {
  46   /**
  47    * Called at the beginning of the DTD, before any entity or notation
  48    * events.
  49    * @param aDoctypeName The document type name.
  50    * @param aSysid The declared system identifier for the external DTD subset,
  51    *               or null if none was declared.
  52    * @param aPubid The declared public identifier for the external DTD subset,
  53    *               or null if none was declared.
  54    */
  55   void handleStartDTD(in wstring aDoctypeName,
  56                       in wstring aSysid,
  57                       in wstring aPubid);
  58
  59   /**
  60    * Called when a prefix mapping starts to be in-scope, before any
  61    * startElement events.
  62    * @param aPrefix The Namespace prefix being declared. An empty string
  63    *                is used for the default element namespace, which has
  64    *                no prefix.
  65    * @param aUri The Namespace URI the prefix is mapped to.
  66    */
  67   void handleStartNamespaceDecl(in wstring aPrefix,
  68                                 in wstring aUri);
  69
  70   /**
  71    * Called when a prefix mapping is no longer in-scope, after any
  72    * endElement events.
  73    * @param aPrefix The prefix that was being mapped. This is the empty string
  74    *                when a default mapping scope ends.
  75    */
  76   void handleEndNamespaceDecl(in wstring aPrefix);
  77
  78   /**
  79    * This is called for a declaration of notation.  The base argument is
  80    * whatever was set by XML_SetBase. aNotationName will never be
  81    * null. The other arguments can be.
  82    * @param aNotationName The notation name.
  83    * @param aSysId The notation's system identifier, or null if none was given.
  84    * @param aPubId The notation's pubilc identifier, or null if none was given.
  85    */
  86   void handleNotationDecl(in wstring aNotationName,
  87                           in wstring aSysid,
  88                           in wstring aPubid);
  89
  90   /**
  91    * This is called for a declaration of an unparsed (NDATA) entity.
  92    * aName, aSysid and aNotationName arguments will never be
  93    * null. The other arguments may be.
  94    * @param aName  The unparsed entity's name.
  95    * @param aSysId The notation's system identifier.
  96    * @param aPubId The notation's pubilc identifier, or null if none was given.
  97    * @param aNotationName The name of the associated notation.
  98    */
  99   void handleUnparsedEntityDecl(in wstring aName,
 100                                 in wstring aSysid,
 101                                 in wstring aPubid,
 102                                 in wstring aNotationName);
 103
 104 };