diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,20 @@ +Haskell bindings: Copyright (c) 2015 Greg V +Duktape: Copyright (c) 2013-2015 by Duktape authors (see duktape/AUTHORS.rst) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 --- /dev/null +++ b/README.md @@ -0,0 +1,65 @@ +# hs-duktape [![Hackage](https://img.shields.io/hackage/v/hs-duktape.svg?style=flat)](https://hackage.haskell.org/package/hs-duktape) [![Build Status](https://img.shields.io/travis/myfreeweb/hs-duktape.svg?style=flat)](https://travis-ci.org/myfreeweb/hs-duktape) [![MIT License](https://img.shields.io/badge/mit-license-green.svg?style=flat)](https://tldrlegal.com/license/mit-license) + +Haskell bindings for [duktape], a very compact embedded ECMAScript (JavaScript) engine. + +[duktape]: http://duktape.org + +## Usage + +Here's a simple REPL example: + +```haskell +module Main where + +import Scripting.Duktape +import Control.Monad (forever) +import Data.ByteString.Char8 (pack) +import System.IO (hFlush, stdout) + +main :: IO () +main = do + dukm <- createDuktapeCtx + case dukm of + Nothing -> putStrLn "I can't even (start Duktape)" + Just duk -> forever $ do + putStr "duktape> " + hFlush stdout + retVal <- evalDuktape duk =<< return . pack =<< getLine + case retVal of + Left e -> putStrLn $ "Duktape error: " ++ e + Right Nothing -> putStrLn "No result" + Right (Just v) -> print v +``` + +[Aeson]'s `Value` type is used for exchanging values between Haskell and ECMAScript. +[lens-aeson] is a good library for working with `Value`, um, values. + +[Aeson]: https://hackage.haskell.org/package/aeson +[lens-aeson]: https://hackage.haskell.org/package/lens-aeson + +## Development + +Use [stack] to build. + +```bash +$ stack build + +$ stack test && rm tests.tix +``` + +[stack]: https://github.com/commercialhaskell/stack + +## Contributing + +Please feel free to submit pull requests! +Bugfixes and simple non-breaking improvements will be accepted without any questions :-) + +By participating in this project you agree to follow the [Contributor Code of Conduct](http://contributor-covenant.org/version/1/2/0/). + +[The list of contributors is available on GitHub](https://github.com/myfreeweb/hs-duktape/graphs/contributors). + +## License + +Licensed under the MIT license (see to the `LICENSE` file). +Haskell bindings: Copyright (c) 2015 Greg V +Duktape: Copyright (c) 2013-2015 by Duktape authors (see duktape/AUTHORS.rst) diff --git a/duktape/src/duktape.c b/duktape/src/duktape.c new file mode 100644 # file too large to diff: duktape/src/duktape.c diff --git a/duktape/src/duktape.h b/duktape/src/duktape.h new file mode 100644 --- /dev/null +++ b/duktape/src/duktape.h @@ -0,0 +1,4460 @@ +/* + * Duktape public API for Duktape 1.2.3. + * See the API reference for documentation on call semantics. + * The exposed API is inside the DUK_API_PUBLIC_H_INCLUDED + * include guard. Other parts of the header are Duktape + * internal and related to platform/compiler/feature detection. + * + * Git commit 0605a18660dbae486c62a42a33fabd034c8623ff (v1.2.3). + * + * See Duktape AUTHORS.rst and LICENSE.txt for copyright and + * licensing information. + */ + +/* LICENSE.txt */ +/* + * =============== + * Duktape license + * =============== + * + * (http://opensource.org/licenses/MIT) + * + * Copyright (c) 2013-2015 by Duktape authors (see AUTHORS.rst) + * + * Permission is hereby granted, free of charge, to any person obtaining a copy + * of this software and associated documentation files (the "Software"), to deal + * in the Software without restriction, including without limitation the rights + * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + * copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN + * THE SOFTWARE. + * + */ + +/* AUTHORS.rst */ +/* + * =============== + * Duktape authors + * =============== + * + * Copyright + * ========= + * + * Duktape copyrights are held by its authors. Each author has a copyright + * to their contribution, and agrees to irrevocably license the contribution + * under the Duktape ``LICENSE.txt``. + * + * Authors + * ======= + * + * Please include an e-mail address, a link to your GitHub profile, or something + * similar to allow your contribution to be identified accurately. + * + * The following people have contributed code and agreed to irrevocably license + * their contributions under the Duktape ``LICENSE.txt`` (in order of appearance): + * + * * Sami Vaarala + * * Niki Dobrev + * * Andreas \u00d6man + * * L\u00e1szl\u00f3 Lang\u00f3 + * * Legimet + * + * Other contributions + * =================== + * + * The following people have contributed something other than code (e.g. reported + * bugs, provided ideas, etc; roughly in order of appearance): + * + * * Greg Burns + * * Anthony Rabine + * * Carlos Costa + * * Aur\u00e9lien Bouilland + * * Preet Desai (Pris Matic) + * * judofyr (http://www.reddit.com/user/judofyr) + * * Jason Woofenden + * * Micha\u0142 Przyby\u015b + * * Anthony Howe + * * Conrad Pankoff + * * Jim Schimpf + * * Rajaran Gaunker (https://github.com/zimbabao) + * * Andreas \u00d6man + * * Doug Sanden + * * Josh Engebretson (https://github.com/JoshEngebretson) + * * Remo Eichenberger (https://github.com/remoe) + * * Mamod Mehyar (https://github.com/mamod) + * * David Demelier (https://github.com/hftmarkand) + * * Tim Caswell (https://github.com/creationix) + * * Mitchell Blank Jr (https://github.com/mitchblank) + * * https://github.com/yushli + * * Seo Sanghyeon (https://github.com/sanxiyn) + * * Han ChoongWoo (https://github.com/tunz) + * * Joshua Peek (https://github.com/josh) + * * Bruce E. Pascoe (https://github.com/fatcerberus) + * * https://github.com/Kelledin + * * https://github.com/sstruchtrup + * + * If you are accidentally missing from this list, send me an e-mail + * (``sami.vaarala@iki.fi``) and I'll fix the omission. + */ + +#ifndef DUKTAPE_H_INCLUDED +#define DUKTAPE_H_INCLUDED + +#define DUK_SINGLE_FILE + +/* + * Determine platform features, select feature selection defines + * (e.g. _XOPEN_SOURCE), include system headers, and define DUK_USE_XXX + * defines which are (only) checked in Duktape internal code for + * activated features. Duktape feature selection is based on automatic + * feature detection, user supplied DUK_OPT_xxx defines, and optionally + * a "duk_custom.h" user header (if DUK_OPT_HAVE_CUSTOM_H is defined). + * + * When compiling Duktape, DUK_COMPILING_DUKTAPE is set, and this file + * is included before any system headers are included. Feature selection + * defines (e.g. _XOPEN_SOURCE) are defined here before any system headers + * are included (which is a requirement for system headers to work correctly). + * This file is responsible for including all system headers and contains + * all platform dependent cruft in general. When compiling user code, + * DUK_COMPILING_DUKTAPE is not defined, and we must avoid e.g. defining + * unnecessary feature selection defines. + * + * The general order of handling: + * - Compiler feature detection (require no includes) + * - Intermediate platform detection (-> easier platform defines) + * - Platform detection, system includes, byte order detection, etc + * - ANSI C wrappers (e.g. DUK_MEMCMP), wrappers for constants, etc + * - DUK_USE_xxx defines are resolved based on input defines + * - Duktape Date provider settings + * - Final sanity checks + * + * DUK_F_XXX are internal feature detection macros which should not be + * used outside this header. + * + * Useful resources: + * + * http://sourceforge.net/p/predef/wiki/Home/ + * http://sourceforge.net/p/predef/wiki/Architectures/ + * http://stackoverflow.com/questions/5919996/how-to-detect-reliably-mac-os-x-ios-linux-windows-in-c-preprocessor + * http://en.wikipedia.org/wiki/C_data_types#Fixed-width_integer_types + * + * Preprocessor defines available in a particular GCC: + * + * gcc -dM -E - = 199901L) +#define DUK_F_C99 +#endif + +#undef DUK_F_CPP +#if defined(__cplusplus) +#define DUK_F_CPP +#endif + +#undef DUK_F_CPP11 +#if defined(__cplusplus) && (__cplusplus >= 201103L) +#define DUK_F_CPP11 +#endif + +/* + * Provides the duk_rdtsc() inline function (if available), limited to + * GCC C99. + * + * See: http://www.mcs.anl.gov/~kazutomo/rdtsc.html + */ + +/* XXX: more accurate detection of what gcc versions work; more inline + * asm versions for other compilers. + */ +#if defined(__GNUC__) && defined(__i386__) && defined(DUK_F_C99) && \ + !defined(__cplusplus) /* unsigned long long not standard */ +static __inline__ unsigned long long duk_rdtsc(void) { + unsigned long long int x; + __asm__ volatile (".byte 0x0f, 0x31" : "=A" (x)); + return x; +} +#define DUK_RDTSC_AVAILABLE 1 +#elif defined(__GNUC__) && defined(__x86_64__) && defined(DUK_F_C99) && \ + !defined(__cplusplus) /* unsigned long long not standard */ +static __inline__ unsigned long long duk_rdtsc(void) { + unsigned hi, lo; + __asm__ __volatile__ ("rdtsc" : "=a"(lo), "=d"(hi)); + return ((unsigned long long) lo) | (((unsigned long long) hi) << 32); +} +#define DUK_RDTSC_AVAILABLE 1 +#else +/* not available */ +#undef DUK_RDTSC_AVAILABLE +#endif + +/* + * Intermediate platform, architecture, and compiler detection. These are + * hopelessly intertwined - e.g. architecture defines depend on compiler etc. + * + * Provide easier defines for platforms and compilers which are often tricky + * or verbose to detect. The intent is not to provide intermediate defines for + * all features; only if existing feature defines are inconvenient. + */ + +/* Intel x86 (32-bit) */ +#if defined(i386) || defined(__i386) || defined(__i386__) || \ + defined(__i486__) || defined(__i586__) || defined(__i686__) || \ + defined(__IA32__) || defined(_M_IX86) || defined(__X86__) || \ + defined(_X86_) || defined(__THW_INTEL__) || defined(__I86__) +#define DUK_F_X86 +#endif + +/* AMD64 (64-bit) */ +#if defined(__amd64__) || defined(__amd64) || \ + defined(__x86_64__) || defined(__x86_64) || \ + defined(_M_X64) || defined(_M_AMD64) +#define DUK_F_X64 +#endif + +/* X32: 64-bit with 32-bit pointers (allows packed tvals). X32 support is + * not very mature yet. + * + * https://sites.google.com/site/x32abi/ + */ +#if defined(DUK_F_X64) && \ + (defined(_ILP32) || defined(__ILP32__)) +#define DUK_F_X32 +/* define only one of: DUK_F_X86, DUK_F_X32, or DUK_F_X64 */ +#undef DUK_F_X64 +#undef DUK_F_X86 +#endif + +/* ARM */ +#if defined(__arm__) || defined(__thumb__) || defined(_ARM) || defined(_M_ARM) +#define DUK_F_ARM +#endif + +/* MIPS */ +/* Related defines: __MIPSEB__, __MIPSEL__, __mips_isa_rev, __LP64__ */ +#if defined(__mips__) || defined(mips) || defined(_MIPS_ISA) || \ + defined(_R3000) || defined(_R4000) || defined(_R5900) || \ + defined(_MIPS_ISA_MIPS1) || defined(_MIPS_ISA_MIPS2) || \ + defined(_MIPS_ISA_MIPS3) || defined(_MIPS_ISA_MIPS4) || \ + defined(__mips) || defined(__MIPS__) +#define DUK_F_MIPS +#if defined(__LP64__) || defined(__mips64) || defined(__mips64__) || \ + defined(__mips_n64) +#define DUK_F_MIPS64 +#else +#define DUK_F_MIPS32 +#endif +#endif + +/* SuperH */ +#if defined(__sh__) || \ + defined(__sh1__) || defined(__SH1__) || \ + defined(__sh2__) || defined(__SH2__) || \ + defined(__sh3__) || defined(__SH3__) || \ + defined(__sh4__) || defined(__SH4__) || \ + defined(__sh5__) || defined(__SH5__) +#define DUK_F_SUPERH +#endif + +/* Motorola 68K. Not defined by VBCC, so user must define one of these + * manually when using VBCC. + */ +#if defined(__m68k__) || defined(M68000) || defined(__MC68K__) +#define DUK_F_M68K +#endif + +/* Linux */ +#if defined(__linux) || defined(__linux__) || defined(linux) +#define DUK_F_LINUX +#endif + +/* FreeBSD */ +#if defined(__FreeBSD__) || defined(__FreeBSD) +#define DUK_F_FREEBSD +#endif + +/* NetBSD */ +#if defined(__NetBSD__) || defined(__NetBSD) +#define DUK_F_NETBSD +#endif + +/* OpenBSD */ +#if defined(__OpenBSD__) || defined(__OpenBSD) +#define DUK_F_OPENBSD +#endif + +/* BSD variant */ +#if defined(DUK_F_FREEBSD) || defined(DUK_F_NETBSD) || defined(DUK_F_OPENBSD) || \ + defined(__bsdi__) || defined(__DragonFly__) +#define DUK_F_BSD +#endif + +/* Generic Unix (includes Cygwin) */ +#if defined(__unix) || defined(__unix__) || defined(unix) || \ + defined(DUK_F_LINUX) || defined(DUK_F_BSD) +#define DUK_F_UNIX +#endif + +/* Cygwin */ +#if defined(__CYGWIN__) +#define DUK_F_CYGWIN +#endif + +/* Windows (32-bit or above) */ +#if defined(_WIN32) || defined(WIN32) || defined(_WIN64) || defined(WIN64) || \ + defined(__WIN32__) || defined(__TOS_WIN__) || defined(__WINDOWS__) +#define DUK_F_WINDOWS +#endif + +#if defined(__APPLE__) +#define DUK_F_APPLE +#endif + +/* Atari ST TOS. __TOS__ defined by PureC (which doesn't work as a target now + * because int is 16-bit, to be fixed). No platform define in VBCC apparently, + * so to use with VBCC, user must define '__TOS__' manually. + */ +#if defined(__TOS__) +#define DUK_F_TOS +#endif + +/* AmigaOS. Neither AMIGA nor __amigaos__ is defined on VBCC, so user must + * define 'AMIGA' manually. + */ +#if defined(AMIGA) || defined(__amigaos__) +#define DUK_F_AMIGAOS +#endif + +/* Flash player (e.g. Crossbridge) */ +#if defined(__FLASHPLAYER__) +#define DUK_F_FLASHPLAYER +#endif + +/* Emscripten (provided explicitly by user), improve if possible */ +#if defined(EMSCRIPTEN) +#define DUK_F_EMSCRIPTEN +#endif + +/* QNX */ +#if defined(__QNX__) +#define DUK_F_QNX +#endif + +/* TI-Nspire (using Ndless) */ +#if defined(_TINSPIRE) +#define DUK_F_TINSPIRE +#endif + +/* GCC and GCC version convenience define. */ +#if defined(__GNUC__) +#define DUK_F_GCC +#if defined(__GNUC__) && defined(__GNUC_MINOR__) && defined(__GNUC_PATCHLEVEL__) +/* Convenience, e.g. gcc 4.5.1 == 40501; http://stackoverflow.com/questions/6031819/emulating-gccs-builtin-unreachable */ +#define DUK_F_GCC_VERSION (__GNUC__ * 10000L + __GNUC_MINOR__ * 100L + __GNUC_PATCHLEVEL__) +#else +#error cannot figure out gcc version +#endif +#endif + +/* Clang */ +#if defined(__clang__) +#define DUK_F_CLANG +/* It seems clang also defines __GNUC__, so undo the GCC detection. */ +#if defined(DUK_F_GCC) +#undef DUK_F_GCC +#endif +#if defined(DUK_F_GCC_VERSION) +#undef DUK_F_GCC_VERSION +#endif +#endif + +/* MSVC */ +#if defined(_MSC_VER) +/* MSVC preprocessor defines: http://msdn.microsoft.com/en-us/library/b0084kay.aspx + * _MSC_FULL_VER includes the build number, but it has at least two formats, see e.g. + * BOOST_MSVC_FULL_VER in http://www.boost.org/doc/libs/1_52_0/boost/config/compiler/visualc.hpp + */ +#define DUK_F_MSVC +#if defined(_MSC_FULL_VER) +#if (_MSC_FULL_VER > 100000000) +#define DUK_F_MSVC_FULL_VER _MSC_FULL_VER +#else +#define DUK_F_MSCV_FULL_VER (_MSC_FULL_VER * 10) +#endif +#endif +#endif /* _MSC_VER */ + +/* MinGW */ +#if defined(__MINGW32__) || defined(__MINGW64__) +/* NOTE: Also GCC flags are detected (DUK_F_GCC etc). */ +#define DUK_F_MINGW +#endif + +/* BCC (Bruce's C compiler): this is a "torture target" for compilation */ +#if defined(__BCC__) || defined(__BCC_VERSION__) +#define DUK_F_BCC +#endif + +#if defined(__VBCC__) +#define DUK_F_VBCC +#endif + +#if (defined(DUK_F_C99) || defined(DUK_F_CPP11)) && \ + !defined(DUK_F_BCC) +/* ULL / LL preprocessor constants should be avoided because they're not + * always available. With suitable options, some compilers will support + * 64-bit integer types but won't support ULL / LL preprocessor constants. + * Assume C99/C++11 environments have these. However, BCC is nominally + * C99 but doesn't support these constants. + */ +#define DUK_F_ULL_CONSTS +#endif + +/* + * Platform detection, system includes, Date provider selection. + * + * Feature selection (e.g. _XOPEN_SOURCE) must happen before any system + * headers are included. This header should avoid providing any feature + * selection defines when compiling user code (only when compiling Duktape + * itself). If a feature selection option is required for user code to + * compile correctly (e.g. it is needed for type detection), it should + * probably be -checked- here, not defined here. + * + * Date provider selection seems a bit out-of-place here, but since + * the date headers and provider functions are heavily platform + * specific, there's little point in duplicating the platform if-else + * ladder. All platform specific Date provider functions are in + * duk_bi_date.c; here we provide appropriate #defines to enable them, + * and include all the necessary system headers so that duk_bi_date.c + * compiles. Date "providers" are: + * + * NOW = getting current time (required) + * TZO = getting local time offset (required) + * PRS = parse datetime (optional) + * FMT = format datetime (optional) + * + * There's a lot of duplication here, unfortunately, because many + * platforms have similar (but not identical) headers, Date providers, + * etc. The duplication could be removed by more complicated nested + * #ifdefs, but it would then be more difficult to make fixes which + * affect only a specific platform. + * + * XXX: add a way to provide custom functions to provide the critical + * primitives; this would be convenient when porting to unknown platforms + * (rather than muck with Duktape internals). + */ + +#if defined(DUK_COMPILING_DUKTAPE) && \ + (defined(DUK_F_LINUX) || defined(DUK_F_EMSCRIPTEN)) +/* A more recent Emscripten (2014-05) seems to lack "linux" environment + * defines, so check for Emscripten explicitly. + */ +#ifndef _POSIX_C_SOURCE +#define _POSIX_C_SOURCE 200809L +#endif +#ifndef _GNU_SOURCE +#define _GNU_SOURCE /* e.g. getdate_r */ +#endif +#ifndef _XOPEN_SOURCE +#define _XOPEN_SOURCE /* e.g. strptime */ +#endif +#endif + +#if defined(DUK_F_QNX) && defined(DUK_COMPILING_DUKTAPE) +/* See: /opt/qnx650/target/qnx6/usr/include/sys/platform.h */ +#define _XOPEN_SOURCE 600 +#define _POSIX_C_SOURCE 200112L +#endif + +#undef DUK_F_MSVC_CRT_SECURE +#if defined(DUK_F_WINDOWS) && defined(_MSC_VER) +/* http://msdn.microsoft.com/en-us/library/8ef0s5kh.aspx + * http://msdn.microsoft.com/en-us/library/wd3wzwts.aspx + * Seem to be available since VS2005. + */ +#if (_MSC_VER >= 1400) +/* VS2005+, secure CRT functions are preferred. Windows Store applications + * (and probably others) should use these. + */ +#define DUK_F_MSVC_CRT_SECURE +#endif +#if (_MSC_VER < 1700) +/* VS2012+ has stdint.h, < VS2012 does not (but it's available for download). */ +#define DUK_F_NO_STDINT_H +#endif +/* Initial fix: disable secure CRT related warnings when compiling Duktape + * itself (must be defined before including Windows headers). Don't define + * for user code including duktape.h. + */ +#if defined(DUK_COMPILING_DUKTAPE) && !defined(_CRT_SECURE_NO_WARNINGS) +#define _CRT_SECURE_NO_WARNINGS +#endif +#endif /* DUK_F_WINDOWS && _MSC_VER */ + +#if defined(DUK_F_TOS) || defined(DUK_F_BCC) +#define DUK_F_NO_STDINT_H +#endif + +/* Workaround for older C++ compilers before including , + * see e.g.: https://sourceware.org/bugzilla/show_bug.cgi?id=15366 + */ +#if defined(__cplusplus) && !defined(__STDC_LIMIT_MACROS) +#define __STDC_LIMIT_MACROS +#endif +#if defined(__cplusplus) && !defined(__STDC_CONSTANT_MACROS) +#define __STDC_CONSTANT_MACROS +#endif + +#if defined(__APPLE__) +/* Mac OSX, iPhone, Darwin */ +#define DUK_USE_DATE_NOW_GETTIMEOFDAY +#define DUK_USE_DATE_TZO_GMTIME_R +#define DUK_USE_DATE_PRS_STRPTIME +#define DUK_USE_DATE_FMT_STRFTIME +#include +#include +#include +#include +#include +#include +#elif defined(DUK_F_OPENBSD) +/* http://www.monkey.org/openbsd/archive/ports/0401/msg00089.html */ +#define DUK_USE_DATE_NOW_GETTIMEOFDAY +#define DUK_USE_DATE_TZO_GMTIME_R +#define DUK_USE_DATE_PRS_STRPTIME +#define DUK_USE_DATE_FMT_STRFTIME +#include +#include +#include +#include +#include +#include +#elif defined(DUK_F_BSD) +/* other BSD */ +#define DUK_USE_DATE_NOW_GETTIMEOFDAY +#define DUK_USE_DATE_TZO_GMTIME_R +#define DUK_USE_DATE_PRS_STRPTIME +#define DUK_USE_DATE_FMT_STRFTIME +#include +#include +#include +#include +#include +#include +#elif defined(DUK_F_TOS) +/* Atari ST TOS */ +#define DUK_USE_DATE_NOW_TIME +#define DUK_USE_DATE_TZO_GMTIME +/* no parsing (not an error) */ +#define DUK_USE_DATE_FMT_STRFTIME +#include +#include +#elif defined(DUK_F_AMIGAOS) +#if defined(DUK_F_M68K) +/* AmigaOS on M68k */ +#define DUK_USE_DATE_NOW_TIME +#define DUK_USE_DATE_TZO_GMTIME +/* no parsing (not an error) */ +#define DUK_USE_DATE_FMT_STRFTIME +#include +#include +#else +#error AmigaOS but not M68K, not supported now +#endif +#elif defined(DUK_F_WINDOWS) +/* Windows 32-bit and 64-bit are currently the same. */ +/* MSVC does not have sys/param.h */ +#define DUK_USE_DATE_NOW_WINDOWS +#define DUK_USE_DATE_TZO_WINDOWS +/* Note: PRS and FMT are intentionally left undefined for now. This means + * there is no platform specific date parsing/formatting but there is still + * the ISO 8601 standard format. + */ +#include +#include +#elif defined(DUK_F_FLASHPLAYER) +/* Crossbridge */ +#define DUK_USE_DATE_NOW_GETTIMEOFDAY +#define DUK_USE_DATE_TZO_GMTIME_R +#define DUK_USE_DATE_PRS_STRPTIME +#define DUK_USE_DATE_FMT_STRFTIME +#include +#include +#include +#include +#include +#elif defined(DUK_F_QNX) +#define DUK_USE_DATE_NOW_GETTIMEOFDAY +#define DUK_USE_DATE_TZO_GMTIME_R +#define DUK_USE_DATE_PRS_STRPTIME +#define DUK_USE_DATE_FMT_STRFTIME +#include +#include +#include +#include +#include +#elif defined(DUK_F_TINSPIRE) +#define DUK_USE_DATE_NOW_GETTIMEOFDAY +#define DUK_USE_DATE_TZO_GMTIME_R +#define DUK_USE_DATE_PRS_STRPTIME +#define DUK_USE_DATE_FMT_STRFTIME +#include +#include +#include +#include +#include +#elif defined(DUK_F_LINUX) +#define DUK_USE_DATE_NOW_GETTIMEOFDAY +#define DUK_USE_DATE_TZO_GMTIME_R +#define DUK_USE_DATE_PRS_STRPTIME +#define DUK_USE_DATE_FMT_STRFTIME +#include +#if defined(DUK_F_BCC) +/* no endian.h */ +#else +#include +#endif /* DUK_F_BCC */ +#include +#include +#include +#include +#elif defined(__posix) +/* POSIX */ +#define DUK_USE_DATE_NOW_GETTIMEOFDAY +#define DUK_USE_DATE_TZO_GMTIME_R +#define DUK_USE_DATE_PRS_STRPTIME +#define DUK_USE_DATE_FMT_STRFTIME +#include +#include +#include +#include +#include +#include +#elif defined(DUK_F_CYGWIN) +/* Cygwin -- don't use strptime() for now */ +#define DUK_USE_DATE_NOW_GETTIMEOFDAY +#define DUK_USE_DATE_TZO_GMTIME_R +#define DUK_USE_DATE_FMT_STRFTIME +#include +#include +#include +#include +#include +#include +#else +/* Other UNIX, hopefully others */ +#define DUK_USE_DATE_NOW_GETTIMEOFDAY +#define DUK_USE_DATE_TZO_GMTIME_R +#define DUK_USE_DATE_PRS_STRPTIME +#define DUK_USE_DATE_FMT_STRFTIME +#include +#if defined(DUK_F_BCC) +/* no endian.h */ +#else +#include +#endif /* DUK_F_BCC */ +#include +#include +#include +#include +#endif + +/* Shared includes */ +#include +#include +#include +#include /* varargs */ +#include +#include /* e.g. ptrdiff_t */ +#if defined(DUK_F_NO_STDINT_H) +/* stdint.h not available */ +#else +/* Technically C99 (C++11) but found in many systems. Note the workaround + * above for some C++ compilers (__STDC_LIMIT_MACROS etc). + */ +#include +#endif +#include + +/* + * Detection for specific libc variants (like uclibc) and other libc specific + * features. Potentially depends on the #includes above. + */ + +#if defined(__UCLIBC__) +#define DUK_F_UCLIBC +#endif + +/* + * Wrapper typedefs and constants for integer types, also sanity check types. + * + * C99 typedefs are quite good but not always available, and we want to avoid + * forcibly redefining the C99 typedefs. So, there are Duktape wrappers for + * all C99 typedefs and Duktape code should only use these typedefs. Type + * detection when C99 is not supported is best effort and may end up detecting + * some types incorrectly. + * + * Pointer sizes are a portability problem: pointers to different types may + * have a different size and function pointers are very difficult to manage + * portably. + * + * http://en.wikipedia.org/wiki/C_data_types#Fixed-width_integer_types + * + * Note: there's an interesting corner case when trying to define minimum + * signed integer value constants which leads to the current workaround of + * defining e.g. -0x80000000 as (-0x7fffffffL - 1L). See doc/code-issues.txt + * for a longer discussion. + * + * Note: avoid typecasts and computations in macro integer constants as they + * can then no longer be used in macro relational expressions (such as + * #if DUK_SIZE_MAX < 0xffffffffUL). There is internal code which relies on + * being able to compare DUK_SIZE_MAX against a limit. + */ + +/* XXX: add feature options to force basic types from outside? */ + +#if !defined(INT_MAX) +#error INT_MAX not defined +#endif + +/* Check that architecture is two's complement, standard C allows e.g. + * INT_MIN to be -2**31+1 (instead of -2**31). + */ +#if defined(INT_MAX) && defined(INT_MIN) +#if INT_MAX != -(INT_MIN + 1) +#error platform does not seem complement of two +#endif +#else +#error cannot check complement of two +#endif + +/* Pointer size determination based on architecture. + * XXX: unsure about BCC correctness. + */ +#if defined(DUK_F_X86) || defined(DUK_F_X32) || \ + defined(DUK_F_BCC) || \ + (defined(__WORDSIZE) && (__WORDSIZE == 32)) +#define DUK_F_32BIT_PTRS +#elif defined(DUK_F_X64) || \ + (defined(__WORDSIZE) && (__WORDSIZE == 64)) +#define DUK_F_64BIT_PTRS +#else +/* not sure, not needed with C99 anyway */ +#endif + +/* Intermediate define for 'have inttypes.h' */ +#undef DUK_F_HAVE_INTTYPES +#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) && \ + !(defined(DUK_F_AMIGAOS) && defined(DUK_F_VBCC)) +/* vbcc + AmigaOS has C99 but no inttypes.h */ +#define DUK_F_HAVE_INTTYPES +#elif defined(__cplusplus) && (__cplusplus >= 201103L) +/* C++11 apparently ratified stdint.h */ +#define DUK_F_HAVE_INTTYPES +#endif + +/* Basic integer typedefs and limits, preferably from inttypes.h, otherwise + * through automatic detection. + */ +#if defined(DUK_F_HAVE_INTTYPES) +/* C99 or compatible */ + +#define DUK_F_HAVE_64BIT +#include + +typedef uint8_t duk_uint8_t; +typedef int8_t duk_int8_t; +typedef uint16_t duk_uint16_t; +typedef int16_t duk_int16_t; +typedef uint32_t duk_uint32_t; +typedef int32_t duk_int32_t; +typedef uint64_t duk_uint64_t; +typedef int64_t duk_int64_t; +typedef uint_least8_t duk_uint_least8_t; +typedef int_least8_t duk_int_least8_t; +typedef uint_least16_t duk_uint_least16_t; +typedef int_least16_t duk_int_least16_t; +typedef uint_least32_t duk_uint_least32_t; +typedef int_least32_t duk_int_least32_t; +typedef uint_least64_t duk_uint_least64_t; +typedef int_least64_t duk_int_least64_t; +typedef uint_fast8_t duk_uint_fast8_t; +typedef int_fast8_t duk_int_fast8_t; +typedef uint_fast16_t duk_uint_fast16_t; +typedef int_fast16_t duk_int_fast16_t; +typedef uint_fast32_t duk_uint_fast32_t; +typedef int_fast32_t duk_int_fast32_t; +typedef uint_fast64_t duk_uint_fast64_t; +typedef int_fast64_t duk_int_fast64_t; +typedef uintptr_t duk_uintptr_t; +typedef intptr_t duk_intptr_t; +typedef uintmax_t duk_uintmax_t; +typedef intmax_t duk_intmax_t; + +#define DUK_UINT8_MIN 0 +#define DUK_UINT8_MAX UINT8_MAX +#define DUK_INT8_MIN INT8_MIN +#define DUK_INT8_MAX INT8_MAX +#define DUK_UINT_LEAST8_MIN 0 +#define DUK_UINT_LEAST8_MAX UINT_LEAST8_MAX +#define DUK_INT_LEAST8_MIN INT_LEAST8_MIN +#define DUK_INT_LEAST8_MAX INT_LEAST8_MAX +#define DUK_UINT_FAST8_MIN 0 +#define DUK_UINT_FAST8_MAX UINT_FAST8_MAX +#define DUK_INT_FAST8_MIN INT_FAST8_MIN +#define DUK_INT_FAST8_MAX INT_FAST8_MAX +#define DUK_UINT16_MIN 0 +#define DUK_UINT16_MAX UINT16_MAX +#define DUK_INT16_MIN INT16_MIN +#define DUK_INT16_MAX INT16_MAX +#define DUK_UINT_LEAST16_MIN 0 +#define DUK_UINT_LEAST16_MAX UINT_LEAST16_MAX +#define DUK_INT_LEAST16_MIN INT_LEAST16_MIN +#define DUK_INT_LEAST16_MAX INT_LEAST16_MAX +#define DUK_UINT_FAST16_MIN 0 +#define DUK_UINT_FAST16_MAX UINT_FAST16_MAX +#define DUK_INT_FAST16_MIN INT_FAST16_MIN +#define DUK_INT_FAST16_MAX INT_FAST16_MAX +#define DUK_UINT32_MIN 0 +#define DUK_UINT32_MAX UINT32_MAX +#define DUK_INT32_MIN INT32_MIN +#define DUK_INT32_MAX INT32_MAX +#define DUK_UINT_LEAST32_MIN 0 +#define DUK_UINT_LEAST32_MAX UINT_LEAST32_MAX +#define DUK_INT_LEAST32_MIN INT_LEAST32_MIN +#define DUK_INT_LEAST32_MAX INT_LEAST32_MAX +#define DUK_UINT_FAST32_MIN 0 +#define DUK_UINT_FAST32_MAX UINT_FAST32_MAX +#define DUK_INT_FAST32_MIN INT_FAST32_MIN +#define DUK_INT_FAST32_MAX INT_FAST32_MAX +#define DUK_UINT64_MIN 0 +#define DUK_UINT64_MAX UINT64_MAX +#define DUK_INT64_MIN INT64_MIN +#define DUK_INT64_MAX INT64_MAX +#define DUK_UINT_LEAST64_MIN 0 +#define DUK_UINT_LEAST64_MAX UINT_LEAST64_MAX +#define DUK_INT_LEAST64_MIN INT_LEAST64_MIN +#define DUK_INT_LEAST64_MAX INT_LEAST64_MAX +#define DUK_UINT_FAST64_MIN 0 +#define DUK_UINT_FAST64_MAX UINT_FAST64_MAX +#define DUK_INT_FAST64_MIN INT_FAST64_MIN +#define DUK_INT_FAST64_MAX INT_FAST64_MAX + +#define DUK_UINTPTR_MIN 0 +#define DUK_UINTPTR_MAX UINTPTR_MAX +#define DUK_INTPTR_MIN INTPTR_MIN +#define DUK_INTPTR_MAX INTPTR_MAX + +#define DUK_UINTMAX_MIN 0 +#define DUK_UINTMAX_MAX UINTMAX_MAX +#define DUK_INTMAX_MIN INTMAX_MIN +#define DUK_INTMAX_MAX INTMAX_MAX + +#define DUK_SIZE_MIN 0 +#define DUK_SIZE_MAX SIZE_MAX + +#else /* C99 types */ + +/* When C99 types are not available, we use heuristic detection to get + * the basic 8, 16, 32, and (possibly) 64 bit types. The fast/least + * types are then assumed to be exactly the same for now: these could + * be improved per platform but C99 types are very often now available. + * 64-bit types are not available on all platforms; this is OK at least + * on 32-bit platforms. + * + * This detection code is necessarily a bit hacky and can provide typedefs + * and defines that won't work correctly on some exotic platform. + */ + +#if (defined(CHAR_BIT) && (CHAR_BIT == 8)) || \ + (defined(UCHAR_MAX) && (UCHAR_MAX == 255)) +typedef unsigned char duk_uint8_t; +typedef signed char duk_int8_t; +#else +#error cannot detect 8-bit type +#endif + +#if defined(USHRT_MAX) && (USHRT_MAX == 65535UL) +typedef unsigned short duk_uint16_t; +typedef signed short duk_int16_t; +#elif defined(UINT_MAX) && (UINT_MAX == 65535UL) +/* On some platforms int is 16-bit but long is 32-bit (e.g. PureC) */ +typedef unsigned int duk_uint16_t; +typedef signed int duk_int16_t; +#else +#error cannot detect 16-bit type +#endif + +#if defined(UINT_MAX) && (UINT_MAX == 4294967295UL) +typedef unsigned int duk_uint32_t; +typedef signed int duk_int32_t; +#elif defined(ULONG_MAX) && (ULONG_MAX == 4294967295UL) +/* On some platforms int is 16-bit but long is 32-bit (e.g. PureC) */ +typedef unsigned long duk_uint32_t; +typedef signed long duk_int32_t; +#else +#error cannot detect 32-bit type +#endif + +/* 64-bit type detection is a bit tricky. + * + * ULLONG_MAX is a standard define. __LONG_LONG_MAX__ and __ULONG_LONG_MAX__ + * are used by at least GCC (even if system headers don't provide ULLONG_MAX). + * Some GCC variants may provide __LONG_LONG_MAX__ but not __ULONG_LONG_MAX__. + * + * ULL / LL constants are rejected / warned about by some compilers, even if + * the compiler has a 64-bit type and the compiler/system headers provide an + * unsupported constant (ULL/LL)! Try to avoid using ULL / LL constants. + * As a side effect we can only check that e.g. ULONG_MAX is larger than 32 + * bits but can't be sure it is exactly 64 bits. Self tests will catch such + * cases. + */ +#undef DUK_F_HAVE_64BIT +#if !defined(DUK_F_HAVE_64BIT) && defined(ULONG_MAX) +#if (ULONG_MAX > 4294967295UL) +#define DUK_F_HAVE_64BIT +typedef unsigned long duk_uint64_t; +typedef signed long duk_int64_t; +#endif +#endif +#if !defined(DUK_F_HAVE_64BIT) && defined(ULLONG_MAX) +#if (ULLONG_MAX > 4294967295UL) +#define DUK_F_HAVE_64BIT +typedef unsigned long long duk_uint64_t; +typedef signed long long duk_int64_t; +#endif +#endif +#if !defined(DUK_F_HAVE_64BIT) && defined(__ULONG_LONG_MAX__) +#if (__ULONG_LONG_MAX__ > 4294967295UL) +#define DUK_F_HAVE_64BIT +typedef unsigned long long duk_uint64_t; +typedef signed long long duk_int64_t; +#endif +#endif +#if !defined(DUK_F_HAVE_64BIT) && defined(__LONG_LONG_MAX__) +#if (__LONG_LONG_MAX__ > 2147483647L) +#define DUK_F_HAVE_64BIT +typedef unsigned long long duk_uint64_t; +typedef signed long long duk_int64_t; +#endif +#endif +#if !defined(DUK_F_HAVE_64BIT) && \ + (defined(DUK_F_MINGW) || defined(DUK_F_MSVC)) +/* Both MinGW and MSVC have a 64-bit type. */ +#define DUK_F_HAVE_64BIT +typedef unsigned long duk_uint64_t; +typedef signed long duk_int64_t; +#endif +#if !defined(DUK_F_HAVE_64BIT) +/* cannot detect 64-bit type, not always needed so don't error */ +#endif + +typedef duk_uint8_t duk_uint_least8_t; +typedef duk_int8_t duk_int_least8_t; +typedef duk_uint16_t duk_uint_least16_t; +typedef duk_int16_t duk_int_least16_t; +typedef duk_uint32_t duk_uint_least32_t; +typedef duk_int32_t duk_int_least32_t; +typedef duk_uint8_t duk_uint_fast8_t; +typedef duk_int8_t duk_int_fast8_t; +typedef duk_uint16_t duk_uint_fast16_t; +typedef duk_int16_t duk_int_fast16_t; +typedef duk_uint32_t duk_uint_fast32_t; +typedef duk_int32_t duk_int_fast32_t; +#if defined(DUK_F_HAVE_64BIT) +typedef duk_uint64_t duk_uint_least64_t; +typedef duk_int64_t duk_int_least64_t; +typedef duk_uint64_t duk_uint_fast64_t; +typedef duk_int64_t duk_int_fast64_t; +#endif +#if defined(DUK_F_HAVE_64BIT) +typedef duk_uint64_t duk_uintmax_t; +typedef duk_int64_t duk_intmax_t; +#else +typedef duk_uint32_t duk_uintmax_t; +typedef duk_int32_t duk_intmax_t; +#endif + +/* Note: the funny looking computations for signed minimum 16-bit, 32-bit, and + * 64-bit values are intentional as the obvious forms (e.g. -0x80000000L) are + * -not- portable. See code-issues.txt for a detailed discussion. + */ +#define DUK_UINT8_MIN 0UL +#define DUK_UINT8_MAX 0xffUL +#define DUK_INT8_MIN (-0x80L) +#define DUK_INT8_MAX 0x7fL +#define DUK_UINT_LEAST8_MIN 0UL +#define DUK_UINT_LEAST8_MAX 0xffUL +#define DUK_INT_LEAST8_MIN (-0x80L) +#define DUK_INT_LEAST8_MAX 0x7fL +#define DUK_UINT_FAST8_MIN 0UL +#define DUK_UINT_FAST8_MAX 0xffUL +#define DUK_INT_FAST8_MIN (-0x80L) +#define DUK_INT_FAST8_MAX 0x7fL +#define DUK_UINT16_MIN 0UL +#define DUK_UINT16_MAX 0xffffUL +#define DUK_INT16_MIN (-0x7fffL - 1L) +#define DUK_INT16_MAX 0x7fffL +#define DUK_UINT_LEAST16_MIN 0UL +#define DUK_UINT_LEAST16_MAX 0xffffUL +#define DUK_INT_LEAST16_MIN (-0x7fffL - 1L) +#define DUK_INT_LEAST16_MAX 0x7fffL +#define DUK_UINT_FAST16_MIN 0UL +#define DUK_UINT_FAST16_MAX 0xffffUL +#define DUK_INT_FAST16_MIN (-0x7fffL - 1L) +#define DUK_INT_FAST16_MAX 0x7fffL +#define DUK_UINT32_MIN 0UL +#define DUK_UINT32_MAX 0xffffffffUL +#define DUK_INT32_MIN (-0x7fffffffL - 1L) +#define DUK_INT32_MAX 0x7fffffffL +#define DUK_UINT_LEAST32_MIN 0UL +#define DUK_UINT_LEAST32_MAX 0xffffffffUL +#define DUK_INT_LEAST32_MIN (-0x7fffffffL - 1L) +#define DUK_INT_LEAST32_MAX 0x7fffffffL +#define DUK_UINT_FAST32_MIN 0UL +#define DUK_UINT_FAST32_MAX 0xffffffffUL +#define DUK_INT_FAST32_MIN (-0x7fffffffL - 1L) +#define DUK_INT_FAST32_MAX 0x7fffffffL + +/* 64-bit constants. Since LL / ULL constants are not always available, + * use computed values. These values can't be used in preprocessor + * comparisons; flag them as such. + */ +#if defined(DUK_F_HAVE_64BIT) +#define DUK_UINT64_MIN ((duk_uint64_t) 0) +#define DUK_UINT64_MAX ((duk_uint64_t) -1) +#define DUK_INT64_MIN ((duk_int64_t) (~(DUK_UINT64_MAX >> 1))) +#define DUK_INT64_MAX ((duk_int64_t) (DUK_UINT64_MAX >> 1)) +#define DUK_UINT_LEAST64_MIN DUK_UINT64_MIN +#define DUK_UINT_LEAST64_MAX DUK_UINT64_MAX +#define DUK_INT_LEAST64_MIN DUK_INT64_MIN +#define DUK_INT_LEAST64_MAX DUK_INT64_MAX +#define DUK_UINT_FAST64_MIN DUK_UINT64_MIN +#define DUK_UINT_FAST64_MAX DUK_UINT64_MAX +#define DUK_INT_FAST64_MIN DUK_INT64_MIN +#define DUK_INT_FAST64_MAX DUK_INT64_MAX +#define DUK_UINT64_MIN_COMPUTED +#define DUK_UINT64_MAX_COMPUTED +#define DUK_INT64_MIN_COMPUTED +#define DUK_INT64_MAX_COMPUTED +#define DUK_UINT_LEAST64_MIN_COMPUTED +#define DUK_UINT_LEAST64_MAX_COMPUTED +#define DUK_INT_LEAST64_MIN_COMPUTED +#define DUK_INT_LEAST64_MAX_COMPUTED +#define DUK_UINT_FAST64_MIN_COMPUTED +#define DUK_UINT_FAST64_MAX_COMPUTED +#define DUK_INT_FAST64_MIN_COMPUTED +#define DUK_INT_FAST64_MAX_COMPUTED +#endif + +#if defined(DUK_F_HAVE_64BIT) +#define DUK_UINTMAX_MIN DUK_UINT64_MIN +#define DUK_UINTMAX_MAX DUK_UINT64_MAX +#define DUK_INTMAX_MIN DUK_INT64_MIN +#define DUK_INTMAX_MAX DUK_INT64_MAX +#define DUK_UINTMAX_MIN_COMPUTED +#define DUK_UINTMAX_MAX_COMPUTED +#define DUK_INTMAX_MIN_COMPUTED +#define DUK_INTMAX_MAX_COMPUTED +#else +#define DUK_UINTMAX_MIN 0UL +#define DUK_UINTMAX_MAX 0xffffffffUL +#define DUK_INTMAX_MIN (-0x7fffffffL - 1L) +#define DUK_INTMAX_MAX 0x7fffffffL +#endif + +/* This detection is not very reliable. */ +#if defined(DUK_F_32BIT_PTRS) +typedef duk_int32_t duk_intptr_t; +typedef duk_uint32_t duk_uintptr_t; +#define DUK_UINTPTR_MIN DUK_UINT32_MIN +#define DUK_UINTPTR_MAX DUK_UINT32_MAX +#define DUK_INTPTR_MIN DUK_INT32_MIN +#define DUK_INTPTR_MAX DUK_INT32_MAX +#elif defined(DUK_F_64BIT_PTRS) && defined(DUK_F_HAVE_64BIT) +typedef duk_int64_t duk_intptr_t; +typedef duk_uint64_t duk_uintptr_t; +#define DUK_UINTPTR_MIN DUK_UINT64_MIN +#define DUK_UINTPTR_MAX DUK_UINT64_MAX +#define DUK_INTPTR_MIN DUK_INT64_MIN +#define DUK_INTPTR_MAX DUK_INT64_MAX +#define DUK_UINTPTR_MIN_COMPUTED +#define DUK_UINTPTR_MAX_COMPUTED +#define DUK_INTPTR_MIN_COMPUTED +#define DUK_INTPTR_MAX_COMPUTED +#else +#error cannot determine intptr type +#endif + +/* SIZE_MAX may be missing so use an approximate value for it. */ +#undef DUK_SIZE_MAX_COMPUTED +#if !defined(SIZE_MAX) +#define DUK_SIZE_MAX_COMPUTED +#define SIZE_MAX ((size_t) (-1)) +#endif +#define DUK_SIZE_MIN 0 +#define DUK_SIZE_MAX SIZE_MAX + +#endif /* C99 types */ + +/* A few types are assumed to always exist. */ +typedef size_t duk_size_t; +typedef ptrdiff_t duk_ptrdiff_t; + +/* The best type for an "all around int" in Duktape internals is "at least + * 32 bit signed integer" which is most convenient. Same for unsigned type. + * Prefer 'int' when large enough, as it is almost always a convenient type. + */ +#if defined(UINT_MAX) && (UINT_MAX >= 0xffffffffUL) +typedef int duk_int_t; +typedef unsigned int duk_uint_t; +#define DUK_INT_MIN INT_MIN +#define DUK_INT_MAX INT_MAX +#define DUK_UINT_MIN 0 +#define DUK_UINT_MAX UINT_MAX +#else +typedef duk_int_fast32_t duk_int_t; +typedef duk_uint_fast32_t duk_uint_t; +#define DUK_INT_MIN DUK_INT_FAST32_MIN +#define DUK_INT_MAX DUK_INT_FAST32_MAX +#define DUK_UINT_MIN DUK_UINT_FAST32_MIN +#define DUK_UINT_MAX DUK_UINT_FAST32_MAX +#endif + +/* Same as 'duk_int_t' but guaranteed to be a 'fast' variant if this + * distinction matters for the CPU. These types are used mainly in the + * executor where it might really matter. + */ +typedef duk_int_fast32_t duk_int_fast_t; +typedef duk_uint_fast32_t duk_uint_fast_t; +#define DUK_INT_FAST_MIN DUK_INT_FAST32_MIN +#define DUK_INT_FAST_MAX DUK_INT_FAST32_MAX +#define DUK_UINT_FAST_MIN DUK_UINT_FAST32_MIN +#define DUK_UINT_FAST_MAX DUK_UINT_FAST32_MAX + +/* Small integers (16 bits or more) can fall back to the 'int' type, but + * have a typedef so they are marked "small" explicitly. + */ +typedef int duk_small_int_t; +typedef unsigned int duk_small_uint_t; +#define DUK_SMALL_INT_MIN INT_MIN +#define DUK_SMALL_INT_MAX INT_MAX +#define DUK_SMALL_UINT_MIN 0 +#define DUK_SMALL_UINT_MAX UINT_MAX + +/* Fast variants of small integers, again for really fast paths like the + * executor. + */ +typedef duk_int_fast16_t duk_small_int_fast_t; +typedef duk_uint_fast16_t duk_small_uint_fast_t; +#define DUK_SMALL_INT_FAST_MIN DUK_INT_FAST16_MIN +#define DUK_SMALL_INT_FAST_MAX DUK_INT_FAST16_MAX +#define DUK_SMALL_UINT_FAST_MIN DUK_UINT_FAST16_MIN +#define DUK_SMALL_UINT_FAST_MAX DUK_UINT_FAST16_MAX + +/* Boolean values are represented with the platform 'int'. */ +typedef duk_small_int_t duk_bool_t; +#define DUK_BOOL_MIN DUK_SMALL_INT_MIN +#define DUK_BOOL_MAX DUK_SMALL_INT_MAX + +/* Index values must have at least 32-bit signed range. */ +typedef duk_int_t duk_idx_t; +#define DUK_IDX_MIN DUK_INT_MIN +#define DUK_IDX_MAX DUK_INT_MAX + +/* Array index values, could be exact 32 bits. + * Currently no need for signed duk_arridx_t. + */ +typedef duk_uint_t duk_uarridx_t; +#define DUK_UARRIDX_MIN DUK_UINT_MIN +#define DUK_UARRIDX_MAX DUK_UINT_MAX + +/* Duktape/C function return value, platform int is enough for now to + * represent 0, 1, or negative error code. Must be compatible with + * assigning truth values (e.g. duk_ret_t rc = (foo == bar);). + */ +typedef duk_small_int_t duk_ret_t; +#define DUK_RET_MIN DUK_SMALL_INT_MIN +#define DUK_RET_MAX DUK_SMALL_INT_MAX + +/* Error codes are represented with platform int. High bits are used + * for flags and such, so 32 bits are needed. + */ +typedef duk_int_t duk_errcode_t; +#define DUK_ERRCODE_MIN DUK_INT_MIN +#define DUK_ERRCODE_MAX DUK_INT_MAX + +/* Codepoint type. Must be 32 bits or more because it is used also for + * internal codepoints. The type is signed because negative codepoints + * are used as internal markers (e.g. to mark EOF or missing argument). + * (X)UTF-8/CESU-8 encode/decode take and return an unsigned variant to + * ensure duk_uint32_t casts back and forth nicely. Almost everything + * else uses the signed one. + */ +typedef duk_int_t duk_codepoint_t; +typedef duk_uint_t duk_ucodepoint_t; +#define DUK_CODEPOINT_MIN DUK_INT_MIN +#define DUK_CODEPOINT_MAX DUK_INT_MAX +#define DUK_UCODEPOINT_MIN DUK_UINT_MIN +#define DUK_UCODEPOINT_MAX DUK_UINT_MAX + +/* IEEE double typedef. */ +typedef double duk_double_t; + +/* We're generally assuming that we're working on a platform with a 32-bit + * address space. If DUK_SIZE_MAX is a typecast value (which is necessary + * if SIZE_MAX is missing), the check must be avoided because the + * preprocessor can't do a comparison. + */ +#if !defined(DUK_SIZE_MAX) +#error DUK_SIZE_MAX is undefined, probably missing SIZE_MAX +#elif !defined(DUK_SIZE_MAX_COMPUTED) +#if DUK_SIZE_MAX < 0xffffffffUL +/* On some systems SIZE_MAX can be smaller than max unsigned 32-bit value + * which seems incorrect if size_t is (at least) an unsigned 32-bit type. + * However, it doesn't seem useful to error out compilation if this is the + * case. + */ +#endif +#endif + +/* Convenience define: 32-bit pointers. 32-bit platforms are an important + * footprint optimization target, and this define allows e.g. struct sizes + * to be organized for compactness. + */ + +#undef DUK_USE_32BIT_PTRS +#if defined(DUK_UINTPTR_MAX) && !defined(DUK_UINTPTR_MAX_COMPUTED) +#if DUK_UINTPTR_MAX <= 0xffffffffUL +#define DUK_USE_32BIT_PTRS +#endif +#endif + +/* + * Check whether we should use 64-bit integers + */ + +/* Quite incomplete now. Use 64-bit types if detected (C99 or other detection) + * unless they are known to be unreliable. For instance, 64-bit types are + * available on VBCC but seem to misbehave. + */ +#if defined(DUK_F_HAVE_64BIT) && !defined(DUK_F_VBCC) +#define DUK_USE_64BIT_OPS +#else +#undef DUK_USE_64BIT_OPS +#endif + +/* + * Alignment requirement and support for unaligned accesses + * + * Assume unaligned accesses are not supported unless specifically allowed + * in the target platform. Some platforms may support unaligned accesses + * but alignment to 4 or 8 may still be desirable. + */ + +#undef DUK_USE_UNALIGNED_ACCESSES_POSSIBLE +#undef DUK_USE_ALIGN_4 +#undef DUK_USE_ALIGN_8 + +#if defined(DUK_F_EMSCRIPTEN) +/* Required on at least some targets, so use whenever Emscripten used, + * regardless of compilation target. + */ +#define DUK_USE_ALIGN_8 +#elif defined(DUK_F_ARM) +#define DUK_USE_ALIGN_4 +#elif defined(DUK_F_MIPS32) +/* Based on 'make checkalign' there are no alignment requirements on + * Linux MIPS except for doubles, which need align by 4. Alignment + * requirements vary based on target though. + */ +#define DUK_USE_ALIGN_4 +#elif defined(DUK_F_MIPS64) +/* Good default is a bit arbitrary because alignment requirements + * depend on target. See https://github.com/svaarala/duktape/issues/102. + */ +#define DUK_USE_ALIGN_8 +#elif defined(DUK_F_SUPERH) +/* Based on 'make checkalign' there are no alignment requirements on + * Linux SH4, but align by 4 is probably a good basic default. + */ +#define DUK_USE_ALIGN_4 +#elif defined(DUK_F_X86) || defined(DUK_F_X32) || defined(DUK_F_X64) || \ + defined(DUK_F_BCC) +/* XXX: This is technically not guaranteed because it's possible to configure + * an x86 to require aligned accesses with Alignment Check (AC) flag. + */ +#define DUK_USE_UNALIGNED_ACCESSES_POSSIBLE +#else +/* Unknown, use safe default */ +#define DUK_USE_ALIGN_8 +#endif + +/* User forced alignment to 4 or 8. */ +#if defined(DUK_OPT_FORCE_ALIGN) +#undef DUK_USE_UNALIGNED_ACCESSES_POSSIBLE +#undef DUK_USE_ALIGN_4 +#undef DUK_USE_ALIGN_8 +#if (DUK_OPT_FORCE_ALIGN == 4) +#define DUK_USE_ALIGN_4 +#elif (DUK_OPT_FORCE_ALIGN == 8) +#define DUK_USE_ALIGN_8 +#else +#error invalid DUK_OPT_FORCE_ALIGN value +#endif +#endif + +/* Compiler specific hackery needed to force struct size to match aligment, + * see e.g. duk_hbuffer.h. + * + * http://stackoverflow.com/questions/11130109/c-struct-size-alignment + * http://stackoverflow.com/questions/10951039/specifying-64-bit-alignment + */ +#if defined(DUK_F_MSVC) +#define DUK_USE_PACK_MSVC_PRAGMA +#elif defined(DUK_F_GCC) +#define DUK_USE_PACK_GCC_ATTR +#elif defined(DUK_F_CLANG) +#define DUK_USE_PACK_CLANG_ATTR +#else +#define DUK_USE_PACK_DUMMY_MEMBER +#endif + +#ifdef DUK_USE_UNALIGNED_ACCESSES_POSSIBLE +#define DUK_USE_HASHBYTES_UNALIGNED_U32_ACCESS +#else +#undef DUK_USE_HASHBYTES_UNALIGNED_U32_ACCESS +#endif + +/* Object property allocation layout has implications for memory and code + * footprint and generated code size/speed. The best layout also depends + * on whether the platform has alignment requirements or benefits from + * having mostly aligned accesses. + */ +#undef DUK_USE_HOBJECT_LAYOUT_1 +#undef DUK_USE_HOBJECT_LAYOUT_2 +#undef DUK_USE_HOBJECT_LAYOUT_3 +#if defined(DUK_USE_UNALIGNED_ACCESSES_POSSIBLE) && \ + !defined(DUK_USE_ALIGN_4) && !defined(DUK_USE_ALIGN_8) +/* On platforms without any alignment issues, layout 1 is preferable + * because it compiles to slightly less code and provides direct access + * to property keys. + */ +#define DUK_USE_HOBJECT_LAYOUT_1 +#else +/* On other platforms use layout 2, which requires some padding but + * is a bit more natural than layout 3 in ordering the entries. Layout + * 3 is currently not used. + */ +#define DUK_USE_HOBJECT_LAYOUT_2 +#endif + +/* + * Byte order and double memory layout detection + * + * Endianness detection is a major portability hassle because the macros + * and headers are not standardized. There's even variance across UNIX + * platforms. Even with "standard" headers, details like underscore count + * varies between platforms, e.g. both __BYTE_ORDER and _BYTE_ORDER are used + * (Crossbridge has a single underscore, for instance). + * + * The checks below are structured with this in mind: several approaches are + * used, and at the end we check if any of them worked. This allows generic + * approaches to be tried first, and platform/compiler specific hacks tried + * last. As a last resort, the user can force a specific endianness, as it's + * not likely that automatic detection will work on the most exotic platforms. + * + * Duktape supports little and big endian machines. There's also support + * for a hybrid used by some ARM machines where integers are little endian + * but IEEE double values use a mixed order (12345678 -> 43218765). This + * byte order for doubles is referred to as "mixed endian". + */ + +#undef DUK_F_BYTEORDER +#undef DUK_USE_BYTEORDER_FORCED + +/* DUK_F_BYTEORDER is set as an intermediate value when detection + * succeeds, to one of: + * 1 = little endian + * 2 = mixed (arm hybrid) endian + * 3 = big endian + */ + +/* For custom platforms allow user to define byteorder explicitly. + * Since endianness headers are not standardized, this is a useful + * workaround for custom platforms for which endianness detection + * is not directly supported. Perhaps custom hardware is used and + * user cannot submit upstream patches. + */ +#if defined(DUK_OPT_FORCE_BYTEORDER) +#if (DUK_OPT_FORCE_BYTEORDER == 1) +#define DUK_F_BYTEORDER 1 +#elif (DUK_OPT_FORCE_BYTEORDER == 2) +#define DUK_F_BYTEORDER 2 +#elif (DUK_OPT_FORCE_BYTEORDER == 3) +#define DUK_F_BYTEORDER 3 +#else +#error invalid DUK_OPT_FORCE_BYTEORDER value +#endif +#define DUK_USE_BYTEORDER_FORCED +#endif /* DUK_OPT_FORCE_BYTEORDER */ + +/* More or less standard endianness predefines provided by header files. + * The ARM hybrid case is detected by assuming that __FLOAT_WORD_ORDER + * will be big endian, see: http://lists.mysql.com/internals/443. + */ +#if !defined(DUK_F_BYTEORDER) +#if defined(__BYTE_ORDER) && defined(__LITTLE_ENDIAN) && (__BYTE_ORDER == __LITTLE_ENDIAN) || \ + defined(_BYTE_ORDER) && defined(_LITTLE_ENDIAN) && (_BYTE_ORDER == _LITTLE_ENDIAN) || \ + defined(__LITTLE_ENDIAN__) +/* Integer little endian */ +#if defined(__FLOAT_WORD_ORDER) && defined(__LITTLE_ENDIAN) && (__FLOAT_WORD_ORDER == __LITTLE_ENDIAN) || \ + defined(_FLOAT_WORD_ORDER) && defined(_LITTLE_ENDIAN) && (_FLOAT_WORD_ORDER == _LITTLE_ENDIAN) +#define DUK_F_BYTEORDER 1 +#elif defined(__FLOAT_WORD_ORDER) && defined(__BIG_ENDIAN) && (__FLOAT_WORD_ORDER == __BIG_ENDIAN) || \ + defined(_FLOAT_WORD_ORDER) && defined(_BIG_ENDIAN) && (_FLOAT_WORD_ORDER == _BIG_ENDIAN) +#define DUK_F_BYTEORDER 2 +#elif !defined(__FLOAT_WORD_ORDER) && !defined(_FLOAT_WORD_ORDER) +/* Float word order not known, assume not a hybrid. */ +#define DUK_F_BYTEORDER 1 +#else +/* byte order is little endian but cannot determine IEEE double word order */ +#endif /* float word order */ +#elif defined(__BYTE_ORDER) && defined(__BIG_ENDIAN) && (__BYTE_ORDER == __BIG_ENDIAN) || \ + defined(_BYTE_ORDER) && defined(_BIG_ENDIAN) && (_BYTE_ORDER == _BIG_ENDIAN) || \ + defined(__BIG_ENDIAN__) +/* Integer big endian */ +#if defined(__FLOAT_WORD_ORDER) && defined(__BIG_ENDIAN) && (__FLOAT_WORD_ORDER == __BIG_ENDIAN) || \ + defined(_FLOAT_WORD_ORDER) && defined(_BIG_ENDIAN) && (_FLOAT_WORD_ORDER == _BIG_ENDIAN) +#define DUK_F_BYTEORDER 3 +#elif !defined(__FLOAT_WORD_ORDER) && !defined(_FLOAT_WORD_ORDER) +/* Float word order not known, assume not a hybrid. */ +#define DUK_F_BYTEORDER 3 +#else +/* byte order is big endian but cannot determine IEEE double word order */ +#endif /* float word order */ +#else +/* cannot determine byte order */ +#endif /* integer byte order */ +#endif /* !defined(DUK_F_BYTEORDER) */ + +/* GCC and Clang provide endianness defines as built-in predefines, with + * leading and trailing double underscores (e.g. __BYTE_ORDER__). See + * output of "make gccpredefs" and "make clangpredefs". Clang doesn't + * seem to provide __FLOAT_WORD_ORDER__. + * http://gcc.gnu.org/onlinedocs/cpp/Common-Predefined-Macros.html + */ +#if !defined(DUK_F_BYTEORDER) && defined(__BYTE_ORDER__) +#if defined(__ORDER_LITTLE_ENDIAN__) && (__BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__) +/* Integer little endian */ +#if defined(__FLOAT_WORD_ORDER__) && defined(__ORDER_LITTLE_ENDIAN__) && \ + (__FLOAT_WORD_ORDER__ == __ORDER_LITTLE_ENDIAN__) +#define DUK_F_BYTEORDER 1 +#elif defined(__FLOAT_WORD_ORDER__) && defined(__ORDER_BIG_ENDIAN__) && \ + (__FLOAT_WORD_ORDER__ == __ORDER_BIG_ENDIAN__) +#define DUK_F_BYTEORDER 2 +#elif !defined(__FLOAT_WORD_ORDER__) +/* Float word order not known, assume not a hybrid. */ +#define DUK_F_BYTEORDER 1 +#else +/* byte order is little endian but cannot determine IEEE double word order */ +#endif /* float word order */ +#elif defined(__ORDER_BIG_ENDIAN__) && (__BYTE_ORDER__ == __ORDER_BIG_ENDIAN__) +/* Integer big endian */ +#if defined(__FLOAT_WORD_ORDER__) && defined(__ORDER_BIG_ENDIAN__) && \ + (__FLOAT_WORD_ORDER__ == __ORDER_BIG_ENDIAN__) +#define DUK_F_BYTEORDER 3 +#elif !defined(__FLOAT_WORD_ORDER__) +/* Float word order not known, assume not a hybrid. */ +#define DUK_F_BYTEORDER 3 +#else +/* byte order is big endian but cannot determine IEEE double word order */ +#endif /* float word order */ +#else +/* cannot determine byte order; __ORDER_PDP_ENDIAN__ is related to 32-bit + * integer ordering and is not relevant + */ +#endif /* integer byte order */ +#endif /* !defined(DUK_F_BYTEORDER) && defined(__BYTE_ORDER__) */ + +/* Atari ST TOS */ +#if !defined(DUK_F_BYTEORDER) && defined(DUK_F_TOS) +#define DUK_F_BYTEORDER 3 +#endif + +/* AmigaOS on M68k */ +#if !defined(DUK_F_BYTEORDER) && defined(DUK_F_AMIGAOS) +#if defined(DUK_F_M68K) +#define DUK_F_BYTEORDER 3 +#endif +#endif + +/* On Windows, assume we're little endian. Even Itanium which has a + * configurable endianness runs little endian in Windows. + */ +#if !defined(DUK_F_BYTEORDER) && defined(DUK_F_WINDOWS) +/* XXX: verify that Windows on ARM is little endian for floating point + * values too. + */ +#define DUK_F_BYTEORDER 1 +#endif /* Windows */ + +/* Crossbridge should work with the standard byteorder #ifdefs. It doesn't + * provide _FLOAT_WORD_ORDER but the standard approach now covers that case + * too. This has been left here just in case. + */ +#if !defined(DUK_F_BYTEORDER) && defined(DUK_F_FLASHPLAYER) +#define DUK_F_BYTEORDER 1 +#endif + +/* QNX gcc cross compiler seems to define e.g. __LITTLEENDIAN__ or __BIGENDIAN__: + * $ /opt/qnx650/host/linux/x86/usr/bin/i486-pc-nto-qnx6.5.0-gcc -dM -E - + * | 0 | 1 | 2 | ..... + * ^-- p=3, points after last valid byte (2) + * + * If this is a practical issue, wrappers are again needed. + */ + +typedef FILE duk_file; +#define DUK_STDIN stdin +#define DUK_STDOUT stdout +#define DUK_STDERR stderr + +/* Special naming to avoid conflict with e.g. DUK_FREE() in duk_heap.h + * (which is unfortunately named). + */ +#define DUK_ANSI_MALLOC malloc +#define DUK_ANSI_REALLOC realloc +#define DUK_ANSI_CALLOC calloc +#define DUK_ANSI_FREE free + +/* Old uclibcs have a broken memcpy so use memmove instead (this is overly + * wide now on purpose): + * http://lists.uclibc.org/pipermail/uclibc-cvs/2008-October/025511.html + */ +#if defined(DUK_F_UCLIBC) +#define DUK_MEMCPY memmove +#else +#define DUK_MEMCPY memcpy +#endif + +#define DUK_MEMMOVE memmove +#define DUK_MEMCMP memcmp +#define DUK_MEMSET memset +#define DUK_STRLEN strlen +#define DUK_STRCMP strcmp +#define DUK_STRNCMP strncmp +#define DUK_PRINTF printf +#define DUK_FPRINTF fprintf +#define DUK_SPRINTF sprintf + +#if defined(DUK_F_MSVC) +/* _snprintf() does NOT NUL terminate on truncation, but Duktape code never + * assumes that. + * http://stackoverflow.com/questions/2915672/snprintf-and-visual-studio-2010 + */ +#define DUK_SNPRINTF _snprintf +#else +#define DUK_SNPRINTF snprintf +#endif + +#define DUK_VSPRINTF vsprintf + +#if defined(DUK_F_MSVC) +#if (_MSC_VER < 1600) +/* Older MSVC version are missing vsnprintf() but have _vsnprintf(). */ +#define DUK_VSNPRINTF _vsnprintf +#else +#define DUK_VSNPRINTF vsnprintf +#endif +#else +#define DUK_VSNPRINTF vsnprintf +#endif /* DUK_F_MSVC */ + +#define DUK_SSCANF sscanf +#define DUK_VSSCANF vsscanf +#define DUK_FOPEN fopen +#define DUK_FCLOSE fclose +#define DUK_FREAD fread +#define DUK_FWRITE fwrite +#define DUK_FSEEK fseek +#define DUK_FTELL ftell +#define DUK_FFLUSH fflush +#define DUK_FPUTC fputc + +#define DUK_MEMZERO(p,n) \ + DUK_MEMSET((p), 0, (n)) + +/* + * Avoiding platform function pointers. + * + * On some platforms built-in functions may be implemented as macros or + * inline functions, so they can't be necessarily addressed by function + * pointers. This is certainly the case with some platform "polyfills" + * which provide missing C99/C++11 functions through macros, and may be + * the case with VS2013 (see GH-17). + */ + +/* This is now the default: the cost in footprint is negligible. */ +#define DUK_USE_AVOID_PLATFORM_FUNCPTRS + +/* + * Vararg macro wrappers. We need va_copy() which is defined in C99 / C++11, + * so an awkward replacement is needed for pre-C99 / pre-C++11 environments. + * This will quite likely need portability hacks for some non-C99 environments. + */ + +#if defined(DUK_F_C99) || defined(DUK_F_CPP11) +/* C99 / C++11 and above: rely on va_copy() which is required. + * Omit parenthesis on macro right side on purpose to minimize differences + * to direct use. + */ +#define DUK_VA_COPY(dest,src) va_copy(dest,src) +#elif defined(DUK_F_GCC) || defined(DUK_F_CLANG) +/* GCC: assume we have __va_copy() in non-C99 mode, which should be correct + * for even quite old GCC versions. Clang matches GCC behavior. + */ +#define DUK_VA_COPY(dest,src) __va_copy(dest,src) +#else +/* Pre-C99: va_list type is implementation dependent. This replacement + * assumes it is a plain value so that a simple assignment will work. + * This is not the case on all platforms (it may be a single-array element, + * for instance). + */ +#define DUK_VA_COPY(dest,src) do { (dest) = (src); } while (0) +#endif + +/* + * Miscellaneous ANSI C or other platform wrappers. + */ + +#define DUK_ABORT abort +#define DUK_EXIT exit + +/* + * Macro hackery to convert e.g. __LINE__ to a string without formatting, + * see: http://stackoverflow.com/questions/240353/convert-a-preprocessor-token-to-a-string + */ + +#define DUK_F_STRINGIFY_HELPER(x) #x +#define DUK_MACRO_STRINGIFY(x) DUK_F_STRINGIFY_HELPER(x) + +/* + * Cause segfault macro. + * + * This is optionally used by panic handling to cause the program to segfault + * (instead of e.g. abort()) on panic. Valgrind will then indicate the C + * call stack leading to the panic. + */ + +#define DUK_CAUSE_SEGFAULT() do { \ + *((volatile duk_uint32_t *) NULL) = (duk_uint32_t) 0xdeadbeefUL; \ + } while (0) + +/* + * Macro for suppressing warnings for potentially unreferenced variables. + * The variables can be actually unreferenced or unreferenced in some + * specific cases only; for instance, if a variable is only debug printed, + * it is unreferenced when debug printing is disabled. + * + * (Introduced here because it's potentially compiler specific.) + */ + +#define DUK_UNREF(x) do { \ + (void) (x); \ + } while (0) + +/* + * DUK_NORETURN: macro for declaring a 'noreturn' function. + * Unfortunately the noreturn declaration may appear in various + * places of a function declaration, so the solution is to wrap + * the entire declaration inside the macro. Compiler support + * for using a noreturn declaration on function pointers varies; + * this macro must only be used for actual function declarations. + * + * http://gcc.gnu.org/onlinedocs/gcc-4.3.2//gcc/Function-Attributes.html + * http://clang.llvm.org/docs/LanguageExtensions.html + */ + +#if defined(DUK_F_GCC_VERSION) && (DUK_F_GCC_VERSION >= 20500L) +/* since gcc-2.5 */ +#define DUK_NORETURN(decl) decl __attribute__((noreturn)) +#elif defined(__clang__) +/* syntax same as gcc */ +#define DUK_NORETURN(decl) decl __attribute__((noreturn)) +#elif defined(DUK_F_MSVC) +/* http://msdn.microsoft.com/en-us/library/aa235362(VS.60).aspx */ +#define DUK_NORETURN(decl) __declspec(noreturn) decl +#else +/* Don't know how to declare a noreturn function, so don't do it; this + * may cause some spurious compilation warnings (e.g. "variable used + * uninitialized"). + */ +#define DUK_NORETURN(decl) decl +#endif + +/* + * Macro for stating that a certain line cannot be reached. + * + * http://gcc.gnu.org/onlinedocs/gcc-4.5.0/gcc/Other-Builtins.html#Other-Builtins + * http://clang.llvm.org/docs/LanguageExtensions.html + */ + +#if defined(DUK_F_GCC_VERSION) && (DUK_F_GCC_VERSION >= 40500L) +/* since gcc-4.5 */ +#define DUK_UNREACHABLE() do { __builtin_unreachable(); } while(0) +#elif defined(__clang__) && defined(__has_builtin) +#if __has_builtin(__builtin_unreachable) +/* same as gcc */ +#define DUK_UNREACHABLE() do { __builtin_unreachable(); } while(0) +#endif +#else +/* unknown */ +#endif + +#if !defined(DUK_UNREACHABLE) +/* Don't know how to declare unreachable point, so don't do it; this + * may cause some spurious compilation warnings (e.g. "variable used + * uninitialized"). + */ +#define DUK_UNREACHABLE() /* unreachable */ +#endif + +/* + * Likely and unlikely branches. Using these is not at all a clear cut case, + * so the selection is a two-step process: (1) DUK_USE_BRANCH_HINTS is set + * if the architecture, compiler etc make it useful to use the hints, and (2) + * a separate check determines how to do them. + * + * These macros expect the argument to be a relational expression with an + * integer value. If used with pointers, you should use an explicit check + * like: + * + * if (DUK_LIKELY(ptr != NULL)) { ... } + * + * instead of: + * + * if (DUK_LIKELY(ptr)) { ... } + * + * http://gcc.gnu.org/onlinedocs/gcc/Other-Builtins.html (__builtin_expect) + */ + +/* pretty much a placeholder now */ +#if defined(DUK_F_GCC) +#define DUK_USE_BRANCH_HINTS +#elif defined(DUK_F_CLANG) +#define DUK_USE_BRANCH_HINTS +#else +#undef DUK_USE_BRANCH_HINTS +#endif + +#if defined(DUK_USE_BRANCH_HINTS) +#if defined(DUK_F_GCC_VERSION) && (DUK_F_GCC_VERSION >= 40500L) +/* GCC: test not very accurate; enable only in relatively recent builds + * because of bugs in gcc-4.4 (http://lists.debian.org/debian-gcc/2010/04/msg00000.html) + */ +#define DUK_LIKELY(x) __builtin_expect((x), 1) +#define DUK_UNLIKELY(x) __builtin_expect((x), 0) +#elif defined(DUK_F_CLANG) +#define DUK_LIKELY(x) __builtin_expect((x), 1) +#define DUK_UNLIKELY(x) __builtin_expect((x), 0) +#endif +#endif /* DUK_USE_BRANCH_HINTS */ + +#if !defined(DUK_LIKELY) +#define DUK_LIKELY(x) (x) +#endif +#if !defined(DUK_UNLIKELY) +#define DUK_UNLIKELY(x) (x) +#endif + +/* + * Function inlining control + * + * DUK_NOINLINE: avoid inlining a function. + * DUK_INLINE: suggest inlining a function. + * DUK_ALWAYS_INLINE: force inlining for critical functions. + */ + +#if defined(DUK_F_CLANG) +#define DUK_NOINLINE __attribute__((noinline)) +#define DUK_INLINE inline +#define DUK_ALWAYS_INLINE inline __attribute__((always_inline)) +#elif defined(DUK_F_GCC) && defined(DUK_F_GCC_VERSION) +#if (DUK_F_GCC_VERSION >= 30101) +#define DUK_NOINLINE __attribute__((noinline)) +#define DUK_INLINE inline +#define DUK_ALWAYS_INLINE inline __attribute__((always_inline)) +#endif +#endif + +#if !defined(DUK_NOINLINE) +#define DUK_NOINLINE /*nop*/ +#define DUK_INLINE /*nop*/ +#define DUK_ALWAYS_INLINE /*nop*/ +#endif + +/* + * Symbol visibility macros + * + * To avoid C++ declaration issues (see GH-63): + * + * - Don't use DUK_LOCAL_DECL for local -data symbols- so that you don't + * end up with both a "static" declaration and a definition. + * + * - Wrap any DUK_INTERNAL_DECL with a '#if !defined(DUK_SINGLE_FILE)' + * so that the internal declarations (which would map to "static" in + * a single file distribution) get dropped. + */ + +/* XXX: user override for these? user override for just using the default visibility macros? */ +/* XXX: separate macros for function and data may be necessary at some point. */ + +#if defined(DUK_F_GCC_VERSION) +#if (DUK_F_GCC_VERSION >= 40000) && !(defined(DUK_F_MINGW) || defined(DUK_F_CYGWIN)) +/* Might work on earlier versions too but limit to GCC 4+. + * MinGW should use Windows specific __declspec or no visibility attributes at all, + * otherwise: "warning: visibility attribute not supported in this configuration; ignored". + * Same applies to Cygwin GCC. + */ +#define DUK_F_GCC_SYMBOL_VISIBILITY +#endif +#endif +#if defined(DUK_F_CLANG) && !defined(DUK_F_GCC_SYMBOL_VISIBILITY) +#define DUK_F_GCC_SYMBOL_VISIBILITY +#endif +#if defined(DUK_OPT_DLL_BUILD) && defined(_WIN32) && (defined(_MSC_VER) || defined(__GNUC__)) +/* __declspec(dllexport) and __declspec(dllimport) only for Windows DLL build. + * MSVC: any minimum version? + * MinGW: no minimum version, even gcc-2.95.3 supported dllimport/dllexport. +*/ +#define DUK_F_MSVC_DLL_SYMBOL_VISIBILITY +#endif + +#if defined(DUK_F_GCC_SYMBOL_VISIBILITY) +/* GCC 4+ visibility attributes. */ +#define DUK_EXTERNAL_DECL __attribute__ ((visibility("default"))) extern +#define DUK_EXTERNAL __attribute__ ((visibility("default"))) +#if defined(DUK_SINGLE_FILE) +#define DUK_INTERNAL_DECL static +#define DUK_INTERNAL static +#else +#define DUK_INTERNAL_DECL __attribute__ ((visibility("hidden"))) extern +#define DUK_INTERNAL __attribute__ ((visibility("hidden"))) +#endif +#elif defined(DUK_F_MSVC_DLL_SYMBOL_VISIBILITY) +/* MSVC dllexport/dllimport: appropriate __declspec depends on whether we're + * compiling Duktape or the application. + */ +#if defined(DUK_COMPILING_DUKTAPE) +#define DUK_EXTERNAL_DECL extern __declspec(dllexport) +#define DUK_EXTERNAL __declspec(dllexport) +#else +#define DUK_EXTERNAL_DECL extern __declspec(dllimport) +#define DUK_EXTERNAL should_not_happen +#endif +#if defined(DUK_SINGLE_FILE) +#define DUK_INTERNAL_DECL static +#define DUK_INTERNAL static +#else +#define DUK_INTERNAL_DECL extern +#define DUK_INTERNAL /*empty*/ +#endif +#else +/* Default visibility. */ +#define DUK_EXTERNAL_DECL extern +#define DUK_EXTERNAL /*empty*/ +#if defined(DUK_SINGLE_FILE) +#define DUK_INTERNAL_DECL static +#define DUK_INTERNAL static +#else /* DUK_SINGLE_FILE */ +#define DUK_INTERNAL_DECL extern +#define DUK_INTERNAL /*empty*/ +#endif +#endif + +/* For now, these are shared. */ +#define DUK_LOCAL_DECL static +#define DUK_LOCAL static + +/* + * __FILE__, __LINE__, __func__ are wrapped. Especially __func__ is a + * problem because it is not available even in some compilers which try + * to be C99 compatible (e.g. VBCC with -c99 option). + */ + +#define DUK_FILE_MACRO __FILE__ + +#define DUK_LINE_MACRO __LINE__ + +#if !defined(DUK_F_VBCC) && !defined(DUK_F_MSVC) +#define DUK_FUNC_MACRO __func__ +#else +#define DUK_FUNC_MACRO "unknown" +#endif + +/* + * Byteswap macros + * + * These are here so that inline assembly or other platform functions can be + * used if available. + */ + +#define DUK_BSWAP32(x) \ + ((((duk_uint32_t) (x)) >> 24) | \ + ((((duk_uint32_t) (x)) >> 8) & 0xff00UL) | \ + ((((duk_uint32_t) (x)) << 8) & 0xff0000UL) | \ + (((duk_uint32_t) (x)) << 24)) + +#define DUK_BSWAP16(x) \ + ((duk_uint16_t) (x) >> 8) | \ + ((duk_uint16_t) (x) << 8) + +/* + * Architecture string, human readable value exposed in Duktape.env + */ + +#if defined(DUK_F_X86) +#define DUK_USE_ARCH_STRING "x86" +#elif defined(DUK_F_X32) +#define DUK_USE_ARCH_STRING "x32" +#elif defined(DUK_F_X64) +#define DUK_USE_ARCH_STRING "x64" +#elif defined(DUK_F_ARM) +#define DUK_USE_ARCH_STRING "arm" +#elif defined(DUK_F_MIPS32) +#define DUK_USE_ARCH_STRING "mips32" +#elif defined(DUK_F_MIPS64) +#define DUK_USE_ARCH_STRING "mips64" +#elif defined(DUK_F_SUPERH) +#define DUK_USE_ARCH_STRING "sh" +#elif defined(DUK_F_M68K) +#define DUK_USE_ARCH_STRING "m68k" +#elif defined(DUK_F_FLASHPLAYER) +#define DUK_USE_ARCH_STRING "flashplayer" +#elif defined(DUK_F_EMSCRIPTEN) +#define DUK_USE_ARCH_STRING "emscripten" +#else +#define DUK_USE_ARCH_STRING "unknown" +#endif + +/* + * OS string, human readable value exposed in Duktape.env + */ + +#if defined(DUK_F_LINUX) +#define DUK_USE_OS_STRING "linux" +#elif defined(__APPLE__) +/* http://stackoverflow.com/questions/5919996/how-to-detect-reliably-mac-os-x-ios-linux-windows-in-c-preprocessor */ +#if TARGET_IPHONE_SIMULATOR +#define DUK_USE_OS_STRING "iphone-sim" +#elif TARGET_OS_IPHONE +#define DUK_USE_OS_STRING "iphone" +#elif TARGET_OS_MAC +#define DUK_USE_OS_STRING "ios" +#else +#define DUK_USE_OS_STRING "ios-unknown" +#endif +#elif defined(DUK_F_FREEBSD) +#define DUK_USE_OS_STRING "freebsd" +#elif defined(DUK_F_OPENBSD) +#define DUK_USE_OS_STRING "openbsd" +#elif defined(DUK_F_NETBSD) +#define DUK_USE_OS_STRING "netbsd" +#elif defined(DUK_F_BSD) +#define DUK_USE_OS_STRING "bsd" +#elif defined(DUK_F_UNIX) +#define DUK_USE_OS_STRING "unix" +#elif defined(DUK_F_WINDOWS) +#define DUK_USE_OS_STRING "windows" +#elif defined(DUK_F_TOS) +#define DUK_USE_OS_STRING "tos" +#elif defined(DUK_F_AMIGAOS) +#define DUK_USE_OS_STRING "amigaos" +#elif defined(DUK_F_QNX) +#define DUK_USE_OS_STRING "qnx" +#elif defined(DUK_F_TINSPIRE) +#define DUK_USE_OS_STRING "tinspire" +#else +#define DUK_USE_OS_STRING "unknown" +#endif + +/* + * Compiler string, human readable value exposed in Duktape.env + */ + +#if defined(DUK_F_MINGW) +#define DUK_USE_COMPILER_STRING "mingw" +#elif defined(DUK_F_GCC) +#if defined(DUK_F_CPP) +#define DUK_USE_COMPILER_STRING "g++" +#else +#define DUK_USE_COMPILER_STRING "gcc" +#endif +#elif defined(DUK_F_CLANG) +#define DUK_USE_COMPILER_STRING "clang" +#elif defined(DUK_F_MSVC) +#define DUK_USE_COMPILER_STRING "msvc" +#elif defined(DUK_F_VBCC) +#define DUK_USE_COMPILER_STRING "vbcc" +#else +#define DUK_USE_COMPILER_STRING "unknown" +#endif + +/* + * Long control transfer, setjmp/longjmp or alternatives + * + * Signal mask is not saved (when that can be communicated to the platform) + */ + +/* dummy non-zero value to be used as an argument for longjmp(), see man longjmp */ +#define DUK_LONGJMP_DUMMY_VALUE 1 + +#if defined(DUK_OPT_SETJMP) +#define DUK_USE_SETJMP +#elif defined(DUK_OPT_UNDERSCORE_SETJMP) +#define DUK_USE_UNDERSCORE_SETJMP +#elif defined(DUK_OPT_SIGSETJMP) +#define DUK_USE_SIGSETJMP +#elif defined(__APPLE__) +/* Use _setjmp() on Apple by default, see GH-55. */ +#define DUK_USE_UNDERSCORE_SETJMP +#else +/* The most portable default is setjmp(). */ +#define DUK_USE_SETJMP +#endif + +#if defined(DUK_USE_UNDERSCORE_SETJMP) +#define DUK_SETJMP(jb) _setjmp((jb)) +#define DUK_LONGJMP(jb) _longjmp((jb), DUK_LONGJMP_DUMMY_VALUE) +#elif defined(DUK_USE_SIGSETJMP) +#define DUK_SETJMP(jb) sigsetjmp((jb), 0 /*savesigs*/) +#define DUK_LONGJMP(jb) siglongjmp((jb), DUK_LONGJMP_DUMMY_VALUE) +#elif defined(DUK_USE_SETJMP) +#define DUK_SETJMP(jb) setjmp((jb)) +#define DUK_LONGJMP(jb) longjmp((jb), DUK_LONGJMP_DUMMY_VALUE) +#else +#error internal error +#endif + +/* + * Target info string + */ + +#if defined(DUK_OPT_TARGET_INFO) +#define DUK_USE_TARGET_INFO DUK_OPT_TARGET_INFO +#else +#define DUK_USE_TARGET_INFO "unknown" +#endif + +/* + * Speed/size and other performance options + */ + +/* Use fast ("inline") refcount operations instead of calling out to helpers + * by default. The difference in binary size is small (~1kB on x64). + */ +#define DUK_USE_FAST_REFCOUNT_DEFAULT + +/* Assert for valstack space but don't check for it in non-assert build. + * Valstack overruns (writing beyond checked space) is memory unsafe and + * potentially a segfault. Produces a smaller and faster binary. + * (In practice the speed difference is small with -O3 so default to + * safer behavior for now.) + */ +#undef DUK_USE_VALSTACK_UNSAFE + +/* Catch-all flag which can be used to choose between variant algorithms + * where a speed-size tradeoff exists (e.g. lookup tables). When it really + * matters, specific use flags may be appropriate. + */ +#define DUK_USE_PREFER_SIZE + +/* + * Tagged type representation (duk_tval) + */ + +#undef DUK_USE_PACKED_TVAL + +#if defined(DUK_USE_PACKED_TVAL_POSSIBLE) && !defined(DUK_OPT_NO_PACKED_TVAL) +#define DUK_USE_PACKED_TVAL +#endif + +/* Support for 48-bit signed integer duk_tval with transparent semantics. */ +#undef DUK_USE_FASTINT +#if defined(DUK_OPT_FASTINT) +#if !defined(DUK_F_HAVE_64BIT) +#error DUK_OPT_FASTINT requires 64-bit integer type support at the moment +#endif +#define DUK_USE_FASTINT +#endif + +/* + * Memory management options + */ + +#define DUK_USE_REFERENCE_COUNTING +#define DUK_USE_DOUBLE_LINKED_HEAP +#define DUK_USE_MARK_AND_SWEEP +#define DUK_USE_MS_STRINGTABLE_RESIZE + +#if defined(DUK_OPT_NO_REFERENCE_COUNTING) +#undef DUK_USE_REFERENCE_COUNTING +#undef DUK_USE_DOUBLE_LINKED_HEAP +/* XXX: undef DUK_USE_MS_STRINGTABLE_RESIZE as it is more expensive + * with more frequent mark-and-sweeps? + */ +#endif + +#if defined(DUK_OPT_NO_MARK_AND_SWEEP) +#undef DUK_USE_MARK_AND_SWEEP +#endif + +#if defined(DUK_USE_MARK_AND_SWEEP) +#define DUK_USE_VOLUNTARY_GC +#if defined(DUK_OPT_NO_VOLUNTARY_GC) +#undef DUK_USE_VOLUNTARY_GC +#endif +#endif + +#if !defined(DUK_USE_MARK_AND_SWEEP) && !defined(DUK_USE_REFERENCE_COUNTING) +#error must have either mark-and-sweep or reference counting enabled +#endif + +#if defined(DUK_OPT_NO_MS_STRINGTABLE_RESIZE) +#undef DUK_USE_MS_STRINGTABLE_RESIZE +#endif + +#undef DUK_USE_GC_TORTURE +#if defined(DUK_OPT_GC_TORTURE) +#define DUK_USE_GC_TORTURE +#endif + +/* + * String table options + */ + +#if defined(DUK_OPT_STRTAB_CHAIN) && defined(DUK_OPT_STRTAB_CHAIN_SIZE) +/* Low memory algorithm: separate chaining using arrays, fixed size hash */ +#define DUK_USE_STRTAB_CHAIN +#define DUK_USE_STRTAB_CHAIN_SIZE DUK_OPT_STRTAB_CHAIN_SIZE +#else +/* Default algorithm: open addressing (probing) */ +#define DUK_USE_STRTAB_PROBE +#endif + +/* + * Error handling options + */ + +#define DUK_USE_AUGMENT_ERROR_CREATE +#define DUK_USE_AUGMENT_ERROR_THROW +#define DUK_USE_TRACEBACKS +#define DUK_USE_ERRCREATE +#define DUK_USE_ERRTHROW + +#define DUK_USE_VERBOSE_ERRORS + +#if defined(DUK_OPT_NO_AUGMENT_ERRORS) +#undef DUK_USE_AUGMENT_ERROR_CREATE +#undef DUK_USE_AUGMENT_ERROR_THROW +#undef DUK_USE_TRACEBACKS +#undef DUK_USE_ERRCREATE +#undef DUK_USE_ERRTHROW +#elif defined(DUK_OPT_NO_TRACEBACKS) +#undef DUK_USE_TRACEBACKS +#endif + +#if defined(DUK_OPT_NO_VERBOSE_ERRORS) +#undef DUK_USE_VERBOSE_ERRORS +#endif + +#if defined(DUK_USE_TRACEBACKS) +#if defined(DUK_OPT_TRACEBACK_DEPTH) +#define DUK_USE_TRACEBACK_DEPTH DUK_OPT_TRACEBACK_DEPTH +#else +#define DUK_USE_TRACEBACK_DEPTH 10 +#endif +#endif + +/* Include messages in executor internal errors. */ +#define DUK_USE_VERBOSE_EXECUTOR_ERRORS + +/* + * Execution and debugger options + */ + +#undef DUK_USE_INTERRUPT_COUNTER +#if defined(DUK_OPT_INTERRUPT_COUNTER) +#define DUK_USE_INTERRUPT_COUNTER +#endif + +#undef DUK_USE_EXEC_TIMEOUT_CHECK +#if defined(DUK_OPT_EXEC_TIMEOUT_CHECK) +#define DUK_USE_EXEC_TIMEOUT_CHECK(udata) DUK_OPT_EXEC_TIMEOUT_CHECK((udata)) +#endif + +#undef DUK_USE_DEBUGGER_SUPPORT +#if defined(DUK_OPT_DEBUGGER_SUPPORT) +#define DUK_USE_DEBUGGER_SUPPORT +#endif + +#undef DUK_USE_DEBUGGER_FWD_PRINTALERT +#if defined(DUK_OPT_DEBUGGER_SUPPORT) && defined(DUK_OPT_DEBUGGER_FWD_PRINTALERT) +#define DUK_USE_DEBUGGER_FWD_PRINTALERT +#endif + +#undef DUK_USE_DEBUGGER_FWD_LOGGING +#if defined(DUK_OPT_DEBUGGER_SUPPORT) && defined(DUK_OPT_DEBUGGER_FWD_LOGGING) +#define DUK_USE_DEBUGGER_FWD_LOGGING +#endif + +/* DumpHeap is optional because it's not always needed and has a relatively + * large footprint. + */ +#undef DUK_USE_DEBUGGER_DUMPHEAP +#if defined(DUK_OPT_DEBUGGER_DUMPHEAP) +#define DUK_USE_DEBUGGER_DUMPHEAP +#endif + +/* Debugger transport read/write torture. */ +#undef DUK_USE_DEBUGGER_TRANSPORT_TORTURE +#if defined(DUK_OPT_DEBUGGER_TRANSPORT_TORTURE) +#define DUK_USE_DEBUGGER_TRANSPORT_TORTURE +#endif + +/* For opcodes with indirect indices, check final index against stack size. + * This should not be necessary because the compiler is trusted, and we don't + * bound check non-indirect indices either. + */ +#undef DUK_USE_EXEC_INDIRECT_BOUND_CHECK +#if defined(DUK_OPT_DEBUG) || defined(DUK_OPT_ASSERTIONS) +/* Enabled with debug/assertions just so that any issues can be caught. */ +#define DUK_USE_EXEC_INDIRECT_BOUND_CHECK +#endif + +/* + * Debug printing and assertion options + */ + +#undef DUK_USE_DEBUG +#undef DUK_USE_DPRINT +#undef DUK_USE_DDPRINT +#undef DUK_USE_DDDPRINT +#undef DUK_USE_DPRINT_RDTSC +#undef DUK_USE_ASSERTIONS + +/* Global debug enable. Compile must be clean on C99 regardless of whether or + * not debugging is enabled. On non-C99 platforms compile should be clean with + * debugging disabled but may produce warnings with debugging enabled (related + * to debug macro hackery and such). + */ +#if defined(DUK_OPT_DEBUG) +#define DUK_USE_DEBUG +#endif + +#if defined(DUK_OPT_DEBUG) && defined(DUK_OPT_DPRINT) +#define DUK_USE_DPRINT +#endif +#if defined(DUK_OPT_DEBUG) && defined(DUK_OPT_DDPRINT) +#define DUK_USE_DDPRINT +#endif +#if defined(DUK_OPT_DEBUG) && defined(DUK_OPT_DDDPRINT) +#define DUK_USE_DDDPRINT +#endif + +#undef DUK_USE_DPRINT_COLORS +#if defined(DUK_OPT_DPRINT_COLORS) +#define DUK_USE_DPRINT_COLORS +#endif + +#if defined(DUK_RDTSC_AVAILABLE) && defined(DUK_OPT_DPRINT_RDTSC) +#define DUK_USE_DPRINT_RDTSC +#else +#undef DUK_USE_DPRINT_RDTSC +#endif + +#if defined(DUK_OPT_ASSERTIONS) +#define DUK_USE_ASSERTIONS +#endif + +/* The static buffer for debug printing is quite large by default, so there + * is an option to shrink it manually for constrained builds. + */ +#if defined(DUK_OPT_DEBUG_BUFSIZE) +#define DUK_USE_DEBUG_BUFSIZE DUK_OPT_DEBUG_BUFSIZE +#else +#define DUK_USE_DEBUG_BUFSIZE 65536L +#endif + +/* + * Ecmascript features / compliance options + */ + +#if defined(DUK_F_BCC) +/* Math built-in is stubbed out on BCC to allow compiler torture testing. */ +#else +#define DUK_USE_MATH_BUILTIN +#endif + +#define DUK_USE_STRICT_DECL +#if defined(DUK_OPT_NO_STRICT_DECL) +#undef DUK_USE_STRICT_DECL +#endif + +#define DUK_USE_REGEXP_SUPPORT +#if defined(DUK_OPT_NO_REGEXP_SUPPORT) +#undef DUK_USE_REGEXP_SUPPORT +#endif + +#undef DUK_USE_STRICT_UTF8_SOURCE +#if defined(DUK_OPT_STRICT_UTF8_SOURCE) +#define DUK_USE_STRICT_UTF8_SOURCE +#endif + +#define DUK_USE_OCTAL_SUPPORT +#if defined(DUK_OPT_NO_OCTAL_SUPPORT) +#undef DUK_USE_OCTAL_SUPPORT +#endif + +#define DUK_USE_SOURCE_NONBMP +#if defined(DUK_OPT_NO_SOURCE_NONBMP) +#undef DUK_USE_SOURCE_NONBMP +#endif + +#define DUK_USE_BROWSER_LIKE +#if defined(DUK_OPT_NO_BROWSER_LIKE) +#undef DUK_USE_BROWSER_LIKE +#endif + +/* E5/E5.1 Section B features. */ +#define DUK_USE_SECTION_B +#if defined(DUK_OPT_NO_SECTION_B) +#undef DUK_USE_SECTION_B +#endif + +/* Non-standard regexp parsing features. */ +#define DUK_USE_NONSTD_REGEXP_DOLLAR_ESCAPE + +/* Treat function statements (function declarations outside top level of + * Program or FunctionBody) same as normal function declarations. This is + * also V8 behavior. See test-dev-func-decl-outside-top.js. + */ +#define DUK_USE_NONSTD_FUNC_STMT +#if defined(DUK_OPT_NO_NONSTD_FUNC_STMT) +#undef DUK_USE_NONSTD_FUNC_STMT +#endif + +/* Array.prototype.splice() non-standard but real world compatible behavior + * when deleteCount is omitted. + */ +#define DUK_USE_NONSTD_ARRAY_SPLICE_DELCOUNT +#if defined(DUK_OPT_NO_NONSTD_ARRAY_SPLICE_DELCOUNT) +#undef DUK_USE_NONSTD_ARRAY_SPLICE_DELCOUNT +#endif + +/* Array.prototype.concat() non-standard but real world compatible behavior + * for non-existent trailing elements. + */ +#define DUK_USE_NONSTD_ARRAY_CONCAT_TRAILER +#if defined(DUK_OPT_NO_NONSTD_ARRAY_CONCAT_TRAILER) +#undef DUK_USE_NONSTD_ARRAY_CONCAT_TRAILER +#endif + +/* Array.prototype.map() non-standard but real world compatible behavior + * for non-existent trailing elements. + */ +#define DUK_USE_NONSTD_ARRAY_MAP_TRAILER +#if defined(DUK_OPT_NO_NONSTD_ARRAY_MAP_TRAILER) +#undef DUK_USE_NONSTD_ARRAY_MAP_TRAILER +#endif + +/* Non-standard 'caller' property for function instances, see + * test-bi-function-nonstd-caller-prop.js. + */ +#undef DUK_USE_NONSTD_FUNC_CALLER_PROPERTY +#if defined(DUK_OPT_NONSTD_FUNC_CALLER_PROPERTY) +#define DUK_USE_NONSTD_FUNC_CALLER_PROPERTY +#endif + +/* Non-standard Object.prototype.__proto__ (ES6 draft), see + * test-bi-object-proto-__proto__.js. + */ +#define DUK_USE_ES6_OBJECT_PROTO_PROPERTY +#if defined(DUK_OPT_NO_ES6_OBJECT_PROTO_PROPERTY) +#undef DUK_USE_ES6_OBJECT_PROTO_PROPERTY +#endif + +/* Non-standard Object.setPrototypeOf (ES6 draft), see + * test-bi-object-setprototypeof.js. + */ +#define DUK_USE_ES6_OBJECT_SETPROTOTYPEOF +#if defined(DUK_OPT_NO_ES6_OBJECT_SETPROTOTYPEOF) +#undef DUK_USE_ES6_OBJECT_SETPROTOTYPEOF +#endif + +/* ES6 Proxy object (subset for now). */ +#define DUK_USE_ES6_PROXY +#if defined(DUK_OPT_NO_ES6_PROXY) +#undef DUK_USE_ES6_PROXY +#endif + +/* Record pc-to-line information. */ +#define DUK_USE_PC2LINE +#if defined(DUK_OPT_NO_PC2LINE) +#undef DUK_USE_PC2LINE +#endif + +/* Non-standard function 'source' property. */ +#undef DUK_USE_NONSTD_FUNC_SOURCE_PROPERTY +#if defined(DUK_OPT_NONSTD_FUNC_SOURCE_PROPERTY) +#define DUK_USE_NONSTD_FUNC_SOURCE_PROPERTY +#endif + +/* CommonJS modules */ +#define DUK_USE_COMMONJS_MODULES +#if defined(DUK_OPT_NO_COMMONJS_MODULES) +#undef DUK_USE_COMMONJS_MODULES +#endif + +/* Additional key argument to setter/getter calls when triggered by property + * accesses. + */ + +#define DUK_USE_NONSTD_GETTER_KEY_ARGUMENT +#define DUK_USE_NONSTD_SETTER_KEY_ARGUMENT +#if defined(DUK_OPT_NO_NONSTD_ACCESSOR_KEY_ARGUMENT) +#undef DUK_USE_NONSTD_GETTER_KEY_ARGUMENT +#undef DUK_USE_NONSTD_SETTER_KEY_ARGUMENT +#endif + +/* JSON escaping of U+2028 and U+2029. + */ + +#define DUK_USE_NONSTD_JSON_ESC_U2028_U2029 +#if defined(DUK_OPT_NO_NONSTD_JSON_ESC_U2028_U2029) +#undef DUK_USE_NONSTD_JSON_ESC_U2028_U2029 +#endif + +/* Allow 32-bit codepoints in String.fromCharCode. */ +#define DUK_USE_NONSTD_STRING_FROMCHARCODE_32BIT +#if defined(DUK_OPT_NO_NONSTD_STRING_FROMCHARCODE_32BIT) +#undef DUK_USE_NONSTD_STRING_FROMCHARCODE_32BIT +#endif + +/* Non-standard array fast path write behavior: when writing to numeric + * indexes of an Array instance, assume Array.prototype doesn't have + * conflicting properties (e.g. a non-writable property "7"). + */ +#define DUK_USE_NONSTD_ARRAY_WRITE +#if defined(DUK_OPT_NO_NONSTD_ARRAY_WRITE) +#undef DUK_USE_NONSTD_ARRAY_WRITE +#endif + +/* + * Tailcalls + */ + +/* Tailcalls are enabled by default. The non-standard function 'caller' + * property feature conflicts with tailcalls quite severely so tailcalls + * are disabled if the 'caller' property is enabled. + */ +#define DUK_USE_TAILCALL +#if defined(DUK_USE_NONSTD_FUNC_CALLER_PROPERTY) +#undef DUK_USE_TAILCALL +#endif + +/* + * Deep vs. shallow stack. + * + * Some embedded platforms have very shallow stack (e.g. 64kB); default to + * a shallow stack on unknown platforms or known embedded platforms. + */ + +#if defined(DUK_F_LINUX) || defined(DUK_F_BSD) || defined(DUK_F_WINDOWS) || \ + defined(DUK_OPT_DEEP_C_STACK) +#define DUK_USE_DEEP_C_STACK +#else +#undef DUK_USE_DEEP_C_STACK +#endif + +/* + * Ecmascript compiler + */ + +/* Ensure final bytecode never exceeds a certain byte size and never uses + * line numbers above a certain limit. This ensures that there is no need + * to deal with unbounded ranges in e.g. pc2line data structures. For now, + * limits are set so that signed 32-bit values can represent line number + * and byte offset with room to spare. + */ +#define DUK_USE_ESBC_LIMITS +#define DUK_USE_ESBC_MAX_LINENUMBER 0x7fff0000L +#define DUK_USE_ESBC_MAX_BYTES 0x7fff0000L + +#undef DUK_USE_SHUFFLE_TORTURE +#if defined(DUK_OPT_SHUFFLE_TORTURE) +#define DUK_USE_SHUFFLE_TORTURE +#endif + +/* + * User panic handler, panic exit behavior for default panic handler + */ + +#undef DUK_USE_PANIC_HANDLER +#if defined(DUK_OPT_PANIC_HANDLER) +#define DUK_USE_PANIC_HANDLER(code,msg) DUK_OPT_PANIC_HANDLER((code),(msg)) +#endif + +#undef DUK_USE_PANIC_ABORT +#undef DUK_USE_PANIC_EXIT +#undef DUK_USE_PANIC_SEGFAULT + +#if defined(DUK_OPT_SEGFAULT_ON_PANIC) +#define DUK_USE_PANIC_SEGFAULT +#else +#define DUK_USE_PANIC_ABORT +#endif + +/* + * File I/O support. This is now used in a few API calls to e.g. push + * a string from file contents or eval a file. For portability it must + * be possible to disable I/O altogether. + */ + +#undef DUK_USE_FILE_IO +#if !defined(DUK_OPT_NO_FILE_IO) +#define DUK_USE_FILE_IO +#endif + +/* + * Optional run-time self tests executed when a heap is created. Some + * platform/compiler issues cannot be determined at compile time. One + * particular example is the bug described in misc/clang_aliasing.c. + */ + +#undef DUK_USE_SELF_TESTS +#if defined(DUK_OPT_SELF_TESTS) +#define DUK_USE_SELF_TESTS +#endif + +/* Double aliasing testcase fails when Emscripten-generated code is run + * on Firefox. This is not fatal because it only affects packed duk_tval + * which we avoid with Emscripten. + */ +#undef DUK_USE_NO_DOUBLE_ALIASING_SELFTEST +#if defined(DUK_F_EMSCRIPTEN) +#define DUK_USE_NO_DOUBLE_ALIASING_SELFTEST +#endif + +/* + * Codecs + */ + +#define DUK_USE_JX +#if defined(DUK_OPT_NO_JX) +#undef DUK_USE_JX +#endif + +#define DUK_USE_JC +#if defined(DUK_OPT_NO_JC) +#undef DUK_USE_JC +#endif + +/* + * InitJS code + */ + +/* Always use the built-in InitJS code for now. */ +#define DUK_USE_BUILTIN_INITJS + +/* User provided InitJS. */ +#undef DUK_USE_USER_INITJS +#if defined(DUK_OPT_USER_INITJS) +#define DUK_USE_USER_INITJS (DUK_OPT_USER_INITJS) +#endif + +/* + * External string data support + * + * Allow duk_hstrings to store data also behind an external pointer (see + * duk_hstring_external). This increases code size slightly but is useful + * in low memory environments where memory is more limited than flash. + */ + +#undef DUK_USE_HSTRING_EXTDATA +#if defined(DUK_OPT_EXTERNAL_STRINGS) +#define DUK_USE_HSTRING_EXTDATA +#endif + +#undef DUK_USE_EXTSTR_INTERN_CHECK +#if defined(DUK_OPT_EXTERNAL_STRINGS) && defined(DUK_OPT_EXTSTR_INTERN_CHECK) +#define DUK_USE_EXTSTR_INTERN_CHECK(udata,ptr,len) DUK_OPT_EXTSTR_INTERN_CHECK((udata), (ptr), (len)) +#endif + +#undef DUK_USE_EXTSTR_FREE +#if defined(DUK_OPT_EXTERNAL_STRINGS) && defined(DUK_OPT_EXTSTR_FREE) +#define DUK_USE_EXTSTR_FREE(udata,ptr) DUK_OPT_EXTSTR_FREE((udata), (ptr)) +#endif + +/* + * Lightweight functions + */ + +/* Force built-ins to use lightfunc function pointers when possible. This + * makes the built-in functions non-compliant with respect to their property + * values and such, but is very useful in low memory environments (can save + * around 14kB of initial RAM footprint). + */ +#undef DUK_USE_LIGHTFUNC_BUILTINS +#if defined(DUK_OPT_LIGHTFUNC_BUILTINS) +#define DUK_USE_LIGHTFUNC_BUILTINS +#endif + +/* + * Pointer compression and 16-bit header fields for low memory environments + */ + +#undef DUK_USE_HEAPPTR16 +#undef DUK_USE_HEAPPTR_ENC16 +#undef DUK_USE_HEAPPTR_DEC16 +#if defined(DUK_OPT_HEAPPTR16) && defined(DUK_OPT_HEAPPTR_ENC16) && defined(DUK_OPT_HEAPPTR_DEC16) +#define DUK_USE_HEAPPTR16 +#define DUK_USE_HEAPPTR_ENC16(udata,ptr) DUK_OPT_HEAPPTR_ENC16((udata),(ptr)) +#define DUK_USE_HEAPPTR_DEC16(udata,ptr) DUK_OPT_HEAPPTR_DEC16((udata),(ptr)) +#endif + +#undef DUK_USE_DATAPTR16 +#undef DUK_USE_DATAPTR_ENC16 +#undef DUK_USE_DATAPTR_DEC16 +#if defined(DUK_OPT_DATAPTR16) && defined(DUK_OPT_DATAPTR_ENC16) && defined(DUK_OPT_DATAPTR_DEC16) +#define DUK_USE_DATAPTR16 +#define DUK_USE_DATAPTR_ENC16(udata,ptr) DUK_OPT_DATAPTR_ENC16((udata),(ptr)) +#define DUK_USE_DATAPTR_DEC16(udata,ptr) DUK_OPT_DATAPTR_DEC16((udata),(ptr)) +#endif + +#undef DUK_USE_FUNCPTR16 +#undef DUK_USE_FUNCPTR_ENC16 +#undef DUK_USE_FUNCPTR_DEC16 +#if defined(DUK_OPT_FUNCPTR16) && defined(DUK_OPT_FUNCPTR_ENC16) && defined(DUK_OPT_FUNCPTR_DEC16) +#define DUK_USE_FUNCPTR16 +#define DUK_USE_FUNCPTR_ENC16(udata,ptr) DUK_OPT_FUNCPTR_ENC16((udata),(ptr)) +#define DUK_USE_FUNCPTR_DEC16(udata,ptr) DUK_OPT_FUNCPTR_DEC16((udata),(ptr)) +#endif + +#undef DUK_USE_REFCOUNT16 +#if defined(DUK_OPT_REFCOUNT16) +#define DUK_USE_REFCOUNT16 +#endif + +#undef DUK_USE_STRHASH16 +#if defined(DUK_OPT_STRHASH16) +#define DUK_USE_STRHASH16 +#endif + +#undef DUK_USE_STRLEN16 +#if defined(DUK_OPT_STRLEN16) +#define DUK_USE_STRLEN16 +#endif + +#undef DUK_USE_BUFLEN16 +#if defined(DUK_OPT_BUFLEN16) +#define DUK_USE_BUFLEN16 +#endif + +#undef DUK_USE_OBJSIZES16 +#if defined(DUK_OPT_OBJSIZES16) +#define DUK_USE_OBJSIZES16 +#endif + +/* For now, hash part is dropped if and only if 16-bit object fields are used. */ +#define DUK_USE_HOBJECT_HASH_PART +#if defined(DUK_USE_OBJSIZES16) +#undef DUK_USE_HOBJECT_HASH_PART +#endif + +/* + * Miscellaneous + */ + +#define DUK_USE_PROVIDE_DEFAULT_ALLOC_FUNCTIONS +#undef DUK_USE_EXPLICIT_NULL_INIT + +#if !defined(DUK_USE_PACKED_TVAL) +#define DUK_USE_EXPLICIT_NULL_INIT +#endif + +#define DUK_USE_ZERO_BUFFER_DATA +#if defined(DUK_OPT_NO_ZERO_BUFFER_DATA) +#undef DUK_USE_ZERO_BUFFER_DATA +#endif + +#undef DUK_USE_VARIADIC_MACROS +#if defined(DUK_F_C99) || (defined(DUK_F_CPP11) && defined(__GNUC__)) +#define DUK_USE_VARIADIC_MACROS +#endif +#if defined(_MSC_VER) && !defined(DUK_USE_VARIADIC_MACROS) +#if (_MSC_VER >= 1400) +/* VS2005+ should have variadic macros even when they're not C99. */ +#define DUK_USE_VARIADIC_MACROS +#endif +#endif + +/* + * Variable size array initialization. + * + * Variable size array at the end of a structure is nonportable. + * There are three alternatives: + * + * 1) C99 (flexible array member): char buf[] + * 2) Compiler specific (e.g. GCC): char buf[0] + * 3) Portable but wastes memory / complicates allocation: char buf[1] + */ + +/* XXX: Currently unused, only hbuffer.h needed this at some point. */ +#undef DUK_USE_FLEX_C99 +#undef DUK_USE_FLEX_ZEROSIZE +#undef DUK_USE_FLEX_ONESIZE +#if defined(DUK_F_C99) +#define DUK_USE_FLEX_C99 +#elif defined(__GNUC__) +#define DUK_USE_FLEX_ZEROSIZE +#else +#define DUK_USE_FLEX_ONESIZE +#endif + +/* + * GCC pragmas + */ + +/* XXX: GCC pragma inside a function fails in some earlier GCC versions (e.g. gcc 4.5). + * This is very approximate but allows clean builds for development right now. + */ +/* http://gcc.gnu.org/onlinedocs/cpp/Common-Predefined-Macros.html */ +#if defined(__GNUC__) && defined(__GNUC_MINOR__) && (__GNUC__ == 4) && (__GNUC_MINOR__ >= 6) +#define DUK_USE_GCC_PRAGMAS +#else +#undef DUK_USE_GCC_PRAGMAS +#endif + +/* + * User declarations + */ + +#if defined(DUK_OPT_DECLARE) +#define DUK_USE_USER_DECLARE() DUK_OPT_DECLARE +#else +#define DUK_USE_USER_DECLARE() /* no user declarations */ +#endif + +/* + * Alternative customization header + * + * If you want to modify the final DUK_USE_xxx flags directly (without + * using the available DUK_OPT_Xxx flags), define DUK_OPT_HAVE_CUSTOM_H + * and tweak the final flags there. + */ + +#if defined(DUK_OPT_HAVE_CUSTOM_H) +#include "duk_custom.h" +#endif + +#endif /* DUK_FEATURES_H_INCLUDED */ + +/* + * BEGIN PUBLIC API + */ + +#ifndef DUK_API_PUBLIC_H_INCLUDED +#define DUK_API_PUBLIC_H_INCLUDED + +/* + * Avoid C++ name mangling + */ + +#ifdef __cplusplus +extern "C" { +#endif + +/* + * Some defines forwarded from feature detection + */ + +#undef DUK_API_VARIADIC_MACROS +#ifdef DUK_USE_VARIADIC_MACROS +#define DUK_API_VARIADIC_MACROS +#endif + +#define DUK_API_NORETURN(decl) DUK_NORETURN(decl) + +/* + * Public API specific typedefs + * + * (duk_context *) maps directly to internal type (duk_hthread *). + * Currently only primitive typedefs have a '_t' suffix. + * + * Many types are wrapped by Duktape for portability to rare platforms + * where e.g. 'int' is a 16-bit type. See practical typing discussion + * in Duktape web documentation. + */ + +struct duk_memory_functions; +struct duk_function_list_entry; +struct duk_number_list_entry; + +typedef void duk_context; +typedef struct duk_memory_functions duk_memory_functions; +typedef struct duk_function_list_entry duk_function_list_entry; +typedef struct duk_number_list_entry duk_number_list_entry; + +typedef duk_ret_t (*duk_c_function)(duk_context *ctx); +typedef void *(*duk_alloc_function) (void *udata, duk_size_t size); +typedef void *(*duk_realloc_function) (void *udata, void *ptr, duk_size_t size); +typedef void (*duk_free_function) (void *udata, void *ptr); +typedef void (*duk_fatal_function) (duk_context *ctx, duk_errcode_t code, const char *msg); +typedef void (*duk_decode_char_function) (void *udata, duk_codepoint_t codepoint); +typedef duk_codepoint_t (*duk_map_char_function) (void *udata, duk_codepoint_t codepoint); +typedef duk_ret_t (*duk_safe_call_function) (duk_context *ctx); +typedef duk_size_t (*duk_debug_read_function) (void *udata, char *buffer, duk_size_t length); +typedef duk_size_t (*duk_debug_write_function) (void *udata, const char *buffer, duk_size_t length); +typedef duk_size_t (*duk_debug_peek_function) (void *udata); +typedef void (*duk_debug_read_flush_function) (void *udata); +typedef void (*duk_debug_write_flush_function) (void *udata); +typedef void (*duk_debug_detached_function) (void *udata); + +struct duk_memory_functions { + duk_alloc_function alloc_func; + duk_realloc_function realloc_func; + duk_free_function free_func; + void *udata; +}; + +struct duk_function_list_entry { + const char *key; + duk_c_function value; + duk_idx_t nargs; +}; + +struct duk_number_list_entry { + const char *key; + duk_double_t value; +}; + +/* + * Constants + */ + +/* Duktape version, (major * 10000) + (minor * 100) + patch. Allows C code + * to #ifdef against Duktape API version. The same value is also available + * to Ecmascript code in Duktape.version. Unofficial development snapshots + * have 99 for patch level (e.g. 0.10.99 would be a development version + * after 0.10.0 but before the next official release). + */ +#define DUK_VERSION 10203L + +/* Git describe for Duktape build. Useful for non-official snapshot builds + * so that application code can easily log which Duktape snapshot was used. + * Not available in the Ecmascript environment. + */ +#define DUK_GIT_DESCRIBE "v1.2.3" + +/* Duktape debug protocol version used by this build. */ +#define DUK_DEBUG_PROTOCOL_VERSION 1 + +/* Used to represent invalid index; if caller uses this without checking, + * this index will map to a non-existent stack entry. Also used in some + * API calls as a marker to denote "no value". + */ +#define DUK_INVALID_INDEX DUK_IDX_MIN + +/* Indicates that a native function does not have a fixed number of args, + * and the argument stack should not be capped/extended at all. + */ +#define DUK_VARARGS ((duk_int_t) (-1)) + +/* Number of value stack entries (in addition to actual call arguments) + * guaranteed to be allocated on entry to a Duktape/C function. + */ +#define DUK_API_ENTRY_STACK 64 + +/* Value types, used by e.g. duk_get_type() */ +#define DUK_TYPE_NONE 0 /* no value, e.g. invalid index */ +#define DUK_TYPE_UNDEFINED 1 /* Ecmascript undefined */ +#define DUK_TYPE_NULL 2 /* Ecmascript null */ +#define DUK_TYPE_BOOLEAN 3 /* Ecmascript boolean: 0 or 1 */ +#define DUK_TYPE_NUMBER 4 /* Ecmascript number: double */ +#define DUK_TYPE_STRING 5 /* Ecmascript string: CESU-8 / extended UTF-8 encoded */ +#define DUK_TYPE_OBJECT 6 /* Ecmascript object: includes objects, arrays, functions, threads */ +#define DUK_TYPE_BUFFER 7 /* fixed or dynamic, garbage collected byte buffer */ +#define DUK_TYPE_POINTER 8 /* raw void pointer */ +#define DUK_TYPE_LIGHTFUNC 9 /* lightweight function pointer */ + +/* Value mask types, used by e.g. duk_get_type_mask() */ +#define DUK_TYPE_MASK_NONE (1 << DUK_TYPE_NONE) +#define DUK_TYPE_MASK_UNDEFINED (1 << DUK_TYPE_UNDEFINED) +#define DUK_TYPE_MASK_NULL (1 << DUK_TYPE_NULL) +#define DUK_TYPE_MASK_BOOLEAN (1 << DUK_TYPE_BOOLEAN) +#define DUK_TYPE_MASK_NUMBER (1 << DUK_TYPE_NUMBER) +#define DUK_TYPE_MASK_STRING (1 << DUK_TYPE_STRING) +#define DUK_TYPE_MASK_OBJECT (1 << DUK_TYPE_OBJECT) +#define DUK_TYPE_MASK_BUFFER (1 << DUK_TYPE_BUFFER) +#define DUK_TYPE_MASK_POINTER (1 << DUK_TYPE_POINTER) +#define DUK_TYPE_MASK_LIGHTFUNC (1 << DUK_TYPE_LIGHTFUNC) +#define DUK_TYPE_MASK_THROW (1 << 10) /* internal flag value: throw if mask doesn't match */ + +/* Coercion hints */ +#define DUK_HINT_NONE 0 /* prefer number, unless input is a Date, in which + * case prefer string (E5 Section 8.12.8) + */ +#define DUK_HINT_STRING 1 /* prefer string */ +#define DUK_HINT_NUMBER 2 /* prefer number */ + +/* Enumeration flags for duk_enum() */ +#define DUK_ENUM_INCLUDE_NONENUMERABLE (1 << 0) /* enumerate non-numerable properties in addition to enumerable */ +#define DUK_ENUM_INCLUDE_INTERNAL (1 << 1) /* enumerate internal properties (regardless of enumerability) */ +#define DUK_ENUM_OWN_PROPERTIES_ONLY (1 << 2) /* don't walk prototype chain, only check own properties */ +#define DUK_ENUM_ARRAY_INDICES_ONLY (1 << 3) /* only enumerate array indices */ +#define DUK_ENUM_SORT_ARRAY_INDICES (1 << 4) /* sort array indices, use with DUK_ENUM_ARRAY_INDICES_ONLY */ +#define DUK_ENUM_NO_PROXY_BEHAVIOR (1 << 5) /* enumerate a proxy object itself without invoking proxy behavior */ + +/* Compilation flags for duk_compile() and duk_eval() */ +#define DUK_COMPILE_EVAL (1 << 0) /* compile eval code (instead of program) */ +#define DUK_COMPILE_FUNCTION (1 << 1) /* compile function code (instead of program) */ +#define DUK_COMPILE_STRICT (1 << 2) /* use strict (outer) context for program, eval, or function */ +#define DUK_COMPILE_SAFE (1 << 3) /* (internal) catch compilation errors */ +#define DUK_COMPILE_NORESULT (1 << 4) /* (internal) omit eval result */ +#define DUK_COMPILE_NOSOURCE (1 << 5) /* (internal) no source string on stack */ +#define DUK_COMPILE_STRLEN (1 << 6) /* (internal) take strlen() of src_buffer (avoids double evaluation in macro) */ + +/* Flags for duk_def_prop() and its variants */ +#define DUK_DEFPROP_WRITABLE (1 << 0) /* set writable (effective if DUK_DEFPROP_HAVE_WRITABLE set) */ +#define DUK_DEFPROP_ENUMERABLE (1 << 1) /* set enumerable (effective if DUK_DEFPROP_HAVE_ENUMERABLE set) */ +#define DUK_DEFPROP_CONFIGURABLE (1 << 2) /* set configurable (effective if DUK_DEFPROP_HAVE_CONFIGURABLE set) */ +#define DUK_DEFPROP_HAVE_WRITABLE (1 << 3) /* set/clear writable */ +#define DUK_DEFPROP_HAVE_ENUMERABLE (1 << 4) /* set/clear enumerable */ +#define DUK_DEFPROP_HAVE_CONFIGURABLE (1 << 5) /* set/clear configurable */ +#define DUK_DEFPROP_HAVE_VALUE (1 << 6) /* set value (given on value stack) */ +#define DUK_DEFPROP_HAVE_GETTER (1 << 7) /* set getter (given on value stack) */ +#define DUK_DEFPROP_HAVE_SETTER (1 << 8) /* set setter (given on value stack) */ +#define DUK_DEFPROP_FORCE (1 << 9) /* force change if possible, may still fail for e.g. virtual properties */ + +/* Flags for duk_push_thread_raw() */ +#define DUK_THREAD_NEW_GLOBAL_ENV (1 << 0) /* create a new global environment */ + +/* Flags for duk_push_string_file_raw() */ +#define DUK_STRING_PUSH_SAFE (1 << 0) /* no error if file does not exist */ + +/* Duktape specific error codes */ +#define DUK_ERR_NONE 0 /* no error (e.g. from duk_get_error_code()) */ +#define DUK_ERR_UNIMPLEMENTED_ERROR 50 /* UnimplementedError */ +#define DUK_ERR_UNSUPPORTED_ERROR 51 /* UnsupportedError */ +#define DUK_ERR_INTERNAL_ERROR 52 /* InternalError */ +#define DUK_ERR_ALLOC_ERROR 53 /* AllocError */ +#define DUK_ERR_ASSERTION_ERROR 54 /* AssertionError */ +#define DUK_ERR_API_ERROR 55 /* APIError */ +#define DUK_ERR_UNCAUGHT_ERROR 56 /* UncaughtError */ + +/* Ecmascript E5 specification error codes */ +#define DUK_ERR_ERROR 100 /* Error */ +#define DUK_ERR_EVAL_ERROR 101 /* EvalError */ +#define DUK_ERR_RANGE_ERROR 102 /* RangeError */ +#define DUK_ERR_REFERENCE_ERROR 103 /* ReferenceError */ +#define DUK_ERR_SYNTAX_ERROR 104 /* SyntaxError */ +#define DUK_ERR_TYPE_ERROR 105 /* TypeError */ +#define DUK_ERR_URI_ERROR 106 /* URIError */ + +/* Return codes for C functions (shortcut for throwing an error) */ +#define DUK_RET_UNIMPLEMENTED_ERROR (-DUK_ERR_UNIMPLEMENTED_ERROR) +#define DUK_RET_UNSUPPORTED_ERROR (-DUK_ERR_UNSUPPORTED_ERROR) +#define DUK_RET_INTERNAL_ERROR (-DUK_ERR_INTERNAL_ERROR) +#define DUK_RET_ALLOC_ERROR (-DUK_ERR_ALLOC_ERROR) +#define DUK_RET_ASSERTION_ERROR (-DUK_ERR_ASSERTION_ERROR) +#define DUK_RET_API_ERROR (-DUK_ERR_API_ERROR) +#define DUK_RET_UNCAUGHT_ERROR (-DUK_ERR_UNCAUGHT_ERROR) +#define DUK_RET_ERROR (-DUK_ERR_ERROR) +#define DUK_RET_EVAL_ERROR (-DUK_ERR_EVAL_ERROR) +#define DUK_RET_RANGE_ERROR (-DUK_ERR_RANGE_ERROR) +#define DUK_RET_REFERENCE_ERROR (-DUK_ERR_REFERENCE_ERROR) +#define DUK_RET_SYNTAX_ERROR (-DUK_ERR_SYNTAX_ERROR) +#define DUK_RET_TYPE_ERROR (-DUK_ERR_TYPE_ERROR) +#define DUK_RET_URI_ERROR (-DUK_ERR_URI_ERROR) + +/* Return codes for protected calls (duk_safe_call(), duk_pcall()). */ +#define DUK_EXEC_SUCCESS 0 +#define DUK_EXEC_ERROR 1 + +/* Log levels */ +#define DUK_LOG_TRACE 0 +#define DUK_LOG_DEBUG 1 +#define DUK_LOG_INFO 2 +#define DUK_LOG_WARN 3 +#define DUK_LOG_ERROR 4 +#define DUK_LOG_FATAL 5 + +/* + * If no variadic macros, __FILE__ and __LINE__ are passed through globals + * which is ugly and not thread safe. + */ + +#ifndef DUK_API_VARIADIC_MACROS +DUK_EXTERNAL_DECL const char *duk_api_global_filename; +DUK_EXTERNAL_DECL duk_int_t duk_api_global_line; +#endif + +/* + * Context management + */ + +DUK_EXTERNAL_DECL +duk_context *duk_create_heap(duk_alloc_function alloc_func, + duk_realloc_function realloc_func, + duk_free_function free_func, + void *heap_udata, + duk_fatal_function fatal_handler); +DUK_EXTERNAL_DECL void duk_destroy_heap(duk_context *ctx); + +#define duk_create_heap_default() \ + duk_create_heap(NULL, NULL, NULL, NULL, NULL) + +/* + * Memory management + * + * Raw functions have no side effects (cannot trigger GC). + */ + +DUK_EXTERNAL_DECL void *duk_alloc_raw(duk_context *ctx, duk_size_t size); +DUK_EXTERNAL_DECL void duk_free_raw(duk_context *ctx, void *ptr); +DUK_EXTERNAL_DECL void *duk_realloc_raw(duk_context *ctx, void *ptr, duk_size_t size); +DUK_EXTERNAL_DECL void *duk_alloc(duk_context *ctx, duk_size_t size); +DUK_EXTERNAL_DECL void duk_free(duk_context *ctx, void *ptr); +DUK_EXTERNAL_DECL void *duk_realloc(duk_context *ctx, void *ptr, duk_size_t size); +DUK_EXTERNAL_DECL void duk_get_memory_functions(duk_context *ctx, duk_memory_functions *out_funcs); +DUK_EXTERNAL_DECL void duk_gc(duk_context *ctx, duk_uint_t flags); + +/* + * Error handling + */ + +DUK_API_NORETURN(DUK_EXTERNAL_DECL void duk_throw(duk_context *ctx)); +DUK_API_NORETURN(DUK_EXTERNAL_DECL void duk_fatal(duk_context *ctx, duk_errcode_t err_code, const char *err_msg)); + +DUK_API_NORETURN(DUK_EXTERNAL_DECL void duk_error_raw(duk_context *ctx, duk_errcode_t err_code, const char *filename, duk_int_t line, const char *fmt, ...)); + +#ifdef DUK_API_VARIADIC_MACROS +#define duk_error(ctx,err_code,...) \ + duk_error_raw((ctx), (duk_errcode_t) (err_code), (const char *) (__FILE__), (duk_int_t) (__LINE__), __VA_ARGS__) +#else +DUK_API_NORETURN(DUK_EXTERNAL_DECL void duk_error_stash(duk_context *ctx, duk_errcode_t err_code, const char *fmt, ...)); +/* One problem with this macro is that expressions like the following fail + * to compile: "(void) duk_error(...)". But because duk_error() is noreturn, + * they make little sense anyway. + */ +#define duk_error \ + (duk_api_global_filename = (const char *) (__FILE__), \ + duk_api_global_line = (duk_int_t) (__LINE__), \ + duk_error_stash) /* last value is func pointer, arguments follow in parens */ +#endif + +DUK_API_NORETURN(DUK_EXTERNAL_DECL void duk_error_va_raw(duk_context *ctx, duk_errcode_t err_code, const char *filename, duk_int_t line, const char *fmt, va_list ap)); +#define duk_error_va(ctx,err_code,fmt,ap) \ + duk_error_va_raw((ctx), (duk_errcode_t) (err_code), (const char *) (__FILE__), (duk_int_t) (__LINE__), (fmt), (ap)) + +/* + * Other state related functions + */ + +DUK_EXTERNAL_DECL duk_bool_t duk_is_strict_call(duk_context *ctx); +DUK_EXTERNAL_DECL duk_bool_t duk_is_constructor_call(duk_context *ctx); + +/* + * Stack management + */ + +DUK_EXTERNAL_DECL duk_idx_t duk_normalize_index(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_idx_t duk_require_normalize_index(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_bool_t duk_is_valid_index(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL void duk_require_valid_index(duk_context *ctx, duk_idx_t index); + +DUK_EXTERNAL_DECL duk_idx_t duk_get_top(duk_context *ctx); +DUK_EXTERNAL_DECL void duk_set_top(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_idx_t duk_get_top_index(duk_context *ctx); +DUK_EXTERNAL_DECL duk_idx_t duk_require_top_index(duk_context *ctx); + +/* Although extra/top could be an unsigned type here, using a signed type + * makes the API more robust to calling code calculation errors or corner + * cases (where caller might occasionally come up with negative values). + * Negative values are treated as zero, which is better than casting them + * to a large unsigned number. (This principle is used elsewhere in the + * API too.) + */ +DUK_EXTERNAL_DECL duk_bool_t duk_check_stack(duk_context *ctx, duk_idx_t extra); +DUK_EXTERNAL_DECL void duk_require_stack(duk_context *ctx, duk_idx_t extra); +DUK_EXTERNAL_DECL duk_bool_t duk_check_stack_top(duk_context *ctx, duk_idx_t top); +DUK_EXTERNAL_DECL void duk_require_stack_top(duk_context *ctx, duk_idx_t top); + +/* + * Stack manipulation (other than push/pop) + */ + +DUK_EXTERNAL_DECL void duk_swap(duk_context *ctx, duk_idx_t index1, duk_idx_t index2); +DUK_EXTERNAL_DECL void duk_swap_top(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL void duk_dup(duk_context *ctx, duk_idx_t from_index); +DUK_EXTERNAL_DECL void duk_dup_top(duk_context *ctx); +DUK_EXTERNAL_DECL void duk_insert(duk_context *ctx, duk_idx_t to_index); +DUK_EXTERNAL_DECL void duk_replace(duk_context *ctx, duk_idx_t to_index); +DUK_EXTERNAL_DECL void duk_copy(duk_context *ctx, duk_idx_t from_index, duk_idx_t to_index); +DUK_EXTERNAL_DECL void duk_remove(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL void duk_xcopymove_raw(duk_context *to_ctx, duk_context *from_ctx, duk_idx_t count, duk_bool_t is_copy); + +#define duk_xmove_top(to_ctx,from_ctx,count) \ + duk_xcopymove_raw((to_ctx), (from_ctx), (count), 0 /*is_copy*/) +#define duk_xcopy_top(to_ctx,from_ctx,count) \ + duk_xcopymove_raw((to_ctx), (from_ctx), (count), 1 /*is_copy*/) + +/* + * Push operations + * + * Push functions return the absolute (relative to bottom of frame) + * position of the pushed value for convenience. + * + * Note: duk_dup() is technically a push. + */ + +DUK_EXTERNAL_DECL void duk_push_undefined(duk_context *ctx); +DUK_EXTERNAL_DECL void duk_push_null(duk_context *ctx); +DUK_EXTERNAL_DECL void duk_push_boolean(duk_context *ctx, duk_bool_t val); +DUK_EXTERNAL_DECL void duk_push_true(duk_context *ctx); +DUK_EXTERNAL_DECL void duk_push_false(duk_context *ctx); +DUK_EXTERNAL_DECL void duk_push_number(duk_context *ctx, duk_double_t val); +DUK_EXTERNAL_DECL void duk_push_nan(duk_context *ctx); +DUK_EXTERNAL_DECL void duk_push_int(duk_context *ctx, duk_int_t val); +DUK_EXTERNAL_DECL void duk_push_uint(duk_context *ctx, duk_uint_t val); +DUK_EXTERNAL_DECL const char *duk_push_string(duk_context *ctx, const char *str); +DUK_EXTERNAL_DECL const char *duk_push_lstring(duk_context *ctx, const char *str, duk_size_t len); +DUK_EXTERNAL_DECL void duk_push_pointer(duk_context *ctx, void *p); +DUK_EXTERNAL_DECL const char *duk_push_sprintf(duk_context *ctx, const char *fmt, ...); +DUK_EXTERNAL_DECL const char *duk_push_vsprintf(duk_context *ctx, const char *fmt, va_list ap); + +DUK_EXTERNAL_DECL const char *duk_push_string_file_raw(duk_context *ctx, const char *path, duk_uint_t flags); +#define duk_push_string_file(ctx,path) \ + duk_push_string_file_raw((ctx), (path), 0) + +DUK_EXTERNAL_DECL void duk_push_this(duk_context *ctx); +DUK_EXTERNAL_DECL void duk_push_current_function(duk_context *ctx); +DUK_EXTERNAL_DECL void duk_push_current_thread(duk_context *ctx); +DUK_EXTERNAL_DECL void duk_push_global_object(duk_context *ctx); +DUK_EXTERNAL_DECL void duk_push_heap_stash(duk_context *ctx); +DUK_EXTERNAL_DECL void duk_push_global_stash(duk_context *ctx); +DUK_EXTERNAL_DECL void duk_push_thread_stash(duk_context *ctx, duk_context *target_ctx); + +DUK_EXTERNAL_DECL duk_idx_t duk_push_object(duk_context *ctx); +DUK_EXTERNAL_DECL duk_idx_t duk_push_array(duk_context *ctx); +DUK_EXTERNAL_DECL duk_idx_t duk_push_c_function(duk_context *ctx, duk_c_function func, duk_idx_t nargs); +DUK_EXTERNAL_DECL duk_idx_t duk_push_c_lightfunc(duk_context *ctx, duk_c_function func, duk_idx_t nargs, duk_idx_t length, duk_int_t magic); +DUK_EXTERNAL_DECL duk_idx_t duk_push_thread_raw(duk_context *ctx, duk_uint_t flags); + +#define duk_push_thread(ctx) \ + duk_push_thread_raw((ctx), 0 /*flags*/) + +#define duk_push_thread_new_globalenv(ctx) \ + duk_push_thread_raw((ctx), DUK_THREAD_NEW_GLOBAL_ENV /*flags*/) + +DUK_EXTERNAL_DECL duk_idx_t duk_push_error_object_raw(duk_context *ctx, duk_errcode_t err_code, const char *filename, duk_int_t line, const char *fmt, ...); + +#ifdef DUK_API_VARIADIC_MACROS +#define duk_push_error_object(ctx,err_code,...) \ + duk_push_error_object_raw((ctx), (err_code), (const char *) (__FILE__), (duk_int_t) (__LINE__), __VA_ARGS__) +#else +DUK_EXTERNAL_DECL duk_idx_t duk_push_error_object_stash(duk_context *ctx, duk_errcode_t err_code, const char *fmt, ...); +/* Note: parentheses are required so that the comma expression works in assignments. */ +#define duk_push_error_object \ + (duk_api_global_filename = (const char *) (__FILE__), \ + duk_api_global_line = (duk_int_t) (__LINE__), \ + duk_push_error_object_stash) /* last value is func pointer, arguments follow in parens */ +#endif + +DUK_EXTERNAL_DECL duk_idx_t duk_push_error_object_va_raw(duk_context *ctx, duk_errcode_t err_code, const char *filename, duk_int_t line, const char *fmt, va_list ap); +#define duk_push_error_object_va(ctx,err_code,fmt,ap) \ + duk_push_error_object_va_raw((ctx), (err_code), (const char *) (__FILE__), (duk_int_t) (__LINE__), (fmt), (ap)) + +#define DUK_BUF_FLAG_DYNAMIC (1 << 0) /* internal flag: dynamic buffer */ +#define DUK_BUF_FLAG_NOZERO (1 << 1) /* internal flag: don't zero allocated buffer */ + +DUK_EXTERNAL_DECL void *duk_push_buffer_raw(duk_context *ctx, duk_size_t size, duk_small_uint_t flags); + +#define duk_push_buffer(ctx,size,dynamic) \ + duk_push_buffer_raw((ctx), (size), (dynamic)); +#define duk_push_fixed_buffer(ctx,size) \ + duk_push_buffer_raw((ctx), (size), 0 /*dynamic*/) +#define duk_push_dynamic_buffer(ctx,size) \ + duk_push_buffer_raw((ctx), (size), 1 /*dynamic*/) + +DUK_EXTERNAL_DECL duk_idx_t duk_push_heapptr(duk_context *ctx, void *ptr); + +/* + * Pop operations + */ + +DUK_EXTERNAL_DECL void duk_pop(duk_context *ctx); +DUK_EXTERNAL_DECL void duk_pop_n(duk_context *ctx, duk_idx_t count); +DUK_EXTERNAL_DECL void duk_pop_2(duk_context *ctx); +DUK_EXTERNAL_DECL void duk_pop_3(duk_context *ctx); + +/* + * Type checks + * + * duk_is_none(), which would indicate whether index it outside of stack, + * is not needed; duk_is_valid_index() gives the same information. + */ + +DUK_EXTERNAL_DECL duk_int_t duk_get_type(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_bool_t duk_check_type(duk_context *ctx, duk_idx_t index, duk_int_t type); +DUK_EXTERNAL_DECL duk_uint_t duk_get_type_mask(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_bool_t duk_check_type_mask(duk_context *ctx, duk_idx_t index, duk_uint_t mask); + +DUK_EXTERNAL_DECL duk_bool_t duk_is_undefined(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_bool_t duk_is_null(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_bool_t duk_is_null_or_undefined(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_bool_t duk_is_boolean(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_bool_t duk_is_number(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_bool_t duk_is_nan(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_bool_t duk_is_string(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_bool_t duk_is_object(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_bool_t duk_is_buffer(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_bool_t duk_is_pointer(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_bool_t duk_is_lightfunc(duk_context *ctx, duk_idx_t index); + +DUK_EXTERNAL_DECL duk_bool_t duk_is_array(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_bool_t duk_is_function(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_bool_t duk_is_c_function(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_bool_t duk_is_ecmascript_function(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_bool_t duk_is_bound_function(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_bool_t duk_is_thread(duk_context *ctx, duk_idx_t index); + +DUK_EXTERNAL_DECL duk_bool_t duk_is_callable(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_bool_t duk_is_dynamic_buffer(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_bool_t duk_is_fixed_buffer(duk_context *ctx, duk_idx_t index); + +DUK_EXTERNAL_DECL duk_bool_t duk_is_primitive(duk_context *ctx, duk_idx_t index); +#define duk_is_object_coercible(ctx,index) \ + duk_check_type_mask((ctx), (index), DUK_TYPE_MASK_BOOLEAN | \ + DUK_TYPE_MASK_NUMBER | \ + DUK_TYPE_MASK_STRING | \ + DUK_TYPE_MASK_OBJECT | \ + DUK_TYPE_MASK_BUFFER | \ + DUK_TYPE_MASK_POINTER | \ + DUK_TYPE_MASK_LIGHTFUNC) + +DUK_EXTERNAL_DECL duk_errcode_t duk_get_error_code(duk_context *ctx, duk_idx_t index); +#define duk_is_error(ctx,index) \ + (duk_get_error_code((ctx), (index)) != 0) + +/* + * Get operations: no coercion, returns default value for invalid + * indices and invalid value types. + * + * duk_get_undefined() and duk_get_null() would be pointless and + * are not included. + */ + +DUK_EXTERNAL_DECL duk_bool_t duk_get_boolean(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_double_t duk_get_number(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_int_t duk_get_int(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_uint_t duk_get_uint(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL const char *duk_get_string(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL const char *duk_get_lstring(duk_context *ctx, duk_idx_t index, duk_size_t *out_len); +DUK_EXTERNAL_DECL void *duk_get_buffer(duk_context *ctx, duk_idx_t index, duk_size_t *out_size); +DUK_EXTERNAL_DECL void *duk_get_pointer(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_c_function duk_get_c_function(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_context *duk_get_context(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL void *duk_get_heapptr(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_size_t duk_get_length(duk_context *ctx, duk_idx_t index); + +/* + * Require operations: no coercion, throw error if index or type + * is incorrect. No defaulting. + */ + +#define duk_require_type_mask(ctx,index,mask) \ + ((void) duk_check_type_mask((ctx), (index), (mask) | DUK_TYPE_MASK_THROW)) + +DUK_EXTERNAL_DECL void duk_require_undefined(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL void duk_require_null(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_bool_t duk_require_boolean(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_double_t duk_require_number(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_int_t duk_require_int(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_uint_t duk_require_uint(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL const char *duk_require_string(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL const char *duk_require_lstring(duk_context *ctx, duk_idx_t index, duk_size_t *out_len); +DUK_EXTERNAL_DECL void *duk_require_buffer(duk_context *ctx, duk_idx_t index, duk_size_t *out_size); +DUK_EXTERNAL_DECL void *duk_require_pointer(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_c_function duk_require_c_function(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_context *duk_require_context(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL void *duk_require_heapptr(duk_context *ctx, duk_idx_t index); + +#define duk_require_object_coercible(ctx,index) \ + ((void) duk_check_type_mask((ctx), (index), DUK_TYPE_MASK_BOOLEAN | \ + DUK_TYPE_MASK_NUMBER | \ + DUK_TYPE_MASK_STRING | \ + DUK_TYPE_MASK_OBJECT | \ + DUK_TYPE_MASK_BUFFER | \ + DUK_TYPE_MASK_POINTER | \ + DUK_TYPE_MASK_LIGHTFUNC | \ + DUK_TYPE_MASK_THROW)) + +/* + * Coercion operations: in-place coercion, return coerced value where + * applicable. If index is invalid, throw error. Some coercions may + * throw an expected error (e.g. from a toString() or valueOf() call) + * or an internal error (e.g. from out of memory). + */ + +DUK_EXTERNAL_DECL void duk_to_undefined(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL void duk_to_null(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_bool_t duk_to_boolean(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_double_t duk_to_number(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_int_t duk_to_int(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_uint_t duk_to_uint(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_int32_t duk_to_int32(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_uint32_t duk_to_uint32(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_uint16_t duk_to_uint16(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL const char *duk_to_string(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL const char *duk_to_lstring(duk_context *ctx, duk_idx_t index, duk_size_t *out_len); +DUK_EXTERNAL_DECL void *duk_to_buffer_raw(duk_context *ctx, duk_idx_t index, duk_size_t *out_size, duk_uint_t flags); +DUK_EXTERNAL_DECL void *duk_to_pointer(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL void duk_to_object(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL void duk_to_defaultvalue(duk_context *ctx, duk_idx_t index, duk_int_t hint); +DUK_EXTERNAL_DECL void duk_to_primitive(duk_context *ctx, duk_idx_t index, duk_int_t hint); + +#define DUK_BUF_MODE_FIXED 0 /* internal: request fixed buffer result */ +#define DUK_BUF_MODE_DYNAMIC 1 /* internal: request dynamic buffer result */ +#define DUK_BUF_MODE_DONTCARE 2 /* internal: don't care about fixed/dynamic nature */ + +#define duk_to_buffer(ctx,index,out_size) \ + duk_to_buffer_raw((ctx), (index), (out_size), DUK_BUF_MODE_DONTCARE) +#define duk_to_fixed_buffer(ctx,index,out_size) \ + duk_to_buffer_raw((ctx), (index), (out_size), DUK_BUF_MODE_FIXED) +#define duk_to_dynamic_buffer(ctx,index,out_size) \ + duk_to_buffer_raw((ctx), (index), (out_size), DUK_BUF_MODE_DYNAMIC) + +/* safe variants of a few coercion operations */ +DUK_EXTERNAL_DECL const char *duk_safe_to_lstring(duk_context *ctx, duk_idx_t index, duk_size_t *out_len); +#define duk_safe_to_string(ctx,index) \ + duk_safe_to_lstring((ctx), (index), NULL) + +/* + * Misc conversion + */ + +DUK_EXTERNAL_DECL const char *duk_base64_encode(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL void duk_base64_decode(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL const char *duk_hex_encode(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL void duk_hex_decode(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL const char *duk_json_encode(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL void duk_json_decode(duk_context *ctx, duk_idx_t index); + +/* + * Buffer + */ + +DUK_EXTERNAL_DECL void *duk_resize_buffer(duk_context *ctx, duk_idx_t index, duk_size_t new_size); + +/* + * Property access + * + * The basic function assumes key is on stack. The _string variant takes + * a C string as a property name, while the _index variant takes an array + * index as a property name (e.g. 123 is equivalent to the key "123"). + */ + +DUK_EXTERNAL_DECL duk_bool_t duk_get_prop(duk_context *ctx, duk_idx_t obj_index); +DUK_EXTERNAL_DECL duk_bool_t duk_get_prop_string(duk_context *ctx, duk_idx_t obj_index, const char *key); +DUK_EXTERNAL_DECL duk_bool_t duk_get_prop_index(duk_context *ctx, duk_idx_t obj_index, duk_uarridx_t arr_index); +DUK_EXTERNAL_DECL duk_bool_t duk_put_prop(duk_context *ctx, duk_idx_t obj_index); +DUK_EXTERNAL_DECL duk_bool_t duk_put_prop_string(duk_context *ctx, duk_idx_t obj_index, const char *key); +DUK_EXTERNAL_DECL duk_bool_t duk_put_prop_index(duk_context *ctx, duk_idx_t obj_index, duk_uarridx_t arr_index); +DUK_EXTERNAL_DECL duk_bool_t duk_del_prop(duk_context *ctx, duk_idx_t obj_index); +DUK_EXTERNAL_DECL duk_bool_t duk_del_prop_string(duk_context *ctx, duk_idx_t obj_index, const char *key); +DUK_EXTERNAL_DECL duk_bool_t duk_del_prop_index(duk_context *ctx, duk_idx_t obj_index, duk_uarridx_t arr_index); +DUK_EXTERNAL_DECL duk_bool_t duk_has_prop(duk_context *ctx, duk_idx_t obj_index); +DUK_EXTERNAL_DECL duk_bool_t duk_has_prop_string(duk_context *ctx, duk_idx_t obj_index, const char *key); +DUK_EXTERNAL_DECL duk_bool_t duk_has_prop_index(duk_context *ctx, duk_idx_t obj_index, duk_uarridx_t arr_index); +DUK_EXTERNAL_DECL void duk_def_prop(duk_context *ctx, duk_idx_t obj_index, duk_uint_t flags); + +DUK_EXTERNAL_DECL duk_bool_t duk_get_global_string(duk_context *ctx, const char *key); +DUK_EXTERNAL_DECL duk_bool_t duk_put_global_string(duk_context *ctx, const char *key); + +/* + * Object prototype + */ + +DUK_EXTERNAL_DECL void duk_get_prototype(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL void duk_set_prototype(duk_context *ctx, duk_idx_t index); + +/* + * Object finalizer + */ + +DUK_EXTERNAL_DECL void duk_get_finalizer(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL void duk_set_finalizer(duk_context *ctx, duk_idx_t index); + +/* + * Global object + */ + +DUK_EXTERNAL_DECL void duk_set_global_object(duk_context *ctx); + +/* + * Duktape/C function magic value + */ + +DUK_EXTERNAL_DECL duk_int_t duk_get_magic(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL void duk_set_magic(duk_context *ctx, duk_idx_t index, duk_int_t magic); +DUK_EXTERNAL_DECL duk_int_t duk_get_current_magic(duk_context *ctx); + +/* + * Module helpers: put multiple function or constant properties + */ + +DUK_EXTERNAL_DECL void duk_put_function_list(duk_context *ctx, duk_idx_t obj_index, const duk_function_list_entry *funcs); +DUK_EXTERNAL_DECL void duk_put_number_list(duk_context *ctx, duk_idx_t obj_index, const duk_number_list_entry *numbers); + +/* + * Variable access + */ + +/* XXX: These calls are incomplete and not usable now. They are not (yet) + * part of the public API. + */ +DUK_EXTERNAL_DECL void duk_get_var(duk_context *ctx); +DUK_EXTERNAL_DECL void duk_put_var(duk_context *ctx); +DUK_EXTERNAL_DECL duk_bool_t duk_del_var(duk_context *ctx); +DUK_EXTERNAL_DECL duk_bool_t duk_has_var(duk_context *ctx); + +/* + * Object operations + */ + +DUK_EXTERNAL_DECL void duk_compact(duk_context *ctx, duk_idx_t obj_index); +DUK_EXTERNAL_DECL void duk_enum(duk_context *ctx, duk_idx_t obj_index, duk_uint_t enum_flags); +DUK_EXTERNAL_DECL duk_bool_t duk_next(duk_context *ctx, duk_idx_t enum_index, duk_bool_t get_value); + +/* + * String manipulation + */ + +DUK_EXTERNAL_DECL void duk_concat(duk_context *ctx, duk_idx_t count); +DUK_EXTERNAL_DECL void duk_join(duk_context *ctx, duk_idx_t count); +DUK_EXTERNAL_DECL void duk_decode_string(duk_context *ctx, duk_idx_t index, duk_decode_char_function callback, void *udata); +DUK_EXTERNAL_DECL void duk_map_string(duk_context *ctx, duk_idx_t index, duk_map_char_function callback, void *udata); +DUK_EXTERNAL_DECL void duk_substring(duk_context *ctx, duk_idx_t index, duk_size_t start_char_offset, duk_size_t end_char_offset); +DUK_EXTERNAL_DECL void duk_trim(duk_context *ctx, duk_idx_t index); +DUK_EXTERNAL_DECL duk_codepoint_t duk_char_code_at(duk_context *ctx, duk_idx_t index, duk_size_t char_offset); + +/* + * Ecmascript operators + */ + +DUK_EXTERNAL_DECL duk_bool_t duk_equals(duk_context *ctx, duk_idx_t index1, duk_idx_t index2); +DUK_EXTERNAL_DECL duk_bool_t duk_strict_equals(duk_context *ctx, duk_idx_t index1, duk_idx_t index2); + +/* + * Function (method) calls + */ + +DUK_EXTERNAL_DECL void duk_call(duk_context *ctx, duk_idx_t nargs); +DUK_EXTERNAL_DECL void duk_call_method(duk_context *ctx, duk_idx_t nargs); +DUK_EXTERNAL_DECL void duk_call_prop(duk_context *ctx, duk_idx_t obj_index, duk_idx_t nargs); +DUK_EXTERNAL_DECL duk_int_t duk_pcall(duk_context *ctx, duk_idx_t nargs); +DUK_EXTERNAL_DECL duk_int_t duk_pcall_method(duk_context *ctx, duk_idx_t nargs); +DUK_EXTERNAL_DECL duk_int_t duk_pcall_prop(duk_context *ctx, duk_idx_t obj_index, duk_idx_t nargs); +DUK_EXTERNAL_DECL void duk_new(duk_context *ctx, duk_idx_t nargs); +DUK_EXTERNAL_DECL duk_int_t duk_safe_call(duk_context *ctx, duk_safe_call_function func, duk_idx_t nargs, duk_idx_t nrets); + +/* + * Thread management + */ + +/* There are currently no native functions to yield/resume, due to the internal + * limitations on coroutine handling. These will be added later. + */ + +/* + * Compilation and evaluation + */ + +DUK_EXTERNAL_DECL duk_int_t duk_eval_raw(duk_context *ctx, const char *src_buffer, duk_size_t src_length, duk_uint_t flags); +DUK_EXTERNAL_DECL duk_int_t duk_compile_raw(duk_context *ctx, const char *src_buffer, duk_size_t src_length, duk_uint_t flags); + +/* plain */ +#define duk_eval(ctx) \ + ((void) duk_push_string((ctx), (const char *) (__FILE__)), \ + (void) duk_eval_raw((ctx), NULL, 0, DUK_COMPILE_EVAL)) + +#define duk_eval_noresult(ctx) \ + ((void) duk_push_string((ctx), (const char *) (__FILE__)), \ + (void) duk_eval_raw((ctx), NULL, 0, DUK_COMPILE_EVAL | DUK_COMPILE_NORESULT)) + +#define duk_peval(ctx) \ + ((void) duk_push_string((ctx), (const char *) (__FILE__)), \ + duk_eval_raw((ctx), NULL, 0, DUK_COMPILE_EVAL | DUK_COMPILE_SAFE)) + +#define duk_peval_noresult(ctx) \ + ((void) duk_push_string((ctx), (const char *) (__FILE__)), \ + duk_eval_raw((ctx), NULL, 0, DUK_COMPILE_EVAL | DUK_COMPILE_SAFE | DUK_COMPILE_NORESULT)) + +#define duk_compile(ctx,flags) \ + ((void) duk_compile_raw((ctx), NULL, 0, (flags))) + +#define duk_pcompile(ctx,flags) \ + (duk_compile_raw((ctx), NULL, 0, (flags) | DUK_COMPILE_SAFE)) + +/* string */ +#define duk_eval_string(ctx,src) \ + ((void) duk_push_string((ctx), (const char *) (__FILE__)), \ + (void) duk_eval_raw((ctx), (src), 0, DUK_COMPILE_EVAL | DUK_COMPILE_NOSOURCE | DUK_COMPILE_STRLEN)) + +#define duk_eval_string_noresult(ctx,src) \ + ((void) duk_push_string((ctx), (const char *) (__FILE__)), \ + (void) duk_eval_raw((ctx), (src), 0, DUK_COMPILE_EVAL | DUK_COMPILE_NOSOURCE | DUK_COMPILE_STRLEN | DUK_COMPILE_NORESULT)) + +#define duk_peval_string(ctx,src) \ + ((void) duk_push_string((ctx), (const char *) (__FILE__)), \ + duk_eval_raw((ctx), (src), 0, DUK_COMPILE_EVAL | DUK_COMPILE_SAFE | DUK_COMPILE_NOSOURCE | DUK_COMPILE_STRLEN)) + +#define duk_peval_string_noresult(ctx,src) \ + ((void) duk_push_string((ctx), (const char *) (__FILE__)), \ + duk_eval_raw((ctx), (src), 0, DUK_COMPILE_EVAL | DUK_COMPILE_SAFE | DUK_COMPILE_NOSOURCE | DUK_COMPILE_STRLEN | DUK_COMPILE_NORESULT)) + +#define duk_compile_string(ctx,flags,src) \ + ((void) duk_push_string((ctx), (const char *) (__FILE__)), \ + (void) duk_compile_raw((ctx), (src), 0, (flags) | DUK_COMPILE_NOSOURCE | DUK_COMPILE_STRLEN)) + +#define duk_compile_string_filename(ctx,flags,src) \ + ((void) duk_compile_raw((ctx), (src), 0, (flags) | DUK_COMPILE_NOSOURCE | DUK_COMPILE_STRLEN)) + +#define duk_pcompile_string(ctx,flags,src) \ + ((void) duk_push_string((ctx), (const char *) (__FILE__)), \ + duk_compile_raw((ctx), (src), 0, (flags) | DUK_COMPILE_SAFE | DUK_COMPILE_NOSOURCE | DUK_COMPILE_STRLEN)) + +#define duk_pcompile_string_filename(ctx,flags,src) \ + (duk_compile_raw((ctx), (src), 0, (flags) | DUK_COMPILE_SAFE | DUK_COMPILE_NOSOURCE | DUK_COMPILE_STRLEN)) + +/* lstring */ +#define duk_eval_lstring(ctx,buf,len) \ + ((void) duk_push_string((ctx), (const char *) (__FILE__)), \ + (void) duk_eval_raw((ctx), buf, len, DUK_COMPILE_EVAL | DUK_COMPILE_NOSOURCE)) + +#define duk_eval_lstring_noresult(ctx,buf,len) \ + ((void) duk_push_string((ctx), (const char *) (__FILE__)), \ + (void) duk_eval_raw((ctx), buf, len, DUK_COMPILE_EVAL | DUK_COMPILE_NOSOURCE | DUK_COMPILE_NORESULT)) + +#define duk_peval_lstring(ctx,buf,len) \ + ((void) duk_push_string((ctx), (const char *) (__FILE__)), \ + duk_eval_raw((ctx), buf, len, DUK_COMPILE_EVAL | DUK_COMPILE_NOSOURCE | DUK_COMPILE_SAFE)) + +#define duk_peval_lstring_noresult(ctx,buf,len) \ + ((void) duk_push_string((ctx), (const char *) (__FILE__)), \ + duk_eval_raw((ctx), buf, len, DUK_COMPILE_EVAL | DUK_COMPILE_SAFE | DUK_COMPILE_NOSOURCE | DUK_COMPILE_NORESULT)) + +#define duk_compile_lstring(ctx,flags,buf,len) \ + ((void) duk_push_string((ctx), (const char *) (__FILE__)), \ + (void) duk_compile_raw((ctx), buf, len, (flags) | DUK_COMPILE_NOSOURCE)) + +#define duk_compile_lstring_filename(ctx,flags,buf,len) \ + ((void) duk_compile_raw((ctx), buf, len, (flags) | DUK_COMPILE_NOSOURCE)) + +#define duk_pcompile_lstring(ctx,flags,buf,len) \ + ((void) duk_push_string((ctx), (const char *) (__FILE__)), \ + duk_compile_raw((ctx), buf, len, (flags) | DUK_COMPILE_SAFE | DUK_COMPILE_NOSOURCE)) + +#define duk_pcompile_lstring_filename(ctx,flags,buf,len) \ + (duk_compile_raw((ctx), buf, len, (flags) | DUK_COMPILE_SAFE | DUK_COMPILE_NOSOURCE)) + +/* file */ +#define duk_eval_file(ctx,path) \ + ((void) duk_push_string_file_raw((ctx), (path), 0), \ + (void) duk_push_string((ctx), (path)), \ + (void) duk_eval_raw((ctx), NULL, 0, DUK_COMPILE_EVAL)) + +#define duk_eval_file_noresult(ctx,path) \ + ((void) duk_push_string_file_raw((ctx), (path), 0), \ + (void) duk_push_string((ctx), (path)), \ + (void) duk_eval_raw((ctx), NULL, 0, DUK_COMPILE_EVAL | DUK_COMPILE_NORESULT)) + +#define duk_peval_file(ctx,path) \ + ((void) duk_push_string_file_raw((ctx), (path), DUK_STRING_PUSH_SAFE), \ + (void) duk_push_string((ctx), (path)), \ + duk_eval_raw((ctx), NULL, 0, DUK_COMPILE_EVAL | DUK_COMPILE_SAFE)) + +#define duk_peval_file_noresult(ctx,path) \ + ((void) duk_push_string_file_raw((ctx), (path), DUK_STRING_PUSH_SAFE), \ + (void) duk_push_string((ctx), (path)), \ + duk_eval_raw((ctx), NULL, 0, DUK_COMPILE_EVAL | DUK_COMPILE_SAFE | DUK_COMPILE_NORESULT)) + +#define duk_compile_file(ctx,flags,path) \ + ((void) duk_push_string_file_raw((ctx), (path), 0), \ + (void) duk_push_string((ctx), (path)), \ + (void) duk_compile_raw((ctx), NULL, 0, (flags))) + +#define duk_pcompile_file(ctx,flags,path) \ + ((void) duk_push_string_file_raw((ctx), (path), DUK_STRING_PUSH_SAFE), \ + (void) duk_push_string((ctx), (path)), \ + duk_compile_raw((ctx), NULL, 0, (flags) | DUK_COMPILE_SAFE)) + +/* + * Logging + */ + +DUK_EXTERNAL_DECL void duk_log(duk_context *ctx, duk_int_t level, const char *fmt, ...); +DUK_EXTERNAL_DECL void duk_log_va(duk_context *ctx, duk_int_t level, const char *fmt, va_list ap); + +/* + * Debugging + */ + +DUK_EXTERNAL_DECL void duk_push_context_dump(duk_context *ctx); + +#if defined(DUK_USE_FILE_IO) +/* internal use */ +#define duk_dump_context_filehandle(ctx,fh) \ + (duk_push_context_dump((ctx)), \ + DUK_FPRINTF((fh), "%s\n", duk_safe_to_string(ctx, -1)), \ + duk_pop(ctx)) + +/* external use */ +#define duk_dump_context_stdout(ctx) \ + duk_dump_context_filehandle((ctx), DUK_STDOUT) +#define duk_dump_context_stderr(ctx) \ + duk_dump_context_filehandle((ctx), DUK_STDERR) +#else /* DUK_USE_FILE_IO */ +#define duk_dump_context_stdout(ctx) ((void) 0) +#define duk_dump_context_stderr(ctx) ((void) 0) +#endif /* DUK_USE_FILE_IO */ + +/* + * Debugger (debug protocol) + */ + +DUK_EXTERNAL_DECL void duk_debugger_attach(duk_context *ctx, + duk_debug_read_function read_cb, + duk_debug_write_function write_cb, + duk_debug_peek_function peek_cb, + duk_debug_read_flush_function read_flush_cb, + duk_debug_write_flush_function write_flush_cb, + duk_debug_detached_function detached_cb, + void *udata); +DUK_EXTERNAL_DECL void duk_debugger_detach(duk_context *ctx); +DUK_EXTERNAL_DECL void duk_debugger_cooperate(duk_context *ctx); + +/* + * C++ name mangling + */ + +#ifdef __cplusplus +/* end 'extern "C"' wrapper */ +} +#endif + +#endif /* DUK_API_PUBLIC_H_INCLUDED */ + +/* + * END PUBLIC API + */ + +/* + * Sanity check for the final effective internal defines. This file also + * double checks user tweaks made by an optional duk_custom.h header. + */ + +#ifndef DUK_FEATURES_SANITY_H_INCLUDED +#define DUK_FEATURES_SANITY_H_INCLUDED + +/* + * Deprecated feature options. + * + * Catch so that user more easily notices and updates build. + */ + +#if defined(DUK_OPT_NO_FUNC_STMT) +#error DUK_OPT_NO_FUNC_STMT is deprecated, use DUK_OPT_NO_NONSTD_FUNC_STMT +#endif + +#if defined(DUK_OPT_FUNC_NONSTD_CALLER_PROPERTY) +#error DUK_OPT_FUNC_NONSTD_CALLER_PROPERTY is deprecated, use DUK_OPT_NONSTD_FUNC_CALLER_PROPERTY +#endif + +#if defined(DUK_OPT_FUNC_NONSTD_SOURCE_PROPERTY) +#error DUK_OPT_FUNC_NONSTD_SOURCE_PROPERTY is deprecated, use DUK_OPT_NONSTD_FUNC_SOURCE_PROPERTY +#endif + +#if defined(DUK_OPT_NO_ARRAY_SPLICE_NONSTD_DELCOUNT) +#error DUK_OPT_NO_ARRAY_SPLICE_NONSTD_DELCOUNT is deprecated, use DUK_OPT_NO_NONSTD_ARRAY_SPLICE_DELCOUNT +#endif + +#if defined(DUK_OPT_NO_OBJECT_ES6_PROTO_PROPERTY) +#error DUK_OPT_NO_OBJECT_ES6_PROTO_PROPERTY is deprecated, use DUK_OPT_NO_ES6_OBJECT_PROTO_PROPERTY +#endif + +#if defined(DUK_OPT_NO_OBJECT_ES6_SETPROTOTYPEOF) +#error DUK_OPT_NO_OBJECT_ES6_SETPROTOTYPEOF is deprecated, use DUK_OPT_NO_ES6_OBJECT_SETPROTOTYPEOF +#endif + +#if defined(DUK_OPT_NO_JSONX) +#error DUK_OPT_NO_JSONX is deprecated, use DUK_OPT_NO_JX +#endif + +#if defined(DUK_OPT_NO_JSONC) +#error DUK_OPT_NO_JSONC is deprecated, use DUK_OPT_NO_JC +#endif + +/* + * Debug print consistency + */ + +#if defined(DUK_USE_DPRINT) && !defined(DUK_USE_DEBUG) +#error DUK_USE_DPRINT without DUK_USE_DEBUG +#endif + +#if defined(DUK_USE_DDPRINT) && !defined(DUK_USE_DEBUG) +#error DUK_USE_DDPRINT without DUK_USE_DEBUG +#endif + +#if defined(DUK_USE_DDDPRINT) && !defined(DUK_USE_DEBUG) +#error DUK_USE_DDDPRINT without DUK_USE_DEBUG +#endif + +#if defined(DUK_USE_HEAPPTR16) && defined(DUK_USE_DEBUG) +/* Debug code doesn't have access to 'heap' so it cannot decode pointers. */ +#error debug printing cannot currently be used with heap pointer compression +#endif + +/* + * Debugger consistency + */ + +#if defined(DUK_USE_DEBUGGER_SUPPORT) +#if !defined(DUK_USE_INTERRUPT_COUNTER) +#error DUK_USE_INTERRUPT_COUNTER is needed when debugger support is enabled +#endif +#if !defined(DUK_USE_PC2LINE) +#error DUK_USE_PC2LINE is needed when debugger support is enabled +#endif +#endif + +/* + * Garbage collection consistency + */ + +#if defined(DUK_USE_REFERENCE_COUNTING) && !defined(DUK_USE_DOUBLE_LINKED_HEAP) +#error DUK_USE_REFERENCE_COUNTING defined without DUK_USE_DOUBLE_LINKED_HEAP +#endif + +#if defined(DUK_USE_GC_TORTURE) && !defined(DUK_USE_MARK_AND_SWEEP) +#error DUK_USE_GC_TORTURE defined without DUK_USE_MARK_AND_SWEEP +#endif + +/* + * Low memory feature consistency + */ + +#if defined(DUK_USE_OBJSIZES16) +#if defined(DUK_USE_HOBJECT_HASH_PART) +#error DUK_USE_OBJSIZES16 assumes DUK_USE_HOBJECT_HASH_PART is not defined +#endif +#endif + +#if defined(DUK_USE_STRTAB_CHAIN) && defined(DUK_USE_STRTAB_PROBE) +#error both DUK_USE_STRTAB_CHAIN and DUK_USE_STRTAB_PROBE defined +#endif +#if !defined(DUK_USE_STRTAB_CHAIN) && !defined(DUK_USE_STRTAB_PROBE) +#error neither DUK_USE_STRTAB_CHAIN nor DUK_USE_STRTAB_PROBE is defined +#endif + +#endif /* DUK_FEATURES_SANITY_H_INCLUDED */ + +/* + * Union to access IEEE double memory representation, indexes for double + * memory representation, and some macros for double manipulation. + * + * Also used by packed duk_tval. Use a union for bit manipulation to + * minimize aliasing issues in practice. The C99 standard does not + * guarantee that this should work, but it's a very widely supported + * practice for low level manipulation. + * + * IEEE double format summary: + * + * seeeeeee eeeeffff ffffffff ffffffff ffffffff ffffffff ffffffff ffffffff + * A B C D E F G H + * + * s sign bit + * eee... exponent field + * fff... fraction + * + * See http://en.wikipedia.org/wiki/Double_precision_floating-point_format. + * + * NaNs are represented as exponent 0x7ff and mantissa != 0. The NaN is a + * signaling NaN when the highest bit of the mantissa is zero, and a quiet + * NaN when the highest bit is set. + * + * At least three memory layouts are relevant here: + * + * A B C D E F G H Big endian (e.g. 68k) DUK_USE_DOUBLE_BE + * H G F E D C B A Little endian (e.g. x86) DUK_USE_DOUBLE_LE + * D C B A H G F E Mixed/cross endian (e.g. ARM) DUK_USE_DOUBLE_ME + * + * ARM is a special case: ARM double values are in mixed/cross endian + * format while ARM duk_uint64_t values are in standard little endian + * format (H G F E D C B A). When a double is read as a duk_uint64_t + * from memory, the register will contain the (logical) value + * E F G H A B C D. This requires some special handling below. + * + * Indexes of various types (8-bit, 16-bit, 32-bit) in memory relative to + * the logical (big endian) order: + * + * byte order duk_uint8_t duk_uint16_t duk_uint32_t + * BE 01234567 0123 01 + * LE 76543210 3210 10 + * ME (ARM) 32107654 1032 01 + * + * Some processors may alter NaN values in a floating point load+store. + * For instance, on X86 a FLD + FSTP may convert a signaling NaN to a + * quiet one. This is catastrophic when NaN space is used in packed + * duk_tval values. See: misc/clang_aliasing.c. + */ + +#ifndef DUK_DBLUNION_H_INCLUDED +#define DUK_DBLUNION_H_INCLUDED + +/* + * Union for accessing double parts, also serves as packed duk_tval + */ + +union duk_double_union { + double d; +#ifdef DUK_USE_64BIT_OPS + duk_uint64_t ull[1]; +#endif + duk_uint32_t ui[2]; + duk_uint16_t us[4]; + duk_uint8_t uc[8]; +#ifdef DUK_USE_PACKED_TVAL_POSSIBLE + void *vp[2]; /* used by packed duk_tval, assumes sizeof(void *) == 4 */ +#endif +}; + +typedef union duk_double_union duk_double_union; + +/* + * Indexes of various types with respect to big endian (logical) layout + */ + +#if defined(DUK_USE_DOUBLE_LE) +#ifdef DUK_USE_64BIT_OPS +#define DUK_DBL_IDX_ULL0 0 +#endif +#define DUK_DBL_IDX_UI0 1 +#define DUK_DBL_IDX_UI1 0 +#define DUK_DBL_IDX_US0 3 +#define DUK_DBL_IDX_US1 2 +#define DUK_DBL_IDX_US2 1 +#define DUK_DBL_IDX_US3 0 +#define DUK_DBL_IDX_UC0 7 +#define DUK_DBL_IDX_UC1 6 +#define DUK_DBL_IDX_UC2 5 +#define DUK_DBL_IDX_UC3 4 +#define DUK_DBL_IDX_UC4 3 +#define DUK_DBL_IDX_UC5 2 +#define DUK_DBL_IDX_UC6 1 +#define DUK_DBL_IDX_UC7 0 +#define DUK_DBL_IDX_VP0 DUK_DBL_IDX_UI0 /* packed tval */ +#define DUK_DBL_IDX_VP1 DUK_DBL_IDX_UI1 /* packed tval */ +#elif defined(DUK_USE_DOUBLE_BE) +#ifdef DUK_USE_64BIT_OPS +#define DUK_DBL_IDX_ULL0 0 +#endif +#define DUK_DBL_IDX_UI0 0 +#define DUK_DBL_IDX_UI1 1 +#define DUK_DBL_IDX_US0 0 +#define DUK_DBL_IDX_US1 1 +#define DUK_DBL_IDX_US2 2 +#define DUK_DBL_IDX_US3 3 +#define DUK_DBL_IDX_UC0 0 +#define DUK_DBL_IDX_UC1 1 +#define DUK_DBL_IDX_UC2 2 +#define DUK_DBL_IDX_UC3 3 +#define DUK_DBL_IDX_UC4 4 +#define DUK_DBL_IDX_UC5 5 +#define DUK_DBL_IDX_UC6 6 +#define DUK_DBL_IDX_UC7 7 +#define DUK_DBL_IDX_VP0 DUK_DBL_IDX_UI0 /* packed tval */ +#define DUK_DBL_IDX_VP1 DUK_DBL_IDX_UI1 /* packed tval */ +#elif defined(DUK_USE_DOUBLE_ME) +#ifdef DUK_USE_64BIT_OPS +#define DUK_DBL_IDX_ULL0 0 /* not directly applicable, byte order differs from a double */ +#endif +#define DUK_DBL_IDX_UI0 0 +#define DUK_DBL_IDX_UI1 1 +#define DUK_DBL_IDX_US0 1 +#define DUK_DBL_IDX_US1 0 +#define DUK_DBL_IDX_US2 3 +#define DUK_DBL_IDX_US3 2 +#define DUK_DBL_IDX_UC0 3 +#define DUK_DBL_IDX_UC1 2 +#define DUK_DBL_IDX_UC2 1 +#define DUK_DBL_IDX_UC3 0 +#define DUK_DBL_IDX_UC4 7 +#define DUK_DBL_IDX_UC5 6 +#define DUK_DBL_IDX_UC6 5 +#define DUK_DBL_IDX_UC7 4 +#define DUK_DBL_IDX_VP0 DUK_DBL_IDX_UI0 /* packed tval */ +#define DUK_DBL_IDX_VP1 DUK_DBL_IDX_UI1 /* packed tval */ +#else +#error internal error +#endif + +/* + * Helper macros for reading/writing memory representation parts, used + * by duk_numconv.c and duk_tval.h. + */ + +#define DUK_DBLUNION_SET_DOUBLE(u,v) do { \ + (u)->d = (v); \ + } while (0) + +#define DUK_DBLUNION_SET_HIGH32(u,v) do { \ + (u)->ui[DUK_DBL_IDX_UI0] = (duk_uint32_t) (v); \ + } while (0) + +#ifdef DUK_USE_64BIT_OPS +#ifdef DUK_USE_DOUBLE_ME +#define DUK_DBLUNION_SET_HIGH32_ZERO_LOW32(u,v) do { \ + (u)->ull[DUK_DBL_IDX_ULL0] = (duk_uint64_t) (v); \ + } while (0) +#else +#define DUK_DBLUNION_SET_HIGH32_ZERO_LOW32(u,v) do { \ + (u)->ull[DUK_DBL_IDX_ULL0] = ((duk_uint64_t) (v)) << 32; \ + } while (0) +#endif +#else /* DUK_USE_64BIT_OPS */ +#define DUK_DBLUNION_SET_HIGH32_ZERO_LOW32(u,v) do { \ + (u)->ui[DUK_DBL_IDX_UI0] = (duk_uint32_t) (v); \ + (u)->ui[DUK_DBL_IDX_UI1] = (duk_uint32_t) 0; \ + } while (0) +#endif /* DUK_USE_64BIT_OPS */ + +#define DUK_DBLUNION_SET_LOW32(u,v) do { \ + (u)->ui[DUK_DBL_IDX_UI1] = (duk_uint32_t) (v); \ + } while (0) + +#define DUK_DBLUNION_GET_DOUBLE(u) ((u)->d) +#define DUK_DBLUNION_GET_HIGH32(u) ((u)->ui[DUK_DBL_IDX_UI0]) +#define DUK_DBLUNION_GET_LOW32(u) ((u)->ui[DUK_DBL_IDX_UI1]) + +#ifdef DUK_USE_64BIT_OPS +#ifdef DUK_USE_DOUBLE_ME +#define DUK_DBLUNION_SET_UINT64(u,v) do { \ + (u)->ui[DUK_DBL_IDX_UI0] = (duk_uint32_t) ((v) >> 32); \ + (u)->ui[DUK_DBL_IDX_UI1] = (duk_uint32_t) (v); \ + } while (0) +#define DUK_DBLUNION_GET_UINT64(u) \ + ((((duk_uint64_t) (u)->ui[DUK_DBL_IDX_UI0]) << 32) | \ + ((duk_uint64_t) (u)->ui[DUK_DBL_IDX_UI1])) +#else +#define DUK_DBLUNION_SET_UINT64(u,v) do { \ + (u)->ull[DUK_DBL_IDX_ULL0] = (duk_uint64_t) (v); \ + } while (0) +#define DUK_DBLUNION_GET_UINT64(u) ((u)->ull[DUK_DBL_IDX_ULL0]) +#endif +#define DUK_DBLUNION_SET_INT64(u,v) DUK_DBLUNION_SET_UINT64((u), (duk_uint64_t) (v)) +#define DUK_DBLUNION_GET_INT64(u) ((duk_int64_t) DUK_DBLUNION_GET_UINT64((u))) +#endif /* DUK_USE_64BIT_OPS */ + +/* + * Double NaN manipulation macros related to NaN normalization needed when + * using the packed duk_tval representation. NaN normalization is necessary + * to keep double values compatible with the duk_tval format. + * + * When packed duk_tval is used, the NaN space is used to store pointers + * and other tagged values in addition to NaNs. Actual NaNs are normalized + * to a specific format. The macros below are used by the implementation + * to check and normalize NaN values when they might be created. The macros + * are essentially NOPs when the non-packed duk_tval representation is used. + * + * A FULL check is exact and checks all bits. A NOTFULL check is used by + * the packed duk_tval and works correctly for all NaNs except those that + * begin with 0x7ff0. Since the 'normalized NaN' values used with packed + * duk_tval begin with 0x7ff8, the partial check is reliable when packed + * duk_tval is used. + * + * The ME variant below is specifically for ARM byte order, which has the + * feature that while doubles have a mixed byte order (32107654), unsigned + * long long values has a little endian byte order (76543210). When writing + * a logical double value through a ULL pointer, the 32-bit words need to be + * swapped; hence the #ifdefs below for ULL writes with DUK_USE_DOUBLE_ME. + * This is not full ARM support but suffices for some environments. + */ + +#ifdef DUK_USE_64BIT_OPS +#ifdef DUK_USE_DOUBLE_ME +#define DUK__DBLUNION_SET_NAN_FULL(u) do { \ + (u)->ull[DUK_DBL_IDX_ULL0] = 0x000000007ff80000ULL; \ + } while (0) +#else +#define DUK__DBLUNION_SET_NAN_FULL(u) do { \ + (u)->ull[DUK_DBL_IDX_ULL0] = 0x7ff8000000000000ULL; \ + } while (0) +#endif +#else /* DUK_USE_64BIT_OPS */ +#define DUK__DBLUNION_SET_NAN_FULL(u) do { \ + (u)->ui[DUK_DBL_IDX_UI0] = (duk_uint32_t) 0x7ff80000UL; \ + (u)->ui[DUK_DBL_IDX_UI1] = (duk_uint32_t) 0x00000000UL; \ + } while (0) +#endif /* DUK_USE_64BIT_OPS */ + +#define DUK__DBLUNION_SET_NAN_NOTFULL(u) do { \ + (u)->us[DUK_DBL_IDX_US0] = 0x7ff8UL; \ + } while (0) + +#ifdef DUK_USE_64BIT_OPS +#ifdef DUK_USE_DOUBLE_ME +#define DUK__DBLUNION_IS_NAN_FULL(u) \ + /* E == 0x7ff, F != 0 => NaN */ \ + ((((u)->us[DUK_DBL_IDX_US0] & 0x7ff0UL) == 0x7ff0UL) && \ + ((((u)->ull[DUK_DBL_IDX_ULL0]) & 0xffffffff000fffffULL) != 0)) +#else +#define DUK__DBLUNION_IS_NAN_FULL(u) \ + /* E == 0x7ff, F != 0 => NaN */ \ + ((((u)->us[DUK_DBL_IDX_US0] & 0x7ff0UL) == 0x7ff0UL) && \ + ((((u)->ull[DUK_DBL_IDX_ULL0]) & 0x000fffffffffffffULL) != 0)) +#endif +#else /* DUK_USE_64BIT_OPS */ +#define DUK__DBLUNION_IS_NAN_FULL(u) \ + /* E == 0x7ff, F != 0 => NaN */ \ + ((((u)->ui[DUK_DBL_IDX_UI0] & 0x7ff00000UL) == 0x7ff00000UL) && \ + (((u)->ui[DUK_DBL_IDX_UI0] & 0x000fffffUL) != 0 || \ + (u)->ui[DUK_DBL_IDX_UI1] != 0)) +#endif /* DUK_USE_64BIT_OPS */ + +#define DUK__DBLUNION_IS_NAN_NOTFULL(u) \ + /* E == 0x7ff, topmost four bits of F != 0 => assume NaN */ \ + ((((u)->us[DUK_DBL_IDX_US0] & 0x7ff0UL) == 0x7ff0UL) && \ + (((u)->us[DUK_DBL_IDX_US0] & 0x000fUL) != 0x0000UL)) + +#ifdef DUK_USE_64BIT_OPS +#ifdef DUK_USE_DOUBLE_ME +#define DUK__DBLUNION_IS_NORMALIZED_NAN_FULL(u) \ + ((u)->ull[DUK_DBL_IDX_ULL0] == 0x000000007ff80000ULL) +#else +#define DUK__DBLUNION_IS_NORMALIZED_NAN_FULL(u) \ + ((u)->ull[DUK_DBL_IDX_ULL0] == 0x7ff8000000000000ULL) +#endif +#else /* DUK_USE_64BIT_OPS */ +#define DUK__DBLUNION_IS_NORMALIZED_NAN_FULL(u) \ + (((u)->ui[DUK_DBL_IDX_UI0] == 0x7ff80000UL) && \ + ((u)->ui[DUK_DBL_IDX_UI1] == 0x00000000UL)) +#endif /* DUK_USE_64BIT_OPS */ + +#define DUK__DBLUNION_IS_NORMALIZED_NAN_NOTFULL(u) \ + /* E == 0x7ff, F == 8 => normalized NaN */ \ + ((u)->us[DUK_DBL_IDX_US0] == 0x7ff8UL) + +#define DUK__DBLUNION_NORMALIZE_NAN_CHECK_FULL(u) do { \ + if (DUK__DBLUNION_IS_NAN_FULL((u))) { \ + DUK__DBLUNION_SET_NAN_FULL((u)); \ + } \ + } while (0) + +#define DUK__DBLUNION_NORMALIZE_NAN_CHECK_NOTFULL(u) do { \ + if (DUK__DBLUNION_IS_NAN_NOTFULL((u))) { \ + DUK__DBLUNION_SET_NAN_NOTFULL((u)); \ + } \ + } while (0) + +/* Concrete macros for NaN handling used by the implementation internals. + * Chosen so that they match the duk_tval representation: with a packed + * duk_tval, ensure NaNs are properly normalized; with a non-packed duk_tval + * these are essentially NOPs. + */ + +#if defined(DUK_USE_PACKED_TVAL) +#if defined(DUK_USE_FULL_TVAL) +#define DUK_DBLUNION_NORMALIZE_NAN_CHECK(u) DUK__DBLUNION_NORMALIZE_NAN_CHECK_FULL((u)) +#define DUK_DBLUNION_IS_NAN(u) DUK__DBLUNION_IS_NAN_FULL((u)) +#define DUK_DBLUNION_IS_NORMALIZED_NAN(u) DUK__DBLUNION_IS_NORMALIZED_NAN_FULL((u)) +#define DUK_DBLUNION_SET_NAN(d) DUK__DBLUNION_SET_NAN_FULL((d)) +#else +#define DUK_DBLUNION_NORMALIZE_NAN_CHECK(u) DUK__DBLUNION_NORMALIZE_NAN_CHECK_NOTFULL((u)) +#define DUK_DBLUNION_IS_NAN(u) DUK__DBLUNION_IS_NAN_NOTFULL((u)) +#define DUK_DBLUNION_IS_NORMALIZED_NAN(u) DUK__DBLUNION_IS_NORMALIZED_NAN_NOTFULL((u)) +#define DUK_DBLUNION_SET_NAN(d) DUK__DBLUNION_SET_NAN_NOTFULL((d)) +#endif +#define DUK_DBLUNION_IS_NORMALIZED(u) \ + (!DUK_DBLUNION_IS_NAN((u)) || /* either not a NaN */ \ + DUK_DBLUNION_IS_NORMALIZED_NAN((u))) /* or is a normalized NaN */ +#else /* DUK_USE_PACKED_TVAL */ +#define DUK_DBLUNION_NORMALIZE_NAN_CHECK(u) /* nop: no need to normalize */ +#define DUK_DBLUNION_IS_NAN(u) (DUK_ISNAN((u)->d)) +#define DUK_DBLUNION_IS_NORMALIZED_NAN(u) (DUK_ISNAN((u)->d)) +#define DUK_DBLUNION_IS_NORMALIZED(u) 1 /* all doubles are considered normalized */ +#define DUK_DBLUNION_SET_NAN(u) do { \ + /* in non-packed representation we don't care about which NaN is used */ \ + (u)->d = DUK_DOUBLE_NAN; \ + } while (0) +#endif /* DUK_USE_PACKED_TVAL */ + +/* Byteswap an (aligned) duk_double_union. */ +#if defined(DUK_USE_DOUBLE_LE) +#define DUK_DBLUNION_BSWAP(u) do { \ + duk_uint32_t duk__bswaptmp1, duk__bswaptmp2; \ + duk__bswaptmp1 = (u)->ui[0]; \ + duk__bswaptmp2 = (u)->ui[1]; \ + duk__bswaptmp1 = DUK_BSWAP32(duk__bswaptmp1); \ + duk__bswaptmp2 = DUK_BSWAP32(duk__bswaptmp2); \ + (u)->ui[0] = duk__bswaptmp2; \ + (u)->ui[1] = duk__bswaptmp1; \ + } while (0) +#elif defined(DUK_USE_DOUBLE_ME) +#define DUK_DBLUNION_BSWAP(u) do { \ + duk_uint32_t duk__bswaptmp1, duk__bswaptmp2; \ + duk__bswaptmp1 = (u)->ui[0]; \ + duk__bswaptmp2 = (u)->ui[1]; \ + duk__bswaptmp1 = DUK_BSWAP32(duk__bswaptmp1); \ + duk__bswaptmp2 = DUK_BSWAP32(duk__bswaptmp2); \ + (u)->ui[0] = duk__bswaptmp1; \ + (u)->ui[1] = duk__bswaptmp2; \ + } while (0) +#elif defined(DUK_USE_DOUBLE_BE) +#define DUK_DBLUNION_BSWAP(u) do { } while (0) +#else +#error internal error, double endianness insane +#endif + +#endif /* DUK_DBLUNION_H_INCLUDED */ + +#endif /* DUKTAPE_H_INCLUDED */ diff --git a/hs-duktape.cabal b/hs-duktape.cabal new file mode 100644 --- /dev/null +++ b/hs-duktape.cabal @@ -0,0 +1,61 @@ +name: hs-duktape +version: 0.1.0 +synopsis: Haskell bindings for a very compact embedded ECMAScript (JavaScript) engine. +category: Web +homepage: https://github.com/myfreeweb/hs-duktape +author: Greg V +copyright: 2015 Greg V , 2013-2015 Duktape authors +maintainer: greg@unrelenting.technology +license: MIT +license-file: LICENSE +build-type: Simple +cabal-version: >= 1.10 +extra-source-files: + README.md + duktape/src/duktape.c + duktape/src/duktape.h +tested-with: + GHC == 7.10.2 + +source-repository head + type: git + location: git://github.com/myfreeweb/hs-duktape.git + +library + build-depends: + base >= 4.3.0.0 && < 5 + , transformers + , text + , bytestring + , aeson + default-language: Haskell2010 + exposed-modules: + Scripting.Duktape + Scripting.Duktape.Raw + ghc-options: -Wall + hs-source-dirs: library + include-dirs: duktape/src + c-sources: duktape/src/duktape.c + includes: duktape.h + install-includes: duktape.h + cc-options: -Wall -O2 -pedantic -std=c99 -fstrict-aliasing -fomit-frame-pointer + +test-suite tests + build-depends: + base >= 4.3.0.0 && < 5 + , text + , bytestring + , hspec + , hspec-expectations-pretty-diff + , aeson + , aeson-qq + , template-haskell + , hs-duktape + default-language: Haskell2010 + ghc-options: -threaded -Wall -fhpc + hs-source-dirs: test-suite + main-is: Spec.hs + other-modules: + TestCommon + Scripting.DuktapeSpec + type: exitcode-stdio-1.0 diff --git a/library/Scripting/Duktape.hs b/library/Scripting/Duktape.hs new file mode 100644 --- /dev/null +++ b/library/Scripting/Duktape.hs @@ -0,0 +1,90 @@ +{-# OPTIONS_GHC -fno-warn-type-defaults #-} +{-# LANGUAGE OverloadedStrings, UnicodeSyntax, CPP #-} + +module Scripting.Duktape ( + DuktapeCtx +, createDuktapeCtx +, evalDuktape +) where + +import Foreign.Ptr +import Foreign.ForeignPtr +import Foreign.Storable +import Foreign.C.String +import Foreign.C.Types +import Foreign.Marshal.Alloc +import Control.Monad.IO.Class +import Data.Text.Encoding (decodeUtf8) +import qualified Data.ByteString as BS +import qualified Data.ByteString.Lazy as BL +import Data.Aeson +import Scripting.Duktape.Raw + +#define DUK_TYPE_NONE 0 +#define DUK_TYPE_UNDEFINED 1 +#define DUK_TYPE_NULL 2 +#define DUK_TYPE_BOOLEAN 3 +#define DUK_TYPE_NUMBER 4 +#define DUK_TYPE_STRING 5 +#define DUK_TYPE_OBJECT 6 +#define DUK_TYPE_BUFFER 7 +#define DUK_TYPE_POINTER 8 +#define DUK_TYPE_LIGHTFUNC 9 + +cMinusOne ∷ CInt +cMinusOne = fromIntegral $ -1 + +data DukType = DukNone | DukUndefined | DukNull | DukBoolean | DukNumber | DukString | DukObject | DukBuffer | DukPointer | DukLightFunc + +getTypeOnStack ∷ DuktapeCtx → Int → IO DukType +getTypeOnStack ctx idx = withForeignPtr ctx $ \ctxPtr → do + t ← c_duk_get_type ctxPtr $ fromIntegral idx + return $ case t of + DUK_TYPE_NONE → DukNone + DUK_TYPE_UNDEFINED → DukUndefined + DUK_TYPE_NULL → DukNull + DUK_TYPE_BOOLEAN → DukBoolean + DUK_TYPE_NUMBER → DukNumber + DUK_TYPE_STRING → DukString + DUK_TYPE_OBJECT → DukObject + DUK_TYPE_BUFFER → DukBuffer + DUK_TYPE_POINTER → DukPointer + DUK_TYPE_LIGHTFUNC → DukLightFunc + _ → DukNone + +getStringFromStack ∷ DuktapeCtx → Int → IO BS.ByteString +getStringFromStack ctx idx = withForeignPtr ctx $ \ctxPtr → do + let cIdx = fromIntegral idx + lenPtr ← malloc ∷ IO (Ptr CSize) + str ← c_duk_get_lstring ctxPtr cIdx lenPtr + len ← peek lenPtr + retVal ← BS.packCStringLen (str, fromIntegral len) + free lenPtr + return retVal + +getValueFromStack ∷ DuktapeCtx → Int → IO (Maybe Value) +getValueFromStack ctx idx = withForeignPtr ctx $ \ctxPtr → do + retType ← getTypeOnStack ctx idx + let cIdx = fromIntegral idx + ret = return . Just + case retType of + DukNull → ret Null + DukBoolean → c_duk_get_boolean ctxPtr cIdx >>= ret . Bool . (== 1) . fromIntegral + DukNumber → c_duk_get_number ctxPtr cIdx >>= ret . Number . realToFrac + DukString → getStringFromStack ctx idx >>= ret . String . decodeUtf8 + DukObject → c_duk_json_encode ctxPtr cIdx >> getStringFromStack ctx idx >>= return . decode . BL.fromStrict + _ → return Nothing + +createDuktapeCtx ∷ MonadIO μ ⇒ μ (Maybe DuktapeCtx) +createDuktapeCtx = liftIO $ createHeapF nullFunPtr + +evalDuktape ∷ MonadIO μ ⇒ DuktapeCtx → BS.ByteString → μ (Either String (Maybe Value)) +evalDuktape ctx src = + liftIO $ withForeignPtr ctx $ \ctxPtr → + BS.useAsCStringLen src $ \(srcCstr, srcLen) → do + evalCode ← c_duk_peval_lstring ctxPtr srcCstr $ fromIntegral srcLen + retVal ← if evalCode /= fromIntegral 0 + then c_duk_safe_to_string ctxPtr cMinusOne >>= peekCString >>= return . Left + else getValueFromStack ctx (-1) >>= return . Right + c_duk_pop ctxPtr + return retVal diff --git a/library/Scripting/Duktape/Raw.hs b/library/Scripting/Duktape/Raw.hs new file mode 100644 --- /dev/null +++ b/library/Scripting/Duktape/Raw.hs @@ -0,0 +1,105 @@ +{-# LANGUAGE OverloadedStrings, UnicodeSyntax, CPP #-} +{-# LANGUAGE ForeignFunctionInterface, EmptyDataDecls #-} + +module Scripting.Duktape.Raw where + +import Foreign.C.Types +import Foreign.C.String +import Foreign.Ptr +import Foreign.ForeignPtr +import Data.Bits + +data DuktapeHeap + +type DuktapeCtx = ForeignPtr DuktapeHeap + +type DukAllocFunction = Ptr () → CSize → IO (Ptr ()) +type DukReallocFunction = Ptr () → Ptr () → CSize → IO (Ptr ()) +type DukFreeFunction = Ptr () → Ptr () → IO () +type DukFatalFunction = Ptr DuktapeHeap → CInt → CString → IO () + +-- Heap lifecycle + +foreign import ccall safe "duktape.h duk_create_heap" + c_duk_create_heap ∷ FunPtr DukAllocFunction → FunPtr DukReallocFunction → FunPtr DukFreeFunction → Ptr () → FunPtr DukFatalFunction → IO (Ptr DuktapeHeap) + +foreign import ccall safe "duktape.h &duk_destroy_heap" + c_duk_destroy_heap ∷ FunPtr(Ptr DuktapeHeap → IO ()) + +-- Evaluation + +#define DUK_COMPILE_EVAL (1 `shiftL` 0) +#define DUK_COMPILE_FUNCTION (1 `shiftL` 1) +#define DUK_COMPILE_STRICT (1 `shiftL` 2) +#define DUK_COMPILE_SAFE (1 `shiftL` 3) +#define DUK_COMPILE_NORESULT (1 `shiftL` 4) +#define DUK_COMPILE_NOSOURCE (1 `shiftL` 5) +#define DUK_COMPILE_STRLEN (1 `shiftL` 6) + +foreign import ccall safe "duktape.h duk_eval_raw" + c_duk_eval_raw ∷ Ptr DuktapeHeap → CString → CSize → CUInt → IO CInt + +c_duk_peval_lstring ∷ Ptr DuktapeHeap → CString → CSize → IO CInt +c_duk_peval_lstring ptr src srclen = do + withCString "hs-duktape" $ \fileStr → + c_duk_push_string ptr fileStr + c_duk_eval_raw ptr src srclen $ DUK_COMPILE_EVAL .|. DUK_COMPILE_NOSOURCE .|. DUK_COMPILE_SAFE + +-- Managing the stack + +foreign import ccall safe "duktape.h duk_pop" + c_duk_pop ∷ Ptr DuktapeHeap → IO () + +-- Pushing to the stack + +foreign import ccall safe "duktape.h duk_push_string" + c_duk_push_string ∷ Ptr DuktapeHeap → CString → IO () + +-- Fetching from the stack + +foreign import ccall safe "duktape.h duk_safe_to_lstring" + c_duk_safe_to_lstring ∷ Ptr DuktapeHeap → CInt → Ptr CSize → IO CString + +c_duk_safe_to_string ∷ Ptr DuktapeHeap → CInt → IO CString +c_duk_safe_to_string ctx idx = c_duk_safe_to_lstring ctx idx nullPtr + +foreign import ccall safe "duktape.h duk_get_string" + c_duk_get_string ∷ Ptr DuktapeHeap → CInt → IO CString + +foreign import ccall safe "duktape.h duk_get_lstring" + c_duk_get_lstring ∷ Ptr DuktapeHeap → CInt → Ptr CSize → IO CString + +foreign import ccall safe "duktape.h duk_get_int" + c_duk_get_int ∷ Ptr DuktapeHeap → CInt → IO CInt + +foreign import ccall safe "duktape.h duk_get_uint" + c_duk_get_uint ∷ Ptr DuktapeHeap → CInt → IO CUInt + +foreign import ccall safe "duktape.h duk_get_number" + c_duk_get_number ∷ Ptr DuktapeHeap → CInt → IO CDouble + +foreign import ccall safe "duktape.h duk_get_boolean" + c_duk_get_boolean ∷ Ptr DuktapeHeap → CInt → IO CInt + +foreign import ccall safe "duktape.h duk_get_type" + c_duk_get_type ∷ Ptr DuktapeHeap → CInt → IO CInt + +-- Encoding/decoding + +foreign import ccall safe "duktape.h duk_json_encode" + c_duk_json_encode ∷ Ptr DuktapeHeap → CInt → IO CString + +foreign import ccall safe "duktape.h duk_json_decode" + c_duk_json_decode ∷ Ptr DuktapeHeap → CInt → IO () + +------------------------------------------------------------------------------------------------------- + +createHeap ∷ FunPtr DukAllocFunction → FunPtr DukReallocFunction → FunPtr DukFreeFunction → Ptr () → FunPtr DukFatalFunction → IO (Maybe DuktapeCtx) +createHeap allocf reallocf freef udata fatalf = do + ptr ← c_duk_create_heap allocf reallocf freef udata fatalf + if ptr /= nullPtr + then newForeignPtr c_duk_destroy_heap ptr >>= return . Just + else return Nothing + +createHeapF ∷ FunPtr DukFatalFunction → IO (Maybe DuktapeCtx) +createHeapF = createHeap nullFunPtr nullFunPtr nullFunPtr nullPtr diff --git a/test-suite/Scripting/DuktapeSpec.hs b/test-suite/Scripting/DuktapeSpec.hs new file mode 100644 --- /dev/null +++ b/test-suite/Scripting/DuktapeSpec.hs @@ -0,0 +1,32 @@ +{-# LANGUAGE QuasiQuotes, OverloadedStrings, UnicodeSyntax #-} + +module Scripting.DuktapeSpec (spec) where + +import Test.Hspec hiding (shouldBe) +import Test.Hspec.Expectations.Pretty (shouldBe) +import TestCommon +import Data.Maybe +import Data.Aeson hiding (json) +import Scripting.Duktape + +spec ∷ Spec +spec = do + describe "evalDuktape" $ do + it "evaluates ECMAScript expressions" $ do + ctx ← createDuktapeCtx + r0 ← evalDuktape (fromJust ctx) "" + r0 `shouldBe` Right Nothing + rE ← evalDuktape (fromJust ctx) "print('hello" + rE `shouldBe` Left "SyntaxError: eof or line terminator while parsing string literal (line 1)" + rT ← evalDuktape (fromJust ctx) "1 == 1" + rT `shouldBe` (Right $ Just $ Bool True) + rF ← evalDuktape (fromJust ctx) "1 == 2" + rF `shouldBe` (Right $ Just $ Bool False) + rN ← evalDuktape (fromJust ctx) "12345" + rN `shouldBe` (Right $ Just $ Number 12345) + rS ← evalDuktape (fromJust ctx) "'string'" + rS `shouldBe` (Right $ Just $ String "string") + rA ← evalDuktape (fromJust ctx) "[1,2,'string',{what:'ever'}]" + rA `shouldBe` (Right $ Just [json|[1,2,"string",{"what":"ever"}]|]) + rO ← evalDuktape (fromJust ctx) "({what: ['ever', 1, 2, 3]})" + rO `shouldBe` (Right $ Just [json|{"what":["ever", 1, 2, 3]}|]) diff --git a/test-suite/Spec.hs b/test-suite/Spec.hs new file mode 100644 --- /dev/null +++ b/test-suite/Spec.hs @@ -0,0 +1,1 @@ +{-# OPTIONS_GHC -F -pgmF hspec-discover #-} diff --git a/test-suite/TestCommon.hs b/test-suite/TestCommon.hs new file mode 100644 --- /dev/null +++ b/test-suite/TestCommon.hs @@ -0,0 +1,12 @@ +{-# LANGUAGE UnicodeSyntax #-} + +module TestCommon ( + json +) where + +import Language.Haskell.TH.Quote +import Data.Aeson.QQ + +-- renames for vim +json ∷ QuasiQuoter +json = aesonQQ