js/src/xpconnect/public/nsAXPCNativeCallContext.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
   2  *
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is Mozilla Communicator client code, released
  17  * March 31, 1998.
  18  *
  19  * The Initial Developer of the Original Code is
  20  * Netscape Communications Corporation.
  21  * Portions created by the Initial Developer are Copyright (C) 1998
  22  * the Initial Developer. All Rights Reserved.
  23  *
  24  * Contributor(s):
  25  *   John Bandhauer <jband@netscape.com> (original author)
  26  *   Nate Nielsen <nielsen@memberwebs.com>
  27  *
  28  * Alternatively, the contents of this file may be used under the terms of
  29  * either of the GNU General Public License Version 2 or later (the "GPL"),
  30  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  31  * in which case the provisions of the GPL or the LGPL are applicable instead
  32  * of those above. If you wish to allow use of your version of this file only
  33  * under the terms of either the GPL or the LGPL, and not to allow others to
  34  * use your version of this file under the terms of the MPL, indicate your
  35  * decision by deleting the provisions above and replace them with the notice
  36  * and other provisions required by the GPL or the LGPL. If you do not delete
  37  * the provisions above, a recipient may use your version of this file under
  38  * the terms of any one of the MPL, the GPL or the LGPL.
  39  *
  40  * ***** END LICENSE BLOCK ***** */
  41
  42 #ifndef nsAXPCNativeCallContext_h__
  43 #define nsAXPCNativeCallContext_h__
  44
  45 class nsIXPConnectWrappedNative;
  46
  47 /**
  48 * A native call context is allocated on the stack when XPConnect calls a
  49 * native method. Holding a pointer to this object beyond the currently
  50 * executing stack frame is not permitted.
  51 */
  52 class nsAXPCNativeCallContext
  53 {
  54 public:
  55     NS_IMETHOD GetCallee(nsISupports **aResult) = 0;
  56     NS_IMETHOD GetCalleeMethodIndex(PRUint16 *aResult) = 0;
  57     NS_IMETHOD GetCalleeWrapper(nsIXPConnectWrappedNative **aResult) = 0;
  58     NS_IMETHOD GetJSContext(JSContext **aResult) = 0;
  59     NS_IMETHOD GetArgc(PRUint32 *aResult) = 0;
  60     NS_IMETHOD GetArgvPtr(jsval **aResult) = 0;
  61
  62     /**
  63      * This may be NULL if the JS caller is ignoring the result of the call.
  64      */
  65     NS_IMETHOD GetRetValPtr(jsval **aResult) = 0;
  66
  67     /**
  68      * Set this to indicate that the callee has directly set the return value
  69      * (using RetValPtr and the JSAPI). If set then xpconnect will not attempt
  70      * to overwrite it with the converted retval from the C++ callee.
  71      */
  72     NS_IMETHOD GetReturnValueWasSet(PRBool *aResult) = 0;
  73     NS_IMETHOD SetReturnValueWasSet(PRBool aValue) = 0;
  74
  75     // Methods added since mozilla 0.6....
  76
  77     NS_IMETHOD GetCalleeInterface(nsIInterfaceInfo **aResult) = 0;
  78     NS_IMETHOD GetCalleeClassInfo(nsIClassInfo **aResult) = 0;
  79
  80     NS_IMETHOD GetPreviousCallContext(nsAXPCNativeCallContext **aResult) = 0;
  81
  82     enum { LANG_UNKNOWN = 0,
  83            LANG_JS      = 1,
  84            LANG_NATIVE  = 2 };
  85
  86     NS_IMETHOD GetLanguage(PRUint16 *aResult) = 0;
  87 };
  88
  89 #endif