intl/chardet/public/nsDetectionConfident.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) 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 nsDetetctionConfident_h__
  38 #define nsDetetctionConfident_h__
  39
  40 /*
  41   This type is used to indicate how confident the detection module about
  42   the return result.
  43
  44   eNoAnswerYet is used to indicate that the detector have not find out a
  45                answer yet based on the data it received.
  46   eBestAnswer  is used to indicate that the answer the detector returned
  47                is the best one within the knowledge of the detector.
  48                In other words, the test to all other candidcates fail.
  49
  50                For example, the (Shift_JIS/EUC-JP/ISO-2022-JP) detection
  51                module may return this with answer "Shift_JIS "if it receive
  52                bytes > 0x80 (which make ISO-2022-JP test failed) and byte
  53                0x82 (which may EUC-JP test failed)
  54
  55   eSureAnswer  is used to indicate that the detector is 100% sure about the
  56                answer.
  57                Exmaple 1; the Shift_JIS/ISO-2022-JP/EUC-JP detector return
  58                this w/ ISO-2022-JP when it hit one of the following ESC seq
  59                   ESC ( J
  60                   ESC $ @
  61                   ESC $ B
  62                Example 2: the detector which can detect UCS2 return w/ UCS2
  63                when the first 2 byte are BOM mark.
  64                Example 3: the Korean detector return ISO-2022-KR when it
  65                hit ESC $ ) C
  66
  67  */
  68 typedef enum {
  69   eNoAnswerYet = 0,
  70   eBestAnswer,
  71   eSureAnswer,
  72   eNoAnswerMatch
  73 } nsDetectionConfident;
  74
  75 #endif /* nsDetetctionConfident_h__ */