intl/chardet/public/nsIStringCharsetDetector.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 nsIStringCharsetDetector_h__
  38 #define nsIStringCharsetDetector_h__
  39
  40 #include "nsISupports.h"
  41 #include "nsDetectionConfident.h"
  42
  43 // {12BB8F15-2389-11d3-B3BF-00805F8A6670}
  44 #define NS_ISTRINGCHARSETDETECTOR_IID \
  45 { 0x12bb8f15, 0x2389, 0x11d3, { 0xb3, 0xbf, 0x0, 0x80, 0x5f, 0x8a, 0x66, 0x70 } }
  46
  47
  48 #define NS_STRCDETECTOR_CONTRACTID_BASE "@mozilla.org/intl/stringcharsetdetect;1?type="
  49
  50 /*
  51   This interface is similar to nsICharsetDetector
  52   The difference is it is for line base detection instead of block based
  53   detectection.
  54  */
  55
  56
  57 class nsIStringCharsetDetector : public nsISupports {
  58 public:
  59
  60    NS_DECLARE_STATIC_IID_ACCESSOR(NS_ISTRINGCHARSETDETECTOR_IID)
  61   /*
  62      Perform the charset detection
  63
  64      aBytesArray- the bytes
  65      aLen- the length of the bytes
  66      oCharset- the charset answer
  67      oConfident - the confidence of the answer
  68    */
  69   NS_IMETHOD DoIt(const char* aBytesArray, PRUint32 aLen,
  70                     const char** oCharset, nsDetectionConfident &oConfident) = 0;
  71 };
  72
  73 NS_DEFINE_STATIC_IID_ACCESSOR(nsIStringCharsetDetector,
  74                               NS_ISTRINGCHARSETDETECTOR_IID)
  75
  76 #endif /* nsIStringCharsetDetector_h__ */