Back to index

lightning-sunbird  0.9+nobinonly
nsIStringCharsetDetector.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) 1999
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 nsIStringCharsetDetector_h__
00038 #define nsIStringCharsetDetector_h__
00039 
00040 #include "nsISupports.h"
00041 #include "nsString.h"
00042 #include "nsDetectionConfident.h"
00043 
00044 // {12BB8F15-2389-11d3-B3BF-00805F8A6670}
00045 #define NS_ISTRINGCHARSETDETECTOR_IID \
00046 { 0x12bb8f15, 0x2389, 0x11d3, { 0xb3, 0xbf, 0x0, 0x80, 0x5f, 0x8a, 0x66, 0x70 } }
00047 
00048 
00049 #define NS_STRCDETECTOR_CONTRACTID_BASE "@mozilla.org/intl/stringcharsetdetect;1?type="
00050 
00051 /*
00052   This interface is similar to nsICharsetDetector
00053   The difference is it is for line base detection instead of block based 
00054   detectection. 
00055  */
00056 
00057 
00058 class nsIStringCharsetDetector : public nsISupports {
00059 public:  
00060 
00061    NS_DEFINE_STATIC_IID_ACCESSOR(NS_ISTRINGCHARSETDETECTOR_IID)
00062   /*
00063      Perform the charset detection
00064     
00065      aBytesArray- the bytes
00066      aLen- the length of the bytes
00067      oCharset- the charset answer
00068      oConfident - the confidence of the answer
00069    */
00070   NS_IMETHOD DoIt(const char* aBytesArray, PRUint32 aLen, 
00071                     const char** oCharset, nsDetectionConfident &oConfident) = 0;
00072 };
00073 #endif /* nsIStringCharsetDetector_h__ */