jim.h

   1 /* Jim - A small embeddable Tcl interpreter
   2  *
   3  * Copyright 2005 Salvatore Sanfilippo <antirez@invece.org>
   4  * Copyright 2005 Clemens Hintze <c.hintze@gmx.net>
   5  * Copyright 2005 patthoyts - Pat Thoyts <patthoyts@users.sf.net>
   6  * Copyright 2008 oharboe - Øyvind Harboe - oyvind.harboe@zylin.com
   7  * Copyright 2008 Andrew Lunn <andrew@lunn.ch>
   8  * Copyright 2008 Duane Ellis <openocd@duaneellis.com>
   9  * Copyright 2008 Uwe Klein <uklein@klein-messgeraete.de>
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  *
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above
  18  *    copyright notice, this list of conditions and the following
  19  *    disclaimer in the documentation and/or other materials
  20  *    provided with the distribution.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE JIM TCL PROJECT ``AS IS'' AND ANY
  23  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  24  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  25  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  26  * JIM TCL PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  27  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  28  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  31  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  32  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  33  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34  *
  35  * The views and conclusions contained in the software and documentation
  36  * are those of the authors and should not be interpreted as representing
  37  * official policies, either expressed or implied, of the Jim Tcl Project.
  38  *
  39  *--- Inline Header File Documentation ---
  40  *    [By Duane Ellis, openocd@duaneellis.com, 8/18/8]
  41  *
  42  * Belief is "Jim" would greatly benifit if Jim Internals where
  43  * documented in some way - form whatever, and perhaps - the package:
  44  * 'doxygen' is the correct approach to do that.
  45  *
  46  *   Details, see: http://www.stack.nl/~dimitri/doxygen/
  47  *
  48  * To that end please follow these guide lines:
  49  *
  50  *    (A) Document the PUBLIC api in the .H file.
  51  *
  52  *    (B) Document JIM Internals, in the .C file.
  53  *
  54  *    (C) Remember JIM is embedded in other packages, to that end do
  55  *    not assume that your way of documenting is the right way, Jim's
  56  *    public documentation should be agnostic, such that it is some
  57  *    what agreeable with the "package" that is embedding JIM inside
  58  *    of it's own doxygen documentation.
  59  *
  60  *    (D) Use minimal Doxygen tags.
  61  *
  62  * This will be an "ongoing work in progress" for some time.
  63  **/
  64
  65 #ifndef __JIM__H
  66 #define __JIM__H
  67
  68 #ifdef __cplusplus
  69 extern "C" {
  70 #endif
  71
  72 #include <time.h>
  73 #include <limits.h>
  74 #include <stdio.h>  /* for the FILE typedef definition */
  75 #include <stdlib.h> /* In order to export the Jim_Free() macro */
  76 #include <stdarg.h> /* In order to get type va_list */
  77
  78 /* -----------------------------------------------------------------------------
  79  * System configuration
  80  * autoconf (configure) will set these
  81  * ---------------------------------------------------------------------------*/
  82 #include <jim-win32compat.h>
  83
  84 #ifndef HAVE_NO_AUTOCONF
  85 #include <jim-config.h>
  86 #endif
  87
  88 /* -----------------------------------------------------------------------------
  89  * Compiler specific fixes.
  90  * ---------------------------------------------------------------------------*/
  91
  92 /* Long Long type and related issues */
  93 #ifndef jim_wide
  94 #  ifdef HAVE_LONG_LONG
  95 #    define jim_wide long long
  96 #    ifndef LLONG_MAX
  97 #      define LLONG_MAX    9223372036854775807LL
  98 #    endif
  99 #    ifndef LLONG_MIN
 100 #      define LLONG_MIN    (-LLONG_MAX - 1LL)
 101 #    endif
 102 #    define JIM_WIDE_MIN LLONG_MIN
 103 #    define JIM_WIDE_MAX LLONG_MAX
 104 #  else
 105 #    define jim_wide long
 106 #    define JIM_WIDE_MIN LONG_MIN
 107 #    define JIM_WIDE_MAX LONG_MAX
 108 #  endif
 109
 110 /* -----------------------------------------------------------------------------
 111  * LIBC specific fixes
 112  * ---------------------------------------------------------------------------*/
 113
 114 #  ifdef HAVE_LONG_LONG
 115 #    define JIM_WIDE_MODIFIER "lld"
 116 #  else
 117 #    define JIM_WIDE_MODIFIER "ld"
 118 #    define strtoull strtoul
 119 #  endif
 120 #endif
 121
 122 #define UCHAR(c) ((unsigned char)(c))
 123
 124 /* -----------------------------------------------------------------------------
 125  * Exported defines
 126  * ---------------------------------------------------------------------------*/
 127
 128 #define JIM_OK 0
 129 #define JIM_ERR 1
 130 #define JIM_RETURN 2
 131 #define JIM_BREAK 3
 132 #define JIM_CONTINUE 4
 133 #define JIM_SIGNAL 5
 134 #define JIM_EXIT 6
 135 /* The following are internal codes and should never been seen/used */
 136 #define JIM_EVAL 7
 137
 138 #define JIM_MAX_CALLFRAME_DEPTH 1000 /* default max nesting depth for procs */
 139 #define JIM_MAX_EVAL_DEPTH 2000 /* default max nesting depth for eval */
 140
 141 /* Some function get an integer argument with flags to change
 142  * the behaviour. */
 143
 144 /* Starting from 1 << 20 flags are reserved for private uses of
 145  * different calls. This way the same 'flags' argument may be used
 146  * to pass both global flags and private flags. */
 147 #define JIM_PRIV_FLAG_SHIFT 20
 148
 149 #define JIM_NONE 0              /* no flags set */
 150 #define JIM_ERRMSG 1            /* set an error message in the interpreter. */
 151 #define JIM_ENUM_ABBREV 2       /* Jim_GetEnum() - Allow unambiguous abbreviation */
 152 #define JIM_UNSHARED 4          /* Jim_GetVariable() - return unshared object */
 153 #define JIM_MUSTEXIST 8         /* Jim_SetDictKeysVector() - fail if non-existent */
 154
 155 /* Flags for Jim_SubstObj() */
 156 #define JIM_SUBST_NOVAR 1 /* don't perform variables substitutions */
 157 #define JIM_SUBST_NOCMD 2 /* don't perform command substitutions */
 158 #define JIM_SUBST_NOESC 4 /* don't perform escapes substitutions */
 159 #define JIM_SUBST_FLAG 128 /* flag to indicate that this is a real substition object */
 160
 161 /* Flags used by API calls getting a 'nocase' argument. */
 162 #define JIM_CASESENS    0   /* case sensitive */
 163 #define JIM_NOCASE      1   /* no case */
 164
 165 /* Filesystem related */
 166 #define JIM_PATH_LEN 1024
 167
 168 /* Unused arguments generate annoying warnings... */
 169 #define JIM_NOTUSED(V) ((void) V)
 170
 171 #define JIM_LIBPATH "auto_path"
 172 #define JIM_INTERACTIVE "tcl_interactive"
 173
 174 /* -----------------------------------------------------------------------------
 175  * Stack
 176  * ---------------------------------------------------------------------------*/
 177
 178 typedef struct Jim_Stack {
 179     int len;
 180     int maxlen;
 181     void **vector;
 182 } Jim_Stack;
 183
 184 /* -----------------------------------------------------------------------------
 185  * Hash table
 186  * ---------------------------------------------------------------------------*/
 187
 188 typedef struct Jim_HashEntry {
 189     void *key;
 190     union {
 191         void *val;
 192         int intval;
 193     } u;
 194     struct Jim_HashEntry *next;
 195 } Jim_HashEntry;
 196
 197 typedef struct Jim_HashTableType {
 198     unsigned int (*hashFunction)(const void *key);
 199     void *(*keyDup)(void *privdata, const void *key);
 200     void *(*valDup)(void *privdata, const void *obj);
 201     int (*keyCompare)(void *privdata, const void *key1, const void *key2);
 202     void (*keyDestructor)(void *privdata, void *key);
 203     void (*valDestructor)(void *privdata, void *obj);
 204 } Jim_HashTableType;
 205
 206 typedef struct Jim_HashTable {
 207     Jim_HashEntry **table;
 208     const Jim_HashTableType *type;
 209     void *privdata;
 210     unsigned int size;
 211     unsigned int sizemask;
 212     unsigned int used;
 213     unsigned int collisions;
 214     unsigned int uniq;
 215 } Jim_HashTable;
 216
 217 typedef struct Jim_HashTableIterator {
 218     Jim_HashTable *ht;
 219     Jim_HashEntry *entry, *nextEntry;
 220     int index;
 221 } Jim_HashTableIterator;
 222
 223 /* This is the initial size of every hash table */
 224 #define JIM_HT_INITIAL_SIZE     16
 225
 226 /* ------------------------------- Macros ------------------------------------*/
 227 #define Jim_FreeEntryVal(ht, entry) \
 228     if ((ht)->type->valDestructor) \
 229         (ht)->type->valDestructor((ht)->privdata, (entry)->u.val)
 230
 231 #define Jim_SetHashVal(ht, entry, _val_) do { \
 232     if ((ht)->type->valDup) \
 233         (entry)->u.val = (ht)->type->valDup((ht)->privdata, (_val_)); \
 234     else \
 235         (entry)->u.val = (_val_); \
 236 } while(0)
 237
 238 #define Jim_FreeEntryKey(ht, entry) \
 239     if ((ht)->type->keyDestructor) \
 240         (ht)->type->keyDestructor((ht)->privdata, (entry)->key)
 241
 242 #define Jim_SetHashKey(ht, entry, _key_) do { \
 243     if ((ht)->type->keyDup) \
 244         (entry)->key = (ht)->type->keyDup((ht)->privdata, (_key_)); \
 245     else \
 246         (entry)->key = (void *)(_key_); \
 247 } while(0)
 248
 249 #define Jim_CompareHashKeys(ht, key1, key2) \
 250     (((ht)->type->keyCompare) ? \
 251         (ht)->type->keyCompare((ht)->privdata, (key1), (key2)) : \
 252         (key1) == (key2))
 253
 254 #define Jim_HashKey(ht, key) ((ht)->type->hashFunction(key) + (ht)->uniq)
 255
 256 #define Jim_GetHashEntryKey(he) ((he)->key)
 257 #define Jim_GetHashEntryVal(he) ((he)->u.val)
 258 #define Jim_GetHashTableCollisions(ht) ((ht)->collisions)
 259 #define Jim_GetHashTableSize(ht) ((ht)->size)
 260 #define Jim_GetHashTableUsed(ht) ((ht)->used)
 261
 262 /* -----------------------------------------------------------------------------
 263  * Jim_Obj structure
 264  * ---------------------------------------------------------------------------*/
 265
 266 /* -----------------------------------------------------------------------------
 267  * Jim object. This is mostly the same as Tcl_Obj itself,
 268  * with the addition of the 'prev' and 'next' pointers.
 269  * In Jim all the objects are stored into a linked list for GC purposes,
 270  * so that it's possible to access every object living in a given interpreter
 271  * sequentially. When an object is freed, it's moved into a different
 272  * linked list, used as object pool.
 273  *
 274  * The refcount of a freed object is always -1.
 275  * ---------------------------------------------------------------------------*/
 276 typedef struct Jim_Obj {
 277     char *bytes; /* string representation buffer. NULL = no string repr. */
 278     const struct Jim_ObjType *typePtr; /* object type. */
 279     int refCount; /* reference count */
 280     int length; /* number of bytes in 'bytes', not including the null term. */
 281     /* Internal representation union */
 282     union {
 283         /* integer number type */
 284         jim_wide wideValue;
 285         /* generic integer value (e.g. index, return code) */
 286         int intValue;
 287         /* double number type */
 288         double doubleValue;
 289         /* Generic pointer */
 290         void *ptr;
 291         /* Generic two pointers value */
 292         struct {
 293             void *ptr1;
 294             void *ptr2;
 295         } twoPtrValue;
 296         /* Variable object */
 297         struct {
 298             struct Jim_Var *varPtr;
 299             unsigned long callFrameId; /* for caching */
 300             int global; /* If the variable name is globally scoped with :: */
 301         } varValue;
 302         /* Command object */
 303         struct {
 304             struct Jim_Obj *nsObj;
 305             struct Jim_Cmd *cmdPtr;
 306             unsigned long procEpoch; /* for caching */
 307         } cmdValue;
 308         /* List object */
 309         struct {
 310             struct Jim_Obj **ele;    /* Elements vector */
 311             int len;        /* Length */
 312             int maxLen;        /* Allocated 'ele' length */
 313         } listValue;
 314         /* String type */
 315         struct {
 316             int maxLength;
 317             int charLength;     /* utf-8 char length. -1 if unknown */
 318         } strValue;
 319         /* Reference type */
 320         struct {
 321             unsigned long id;
 322             struct Jim_Reference *refPtr;
 323         } refValue;
 324         /* Source type */
 325         struct {
 326             struct Jim_Obj *fileNameObj;
 327             int lineNumber;
 328         } sourceValue;
 329         /* Dict substitution type */
 330         struct {
 331             struct Jim_Obj *varNameObjPtr;
 332             struct Jim_Obj *indexObjPtr;
 333         } dictSubstValue;
 334         /* Regular expression pattern */
 335         struct {
 336             void *compre;       /* really an allocated (regex_t *) */
 337             unsigned flags;
 338         } regexpValue;
 339         struct {
 340             int line;
 341             int argc;
 342         } scriptLineValue;
 343     } internalRep;
 344     /* This are 8 or 16 bytes more for every object
 345      * but this is required for efficient garbage collection
 346      * of Jim references. */
 347     struct Jim_Obj *prevObjPtr; /* pointer to the prev object. */
 348     struct Jim_Obj *nextObjPtr; /* pointer to the next object. */
 349 } Jim_Obj;
 350
 351 /* Jim_Obj related macros */
 352 #define Jim_IncrRefCount(objPtr) \
 353     ++(objPtr)->refCount
 354 #define Jim_DecrRefCount(interp, objPtr) \
 355     if (--(objPtr)->refCount <= 0) Jim_FreeObj(interp, objPtr)
 356 #define Jim_IsShared(objPtr) \
 357     ((objPtr)->refCount > 1)
 358
 359 /* This macro is used when we allocate a new object using
 360  * Jim_New...Obj(), but for some error we need to destroy it.
 361  * Instead to use Jim_IncrRefCount() + Jim_DecrRefCount() we
 362  * can just call Jim_FreeNewObj. To call Jim_Free directly
 363  * seems too raw, the object handling may change and we want
 364  * that Jim_FreeNewObj() can be called only against objects
 365  * that are belived to have refcount == 0. */
 366 #define Jim_FreeNewObj Jim_FreeObj
 367
 368 /* Free the internal representation of the object. */
 369 #define Jim_FreeIntRep(i,o) \
 370     if ((o)->typePtr && (o)->typePtr->freeIntRepProc) \
 371         (o)->typePtr->freeIntRepProc(i, o)
 372
 373 /* Get the internal representation pointer */
 374 #define Jim_GetIntRepPtr(o) (o)->internalRep.ptr
 375
 376 /* Set the internal representation pointer */
 377 #define Jim_SetIntRepPtr(o, p) \
 378     (o)->internalRep.ptr = (p)
 379
 380 /* The object type structure.
 381  * There are three methods.
 382  *
 383  * - freeIntRepProc is used to free the internal representation of the object.
 384  *   Can be NULL if there is nothing to free.
 385  *
 386  * - dupIntRepProc is used to duplicate the internal representation of the object.
 387  *   If NULL, when an object is duplicated, the internalRep union is
 388  *   directly copied from an object to another.
 389  *   Note that it's up to the caller to free the old internal repr of the
 390  *   object before to call the Dup method.
 391  *
 392  * - updateStringProc is used to create the string from the internal repr.
 393  */
 394
 395 struct Jim_Interp;
 396
 397 typedef void (Jim_FreeInternalRepProc)(struct Jim_Interp *interp,
 398         struct Jim_Obj *objPtr);
 399 typedef void (Jim_DupInternalRepProc)(struct Jim_Interp *interp,
 400         struct Jim_Obj *srcPtr, Jim_Obj *dupPtr);
 401 typedef void (Jim_UpdateStringProc)(struct Jim_Obj *objPtr);
 402
 403 typedef struct Jim_ObjType {
 404     const char *name; /* The name of the type. */
 405     Jim_FreeInternalRepProc *freeIntRepProc;
 406     Jim_DupInternalRepProc *dupIntRepProc;
 407     Jim_UpdateStringProc *updateStringProc;
 408     int flags;
 409 } Jim_ObjType;
 410
 411 /* Jim_ObjType flags */
 412 #define JIM_TYPE_NONE 0        /* No flags */
 413 #define JIM_TYPE_REFERENCES 1    /* The object may contain referneces. */
 414
 415 /* Starting from 1 << 20 flags are reserved for private uses of
 416  * different calls. This way the same 'flags' argument may be used
 417  * to pass both global flags and private flags. */
 418 #define JIM_PRIV_FLAG_SHIFT 20
 419
 420 /* -----------------------------------------------------------------------------
 421  * Call frame, vars, commands structures
 422  * ---------------------------------------------------------------------------*/
 423
 424 /* Call frame */
 425 typedef struct Jim_CallFrame {
 426     unsigned long id; /* Call Frame ID. Used for caching. */
 427     int level; /* Level of this call frame. 0 = global */
 428     struct Jim_HashTable vars; /* Where local vars are stored */
 429     struct Jim_HashTable *staticVars; /* pointer to procedure static vars */
 430     struct Jim_CallFrame *parent; /* The parent callframe */
 431     Jim_Obj *const *argv; /* object vector of the current procedure call. */
 432     int argc; /* number of args of the current procedure call. */
 433     Jim_Obj *procArgsObjPtr; /* arglist object of the running procedure */
 434     Jim_Obj *procBodyObjPtr; /* body object of the running procedure */
 435     struct Jim_CallFrame *next; /* Callframes are in a linked list */
 436     Jim_Obj *nsObj;             /* Namespace for this proc call frame */
 437     Jim_Obj *fileNameObj;       /* file and line of caller of this proc (if available) */
 438     int line;
 439     Jim_Stack *localCommands; /* commands to be destroyed when the call frame is destroyed */
 440     int tailcall;            /* non-zero if a tailcall is being evaluated at this level */
 441     struct Jim_Obj *tailcallObj;  /* Pending tailcall invocation */
 442     struct Jim_Cmd *tailcallCmd;  /* Resolved command for pending tailcall invocation */
 443 } Jim_CallFrame;
 444
 445 /* The var structure. It just holds the pointer of the referenced
 446  * object. If linkFramePtr is not NULL the variable is a link
 447  * to a variable of name store on objPtr living on the given callframe
 448  * (this happens when the [global] or [upvar] command is used).
 449  * The interp in order to always know how to free the Jim_Obj associated
 450  * with a given variable because In Jim objects memory managment is
 451  * bound to interpreters. */
 452 typedef struct Jim_Var {
 453     Jim_Obj *objPtr;
 454     struct Jim_CallFrame *linkFramePtr;
 455 } Jim_Var;
 456
 457 /* The cmd structure. */
 458 typedef int Jim_CmdProc(struct Jim_Interp *interp, int argc,
 459     Jim_Obj *const *argv);
 460 typedef void Jim_DelCmdProc(struct Jim_Interp *interp, void *privData);
 461
 462
 463
 464 /* A command is implemented in C if isproc is 0, otherwise
 465  * it's a Tcl procedure with the arglist and body represented by the
 466  * two objects referenced by arglistObjPtr and bodyoObjPtr. */
 467 typedef struct Jim_Cmd {
 468     int inUse;           /* Reference count */
 469     int isproc;          /* Is this a procedure? */
 470     struct Jim_Cmd *prevCmd;    /* Previous command defn if cmd created 'local' */
 471     union {
 472         struct {
 473             /* native (C) command */
 474             Jim_CmdProc *cmdProc; /* The command implementation */
 475             Jim_DelCmdProc *delProc; /* Called when the command is deleted if != NULL */
 476             void *privData; /* command-private data available via Jim_CmdPrivData() */
 477         } native;
 478         struct {
 479             /* Tcl procedure */
 480             Jim_Obj *argListObjPtr;
 481             Jim_Obj *bodyObjPtr;
 482             Jim_HashTable *staticVars;  /* Static vars hash table. NULL if no statics. */
 483             int argListLen;             /* Length of argListObjPtr */
 484             int reqArity;               /* Number of required parameters */
 485             int optArity;               /* Number of optional parameters */
 486             int argsPos;                /* Position of 'args', if specified, or -1 */
 487             int upcall;                 /* True if proc is currently in upcall */
 488             struct Jim_ProcArg {
 489                 Jim_Obj *nameObjPtr;    /* Name of this arg */
 490                 Jim_Obj *defaultObjPtr; /* Default value, (or rename for $args) */
 491             } *arglist;
 492             Jim_Obj *nsObj;             /* Namespace for this proc */
 493         } proc;
 494     } u;
 495 } Jim_Cmd;
 496
 497 /* Pseudo Random Number Generator State structure */
 498 typedef struct Jim_PrngState {
 499     unsigned char sbox[256];
 500     unsigned int i, j;
 501 } Jim_PrngState;
 502
 503 /* -----------------------------------------------------------------------------
 504  * Jim interpreter structure.
 505  * Fields similar to the real Tcl interpreter structure have the same names.
 506  * ---------------------------------------------------------------------------*/
 507 typedef struct Jim_Interp {
 508     Jim_Obj *result; /* object returned by the last command called. */
 509     int errorLine; /* Error line where an error occurred. */
 510     Jim_Obj *errorFileNameObj; /* Error file where an error occurred. */
 511     int addStackTrace; /* > 0 If a level should be added to the stack trace */
 512     int maxCallFrameDepth; /* Used for infinite loop detection. */
 513     int maxEvalDepth; /* Used for infinite loop detection. */
 514     int evalDepth;  /* Current eval depth */
 515     int returnCode; /* Completion code to return on JIM_RETURN. */
 516     int returnLevel; /* Current level of 'return -level' */
 517     int exitCode; /* Code to return to the OS on JIM_EXIT. */
 518     long id; /* Hold unique id for various purposes */
 519     int signal_level; /* A nesting level of catch -signal */
 520     jim_wide sigmask;  /* Bit mask of caught signals, or 0 if none */
 521     int (*signal_set_result)(struct Jim_Interp *interp, jim_wide sigmask); /* Set a result for the sigmask */
 522     Jim_CallFrame *framePtr; /* Pointer to the current call frame */
 523     Jim_CallFrame *topFramePtr; /* toplevel/global frame pointer. */
 524     struct Jim_HashTable commands; /* Commands hash table */
 525     unsigned long procEpoch; /* Incremented every time the result
 526                 of procedures names lookup caching
 527                 may no longer be valid. */
 528     unsigned long callFrameEpoch; /* Incremented every time a new
 529                 callframe is created. This id is used for the
 530                 'ID' field contained in the Jim_CallFrame
 531                 structure. */
 532     int local; /* If 'local' is in effect, newly defined procs keep a reference to the old defn */
 533     Jim_Obj *liveList; /* Linked list of all the live objects. */
 534     Jim_Obj *freeList; /* Linked list of all the unused objects. */
 535     Jim_Obj *currentScriptObj; /* Script currently in execution. */
 536     Jim_Obj *nullScriptObj; /* script representation of an empty string */
 537     Jim_Obj *emptyObj; /* Shared empty string object. */
 538     Jim_Obj *trueObj; /* Shared true int object. */
 539     Jim_Obj *falseObj; /* Shared false int object. */
 540     unsigned long referenceNextId; /* Next id for reference. */
 541     struct Jim_HashTable references; /* References hash table. */
 542     unsigned long lastCollectId; /* reference max Id of the last GC
 543                 execution. It's set to -1 while the collection
 544                 is running as sentinel to avoid to recursive
 545                 calls via the [collect] command inside
 546                 finalizers. */
 547     time_t lastCollectTime; /* unix time of the last GC execution */
 548     Jim_Obj *stackTrace; /* Stack trace object. */
 549     Jim_Obj *errorProc; /* Name of last procedure which returned an error */
 550     Jim_Obj *unknown; /* Unknown command cache */
 551     int unknown_called; /* The unknown command has been invoked */
 552     int errorFlag; /* Set if an error occurred during execution. */
 553     void *cmdPrivData; /* Used to pass the private data pointer to
 554                   a command. It is set to what the user specified
 555                   via Jim_CreateCommand(). */
 556
 557     struct Jim_CallFrame *freeFramesList; /* list of CallFrame structures. */
 558     struct Jim_HashTable assocData; /* per-interp storage for use by packages */
 559     Jim_PrngState *prngState; /* per interpreter Random Number Gen. state. */
 560     struct Jim_HashTable packages; /* Provided packages hash table */
 561     Jim_Stack *loadHandles; /* handles of loaded modules [load] */
 562 } Jim_Interp;
 563
 564 /* Currently provided as macro that performs the increment.
 565  * At some point may be a real function doing more work.
 566  * The proc epoch is used in order to know when a command lookup
 567  * cached can no longer considered valid. */
 568 #define Jim_InterpIncrProcEpoch(i) (i)->procEpoch++
 569 #define Jim_SetResultString(i,s,l) Jim_SetResult(i, Jim_NewStringObj(i,s,l))
 570 #define Jim_SetResultInt(i,intval) Jim_SetResult(i, Jim_NewIntObj(i,intval))
 571 /* Note: Using trueObj and falseObj here makes some things slower...*/
 572 #define Jim_SetResultBool(i,b) Jim_SetResultInt(i, b)
 573 #define Jim_SetEmptyResult(i) Jim_SetResult(i, (i)->emptyObj)
 574 #define Jim_GetResult(i) ((i)->result)
 575 #define Jim_CmdPrivData(i) ((i)->cmdPrivData)
 576
 577 /* Note that 'o' is expanded only one time inside this macro,
 578  * so it's safe to use side effects. */
 579 #define Jim_SetResult(i,o) do {     \
 580     Jim_Obj *_resultObjPtr_ = (o);    \
 581     Jim_IncrRefCount(_resultObjPtr_); \
 582     Jim_DecrRefCount(i,(i)->result);  \
 583     (i)->result = _resultObjPtr_;     \
 584 } while(0)
 585
 586 /* Use this for filehandles, etc. which need a unique id */
 587 #define Jim_GetId(i) (++(i)->id)
 588
 589 /* Reference structure. The interpreter pointer is held within privdata member in HashTable */
 590 #define JIM_REFERENCE_TAGLEN 7 /* The tag is fixed-length, because the reference
 591                                   string representation must be fixed length. */
 592 typedef struct Jim_Reference {
 593     Jim_Obj *objPtr;
 594     Jim_Obj *finalizerCmdNamePtr;
 595     char tag[JIM_REFERENCE_TAGLEN+1];
 596 } Jim_Reference;
 597
 598 /* -----------------------------------------------------------------------------
 599  * Exported API prototypes.
 600  * ---------------------------------------------------------------------------*/
 601
 602 #define Jim_NewEmptyStringObj(i) Jim_NewStringObj(i, "", 0)
 603 #define Jim_FreeHashTableIterator(iter) Jim_Free(iter)
 604
 605 #define JIM_EXPORT
 606
 607 /* Memory allocation */
 608 JIM_EXPORT void *Jim_Alloc (int size);
 609 JIM_EXPORT void *Jim_Realloc(void *ptr, int size);
 610 JIM_EXPORT void Jim_Free (void *ptr);
 611 JIM_EXPORT char * Jim_StrDup (const char *s);
 612 JIM_EXPORT char *Jim_StrDupLen(const char *s, int l);
 613
 614 /* environment */
 615 JIM_EXPORT char **Jim_GetEnviron(void);
 616 JIM_EXPORT void Jim_SetEnviron(char **env);
 617 JIM_EXPORT int Jim_MakeTempFile(Jim_Interp *interp, const char *template);
 618
 619 /* evaluation */
 620 JIM_EXPORT int Jim_Eval(Jim_Interp *interp, const char *script);
 621 /* in C code, you can do this and get better error messages */
 622 /*   Jim_EvalSource( interp, __FILE__, __LINE__ , "some tcl commands"); */
 623 JIM_EXPORT int Jim_EvalSource(Jim_Interp *interp, const char *filename, int lineno, const char *script);
 624 /* Backwards compatibility */
 625 #define Jim_Eval_Named(I, S, F, L) Jim_EvalSource((I), (F), (L), (S))
 626
 627 JIM_EXPORT int Jim_EvalGlobal(Jim_Interp *interp, const char *script);
 628 JIM_EXPORT int Jim_EvalFile(Jim_Interp *interp, const char *filename);
 629 JIM_EXPORT int Jim_EvalFileGlobal(Jim_Interp *interp, const char *filename);
 630 JIM_EXPORT int Jim_EvalObj (Jim_Interp *interp, Jim_Obj *scriptObjPtr);
 631 JIM_EXPORT int Jim_EvalObjVector (Jim_Interp *interp, int objc,
 632         Jim_Obj *const *objv);
 633 JIM_EXPORT int Jim_EvalObjList(Jim_Interp *interp, Jim_Obj *listObj);
 634 JIM_EXPORT int Jim_EvalObjPrefix(Jim_Interp *interp, Jim_Obj *prefix,
 635         int objc, Jim_Obj *const *objv);
 636 #define Jim_EvalPrefix(i, p, oc, ov) Jim_EvalObjPrefix((i), Jim_NewStringObj((i), (p), -1), (oc), (ov))
 637 JIM_EXPORT int Jim_EvalNamespace(Jim_Interp *interp, Jim_Obj *scriptObj, Jim_Obj *nsObj);
 638 JIM_EXPORT int Jim_SubstObj (Jim_Interp *interp, Jim_Obj *substObjPtr,
 639         Jim_Obj **resObjPtrPtr, int flags);
 640
 641 /* stack */
 642 JIM_EXPORT void Jim_InitStack(Jim_Stack *stack);
 643 JIM_EXPORT void Jim_FreeStack(Jim_Stack *stack);
 644 JIM_EXPORT int Jim_StackLen(Jim_Stack *stack);
 645 JIM_EXPORT void Jim_StackPush(Jim_Stack *stack, void *element);
 646 JIM_EXPORT void * Jim_StackPop(Jim_Stack *stack);
 647 JIM_EXPORT void * Jim_StackPeek(Jim_Stack *stack);
 648 JIM_EXPORT void Jim_FreeStackElements(Jim_Stack *stack, void (*freeFunc)(void *ptr));
 649
 650 /* hash table */
 651 JIM_EXPORT int Jim_InitHashTable (Jim_HashTable *ht,
 652         const Jim_HashTableType *type, void *privdata);
 653 JIM_EXPORT void Jim_ExpandHashTable (Jim_HashTable *ht,
 654         unsigned int size);
 655 JIM_EXPORT int Jim_AddHashEntry (Jim_HashTable *ht, const void *key,
 656         void *val);
 657 JIM_EXPORT int Jim_ReplaceHashEntry (Jim_HashTable *ht,
 658         const void *key, void *val);
 659 JIM_EXPORT int Jim_DeleteHashEntry (Jim_HashTable *ht,
 660         const void *key);
 661 JIM_EXPORT int Jim_FreeHashTable (Jim_HashTable *ht);
 662 JIM_EXPORT Jim_HashEntry * Jim_FindHashEntry (Jim_HashTable *ht,
 663         const void *key);
 664 JIM_EXPORT void Jim_ResizeHashTable (Jim_HashTable *ht);
 665 JIM_EXPORT Jim_HashTableIterator *Jim_GetHashTableIterator
 666         (Jim_HashTable *ht);
 667 JIM_EXPORT Jim_HashEntry * Jim_NextHashEntry
 668         (Jim_HashTableIterator *iter);
 669
 670 /* objects */
 671 JIM_EXPORT Jim_Obj * Jim_NewObj (Jim_Interp *interp);
 672 JIM_EXPORT void Jim_FreeObj (Jim_Interp *interp, Jim_Obj *objPtr);
 673 JIM_EXPORT void Jim_InvalidateStringRep (Jim_Obj *objPtr);
 674 JIM_EXPORT Jim_Obj * Jim_DuplicateObj (Jim_Interp *interp,
 675         Jim_Obj *objPtr);
 676 JIM_EXPORT const char * Jim_GetString(Jim_Obj *objPtr,
 677         int *lenPtr);
 678 JIM_EXPORT const char *Jim_String(Jim_Obj *objPtr);
 679 JIM_EXPORT int Jim_Length(Jim_Obj *objPtr);
 680
 681 /* string object */
 682 JIM_EXPORT Jim_Obj * Jim_NewStringObj (Jim_Interp *interp,
 683         const char *s, int len);
 684 JIM_EXPORT Jim_Obj *Jim_NewStringObjUtf8(Jim_Interp *interp,
 685         const char *s, int charlen);
 686 JIM_EXPORT Jim_Obj * Jim_NewStringObjNoAlloc (Jim_Interp *interp,
 687         char *s, int len);
 688 JIM_EXPORT void Jim_AppendString (Jim_Interp *interp, Jim_Obj *objPtr,
 689         const char *str, int len);
 690 JIM_EXPORT void Jim_AppendObj (Jim_Interp *interp, Jim_Obj *objPtr,
 691         Jim_Obj *appendObjPtr);
 692 JIM_EXPORT void Jim_AppendStrings (Jim_Interp *interp,
 693         Jim_Obj *objPtr, ...);
 694 JIM_EXPORT int Jim_StringEqObj(Jim_Obj *aObjPtr, Jim_Obj *bObjPtr);
 695 JIM_EXPORT int Jim_StringMatchObj (Jim_Interp *interp, Jim_Obj *patternObjPtr,
 696         Jim_Obj *objPtr, int nocase);
 697 JIM_EXPORT Jim_Obj * Jim_StringRangeObj (Jim_Interp *interp,
 698         Jim_Obj *strObjPtr, Jim_Obj *firstObjPtr,
 699         Jim_Obj *lastObjPtr);
 700 JIM_EXPORT Jim_Obj * Jim_FormatString (Jim_Interp *interp,
 701         Jim_Obj *fmtObjPtr, int objc, Jim_Obj *const *objv);
 702 JIM_EXPORT Jim_Obj * Jim_ScanString (Jim_Interp *interp, Jim_Obj *strObjPtr,
 703         Jim_Obj *fmtObjPtr, int flags);
 704 JIM_EXPORT int Jim_CompareStringImmediate (Jim_Interp *interp,
 705         Jim_Obj *objPtr, const char *str);
 706 JIM_EXPORT int Jim_StringCompareObj(Jim_Interp *interp, Jim_Obj *firstObjPtr,
 707         Jim_Obj *secondObjPtr, int nocase);
 708 JIM_EXPORT int Jim_StringCompareLenObj(Jim_Interp *interp, Jim_Obj *firstObjPtr,
 709         Jim_Obj *secondObjPtr, int nocase);
 710 JIM_EXPORT int Jim_Utf8Length(Jim_Interp *interp, Jim_Obj *objPtr);
 711
 712 /* reference object */
 713 JIM_EXPORT Jim_Obj * Jim_NewReference (Jim_Interp *interp,
 714         Jim_Obj *objPtr, Jim_Obj *tagPtr, Jim_Obj *cmdNamePtr);
 715 JIM_EXPORT Jim_Reference * Jim_GetReference (Jim_Interp *interp,
 716         Jim_Obj *objPtr);
 717 JIM_EXPORT int Jim_SetFinalizer (Jim_Interp *interp, Jim_Obj *objPtr, Jim_Obj *cmdNamePtr);
 718 JIM_EXPORT int Jim_GetFinalizer (Jim_Interp *interp, Jim_Obj *objPtr, Jim_Obj **cmdNamePtrPtr);
 719
 720 /* interpreter */
 721 JIM_EXPORT Jim_Interp * Jim_CreateInterp (void);
 722 JIM_EXPORT void Jim_FreeInterp (Jim_Interp *i);
 723 JIM_EXPORT int Jim_GetExitCode (Jim_Interp *interp);
 724 JIM_EXPORT const char *Jim_ReturnCode(int code);
 725 JIM_EXPORT void Jim_SetResultFormatted(Jim_Interp *interp, const char *format, ...);
 726
 727 /* commands */
 728 JIM_EXPORT void Jim_RegisterCoreCommands (Jim_Interp *interp);
 729 JIM_EXPORT int Jim_CreateCommand (Jim_Interp *interp,
 730         const char *cmdName, Jim_CmdProc cmdProc, void *privData,
 731          Jim_DelCmdProc delProc);
 732 JIM_EXPORT int Jim_DeleteCommand (Jim_Interp *interp,
 733         const char *cmdName);
 734 JIM_EXPORT int Jim_RenameCommand (Jim_Interp *interp,
 735         const char *oldName, const char *newName);
 736 JIM_EXPORT Jim_Cmd * Jim_GetCommand (Jim_Interp *interp,
 737         Jim_Obj *objPtr, int flags);
 738 JIM_EXPORT int Jim_SetVariable (Jim_Interp *interp,
 739         Jim_Obj *nameObjPtr, Jim_Obj *valObjPtr);
 740 JIM_EXPORT int Jim_SetVariableStr (Jim_Interp *interp,
 741         const char *name, Jim_Obj *objPtr);
 742 JIM_EXPORT int Jim_SetGlobalVariableStr (Jim_Interp *interp,
 743         const char *name, Jim_Obj *objPtr);
 744 JIM_EXPORT int Jim_SetVariableStrWithStr (Jim_Interp *interp,
 745         const char *name, const char *val);
 746 JIM_EXPORT int Jim_SetVariableLink (Jim_Interp *interp,
 747         Jim_Obj *nameObjPtr, Jim_Obj *targetNameObjPtr,
 748         Jim_CallFrame *targetCallFrame);
 749 JIM_EXPORT Jim_Obj * Jim_MakeGlobalNamespaceName(Jim_Interp *interp,
 750         Jim_Obj *nameObjPtr);
 751 JIM_EXPORT Jim_Obj * Jim_GetVariable (Jim_Interp *interp,
 752         Jim_Obj *nameObjPtr, int flags);
 753 JIM_EXPORT Jim_Obj * Jim_GetGlobalVariable (Jim_Interp *interp,
 754         Jim_Obj *nameObjPtr, int flags);
 755 JIM_EXPORT Jim_Obj * Jim_GetVariableStr (Jim_Interp *interp,
 756         const char *name, int flags);
 757 JIM_EXPORT Jim_Obj * Jim_GetGlobalVariableStr (Jim_Interp *interp,
 758         const char *name, int flags);
 759 JIM_EXPORT int Jim_UnsetVariable (Jim_Interp *interp,
 760         Jim_Obj *nameObjPtr, int flags);
 761
 762 /* call frame */
 763 JIM_EXPORT Jim_CallFrame *Jim_GetCallFrameByLevel(Jim_Interp *interp,
 764         Jim_Obj *levelObjPtr);
 765
 766 /* garbage collection */
 767 JIM_EXPORT int Jim_Collect (Jim_Interp *interp);
 768 JIM_EXPORT void Jim_CollectIfNeeded (Jim_Interp *interp);
 769
 770 /* index object */
 771 JIM_EXPORT int Jim_GetIndex (Jim_Interp *interp, Jim_Obj *objPtr,
 772         int *indexPtr);
 773
 774 /* list object */
 775 JIM_EXPORT Jim_Obj * Jim_NewListObj (Jim_Interp *interp,
 776         Jim_Obj *const *elements, int len);
 777 JIM_EXPORT void Jim_ListInsertElements (Jim_Interp *interp,
 778         Jim_Obj *listPtr, int listindex, int objc, Jim_Obj *const *objVec);
 779 JIM_EXPORT void Jim_ListAppendElement (Jim_Interp *interp,
 780         Jim_Obj *listPtr, Jim_Obj *objPtr);
 781 JIM_EXPORT void Jim_ListAppendList (Jim_Interp *interp,
 782         Jim_Obj *listPtr, Jim_Obj *appendListPtr);
 783 JIM_EXPORT int Jim_ListLength (Jim_Interp *interp, Jim_Obj *objPtr);
 784 JIM_EXPORT int Jim_ListIndex (Jim_Interp *interp, Jim_Obj *listPrt,
 785         int listindex, Jim_Obj **objPtrPtr, int seterr);
 786 JIM_EXPORT Jim_Obj *Jim_ListGetIndex(Jim_Interp *interp, Jim_Obj *listPtr, int idx);
 787 JIM_EXPORT int Jim_SetListIndex (Jim_Interp *interp,
 788         Jim_Obj *varNamePtr, Jim_Obj *const *indexv, int indexc,
 789         Jim_Obj *newObjPtr);
 790 JIM_EXPORT Jim_Obj * Jim_ConcatObj (Jim_Interp *interp, int objc,
 791         Jim_Obj *const *objv);
 792 JIM_EXPORT Jim_Obj *Jim_ListJoin(Jim_Interp *interp,
 793         Jim_Obj *listObjPtr, const char *joinStr, int joinStrLen);
 794
 795 /* dict object */
 796 JIM_EXPORT Jim_Obj * Jim_NewDictObj (Jim_Interp *interp,
 797         Jim_Obj *const *elements, int len);
 798 JIM_EXPORT int Jim_DictKey (Jim_Interp *interp, Jim_Obj *dictPtr,
 799         Jim_Obj *keyPtr, Jim_Obj **objPtrPtr, int flags);
 800 JIM_EXPORT int Jim_DictKeysVector (Jim_Interp *interp,
 801         Jim_Obj *dictPtr, Jim_Obj *const *keyv, int keyc,
 802         Jim_Obj **objPtrPtr, int flags);
 803 JIM_EXPORT int Jim_SetDictKeysVector (Jim_Interp *interp,
 804         Jim_Obj *varNamePtr, Jim_Obj *const *keyv, int keyc,
 805         Jim_Obj *newObjPtr, int flags);
 806 JIM_EXPORT int Jim_DictPairs(Jim_Interp *interp,
 807         Jim_Obj *dictPtr, Jim_Obj ***objPtrPtr, int *len);
 808 JIM_EXPORT int Jim_DictAddElement(Jim_Interp *interp, Jim_Obj *objPtr,
 809         Jim_Obj *keyObjPtr, Jim_Obj *valueObjPtr);
 810 JIM_EXPORT int Jim_DictKeys(Jim_Interp *interp, Jim_Obj *objPtr, Jim_Obj *patternObj);
 811 JIM_EXPORT int Jim_DictValues(Jim_Interp *interp, Jim_Obj *dictObjPtr, Jim_Obj *patternObjPtr);
 812 JIM_EXPORT int Jim_DictSize(Jim_Interp *interp, Jim_Obj *objPtr);
 813 JIM_EXPORT int Jim_DictInfo(Jim_Interp *interp, Jim_Obj *objPtr);
 814
 815 /* return code object */
 816 JIM_EXPORT int Jim_GetReturnCode (Jim_Interp *interp, Jim_Obj *objPtr,
 817         int *intPtr);
 818
 819 /* expression object */
 820 JIM_EXPORT int Jim_EvalExpression (Jim_Interp *interp,
 821         Jim_Obj *exprObjPtr, Jim_Obj **exprResultPtrPtr);
 822 JIM_EXPORT int Jim_GetBoolFromExpr (Jim_Interp *interp,
 823         Jim_Obj *exprObjPtr, int *boolPtr);
 824
 825 /* integer object */
 826 JIM_EXPORT int Jim_GetWide (Jim_Interp *interp, Jim_Obj *objPtr,
 827         jim_wide *widePtr);
 828 JIM_EXPORT int Jim_GetLong (Jim_Interp *interp, Jim_Obj *objPtr,
 829         long *longPtr);
 830 #define Jim_NewWideObj  Jim_NewIntObj
 831 JIM_EXPORT Jim_Obj * Jim_NewIntObj (Jim_Interp *interp,
 832         jim_wide wideValue);
 833
 834 /* double object */
 835 JIM_EXPORT int Jim_GetDouble(Jim_Interp *interp, Jim_Obj *objPtr,
 836         double *doublePtr);
 837 JIM_EXPORT void Jim_SetDouble(Jim_Interp *interp, Jim_Obj *objPtr,
 838         double doubleValue);
 839 JIM_EXPORT Jim_Obj * Jim_NewDoubleObj(Jim_Interp *interp, double doubleValue);
 840
 841 /* commands utilities */
 842 JIM_EXPORT void Jim_WrongNumArgs (Jim_Interp *interp, int argc,
 843         Jim_Obj *const *argv, const char *msg);
 844 JIM_EXPORT int Jim_GetEnum (Jim_Interp *interp, Jim_Obj *objPtr,
 845         const char * const *tablePtr, int *indexPtr, const char *name, int flags);
 846 JIM_EXPORT int Jim_ScriptIsComplete (const char *s, int len,
 847         char *stateCharPtr);
 848 /**
 849  * Find a matching name in the array of the given length.
 850  *
 851  * NULL entries are ignored.
 852  *
 853  * Returns the matching index if found, or -1 if not.
 854  */
 855 JIM_EXPORT int Jim_FindByName(const char *name, const char * const array[], size_t len);
 856
 857 /* package utilities */
 858 typedef void (Jim_InterpDeleteProc)(Jim_Interp *interp, void *data);
 859 JIM_EXPORT void * Jim_GetAssocData(Jim_Interp *interp, const char *key);
 860 JIM_EXPORT int Jim_SetAssocData(Jim_Interp *interp, const char *key,
 861         Jim_InterpDeleteProc *delProc, void *data);
 862 JIM_EXPORT int Jim_DeleteAssocData(Jim_Interp *interp, const char *key);
 863
 864 /* Packages C API */
 865 /* jim-package.c */
 866 JIM_EXPORT int Jim_PackageProvide (Jim_Interp *interp,
 867         const char *name, const char *ver, int flags);
 868 JIM_EXPORT int Jim_PackageRequire (Jim_Interp *interp,
 869         const char *name, int flags);
 870
 871 /* error messages */
 872 JIM_EXPORT void Jim_MakeErrorMessage (Jim_Interp *interp);
 873
 874 /* interactive mode */
 875 JIM_EXPORT int Jim_InteractivePrompt (Jim_Interp *interp);
 876 JIM_EXPORT void Jim_HistoryLoad(const char *filename);
 877 JIM_EXPORT void Jim_HistorySave(const char *filename);
 878 JIM_EXPORT char *Jim_HistoryGetline(const char *prompt);
 879 JIM_EXPORT void Jim_HistoryAdd(const char *line);
 880 JIM_EXPORT void Jim_HistoryShow(void);
 881
 882 /* Misc */
 883 JIM_EXPORT int Jim_InitStaticExtensions(Jim_Interp *interp);
 884 JIM_EXPORT int Jim_StringToWide(const char *str, jim_wide *widePtr, int base);
 885 JIM_EXPORT int Jim_IsBigEndian(void);
 886
 887 /**
 888  * Returns 1 if a signal has been received while
 889  * in a catch -signal {} clause.
 890  */
 891 #define Jim_CheckSignal(i) ((i)->signal_level && (i)->sigmask)
 892
 893 /* jim-load.c */
 894 JIM_EXPORT int Jim_LoadLibrary(Jim_Interp *interp, const char *pathName);
 895 JIM_EXPORT void Jim_FreeLoadHandles(Jim_Interp *interp);
 896
 897 /* jim-aio.c */
 898 JIM_EXPORT FILE *Jim_AioFilehandle(Jim_Interp *interp, Jim_Obj *command);
 899
 900 /* type inspection - avoid where possible */
 901 JIM_EXPORT int Jim_IsDict(Jim_Obj *objPtr);
 902 JIM_EXPORT int Jim_IsList(Jim_Obj *objPtr);
 903
 904 #ifdef __cplusplus
 905 }
 906 #endif
 907
 908 #endif /* __JIM__H */
 909
 910 /*
 911  * Local Variables: ***
 912  * c-basic-offset: 4 ***
 913  * tab-width: 4 ***
 914  * End: ***
 915  */