Back to index

lightning-sunbird  0.9+nobinonly
xcDll.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 
00038 /* Dll
00039  *
00040  * Programmatic representation of a dll. Stores modifiedTime and size for
00041  * easy detection of change in dll.
00042  *
00043  * dp Suresh <dp@netscape.com>
00044  */
00045 
00046 #ifndef xcDll_h__
00047 #define xcDll_h__
00048 
00049 #include "prio.h"
00050 #include "prlink.h"
00051 #include "nsISupports.h"
00052 #include "nsILocalFile.h"
00053 #include "nsCOMPtr.h"
00054 #include "nsString.h"
00055 
00056 class nsNativeComponentLoader;
00057 
00058 #if defined(DEBUG) && !defined(XP_BEOS)
00059 #define SHOULD_IMPLEMENT_BREAKAFTERLOAD
00060 #endif
00061 
00062 class nsIModule;
00063 class nsIServiceManager;
00064 
00065 typedef enum nsDllStatus
00066 {
00067        DLL_OK = 0,
00068        DLL_NO_MEM = 1,
00069        DLL_STAT_ERROR = 2,
00070        DLL_NOT_FILE = 3,
00071        DLL_INVALID_PARAM = 4
00072 } nsDllStatus;
00073 
00074 class nsDll
00075 {
00076 private:
00077     nsCOMPtr<nsIFile>         m_dllSpec; 
00078     PRLibrary                *m_instance; 
00079     nsIModule                *m_moduleObject;
00080     nsNativeComponentLoader  *m_loader;
00081     PRBool                    m_markForUnload;
00082 
00083     void Init(nsIFile *dllSpec);
00084 
00085 #ifdef SHOULD_IMPLEMENT_BREAKAFTERLOAD
00086     void BreakAfterLoad(const char *nsprPath);
00087 #endif
00088 
00089 public:
00090  
00091        nsDll(nsIFile *dllSpec, nsNativeComponentLoader* loader);
00092        ~nsDll(void);
00093 
00094        // Dll Loading
00095        PRBool Load(void);
00096        PRBool Unload(void);
00097        PRBool IsLoaded(void)
00098        {
00099               return ((m_instance != 0) ? PR_TRUE : PR_FALSE);
00100        }
00101     void MarkForUnload(PRBool mark) { m_markForUnload = mark; }
00102     PRBool IsMarkedForUnload(void) { return m_markForUnload; }
00103 
00104     // Shutdown the dll. This will call any on unload hook for the dll.
00105     // This wont unload the dll. Unload() implicitly calls Shutdown().
00106     nsresult Shutdown(void);
00107 
00108        void *FindSymbol(const char *symbol);
00109        
00110     PRBool HasChanged(void);
00111 
00112     void GetDisplayPath(nsACString& string);
00113 
00114        PRLibrary *GetInstance(void) { return (m_instance); }
00115 
00116     // NS_RELEASE() is required to be done on objects returned
00117     nsresult GetDllSpec(nsIFile **dllSpec);
00118     nsresult GetModule(nsISupports *servMgr, nsIModule **mobj);
00119 };
00120 
00121 #endif /* xcDll_h__ */