Skip to content

Latest commit

 

History

History
51 lines (37 loc) · 2.13 KB

system-install.rst

File metadata and controls

51 lines (37 loc) · 2.13 KB
Raw

Installing Duktape as a system library

Duktape can be installed as a system library (e.g. as part of a Unix distribution) as follows:

  • Come up with a duk_config.h suitable for the target system. As a general rule you should use the defaults unless they conflict with the target system. On some systems you may need to override byte order, alignment requirements, Date built-in provider, etc. See duk-config.rst for details.
  • Build a system specific installation package with:
    • duktape.c compiled into a static/dynamic library, installed into system library paths.
    • duktape.h and duk_config.h, installed into system include paths.
  • A user application then simply ensures that:
    • The system include path containing duktape.h and duk_config.h is in the include path.
    • The system library path containing the Duktape static/dynamic library is in the library path.
    • Link with the the static/dynamic Duktape library.
    • Ensure that the standard math library is linked (-lm).

There a few limitations in this approach:

  • A user application cannot use custom config options because the active options are encapsulated in duk_config.h and affect the compilation of the shared Duktape library. This issue exists with all libraries with custom features affecting library compilation but may be emphasized for Duktape because there are a lot of config options.
  • Technically the Duktape library and the user application should be compiled with the same compiler. When using different compilers basic types or struct alignment rules (among other things) may differ. In practice it's unlikely you'll run into problems, at least when using mainline compilers like gcc/clang.

Before Duktape 1.3 the application would also need to use the same feature options (DUK_OPT_xxx) used when compiling the shared Duktape library. However, as of Duktape 1.3 all the relevant config options (DUK_USE_xxx) are encapsulated in duk_config.h so they can be modified without relying on command line feature options.