Back to index

lightning-sunbird  0.9+nobinonly
nsDetectionConfident.h
Go to the documentation of this file.
00001 /* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 #ifndef nsDetetctionConfident_h__
00038 #define nsDetetctionConfident_h__
00039 
00040 /*
00041   This type is used to indidcate how confident the detection module about
00042   the return result.
00043  
00044   eNoAnswerYet is used to indidcate that the detector have not find out a 
00045                answer yet based on the data it received.
00046   eBestAnswer  is used to indidcate that the answer the detector returned
00047                is the best one within the knowledge of the detector.
00048                In other words, the test to all other candidcates fail.
00049 
00050                For example, the (Shift_JIS/EUC-JP/ISO-2022-JP) detection
00051                module may return this with answer "Shift_JIS "if it receive 
00052                bytes > 0x80 (which make ISO-2022-JP test failed) and byte 
00053                0x82 (which may EUC-JP test failed)
00054 
00055   eSureAnswer  is used to indidcate that the detector are 100% sure about the 
00056                answer. 
00057                Exmaple 1; the Shift_JIS/ISO-2022-JP/EUC-JP detector return
00058                this w/ ISO-2022-JP when it hit one of the following ESC seq
00059                   ESC ( J
00060                   ESC $ @
00061                   ESC $ B
00062                Example 2: the detector which can detect UCS2 return w/ UCS2
00063                when the first 2 byte are BOM mark.
00064                Example 3: the Korean detector return ISO-2022-KR when it
00065                hit ESC $ ) C
00066   
00067  */
00068 typedef enum {
00069   eNoAnswerYet = 0,
00070   eBestAnswer,
00071   eSureAnswer,
00072   eNoAnswerMatch
00073 } nsDetectionConfident;
00074 
00075 #endif /* nsDetetctionConfident_h__ */