javascript duktape javascript-engine

Sami Vaarala 992c50e15a website typo fix		11 years ago
api-testcases	add specific negative return api test	11 years ago
bugs	ditz issue update	11 years ago
doc	test262 failure diagnosing	11 years ago
ecmascript-testcases	rename setFinalizer -> setFin in testcases	11 years ago
examples	avoid ToString() coercion of final Program result in non-interactive mode, as it may itself throw a TypeError (e.g. failed to coerce with [[DefaultValue]])	11 years ago
licenses	murmurhash2 license	12 years ago
misc	add c overflow misc test	11 years ago
references	Ecmascript E5 and E5.1 specifications as references (license allows redistribution)	12 years ago
runtests	runtests: knownbug -> knownissue, fixme note on use strict	11 years ago
src	add legacy setFinalizer/getFinalizer values for now	11 years ago
website	website typo fix	11 years ago
.gitignore	add stripped files to ignore too	12 years ago
LICENSE.txt	add a basic README and LICENSE	12 years ago
Makefile	makefile fix	11 years ago
README.md	README.md update, refer to underscore/test262 status docs	11 years ago
README.txt.dist	remove full dist README, update source dist README	11 years ago
RELEASES.txt	release note update	11 years ago
combine_src.py	make combining sources deterministic so that combined sources diff better	11 years ago
filter262log.py	test262 result filter fixes	11 years ago
make_dist.sh	first draft of 'initjs' code which would allow compatibility cruft to be implemented in JS and executed in init	11 years ago
underscore-test-shim.js	underscore test shim fix, jsonxEnc -> jxEnc	11 years ago
underscore_test	add valgrind support to underscore_test	11 years ago

README.md

Duktape

Introduction

Duktape is an embeddable Javascript engine, with a focus on portability and compact footprint.

Duktape is easy to integrate into a C/C++ project: add duktape.c and duktape.h to your build, and use the Duktape API to call Ecmascript functions from C code and vice versa.

Main features:

Embeddable, portable, compact
Ecmascript E5/E5.1 compliant
Built-in regular expression engine
Built-in Unicode support
Minimal platform dependencies
Combined reference counting and mark-and-sweep garbage collection with finalization
Liberal license

See duktape.org for packaged end-user downloads and documentation.

Have fun!

About this repository

This repository is intended for Duktape developers only, and contains Duktape internals: test cases, internal documentation, sources for the duktape.org web site, etc.

Getting started: end user

When embedding Duktape in your application you should use the packaged source distributables available from duktape.org/download.html.

However, if you really want to use a bleeding edge version:

$ git clone https://github.com/svaarala/duktape.git
$ cd duktape
$ make dist-src

Then use duktape-<version>.tar.xz like a normal source distributable.

Getting started: developing Duktape

If you intend to change Duktape internals, run test cases, etc:

# Install NodeJS and npm
$ sudo apt-get install nodejs npm

# Compile the command line tool ('duk')
$ git clone https://github.com/svaarala/duktape.git
$ cd duktape
$ make

# Run Ecmascript and API testcases
$ make test
$ make apitest
$ make regfuzztest
$ make underscoretest  # see doc/underscore-status.txt
$ make test262test     # see doc/test262-status.txt

Note: the repo Makefile is intended for Linux developer use, it is not a multi-platform "end user" Makefile. In particular, the Makefile is not intended to work on e.g. OSX or Windows. The source distributable has more user-friendly Makefile examples, but you should normally simply write your own Makefile when integrating Duktape into your program.

License

See LICENSE.txt.