LCOV - code coverage report
Current view: directory - objdir/dist/include - nsIFragmentContentSink.h (source / functions) Found Hit Coverage
Test: app.info Lines: 1 1 100.0 %
Date: 2012-06-02 Functions: 1 1 100.0 %

       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 Communicator client code.
      16                 :  *
      17                 :  * The Initial Developer of the Original Code is
      18                 :  * Netscape Communications Corporation.
      19                 :  * Portions created by the Initial Developer are Copyright (C) 1998
      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                 : #ifndef nsIFragmentContentSink_h___
      38                 : #define nsIFragmentContentSink_h___
      39                 : 
      40                 : #include "nsISupports.h"
      41                 : 
      42                 : class nsIDOMDocumentFragment;
      43                 : class nsIDocument;
      44                 : 
      45                 : #define NS_I_FRAGMENT_CONTENT_SINK_IID \
      46                 :   { 0x1a8ce30b, 0x63fc, 0x441a, \
      47                 :     { 0xa3, 0xaa, 0xf7, 0x16, 0xc0, 0xfe, 0x96, 0x69 } }
      48                 : 
      49                 : /**
      50                 :  * The fragment sink allows a client to parse a fragment of sink, possibly
      51                 :  * surrounded in context. Also see nsIParser::ParseFragment().
      52                 :  * Note: once you've parsed a fragment, the fragment sink must be re-set on
      53                 :  * the parser in order to parse another fragment.
      54                 :  */
      55               1 : class nsIFragmentContentSink : public nsISupports {
      56                 : public:
      57                 :   NS_DECLARE_STATIC_IID_ACCESSOR(NS_I_FRAGMENT_CONTENT_SINK_IID)
      58                 :   /**
      59                 :    * This method is used to obtain the fragment created by
      60                 :    * a fragment content sink and to release resources held by the parser.
      61                 :    *
      62                 :    * The sink drops its reference to the fragment.
      63                 :    */
      64                 :   NS_IMETHOD FinishFragmentParsing(nsIDOMDocumentFragment** aFragment) = 0;
      65                 : 
      66                 :   /**
      67                 :    * This method is used to set the target document for this fragment
      68                 :    * sink.  This document's nodeinfo manager will be used to create
      69                 :    * the content objects.  This MUST be called before the sink is used.
      70                 :    *
      71                 :    * @param aDocument the document the new nodes will belong to
      72                 :    * (should not be null)
      73                 :    */
      74                 :   NS_IMETHOD SetTargetDocument(nsIDocument* aDocument) = 0;
      75                 : 
      76                 :   /**
      77                 :    * This method is used to indicate to the sink that we're done building
      78                 :    * the context and should start paying attention to the incoming content
      79                 :    */
      80                 :   NS_IMETHOD WillBuildContent() = 0;
      81                 : 
      82                 :   /**
      83                 :    * This method is used to indicate to the sink that we're done building
      84                 :    * The real content. This is useful if you want to parse additional context
      85                 :    * (such as an end context).
      86                 :    */
      87                 :   NS_IMETHOD DidBuildContent() = 0;
      88                 : 
      89                 :   /**
      90                 :    * This method is a total hack to help with parsing fragments. It is called to
      91                 :    * tell the fragment sink that a container from the context will be delivered
      92                 :    * after the call to WillBuildContent(). This is only relevent for HTML
      93                 :    * fragments that use nsHTMLTokenizer/CNavDTD.
      94                 :    */
      95                 :   NS_IMETHOD IgnoreFirstContainer() = 0;
      96                 : 
      97                 :   /**
      98                 :    * Sets whether scripts elements are marked as unexecutable.
      99                 :    */
     100                 :   NS_IMETHOD SetPreventScriptExecution(bool aPreventScriptExecution) = 0;
     101                 : };
     102                 : 
     103                 : NS_DEFINE_STATIC_IID_ACCESSOR(nsIFragmentContentSink,
     104                 :                               NS_I_FRAGMENT_CONTENT_SINK_IID)
     105                 : 
     106                 : /**
     107                 :  * This interface is implemented by paranoid content sinks, and allows consumers
     108                 :  * to add tags and attributes to the default white-list set.
     109                 :  */
     110                 : class nsIParanoidFragmentContentSink : public nsISupports {
     111                 : public:
     112                 :   NS_DECLARE_STATIC_IID_ACCESSOR(NS_I_PARANOID_FRAGMENT_CONTENT_SINK_IID)
     113                 : 
     114                 :   /**
     115                 :    * Allow the content sink to accept style elements and attributes.
     116                 :    */
     117                 :   virtual void AllowStyles() = 0;
     118                 : 
     119                 :   /**
     120                 :    * Allow the content sink to accept comments.
     121                 :    */
     122                 :   virtual void AllowComments() = 0;
     123                 : };
     124                 : 
     125                 : nsresult
     126                 : NS_NewXMLFragmentContentSink(nsIFragmentContentSink** aInstancePtrResult);
     127                 : 
     128                 : #endif

Generated by: LCOV version 1.7