← Back to branch summary

~ubuntu-branches/ubuntu/precise/kompozer/precise

« back to all changes in this revision

Viewing changes to mozilla/intl/chardet/public/nsICharsetDetector.h

  • Committer: Bazaar Package Importer
  • Author(s): Anthony Yarusso
  • Date: 2007-08-27 01:11:03 UTC
  • Revision ID: james.westby@ubuntu.com-20070827011103-2jgf4s6532gqu2ka
Tags: upstream-0.7.10
Import upstream version 0.7.10

Show diffs side-by-side

added added

removed removed

Lines of Context:
mozilla/intl/chardet/public/nsICharsetDetector.h
 
1
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
 
2
/* ***** BEGIN LICENSE BLOCK *****
 
3
 * Version: NPL 1.1/GPL 2.0/LGPL 2.1
 
4
 *
 
5
 * The contents of this file are subject to the Netscape Public License
 
6
 * Version 1.1 (the "License"); you may not use this file except in
 
7
 * compliance with the License. You may obtain a copy of the License at
 
8
 * http://www.mozilla.org/NPL/
 
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) 1999
 
20
 * the Initial Developer. All Rights Reserved.
 
21
 *
 
22
 * Contributor(s):
 
23
 *
 
24
 *
 
25
 * Alternatively, the contents of this file may be used under the terms of
 
26
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 
27
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 
28
 * in which case the provisions of the GPL or the LGPL are applicable instead
 
29
 * of those above. If you wish to allow use of your version of this file only
 
30
 * under the terms of either the GPL or the LGPL, and not to allow others to
 
31
 * use your version of this file under the terms of the NPL, indicate your
 
32
 * decision by deleting the provisions above and replace them with the notice
 
33
 * and other provisions required by the GPL or the LGPL. If you do not delete
 
34
 * the provisions above, a recipient may use your version of this file under
 
35
 * the terms of any one of the NPL, the GPL or the LGPL.
 
36
 *
 
37
 * ***** END LICENSE BLOCK ***** */
 
38
 
 
39
#ifndef nsICharsetDetector_h__
 
40
#define nsICharsetDetector_h__
 
41
 
 
42
#include "nsISupports.h"
 
43
 
 
44
class nsICharsetDetectionObserver;
 
45
 
 
46
// {12BB8F14-2389-11d3-B3BF-00805F8A6670}
 
47
#define NS_ICHARSETDETECTOR_IID \
 
48
{ 0x12bb8f14, 0x2389, 0x11d3, { 0xb3, 0xbf, 0x0, 0x80, 0x5f, 0x8a, 0x66, 0x70 } }
 
49
 
 
50
#define NS_CHARSET_DETECTOR_CONTRACTID_BASE "@mozilla.org/intl/charsetdetect;1?type="
 
51
#define NS_CHARSET_DETECTOR_CATEGORY "charset-detectors"
 
52
 
 
53
class nsICharsetDetector : public nsISupports {
 
54
public:  
 
55
  NS_DEFINE_STATIC_IID_ACCESSOR(NS_ICHARSETDETECTOR_IID)
 
56
 
 
57
  /* 
 
58
     Setup the observer so it know how to notify the answer
 
59
   */
 
60
  NS_IMETHOD Init(nsICharsetDetectionObserver* observer) = 0;
 
61
 
 
62
  /*
 
63
     Feed a block of bytes to the detector.
 
64
     It will call the Notify function of the nsICharsetObserver if it find out
 
65
     the answer. 
 
66
     aBytesArray - array of bytes
 
67
     aLen        - length of aBytesArray
 
68
     oDontFeedMe - return PR_TRUE if the detector do not need the following block
 
69
                          PR_FALSE it need more bytes. 
 
70
                   This is used to enhance performance
 
71
   */
 
72
  NS_IMETHOD DoIt(const char* aBytesArray, PRUint32 aLen, PRBool* oDontFeedMe) = 0;
 
73
 
 
74
  /*
 
75
     It also tell the detector the last chance the make a decision
 
76
   */
 
77
  NS_IMETHOD Done() = 0;
 
78
 
 
79
};
 
80
#endif /* nsICharsetDetector_h__ */