dom/public/nsDOMScriptObjectHolder.h

   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) 2005
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *      Mark Hammond <mhammond@skippinet.com.au>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #ifndef nsDOMScriptObjectHolder_h__
  40 #define nsDOMScriptObjectHolder_h__
  41
  42 #include "nsIScriptContext.h"
  43 #include "nsIDOMScriptObjectFactory.h"
  44
  45 // A thin class used to help with script object memory management.  No virtual
  46 // functions and a fully inline implementation should keep the cost down.
  47 // [Note that a fully inline implementation is necessary for use by other
  48 // languages, which do not link against the layout component module]
  49 class NS_STACK_CLASS nsScriptObjectHolder {
  50 public:
  51   // A constructor that will cause a reference to |ctx| to be stored in
  52   // the object.  Only use for short-lived object holders.
  53   nsScriptObjectHolder(nsIScriptContext *ctx, void *aObject = nsnull) :
  54       mObject(aObject), mContext(ctx) {
  55     NS_ASSERTION(ctx, "Must provide a valid context");
  56   }
  57
  58   // copy constructor
  59   nsScriptObjectHolder(const nsScriptObjectHolder& other) :
  60       mObject(other.mObject),
  61       mContext(other.mContext)
  62   {
  63     // New hold the script object and new reference on the script context.
  64     if (mObject)
  65       mContext->HoldScriptObject(mObject);
  66   }
  67
  68   ~nsScriptObjectHolder() {
  69     if (mObject)
  70       mContext->DropScriptObject(mObject);
  71   }
  72
  73   // misc operators
  74   nsScriptObjectHolder &operator=(const nsScriptObjectHolder &other) {
  75     set(other);
  76     return *this;
  77   }
  78   PRBool operator!() const {
  79     return !mObject;
  80   }
  81   operator void *() const {
  82     return mObject;
  83   }
  84
  85   // Drop the script object - but *not* the nsIScriptContext.
  86   nsresult drop() {
  87     nsresult rv = NS_OK;
  88     if (mObject) {
  89       rv = mContext->DropScriptObject(mObject);
  90       mObject = nsnull;
  91     }
  92     return rv;
  93   }
  94   nsresult set(void *object) {
  95     NS_ASSERTION(getScriptTypeID() != nsIProgrammingLanguage::UNKNOWN,
  96                  "Must know the language!");
  97     nsresult rv = drop();
  98     if (NS_FAILED(rv))
  99       return rv;
 100     if (object) {
 101       rv = mContext->HoldScriptObject(object);
 102       // don't store the pointer if we failed to lock it.
 103       if (NS_SUCCEEDED(rv)) {
 104         mObject = object;
 105       }
 106     }
 107     return rv;
 108   }
 109   nsresult set(const nsScriptObjectHolder &other) {
 110     NS_ASSERTION(getScriptTypeID() == other.getScriptTypeID(),
 111                  "Must have identical languages!");
 112     nsresult rv = drop();
 113     if (NS_FAILED(rv))
 114       return rv;
 115     return set(other.mObject);
 116   }
 117   // Get the language ID.
 118   PRUint32 getScriptTypeID() const {
 119     return mContext->GetScriptTypeID();
 120   }
 121 protected:
 122   void *mObject;
 123   nsCOMPtr<nsIScriptContext> mContext;
 124 };
 125
 126 #endif // nsDOMScriptObjectHolder_h__