duktape/website/api/duk_peval.yaml

name: duk_peval

proto: |
  duk_int_t duk_peval(duk_context *ctx);

stack: |
  [ ... source! ] -> [ ... result! ]  (if success, return value == 0)
  [ ... source! ] -> [ ... err! ]  (if failure, return value != 0)

summary: |
  <p>Like <code><a href="#duk_eval">duk_eval()</a></code> but catches errors
  related to compilation (such as syntax errors in the source).  A zero return
  value indicates success and the eval result is left on the stack top.
  A non-zero return value indicates an error, and the error is left on the stack top.</p>

  <p>If value stack top is too low (smaller than 1), an error is thrown.</p>

example: |
  duk_push_string(ctx, "print('Hello world!'); syntax error here=");
  if (duk_peval(ctx) != 0) {
      printf("eval failed: %s\n", duk_safe_to_string(ctx, -1));
  } else {
      printf("result is: %s\n", duk_safe_to_string(ctx, -1));
  }
  duk_pop(ctx);

tags:
  - compile
  - protected

seealso:
  - duk_eval
  - duk_peval_noresult
  - duk_peval_string
  - duk_peval_string_noresult
  - duk_peval_lstring
  - duk_peval_lstring_noresult

introduced: 1.0.0