intl/chardet/public/nsICharsetDetectionAdaptor.h

   1 /* -*- Mode: C; tab-width: 4; 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
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1999
  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 nsICDETAdaptor_h__
  38 #define nsICDETAdaptor_h__
  39 #include "nsISupports.h"
  40
  41 class nsICharsetDetector;
  42 class nsIWebShellServices;
  43 class nsIDocument;
  44 class nsIParser;
  45
  46 // {12BB8F13-2389-11d3-B3BF-00805F8A6670}
  47 #define NS_ICHARSETDETECTIONADAPTOR_IID \
  48 { 0x12bb8f13, 0x2389, 0x11d3, { 0xb3, 0xbf, 0x0, 0x80, 0x5f, 0x8a, 0x66, 0x70 } }
  49
  50 /*
  51    This interface is defined to be serverd as an Adaptor between
  52    nsIWebShellServices, nsICharsetDetector and nsIParserFilter
  53
  54    It make the nsICharsetDetector implementation independent from the
  55    nsIParserFilter and nsIWebShellServices
  56  */
  57
  58 class nsICharsetDetectionAdaptor : public nsISupports {
  59 public:
  60   NS_DECLARE_STATIC_IID_ACCESSOR(NS_ICHARSETDETECTIONADAPTOR_IID)
  61   /*
  62      Initialize it by setup the nsICharsetDetector and the
  63      nsIWebShellServices
  64    */
  65   NS_IMETHOD Init(nsIWebShellServices* aWebShell, nsICharsetDetector *aDetector,
  66                   nsIDocument* aDocument, nsIParser* aParser,
  67                   const char* aCharset, const char* aCommand=nsnull) = 0;
  68 };
  69
  70 NS_DEFINE_STATIC_IID_ACCESSOR(nsICharsetDetectionAdaptor,
  71                               NS_ICHARSETDETECTIONADAPTOR_IID)
  72
  73 #endif /* nsICDETAdaptor_h__ */