Guide gettingstarted.html cleanups

svaarala · svaarala · commit 63d01fff6031 · 2014-09-02T18:55:24.000+03:00
diff --git a/examples/guide/primecheck.c b/examples/guide/primecheck.c
@@ -4,7 +4,7 @@
 #include <string.h>
 #include "duktape.h"
 
-static int native_prime_check(duk_context *ctx) {
+static duk_ret_t native_prime_check(duk_context *ctx) {
     int val = duk_require_int(ctx, 0);
     int lim = duk_require_int(ctx, 1);
     int i;
@@ -30,8 +30,7 @@ int main(int argc, const char *argv[]) {
     duk_push_c_function(ctx, native_prime_check, 2 /*nargs*/);
     duk_put_prop_string(ctx, -2, "primeCheckNative");
 
-    duk_eval_file(ctx, "prime.js");
-    duk_pop(ctx);  /* pop eval result */
+    duk_eval_file_noresult(ctx, "prime.js");
 
     duk_get_prop_string(ctx, -1, "primeTest");
     duk_call(ctx, 0);
diff --git a/examples/guide/processlines.c b/examples/guide/processlines.c
@@ -13,8 +13,7 @@ int main(int argc, const char *argv[]) {
     ctx = duk_create_heap_default();
     if (!ctx) { exit(1); }
 
-    duk_eval_file(ctx, "process.js");
-    duk_pop(ctx);  /* pop eval result */
+    duk_eval_file_noresult(ctx, "process.js");
 
     memset(line, 0, sizeof(line));
     idx = 0;
@@ -29,7 +28,7 @@ int main(int argc, const char *argv[]) {
             duk_get_prop_string(ctx, -1 /*index*/, "processLine");
             duk_push_string(ctx, line);
             duk_call(ctx, 1 /*nargs*/);
-            printf("%s\n", duk_to_string(ctx, -1));
+            printf("%s\n", duk_safe_to_string(ctx, -1));
             duk_pop(ctx);
 
             idx = 0;
diff --git a/website/guide/gettingstarted.html b/website/guide/gettingstarted.html
@@ -32,7 +32,7 @@ <h2>Command line tool</h2>
 <p>You can now run Ecmascript code interactively:</p>
 <pre>
 $ ./duk
-((o) Duktape 0.11.0
+((o) Duktape 0.12.0
 duk&gt; print('Hello world!')
 Hello world!
 = undefined
@@ -46,7 +46,6 @@ <h2>Command line tool</h2>
 <pre>
 $ ./duk fib.js
 0 1 1 2 3 5 8 13 21 34 55 89 144 233 377 610 987 1597 2584 4181
-Cleaning up...
 </pre>
 
 <h2>Integrating Duktape into your program</h2>
@@ -124,14 +123,11 @@ <h2>Integrating Duktape into your program</h2>
 
 <li>
 <pre class="c-code">
-duk_eval_file(ctx, "process.js");
-duk_pop(ctx);  /* pop eval result */
+duk_eval_file_noresult(ctx, "process.js");
 </pre>
-<p>The first call reads in <code>process.js</code> and evaluates its contents.
-The script registers the <code>processLine()</code> function into the Ecmascript
-global object.  The result of the evaluation is pushed on top of the value
-stack.  Here we don't need the evaluation result, so we pop the value off
-the stack.</p>
+<p>The eval call reads in <code>process.js</code>, then compiles and executes the
+script.  The eval result is ignored.  The script registers the <code>processLine()</code>
+function into the Ecmascript global object.</p>
 </li>
 
 <li>
@@ -174,11 +170,11 @@ <h2>Integrating Duktape into your program</h2>
 
 <li>
 <pre class="c-code">
-printf("%s\n", duk_to_string(ctx, -1));
+printf("%s\n", duk_safe_to_string(ctx, -1));
 duk_pop(ctx);
 </pre>
-<p>The <code>duk_to_string()</code> call requests Duktape to convert the value stack
-element at index -1 (the topmost value on the stack, which is the processLine
+<p>The <code>duk_safe_to_string()</code> call requests Duktape to convert the value
+stack element at index -1 (the topmost value on the stack, which is the processLine
 function call result here) to a string, returning a <code>const char *</code> pointing
 to the result.  This return value is a read-only, NUL terminated UTF-8 value which
 C code can use directly as long as the value resides on the value stack.  Here we
@@ -203,7 +199,7 @@ <h2>Integrating Duktape into your program</h2>
 $ gcc -std=c99 -o processlines -Isrc/ src/duktape.c processlines.c -lm
 </pre>
 
-<p>Test run:</p>
+<p>Test run (ensure that <code>process.js</code> is in the current directory):</p>
 <pre>
 $ echo "I like *Sam &amp; Max*." | ./processlines
 I like &lt;b&gt;Sam &amp;<!-- avoiding double decode is tricky -->&#35;38; Max&lt;/b&gt;.
@@ -230,7 +226,7 @@ <h2>Calling C code from Ecmascript (Duktape/C bindings)</h2>
 <i>value stack</i>, manipulated with the Duktape API.  We'll go deeper into
 Duktape/C binding and the Duktape API later on.  Example:</p>
 <pre class="c-code">
-int my_native_func(duk_context *ctx) {
+duk_ret_t my_native_func(duk_context *ctx) {
     double arg = duk_require_number(ctx, 0 /*index*/);
     duk_push_number(ctx, arg * arg);
     return 1;
@@ -305,8 +301,12 @@ <h2>Calling C code from Ecmascript (Duktape/C bindings)</h2>
 If they are numbers, their value is converted to an integer and assigned to
 the <code>val</code> and <code>lim</code> locals.  The index 0 refers to the first
 function argument and index 1 to the second.</p>
+<p>
+Technically <code>duk_require_int()</code> returns a <code>duk_int_t</code>; this
+indirect type is always mapped to an <code>int</code> except on obscure platforms
+where an <code>int</code> is only 16 bits wide.  In ordinary application code you
+don't need to worry about this, see <a href="#ctypes">C types</a> for more discussion.</p>
 </li>
-
 <li>
 <pre class="c-code">
 duk_push_false(ctx);
@@ -357,7 +357,7 @@ <h2>Calling C code from Ecmascript (Duktape/C bindings)</h2>
 $ gcc -std=c99 -o primecheck -Isrc/ src/duktape.c primecheck.c -lm
 </pre>
 
-<p>Test run:</p>
+<p>Test run (ensure that <code>prime.js</code> is in the current directory):</p>
 <pre>
 $ time ./primecheck
 Have native helper: true
@@ -388,4 +388,3 @@ <h2>Calling C code from Ecmascript (Duktape/C bindings)</h2>
 user	0m23.573s
 sys	0m0.000s
 </pre>
-
