summaryrefslogtreecommitdiff
path: root/dom/base/nsDOMJSUtils.h
blob: 6d09fb7bba965a9d28f9a050781143552b0196ab (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef nsDOMJSUtils_h__
#define nsDOMJSUtils_h__

#include "nsIScriptContext.h"
#include "jsapi.h"

class nsIJSArgArray;

// A factory function for turning a JS::Value argv into an nsIArray
// but also supports an effecient way of extracting the original argv.
// The resulting object will take a copy of the array, and ensure each
// element is rooted.
// Optionally, aArgv may be nullptr, in which case the array is allocated and
// rooted, but all items remain nullptr.  This presumably means the caller
// will then QI us for nsIJSArgArray, and set our array elements.
nsresult NS_CreateJSArgv(JSContext *aContext, uint32_t aArgc,
                         const JS::Value* aArgv, nsIJSArgArray **aArray);

#endif // nsDOMJSUtils_h__