intl/chardet/src/nsDetectionAdaptor.h

   1 /* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   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) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37 #ifndef nsDetectionAdaptor_h__
  38 #define nsDetectionAdaptor_h__
  39
  40 #include "nsCOMPtr.h"
  41 #include "nsIWebShellServices.h"
  42
  43 #include "nsIParserFilter.h"
  44 static NS_DEFINE_IID(kIParserFilterIID, NS_IPARSERFILTER_IID);
  45
  46 class nsIDocument;
  47 class CToken;
  48
  49 //--------------------------------------------------------------
  50 class nsMyObserver : public nsICharsetDetectionObserver
  51 {
  52  public:
  53    NS_DECL_ISUPPORTS
  54
  55  public:
  56    nsMyObserver( void )
  57    {
  58      mWebShellSvc = nsnull;
  59      mNotifyByReload = PR_FALSE;
  60      mWeakRefDocument = nsnull;
  61      mWeakRefParser = nsnull;
  62    }
  63    virtual  ~nsMyObserver( void )
  64    {
  65      // do not release nor delete mWeakRefDocument
  66      // do not release nor delete mWeakRefParser
  67    }
  68
  69
  70    // Methods to support nsICharsetDetectionAdaptor
  71    NS_IMETHOD Init(nsIWebShellServices* aWebShellSvc,
  72                    nsIDocument* aDocument,
  73                    nsIParser* aParser,
  74                    const char* aCharset,
  75                    const char* aCommand);
  76
  77    // Methods to support nsICharsetDetectionObserver
  78    NS_IMETHOD Notify(const char* aCharset, nsDetectionConfident aConf);
  79    void SetNotifyByReload(PRBool aByReload) { mNotifyByReload = aByReload; }
  80  private:
  81      nsCOMPtr<nsIWebShellServices> mWebShellSvc;
  82      PRBool mNotifyByReload;
  83
  84      //The adaptor is owned by parser as filter, and adaptor owns detector,
  85      //which in turn owns observer. Parser also live within the lifespan of
  86      //document. The ownership tree is like:
  87      //  document->parser->adaptor->detector->observer
  88      //We do not want to own Document & Parser to avoid ownership loop. That
  89      //will cause memory leakage.
  90      //If in future this chain got changed, ie. parser outlives document, or
  91      //detector outlives parser, we might want to change weak reference here.
  92      nsIDocument* mWeakRefDocument;
  93      nsIParser* mWeakRefParser;
  94      nsCAutoString mCharset;
  95      nsCAutoString mCommand;
  96 };
  97
  98 class nsDetectionAdaptor :
  99                            public nsIParserFilter,
 100                            public nsICharsetDetectionAdaptor
 101 {
 102  public:
 103    NS_DECL_ISUPPORTS
 104
 105  public:
 106    nsDetectionAdaptor( void );
 107    virtual  ~nsDetectionAdaptor( void );
 108
 109    // Methods to support nsICharsetDetectionAdaptor
 110    NS_IMETHOD Init(nsIWebShellServices* aWebShellSvc, nsICharsetDetector *aDetector,
 111                    nsIDocument* aDocument,
 112                    nsIParser* aParser,
 113                    const char* aCharset,
 114                    const char* aCommand=nsnull);
 115
 116    // Methode to suppor nsIParserFilter
 117    NS_IMETHOD RawBuffer(const char * buffer, PRUint32 * buffer_length) ;
 118    NS_IMETHOD Finish();
 119
 120    // really don't care the following two, only because they are defined
 121    // in nsIParserFilter.h
 122    NS_IMETHOD WillAddToken(CToken & token) { return NS_OK; }
 123    NS_IMETHOD ProcessTokens( void ) {return NS_OK;}
 124
 125   private:
 126      nsCOMPtr<nsICharsetDetector> mDetector;
 127      PRBool mDontFeedToDetector;
 128      nsCOMPtr<nsMyObserver> mObserver;
 129 };
 130
 131 #endif /* nsDetectionAdaptor_h__ */