The Tor Browser: intl/chardet/public/nsICharsetDetector.h@b8a032363ba2

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

     1 /* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */

     2 /* This Source Code Form is subject to the terms of the Mozilla Public

     3  * License, v. 2.0. If a copy of the MPL was not distributed with this

     4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

     6 #ifndef nsICharsetDetector_h__

     7 #define nsICharsetDetector_h__

     9 #include "nsISupports.h"

    11 class nsICharsetDetectionObserver;

    13 // {12BB8F14-2389-11d3-B3BF-00805F8A6670}

    14 #define NS_ICHARSETDETECTOR_IID \

    15 { 0x12bb8f14, 0x2389, 0x11d3, { 0xb3, 0xbf, 0x0, 0x80, 0x5f, 0x8a, 0x66, 0x70 } }

    17 #define NS_CHARSET_DETECTOR_CONTRACTID_BASE "@mozilla.org/intl/charsetdetect;1?type="

    18 #define NS_CHARSET_DETECTOR_CATEGORY "charset-detectors"

    20 class nsICharsetDetector : public nsISupports {

    21 public:

    22   NS_DECLARE_STATIC_IID_ACCESSOR(NS_ICHARSETDETECTOR_IID)

    24   /*

    25      Setup the observer so it know how to notify the answer

    26    */

    27   NS_IMETHOD Init(nsICharsetDetectionObserver* observer) = 0;

    29   /*

    30      Feed a block of bytes to the detector.

    31      It will call the Notify function of the nsICharsetObserver if it find out

    32      the answer.

    33      aBytesArray - array of bytes

    34      aLen        - length of aBytesArray

    35      oDontFeedMe - return true if the detector do not need the following block

    36                           false it need more bytes.

    37                    This is used to enhance performance

    38    */

    39   NS_IMETHOD DoIt(const char* aBytesArray, uint32_t aLen, bool* oDontFeedMe) = 0;

    41   /*

    42      It also tell the detector the last chance the make a decision

    43    */

    44   NS_IMETHOD Done() = 0;

    46 };

    48 NS_DEFINE_STATIC_IID_ACCESSOR(nsICharsetDetector,

    49                               NS_ICHARSETDETECTOR_IID)

    51 #endif /* nsICharsetDetector_h__ */

The Tor Browser / file revision