Back to index

lightning-sunbird  0.9+nobinonly
ActiveScriptSite.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
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  *   Adam Lock <adamlock@eircom.net>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either the GNU General Public License Version 2 or later (the "GPL"), or
00027  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 #ifndef ACTIVESCRIPTSITE_H
00039 #define ACTIVESCRIPTSITE_H
00040 
00041 
00042 class CActiveScriptSite :    public CComObjectRootEx<CComSingleThreadModel>,
00043                             public IActiveScriptSite
00044 {
00045     // Pointer to owned script engine
00046     CComQIPtr<IActiveScript, &IID_IActiveScript> m_spIActiveScript;
00047 
00048     // List of registered, named objects
00049     CNamedObjectList m_cObjectList;
00050 
00051     // Current script state
00052     SCRIPTSTATE m_ssScriptState;
00053 
00054 public:
00055     CActiveScriptSite();
00056     virtual ~CActiveScriptSite();
00057 
00058 BEGIN_COM_MAP(CActiveScriptSite)
00059     COM_INTERFACE_ENTRY(IActiveScriptSite)
00060 END_COM_MAP()
00061 
00062     // Attach to the specified script engine    
00063     virtual HRESULT Attach(CLSID clsidScriptEngine);
00064     // Helper to attach to the VBScript engine
00065     virtual HRESULT AttachVBScript();
00066     // Helper to attach to the JScript engine
00067     virtual HRESULT AttachJScript();
00068     // Detach from the script engine
00069     virtual HRESULT Detach();
00070     // Return the current state of the script engine
00071     virtual SCRIPTSTATE GetScriptState() const
00072     {
00073         return m_ssScriptState;
00074     }
00075 
00076     // Parse the specified script
00077     virtual HRESULT ParseScriptText(const TCHAR *szScript);
00078     // Parse the specified script from a file
00079     virtual HRESULT ParseScriptFile(const TCHAR *szFile);
00080     // Add object to script address space
00081     virtual HRESULT AddNamedObject(const TCHAR *szName, IUnknown *pObject, BOOL bGlobalMembers = FALSE);
00082     // Play the script
00083     virtual HRESULT PlayScript();
00084     // Stop the script
00085     virtual HRESULT StopScript();
00086 
00087 public:
00088     // IActiveScriptSite
00089     virtual HRESULT STDMETHODCALLTYPE GetLCID(/* [out] */ LCID __RPC_FAR *plcid);
00090     virtual HRESULT STDMETHODCALLTYPE GetItemInfo(/* [in] */ LPCOLESTR pstrName, /* [in] */ DWORD dwReturnMask, /* [out] */ IUnknown __RPC_FAR *__RPC_FAR *ppiunkItem, /* [out] */ ITypeInfo __RPC_FAR *__RPC_FAR *ppti);
00091     virtual HRESULT STDMETHODCALLTYPE GetDocVersionString(/* [out] */ BSTR __RPC_FAR *pbstrVersion);
00092     virtual HRESULT STDMETHODCALLTYPE OnScriptTerminate(/* [in] */ const VARIANT __RPC_FAR *pvarResult, /* [in] */ const EXCEPINFO __RPC_FAR *pexcepinfo);
00093     virtual HRESULT STDMETHODCALLTYPE OnStateChange(/* [in] */ SCRIPTSTATE ssScriptState);
00094     virtual HRESULT STDMETHODCALLTYPE OnScriptError(/* [in] */ IActiveScriptError __RPC_FAR *pscripterror);
00095     virtual HRESULT STDMETHODCALLTYPE OnEnterScript(void);
00096     virtual HRESULT STDMETHODCALLTYPE OnLeaveScript(void);
00097 };
00098 
00099 typedef CComObject<CActiveScriptSite> CActiveScriptSiteInstance;
00100 
00101 #endif