Back to index

lightning-sunbird  0.9+nobinonly
nsICharsetDetector.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 
00038 #ifndef nsICharsetDetector_h__
00039 #define nsICharsetDetector_h__
00040 
00041 #include "nsISupports.h"
00042 
00043 class nsICharsetDetectionObserver;
00044 
00045 // {12BB8F14-2389-11d3-B3BF-00805F8A6670}
00046 #define NS_ICHARSETDETECTOR_IID \
00047 { 0x12bb8f14, 0x2389, 0x11d3, { 0xb3, 0xbf, 0x0, 0x80, 0x5f, 0x8a, 0x66, 0x70 } }
00048 
00049 #define NS_CHARSET_DETECTOR_CONTRACTID_BASE "@mozilla.org/intl/charsetdetect;1?type="
00050 #define NS_CHARSET_DETECTOR_CATEGORY "charset-detectors"
00051  
00052 class nsICharsetDetector : public nsISupports {
00053 public:  
00054   NS_DEFINE_STATIC_IID_ACCESSOR(NS_ICHARSETDETECTOR_IID)
00055 
00056   /* 
00057      Setup the observer so it know how to notify the answer
00058    */
00059   NS_IMETHOD Init(nsICharsetDetectionObserver* observer) = 0;
00060 
00061   /*
00062      Feed a block of bytes to the detector.
00063      It will call the Notify function of the nsICharsetObserver if it find out
00064      the answer. 
00065      aBytesArray - array of bytes
00066      aLen        - length of aBytesArray
00067      oDontFeedMe - return PR_TRUE if the detector do not need the following block
00068                           PR_FALSE it need more bytes. 
00069                    This is used to enhance performance
00070    */
00071   NS_IMETHOD DoIt(const char* aBytesArray, PRUint32 aLen, PRBool* oDontFeedMe) = 0;
00072 
00073   /*
00074      It also tell the detector the last chance the make a decision
00075    */
00076   NS_IMETHOD Done() = 0;
00077 
00078 };
00079 #endif /* nsICharsetDetector_h__ */