mirror of https://github.com/svaarala/duktape.git
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
53 lines
1.8 KiB
53 lines
1.8 KiB
<h1 id="introduction">Introduction</h1>
|
|
|
|
<p>Version: <span class="duktape-version">XX.XX.XX</span> (<span class="current-date">XXXX-XX-XX</span>)</p>
|
|
|
|
<h2>Document scope</h2>
|
|
|
|
<p>The Duktape API (defined in <code>duktape.h</code>) is a set of constants
|
|
and API calls which allows C/C++ programs to interface with Ecmascript
|
|
code and shields them from internal details like value representation.
|
|
</p>
|
|
|
|
<p>This document provides a concise reference for the Duktape API and
|
|
its core concepts. If you're new to Duktape, please read the
|
|
<a href="guide.html">Duktape Programmer's Guide</a> first.</p>
|
|
|
|
<div class="note">
|
|
The API will be in flux until 1.0 release.
|
|
</div>
|
|
|
|
<h2>Searching for functions using browser search</h2>
|
|
|
|
<p>You can use browser search (typically CTRL-F) to search for
|
|
function definitions by prepending a dot to the search term. For instance,
|
|
use ".duk_example_func" to look for <code>duk_example_func()</code>. In most
|
|
browsers only the actual section defining the function should be found.</p>
|
|
|
|
<h2>API safety</h2>
|
|
|
|
<p>As a general rule, API calls check all their parameters and tolerate
|
|
<code>NULL</code> arguments and invalid value stack indices without unsafe
|
|
behavior (crashes).</p>
|
|
|
|
<p>One major exception is the Duktape context argument, <code>ctx</code>.
|
|
Unless stated otherwise, it is not checked and is required to be
|
|
non-<code>NULL</code> or unsafe behavior may occur. This is the case
|
|
because explicit checks for the argument would increase code footprint
|
|
for little practical gain.</p>
|
|
|
|
<h2>Minimal Duktape program</h2>
|
|
|
|
<pre class="c-code">
|
|
#include "duktape.h"
|
|
|
|
int main(int argc, char *argv[]) {
|
|
duk_context *ctx = duk_create_heap_default(ctx);
|
|
if (ctx) {
|
|
duk_eval_string(ctx, "print('Hello world from Javascript!');");
|
|
duk_destroy_heap(ctx);
|
|
}
|
|
return 0;
|
|
}
|
|
</pre>
|
|
|
|
|