LCOV - app.info - dom/base/nsJSUtils.h

LCOV - code coverage report
| Current view: | directory - dom/base - nsJSUtils.h (source / functions) |  | Found | Hit | Coverage |
| Test: | app.info | Lines: | 19 | 15 | 78.9 %
| Date: | 2012-04-21 | Functions: | 5 | 4 | 80.0 %

           1                 : /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
           2                 : /* ***** BEGIN LICENSE BLOCK *****
           3                 :  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
           4                 :  *
           5                 :  * The contents of this file are subject to the Mozilla Public License Version
           6                 :  * 1.1 (the "License"); you may not use this file except in compliance with
           7                 :  * the License. You may obtain a copy of the License at
           8                 :  * http://www.mozilla.org/MPL/
           9                 :  *
          10                 :  * Software distributed under the License is distributed on an "AS IS" basis,
          11                 :  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
          12                 :  * for the specific language governing rights and limitations under the
          13                 :  * License.
          14                 :  *
          15                 :  * The Original Code is mozilla.org code.
          16                 :  *
          17                 :  * The Initial Developer of the Original Code is
          18                 :  * Netscape Communications Corporation.
          19                 :  * Portions created by the Initial Developer are Copyright (C) 1998
          20                 :  * the Initial Developer. All Rights Reserved.
          21                 :  *
          22                 :  * Contributor(s):
          23                 :  *
          24                 :  * Alternatively, the contents of this file may be used under the terms of
          25                 :  * either of the GNU General Public License Version 2 or later (the "GPL"),
          26                 :  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
          27                 :  * in which case the provisions of the GPL or the LGPL are applicable instead
          28                 :  * of those above. If you wish to allow use of your version of this file only
          29                 :  * under the terms of either the GPL or the LGPL, and not to allow others to
          30                 :  * use your version of this file under the terms of the MPL, indicate your
          31                 :  * decision by deleting the provisions above and replace them with the notice
          32                 :  * and other provisions required by the GPL or the LGPL. If you do not delete
          33                 :  * the provisions above, a recipient may use your version of this file under
          34                 :  * the terms of any one of the MPL, the GPL or the LGPL.
          35                 :  *
          36                 :  * ***** END LICENSE BLOCK ***** */
          37                 :
          38                 : #ifndef nsJSUtils_h__
          39                 : #define nsJSUtils_h__
          40                 :
          41                 : /**
          42                 :  * This is not a generated file. It contains common utility functions
          43                 :  * invoked from the JavaScript code generated from IDL interfaces.
          44                 :  * The goal of the utility functions is to cut down on the size of
          45                 :  * the generated code itself.
          46                 :  */
          47                 :
          48                 : #include "nsISupports.h"
          49                 : #include "jsapi.h"
          50                 : #include "nsString.h"
          51                 :
          52                 : class nsIDOMEventListener;
          53                 : class nsIScriptContext;
          54                 : class nsIScriptGlobalObject;
          55                 : class nsIPrincipal;
          56                 :
          57                 : class nsJSUtils
          58                 : {
          59                 : public:
          60                 :   static JSBool GetCallingLocation(JSContext* aContext, const char* *aFilename,
          61                 :                                    PRUint32* aLineno);
          62                 :
          63                 :   static nsIScriptGlobalObject *GetStaticScriptGlobal(JSContext* aContext,
          64                 :                                                       JSObject* aObj);
          65                 :
          66                 :   static nsIScriptContext *GetStaticScriptContext(JSContext* aContext,
          67                 :                                                   JSObject* aObj);
          68                 :
          69                 :   static nsIScriptGlobalObject *GetDynamicScriptGlobal(JSContext *aContext);
          70                 :
          71                 :   static nsIScriptContext *GetDynamicScriptContext(JSContext *aContext);
          72                 :
          73                 :   /**
          74                 :    * Retrieve the inner window ID based on the given JSContext.
          75                 :    *
          76                 :    * @param JSContext aContext
          77                 :    *        The JSContext from which you want to find the inner window ID.
          78                 :    *
          79                 :    * @returns PRUint64 the inner window ID.
          80                 :    */
          81                 :   static PRUint64 GetCurrentlyRunningCodeInnerWindowID(JSContext *aContext);
          82                 : };
          83                 :
          84                 :
          85                 : class nsDependentJSString : public nsDependentString
          86                 : {
          87                 : public:
          88                 :   /**
          89                 :    * In the case of string ids, getting the string's chars is infallible, so
          90                 :    * the dependent string can be constructed directly.
          91                 :    */
          92               0 :   explicit nsDependentJSString(jsid id)
          93                 :     : nsDependentString(JS_GetInternedStringChars(JSID_TO_STRING(id)),
          94               0 :                         JS_GetStringLength(JSID_TO_STRING(id)))
          95                 :   {
          96               0 :   }
          97                 :
          98                 :   /**
          99                 :    * For all other strings, the nsDependentJSString object should be default
         100                 :    * constructed, which leaves it empty (this->IsEmpty()), and initialized with
         101                 :    * one of the fallible init() methods below.
         102                 :    */
         103                 :
         104           40702 :   nsDependentJSString()
         105           40702 :   {
         106           40702 :   }
         107                 :
         108           40702 :   JSBool init(JSContext* aContext, JSString* str)
         109                 :   {
         110                 :       size_t length;
         111           40702 :       const jschar* chars = JS_GetStringCharsZAndLength(aContext, str, &length);
         112           40702 :       if (!chars)
         113               0 :           return JS_FALSE;
         114                 :
         115           40702 :       NS_ASSERTION(IsEmpty(), "init() on initialized string");
         116           40702 :       nsDependentString* base = this;
         117           40702 :       new(base) nsDependentString(chars, length);
         118           40702 :       return JS_TRUE;
         119                 :   }
         120                 :
         121            3762 :   JSBool init(JSContext* aContext, const jsval &v)
         122                 :   {
         123            3762 :       return init(aContext, JSVAL_TO_STRING(v));
         124                 :   }
         125                 :
         126           40702 :   ~nsDependentJSString()
         127           40702 :   {
         128           40702 :   }
         129                 : };
         130                 :
         131                 : #endif /* nsJSUtils_h__ */

Generated by: LCOV version 1.7