/js/lib/Socket.IO-node/support/expresso/deps/jscoverage/js/jsiter.h
C++ Header | 140 lines | 54 code | 21 blank | 65 comment | 1 complexity | c1a9245b3f64d1a0a7d6959f498329f5 MD5 | raw file
Possible License(s): GPL-2.0, LGPL-2.1, MPL-2.0-no-copyleft-exception, BSD-3-Clause
- /* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
- * vim: set ts=8 sw=4 et tw=78:
- *
- * ***** BEGIN LICENSE BLOCK *****
- * Version: MPL 1.1/GPL 2.0/LGPL 2.1 *
- * The contents of this file are subject to the Mozilla Public License Version
- * 1.1 (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- * http://www.mozilla.org/MPL/
- *
- * Software distributed under the License is distributed on an "AS IS" basis,
- * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
- * for the specific language governing rights and limitations under the
- * License.
- *
- * The Original Code is Mozilla Communicator client code, released
- * March 31, 1998.
- *
- * The Initial Developer of the Original Code is
- * Netscape Communications Corporation.
- * Portions created by the Initial Developer are Copyright (C) 1998
- * the Initial Developer. All Rights Reserved.
- *
- * Contributor(s):
- *
- * Alternatively, the contents of this file may be used under the terms of
- * either of the GNU General Public License Version 2 or later (the "GPL"),
- * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
- * in which case the provisions of the GPL or the LGPL are applicable instead
- * of those above. If you wish to allow use of your version of this file only
- * under the terms of either the GPL or the LGPL, and not to allow others to
- * use your version of this file under the terms of the MPL, indicate your
- * decision by deleting the provisions above and replace them with the notice
- * and other provisions required by the GPL or the LGPL. If you do not delete
- * the provisions above, a recipient may use your version of this file under
- * the terms of any one of the MPL, the GPL or the LGPL.
- *
- * ***** END LICENSE BLOCK ***** */
- #ifndef jsiter_h___
- #define jsiter_h___
- /*
- * JavaScript iterators.
- */
- #include "jsprvtd.h"
- #include "jspubtd.h"
- JS_BEGIN_EXTERN_C
- /*
- * NB: these flag bits are encoded into the bytecode stream in the immediate
- * operand of JSOP_ITER, so don't change them without advancing jsxdrapi.h's
- * JSXDR_BYTECODE_VERSION.
- */
- #define JSITER_ENUMERATE 0x1 /* for-in compatible hidden default iterator */
- #define JSITER_FOREACH 0x2 /* return [key, value] pair rather than key */
- #define JSITER_KEYVALUE 0x4 /* destructuring for-in wants [key, value] */
- /*
- * Native iterator object slots, shared between jsiter.cpp and jstracer.cpp.
- */
- #define JSSLOT_ITER_STATE (JSSLOT_PRIVATE)
- #define JSSLOT_ITER_FLAGS (JSSLOT_PRIVATE + 1)
- /*
- * Convert the value stored in *vp to its iteration object. The flags should
- * contain JSITER_ENUMERATE if js_ValueToIterator is called when enumerating
- * for-in semantics are required, and when the caller can guarantee that the
- * iterator will never be exposed to scripts.
- */
- extern JS_FRIEND_API(JSBool)
- js_ValueToIterator(JSContext *cx, uintN flags, jsval *vp);
- extern JS_FRIEND_API(JSBool) JS_FASTCALL
- js_CloseIterator(JSContext *cx, jsval v);
- /*
- * Given iterobj, call iterobj.next(). If the iterator stopped, set *rval to
- * JSVAL_HOLE. Otherwise set it to the result of the next call.
- */
- extern JS_FRIEND_API(JSBool)
- js_CallIteratorNext(JSContext *cx, JSObject *iterobj, jsval *rval);
- /*
- * Close iterobj, whose class must be js_IteratorClass.
- */
- extern void
- js_CloseNativeIterator(JSContext *cx, JSObject *iterobj);
- extern JSBool
- js_ThrowStopIteration(JSContext *cx);
- #if JS_HAS_GENERATORS
- /*
- * Generator state codes.
- */
- typedef enum JSGeneratorState {
- JSGEN_NEWBORN, /* not yet started */
- JSGEN_OPEN, /* started by a .next() or .send(undefined) call */
- JSGEN_RUNNING, /* currently executing via .next(), etc., call */
- JSGEN_CLOSING, /* close method is doing asynchronous return */
- JSGEN_CLOSED /* closed, cannot be started or closed again */
- } JSGeneratorState;
- struct JSGenerator {
- JSObject *obj;
- JSGeneratorState state;
- JSStackFrame frame;
- JSFrameRegs savedRegs;
- JSArena arena;
- jsval slots[1];
- };
- #define FRAME_TO_GENERATOR(fp) \
- ((JSGenerator *) ((uint8 *)(fp) - offsetof(JSGenerator, frame)))
- extern JSObject *
- js_NewGenerator(JSContext *cx, JSStackFrame *fp);
- #endif
- extern JSClass js_GeneratorClass;
- extern JSClass js_IteratorClass;
- extern JSClass js_StopIterationClass;
- static inline bool
- js_ValueIsStopIteration(jsval v)
- {
- return !JSVAL_IS_PRIMITIVE(v) &&
- STOBJ_GET_CLASS(JSVAL_TO_OBJECT(v)) == &js_StopIterationClass;
- }
- extern JSObject *
- js_InitIteratorClasses(JSContext *cx, JSObject *obj);
- JS_END_EXTERN_C
- #endif /* jsiter_h___ */