Back to index

lightning-sunbird  0.9+nobinonly
nsJSUtils.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; 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 #ifndef nsJSUtils_h__
00039 #define nsJSUtils_h__
00040 
00048 #include "nsISupports.h"
00049 #include "jsapi.h"
00050 #include "nsString.h"
00051 #include "nsCOMPtr.h"
00052 
00053 class nsIDOMEventListener;
00054 class nsIScriptContext;
00055 class nsIScriptGlobalObject;
00056 class nsIDOMGCParticipant;
00057 class nsIXPConnectJSObjectHolder;
00058 class nsIPrincipal;
00059 
00060 class nsJSUtils
00061 {
00062 public:
00063   static JSBool GetCallingLocation(JSContext* aContext, const char* *aFilename,
00064                                    PRUint32* aLineno, nsIPrincipal* aPrincipal);
00065 
00066   static jsval ConvertStringToJSVal(const nsString& aProp,
00067                                     JSContext* aContext);
00068 
00069   static PRBool ConvertJSValToXPCObject(nsISupports** aSupports, REFNSIID aIID,
00070                                         JSContext* aContext, jsval aValue);
00071 
00072   static void ConvertJSValToString(nsAString& aString,
00073                                    JSContext* aContext, jsval aValue);
00074 
00075   static PRBool ConvertJSValToUint32(PRUint32* aProp, JSContext* aContext,
00076                                      jsval aValue);
00077 
00078   static nsIScriptGlobalObject *GetStaticScriptGlobal(JSContext* aContext,
00079                                                       JSObject* aObj);
00080 
00081   static nsIScriptContext *GetStaticScriptContext(JSContext* aContext,
00082                                                   JSObject* aObj);
00083 
00084   static nsIScriptGlobalObject *GetDynamicScriptGlobal(JSContext *aContext);
00085 
00086   static nsIScriptContext *GetDynamicScriptContext(JSContext *aContext);
00087 };
00088 
00089 
00090 class nsDependentJSString : public nsDependentString
00091 {
00092 public:
00093   explicit nsDependentJSString(jsval v)
00094     : nsDependentString((PRUnichar *)::JS_GetStringChars(JSVAL_TO_STRING(v)),
00095                         ::JS_GetStringLength(JSVAL_TO_STRING(v)))
00096   {
00097   }
00098 
00099   explicit nsDependentJSString(JSString *str)
00100     : nsDependentString((PRUnichar *)::JS_GetStringChars(str), ::JS_GetStringLength(str))
00101   {
00102   }
00103 
00104   ~nsDependentJSString()
00105   {
00106   }
00107 };
00108 
00123 class nsMarkedJSFunctionHolder_base
00124 {
00125 public:
00126   void Set(nsISupports *aPotentialFunction, nsIDOMGCParticipant *aParticipant);
00127   already_AddRefed<nsISupports> Get(REFNSIID aIID);
00128 
00129   nsMarkedJSFunctionHolder_base() : mObject(nsnull) {}
00130   ~nsMarkedJSFunctionHolder_base();
00131 
00132   PRBool TryMarkedSet(nsISupports *aPotentialFunction, nsIDOMGCParticipant *aParticipant);
00133 
00134   nsISupports *mObject;
00135 };
00136 
00137 template <class T>
00138 class nsMarkedJSFunctionHolder : protected nsMarkedJSFunctionHolder_base
00139 {
00140 public:
00141   void Set(T *aPotentialFunction, nsIDOMGCParticipant *aParticipant) {
00142     nsMarkedJSFunctionHolder_base::Set(aPotentialFunction, aParticipant);
00143   }
00144   already_AddRefed<T> Get() {
00145     return already_AddRefed<T>(NS_STATIC_CAST(T*, nsMarkedJSFunctionHolder_base::Get(NS_GET_IID(T)).get()));
00146   }
00147   // An overloaded version that's more useful for XPCOM getters
00148   void Get(T** aResult) {
00149     *aResult = Get().get();
00150   }
00151 };
00152 
00153 #endif /* nsJSUtils_h__ */