1 /* Jim - A small embeddable Tcl interpreter
2 * Copyright 2005 Salvatore Sanfilippo <antirez@invece.org>
3 * Copyright 2005 Clemens Hintze <c.hintze@gmx.net>
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * A copy of the license is also included in the source distribution
12 * of Jim, as a TXT file name called LICENSE.
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
30 #include <stdio.h> /* for the FILE typedef definition */
31 #include <stdlib.h> /* In order to export the Jim_Free() macro */
33 /* -----------------------------------------------------------------------------
34 * Some /very/ old compiler maybe do not know how to
35 * handle 'const'. They even do not know, how to ignore
36 * it. For those compiler it may be better to compile with
37 * define JIM_NO_CONST activated
38 * ---------------------------------------------------------------------------*/
44 /* -----------------------------------------------------------------------------
45 * System configuration
46 * For most modern systems, you can leave the default.
47 * For embedded systems some change may be required.
48 * ---------------------------------------------------------------------------*/
50 #define HAVE_LONG_LONG
52 /* -----------------------------------------------------------------------------
53 * Compiler specific fixes.
54 * ---------------------------------------------------------------------------*/
56 /* MSC has _stricmp instead of strcasecmp */
58 # define strcasecmp _stricmp
61 /* Long Long type and related issues */
63 # ifdef _MSC_VER /* MSC compiler */
64 # define jim_wide _int64
66 # define LLONG_MAX 9223372036854775807I64
69 # define LLONG_MIN (-LLONG_MAX - 1I64)
71 # define JIM_WIDE_MIN LLONG_MIN
72 # define JIM_WIDE_MAX LLONG_MAX
73 # else /* Other compilers (mainly GCC) */
74 # define jim_wide long long
76 # define LLONG_MAX 9223372036854775807LL
79 # define LLONG_MIN (-LLONG_MAX - 1LL)
81 # define JIM_WIDE_MIN LLONG_MIN
82 # define JIM_WIDE_MAX LLONG_MAX
85 # define jim_wide long
86 # define JIM_WIDE_MIN LONG_MIN
87 # define JIM_WIDE_MAX LONG_MAX
90 /* -----------------------------------------------------------------------------
92 * ---------------------------------------------------------------------------*/
95 # if defined(_MSC_VER) || defined(__MSVCRT__)
96 # define JIM_WIDE_MODIFIER "I64d"
98 # define JIM_WIDE_MODIFIER "lld"
101 # define JIM_WIDE_MODIFIER "ld"
104 /* -----------------------------------------------------------------------------
106 * ---------------------------------------------------------------------------*/
108 /* Jim version numbering: every version of jim is marked with a
109 * successive integer number. This is version 0. The first
110 * stable version will be 1, then 2, 3, and so on. */
111 #define JIM_VERSION 51
117 #define JIM_CONTINUE 4
120 #define JIM_MAX_NESTING_DEPTH 10000 /* default max nesting depth */
122 /* Some function get an integer argument with flags to change
124 #define JIM_NONE 0 /* no flags set */
125 #define JIM_ERRMSG 1 /* set an error message in the interpreter. */
127 /* Flags for Jim_SubstObj() */
128 #define JIM_SUBST_NOVAR 1 /* don't perform variables substitutions */
129 #define JIM_SUBST_NOCMD 2 /* don't perform command substitutions */
130 #define JIM_SUBST_NOESC 4 /* don't perform escapes substitutions */
132 /* Unused arguments generate annoying warnings... */
133 #define JIM_NOTUSED(V) ((void) V)
135 /* Flags used by API calls getting a 'nocase' argument. */
136 #define JIM_CASESENS 0 /* case sensitive */
137 #define JIM_NOCASE 1 /* no case */
139 /* Filesystem related */
140 #define JIM_PATH_LEN 1024
142 /* Newline, some embedded system may need -DJIM_CRLF */
144 #define JIM_NL "\r\n"
149 #if defined(__WIN32__) || defined(_WIN32)
150 #define DLLEXPORT __declspec(dllexport)
151 #define DLLIMPORT __declspec(dllimport)
157 /* -----------------------------------------------------------------------------
159 * ---------------------------------------------------------------------------*/
161 typedef struct Jim_Stack {
167 /* -----------------------------------------------------------------------------
169 * ---------------------------------------------------------------------------*/
171 typedef struct Jim_HashEntry {
174 struct Jim_HashEntry *next;
177 typedef struct Jim_HashTableType {
178 unsigned int (*hashFunction)(const void *key);
179 const void *(*keyDup)(void *privdata, const void *key);
180 void *(*valDup)(void *privdata, const void *obj);
181 int (*keyCompare)(void *privdata, const void *key1, const void *key2);
182 void (*keyDestructor)(void *privdata, const void *key);
183 void (*valDestructor)(void *privdata, void *obj);
186 typedef struct Jim_HashTable {
187 Jim_HashEntry **table;
188 Jim_HashTableType *type;
190 unsigned int sizemask;
192 unsigned int collisions;
196 typedef struct Jim_HashTableIterator {
199 Jim_HashEntry *entry, *nextEntry;
200 } Jim_HashTableIterator;
202 /* This is the initial size of every hash table */
203 #define JIM_HT_INITIAL_SIZE 16
205 /* ------------------------------- Macros ------------------------------------*/
206 #define Jim_FreeEntryVal(ht, entry) \
207 if ((ht)->type->valDestructor) \
208 (ht)->type->valDestructor((ht)->privdata, (entry)->val)
210 #define Jim_SetHashVal(ht, entry, _val_) do { \
211 if ((ht)->type->valDup) \
212 entry->val = (ht)->type->valDup((ht)->privdata, _val_); \
214 entry->val = (_val_); \
217 #define Jim_FreeEntryKey(ht, entry) \
218 if ((ht)->type->keyDestructor) \
219 (ht)->type->keyDestructor((ht)->privdata, (entry)->key)
221 #define Jim_SetHashKey(ht, entry, _key_) do { \
222 if ((ht)->type->keyDup) \
223 entry->key = (ht)->type->keyDup((ht)->privdata, _key_); \
225 entry->key = (_key_); \
228 #define Jim_CompareHashKeys(ht, key1, key2) \
229 (((ht)->type->keyCompare) ? \
230 (ht)->type->keyCompare((ht)->privdata, key1, key2) : \
233 #define Jim_HashKey(ht, key) (ht)->type->hashFunction(key)
235 #define Jim_GetHashEntryKey(he) ((he)->key)
236 #define Jim_GetHashEntryVal(he) ((he)->val)
237 #define Jim_GetHashTableCollisions(ht) ((ht)->collisions)
238 #define Jim_GetHashTableSize(ht) ((ht)->size)
239 #define Jim_GetHashTableUsed(ht) ((ht)->used)
241 /* -----------------------------------------------------------------------------
243 * ---------------------------------------------------------------------------*/
245 /* -----------------------------------------------------------------------------
246 * Jim object. This is mostly the same as Tcl_Obj itself,
247 * with the addition of the 'prev' and 'next' pointers.
248 * In Jim all the objects are stored into a linked list for GC purposes,
249 * so that it's possible to access every object living in a given interpreter
250 * sequentially. When an object is freed, it's moved into a different
251 * linked list, used as object pool.
253 * The refcount of a freed object is always -1.
254 * ---------------------------------------------------------------------------*/
255 typedef struct Jim_Obj {
256 int refCount; /* reference count */
257 char *bytes; /* string representation buffer. NULL = no string repr. */
258 int length; /* number of bytes in 'bytes', not including the numterm. */
259 struct Jim_ObjType *typePtr; /* object type. */
260 /* Internal representation union */
262 /* integer number type */
264 /* hashed object type value */
268 /* return code type */
270 /* double number type */
272 /* Generic pointer */
274 /* Generic two pointers value */
279 /* Variable object */
281 unsigned jim_wide callFrameId;
282 struct Jim_Var *varPtr;
286 unsigned jim_wide procEpoch;
287 struct Jim_Cmd *cmdPtr;
291 struct Jim_Obj **ele; /* Elements vector */
292 int len; /* Length */
293 int maxLen; /* Allocated 'ele' length */
302 struct Jim_Reference *refPtr;
306 const char *fileName;
309 /* Dict substitution type */
311 struct Jim_Obj *varNameObjPtr;
312 struct Jim_Obj *indexObjPtr;
314 /* tagged binary type */
320 /* This are 8 or 16 bytes more for every object
321 * but this is required for efficient garbage collection
322 * of Jim references. */
323 struct Jim_Obj *prevObjPtr; /* pointer to the prev object. */
324 struct Jim_Obj *nextObjPtr; /* pointer to the next object. */
327 /* Jim_Obj related macros */
328 #define Jim_IncrRefCount(objPtr) \
330 #define Jim_DecrRefCount(interp, objPtr) \
331 if (--(objPtr)->refCount <= 0) Jim_FreeObj(interp, objPtr)
332 #define Jim_IsShared(objPtr) \
333 ((objPtr)->refCount > 1)
335 /* This macro is used when we allocate a new object using
336 * Jim_New...Obj(), but for some error we need to destroy it.
337 * Instead to use Jim_IncrRefCount() + Jim_DecrRefCount() we
338 * can just call Jim_FreeNewObj. To call Jim_Free directly
339 * seems too raw, the object handling may change and we want
340 * that Jim_FreeNewObj() can be called only against objects
341 * that are belived to have refcount == 0. */
342 #define Jim_FreeNewObj Jim_FreeObj
344 /* Free the internal representation of the object. */
345 #define Jim_FreeIntRep(i,o) \
346 if ((o)->typePtr && (o)->typePtr->freeIntRepProc) \
347 (o)->typePtr->freeIntRepProc(i, o)
349 /* Get the internal representation pointer */
350 #define Jim_GetIntRepPtr(o) (o)->internalRep.ptr
352 /* Set the internal representation pointer */
353 #define Jim_SetIntRepPtr(o, p) \
354 (o)->internalRep.ptr = (p)
356 /* The object type structure.
357 * There are four methods.
359 * - FreeIntRep is used to free the internal representation of the object.
360 * Can be NULL if there is nothing to free.
361 * - DupIntRep is used to duplicate the internal representation of the object.
362 * If NULL, when an object is duplicated, the internalRep union is
363 * directly copied from an object to another.
364 * Note that it's up to the caller to free the old internal repr of the
365 * object before to call the Dup method.
366 * - UpdateString is used to create the string from the internal repr.
367 * - setFromAny is used to convert the current object into one of this type.
372 typedef void (Jim_FreeInternalRepProc)(struct Jim_Interp *interp,
373 struct Jim_Obj *objPtr);
374 typedef void (Jim_DupInternalRepProc)(struct Jim_Interp *interp,
375 struct Jim_Obj *srcPtr, Jim_Obj *dupPtr);
376 typedef void (Jim_UpdateStringProc)(struct Jim_Obj *objPtr);
378 typedef struct Jim_ObjType {
379 const char *name; /* The name of the type. */
380 Jim_FreeInternalRepProc *freeIntRepProc;
381 Jim_DupInternalRepProc *dupIntRepProc;
382 Jim_UpdateStringProc *updateStringProc;
386 /* Jim_ObjType flags */
387 #define JIM_TYPE_NONE 0 /* No flags */
388 #define JIM_TYPE_REFERENCES 1 /* The object may contain referneces. */
390 /* Starting from 1 << 20 flags are reserved for private uses of
391 * different calls. This way the same 'flags' argument may be used
392 * to pass both global flags and private flags. */
393 #define JIM_PRIV_FLAG_SHIFT 20
395 /* -----------------------------------------------------------------------------
396 * Call frame, vars, commands structures
397 * ---------------------------------------------------------------------------*/
400 typedef struct Jim_CallFrame {
401 unsigned jim_wide id; /* Call Frame ID. Used for caching. */
402 struct Jim_HashTable vars; /* Where local vars are stored */
403 struct Jim_HashTable *staticVars; /* pointer to procedure static vars */
404 struct Jim_CallFrame *parentCallFrame;
405 Jim_Obj *const *argv; /* object vector of the current procedure call. */
406 int argc; /* number of args of the current procedure call. */
407 Jim_Obj *procArgsObjPtr; /* arglist object of the running procedure */
408 Jim_Obj *procBodyObjPtr; /* body object of the running procedure */
409 struct Jim_CallFrame *nextFramePtr;
412 /* The var structure. It just holds the pointer of the referenced
413 * object. If linkFramePtr is not NULL the variable is a link
414 * to a variable of name store on objPtr living on the given callframe
415 * (this happens when the [global] or [upvar] command is used).
416 * The interp in order to always know how to free the Jim_Obj associated
417 * with a given variable because In Jim objects memory managment is
418 * bound to interpreters. */
419 typedef struct Jim_Var {
421 struct Jim_CallFrame *linkFramePtr;
424 /* The cmd structure. */
425 typedef int (*Jim_CmdProc)(struct Jim_Interp *interp, int argc,
426 Jim_Obj *const *argv);
427 typedef void (*Jim_DelCmdProc)(struct Jim_Interp *interp, void *privData);
429 /* A command is implemented in C if funcPtr is != NULL, otherwise
430 * it's a Tcl procedure with the arglist and body represented by the
431 * two objects referenced by arglistObjPtr and bodyoObjPtr. */
432 typedef struct Jim_Cmd {
433 Jim_CmdProc cmdProc; /* Not-NULL for a C command. */
434 void *privData; /* Only used for C commands. */
435 Jim_DelCmdProc delProc; /* Called when the command is deleted if != NULL */
436 Jim_Obj *argListObjPtr;
438 Jim_HashTable *staticVars; /* Static vars hash table. NULL if no statics. */
439 int arityMin; /* Min number of arguments. */
440 int arityMax; /* Max number of arguments. */
443 /* Pseudo Random Number Generator State structure */
444 typedef struct Jim_PrngState {
445 unsigned char sbox[256];
449 /* -----------------------------------------------------------------------------
450 * Jim interpreter structure.
451 * Fields similar to the real Tcl interpreter structure have the same names.
452 * ---------------------------------------------------------------------------*/
453 typedef struct Jim_Interp {
454 Jim_Obj *result; /* object returned by the last command called. */
455 int errorLine; /* Error line where an error occurred. */
456 const char *errorFileName; /* Error file where an error occurred. */
457 int numLevels; /* Number of current nested calls. */
458 int maxNestingDepth; /* Used for infinite loop detection. */
459 int returnCode; /* Completion code to return on JIM_RETURN. */
460 int exitCode; /* Code to return to the OS on JIM_EXIT. */
461 Jim_CallFrame *framePtr; /* Pointer to the current call frame */
462 Jim_CallFrame *topFramePtr; /* toplevel/global frame pointer. */
463 struct Jim_HashTable commands; /* Commands hash table */
464 unsigned jim_wide procEpoch; /* Incremented every time the result
465 of procedures names lookup caching
466 may no longer be valid. */
467 unsigned jim_wide callFrameEpoch; /* Incremented every time a new
468 callframe is created. This id is used for the
469 'ID' field contained in the Jim_CallFrame
471 Jim_Obj *liveList; /* Linked list of all the live objects. */
472 Jim_Obj *freeList; /* Linked list of all the unused objects. */
473 const char *scriptFileName; /* File name of the script currently in execution. */
474 Jim_Obj *emptyObj; /* Shared empty string object. */
475 unsigned jim_wide referenceNextId; /* Next id for reference. */
476 struct Jim_HashTable references; /* References hash table. */
477 jim_wide lastCollectId; /* reference max Id of the last GC
478 execution. It's set to -1 while the collection
479 is running as sentinel to avoid to recursive
480 calls via the [collect] command inside
482 time_t lastCollectTime; /* unix time of the last GC execution */
483 struct Jim_HashTable sharedStrings; /* Shared Strings hash table */
484 Jim_Obj *stackTrace; /* Stack trace object. */
485 Jim_Obj *unknown; /* Unknown command cache */
486 int errorFlag; /* Set if an error occurred during execution. */
487 int evalRetcodeLevel; /* Level where the last return with code JIM_EVAL
489 void *cmdPrivData; /* Used to pass the private data pointer to
490 a command. It is set to what the user specified
491 via Jim_CreateCommand(). */
493 struct Jim_HashTable stub; /* Stub hash table to export API */
494 /* Jim_GetApi() function pointer, used to bootstrap the STUB table */
495 int (*getApiFuncPtr)(struct Jim_Interp *, const char *, void *);
496 struct Jim_CallFrame *freeFramesList; /* list of CallFrame structures. */
497 struct Jim_HashTable assocData; /* per-interp storage for use by packages */
498 Jim_PrngState *prngState; /* per interpreter Random Number Gen. state. */
499 struct Jim_HashTable packages; /* Provided packages hash table */
500 FILE *stdin_; /* input file pointer, 'stdin' by default */
501 FILE *stdout_; /* output file pointer, 'stdout' by default */
502 FILE *stderr_; /* errors file pointer, 'stderr' by default */
505 /* Currently provided as macro that performs the increment.
506 * At some point may be a real function doing more work.
507 * The proc epoch is used in order to know when a command lookup
508 * cached can no longer considered valid. */
509 #define Jim_InterpIncrProcEpoch(i) (i)->procEpoch++
510 #define Jim_SetResultString(i,s,l) Jim_SetResult(i, Jim_NewStringObj(i,s,l))
511 #define Jim_SetEmptyResult(i) Jim_SetResult(i, (i)->emptyObj)
512 #define Jim_GetResult(i) ((i)->result)
513 #define Jim_CmdPrivData(i) ((i)->cmdPrivData)
515 /* Note that 'o' is expanded only one time inside this macro,
516 * so it's safe to use side effects. */
517 #define Jim_SetResult(i,o) do { \
518 Jim_Obj *_resultObjPtr_ = (o); \
519 Jim_IncrRefCount(_resultObjPtr_); \
520 Jim_DecrRefCount(i,(i)->result); \
521 (i)->result = _resultObjPtr_; \
524 /* Reference structure. The interpreter pointer is held within privdata member in HashTable */
525 #define JIM_REFERENCE_TAGLEN 7 /* The tag is fixed-length, because the reference
526 string representation must be fixed length. */
527 typedef struct Jim_Reference {
529 Jim_Obj *finalizerCmdNamePtr;
530 char tag[JIM_REFERENCE_TAGLEN+1];
533 /* -----------------------------------------------------------------------------
534 * Exported API prototypes.
535 * ---------------------------------------------------------------------------*/
537 /* Macros that are common for extensions and core. */
538 #define Jim_NewEmptyStringObj(i) Jim_NewStringObj(i, "", 0)
540 /* The core includes real prototypes, extensions instead
541 * include a global function pointer for every function exported.
542 * Once the extension calls Jim_InitExtension(), the global
543 * functon pointers are set to the value of the STUB table
544 * contained in the Jim_Interp structure.
546 * This makes Jim able to load extensions even if it is statically
547 * linked itself, and to load extensions compiled with different
548 * versions of Jim (as long as the API is still compatible.) */
550 /* Macros are common for core and extensions */
551 #define Jim_FreeHashTableIterator(iter) Jim_Free(iter)
554 # if defined JIM_EXTENSION || defined JIM_EMBEDDED
555 # define JIM_API(x) (*x)
558 # define JIM_API(x) (*x)
559 # define JIM_STATIC extern
562 # define JIM_API(x) x
563 # if defined(BUILD_Jim)
564 # define JIM_STATIC DLLEXPORT
566 # define JIM_STATIC static
568 #endif /* __JIM_CORE__ */
570 /* Memory allocation */
571 JIM_STATIC void * JIM_API(Jim_Alloc) (int size);
572 JIM_STATIC void JIM_API(Jim_Free) (void *ptr);
573 JIM_STATIC char * JIM_API(Jim_StrDup) (const char *s);
576 JIM_STATIC int JIM_API(Jim_Eval)(Jim_Interp *interp, const char *script);
577 JIM_STATIC int JIM_API(Jim_EvalGlobal)(Jim_Interp *interp, const char *script);
578 JIM_STATIC int JIM_API(Jim_EvalFile)(Jim_Interp *interp, const char *filename);
579 JIM_STATIC int JIM_API(Jim_EvalObj) (Jim_Interp *interp, Jim_Obj *scriptObjPtr);
580 JIM_STATIC int JIM_API(Jim_EvalObjBackground) (Jim_Interp *interp,
581 Jim_Obj *scriptObjPtr);
582 JIM_STATIC int JIM_API(Jim_EvalObjVector) (Jim_Interp *interp, int objc,
583 Jim_Obj *const *objv);
584 JIM_STATIC int JIM_API(Jim_SubstObj) (Jim_Interp *interp, Jim_Obj *substObjPtr,
585 Jim_Obj **resObjPtrPtr, int flags);
588 JIM_STATIC void JIM_API(Jim_InitStack)(Jim_Stack *stack);
589 JIM_STATIC void JIM_API(Jim_FreeStack)(Jim_Stack *stack);
590 JIM_STATIC int JIM_API(Jim_StackLen)(Jim_Stack *stack);
591 JIM_STATIC void JIM_API(Jim_StackPush)(Jim_Stack *stack, void *element);
592 JIM_STATIC void * JIM_API(Jim_StackPop)(Jim_Stack *stack);
593 JIM_STATIC void * JIM_API(Jim_StackPeek)(Jim_Stack *stack);
594 JIM_STATIC void JIM_API(Jim_FreeStackElements)(Jim_Stack *stack, void (*freeFunc)(void *ptr));
597 JIM_STATIC int JIM_API(Jim_InitHashTable) (Jim_HashTable *ht,
598 Jim_HashTableType *type, void *privdata);
599 JIM_STATIC int JIM_API(Jim_ExpandHashTable) (Jim_HashTable *ht,
601 JIM_STATIC int JIM_API(Jim_AddHashEntry) (Jim_HashTable *ht, const void *key,
603 JIM_STATIC int JIM_API(Jim_ReplaceHashEntry) (Jim_HashTable *ht,
604 const void *key, void *val);
605 JIM_STATIC int JIM_API(Jim_DeleteHashEntry) (Jim_HashTable *ht,
607 JIM_STATIC int JIM_API(Jim_FreeHashTable) (Jim_HashTable *ht);
608 JIM_STATIC Jim_HashEntry * JIM_API(Jim_FindHashEntry) (Jim_HashTable *ht,
610 JIM_STATIC int JIM_API(Jim_ResizeHashTable) (Jim_HashTable *ht);
611 JIM_STATIC Jim_HashTableIterator *JIM_API(Jim_GetHashTableIterator)
613 JIM_STATIC Jim_HashEntry * JIM_API(Jim_NextHashEntry)
614 (Jim_HashTableIterator *iter);
617 JIM_STATIC Jim_Obj * JIM_API(Jim_NewObj) (Jim_Interp *interp);
618 JIM_STATIC void JIM_API(Jim_FreeObj) (Jim_Interp *interp, Jim_Obj *objPtr);
619 JIM_STATIC void JIM_API(Jim_InvalidateStringRep) (Jim_Obj *objPtr);
620 JIM_STATIC void JIM_API(Jim_InitStringRep) (Jim_Obj *objPtr, const char *bytes,
622 JIM_STATIC Jim_Obj * JIM_API(Jim_DuplicateObj) (Jim_Interp *interp,
624 JIM_STATIC const char * JIM_API(Jim_GetString)(Jim_Obj *objPtr,
626 JIM_STATIC int JIM_API(Jim_Length)(Jim_Obj *objPtr);
629 JIM_STATIC Jim_Obj * JIM_API(Jim_NewStringObj) (Jim_Interp *interp,
630 const char *s, int len);
631 JIM_STATIC Jim_Obj * JIM_API(Jim_NewStringObjNoAlloc) (Jim_Interp *interp,
633 JIM_STATIC void JIM_API(Jim_AppendString) (Jim_Interp *interp, Jim_Obj *objPtr,
634 const char *str, int len);
635 JIM_STATIC void JIM_API(Jim_AppendObj) (Jim_Interp *interp, Jim_Obj *objPtr,
636 Jim_Obj *appendObjPtr);
637 JIM_STATIC void JIM_API(Jim_AppendStrings) (Jim_Interp *interp,
638 Jim_Obj *objPtr, ...);
639 JIM_STATIC int JIM_API(Jim_StringEqObj) (Jim_Obj *aObjPtr,
640 Jim_Obj *bObjPtr, int nocase);
641 JIM_STATIC int JIM_API(Jim_StringMatchObj) (Jim_Obj *patternObjPtr,
642 Jim_Obj *objPtr, int nocase);
643 JIM_STATIC Jim_Obj * JIM_API(Jim_StringRangeObj) (Jim_Interp *interp,
644 Jim_Obj *strObjPtr, Jim_Obj *firstObjPtr,
645 Jim_Obj *lastObjPtr);
646 JIM_STATIC Jim_Obj * JIM_API(Jim_FormatString) (Jim_Interp *interp,
647 Jim_Obj *fmtObjPtr, int objc, Jim_Obj *const *objv);
648 JIM_STATIC Jim_Obj * JIM_API(Jim_ScanString) (Jim_Interp *interp, Jim_Obj *strObjPtr,
649 Jim_Obj *fmtObjPtr, int flags);
650 JIM_STATIC int JIM_API(Jim_CompareStringImmediate) (Jim_Interp *interp,
651 Jim_Obj *objPtr, const char *str);
653 /* reference object */
654 JIM_STATIC Jim_Obj * JIM_API(Jim_NewReference) (Jim_Interp *interp,
655 Jim_Obj *objPtr, Jim_Obj *tagPtr, Jim_Obj *cmdNamePtr);
656 JIM_STATIC Jim_Reference * JIM_API(Jim_GetReference) (Jim_Interp *interp,
658 JIM_STATIC int JIM_API(Jim_SetFinalizer) (Jim_Interp *interp, Jim_Obj *objPtr, Jim_Obj *cmdNamePtr);
659 JIM_STATIC int JIM_API(Jim_GetFinalizer) (Jim_Interp *interp, Jim_Obj *objPtr, Jim_Obj **cmdNamePtrPtr);
662 JIM_STATIC Jim_Interp * JIM_API(Jim_CreateInterp) (void);
663 JIM_STATIC void JIM_API(Jim_FreeInterp) (Jim_Interp *i);
664 JIM_STATIC int JIM_API(Jim_GetExitCode) (Jim_Interp *interp);
665 JIM_STATIC FILE * JIM_API(Jim_SetStdin) (Jim_Interp *interp, FILE *fp);
666 JIM_STATIC FILE * JIM_API(Jim_SetStdout) (Jim_Interp *interp, FILE *fp);
667 JIM_STATIC FILE * JIM_API(Jim_SetStderr) (Jim_Interp *interp, FILE *fp);
670 JIM_STATIC void JIM_API(Jim_RegisterCoreCommands) (Jim_Interp *interp);
671 JIM_STATIC int JIM_API(Jim_CreateCommand) (Jim_Interp *interp,
672 const char *cmdName, Jim_CmdProc cmdProc, void *privData,
673 Jim_DelCmdProc delProc);
674 JIM_STATIC int JIM_API(Jim_CreateProcedure) (Jim_Interp *interp,
675 const char *cmdName, Jim_Obj *argListObjPtr, Jim_Obj *staticsListObjPtr,
676 Jim_Obj *bodyObjPtr, int arityMin, int arityMax);
677 JIM_STATIC int JIM_API(Jim_DeleteCommand) (Jim_Interp *interp,
678 const char *cmdName);
679 JIM_STATIC int JIM_API(Jim_RenameCommand) (Jim_Interp *interp,
680 const char *oldName, const char *newName);
681 JIM_STATIC Jim_Cmd * JIM_API(Jim_GetCommand) (Jim_Interp *interp,
682 Jim_Obj *objPtr, int flags);
683 JIM_STATIC int JIM_API(Jim_SetVariable) (Jim_Interp *interp,
684 Jim_Obj *nameObjPtr, Jim_Obj *valObjPtr);
685 JIM_STATIC int JIM_API(Jim_SetVariableStr) (Jim_Interp *interp,
686 const char *name, Jim_Obj *objPtr);
687 JIM_STATIC int JIM_API(Jim_SetGlobalVariableStr) (Jim_Interp *interp,
688 const char *name, Jim_Obj *objPtr);
689 JIM_STATIC int JIM_API(Jim_SetVariableStrWithStr) (Jim_Interp *interp,
690 const char *name, const char *val);
691 JIM_STATIC int JIM_API(Jim_SetVariableLink) (Jim_Interp *interp,
692 Jim_Obj *nameObjPtr, Jim_Obj *targetNameObjPtr,
693 Jim_CallFrame *targetCallFrame);
694 JIM_STATIC Jim_Obj * JIM_API(Jim_GetVariable) (Jim_Interp *interp,
695 Jim_Obj *nameObjPtr, int flags);
696 JIM_STATIC Jim_Obj * JIM_API(Jim_GetGlobalVariable) (Jim_Interp *interp,
697 Jim_Obj *nameObjPtr, int flags);
698 JIM_STATIC Jim_Obj * JIM_API(Jim_GetVariableStr) (Jim_Interp *interp,
699 const char *name, int flags);
700 JIM_STATIC Jim_Obj * JIM_API(Jim_GetGlobalVariableStr) (Jim_Interp *interp,
701 const char *name, int flags);
702 JIM_STATIC int JIM_API(Jim_UnsetVariable) (Jim_Interp *interp,
703 Jim_Obj *nameObjPtr, int flags);
706 JIM_STATIC int JIM_API(Jim_GetCallFrameByLevel) (Jim_Interp *interp,
707 Jim_Obj *levelObjPtr, Jim_CallFrame **framePtrPtr,
710 /* garbage collection */
711 JIM_STATIC int JIM_API(Jim_Collect) (Jim_Interp *interp);
712 JIM_STATIC void JIM_API(Jim_CollectIfNeeded) (Jim_Interp *interp);
715 JIM_STATIC int JIM_API(Jim_GetIndex) (Jim_Interp *interp, Jim_Obj *objPtr,
719 JIM_STATIC Jim_Obj * JIM_API(Jim_NewListObj) (Jim_Interp *interp,
720 Jim_Obj *const *elements, int len);
721 JIM_STATIC void JIM_API(Jim_ListInsertElements) (Jim_Interp *interp,
722 Jim_Obj *listPtr, int index, int objc, Jim_Obj *const *objVec);
723 JIM_STATIC void JIM_API(Jim_ListAppendElement) (Jim_Interp *interp,
724 Jim_Obj *listPtr, Jim_Obj *objPtr);
725 JIM_STATIC void JIM_API(Jim_ListAppendList) (Jim_Interp *interp,
726 Jim_Obj *listPtr, Jim_Obj *appendListPtr);
727 JIM_STATIC void JIM_API(Jim_ListLength) (Jim_Interp *interp, Jim_Obj *listPtr,
729 JIM_STATIC int JIM_API(Jim_ListIndex) (Jim_Interp *interp, Jim_Obj *listPrt,
730 int index, Jim_Obj **objPtrPtr, int seterr);
731 JIM_STATIC int JIM_API(Jim_SetListIndex) (Jim_Interp *interp,
732 Jim_Obj *varNamePtr, Jim_Obj *const *indexv, int indexc,
734 JIM_STATIC Jim_Obj * JIM_API(Jim_ConcatObj) (Jim_Interp *interp, int objc,
735 Jim_Obj *const *objv);
738 JIM_STATIC Jim_Obj * JIM_API(Jim_NewDictObj) (Jim_Interp *interp,
739 Jim_Obj *const *elements, int len);
740 JIM_STATIC int JIM_API(Jim_DictKey) (Jim_Interp *interp, Jim_Obj *dictPtr,
741 Jim_Obj *keyPtr, Jim_Obj **objPtrPtr, int flags);
742 JIM_STATIC int JIM_API(Jim_DictKeysVector) (Jim_Interp *interp,
743 Jim_Obj *dictPtr, Jim_Obj *const *keyv, int keyc,
744 Jim_Obj **objPtrPtr, int flags);
745 JIM_STATIC int JIM_API(Jim_SetDictKeysVector) (Jim_Interp *interp,
746 Jim_Obj *varNamePtr, Jim_Obj *const *keyv, int keyc,
749 /* return code object */
750 JIM_STATIC int JIM_API(Jim_GetReturnCode) (Jim_Interp *interp, Jim_Obj *objPtr,
753 /* expression object */
754 JIM_STATIC int JIM_API(Jim_EvalExpression) (Jim_Interp *interp,
755 Jim_Obj *exprObjPtr, Jim_Obj **exprResultPtrPtr);
756 JIM_STATIC int JIM_API(Jim_GetBoolFromExpr) (Jim_Interp *interp,
757 Jim_Obj *exprObjPtr, int *boolPtr);
760 JIM_STATIC int JIM_API(Jim_GetWide) (Jim_Interp *interp, Jim_Obj *objPtr,
762 JIM_STATIC int JIM_API(Jim_GetLong) (Jim_Interp *interp, Jim_Obj *objPtr,
764 JIM_STATIC void JIM_API(Jim_SetWide) (Jim_Interp *interp, Jim_Obj *objPtr,
766 JIM_STATIC Jim_Obj * JIM_API(Jim_NewIntObj) (Jim_Interp *interp,
770 JIM_STATIC int JIM_API(Jim_GetDouble)(Jim_Interp *interp, Jim_Obj *objPtr,
772 JIM_STATIC void JIM_API(Jim_SetDouble)(Jim_Interp *interp, Jim_Obj *objPtr,
774 JIM_STATIC Jim_Obj * JIM_API(Jim_NewDoubleObj)(Jim_Interp *interp, double doubleValue);
777 JIM_STATIC const char * JIM_API(Jim_GetSharedString) (Jim_Interp *interp,
779 JIM_STATIC void JIM_API(Jim_ReleaseSharedString) (Jim_Interp *interp,
782 /* commands utilities */
783 JIM_STATIC void JIM_API(Jim_WrongNumArgs) (Jim_Interp *interp, int argc,
784 Jim_Obj *const *argv, const char *msg);
785 JIM_STATIC int JIM_API(Jim_GetEnum) (Jim_Interp *interp, Jim_Obj *objPtr,
786 const char **tablePtr, int *indexPtr, const char *name, int flags);
787 JIM_STATIC int JIM_API(Jim_ScriptIsComplete) (const char *s, int len,
790 /* package utilities */
791 typedef void (Jim_InterpDeleteProc)(Jim_Interp *interp, void *data);
792 JIM_STATIC void * JIM_API(Jim_GetAssocData)(Jim_Interp *interp, const char *key);
793 JIM_STATIC int JIM_API(Jim_SetAssocData)(Jim_Interp *interp, const char *key,
794 Jim_InterpDeleteProc *delProc, void *data);
795 JIM_STATIC int JIM_API(Jim_DeleteAssocData)(Jim_Interp *interp, const char *key);
797 /* API import/export functions */
798 JIM_STATIC int JIM_API(Jim_GetApi) (Jim_Interp *interp, const char *funcname,
800 JIM_STATIC int JIM_API(Jim_RegisterApi) (Jim_Interp *interp,
801 const char *funcname, void *funcptr);
804 JIM_STATIC int JIM_API(Jim_PackageProvide) (Jim_Interp *interp,
805 const char *name, const char *ver, int flags);
806 JIM_STATIC const char * JIM_API(Jim_PackageRequire) (Jim_Interp *interp,
807 const char *name, const char *ver, int flags);
810 JIM_STATIC void JIM_API(Jim_PrintErrorMessage) (Jim_Interp *interp);
812 /* interactive mode */
813 JIM_STATIC int JIM_API(Jim_InteractivePrompt) (Jim_Interp *interp);
816 JIM_STATIC void JIM_API(Jim_Panic) (Jim_Interp *interp, const char *fmt, ...);
823 #define JIM_GET_API(name) \
824 Jim_GetApi(interp, "Jim_" #name, ((void *)&Jim_ ## name))
826 #if defined JIM_EXTENSION || defined JIM_EMBEDDED
827 /* This must be included "inline" inside the extension */
828 static void Jim_InitExtension(Jim_Interp *interp)
830 Jim_GetApi = interp->getApiFuncPtr;
835 JIM_GET_API(EvalGlobal);
836 JIM_GET_API(EvalFile);
837 JIM_GET_API(EvalObj);
838 JIM_GET_API(EvalObjBackground);
839 JIM_GET_API(EvalObjVector);
840 JIM_GET_API(InitHashTable);
841 JIM_GET_API(ExpandHashTable);
842 JIM_GET_API(AddHashEntry);
843 JIM_GET_API(ReplaceHashEntry);
844 JIM_GET_API(DeleteHashEntry);
845 JIM_GET_API(FreeHashTable);
846 JIM_GET_API(FindHashEntry);
847 JIM_GET_API(ResizeHashTable);
848 JIM_GET_API(GetHashTableIterator);
849 JIM_GET_API(NextHashEntry);
851 JIM_GET_API(FreeObj);
852 JIM_GET_API(InvalidateStringRep);
853 JIM_GET_API(InitStringRep);
854 JIM_GET_API(DuplicateObj);
855 JIM_GET_API(GetString);
857 JIM_GET_API(InvalidateStringRep);
858 JIM_GET_API(NewStringObj);
859 JIM_GET_API(NewStringObjNoAlloc);
860 JIM_GET_API(AppendString);
861 JIM_GET_API(AppendObj);
862 JIM_GET_API(AppendStrings);
863 JIM_GET_API(StringEqObj);
864 JIM_GET_API(StringMatchObj);
865 JIM_GET_API(StringRangeObj);
866 JIM_GET_API(FormatString);
867 JIM_GET_API(ScanString);
868 JIM_GET_API(CompareStringImmediate);
869 JIM_GET_API(NewReference);
870 JIM_GET_API(GetReference);
871 JIM_GET_API(SetFinalizer);
872 JIM_GET_API(GetFinalizer);
873 JIM_GET_API(CreateInterp);
874 JIM_GET_API(FreeInterp);
875 JIM_GET_API(GetExitCode);
876 JIM_GET_API(SetStdin);
877 JIM_GET_API(SetStdout);
878 JIM_GET_API(SetStderr);
879 JIM_GET_API(CreateCommand);
880 JIM_GET_API(CreateProcedure);
881 JIM_GET_API(DeleteCommand);
882 JIM_GET_API(RenameCommand);
883 JIM_GET_API(GetCommand);
884 JIM_GET_API(SetVariable);
885 JIM_GET_API(SetVariableStr);
886 JIM_GET_API(SetGlobalVariableStr);
887 JIM_GET_API(SetVariableStrWithStr);
888 JIM_GET_API(SetVariableLink);
889 JIM_GET_API(GetVariable);
890 JIM_GET_API(GetCallFrameByLevel);
891 JIM_GET_API(Collect);
892 JIM_GET_API(CollectIfNeeded);
893 JIM_GET_API(GetIndex);
894 JIM_GET_API(NewListObj);
895 JIM_GET_API(ListInsertElements);
896 JIM_GET_API(ListAppendElement);
897 JIM_GET_API(ListAppendList);
898 JIM_GET_API(ListLength);
899 JIM_GET_API(ListIndex);
900 JIM_GET_API(SetListIndex);
901 JIM_GET_API(ConcatObj);
902 JIM_GET_API(NewDictObj);
903 JIM_GET_API(DictKey);
904 JIM_GET_API(DictKeysVector);
905 JIM_GET_API(GetIndex);
906 JIM_GET_API(GetReturnCode);
907 JIM_GET_API(EvalExpression);
908 JIM_GET_API(GetBoolFromExpr);
909 JIM_GET_API(GetWide);
910 JIM_GET_API(GetLong);
911 JIM_GET_API(SetWide);
912 JIM_GET_API(NewIntObj);
913 JIM_GET_API(GetDouble);
914 JIM_GET_API(SetDouble);
915 JIM_GET_API(NewDoubleObj);
916 JIM_GET_API(WrongNumArgs);
917 JIM_GET_API(SetDictKeysVector);
918 JIM_GET_API(SubstObj);
919 JIM_GET_API(RegisterApi);
920 JIM_GET_API(PrintErrorMessage);
921 JIM_GET_API(InteractivePrompt);
922 JIM_GET_API(RegisterCoreCommands);
923 JIM_GET_API(GetSharedString);
924 JIM_GET_API(ReleaseSharedString);
927 JIM_GET_API(UnsetVariable);
928 JIM_GET_API(GetVariableStr);
929 JIM_GET_API(GetGlobalVariable);
930 JIM_GET_API(GetGlobalVariableStr);
931 JIM_GET_API(GetAssocData);
932 JIM_GET_API(SetAssocData);
933 JIM_GET_API(DeleteAssocData);
934 JIM_GET_API(GetEnum);
935 JIM_GET_API(ScriptIsComplete);
936 JIM_GET_API(PackageProvide);
937 JIM_GET_API(PackageRequire);
938 JIM_GET_API(InitStack);
939 JIM_GET_API(FreeStack);
940 JIM_GET_API(StackLen);
941 JIM_GET_API(StackPush);
942 JIM_GET_API(StackPop);
943 JIM_GET_API(StackPeek);
944 JIM_GET_API(FreeStackElements);
946 #endif /* defined JIM_EXTENSION || defined JIM_EMBEDDED */
951 Jim_Interp *ExportedJimCreateInterp(void);
952 static void Jim_InitEmbedded(void) {
953 Jim_Interp *i = ExportedJimCreateInterp();
954 Jim_InitExtension(i);
957 #endif /* JIM_EMBEDDED */
958 #endif /* __JIM_CORE__ */
964 #endif /* __JIM__H */