examples.api/README

   1 Jim examples
   2 ============
   3 BSD 2-clause license, (c) 2010 Wojciech A. Koszek <wkoszek@FreeBSD.org>
   4
   5
   6 This directory contains examples of Jim interpreter API. In order to start
   7 working with Jim API one may just want to copy existing example .c file
   8 into new file, modify Makefile and start working on a new program.
   9
  10 Existing examples
  11 =================
  12
  13 jim_command
  14         Simple command implementation in Jim's API. Command is then executed
  15         in a script encoded within a program.
  16
  17 jim_hello
  18         Standard "Hello world!" program.
  19
  20 jim_inline
  21         Similar "Hello world!" program, but the result comes from a Tcl
  22         script interpreted in Jim. Result is printed back on a terminal.
  23
  24 jim_list
  25         Will teach you how to create a list in Jim's API.  Once created,
  26         will show how to name and export it, so that variable is visible in
  27         the script's source code. Once done, interpretation of separate
  28         print.tcl file is presented. As a result, the script can print a
  29         list members created from within ANSI C program.
  30
  31 jim_obj
  32         Basic object creation in Jim.
  33
  34 jim_return
  35         Similar to jim_command example, but implemented command actually
  36         returns a value.