Back to index

lightning-sunbird  0.9+nobinonly
nsDetectionAdaptor.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) 1998
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 nsDetectionAdaptor_h__
00038 #define nsDetectionAdaptor_h__
00039 
00040 #include "nsCOMPtr.h"
00041 #include "nsIDocument.h"
00042 #include "nsIWebShellServices.h"
00043 
00044 #include "nsIParserFilter.h"
00045 static NS_DEFINE_IID(kIParserFilterIID, NS_IPARSERFILTER_IID);
00046 
00047 class CToken;
00048 
00049 //--------------------------------------------------------------
00050 class nsMyObserver : public nsICharsetDetectionObserver
00051 {
00052  public:
00053    NS_DECL_ISUPPORTS
00054 
00055  public:
00056    nsMyObserver( void )
00057    {
00058      mWebShellSvc = nsnull;
00059      mNotifyByReload = PR_FALSE;
00060      mWeakRefDocument = nsnull;
00061      mWeakRefParser = nsnull;
00062    }
00063    virtual  ~nsMyObserver( void )
00064    {
00065      // do not release nor delete mWeakRefDocument
00066      // do not release nor delete mWeakRefParser
00067    }
00068 
00069 
00070    // Methods to support nsICharsetDetectionAdaptor
00071    NS_IMETHOD Init(nsIWebShellServices* aWebShellSvc, 
00072                    nsIDocument* aDocument,
00073                    nsIParser* aParser,
00074                    const char* aCharset,
00075                    const char* aCommand);
00076 
00077    // Methods to support nsICharsetDetectionObserver
00078    NS_IMETHOD Notify(const char* aCharset, nsDetectionConfident aConf);
00079    void SetNotifyByReload(PRBool aByReload) { mNotifyByReload = aByReload; };
00080  private:
00081      nsCOMPtr<nsIWebShellServices> mWebShellSvc;
00082      PRBool mNotifyByReload;
00083 
00084      //The adaptor is owned by parser as filter, and adaptor owns detector, 
00085      //which in turn owns observer. Parser also live within the lifespan of 
00086      //document. The ownership tree is like:
00087      //  document->parser->adaptor->detector->observer
00088      //We do not want to own Document & Parser to avoid ownership loop. That 
00089      //will cause memory leakage. 
00090      //If in future this chain got changed, ie. parser outlives document, or 
00091      //detector outlives parser, we might want to change weak reference here. 
00092      nsIDocument* mWeakRefDocument;
00093      nsIParser* mWeakRefParser;
00094      nsCAutoString mCharset;
00095      nsCAutoString mCommand;
00096 };
00097 
00098 class nsDetectionAdaptor : 
00099                            public nsIParserFilter,
00100                            public nsICharsetDetectionAdaptor
00101 {
00102  public:
00103    NS_DECL_ISUPPORTS
00104 
00105  public:
00106    nsDetectionAdaptor( void );
00107    virtual  ~nsDetectionAdaptor( void );
00108 
00109    // Methods to support nsICharsetDetectionAdaptor
00110    NS_IMETHOD Init(nsIWebShellServices* aWebShellSvc, nsICharsetDetector *aDetector, 
00111                    nsIDocument* aDocument,
00112                    nsIParser* aParser,
00113                    const char* aCharset,
00114                    const char* aCommand=nsnull);
00115   
00116    // Methode to suppor nsIParserFilter
00117    NS_IMETHOD RawBuffer(const char * buffer, PRUint32 * buffer_length) ;
00118    NS_IMETHOD Finish();
00119 
00120    // really don't care the following two, only because they are defined
00121    // in nsIParserFilter.h
00122    NS_IMETHOD WillAddToken(CToken & token) { return NS_OK; };
00123    NS_IMETHOD ProcessTokens( void ) {return NS_OK;};
00124 
00125   private:
00126      nsCOMPtr<nsICharsetDetector> mDetector;
00127      PRBool mDontFeedToDetector;
00128      nsCOMPtr<nsMyObserver> mObserver; 
00129 };
00130 
00131 #endif /* nsDetectionAdaptor_h__ */