Back to index

lightning-sunbird  0.9+nobinonly
nsScriptablePeer.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  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * 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 // ==============================
00039 // ! Scriptability related code !
00040 // ==============================
00041 //
00042 // nsScriptablePeer - xpconnect scriptable peer
00043 //
00044 
00045 #ifndef __nsScriptablePeer_h__
00046 #define __nsScriptablePeer_h__
00047 
00048 #include "nsIScriptablePluginSample.h"
00049 #include "nsIClassInfo.h"
00050 
00051 class nsPluginInstance;
00052 
00053 // We must implement nsIClassInfo because it signals the
00054 // Mozilla Security Manager to allow calls from JavaScript.
00055 
00056 class nsClassInfoMixin : public nsIClassInfo
00057 {
00058   // These flags are used by the DOM and security systems to signal that 
00059   // JavaScript callers are allowed to call this object's scritable methods.
00060   NS_IMETHOD GetFlags(PRUint32 *aFlags)
00061     {*aFlags = nsIClassInfo::PLUGIN_OBJECT | nsIClassInfo::DOM_OBJECT;
00062      return NS_OK;}
00063   NS_IMETHOD GetImplementationLanguage(PRUint32 *aImplementationLanguage)
00064     {*aImplementationLanguage = nsIProgrammingLanguage::CPLUSPLUS;
00065      return NS_OK;}
00066   // The rest of the methods can safely return error codes...
00067   NS_IMETHOD GetInterfaces(PRUint32 *count, nsIID * **array)
00068     {return NS_ERROR_NOT_IMPLEMENTED;}
00069   NS_IMETHOD GetHelperForLanguage(PRUint32 language, nsISupports **_retval)
00070     {return NS_ERROR_NOT_IMPLEMENTED;}
00071   NS_IMETHOD GetContractID(char * *aContractID)
00072     {return NS_ERROR_NOT_IMPLEMENTED;}
00073   NS_IMETHOD GetClassDescription(char * *aClassDescription)
00074     {return NS_ERROR_NOT_IMPLEMENTED;}
00075   NS_IMETHOD GetClassID(nsCID * *aClassID)
00076     {return NS_ERROR_NOT_IMPLEMENTED;}
00077   NS_IMETHOD GetClassIDNoAlloc(nsCID *aClassIDNoAlloc)
00078     {return NS_ERROR_NOT_IMPLEMENTED;}
00079 };
00080 
00081 class nsScriptablePeer : public nsIScriptablePluginSample,
00082                          public nsClassInfoMixin
00083 {
00084 public:
00085   nsScriptablePeer(nsPluginInstance* plugin);
00086   ~nsScriptablePeer();
00087 
00088 public:
00089   // methods from nsISupports
00090   NS_IMETHOD QueryInterface(const nsIID& aIID, void** aInstancePtr); 
00091   NS_IMETHOD_(nsrefcnt) AddRef(); 
00092   NS_IMETHOD_(nsrefcnt) Release(); 
00093 
00094 protected: 
00095   nsrefcnt mRefCnt;  
00096 
00097 public:
00098   // native methods callable from JavaScript
00099   NS_DECL_NSISCRIPTABLEPLUGINSAMPLE
00100 
00101   void SetInstance(nsPluginInstance* plugin);
00102 
00103 protected:
00104   nsPluginInstance* mPlugin;
00105 };
00106 
00107 #endif