1 /* Jim - A small embeddable Tcl interpreter
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>
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
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.
39 *--- Inline Header File Documentation ---
40 * [By Duane Ellis, openocd@duaneellis.com, 8/18/8]
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.
46 * Details, see: http://www.stack.nl/~dimitri/doxygen/
48 * To that end please follow these guide lines:
50 * (A) Document the PUBLIC api in the .H file.
52 * (B) Document JIM Internals, in the .C file.
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.
60 * (D) Use minimal Doxygen tags.
62 * This will be an "ongoing work in progress" for some time.
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 */
78 /* -----------------------------------------------------------------------------
79 * System configuration
80 * autoconf (configure) will set these
81 * ---------------------------------------------------------------------------*/
82 #include <jim-win32compat.h>
84 #ifndef HAVE_NO_AUTOCONF
85 #include <jim-config.h>
88 /* -----------------------------------------------------------------------------
89 * Compiler specific fixes.
90 * ---------------------------------------------------------------------------*/
92 /* Long Long type and related issues */
94 # ifdef HAVE_LONG_LONG
95 # define jim_wide long long
97 # define LLONG_MAX 9223372036854775807LL
100 # define LLONG_MIN (-LLONG_MAX - 1LL)
102 # define JIM_WIDE_MIN LLONG_MIN
103 # define JIM_WIDE_MAX LLONG_MAX
105 # define jim_wide long
106 # define JIM_WIDE_MIN LONG_MIN
107 # define JIM_WIDE_MAX LONG_MAX
110 /* -----------------------------------------------------------------------------
111 * LIBC specific fixes
112 * ---------------------------------------------------------------------------*/
114 # ifdef HAVE_LONG_LONG
115 # define JIM_WIDE_MODIFIER "lld"
117 # define JIM_WIDE_MODIFIER "ld"
118 # define strtoull strtoul
122 #define UCHAR(c) ((unsigned char)(c))
124 /* -----------------------------------------------------------------------------
126 * ---------------------------------------------------------------------------*/
132 #define JIM_CONTINUE 4
135 /* The following are internal codes and should never been seen/used */
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 */
141 /* Some function get an integer argument with flags to change
143 #define JIM_NONE 0 /* no flags set */
144 #define JIM_ERRMSG 1 /* set an error message in the interpreter. */
146 #define JIM_UNSHARED 4 /* Flag to Jim_GetVariable() */
147 #define JIM_MUSTEXIST 8 /* Flag to Jim_SetDictKeysVector() - fail if non-existent */
150 #define JIM_GLOBAL_ONLY 0x100
152 /* Flags for Jim_SubstObj() */
153 #define JIM_SUBST_NOVAR 1 /* don't perform variables substitutions */
154 #define JIM_SUBST_NOCMD 2 /* don't perform command substitutions */
155 #define JIM_SUBST_NOESC 4 /* don't perform escapes substitutions */
156 #define JIM_SUBST_FLAG 128 /* flag to indicate that this is a real substition object */
158 /* Unused arguments generate annoying warnings... */
159 #define JIM_NOTUSED(V) ((void) V)
161 /* Flags for Jim_GetEnum() */
162 #define JIM_ENUM_ABBREV 2 /* Allow unambiguous abbreviation */
164 /* Flags used by API calls getting a 'nocase' argument. */
165 #define JIM_CASESENS 0 /* case sensitive */
166 #define JIM_NOCASE 1 /* no case */
168 /* Filesystem related */
169 #define JIM_PATH_LEN 1024
171 /* Newline, some embedded system may need -DJIM_CRLF */
173 #define JIM_NL "\r\n"
178 #define JIM_LIBPATH "auto_path"
179 #define JIM_INTERACTIVE "tcl_interactive"
181 /* -----------------------------------------------------------------------------
183 * ---------------------------------------------------------------------------*/
185 typedef struct Jim_Stack
{
191 /* -----------------------------------------------------------------------------
193 * ---------------------------------------------------------------------------*/
195 typedef struct Jim_HashEntry
{
201 struct Jim_HashEntry
*next
;
204 typedef struct Jim_HashTableType
{
205 unsigned int (*hashFunction
)(const void *key
);
206 void *(*keyDup
)(void *privdata
, const void *key
);
207 void *(*valDup
)(void *privdata
, const void *obj
);
208 int (*keyCompare
)(void *privdata
, const void *key1
, const void *key2
);
209 void (*keyDestructor
)(void *privdata
, void *key
);
210 void (*valDestructor
)(void *privdata
, void *obj
);
213 typedef struct Jim_HashTable
{
214 Jim_HashEntry
**table
;
215 const Jim_HashTableType
*type
;
217 unsigned int sizemask
;
219 unsigned int collisions
;
223 typedef struct Jim_HashTableIterator
{
226 Jim_HashEntry
*entry
, *nextEntry
;
227 } Jim_HashTableIterator
;
229 /* This is the initial size of every hash table */
230 #define JIM_HT_INITIAL_SIZE 16
232 /* ------------------------------- Macros ------------------------------------*/
233 #define Jim_FreeEntryVal(ht, entry) \
234 if ((ht)->type->valDestructor) \
235 (ht)->type->valDestructor((ht)->privdata, (entry)->u.val)
237 #define Jim_SetHashVal(ht, entry, _val_) do { \
238 if ((ht)->type->valDup) \
239 entry->u.val = (ht)->type->valDup((ht)->privdata, _val_); \
241 entry->u.val = (_val_); \
244 #define Jim_FreeEntryKey(ht, entry) \
245 if ((ht)->type->keyDestructor) \
246 (ht)->type->keyDestructor((ht)->privdata, (entry)->key)
248 #define Jim_SetHashKey(ht, entry, _key_) do { \
249 if ((ht)->type->keyDup) \
250 entry->key = (ht)->type->keyDup((ht)->privdata, _key_); \
252 entry->key = (void *)(_key_); \
255 #define Jim_CompareHashKeys(ht, key1, key2) \
256 (((ht)->type->keyCompare) ? \
257 (ht)->type->keyCompare((ht)->privdata, key1, key2) : \
260 #define Jim_HashKey(ht, key) (ht)->type->hashFunction(key)
262 #define Jim_GetHashEntryKey(he) ((he)->key)
263 #define Jim_GetHashEntryVal(he) ((he)->val)
264 #define Jim_GetHashTableCollisions(ht) ((ht)->collisions)
265 #define Jim_GetHashTableSize(ht) ((ht)->size)
266 #define Jim_GetHashTableUsed(ht) ((ht)->used)
268 /* -----------------------------------------------------------------------------
270 * ---------------------------------------------------------------------------*/
272 /* -----------------------------------------------------------------------------
273 * Jim object. This is mostly the same as Tcl_Obj itself,
274 * with the addition of the 'prev' and 'next' pointers.
275 * In Jim all the objects are stored into a linked list for GC purposes,
276 * so that it's possible to access every object living in a given interpreter
277 * sequentially. When an object is freed, it's moved into a different
278 * linked list, used as object pool.
280 * The refcount of a freed object is always -1.
281 * ---------------------------------------------------------------------------*/
282 typedef struct Jim_Obj
{
283 char *bytes
; /* string representation buffer. NULL = no string repr. */
284 const struct Jim_ObjType
*typePtr
; /* object type. */
285 int refCount
; /* reference count */
286 int length
; /* number of bytes in 'bytes', not including the null term. */
287 /* Internal representation union */
289 /* integer number type */
291 /* generic integer value (e.g. index, return code) */
293 /* double number type */
295 /* Generic pointer */
297 /* Generic two pointers value */
302 /* Variable object */
304 unsigned long callFrameId
; /* for caching */
305 struct Jim_Var
*varPtr
;
306 int global
; /* If the variable name is globally scoped with :: */
310 unsigned long procEpoch
; /* for caching */
311 struct Jim_Obj
*nsObj
;
312 struct Jim_Cmd
*cmdPtr
;
316 struct Jim_Obj
**ele
; /* Elements vector */
317 int len
; /* Length */
318 int maxLen
; /* Allocated 'ele' length */
323 int charLength
; /* utf-8 char length. -1 if unknown */
328 struct Jim_Reference
*refPtr
;
332 struct Jim_Obj
*fileNameObj
;
335 /* Dict substitution type */
337 struct Jim_Obj
*varNameObjPtr
;
338 struct Jim_Obj
*indexObjPtr
;
340 /* Regular expression pattern */
343 void *compre
; /* really an allocated (regex_t *) */
350 /* This are 8 or 16 bytes more for every object
351 * but this is required for efficient garbage collection
352 * of Jim references. */
353 struct Jim_Obj
*prevObjPtr
; /* pointer to the prev object. */
354 struct Jim_Obj
*nextObjPtr
; /* pointer to the next object. */
357 /* Jim_Obj related macros */
358 #define Jim_IncrRefCount(objPtr) \
360 #define Jim_DecrRefCount(interp, objPtr) \
361 if (--(objPtr)->refCount <= 0) Jim_FreeObj(interp, objPtr)
362 #define Jim_IsShared(objPtr) \
363 ((objPtr)->refCount > 1)
365 /* This macro is used when we allocate a new object using
366 * Jim_New...Obj(), but for some error we need to destroy it.
367 * Instead to use Jim_IncrRefCount() + Jim_DecrRefCount() we
368 * can just call Jim_FreeNewObj. To call Jim_Free directly
369 * seems too raw, the object handling may change and we want
370 * that Jim_FreeNewObj() can be called only against objects
371 * that are belived to have refcount == 0. */
372 #define Jim_FreeNewObj Jim_FreeObj
374 /* Free the internal representation of the object. */
375 #define Jim_FreeIntRep(i,o) \
376 if ((o)->typePtr && (o)->typePtr->freeIntRepProc) \
377 (o)->typePtr->freeIntRepProc(i, o)
379 /* Get the internal representation pointer */
380 #define Jim_GetIntRepPtr(o) (o)->internalRep.ptr
382 /* Set the internal representation pointer */
383 #define Jim_SetIntRepPtr(o, p) \
384 (o)->internalRep.ptr = (p)
386 /* The object type structure.
387 * There are four methods.
389 * - FreeIntRep is used to free the internal representation of the object.
390 * Can be NULL if there is nothing to free.
391 * - DupIntRep is used to duplicate the internal representation of the object.
392 * If NULL, when an object is duplicated, the internalRep union is
393 * directly copied from an object to another.
394 * Note that it's up to the caller to free the old internal repr of the
395 * object before to call the Dup method.
396 * - UpdateString is used to create the string from the internal repr.
397 * - setFromAny is used to convert the current object into one of this type.
402 typedef void (Jim_FreeInternalRepProc
)(struct Jim_Interp
*interp
,
403 struct Jim_Obj
*objPtr
);
404 typedef void (Jim_DupInternalRepProc
)(struct Jim_Interp
*interp
,
405 struct Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
);
406 typedef void (Jim_UpdateStringProc
)(struct Jim_Obj
*objPtr
);
408 typedef struct Jim_ObjType
{
409 const char *name
; /* The name of the type. */
410 Jim_FreeInternalRepProc
*freeIntRepProc
;
411 Jim_DupInternalRepProc
*dupIntRepProc
;
412 Jim_UpdateStringProc
*updateStringProc
;
416 /* Jim_ObjType flags */
417 #define JIM_TYPE_NONE 0 /* No flags */
418 #define JIM_TYPE_REFERENCES 1 /* The object may contain referneces. */
420 /* Starting from 1 << 20 flags are reserved for private uses of
421 * different calls. This way the same 'flags' argument may be used
422 * to pass both global flags and private flags. */
423 #define JIM_PRIV_FLAG_SHIFT 20
425 /* -----------------------------------------------------------------------------
426 * Call frame, vars, commands structures
427 * ---------------------------------------------------------------------------*/
430 typedef struct Jim_CallFrame
{
431 unsigned long id
; /* Call Frame ID. Used for caching. */
432 int level
; /* Level of this call frame. 0 = global */
433 struct Jim_HashTable vars
; /* Where local vars are stored */
434 struct Jim_HashTable
*staticVars
; /* pointer to procedure static vars */
435 struct Jim_CallFrame
*parent
; /* The parent callframe */
436 Jim_Obj
*const *argv
; /* object vector of the current procedure call. */
437 int argc
; /* number of args of the current procedure call. */
438 Jim_Obj
*procArgsObjPtr
; /* arglist object of the running procedure */
439 Jim_Obj
*procBodyObjPtr
; /* body object of the running procedure */
440 struct Jim_CallFrame
*next
; /* Callframes are in a linked list */
441 Jim_Obj
*nsObj
; /* Namespace for this proc call frame */
442 Jim_Obj
*fileNameObj
; /* file and line of caller of this proc (if available) */
444 Jim_Stack
*localCommands
; /* commands to be destroyed when the call frame is destroyed */
447 /* The var structure. It just holds the pointer of the referenced
448 * object. If linkFramePtr is not NULL the variable is a link
449 * to a variable of name store on objPtr living on the given callframe
450 * (this happens when the [global] or [upvar] command is used).
451 * The interp in order to always know how to free the Jim_Obj associated
452 * with a given variable because In Jim objects memory managment is
453 * bound to interpreters. */
454 typedef struct Jim_Var
{
456 struct Jim_CallFrame
*linkFramePtr
;
459 /* The cmd structure. */
460 typedef int (*Jim_CmdProc
)(struct Jim_Interp
*interp
, int argc
,
461 Jim_Obj
*const *argv
);
462 typedef void (*Jim_DelCmdProc
)(struct Jim_Interp
*interp
, void *privData
);
466 /* A command is implemented in C if funcPtr is != NULL, otherwise
467 * it's a Tcl procedure with the arglist and body represented by the
468 * two objects referenced by arglistObjPtr and bodyoObjPtr. */
469 typedef struct Jim_Cmd
{
470 int inUse
; /* Reference count */
471 int isproc
; /* Is this a procedure? */
472 struct Jim_Cmd
*prevCmd
; /* Previous command defn if cmd created 'local' */
475 /* native (C) command */
476 Jim_CmdProc cmdProc
; /* The command implementation */
477 Jim_DelCmdProc delProc
; /* Called when the command is deleted if != NULL */
478 void *privData
; /* command-private data available via Jim_CmdPrivData() */
482 Jim_Obj
*argListObjPtr
;
484 Jim_HashTable
*staticVars
; /* Static vars hash table. NULL if no statics. */
485 int argListLen
; /* Length of argListObjPtr */
486 int reqArity
; /* Number of required parameters */
487 int optArity
; /* Number of optional parameters */
488 int argsPos
; /* Position of 'args', if specified, or -1 */
489 int upcall
; /* True if proc is currently in upcall */
491 Jim_Obj
*nameObjPtr
; /* Name of this arg */
492 Jim_Obj
*defaultObjPtr
; /* Default value, (or rename for $args) */
494 Jim_Obj
*nsObj
; /* Namespace for this proc */
499 /* Pseudo Random Number Generator State structure */
500 typedef struct Jim_PrngState
{
501 unsigned char sbox
[256];
505 /* -----------------------------------------------------------------------------
506 * Jim interpreter structure.
507 * Fields similar to the real Tcl interpreter structure have the same names.
508 * ---------------------------------------------------------------------------*/
509 typedef struct Jim_Interp
{
510 Jim_Obj
*result
; /* object returned by the last command called. */
511 int errorLine
; /* Error line where an error occurred. */
512 Jim_Obj
*errorFileNameObj
; /* Error file where an error occurred. */
513 int addStackTrace
; /* > 0 If a level should be added to the stack trace */
514 int maxCallFrameDepth
; /* Used for infinite loop detection. */
515 int maxEvalDepth
; /* Used for infinite loop detection. */
516 int evalDepth
; /* Current eval depth */
517 int returnCode
; /* Completion code to return on JIM_RETURN. */
518 int returnLevel
; /* Current level of 'return -level' */
519 int exitCode
; /* Code to return to the OS on JIM_EXIT. */
520 long id
; /* Hold unique id for various purposes */
521 int signal_level
; /* A nesting level of catch -signal */
522 jim_wide sigmask
; /* Bit mask of caught signals, or 0 if none */
523 int (*signal_set_result
)(struct Jim_Interp
*interp
, jim_wide sigmask
); /* Set a result for the sigmask */
524 Jim_CallFrame
*framePtr
; /* Pointer to the current call frame */
525 Jim_CallFrame
*topFramePtr
; /* toplevel/global frame pointer. */
526 struct Jim_HashTable commands
; /* Commands hash table */
527 unsigned long procEpoch
; /* Incremented every time the result
528 of procedures names lookup caching
529 may no longer be valid. */
530 unsigned long callFrameEpoch
; /* Incremented every time a new
531 callframe is created. This id is used for the
532 'ID' field contained in the Jim_CallFrame
534 int local
; /* If 'local' is in effect, newly defined procs keep a reference to the old defn */
535 Jim_Obj
*liveList
; /* Linked list of all the live objects. */
536 Jim_Obj
*freeList
; /* Linked list of all the unused objects. */
537 Jim_Obj
*currentScriptObj
; /* Script currently in execution. */
538 Jim_Obj
*nullScriptObj
; /* script representation of an empty string */
539 Jim_Obj
*emptyObj
; /* Shared empty string object. */
540 Jim_Obj
*trueObj
; /* Shared true int object. */
541 Jim_Obj
*falseObj
; /* Shared false int object. */
542 unsigned long referenceNextId
; /* Next id for reference. */
543 struct Jim_HashTable references
; /* References hash table. */
544 unsigned long lastCollectId
; /* reference max Id of the last GC
545 execution. It's set to -1 while the collection
546 is running as sentinel to avoid to recursive
547 calls via the [collect] command inside
549 time_t lastCollectTime
; /* unix time of the last GC execution */
550 Jim_Obj
*stackTrace
; /* Stack trace object. */
551 Jim_Obj
*errorProc
; /* Name of last procedure which returned an error */
552 Jim_Obj
*unknown
; /* Unknown command cache */
553 int unknown_called
; /* The unknown command has been invoked */
554 int errorFlag
; /* Set if an error occurred during execution. */
555 void *cmdPrivData
; /* Used to pass the private data pointer to
556 a command. It is set to what the user specified
557 via Jim_CreateCommand(). */
559 struct Jim_CallFrame
*freeFramesList
; /* list of CallFrame structures. */
560 struct Jim_HashTable assocData
; /* per-interp storage for use by packages */
561 Jim_PrngState
*prngState
; /* per interpreter Random Number Gen. state. */
562 struct Jim_HashTable packages
; /* Provided packages hash table */
563 Jim_Stack
*loadHandles
; /* handles of loaded modules [load] */
566 /* Currently provided as macro that performs the increment.
567 * At some point may be a real function doing more work.
568 * The proc epoch is used in order to know when a command lookup
569 * cached can no longer considered valid. */
570 #define Jim_InterpIncrProcEpoch(i) (i)->procEpoch++
571 #define Jim_SetResultString(i,s,l) Jim_SetResult(i, Jim_NewStringObj(i,s,l))
572 #define Jim_SetResultInt(i,intval) Jim_SetResult(i, Jim_NewIntObj(i,intval))
573 /* Note: Using trueObj and falseObj here makes some things slower...*/
574 #define Jim_SetResultBool(i,b) Jim_SetResultInt(i, b)
575 #define Jim_SetEmptyResult(i) Jim_SetResult(i, (i)->emptyObj)
576 #define Jim_GetResult(i) ((i)->result)
577 #define Jim_CmdPrivData(i) ((i)->cmdPrivData)
579 /* Note that 'o' is expanded only one time inside this macro,
580 * so it's safe to use side effects. */
581 #define Jim_SetResult(i,o) do { \
582 Jim_Obj *_resultObjPtr_ = (o); \
583 Jim_IncrRefCount(_resultObjPtr_); \
584 Jim_DecrRefCount(i,(i)->result); \
585 (i)->result = _resultObjPtr_; \
588 /* Use this for filehandles, etc. which need a unique id */
589 #define Jim_GetId(i) (++(i)->id)
591 /* Reference structure. The interpreter pointer is held within privdata member in HashTable */
592 #define JIM_REFERENCE_TAGLEN 7 /* The tag is fixed-length, because the reference
593 string representation must be fixed length. */
594 typedef struct Jim_Reference
{
596 Jim_Obj
*finalizerCmdNamePtr
;
597 char tag
[JIM_REFERENCE_TAGLEN
+1];
600 /* -----------------------------------------------------------------------------
601 * Exported API prototypes.
602 * ---------------------------------------------------------------------------*/
604 /* Macros that are common for extensions and core. */
605 #define Jim_NewEmptyStringObj(i) Jim_NewStringObj(i, "", 0)
607 /* The core includes real prototypes, extensions instead
608 * include a global function pointer for every function exported.
609 * Once the extension calls Jim_InitExtension(), the global
610 * functon pointers are set to the value of the STUB table
611 * contained in the Jim_Interp structure.
613 * This makes Jim able to load extensions even if it is statically
614 * linked itself, and to load extensions compiled with different
615 * versions of Jim (as long as the API is still compatible.) */
617 /* Macros are common for core and extensions */
618 #define Jim_FreeHashTableIterator(iter) Jim_Free(iter)
622 /* Memory allocation */
623 JIM_EXPORT
void *Jim_Alloc (int size
);
624 JIM_EXPORT
void *Jim_Realloc(void *ptr
, int size
);
625 JIM_EXPORT
void Jim_Free (void *ptr
);
626 JIM_EXPORT
char * Jim_StrDup (const char *s
);
627 JIM_EXPORT
char *Jim_StrDupLen(const char *s
, int l
);
630 JIM_EXPORT
char **Jim_GetEnviron(void);
631 JIM_EXPORT
void Jim_SetEnviron(char **env
);
634 JIM_EXPORT
int Jim_Eval(Jim_Interp
*interp
, const char *script
);
635 /* in C code, you can do this and get better error messages */
636 /* Jim_EvalSource( interp, __FILE__, __LINE__ , "some tcl commands"); */
637 JIM_EXPORT
int Jim_EvalSource(Jim_Interp
*interp
, const char *filename
, int lineno
, const char *script
);
638 /* Backwards compatibility */
639 #define Jim_Eval_Named(I, S, F, L) Jim_EvalSource((I), (F), (L), (S))
641 JIM_EXPORT
int Jim_EvalGlobal(Jim_Interp
*interp
, const char *script
);
642 JIM_EXPORT
int Jim_EvalFile(Jim_Interp
*interp
, const char *filename
);
643 JIM_EXPORT
int Jim_EvalFileGlobal(Jim_Interp
*interp
, const char *filename
);
644 JIM_EXPORT
int Jim_EvalObj (Jim_Interp
*interp
, Jim_Obj
*scriptObjPtr
);
645 JIM_EXPORT
int Jim_EvalObjVector (Jim_Interp
*interp
, int objc
,
646 Jim_Obj
*const *objv
);
647 JIM_EXPORT
int Jim_EvalObjList(Jim_Interp
*interp
, Jim_Obj
*listObj
);
648 JIM_EXPORT
int Jim_EvalObjPrefix(Jim_Interp
*interp
, Jim_Obj
*prefix
,
649 int objc
, Jim_Obj
*const *objv
);
650 #define Jim_EvalPrefix(i, p, oc, ov) Jim_EvalObjPrefix((i), Jim_NewStringObj((i), (p), -1), (oc), (ov))
651 JIM_EXPORT
int Jim_EvalNamespace(Jim_Interp
*interp
, Jim_Obj
*scriptObj
, Jim_Obj
*nsObj
);
652 JIM_EXPORT
int Jim_SubstObj (Jim_Interp
*interp
, Jim_Obj
*substObjPtr
,
653 Jim_Obj
**resObjPtrPtr
, int flags
);
656 JIM_EXPORT
void Jim_InitStack(Jim_Stack
*stack
);
657 JIM_EXPORT
void Jim_FreeStack(Jim_Stack
*stack
);
658 JIM_EXPORT
int Jim_StackLen(Jim_Stack
*stack
);
659 JIM_EXPORT
void Jim_StackPush(Jim_Stack
*stack
, void *element
);
660 JIM_EXPORT
void * Jim_StackPop(Jim_Stack
*stack
);
661 JIM_EXPORT
void * Jim_StackPeek(Jim_Stack
*stack
);
662 JIM_EXPORT
void Jim_FreeStackElements(Jim_Stack
*stack
, void (*freeFunc
)(void *ptr
));
665 JIM_EXPORT
int Jim_InitHashTable (Jim_HashTable
*ht
,
666 const Jim_HashTableType
*type
, void *privdata
);
667 JIM_EXPORT
void Jim_ExpandHashTable (Jim_HashTable
*ht
,
669 JIM_EXPORT
int Jim_AddHashEntry (Jim_HashTable
*ht
, const void *key
,
671 JIM_EXPORT
int Jim_ReplaceHashEntry (Jim_HashTable
*ht
,
672 const void *key
, void *val
);
673 JIM_EXPORT
int Jim_DeleteHashEntry (Jim_HashTable
*ht
,
675 JIM_EXPORT
int Jim_FreeHashTable (Jim_HashTable
*ht
);
676 JIM_EXPORT Jim_HashEntry
* Jim_FindHashEntry (Jim_HashTable
*ht
,
678 JIM_EXPORT
void Jim_ResizeHashTable (Jim_HashTable
*ht
);
679 JIM_EXPORT Jim_HashTableIterator
*Jim_GetHashTableIterator
681 JIM_EXPORT Jim_HashEntry
* Jim_NextHashEntry
682 (Jim_HashTableIterator
*iter
);
685 JIM_EXPORT Jim_Obj
* Jim_NewObj (Jim_Interp
*interp
);
686 JIM_EXPORT
void Jim_FreeObj (Jim_Interp
*interp
, Jim_Obj
*objPtr
);
687 JIM_EXPORT
void Jim_InvalidateStringRep (Jim_Obj
*objPtr
);
688 JIM_EXPORT Jim_Obj
* Jim_DuplicateObj (Jim_Interp
*interp
,
690 JIM_EXPORT
const char * Jim_GetString(Jim_Obj
*objPtr
,
692 JIM_EXPORT
const char *Jim_String(Jim_Obj
*objPtr
);
693 JIM_EXPORT
int Jim_Length(Jim_Obj
*objPtr
);
696 JIM_EXPORT Jim_Obj
* Jim_NewStringObj (Jim_Interp
*interp
,
697 const char *s
, int len
);
698 JIM_EXPORT Jim_Obj
*Jim_NewStringObjUtf8(Jim_Interp
*interp
,
699 const char *s
, int charlen
);
700 JIM_EXPORT Jim_Obj
* Jim_NewStringObjNoAlloc (Jim_Interp
*interp
,
702 JIM_EXPORT
void Jim_AppendString (Jim_Interp
*interp
, Jim_Obj
*objPtr
,
703 const char *str
, int len
);
704 JIM_EXPORT
void Jim_AppendObj (Jim_Interp
*interp
, Jim_Obj
*objPtr
,
705 Jim_Obj
*appendObjPtr
);
706 JIM_EXPORT
void Jim_AppendStrings (Jim_Interp
*interp
,
707 Jim_Obj
*objPtr
, ...);
708 JIM_EXPORT
int Jim_StringEqObj(Jim_Obj
*aObjPtr
, Jim_Obj
*bObjPtr
);
709 JIM_EXPORT
int Jim_StringMatchObj (Jim_Interp
*interp
, Jim_Obj
*patternObjPtr
,
710 Jim_Obj
*objPtr
, int nocase
);
711 JIM_EXPORT Jim_Obj
* Jim_StringRangeObj (Jim_Interp
*interp
,
712 Jim_Obj
*strObjPtr
, Jim_Obj
*firstObjPtr
,
713 Jim_Obj
*lastObjPtr
);
714 JIM_EXPORT Jim_Obj
* Jim_FormatString (Jim_Interp
*interp
,
715 Jim_Obj
*fmtObjPtr
, int objc
, Jim_Obj
*const *objv
);
716 JIM_EXPORT Jim_Obj
* Jim_ScanString (Jim_Interp
*interp
, Jim_Obj
*strObjPtr
,
717 Jim_Obj
*fmtObjPtr
, int flags
);
718 JIM_EXPORT
int Jim_CompareStringImmediate (Jim_Interp
*interp
,
719 Jim_Obj
*objPtr
, const char *str
);
720 JIM_EXPORT
int Jim_StringCompareObj(Jim_Interp
*interp
, Jim_Obj
*firstObjPtr
,
721 Jim_Obj
*secondObjPtr
, int nocase
);
722 JIM_EXPORT
int Jim_StringCompareLenObj(Jim_Interp
*interp
, Jim_Obj
*firstObjPtr
,
723 Jim_Obj
*secondObjPtr
, int nocase
);
724 JIM_EXPORT
int Jim_Utf8Length(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
726 /* reference object */
727 JIM_EXPORT Jim_Obj
* Jim_NewReference (Jim_Interp
*interp
,
728 Jim_Obj
*objPtr
, Jim_Obj
*tagPtr
, Jim_Obj
*cmdNamePtr
);
729 JIM_EXPORT Jim_Reference
* Jim_GetReference (Jim_Interp
*interp
,
731 JIM_EXPORT
int Jim_SetFinalizer (Jim_Interp
*interp
, Jim_Obj
*objPtr
, Jim_Obj
*cmdNamePtr
);
732 JIM_EXPORT
int Jim_GetFinalizer (Jim_Interp
*interp
, Jim_Obj
*objPtr
, Jim_Obj
**cmdNamePtrPtr
);
735 JIM_EXPORT Jim_Interp
* Jim_CreateInterp (void);
736 JIM_EXPORT
void Jim_FreeInterp (Jim_Interp
*i
);
737 JIM_EXPORT
int Jim_GetExitCode (Jim_Interp
*interp
);
738 JIM_EXPORT
const char *Jim_ReturnCode(int code
);
739 JIM_EXPORT
void Jim_SetResultFormatted(Jim_Interp
*interp
, const char *format
, ...);
742 JIM_EXPORT
void Jim_RegisterCoreCommands (Jim_Interp
*interp
);
743 JIM_EXPORT
int Jim_CreateCommand (Jim_Interp
*interp
,
744 const char *cmdName
, Jim_CmdProc cmdProc
, void *privData
,
745 Jim_DelCmdProc delProc
);
746 JIM_EXPORT
int Jim_DeleteCommand (Jim_Interp
*interp
,
747 const char *cmdName
);
748 JIM_EXPORT
int Jim_RenameCommand (Jim_Interp
*interp
,
749 const char *oldName
, const char *newName
);
750 JIM_EXPORT Jim_Cmd
* Jim_GetCommand (Jim_Interp
*interp
,
751 Jim_Obj
*objPtr
, int flags
);
752 JIM_EXPORT
int Jim_SetVariable (Jim_Interp
*interp
,
753 Jim_Obj
*nameObjPtr
, Jim_Obj
*valObjPtr
);
754 JIM_EXPORT
int Jim_SetVariableStr (Jim_Interp
*interp
,
755 const char *name
, Jim_Obj
*objPtr
);
756 JIM_EXPORT
int Jim_SetGlobalVariableStr (Jim_Interp
*interp
,
757 const char *name
, Jim_Obj
*objPtr
);
758 JIM_EXPORT
int Jim_SetVariableStrWithStr (Jim_Interp
*interp
,
759 const char *name
, const char *val
);
760 JIM_EXPORT
int Jim_SetVariableLink (Jim_Interp
*interp
,
761 Jim_Obj
*nameObjPtr
, Jim_Obj
*targetNameObjPtr
,
762 Jim_CallFrame
*targetCallFrame
);
763 JIM_EXPORT
int Jim_CreateNamespaceVariable(Jim_Interp
*interp
,
764 Jim_Obj
*varNameObj
, Jim_Obj
*targetNameObj
);
765 JIM_EXPORT
int Jim_DiscardNamespaceVars(Jim_Interp
*interp
);
766 JIM_EXPORT Jim_Obj
* Jim_GetVariable (Jim_Interp
*interp
,
767 Jim_Obj
*nameObjPtr
, int flags
);
768 JIM_EXPORT Jim_Obj
* Jim_GetGlobalVariable (Jim_Interp
*interp
,
769 Jim_Obj
*nameObjPtr
, int flags
);
770 JIM_EXPORT Jim_Obj
* Jim_GetVariableStr (Jim_Interp
*interp
,
771 const char *name
, int flags
);
772 JIM_EXPORT Jim_Obj
* Jim_GetGlobalVariableStr (Jim_Interp
*interp
,
773 const char *name
, int flags
);
774 JIM_EXPORT
int Jim_UnsetVariable (Jim_Interp
*interp
,
775 Jim_Obj
*nameObjPtr
, int flags
);
778 JIM_EXPORT Jim_CallFrame
*Jim_GetCallFrameByLevel(Jim_Interp
*interp
,
779 Jim_Obj
*levelObjPtr
);
781 /* garbage collection */
782 JIM_EXPORT
int Jim_Collect (Jim_Interp
*interp
);
783 JIM_EXPORT
void Jim_CollectIfNeeded (Jim_Interp
*interp
);
786 JIM_EXPORT
int Jim_GetIndex (Jim_Interp
*interp
, Jim_Obj
*objPtr
,
790 JIM_EXPORT Jim_Obj
* Jim_NewListObj (Jim_Interp
*interp
,
791 Jim_Obj
*const *elements
, int len
);
792 JIM_EXPORT
void Jim_ListInsertElements (Jim_Interp
*interp
,
793 Jim_Obj
*listPtr
, int listindex
, int objc
, Jim_Obj
*const *objVec
);
794 JIM_EXPORT
void Jim_ListAppendElement (Jim_Interp
*interp
,
795 Jim_Obj
*listPtr
, Jim_Obj
*objPtr
);
796 JIM_EXPORT
void Jim_ListAppendList (Jim_Interp
*interp
,
797 Jim_Obj
*listPtr
, Jim_Obj
*appendListPtr
);
798 JIM_EXPORT
int Jim_ListLength (Jim_Interp
*interp
, Jim_Obj
*objPtr
);
799 JIM_EXPORT
int Jim_ListIndex (Jim_Interp
*interp
, Jim_Obj
*listPrt
,
800 int listindex
, Jim_Obj
**objPtrPtr
, int seterr
);
801 JIM_EXPORT Jim_Obj
*Jim_ListGetIndex(Jim_Interp
*interp
, Jim_Obj
*listPtr
, int idx
);
802 JIM_EXPORT
int Jim_SetListIndex (Jim_Interp
*interp
,
803 Jim_Obj
*varNamePtr
, Jim_Obj
*const *indexv
, int indexc
,
805 JIM_EXPORT Jim_Obj
* Jim_ConcatObj (Jim_Interp
*interp
, int objc
,
806 Jim_Obj
*const *objv
);
807 JIM_EXPORT Jim_Obj
*Jim_ListJoin(Jim_Interp
*interp
,
808 Jim_Obj
*listObjPtr
, const char *joinStr
, int joinStrLen
);
811 JIM_EXPORT Jim_Obj
* Jim_NewDictObj (Jim_Interp
*interp
,
812 Jim_Obj
*const *elements
, int len
);
813 JIM_EXPORT
int Jim_DictKey (Jim_Interp
*interp
, Jim_Obj
*dictPtr
,
814 Jim_Obj
*keyPtr
, Jim_Obj
**objPtrPtr
, int flags
);
815 JIM_EXPORT
int Jim_DictKeysVector (Jim_Interp
*interp
,
816 Jim_Obj
*dictPtr
, Jim_Obj
*const *keyv
, int keyc
,
817 Jim_Obj
**objPtrPtr
, int flags
);
818 JIM_EXPORT
int Jim_SetDictKeysVector (Jim_Interp
*interp
,
819 Jim_Obj
*varNamePtr
, Jim_Obj
*const *keyv
, int keyc
,
820 Jim_Obj
*newObjPtr
, int flags
);
821 JIM_EXPORT
int Jim_DictPairs(Jim_Interp
*interp
,
822 Jim_Obj
*dictPtr
, Jim_Obj
***objPtrPtr
, int *len
);
823 JIM_EXPORT
int Jim_DictAddElement(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
824 Jim_Obj
*keyObjPtr
, Jim_Obj
*valueObjPtr
);
825 JIM_EXPORT
int Jim_DictKeys(Jim_Interp
*interp
, Jim_Obj
*objPtr
, Jim_Obj
*patternObj
);
826 JIM_EXPORT
int Jim_DictValues(Jim_Interp
*interp
, Jim_Obj
*dictObjPtr
, Jim_Obj
*patternObjPtr
);
827 JIM_EXPORT
int Jim_DictSize(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
829 /* return code object */
830 JIM_EXPORT
int Jim_GetReturnCode (Jim_Interp
*interp
, Jim_Obj
*objPtr
,
833 /* expression object */
834 JIM_EXPORT
int Jim_EvalExpression (Jim_Interp
*interp
,
835 Jim_Obj
*exprObjPtr
, Jim_Obj
**exprResultPtrPtr
);
836 JIM_EXPORT
int Jim_GetBoolFromExpr (Jim_Interp
*interp
,
837 Jim_Obj
*exprObjPtr
, int *boolPtr
);
840 JIM_EXPORT
int Jim_GetWide (Jim_Interp
*interp
, Jim_Obj
*objPtr
,
842 JIM_EXPORT
int Jim_GetLong (Jim_Interp
*interp
, Jim_Obj
*objPtr
,
844 #define Jim_NewWideObj Jim_NewIntObj
845 JIM_EXPORT Jim_Obj
* Jim_NewIntObj (Jim_Interp
*interp
,
849 JIM_EXPORT
int Jim_GetDouble(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
851 JIM_EXPORT
void Jim_SetDouble(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
853 JIM_EXPORT Jim_Obj
* Jim_NewDoubleObj(Jim_Interp
*interp
, double doubleValue
);
855 /* commands utilities */
856 JIM_EXPORT
void Jim_WrongNumArgs (Jim_Interp
*interp
, int argc
,
857 Jim_Obj
*const *argv
, const char *msg
);
858 JIM_EXPORT
int Jim_GetEnum (Jim_Interp
*interp
, Jim_Obj
*objPtr
,
859 const char * const *tablePtr
, int *indexPtr
, const char *name
, int flags
);
860 JIM_EXPORT
int Jim_ScriptIsComplete (const char *s
, int len
,
863 * Find a matching name in the array of the given length.
865 * NULL entries are ignored.
867 * Returns the matching index if found, or -1 if not.
869 JIM_EXPORT
int Jim_FindByName(const char *name
, const char * const array
[], size_t len
);
871 /* package utilities */
872 typedef void (Jim_InterpDeleteProc
)(Jim_Interp
*interp
, void *data
);
873 JIM_EXPORT
void * Jim_GetAssocData(Jim_Interp
*interp
, const char *key
);
874 JIM_EXPORT
int Jim_SetAssocData(Jim_Interp
*interp
, const char *key
,
875 Jim_InterpDeleteProc
*delProc
, void *data
);
876 JIM_EXPORT
int Jim_DeleteAssocData(Jim_Interp
*interp
, const char *key
);
880 JIM_EXPORT
int Jim_PackageProvide (Jim_Interp
*interp
,
881 const char *name
, const char *ver
, int flags
);
882 JIM_EXPORT
int Jim_PackageRequire (Jim_Interp
*interp
,
883 const char *name
, int flags
);
886 JIM_EXPORT
void Jim_MakeErrorMessage (Jim_Interp
*interp
);
888 /* interactive mode */
889 JIM_EXPORT
int Jim_InteractivePrompt (Jim_Interp
*interp
);
890 JIM_EXPORT
void Jim_HistoryLoad(const char *filename
);
891 JIM_EXPORT
void Jim_HistorySave(const char *filename
);
892 JIM_EXPORT
char *Jim_HistoryGetline(const char *prompt
);
893 JIM_EXPORT
void Jim_HistoryAdd(const char *line
);
894 JIM_EXPORT
void Jim_HistoryShow(void);
897 JIM_EXPORT
int Jim_InitStaticExtensions(Jim_Interp
*interp
);
898 JIM_EXPORT
int Jim_StringToWide(const char *str
, jim_wide
*widePtr
, int base
);
899 JIM_EXPORT
int Jim_IsBigEndian(void);
901 * Returns 1 if a signal has been received while
902 * in a catch -signal {} clause.
904 #define Jim_CheckSignal(i) ((i)->signal_level && (i)->sigmask)
907 JIM_EXPORT
int Jim_LoadLibrary(Jim_Interp
*interp
, const char *pathName
);
908 JIM_EXPORT
void Jim_FreeLoadHandles(Jim_Interp
*interp
);
911 JIM_EXPORT
FILE *Jim_AioFilehandle(Jim_Interp
*interp
, Jim_Obj
*command
);
914 /* type inspection - avoid where possible */
915 JIM_EXPORT
int Jim_IsDict(Jim_Obj
*objPtr
);
916 JIM_EXPORT
int Jim_IsList(Jim_Obj
*objPtr
);
922 #endif /* __JIM__H */
925 * Local Variables: ***
926 * c-basic-offset: 4 ***