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.
22 #define JIM_OPTIMIZATION /* comment to avoid optimizations and reduce size */
25 #include <pkgconf/jimtcl.h>
28 #define JIM_DYNLIB /* Dynamic library support for UNIX and WIN32 */
29 #endif /* JIM_ANSIC */
41 /* Include the platform dependent libraries for
42 * dynamic loading of libraries. */
44 #if defined(_WIN32) || defined(WIN32)
49 #define WIN32_LEAN_AND_MEAN
52 #pragma warning(disable:4146)
57 #endif /* JIM_DYNLIB */
60 #include <cyg/jimtcl/jim.h>
69 /* -----------------------------------------------------------------------------
71 * ---------------------------------------------------------------------------*/
73 /* A shared empty string for the objects string representation.
74 * Jim_InvalidateStringRep knows about it and don't try to free. */
75 static char *JimEmptyStringRep = (char*) "";
77 /* -----------------------------------------------------------------------------
78 * Required prototypes of not exported functions
79 * ---------------------------------------------------------------------------*/
80 static void JimChangeCallFrameId(Jim_Interp *interp, Jim_CallFrame *cf);
81 static void JimFreeCallFrame(Jim_Interp *interp, Jim_CallFrame *cf, int flags);
82 static void JimRegisterCoreApi(Jim_Interp *interp);
84 static Jim_HashTableType JimVariablesHashTableType;
86 /* -----------------------------------------------------------------------------
88 * ---------------------------------------------------------------------------*/
91 * Convert a string to a jim_wide INTEGER.
92 * This function originates from BSD.
94 * Ignores `locale' stuff. Assumes that the upper and lower case
95 * alphabets and digits are each contiguous.
98 #define JimIsAscii(c) (((c) & ~0x7f) == 0)
99 static jim_wide JimStrtoll(const char *nptr, char **endptr, register int base)
101 register const char *s;
102 register unsigned jim_wide acc;
103 register unsigned char c;
104 register unsigned jim_wide qbase, cutoff;
105 register int neg, any, cutlim;
108 * Skip white space and pick up leading +/- sign if any.
109 * If base is 0, allow 0x for hex and 0 for octal, else
110 * assume decimal; if base is already 16, allow 0x.
115 } while (isspace(c));
124 if ((base == 0 || base == 16) &&
125 c == '0' && (*s == 'x' || *s == 'X')) {
131 base = c == '0' ? 8 : 10;
134 * Compute the cutoff value between legal numbers and illegal
135 * numbers. That is the largest legal value, divided by the
136 * base. An input number that is greater than this value, if
137 * followed by a legal input character, is too big. One that
138 * is equal to this value may be valid or not; the limit
139 * between valid and invalid numbers is then based on the last
140 * digit. For instance, if the range for quads is
141 * [-9223372036854775808..9223372036854775807] and the input base
142 * is 10, cutoff will be set to 922337203685477580 and cutlim to
143 * either 7 (neg==0) or 8 (neg==1), meaning that if we have
144 * accumulated a value > 922337203685477580, or equal but the
145 * next digit is > 7 (or 8), the number is too big, and we will
146 * return a range error.
148 * Set any if any `digits' consumed; make it negative to indicate
151 qbase = (unsigned)base;
152 cutoff = neg ? (unsigned jim_wide)-(LLONG_MIN + LLONG_MAX) + LLONG_MAX
154 cutlim = (int)(cutoff % qbase);
156 for (acc = 0, any = 0;; c = *s++) {
162 c -= isupper(c) ? 'A' - 10 : 'a' - 10;
167 if (any < 0 || acc > cutoff || (acc == cutoff && c > cutlim))
176 acc = neg ? LLONG_MIN : LLONG_MAX;
181 *endptr = (char *)(any ? s - 1 : nptr);
186 /* Glob-style pattern matching. */
187 static int JimStringMatch(const char *pattern, int patternLen,
188 const char *string, int stringLen, int nocase)
193 while (pattern[1] == '*') {
198 return 1; /* match */
200 if (JimStringMatch(pattern+1, patternLen-1,
201 string, stringLen, nocase))
202 return 1; /* match */
206 return 0; /* no match */
210 return 0; /* no match */
220 not = pattern[0] == '^';
227 if (pattern[0] == '\\') {
230 if (pattern[0] == string[0])
232 } else if (pattern[0] == ']') {
234 } else if (patternLen == 0) {
238 } else if (pattern[1] == '-' && patternLen >= 3) {
239 int start = pattern[0];
240 int end = pattern[2];
248 start = tolower(start);
254 if (c >= start && c <= end)
258 if (pattern[0] == string[0])
261 if (tolower((int)pattern[0]) == tolower((int)string[0]))
271 return 0; /* no match */
277 if (patternLen >= 2) {
284 if (pattern[0] != string[0])
285 return 0; /* no match */
287 if (tolower((int)pattern[0]) != tolower((int)string[0]))
288 return 0; /* no match */
296 if (stringLen == 0) {
297 while(*pattern == '*') {
304 if (patternLen == 0 && stringLen == 0)
309 int JimStringCompare(const char *s1, int l1, const char *s2, int l2,
312 unsigned char *u1 = (unsigned char*) s1, *u2 = (unsigned char*) s2;
318 u1++; u2++; l1--; l2--;
320 if (!l1 && !l2) return 0;
324 if (tolower((int)*u1) != tolower((int)*u2))
325 return tolower((int)*u1)-tolower((int)*u2);
326 u1++; u2++; l1--; l2--;
328 if (!l1 && !l2) return 0;
333 /* Search 's1' inside 's2', starting to search from char 'index' of 's2'.
334 * The index of the first occurrence of s1 in s2 is returned.
335 * If s1 is not found inside s2, -1 is returned. */
336 int JimStringFirst(const char *s1, int l1, const char *s2, int l2, int index)
340 if (!l1 || !l2 || l1 > l2) return -1;
341 if (index < 0) index = 0;
343 for (i = index; i <= l2-l1; i++) {
344 if (memcmp(s2, s1, l1) == 0)
351 int Jim_WideToString(char *buf, jim_wide wideValue)
353 const char *fmt = "%" JIM_WIDE_MODIFIER;
354 return sprintf(buf, fmt, wideValue);
357 int Jim_StringToWide(const char *str, jim_wide *widePtr, int base)
361 #ifdef HAVE_LONG_LONG
362 *widePtr = JimStrtoll(str, &endptr, base);
364 *widePtr = strtol(str, &endptr, base);
366 if ((str[0] == '\0') || (str == endptr) )
368 if (endptr[0] != '\0') {
370 if (!isspace((int)*endptr))
378 int Jim_StringToIndex(const char *str, int *intPtr)
382 *intPtr = strtol(str, &endptr, 10);
383 if ( (str[0] == '\0') || (str == endptr) )
385 if (endptr[0] != '\0') {
387 if (!isspace((int)*endptr))
395 /* The string representation of references has two features in order
396 * to make the GC faster. The first is that every reference starts
397 * with a non common character '~', in order to make the string matching
398 * fater. The second is that the reference string rep his 32 characters
399 * in length, this allows to avoid to check every object with a string
400 * repr < 32, and usually there are many of this objects. */
402 #define JIM_REFERENCE_SPACE (35+JIM_REFERENCE_TAGLEN)
404 static int JimFormatReference(char *buf, Jim_Reference *refPtr, jim_wide id)
406 const char *fmt = "<reference.<%s>.%020" JIM_WIDE_MODIFIER ">";
407 sprintf(buf, fmt, refPtr->tag, id);
408 return JIM_REFERENCE_SPACE;
411 int Jim_DoubleToString(char *buf, double doubleValue)
416 len = sprintf(buf, "%.17g", doubleValue);
419 if (*s == '.') return len;
422 /* Add a final ".0" if it's a number. But not
424 if (isdigit((int)buf[0])
425 || ((buf[0] == '-' || buf[0] == '+')
426 && isdigit((int)buf[1]))) {
435 int Jim_StringToDouble(const char *str, double *doublePtr)
439 *doublePtr = strtod(str, &endptr);
440 if (str[0] == '\0' || endptr[0] != '\0' || (str == endptr) )
445 static jim_wide JimPowWide(jim_wide b, jim_wide e)
448 if ((b==0 && e!=0) || (e<0)) return 0;
449 for(i=0; i<e; i++) {res *= b;}
453 /* -----------------------------------------------------------------------------
455 * ---------------------------------------------------------------------------*/
457 /* Note that 'interp' may be NULL if not available in the
458 * context of the panic. It's only useful to get the error
459 * file descriptor, it will default to stderr otherwise. */
460 void Jim_Panic(Jim_Interp *interp, const char *fmt, ...)
466 * Send it here first.. Assuming STDIO still works
468 fprintf(stderr, JIM_NL "JIM INTERPRETER PANIC: ");
469 vfprintf(stderr, fmt, ap);
470 fprintf(stderr, JIM_NL JIM_NL);
473 #ifdef HAVE_BACKTRACE
479 size = backtrace(array, 40);
480 strings = backtrace_symbols(array, size);
481 for (i = 0; i < size; i++)
482 fprintf(fp,"[backtrace] %s" JIM_NL, strings[i]);
483 fprintf(fp,"[backtrace] Include the above lines and the output" JIM_NL);
484 fprintf(fp,"[backtrace] of 'nm <executable>' in the bug report." JIM_NL);
488 /* This may actually crash... we do it last */
489 if( interp && interp->cookie_stderr ){
490 Jim_fprintf( interp, interp->cookie_stderr, JIM_NL "JIM INTERPRETER PANIC: ");
491 Jim_vfprintf( interp, interp->cookie_stderr, fmt, ap );
492 Jim_fprintf( interp, interp->cookie_stderr, JIM_NL JIM_NL );
497 /* -----------------------------------------------------------------------------
499 * ---------------------------------------------------------------------------*/
501 /* Macro used for memory debugging.
502 * In order for they to work you have to rename Jim_Alloc into _Jim_Alloc
503 * and similary for Jim_Realloc and Jim_Free */
505 #define Jim_Alloc(s) (printf("%s %d: Jim_Alloc(%d)\n",__FILE__,__LINE__,s),_Jim_Alloc(s))
506 #define Jim_Free(p) (printf("%s %d: Jim_Free(%p)\n",__FILE__,__LINE__,p),_Jim_Free(p))
507 #define Jim_Realloc(p,s) (printf("%s %d: Jim_Realloc(%p,%d)\n",__FILE__,__LINE__,p,s),_Jim_Realloc(p,s))
510 void *Jim_Alloc(int size)
512 /* We allocate zero length arrayes, etc. to use a single orthogonal codepath */
515 void *p = malloc(size);
517 Jim_Panic(NULL,"malloc: Out of memory");
521 void Jim_Free(void *ptr) {
525 void *Jim_Realloc(void *ptr, int size)
527 /* We allocate zero length arrayes, etc. to use a single orthogonal codepath */
530 void *p = realloc(ptr, size);
532 Jim_Panic(NULL,"realloc: Out of memory");
536 char *Jim_StrDup(const char *s)
539 char *copy = Jim_Alloc(l+1);
541 memcpy(copy, s, l+1);
545 char *Jim_StrDupLen(const char *s, int l)
547 char *copy = Jim_Alloc(l+1);
549 memcpy(copy, s, l+1);
550 copy[l] = 0; /* Just to be sure, original could be substring */
554 /* -----------------------------------------------------------------------------
555 * Time related functions
556 * ---------------------------------------------------------------------------*/
557 /* Returns microseconds of CPU used since start. */
558 static jim_wide JimClock(void)
560 #if (defined WIN32) && !(defined JIM_ANSIC)
562 QueryPerformanceFrequency(&f);
563 QueryPerformanceCounter(&t);
564 return (long)((t.QuadPart * 1000000) / f.QuadPart);
566 clock_t clocks = clock();
568 return (long)(clocks*(1000000/CLOCKS_PER_SEC));
572 /* -----------------------------------------------------------------------------
574 * ---------------------------------------------------------------------------*/
576 /* -------------------------- private prototypes ---------------------------- */
577 static int JimExpandHashTableIfNeeded(Jim_HashTable *ht);
578 static unsigned int JimHashTableNextPower(unsigned int size);
579 static int JimInsertHashEntry(Jim_HashTable *ht, const void *key);
581 /* -------------------------- hash functions -------------------------------- */
583 /* Thomas Wang's 32 bit Mix Function */
584 unsigned int Jim_IntHashFunction(unsigned int key)
595 /* Identity hash function for integer keys */
596 unsigned int Jim_IdentityHashFunction(unsigned int key)
601 /* Generic hash function (we are using to multiply by 9 and add the byte
603 unsigned int Jim_GenHashFunction(const unsigned char *buf, int len)
611 /* ----------------------------- API implementation ------------------------- */
612 /* reset an hashtable already initialized with ht_init().
613 * NOTE: This function should only called by ht_destroy(). */
614 static void JimResetHashTable(Jim_HashTable *ht)
623 /* Initialize the hash table */
624 int Jim_InitHashTable(Jim_HashTable *ht, Jim_HashTableType *type,
627 JimResetHashTable(ht);
629 ht->privdata = privDataPtr;
633 /* Resize the table to the minimal size that contains all the elements,
634 * but with the invariant of a USER/BUCKETS ration near to <= 1 */
635 int Jim_ResizeHashTable(Jim_HashTable *ht)
637 int minimal = ht->used;
639 if (minimal < JIM_HT_INITIAL_SIZE)
640 minimal = JIM_HT_INITIAL_SIZE;
641 return Jim_ExpandHashTable(ht, minimal);
644 /* Expand or create the hashtable */
645 int Jim_ExpandHashTable(Jim_HashTable *ht, unsigned int size)
647 Jim_HashTable n; /* the new hashtable */
648 unsigned int realsize = JimHashTableNextPower(size), i;
650 /* the size is invalid if it is smaller than the number of
651 * elements already inside the hashtable */
652 if (ht->used >= size)
655 Jim_InitHashTable(&n, ht->type, ht->privdata);
657 n.sizemask = realsize-1;
658 n.table = Jim_Alloc(realsize*sizeof(Jim_HashEntry*));
660 /* Initialize all the pointers to NULL */
661 memset(n.table, 0, realsize*sizeof(Jim_HashEntry*));
663 /* Copy all the elements from the old to the new table:
664 * note that if the old hash table is empty ht->size is zero,
665 * so Jim_ExpandHashTable just creates an hash table. */
667 for (i = 0; i < ht->size && ht->used > 0; i++) {
668 Jim_HashEntry *he, *nextHe;
670 if (ht->table[i] == NULL) continue;
672 /* For each hash entry on this slot... */
678 /* Get the new element index */
679 h = Jim_HashKey(ht, he->key) & n.sizemask;
680 he->next = n.table[h];
683 /* Pass to the next element */
687 assert(ht->used == 0);
690 /* Remap the new hashtable in the old */
695 /* Add an element to the target hash table */
696 int Jim_AddHashEntry(Jim_HashTable *ht, const void *key, void *val)
699 Jim_HashEntry *entry;
701 /* Get the index of the new element, or -1 if
702 * the element already exists. */
703 if ((index = JimInsertHashEntry(ht, key)) == -1)
706 /* Allocates the memory and stores key */
707 entry = Jim_Alloc(sizeof(*entry));
708 entry->next = ht->table[index];
709 ht->table[index] = entry;
711 /* Set the hash entry fields. */
712 Jim_SetHashKey(ht, entry, key);
713 Jim_SetHashVal(ht, entry, val);
718 /* Add an element, discarding the old if the key already exists */
719 int Jim_ReplaceHashEntry(Jim_HashTable *ht, const void *key, void *val)
721 Jim_HashEntry *entry;
723 /* Try to add the element. If the key
724 * does not exists Jim_AddHashEntry will suceed. */
725 if (Jim_AddHashEntry(ht, key, val) == JIM_OK)
727 /* It already exists, get the entry */
728 entry = Jim_FindHashEntry(ht, key);
729 /* Free the old value and set the new one */
730 Jim_FreeEntryVal(ht, entry);
731 Jim_SetHashVal(ht, entry, val);
735 /* Search and remove an element */
736 int Jim_DeleteHashEntry(Jim_HashTable *ht, const void *key)
739 Jim_HashEntry *he, *prevHe;
743 h = Jim_HashKey(ht, key) & ht->sizemask;
748 if (Jim_CompareHashKeys(ht, key, he->key)) {
749 /* Unlink the element from the list */
751 prevHe->next = he->next;
753 ht->table[h] = he->next;
754 Jim_FreeEntryKey(ht, he);
755 Jim_FreeEntryVal(ht, he);
763 return JIM_ERR; /* not found */
766 /* Destroy an entire hash table */
767 int Jim_FreeHashTable(Jim_HashTable *ht)
771 /* Free all the elements */
772 for (i = 0; i < ht->size && ht->used > 0; i++) {
773 Jim_HashEntry *he, *nextHe;
775 if ((he = ht->table[i]) == NULL) continue;
778 Jim_FreeEntryKey(ht, he);
779 Jim_FreeEntryVal(ht, he);
785 /* Free the table and the allocated cache structure */
787 /* Re-initialize the table */
788 JimResetHashTable(ht);
789 return JIM_OK; /* never fails */
792 Jim_HashEntry *Jim_FindHashEntry(Jim_HashTable *ht, const void *key)
797 if (ht->size == 0) return NULL;
798 h = Jim_HashKey(ht, key) & ht->sizemask;
801 if (Jim_CompareHashKeys(ht, key, he->key))
808 Jim_HashTableIterator *Jim_GetHashTableIterator(Jim_HashTable *ht)
810 Jim_HashTableIterator *iter = Jim_Alloc(sizeof(*iter));
815 iter->nextEntry = NULL;
819 Jim_HashEntry *Jim_NextHashEntry(Jim_HashTableIterator *iter)
822 if (iter->entry == NULL) {
825 (signed)iter->ht->size) break;
826 iter->entry = iter->ht->table[iter->index];
828 iter->entry = iter->nextEntry;
831 /* We need to save the 'next' here, the iterator user
832 * may delete the entry we are returning. */
833 iter->nextEntry = iter->entry->next;
840 /* ------------------------- private functions ------------------------------ */
842 /* Expand the hash table if needed */
843 static int JimExpandHashTableIfNeeded(Jim_HashTable *ht)
845 /* If the hash table is empty expand it to the intial size,
846 * if the table is "full" dobule its size. */
848 return Jim_ExpandHashTable(ht, JIM_HT_INITIAL_SIZE);
849 if (ht->size == ht->used)
850 return Jim_ExpandHashTable(ht, ht->size*2);
854 /* Our hash table capability is a power of two */
855 static unsigned int JimHashTableNextPower(unsigned int size)
857 unsigned int i = JIM_HT_INITIAL_SIZE;
859 if (size >= 2147483648U)
868 /* Returns the index of a free slot that can be populated with
869 * an hash entry for the given 'key'.
870 * If the key already exists, -1 is returned. */
871 static int JimInsertHashEntry(Jim_HashTable *ht, const void *key)
876 /* Expand the hashtable if needed */
877 if (JimExpandHashTableIfNeeded(ht) == JIM_ERR)
879 /* Compute the key hash value */
880 h = Jim_HashKey(ht, key) & ht->sizemask;
881 /* Search if this slot does not already contain the given key */
884 if (Jim_CompareHashKeys(ht, key, he->key))
891 /* ----------------------- StringCopy Hash Table Type ------------------------*/
893 static unsigned int JimStringCopyHTHashFunction(const void *key)
895 return Jim_GenHashFunction(key, strlen(key));
898 static const void *JimStringCopyHTKeyDup(void *privdata, const void *key)
900 int len = strlen(key);
901 char *copy = Jim_Alloc(len+1);
902 JIM_NOTUSED(privdata);
904 memcpy(copy, key, len);
909 static void *JimStringKeyValCopyHTValDup(void *privdata, const void *val)
911 int len = strlen(val);
912 char *copy = Jim_Alloc(len+1);
913 JIM_NOTUSED(privdata);
915 memcpy(copy, val, len);
920 static int JimStringCopyHTKeyCompare(void *privdata, const void *key1,
923 JIM_NOTUSED(privdata);
925 return strcmp(key1, key2) == 0;
928 static void JimStringCopyHTKeyDestructor(void *privdata, const void *key)
930 JIM_NOTUSED(privdata);
932 Jim_Free((void*)key); /* ATTENTION: const cast */
935 static void JimStringKeyValCopyHTValDestructor(void *privdata, void *val)
937 JIM_NOTUSED(privdata);
939 Jim_Free((void*)val); /* ATTENTION: const cast */
942 static Jim_HashTableType JimStringCopyHashTableType = {
943 JimStringCopyHTHashFunction, /* hash function */
944 JimStringCopyHTKeyDup, /* key dup */
946 JimStringCopyHTKeyCompare, /* key compare */
947 JimStringCopyHTKeyDestructor, /* key destructor */
948 NULL /* val destructor */
951 /* This is like StringCopy but does not auto-duplicate the key.
952 * It's used for intepreter's shared strings. */
953 static Jim_HashTableType JimSharedStringsHashTableType = {
954 JimStringCopyHTHashFunction, /* hash function */
957 JimStringCopyHTKeyCompare, /* key compare */
958 JimStringCopyHTKeyDestructor, /* key destructor */
959 NULL /* val destructor */
962 /* This is like StringCopy but also automatically handle dynamic
963 * allocated C strings as values. */
964 static Jim_HashTableType JimStringKeyValCopyHashTableType = {
965 JimStringCopyHTHashFunction, /* hash function */
966 JimStringCopyHTKeyDup, /* key dup */
967 JimStringKeyValCopyHTValDup, /* val dup */
968 JimStringCopyHTKeyCompare, /* key compare */
969 JimStringCopyHTKeyDestructor, /* key destructor */
970 JimStringKeyValCopyHTValDestructor, /* val destructor */
973 typedef struct AssocDataValue {
974 Jim_InterpDeleteProc *delProc;
978 static void JimAssocDataHashTableValueDestructor(void *privdata, void *data)
980 AssocDataValue *assocPtr = (AssocDataValue *)data;
981 if (assocPtr->delProc != NULL)
982 assocPtr->delProc((Jim_Interp *)privdata, assocPtr->data);
986 static Jim_HashTableType JimAssocDataHashTableType = {
987 JimStringCopyHTHashFunction, /* hash function */
988 JimStringCopyHTKeyDup, /* key dup */
990 JimStringCopyHTKeyCompare, /* key compare */
991 JimStringCopyHTKeyDestructor, /* key destructor */
992 JimAssocDataHashTableValueDestructor /* val destructor */
995 /* -----------------------------------------------------------------------------
996 * Stack - This is a simple generic stack implementation. It is used for
997 * example in the 'expr' expression compiler.
998 * ---------------------------------------------------------------------------*/
999 void Jim_InitStack(Jim_Stack *stack)
1003 stack->vector = NULL;
1006 void Jim_FreeStack(Jim_Stack *stack)
1008 Jim_Free(stack->vector);
1011 int Jim_StackLen(Jim_Stack *stack)
1016 void Jim_StackPush(Jim_Stack *stack, void *element) {
1017 int neededLen = stack->len+1;
1018 if (neededLen > stack->maxlen) {
1019 stack->maxlen = neededLen*2;
1020 stack->vector = Jim_Realloc(stack->vector, sizeof(void*)*stack->maxlen);
1022 stack->vector[stack->len] = element;
1026 void *Jim_StackPop(Jim_Stack *stack)
1028 if (stack->len == 0) return NULL;
1030 return stack->vector[stack->len];
1033 void *Jim_StackPeek(Jim_Stack *stack)
1035 if (stack->len == 0) return NULL;
1036 return stack->vector[stack->len-1];
1039 void Jim_FreeStackElements(Jim_Stack *stack, void (*freeFunc)(void *ptr))
1043 for (i = 0; i < stack->len; i++)
1044 freeFunc(stack->vector[i]);
1047 /* -----------------------------------------------------------------------------
1049 * ---------------------------------------------------------------------------*/
1052 #define JIM_TT_NONE -1 /* No token returned */
1053 #define JIM_TT_STR 0 /* simple string */
1054 #define JIM_TT_ESC 1 /* string that needs escape chars conversion */
1055 #define JIM_TT_VAR 2 /* var substitution */
1056 #define JIM_TT_DICTSUGAR 3 /* Syntax sugar for [dict get], $foo(bar) */
1057 #define JIM_TT_CMD 4 /* command substitution */
1058 #define JIM_TT_SEP 5 /* word separator */
1059 #define JIM_TT_EOL 6 /* line separator */
1061 /* Additional token types needed for expressions */
1062 #define JIM_TT_SUBEXPR_START 7
1063 #define JIM_TT_SUBEXPR_END 8
1064 #define JIM_TT_EXPR_NUMBER 9
1065 #define JIM_TT_EXPR_OPERATOR 10
1068 #define JIM_PS_DEF 0 /* Default state */
1069 #define JIM_PS_QUOTE 1 /* Inside "" */
1071 /* Parser context structure. The same context is used both to parse
1072 * Tcl scripts and lists. */
1073 struct JimParserCtx {
1074 const char *prg; /* Program text */
1075 const char *p; /* Pointer to the point of the program we are parsing */
1076 int len; /* Left length of 'prg' */
1077 int linenr; /* Current line number */
1079 const char *tend; /* Returned token is at tstart-tend in 'prg'. */
1080 int tline; /* Line number of the returned token */
1081 int tt; /* Token type */
1082 int eof; /* Non zero if EOF condition is true. */
1083 int state; /* Parser state */
1084 int comment; /* Non zero if the next chars may be a comment. */
1087 #define JimParserEof(c) ((c)->eof)
1088 #define JimParserTstart(c) ((c)->tstart)
1089 #define JimParserTend(c) ((c)->tend)
1090 #define JimParserTtype(c) ((c)->tt)
1091 #define JimParserTline(c) ((c)->tline)
1093 static int JimParseScript(struct JimParserCtx *pc);
1094 static int JimParseSep(struct JimParserCtx *pc);
1095 static int JimParseEol(struct JimParserCtx *pc);
1096 static int JimParseCmd(struct JimParserCtx *pc);
1097 static int JimParseVar(struct JimParserCtx *pc);
1098 static int JimParseBrace(struct JimParserCtx *pc);
1099 static int JimParseStr(struct JimParserCtx *pc);
1100 static int JimParseComment(struct JimParserCtx *pc);
1101 static char *JimParserGetToken(struct JimParserCtx *pc,
1102 int *lenPtr, int *typePtr, int *linePtr);
1104 /* Initialize a parser context.
1105 * 'prg' is a pointer to the program text, linenr is the line
1106 * number of the first line contained in the program. */
1107 void JimParserInit(struct JimParserCtx *pc, const char *prg,
1108 int len, int linenr)
1116 pc->tt = JIM_TT_NONE;
1118 pc->state = JIM_PS_DEF;
1119 pc->linenr = linenr;
1123 int JimParseScript(struct JimParserCtx *pc)
1125 while(1) { /* the while is used to reiterate with continue if needed */
1129 pc->tline = pc->linenr;
1130 pc->tt = JIM_TT_EOL;
1136 if (*(pc->p+1) == '\n')
1137 return JimParseSep(pc);
1140 return JimParseStr(pc);
1146 if (pc->state == JIM_PS_DEF)
1147 return JimParseSep(pc);
1150 return JimParseStr(pc);
1156 if (pc->state == JIM_PS_DEF)
1157 return JimParseEol(pc);
1159 return JimParseStr(pc);
1163 return JimParseCmd(pc);
1167 if (JimParseVar(pc) == JIM_ERR) {
1168 pc->tstart = pc->tend = pc->p++; pc->len--;
1169 pc->tline = pc->linenr;
1170 pc->tt = JIM_TT_STR;
1177 JimParseComment(pc);
1180 return JimParseStr(pc);
1184 return JimParseStr(pc);
1191 int JimParseSep(struct JimParserCtx *pc)
1194 pc->tline = pc->linenr;
1195 while (*pc->p == ' ' || *pc->p == '\t' || *pc->p == '\r' ||
1196 (*pc->p == '\\' && *(pc->p+1) == '\n')) {
1197 if (*pc->p == '\\') {
1204 pc->tt = JIM_TT_SEP;
1208 int JimParseEol(struct JimParserCtx *pc)
1211 pc->tline = pc->linenr;
1212 while (*pc->p == ' ' || *pc->p == '\n' ||
1213 *pc->p == '\t' || *pc->p == '\r' || *pc->p == ';') {
1219 pc->tt = JIM_TT_EOL;
1223 /* Todo. Don't stop if ']' appears inside {} or quoted.
1224 * Also should handle the case of puts [string length "]"] */
1225 int JimParseCmd(struct JimParserCtx *pc)
1230 pc->tstart = ++pc->p; pc->len--;
1231 pc->tline = pc->linenr;
1235 } else if (*pc->p == '[' && blevel == 0) {
1237 } else if (*pc->p == ']' && blevel == 0) {
1240 } else if (*pc->p == '\\') {
1242 } else if (*pc->p == '{') {
1244 } else if (*pc->p == '}') {
1247 } else if (*pc->p == '\n')
1252 pc->tt = JIM_TT_CMD;
1253 if (*pc->p == ']') {
1259 int JimParseVar(struct JimParserCtx *pc)
1261 int brace = 0, stop = 0, ttype = JIM_TT_VAR;
1263 pc->tstart = ++pc->p; pc->len--; /* skip the $ */
1264 pc->tline = pc->linenr;
1265 if (*pc->p == '{') {
1266 pc->tstart = ++pc->p; pc->len--;
1271 if (*pc->p == '}' || pc->len == 0) {
1276 else if (*pc->p == '\n')
1286 if (!((*pc->p >= 'a' && *pc->p <= 'z') ||
1287 (*pc->p >= 'A' && *pc->p <= 'Z') ||
1288 (*pc->p >= '0' && *pc->p <= '9') || *pc->p == '_'))
1294 /* Parse [dict get] syntax sugar. */
1295 if (*pc->p == '(') {
1296 while (*pc->p != ')' && pc->len) {
1298 if (*pc->p == '\\' && pc->len >= 2) {
1299 pc->p += 2; pc->len -= 2;
1302 if (*pc->p != '\0') {
1305 ttype = JIM_TT_DICTSUGAR;
1309 /* Check if we parsed just the '$' character.
1310 * That's not a variable so an error is returned
1311 * to tell the state machine to consider this '$' just
1313 if (pc->tstart == pc->p) {
1321 int JimParseBrace(struct JimParserCtx *pc)
1325 pc->tstart = ++pc->p; pc->len--;
1326 pc->tline = pc->linenr;
1328 if (*pc->p == '\\' && pc->len >= 2) {
1332 } else if (*pc->p == '{') {
1334 } else if (pc->len == 0 || *pc->p == '}') {
1336 if (pc->len == 0 || level == 0) {
1341 pc->tt = JIM_TT_STR;
1344 } else if (*pc->p == '\n') {
1349 return JIM_OK; /* unreached */
1352 int JimParseStr(struct JimParserCtx *pc)
1354 int newword = (pc->tt == JIM_TT_SEP || pc->tt == JIM_TT_EOL ||
1355 pc->tt == JIM_TT_NONE || pc->tt == JIM_TT_STR);
1356 if (newword && *pc->p == '{') {
1357 return JimParseBrace(pc);
1358 } else if (newword && *pc->p == '"') {
1359 pc->state = JIM_PS_QUOTE;
1363 pc->tline = pc->linenr;
1367 pc->tt = JIM_TT_ESC;
1372 if (pc->state == JIM_PS_DEF &&
1373 *(pc->p+1) == '\n') {
1375 pc->tt = JIM_TT_ESC;
1385 pc->tt = JIM_TT_ESC;
1392 if (pc->state == JIM_PS_DEF) {
1394 pc->tt = JIM_TT_ESC;
1396 } else if (*pc->p == '\n') {
1401 if (pc->state == JIM_PS_QUOTE) {
1403 pc->tt = JIM_TT_ESC;
1405 pc->state = JIM_PS_DEF;
1412 return JIM_OK; /* unreached */
1415 int JimParseComment(struct JimParserCtx *pc)
1418 if (*pc->p == '\n') {
1420 if (*(pc->p-1) != '\\') {
1430 /* xdigitval and odigitval are helper functions for JimParserGetToken() */
1431 static int xdigitval(int c)
1433 if (c >= '0' && c <= '9') return c-'0';
1434 if (c >= 'a' && c <= 'f') return c-'a'+10;
1435 if (c >= 'A' && c <= 'F') return c-'A'+10;
1439 static int odigitval(int c)
1441 if (c >= '0' && c <= '7') return c-'0';
1445 /* Perform Tcl escape substitution of 's', storing the result
1446 * string into 'dest'. The escaped string is guaranteed to
1447 * be the same length or shorted than the source string.
1448 * Slen is the length of the string at 's', if it's -1 the string
1449 * length will be calculated by the function.
1451 * The function returns the length of the resulting string. */
1452 static int JimEscape(char *dest, const char *s, int slen)
1460 for (i = 0; i < slen; i++) {
1464 case 'a': *p++ = 0x7; i++; break;
1465 case 'b': *p++ = 0x8; i++; break;
1466 case 'f': *p++ = 0xc; i++; break;
1467 case 'n': *p++ = 0xa; i++; break;
1468 case 'r': *p++ = 0xd; i++; break;
1469 case 't': *p++ = 0x9; i++; break;
1470 case 'v': *p++ = 0xb; i++; break;
1471 case '\0': *p++ = '\\'; i++; break;
1472 case '\n': *p++ = ' '; i++; break;
1474 if (s[i+1] == 'x') {
1476 int c = xdigitval(s[i+2]);
1483 c = xdigitval(s[i+3]);
1493 } else if (s[i+1] >= '0' && s[i+1] <= '7')
1496 int c = odigitval(s[i+1]);
1498 c = odigitval(s[i+2]);
1505 c = odigitval(s[i+3]);
1531 /* Returns a dynamically allocated copy of the current token in the
1532 * parser context. The function perform conversion of escapes if
1533 * the token is of type JIM_TT_ESC.
1535 * Note that after the conversion, tokens that are grouped with
1536 * braces in the source code, are always recognizable from the
1537 * identical string obtained in a different way from the type.
1539 * For exmple the string:
1543 * will return as first token "expand", of type JIM_TT_STR
1549 * will return as first token "expand", of type JIM_TT_ESC
1551 char *JimParserGetToken(struct JimParserCtx *pc,
1552 int *lenPtr, int *typePtr, int *linePtr)
1554 const char *start, *end;
1558 start = JimParserTstart(pc);
1559 end = JimParserTend(pc);
1561 if (lenPtr) *lenPtr = 0;
1562 if (typePtr) *typePtr = JimParserTtype(pc);
1563 if (linePtr) *linePtr = JimParserTline(pc);
1564 token = Jim_Alloc(1);
1568 len = (end-start)+1;
1569 token = Jim_Alloc(len+1);
1570 if (JimParserTtype(pc) != JIM_TT_ESC) {
1571 /* No escape conversion needed? Just copy it. */
1572 memcpy(token, start, len);
1575 /* Else convert the escape chars. */
1576 len = JimEscape(token, start, len);
1578 if (lenPtr) *lenPtr = len;
1579 if (typePtr) *typePtr = JimParserTtype(pc);
1580 if (linePtr) *linePtr = JimParserTline(pc);
1584 /* The following functin is not really part of the parsing engine of Jim,
1585 * but it somewhat related. Given an string and its length, it tries
1586 * to guess if the script is complete or there are instead " " or { }
1587 * open and not completed. This is useful for interactive shells
1588 * implementation and for [info complete].
1590 * If 'stateCharPtr' != NULL, the function stores ' ' on complete script,
1591 * '{' on scripts incomplete missing one or more '}' to be balanced.
1592 * '"' on scripts incomplete missing a '"' char.
1594 * If the script is complete, 1 is returned, otherwise 0. */
1595 int Jim_ScriptIsComplete(const char *s, int len, char *stateCharPtr)
1609 } else if (state == '"') {
1616 } else if (state == ' ') {
1633 *stateCharPtr = state;
1634 return state == ' ';
1637 /* -----------------------------------------------------------------------------
1639 * ---------------------------------------------------------------------------*/
1640 static int JimParseListSep(struct JimParserCtx *pc);
1641 static int JimParseListStr(struct JimParserCtx *pc);
1643 int JimParseList(struct JimParserCtx *pc)
1646 pc->tstart = pc->tend = pc->p;
1647 pc->tline = pc->linenr;
1648 pc->tt = JIM_TT_EOL;
1657 if (pc->state == JIM_PS_DEF)
1658 return JimParseListSep(pc);
1660 return JimParseListStr(pc);
1663 return JimParseListStr(pc);
1669 int JimParseListSep(struct JimParserCtx *pc)
1672 pc->tline = pc->linenr;
1673 while (*pc->p == ' ' || *pc->p == '\t' || *pc->p == '\r' || *pc->p == '\n')
1678 pc->tt = JIM_TT_SEP;
1682 int JimParseListStr(struct JimParserCtx *pc)
1684 int newword = (pc->tt == JIM_TT_SEP || pc->tt == JIM_TT_EOL ||
1685 pc->tt == JIM_TT_NONE);
1686 if (newword && *pc->p == '{') {
1687 return JimParseBrace(pc);
1688 } else if (newword && *pc->p == '"') {
1689 pc->state = JIM_PS_QUOTE;
1693 pc->tline = pc->linenr;
1697 pc->tt = JIM_TT_ESC;
1708 if (pc->state == JIM_PS_DEF) {
1710 pc->tt = JIM_TT_ESC;
1712 } else if (*pc->p == '\n') {
1717 if (pc->state == JIM_PS_QUOTE) {
1719 pc->tt = JIM_TT_ESC;
1721 pc->state = JIM_PS_DEF;
1728 return JIM_OK; /* unreached */
1731 /* -----------------------------------------------------------------------------
1732 * Jim_Obj related functions
1733 * ---------------------------------------------------------------------------*/
1735 /* Return a new initialized object. */
1736 Jim_Obj *Jim_NewObj(Jim_Interp *interp)
1740 /* -- Check if there are objects in the free list -- */
1741 if (interp->freeList != NULL) {
1742 /* -- Unlink the object from the free list -- */
1743 objPtr = interp->freeList;
1744 interp->freeList = objPtr->nextObjPtr;
1746 /* -- No ready to use objects: allocate a new one -- */
1747 objPtr = Jim_Alloc(sizeof(*objPtr));
1750 /* Object is returned with refCount of 0. Every
1751 * kind of GC implemented should take care to don't try
1752 * to scan objects with refCount == 0. */
1753 objPtr->refCount = 0;
1754 /* All the other fields are left not initialized to save time.
1755 * The caller will probably want set they to the right
1758 /* -- Put the object into the live list -- */
1759 objPtr->prevObjPtr = NULL;
1760 objPtr->nextObjPtr = interp->liveList;
1761 if (interp->liveList)
1762 interp->liveList->prevObjPtr = objPtr;
1763 interp->liveList = objPtr;
1768 /* Free an object. Actually objects are never freed, but
1769 * just moved to the free objects list, where they will be
1770 * reused by Jim_NewObj(). */
1771 void Jim_FreeObj(Jim_Interp *interp, Jim_Obj *objPtr)
1773 /* Check if the object was already freed, panic. */
1774 if (objPtr->refCount != 0) {
1775 Jim_Panic(interp,"!!!Object %p freed with bad refcount %d", objPtr,
1778 /* Free the internal representation */
1779 Jim_FreeIntRep(interp, objPtr);
1780 /* Free the string representation */
1781 if (objPtr->bytes != NULL) {
1782 if (objPtr->bytes != JimEmptyStringRep)
1783 Jim_Free(objPtr->bytes);
1785 /* Unlink the object from the live objects list */
1786 if (objPtr->prevObjPtr)
1787 objPtr->prevObjPtr->nextObjPtr = objPtr->nextObjPtr;
1788 if (objPtr->nextObjPtr)
1789 objPtr->nextObjPtr->prevObjPtr = objPtr->prevObjPtr;
1790 if (interp->liveList == objPtr)
1791 interp->liveList = objPtr->nextObjPtr;
1792 /* Link the object into the free objects list */
1793 objPtr->prevObjPtr = NULL;
1794 objPtr->nextObjPtr = interp->freeList;
1795 if (interp->freeList)
1796 interp->freeList->prevObjPtr = objPtr;
1797 interp->freeList = objPtr;
1798 objPtr->refCount = -1;
1801 /* Invalidate the string representation of an object. */
1802 void Jim_InvalidateStringRep(Jim_Obj *objPtr)
1804 if (objPtr->bytes != NULL) {
1805 if (objPtr->bytes != JimEmptyStringRep)
1806 Jim_Free(objPtr->bytes);
1808 objPtr->bytes = NULL;
1811 #define Jim_SetStringRep(o, b, l) \
1812 do { (o)->bytes = b; (o)->length = l; } while (0)
1814 /* Set the initial string representation for an object.
1815 * Does not try to free an old one. */
1816 void Jim_InitStringRep(Jim_Obj *objPtr, const char *bytes, int length)
1819 objPtr->bytes = JimEmptyStringRep;
1822 objPtr->bytes = Jim_Alloc(length+1);
1823 objPtr->length = length;
1824 memcpy(objPtr->bytes, bytes, length);
1825 objPtr->bytes[length] = '\0';
1829 /* Duplicate an object. The returned object has refcount = 0. */
1830 Jim_Obj *Jim_DuplicateObj(Jim_Interp *interp, Jim_Obj *objPtr)
1834 dupPtr = Jim_NewObj(interp);
1835 if (objPtr->bytes == NULL) {
1836 /* Object does not have a valid string representation. */
1837 dupPtr->bytes = NULL;
1839 Jim_InitStringRep(dupPtr, objPtr->bytes, objPtr->length);
1841 if (objPtr->typePtr != NULL) {
1842 if (objPtr->typePtr->dupIntRepProc == NULL) {
1843 dupPtr->internalRep = objPtr->internalRep;
1845 objPtr->typePtr->dupIntRepProc(interp, objPtr, dupPtr);
1847 dupPtr->typePtr = objPtr->typePtr;
1849 dupPtr->typePtr = NULL;
1854 /* Return the string representation for objPtr. If the object
1855 * string representation is invalid, calls the method to create
1856 * a new one starting from the internal representation of the object. */
1857 const char *Jim_GetString(Jim_Obj *objPtr, int *lenPtr)
1859 if (objPtr->bytes == NULL) {
1860 /* Invalid string repr. Generate it. */
1861 if (objPtr->typePtr->updateStringProc == NULL) {
1862 Jim_Panic(NULL,"UpdataStringProc called against '%s' type.",
1863 objPtr->typePtr->name);
1865 objPtr->typePtr->updateStringProc(objPtr);
1868 *lenPtr = objPtr->length;
1869 return objPtr->bytes;
1872 /* Just returns the length of the object's string rep */
1873 int Jim_Length(Jim_Obj *objPtr)
1877 Jim_GetString(objPtr, &len);
1881 /* -----------------------------------------------------------------------------
1883 * ---------------------------------------------------------------------------*/
1884 static void DupStringInternalRep(Jim_Interp *interp, Jim_Obj *srcPtr, Jim_Obj *dupPtr);
1885 static int SetStringFromAny(Jim_Interp *interp, struct Jim_Obj *objPtr);
1887 static Jim_ObjType stringObjType = {
1890 DupStringInternalRep,
1892 JIM_TYPE_REFERENCES,
1895 void DupStringInternalRep(Jim_Interp *interp, Jim_Obj *srcPtr, Jim_Obj *dupPtr)
1897 JIM_NOTUSED(interp);
1899 /* This is a bit subtle: the only caller of this function
1900 * should be Jim_DuplicateObj(), that will copy the
1901 * string representaion. After the copy, the duplicated
1902 * object will not have more room in teh buffer than
1903 * srcPtr->length bytes. So we just set it to length. */
1904 dupPtr->internalRep.strValue.maxLength = srcPtr->length;
1907 int SetStringFromAny(Jim_Interp *interp, Jim_Obj *objPtr)
1909 /* Get a fresh string representation. */
1910 (void) Jim_GetString(objPtr, NULL);
1911 /* Free any other internal representation. */
1912 Jim_FreeIntRep(interp, objPtr);
1913 /* Set it as string, i.e. just set the maxLength field. */
1914 objPtr->typePtr = &stringObjType;
1915 objPtr->internalRep.strValue.maxLength = objPtr->length;
1919 Jim_Obj *Jim_NewStringObj(Jim_Interp *interp, const char *s, int len)
1921 Jim_Obj *objPtr = Jim_NewObj(interp);
1925 /* Alloc/Set the string rep. */
1927 objPtr->bytes = JimEmptyStringRep;
1930 objPtr->bytes = Jim_Alloc(len+1);
1931 objPtr->length = len;
1932 memcpy(objPtr->bytes, s, len);
1933 objPtr->bytes[len] = '\0';
1936 /* No typePtr field for the vanilla string object. */
1937 objPtr->typePtr = NULL;
1941 /* This version does not try to duplicate the 's' pointer, but
1942 * use it directly. */
1943 Jim_Obj *Jim_NewStringObjNoAlloc(Jim_Interp *interp, char *s, int len)
1945 Jim_Obj *objPtr = Jim_NewObj(interp);
1949 Jim_SetStringRep(objPtr, s, len);
1950 objPtr->typePtr = NULL;
1954 /* Low-level string append. Use it only against objects
1955 * of type "string". */
1956 void StringAppendString(Jim_Obj *objPtr, const char *str, int len)
1962 needlen = objPtr->length + len;
1963 if (objPtr->internalRep.strValue.maxLength < needlen ||
1964 objPtr->internalRep.strValue.maxLength == 0) {
1965 if (objPtr->bytes == JimEmptyStringRep) {
1966 objPtr->bytes = Jim_Alloc((needlen*2)+1);
1968 objPtr->bytes = Jim_Realloc(objPtr->bytes, (needlen*2)+1);
1970 objPtr->internalRep.strValue.maxLength = needlen*2;
1972 memcpy(objPtr->bytes + objPtr->length, str, len);
1973 objPtr->bytes[objPtr->length+len] = '\0';
1974 objPtr->length += len;
1977 /* Low-level wrapper to append an object. */
1978 void StringAppendObj(Jim_Obj *objPtr, Jim_Obj *appendObjPtr)
1983 str = Jim_GetString(appendObjPtr, &len);
1984 StringAppendString(objPtr, str, len);
1987 /* Higher level API to append strings to objects. */
1988 void Jim_AppendString(Jim_Interp *interp, Jim_Obj *objPtr, const char *str,
1991 if (Jim_IsShared(objPtr))
1992 Jim_Panic(interp,"Jim_AppendString called with shared object");
1993 if (objPtr->typePtr != &stringObjType)
1994 SetStringFromAny(interp, objPtr);
1995 StringAppendString(objPtr, str, len);
1998 void Jim_AppendObj(Jim_Interp *interp, Jim_Obj *objPtr,
1999 Jim_Obj *appendObjPtr)
2004 str = Jim_GetString(appendObjPtr, &len);
2005 Jim_AppendString(interp, objPtr, str, len);
2008 void Jim_AppendStrings(Jim_Interp *interp, Jim_Obj *objPtr, ...)
2012 if (objPtr->typePtr != &stringObjType)
2013 SetStringFromAny(interp, objPtr);
2014 va_start(ap, objPtr);
2016 char *s = va_arg(ap, char*);
2018 if (s == NULL) break;
2019 Jim_AppendString(interp, objPtr, s, -1);
2024 int Jim_StringEqObj(Jim_Obj *aObjPtr, Jim_Obj *bObjPtr, int nocase)
2026 const char *aStr, *bStr;
2029 if (aObjPtr == bObjPtr) return 1;
2030 aStr = Jim_GetString(aObjPtr, &aLen);
2031 bStr = Jim_GetString(bObjPtr, &bLen);
2032 if (aLen != bLen) return 0;
2034 return memcmp(aStr, bStr, aLen) == 0;
2035 for (i = 0; i < aLen; i++) {
2036 if (tolower((int)aStr[i]) != tolower((int)bStr[i]))
2042 int Jim_StringMatchObj(Jim_Obj *patternObjPtr, Jim_Obj *objPtr,
2045 const char *pattern, *string;
2046 int patternLen, stringLen;
2048 pattern = Jim_GetString(patternObjPtr, &patternLen);
2049 string = Jim_GetString(objPtr, &stringLen);
2050 return JimStringMatch(pattern, patternLen, string, stringLen, nocase);
2053 int Jim_StringCompareObj(Jim_Obj *firstObjPtr,
2054 Jim_Obj *secondObjPtr, int nocase)
2056 const char *s1, *s2;
2059 s1 = Jim_GetString(firstObjPtr, &l1);
2060 s2 = Jim_GetString(secondObjPtr, &l2);
2061 return JimStringCompare(s1, l1, s2, l2, nocase);
2064 /* Convert a range, as returned by Jim_GetRange(), into
2065 * an absolute index into an object of the specified length.
2066 * This function may return negative values, or values
2067 * bigger or equal to the length of the list if the index
2068 * is out of range. */
2069 static int JimRelToAbsIndex(int len, int index)
2076 /* Convert a pair of index as normalize by JimRelToAbsIndex(),
2077 * into a range stored in *firstPtr, *lastPtr, *rangeLenPtr, suitable
2078 * for implementation of commands like [string range] and [lrange].
2080 * The resulting range is guaranteed to address valid elements of
2082 static void JimRelToAbsRange(int len, int first, int last,
2083 int *firstPtr, int *lastPtr, int *rangeLenPtr)
2090 rangeLen = last-first+1;
2097 rangeLen -= (last-(len-1));
2102 if (rangeLen < 0) rangeLen = 0;
2106 *rangeLenPtr = rangeLen;
2109 Jim_Obj *Jim_StringRangeObj(Jim_Interp *interp,
2110 Jim_Obj *strObjPtr, Jim_Obj *firstObjPtr, Jim_Obj *lastObjPtr)
2116 if (Jim_GetIndex(interp, firstObjPtr, &first) != JIM_OK ||
2117 Jim_GetIndex(interp, lastObjPtr, &last) != JIM_OK)
2119 str = Jim_GetString(strObjPtr, &len);
2120 first = JimRelToAbsIndex(len, first);
2121 last = JimRelToAbsIndex(len, last);
2122 JimRelToAbsRange(len, first, last, &first, &last, &rangeLen);
2123 return Jim_NewStringObj(interp, str+first, rangeLen);
2126 static Jim_Obj *JimStringToLower(Jim_Interp *interp, Jim_Obj *strObjPtr)
2128 char *buf = Jim_Alloc(strObjPtr->length+1);
2131 memcpy(buf, strObjPtr->bytes, strObjPtr->length+1);
2132 for (i = 0; i < strObjPtr->length; i++)
2133 buf[i] = tolower(buf[i]);
2134 return Jim_NewStringObjNoAlloc(interp, buf, strObjPtr->length);
2137 static Jim_Obj *JimStringToUpper(Jim_Interp *interp, Jim_Obj *strObjPtr)
2139 char *buf = Jim_Alloc(strObjPtr->length+1);
2142 memcpy(buf, strObjPtr->bytes, strObjPtr->length+1);
2143 for (i = 0; i < strObjPtr->length; i++)
2144 buf[i] = toupper(buf[i]);
2145 return Jim_NewStringObjNoAlloc(interp, buf, strObjPtr->length);
2148 /* This is the core of the [format] command.
2149 * TODO: Lots of things work - via a hack
2150 * However, no format item can be >= JIM_MAX_FMT
2152 Jim_Obj *Jim_FormatString(Jim_Interp *interp, Jim_Obj *fmtObjPtr,
2153 int objc, Jim_Obj *const *objv)
2155 const char *fmt, *_fmt;
2160 fmt = Jim_GetString(fmtObjPtr, &fmtLen);
2162 resObjPtr = Jim_NewStringObj(interp, "", 0);
2164 const char *p = fmt;
2168 /* we cheat and use Sprintf()! */
2169 #define JIM_MAX_FMT 2048
2170 char sprintf_buf[JIM_MAX_FMT];
2180 while (*fmt != '%' && fmtLen) {
2183 Jim_AppendString(interp, resObjPtr, p, fmt-p);
2186 fmt++; fmtLen--; /* skip '%' */
2199 case 'b': /* binary - not all printfs() do this */
2200 case 's': /* string */
2201 case 'i': /* integer */
2202 case 'd': /* decimal */
2204 case 'X': /* CAP hex */
2205 case 'c': /* char */
2206 case 'o': /* octal */
2207 case 'u': /* unsigned */
2208 case 'f': /* float */
2212 case '0': /* zero pad */
2222 case ' ': /* sign space */
2247 while( isdigit(*fmt) && (fmtLen > 0) ){
2248 width = (width * 10) + (*fmt - '0');
2253 /* suck up the next item as an integer */
2257 goto not_enough_args;
2259 if( Jim_GetWide(interp,objv[0],&wideValue )== JIM_ERR ){
2260 Jim_FreeNewObj(interp, resObjPtr );
2277 Jim_FreeNewObj(interp, resObjPtr);
2278 Jim_SetResultString(interp,
2279 "not enough arguments for all format specifiers", -1);
2287 * Create the formatter
2288 * cause we cheat and use sprintf()
2298 /* PLUS overrides */
2308 sprintf( cp, "%d", width );
2314 /* here we do the work */
2315 /* actually - we make sprintf() do it for us */
2320 /* BUG: we do not handled embeded NULLs */
2321 snprintf( sprintf_buf, JIM_MAX_FMT, fmt_str, Jim_GetString( objv[0], NULL ));
2326 if (Jim_GetWide(interp, objv[0], &wideValue) == JIM_ERR) {
2327 Jim_FreeNewObj(interp, resObjPtr);
2330 c = (char) wideValue;
2331 snprintf( sprintf_buf, JIM_MAX_FMT, fmt_str, c );
2341 if( Jim_GetDouble( interp, objv[0], &doubleValue ) == JIM_ERR ){
2342 Jim_FreeNewObj( interp, resObjPtr );
2345 snprintf( sprintf_buf, JIM_MAX_FMT, fmt_str, doubleValue );
2353 /* jim widevaluse are 64bit */
2354 if( sizeof(jim_wide) == sizeof(long long) ){
2362 if (Jim_GetWide(interp, objv[0], &wideValue) == JIM_ERR) {
2363 Jim_FreeNewObj(interp, resObjPtr);
2366 snprintf(sprintf_buf, JIM_MAX_FMT, fmt_str, wideValue );
2369 sprintf_buf[0] = '%';
2371 objv--; /* undo the objv++ below */
2374 spec[0] = *fmt; spec[1] = '\0';
2375 Jim_FreeNewObj(interp, resObjPtr);
2376 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
2377 Jim_AppendStrings(interp, Jim_GetResult(interp),
2378 "bad field specifier \"", spec, "\"", NULL);
2381 /* force terminate */
2383 printf("FMT was: %s\n", fmt_str );
2384 printf("RES was: |%s|\n", sprintf_buf );
2387 sprintf_buf[ JIM_MAX_FMT - 1] = 0;
2388 Jim_AppendString( interp, resObjPtr, sprintf_buf, strlen(sprintf_buf) );
2397 /* -----------------------------------------------------------------------------
2398 * Compared String Object
2399 * ---------------------------------------------------------------------------*/
2401 /* This is strange object that allows to compare a C literal string
2402 * with a Jim object in very short time if the same comparison is done
2403 * multiple times. For example every time the [if] command is executed,
2404 * Jim has to check if a given argument is "else". This comparions if
2405 * the code has no errors are true most of the times, so we can cache
2406 * inside the object the pointer of the string of the last matching
2407 * comparison. Because most C compilers perform literal sharing,
2408 * so that: char *x = "foo", char *y = "foo", will lead to x == y,
2409 * this works pretty well even if comparisons are at different places
2410 * inside the C code. */
2412 static Jim_ObjType comparedStringObjType = {
2417 JIM_TYPE_REFERENCES,
2420 /* The only way this object is exposed to the API is via the following
2421 * function. Returns true if the string and the object string repr.
2422 * are the same, otherwise zero is returned.
2424 * Note: this isn't binary safe, but it hardly needs to be.*/
2425 int Jim_CompareStringImmediate(Jim_Interp *interp, Jim_Obj *objPtr,
2428 if (objPtr->typePtr == &comparedStringObjType &&
2429 objPtr->internalRep.ptr == str)
2432 const char *objStr = Jim_GetString(objPtr, NULL);
2433 if (strcmp(str, objStr) != 0) return 0;
2434 if (objPtr->typePtr != &comparedStringObjType) {
2435 Jim_FreeIntRep(interp, objPtr);
2436 objPtr->typePtr = &comparedStringObjType;
2438 objPtr->internalRep.ptr = (char*)str; /*ATTENTION: const cast */
2443 int qsortCompareStringPointers(const void *a, const void *b)
2445 char * const *sa = (char * const *)a;
2446 char * const *sb = (char * const *)b;
2447 return strcmp(*sa, *sb);
2450 int Jim_GetEnum(Jim_Interp *interp, Jim_Obj *objPtr,
2451 const char **tablePtr, int *indexPtr, const char *name, int flags)
2453 const char **entryPtr = NULL;
2454 char **tablePtrSorted;
2458 for (entryPtr = tablePtr, i = 0; *entryPtr != NULL; entryPtr++, i++) {
2459 if (Jim_CompareStringImmediate(interp, objPtr, *entryPtr)) {
2463 count++; /* If nothing matches, this will reach the len of tablePtr */
2465 if (flags & JIM_ERRMSG) {
2468 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
2469 Jim_AppendStrings(interp, Jim_GetResult(interp),
2470 "bad ", name, " \"", Jim_GetString(objPtr, NULL), "\": must be one of ",
2472 tablePtrSorted = Jim_Alloc(sizeof(char*)*count);
2473 memcpy(tablePtrSorted, tablePtr, sizeof(char*)*count);
2474 qsort(tablePtrSorted, count, sizeof(char*), qsortCompareStringPointers);
2475 for (i = 0; i < count; i++) {
2476 if (i+1 == count && count > 1)
2477 Jim_AppendString(interp, Jim_GetResult(interp), "or ", -1);
2478 Jim_AppendString(interp, Jim_GetResult(interp),
2479 tablePtrSorted[i], -1);
2481 Jim_AppendString(interp, Jim_GetResult(interp), ", ", -1);
2483 Jim_Free(tablePtrSorted);
2488 /* -----------------------------------------------------------------------------
2491 * This object is just a string from the language point of view, but
2492 * in the internal representation it contains the filename and line number
2493 * where this given token was read. This information is used by
2494 * Jim_EvalObj() if the object passed happens to be of type "source".
2496 * This allows to propagate the information about line numbers and file
2497 * names and give error messages with absolute line numbers.
2499 * Note that this object uses shared strings for filenames, and the
2500 * pointer to the filename together with the line number is taken into
2501 * the space for the "inline" internal represenation of the Jim_Object,
2502 * so there is almost memory zero-overhead.
2504 * Also the object will be converted to something else if the given
2505 * token it represents in the source file is not something to be
2506 * evaluated (not a script), and will be specialized in some other way,
2507 * so the time overhead is alzo null.
2508 * ---------------------------------------------------------------------------*/
2510 static void FreeSourceInternalRep(Jim_Interp *interp, Jim_Obj *objPtr);
2511 static void DupSourceInternalRep(Jim_Interp *interp, Jim_Obj *srcPtr, Jim_Obj *dupPtr);
2513 static Jim_ObjType sourceObjType = {
2515 FreeSourceInternalRep,
2516 DupSourceInternalRep,
2518 JIM_TYPE_REFERENCES,
2521 void FreeSourceInternalRep(Jim_Interp *interp, Jim_Obj *objPtr)
2523 Jim_ReleaseSharedString(interp,
2524 objPtr->internalRep.sourceValue.fileName);
2527 void DupSourceInternalRep(Jim_Interp *interp, Jim_Obj *srcPtr, Jim_Obj *dupPtr)
2529 dupPtr->internalRep.sourceValue.fileName =
2530 Jim_GetSharedString(interp,
2531 srcPtr->internalRep.sourceValue.fileName);
2532 dupPtr->internalRep.sourceValue.lineNumber =
2533 dupPtr->internalRep.sourceValue.lineNumber;
2534 dupPtr->typePtr = &sourceObjType;
2537 static void JimSetSourceInfo(Jim_Interp *interp, Jim_Obj *objPtr,
2538 const char *fileName, int lineNumber)
2540 if (Jim_IsShared(objPtr))
2541 Jim_Panic(interp,"JimSetSourceInfo called with shared object");
2542 if (objPtr->typePtr != NULL)
2543 Jim_Panic(interp,"JimSetSourceInfo called with typePtr != NULL");
2544 objPtr->internalRep.sourceValue.fileName =
2545 Jim_GetSharedString(interp, fileName);
2546 objPtr->internalRep.sourceValue.lineNumber = lineNumber;
2547 objPtr->typePtr = &sourceObjType;
2550 /* -----------------------------------------------------------------------------
2552 * ---------------------------------------------------------------------------*/
2554 #define JIM_CMDSTRUCT_EXPAND -1
2556 static void FreeScriptInternalRep(Jim_Interp *interp, Jim_Obj *objPtr);
2557 static void DupScriptInternalRep(Jim_Interp *interp, Jim_Obj *srcPtr, Jim_Obj *dupPtr);
2558 static int SetScriptFromAny(Jim_Interp *interp, struct Jim_Obj *objPtr);
2560 static Jim_ObjType scriptObjType = {
2562 FreeScriptInternalRep,
2563 DupScriptInternalRep,
2565 JIM_TYPE_REFERENCES,
2568 /* The ScriptToken structure represents every token into a scriptObj.
2569 * Every token contains an associated Jim_Obj that can be specialized
2570 * by commands operating on it. */
2571 typedef struct ScriptToken {
2577 /* This is the script object internal representation. An array of
2578 * ScriptToken structures, with an associated command structure array.
2579 * The command structure is a pre-computed representation of the
2580 * command length and arguments structure as a simple liner array
2583 * For example the script:
2586 * set $i $x$y [foo]BAR
2588 * will produce a ScriptObj with the following Tokens:
2605 * This is a description of the tokens, separators, and of lines.
2606 * The command structure instead represents the number of arguments
2607 * of every command, followed by the tokens of which every argument
2608 * is composed. So for the example script, the cmdstruct array will
2613 * Because "puts hello" has two args (2), composed of single tokens (1 1)
2614 * While "set $i $x$y [foo]BAR" has four (4) args, the first two
2615 * composed of single tokens (1 1) and the last two of double tokens
2618 * The precomputation of the command structure makes Jim_Eval() faster,
2619 * and simpler because there aren't dynamic lengths / allocations.
2621 * -- {expand} handling --
2623 * Expand is handled in a special way. When a command
2624 * contains at least an argument with the {expand} prefix,
2625 * the command structure presents a -1 before the integer
2626 * describing the number of arguments. This is used in order
2627 * to send the command exection to a different path in case
2628 * of {expand} and guarantee a fast path for the more common
2629 * case. Also, the integers describing the number of tokens
2630 * are expressed with negative sign, to allow for fast check
2631 * of what's an {expand}-prefixed argument and what not.
2633 * For example the command:
2635 * list {expand}{1 2}
2637 * Will produce the following cmdstruct array:
2641 * -- the substFlags field of the structure --
2643 * The scriptObj structure is used to represent both "script" objects
2644 * and "subst" objects. In the second case, the cmdStruct related
2645 * fields are not used at all, but there is an additional field used
2646 * that is 'substFlags': this represents the flags used to turn
2647 * the string into the intenral representation used to perform the
2648 * substitution. If this flags are not what the application requires
2649 * the scriptObj is created again. For example the script:
2651 * subst -nocommands $string
2652 * subst -novariables $string
2654 * Will recreate the internal representation of the $string object
2657 typedef struct ScriptObj {
2658 int len; /* Length as number of tokens. */
2659 int commands; /* number of top-level commands in script. */
2660 ScriptToken *token; /* Tokens array. */
2661 int *cmdStruct; /* commands structure */
2662 int csLen; /* length of the cmdStruct array. */
2663 int substFlags; /* flags used for the compilation of "subst" objects */
2664 int inUse; /* Used to share a ScriptObj. Currently
2665 only used by Jim_EvalObj() as protection against
2666 shimmering of the currently evaluated object. */
2670 void FreeScriptInternalRep(Jim_Interp *interp, Jim_Obj *objPtr)
2673 struct ScriptObj *script = (void*) objPtr->internalRep.ptr;
2676 if (script->inUse != 0) return;
2677 for (i = 0; i < script->len; i++) {
2678 if (script->token[i].objPtr != NULL)
2679 Jim_DecrRefCount(interp, script->token[i].objPtr);
2681 Jim_Free(script->token);
2682 Jim_Free(script->cmdStruct);
2683 Jim_Free(script->fileName);
2687 void DupScriptInternalRep(Jim_Interp *interp, Jim_Obj *srcPtr, Jim_Obj *dupPtr)
2689 JIM_NOTUSED(interp);
2690 JIM_NOTUSED(srcPtr);
2692 /* Just returns an simple string. */
2693 dupPtr->typePtr = NULL;
2696 /* Add a new token to the internal repr of a script object */
2697 static void ScriptObjAddToken(Jim_Interp *interp, struct ScriptObj *script,
2698 char *strtoken, int len, int type, char *filename, int linenr)
2701 struct ScriptToken *token;
2703 prevtype = (script->len == 0) ? JIM_TT_EOL : \
2704 script->token[script->len-1].type;
2705 /* Skip tokens without meaning, like words separators
2706 * following a word separator or an end of command and
2708 if (prevtype == JIM_TT_EOL) {
2709 if (type == JIM_TT_EOL || type == JIM_TT_SEP) {
2713 } else if (prevtype == JIM_TT_SEP) {
2714 if (type == JIM_TT_SEP) {
2717 } else if (type == JIM_TT_EOL) {
2718 /* If an EOL is following by a SEP, drop the previous
2721 Jim_DecrRefCount(interp, script->token[script->len].objPtr);
2723 } else if (prevtype != JIM_TT_EOL && prevtype != JIM_TT_SEP &&
2724 type == JIM_TT_ESC && len == 0)
2726 /* Don't add empty tokens used in interpolation */
2730 /* Make space for a new istruction */
2732 script->token = Jim_Realloc(script->token,
2733 sizeof(ScriptToken)*script->len);
2734 /* Initialize the new token */
2735 token = script->token+(script->len-1);
2737 /* Every object is intially as a string, but the
2738 * internal type may be specialized during execution of the
2740 token->objPtr = Jim_NewStringObjNoAlloc(interp, strtoken, len);
2741 /* To add source info to SEP and EOL tokens is useless because
2742 * they will never by called as arguments of Jim_EvalObj(). */
2743 if (filename && type != JIM_TT_SEP && type != JIM_TT_EOL)
2744 JimSetSourceInfo(interp, token->objPtr, filename, linenr);
2745 Jim_IncrRefCount(token->objPtr);
2746 token->linenr = linenr;
2749 /* Add an integer into the command structure field of the script object. */
2750 static void ScriptObjAddInt(struct ScriptObj *script, int val)
2753 script->cmdStruct = Jim_Realloc(script->cmdStruct,
2754 sizeof(int)*script->csLen);
2755 script->cmdStruct[script->csLen-1] = val;
2758 /* Search a Jim_Obj contained in 'script' with the same stinrg repr.
2759 * of objPtr. Search nested script objects recursively. */
2760 static Jim_Obj *ScriptSearchLiteral(Jim_Interp *interp, ScriptObj *script,
2761 ScriptObj *scriptBarrier, Jim_Obj *objPtr)
2765 for (i = 0; i < script->len; i++) {
2766 if (script->token[i].objPtr != objPtr &&
2767 Jim_StringEqObj(script->token[i].objPtr, objPtr, 0)) {
2768 return script->token[i].objPtr;
2770 /* Enter recursively on scripts only if the object
2771 * is not the same as the one we are searching for
2772 * shared occurrences. */
2773 if (script->token[i].objPtr->typePtr == &scriptObjType &&
2774 script->token[i].objPtr != objPtr) {
2775 Jim_Obj *foundObjPtr;
2777 ScriptObj *subScript =
2778 script->token[i].objPtr->internalRep.ptr;
2779 /* Don't recursively enter the script we are trying
2780 * to make shared to avoid circular references. */
2781 if (subScript == scriptBarrier) continue;
2782 if (subScript != script) {
2784 ScriptSearchLiteral(interp, subScript,
2785 scriptBarrier, objPtr);
2786 if (foundObjPtr != NULL)
2794 /* Share literals of a script recursively sharing sub-scripts literals. */
2795 static void ScriptShareLiterals(Jim_Interp *interp, ScriptObj *script,
2796 ScriptObj *topLevelScript)
2801 /* Try to share with toplevel object. */
2802 if (topLevelScript != NULL) {
2803 for (i = 0; i < script->len; i++) {
2804 Jim_Obj *foundObjPtr;
2805 char *str = script->token[i].objPtr->bytes;
2807 if (script->token[i].objPtr->refCount != 1) continue;
2808 if (script->token[i].objPtr->typePtr == &scriptObjType) continue;
2809 if (strchr(str, ' ') || strchr(str, '\n')) continue;
2810 foundObjPtr = ScriptSearchLiteral(interp,
2812 script, /* barrier */
2813 script->token[i].objPtr);
2814 if (foundObjPtr != NULL) {
2815 Jim_IncrRefCount(foundObjPtr);
2816 Jim_DecrRefCount(interp,
2817 script->token[i].objPtr);
2818 script->token[i].objPtr = foundObjPtr;
2822 /* Try to share locally */
2823 for (i = 0; i < script->len; i++) {
2824 char *str = script->token[i].objPtr->bytes;
2826 if (script->token[i].objPtr->refCount != 1) continue;
2827 if (strchr(str, ' ') || strchr(str, '\n')) continue;
2828 for (j = 0; j < script->len; j++) {
2829 if (script->token[i].objPtr !=
2830 script->token[j].objPtr &&
2831 Jim_StringEqObj(script->token[i].objPtr,
2832 script->token[j].objPtr, 0))
2834 Jim_IncrRefCount(script->token[j].objPtr);
2835 Jim_DecrRefCount(interp,
2836 script->token[i].objPtr);
2837 script->token[i].objPtr =
2838 script->token[j].objPtr;
2844 /* This method takes the string representation of an object
2845 * as a Tcl script, and generates the pre-parsed internal representation
2847 int SetScriptFromAny(Jim_Interp *interp, struct Jim_Obj *objPtr)
2850 const char *scriptText = Jim_GetString(objPtr, &scriptTextLen);
2851 struct JimParserCtx parser;
2852 struct ScriptObj *script = Jim_Alloc(sizeof(*script));
2854 int args, tokens, start, end, i;
2855 int initialLineNumber;
2856 int propagateSourceInfo = 0;
2860 script->commands = 0;
2861 script->token = NULL;
2862 script->cmdStruct = NULL;
2864 /* Try to get information about filename / line number */
2865 if (objPtr->typePtr == &sourceObjType) {
2867 Jim_StrDup(objPtr->internalRep.sourceValue.fileName);
2868 initialLineNumber = objPtr->internalRep.sourceValue.lineNumber;
2869 propagateSourceInfo = 1;
2871 script->fileName = Jim_StrDup("?");
2872 initialLineNumber = 1;
2875 JimParserInit(&parser, scriptText, scriptTextLen, initialLineNumber);
2876 while(!JimParserEof(&parser)) {
2878 int len, type, linenr;
2880 JimParseScript(&parser);
2881 token = JimParserGetToken(&parser, &len, &type, &linenr);
2882 ScriptObjAddToken(interp, script, token, len, type,
2883 propagateSourceInfo ? script->fileName : NULL,
2886 token = script->token;
2888 /* Compute the command structure array
2889 * (see the ScriptObj struct definition for more info) */
2890 start = 0; /* Current command start token index */
2891 end = -1; /* Current command end token index */
2893 int expand = 0; /* expand flag. set to 1 on {expand} form. */
2894 int interpolation = 0; /* set to 1 if there is at least one
2895 argument of the command obtained via
2896 interpolation of more tokens. */
2897 /* Search for the end of command, while
2898 * count the number of args. */
2900 if (start >= script->len) break;
2901 args = 1; /* Number of args in current command */
2902 while (token[end].type != JIM_TT_EOL) {
2903 if (end == 0 || token[end-1].type == JIM_TT_SEP ||
2904 token[end-1].type == JIM_TT_EOL)
2906 if (token[end].type == JIM_TT_STR &&
2907 token[end+1].type != JIM_TT_SEP &&
2908 token[end+1].type != JIM_TT_EOL &&
2909 (!strcmp(token[end].objPtr->bytes, "expand") ||
2910 !strcmp(token[end].objPtr->bytes, "*")))
2913 if (token[end].type == JIM_TT_SEP)
2917 interpolation = !((end-start+1) == args*2);
2918 /* Add the 'number of arguments' info into cmdstruct.
2919 * Negative value if there is list expansion involved. */
2921 ScriptObjAddInt(script, -1);
2922 ScriptObjAddInt(script, args);
2923 /* Now add info about the number of tokens. */
2924 tokens = 0; /* Number of tokens in current argument. */
2926 for (i = start; i <= end; i++) {
2927 if (token[i].type == JIM_TT_SEP ||
2928 token[i].type == JIM_TT_EOL)
2930 if (tokens == 1 && expand)
2932 ScriptObjAddInt(script,
2933 expand ? -tokens : tokens);
2938 } else if (tokens == 0 && token[i].type == JIM_TT_STR &&
2939 (!strcmp(token[i].objPtr->bytes, "expand") ||
2940 !strcmp(token[i].objPtr->bytes, "*")))
2947 /* Perform literal sharing, but only for objects that appear
2948 * to be scripts written as literals inside the source code,
2949 * and not computed at runtime. Literal sharing is a costly
2950 * operation that should be done only against objects that
2951 * are likely to require compilation only the first time, and
2952 * then are executed multiple times. */
2953 if (propagateSourceInfo && interp->framePtr->procBodyObjPtr) {
2954 Jim_Obj *bodyObjPtr = interp->framePtr->procBodyObjPtr;
2955 if (bodyObjPtr->typePtr == &scriptObjType) {
2956 ScriptObj *bodyScript =
2957 bodyObjPtr->internalRep.ptr;
2958 ScriptShareLiterals(interp, script, bodyScript);
2960 } else if (propagateSourceInfo) {
2961 ScriptShareLiterals(interp, script, NULL);
2963 /* Free the old internal rep and set the new one. */
2964 Jim_FreeIntRep(interp, objPtr);
2965 Jim_SetIntRepPtr(objPtr, script);
2966 objPtr->typePtr = &scriptObjType;
2970 ScriptObj *Jim_GetScript(Jim_Interp *interp, Jim_Obj *objPtr)
2972 if (objPtr->typePtr != &scriptObjType) {
2973 SetScriptFromAny(interp, objPtr);
2975 return (ScriptObj*) Jim_GetIntRepPtr(objPtr);
2978 /* -----------------------------------------------------------------------------
2980 * ---------------------------------------------------------------------------*/
2982 /* Commands HashTable Type.
2984 * Keys are dynamic allocated strings, Values are Jim_Cmd structures. */
2985 static void Jim_CommandsHT_ValDestructor(void *interp, void *val)
2987 Jim_Cmd *cmdPtr = (void*) val;
2989 if (cmdPtr->cmdProc == NULL) {
2990 Jim_DecrRefCount(interp, cmdPtr->argListObjPtr);
2991 Jim_DecrRefCount(interp, cmdPtr->bodyObjPtr);
2992 if (cmdPtr->staticVars) {
2993 Jim_FreeHashTable(cmdPtr->staticVars);
2994 Jim_Free(cmdPtr->staticVars);
2996 } else if (cmdPtr->delProc != NULL) {
2997 /* If it was a C coded command, call the delProc if any */
2998 cmdPtr->delProc(interp, cmdPtr->privData);
3003 static Jim_HashTableType JimCommandsHashTableType = {
3004 JimStringCopyHTHashFunction, /* hash function */
3005 JimStringCopyHTKeyDup, /* key dup */
3007 JimStringCopyHTKeyCompare, /* key compare */
3008 JimStringCopyHTKeyDestructor, /* key destructor */
3009 Jim_CommandsHT_ValDestructor /* val destructor */
3012 /* ------------------------- Commands related functions --------------------- */
3014 int Jim_CreateCommand(Jim_Interp *interp, const char *cmdName,
3015 Jim_CmdProc cmdProc, void *privData, Jim_DelCmdProc delProc)
3020 he = Jim_FindHashEntry(&interp->commands, cmdName);
3021 if (he == NULL) { /* New command to create */
3022 cmdPtr = Jim_Alloc(sizeof(*cmdPtr));
3023 cmdPtr->cmdProc = cmdProc;
3024 cmdPtr->privData = privData;
3025 cmdPtr->delProc = delProc;
3026 Jim_AddHashEntry(&interp->commands, cmdName, cmdPtr);
3028 Jim_InterpIncrProcEpoch(interp);
3029 /* Free the arglist/body objects if it was a Tcl procedure */
3031 if (cmdPtr->cmdProc == NULL) {
3032 Jim_DecrRefCount(interp, cmdPtr->argListObjPtr);
3033 Jim_DecrRefCount(interp, cmdPtr->bodyObjPtr);
3034 if (cmdPtr->staticVars) {
3035 Jim_FreeHashTable(cmdPtr->staticVars);
3036 Jim_Free(cmdPtr->staticVars);
3038 cmdPtr->staticVars = NULL;
3039 } else if (cmdPtr->delProc != NULL) {
3040 /* If it was a C coded command, call the delProc if any */
3041 cmdPtr->delProc(interp, cmdPtr->privData);
3043 cmdPtr->cmdProc = cmdProc;
3044 cmdPtr->privData = privData;
3046 /* There is no need to increment the 'proc epoch' because
3047 * creation of a new procedure can never affect existing
3048 * cached commands. We don't do negative caching. */
3052 int Jim_CreateProcedure(Jim_Interp *interp, const char *cmdName,
3053 Jim_Obj *argListObjPtr, Jim_Obj *staticsListObjPtr, Jim_Obj *bodyObjPtr,
3054 int arityMin, int arityMax)
3058 cmdPtr = Jim_Alloc(sizeof(*cmdPtr));
3059 cmdPtr->cmdProc = NULL; /* Not a C coded command */
3060 cmdPtr->argListObjPtr = argListObjPtr;
3061 cmdPtr->bodyObjPtr = bodyObjPtr;
3062 Jim_IncrRefCount(argListObjPtr);
3063 Jim_IncrRefCount(bodyObjPtr);
3064 cmdPtr->arityMin = arityMin;
3065 cmdPtr->arityMax = arityMax;
3066 cmdPtr->staticVars = NULL;
3068 /* Create the statics hash table. */
3069 if (staticsListObjPtr) {
3072 Jim_ListLength(interp, staticsListObjPtr, &len);
3074 cmdPtr->staticVars = Jim_Alloc(sizeof(Jim_HashTable));
3075 Jim_InitHashTable(cmdPtr->staticVars, &JimVariablesHashTableType,
3077 for (i = 0; i < len; i++) {
3078 Jim_Obj *objPtr, *initObjPtr, *nameObjPtr;
3082 Jim_ListIndex(interp, staticsListObjPtr, i, &objPtr, JIM_NONE);
3083 /* Check if it's composed of two elements. */
3084 Jim_ListLength(interp, objPtr, &subLen);
3085 if (subLen == 1 || subLen == 2) {
3086 /* Try to get the variable value from the current
3088 Jim_ListIndex(interp, objPtr, 0, &nameObjPtr, JIM_NONE);
3090 initObjPtr = Jim_GetVariable(interp, nameObjPtr,
3092 if (initObjPtr == NULL) {
3093 Jim_SetResult(interp,
3094 Jim_NewEmptyStringObj(interp));
3095 Jim_AppendStrings(interp, Jim_GetResult(interp),
3096 "variable for initialization of static \"",
3097 Jim_GetString(nameObjPtr, NULL),
3098 "\" not found in the local context",
3103 Jim_ListIndex(interp, objPtr, 1, &initObjPtr, JIM_NONE);
3105 varPtr = Jim_Alloc(sizeof(*varPtr));
3106 varPtr->objPtr = initObjPtr;
3107 Jim_IncrRefCount(initObjPtr);
3108 varPtr->linkFramePtr = NULL;
3109 if (Jim_AddHashEntry(cmdPtr->staticVars,
3110 Jim_GetString(nameObjPtr, NULL),
3113 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3114 Jim_AppendStrings(interp, Jim_GetResult(interp),
3115 "static variable name \"",
3116 Jim_GetString(objPtr, NULL), "\"",
3117 " duplicated in statics list", NULL);
3118 Jim_DecrRefCount(interp, initObjPtr);
3123 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3124 Jim_AppendStrings(interp, Jim_GetResult(interp),
3125 "too many fields in static specifier \"",
3126 objPtr, "\"", NULL);
3133 /* Add the new command */
3135 /* it may already exist, so we try to delete the old one */
3136 if (Jim_DeleteHashEntry(&interp->commands, cmdName) != JIM_ERR) {
3137 /* There was an old procedure with the same name, this requires
3138 * a 'proc epoch' update. */
3139 Jim_InterpIncrProcEpoch(interp);
3141 /* If a procedure with the same name didn't existed there is no need
3142 * to increment the 'proc epoch' because creation of a new procedure
3143 * can never affect existing cached commands. We don't do
3144 * negative caching. */
3145 Jim_AddHashEntry(&interp->commands, cmdName, cmdPtr);
3149 Jim_FreeHashTable(cmdPtr->staticVars);
3150 Jim_Free(cmdPtr->staticVars);
3151 Jim_DecrRefCount(interp, argListObjPtr);
3152 Jim_DecrRefCount(interp, bodyObjPtr);
3157 int Jim_DeleteCommand(Jim_Interp *interp, const char *cmdName)
3159 if (Jim_DeleteHashEntry(&interp->commands, cmdName) == JIM_ERR)
3161 Jim_InterpIncrProcEpoch(interp);
3165 int Jim_RenameCommand(Jim_Interp *interp, const char *oldName,
3166 const char *newName)
3170 Jim_Cmd *copyCmdPtr;
3172 if (newName[0] == '\0') /* Delete! */
3173 return Jim_DeleteCommand(interp, oldName);
3175 he = Jim_FindHashEntry(&interp->commands, oldName);
3177 return JIM_ERR; /* Invalid command name */
3179 copyCmdPtr = Jim_Alloc(sizeof(Jim_Cmd));
3180 *copyCmdPtr = *cmdPtr;
3181 /* In order to avoid that a procedure will get arglist/body/statics
3182 * freed by the hash table methods, fake a C-coded command
3183 * setting cmdPtr->cmdProc as not NULL */
3184 cmdPtr->cmdProc = (void*)1;
3185 /* Also make sure delProc is NULL. */
3186 cmdPtr->delProc = NULL;
3187 /* Destroy the old command, and make sure the new is freed
3189 Jim_DeleteHashEntry(&interp->commands, oldName);
3190 Jim_DeleteHashEntry(&interp->commands, newName);
3191 /* Now the new command. We are sure it can't fail because
3192 * the target name was already freed. */
3193 Jim_AddHashEntry(&interp->commands, newName, copyCmdPtr);
3194 /* Increment the epoch */
3195 Jim_InterpIncrProcEpoch(interp);
3199 /* -----------------------------------------------------------------------------
3201 * ---------------------------------------------------------------------------*/
3203 static int SetCommandFromAny(Jim_Interp *interp, struct Jim_Obj *objPtr);
3205 static Jim_ObjType commandObjType = {
3210 JIM_TYPE_REFERENCES,
3213 int SetCommandFromAny(Jim_Interp *interp, Jim_Obj *objPtr)
3216 const char *cmdName;
3218 /* Get the string representation */
3219 cmdName = Jim_GetString(objPtr, NULL);
3220 /* Lookup this name into the commands hash table */
3221 he = Jim_FindHashEntry(&interp->commands, cmdName);
3225 /* Free the old internal repr and set the new one. */
3226 Jim_FreeIntRep(interp, objPtr);
3227 objPtr->typePtr = &commandObjType;
3228 objPtr->internalRep.cmdValue.procEpoch = interp->procEpoch;
3229 objPtr->internalRep.cmdValue.cmdPtr = (void*)he->val;
3233 /* This function returns the command structure for the command name
3234 * stored in objPtr. It tries to specialize the objPtr to contain
3235 * a cached info instead to perform the lookup into the hash table
3236 * every time. The information cached may not be uptodate, in such
3237 * a case the lookup is performed and the cache updated. */
3238 Jim_Cmd *Jim_GetCommand(Jim_Interp *interp, Jim_Obj *objPtr, int flags)
3240 if ((objPtr->typePtr != &commandObjType ||
3241 objPtr->internalRep.cmdValue.procEpoch != interp->procEpoch) &&
3242 SetCommandFromAny(interp, objPtr) == JIM_ERR) {
3243 if (flags & JIM_ERRMSG) {
3244 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3245 Jim_AppendStrings(interp, Jim_GetResult(interp),
3246 "invalid command name \"", objPtr->bytes, "\"",
3251 return objPtr->internalRep.cmdValue.cmdPtr;
3254 /* -----------------------------------------------------------------------------
3256 * ---------------------------------------------------------------------------*/
3258 /* Variables HashTable Type.
3260 * Keys are dynamic allocated strings, Values are Jim_Var structures. */
3261 static void JimVariablesHTValDestructor(void *interp, void *val)
3263 Jim_Var *varPtr = (void*) val;
3265 Jim_DecrRefCount(interp, varPtr->objPtr);
3269 static Jim_HashTableType JimVariablesHashTableType = {
3270 JimStringCopyHTHashFunction, /* hash function */
3271 JimStringCopyHTKeyDup, /* key dup */
3273 JimStringCopyHTKeyCompare, /* key compare */
3274 JimStringCopyHTKeyDestructor, /* key destructor */
3275 JimVariablesHTValDestructor /* val destructor */
3278 /* -----------------------------------------------------------------------------
3280 * ---------------------------------------------------------------------------*/
3282 #define JIM_DICT_SUGAR 100 /* Only returned by SetVariableFromAny() */
3284 static int SetVariableFromAny(Jim_Interp *interp, struct Jim_Obj *objPtr);
3286 static Jim_ObjType variableObjType = {
3291 JIM_TYPE_REFERENCES,
3294 /* Return true if the string "str" looks like syntax sugar for [dict]. I.e.
3295 * is in the form "varname(key)". */
3296 static int Jim_NameIsDictSugar(const char *str, int len)
3300 if (len && str[len-1] == ')' && strchr(str, '(') != NULL)
3305 /* This method should be called only by the variable API.
3306 * It returns JIM_OK on success (variable already exists),
3307 * JIM_ERR if it does not exists, JIM_DICT_GLUE if it's not
3308 * a variable name, but syntax glue for [dict] i.e. the last
3309 * character is ')' */
3310 int SetVariableFromAny(Jim_Interp *interp, struct Jim_Obj *objPtr)
3313 const char *varName;
3316 /* Check if the object is already an uptodate variable */
3317 if (objPtr->typePtr == &variableObjType &&
3318 objPtr->internalRep.varValue.callFrameId == interp->framePtr->id)
3319 return JIM_OK; /* nothing to do */
3320 /* Get the string representation */
3321 varName = Jim_GetString(objPtr, &len);
3322 /* Make sure it's not syntax glue to get/set dict. */
3323 if (Jim_NameIsDictSugar(varName, len))
3324 return JIM_DICT_SUGAR;
3325 /* Lookup this name into the variables hash table */
3326 he = Jim_FindHashEntry(&interp->framePtr->vars, varName);
3328 /* Try with static vars. */
3329 if (interp->framePtr->staticVars == NULL)
3331 if (!(he = Jim_FindHashEntry(interp->framePtr->staticVars, varName)))
3334 /* Free the old internal repr and set the new one. */
3335 Jim_FreeIntRep(interp, objPtr);
3336 objPtr->typePtr = &variableObjType;
3337 objPtr->internalRep.varValue.callFrameId = interp->framePtr->id;
3338 objPtr->internalRep.varValue.varPtr = (void*)he->val;
3342 /* -------------------- Variables related functions ------------------------- */
3343 static int JimDictSugarSet(Jim_Interp *interp, Jim_Obj *ObjPtr,
3344 Jim_Obj *valObjPtr);
3345 static Jim_Obj *JimDictSugarGet(Jim_Interp *interp, Jim_Obj *ObjPtr);
3347 /* For now that's dummy. Variables lookup should be optimized
3348 * in many ways, with caching of lookups, and possibly with
3349 * a table of pre-allocated vars in every CallFrame for local vars.
3350 * All the caching should also have an 'epoch' mechanism similar
3351 * to the one used by Tcl for procedures lookup caching. */
3353 int Jim_SetVariable(Jim_Interp *interp, Jim_Obj *nameObjPtr, Jim_Obj *valObjPtr)
3359 if ((err = SetVariableFromAny(interp, nameObjPtr)) != JIM_OK) {
3360 /* Check for [dict] syntax sugar. */
3361 if (err == JIM_DICT_SUGAR)
3362 return JimDictSugarSet(interp, nameObjPtr, valObjPtr);
3363 /* New variable to create */
3364 name = Jim_GetString(nameObjPtr, NULL);
3366 var = Jim_Alloc(sizeof(*var));
3367 var->objPtr = valObjPtr;
3368 Jim_IncrRefCount(valObjPtr);
3369 var->linkFramePtr = NULL;
3370 /* Insert the new variable */
3371 Jim_AddHashEntry(&interp->framePtr->vars, name, var);
3372 /* Make the object int rep a variable */
3373 Jim_FreeIntRep(interp, nameObjPtr);
3374 nameObjPtr->typePtr = &variableObjType;
3375 nameObjPtr->internalRep.varValue.callFrameId =
3376 interp->framePtr->id;
3377 nameObjPtr->internalRep.varValue.varPtr = var;
3379 var = nameObjPtr->internalRep.varValue.varPtr;
3380 if (var->linkFramePtr == NULL) {
3381 Jim_IncrRefCount(valObjPtr);
3382 Jim_DecrRefCount(interp, var->objPtr);
3383 var->objPtr = valObjPtr;
3384 } else { /* Else handle the link */
3385 Jim_CallFrame *savedCallFrame;
3387 savedCallFrame = interp->framePtr;
3388 interp->framePtr = var->linkFramePtr;
3389 err = Jim_SetVariable(interp, var->objPtr, valObjPtr);
3390 interp->framePtr = savedCallFrame;
3398 int Jim_SetVariableStr(Jim_Interp *interp, const char *name, Jim_Obj *objPtr)
3400 Jim_Obj *nameObjPtr;
3403 nameObjPtr = Jim_NewStringObj(interp, name, -1);
3404 Jim_IncrRefCount(nameObjPtr);
3405 result = Jim_SetVariable(interp, nameObjPtr, objPtr);
3406 Jim_DecrRefCount(interp, nameObjPtr);
3410 int Jim_SetGlobalVariableStr(Jim_Interp *interp, const char *name, Jim_Obj *objPtr)
3412 Jim_CallFrame *savedFramePtr;
3415 savedFramePtr = interp->framePtr;
3416 interp->framePtr = interp->topFramePtr;
3417 result = Jim_SetVariableStr(interp, name, objPtr);
3418 interp->framePtr = savedFramePtr;
3422 int Jim_SetVariableStrWithStr(Jim_Interp *interp, const char *name, const char *val)
3424 Jim_Obj *nameObjPtr, *valObjPtr;
3427 nameObjPtr = Jim_NewStringObj(interp, name, -1);
3428 valObjPtr = Jim_NewStringObj(interp, val, -1);
3429 Jim_IncrRefCount(nameObjPtr);
3430 Jim_IncrRefCount(valObjPtr);
3431 result = Jim_SetVariable(interp, nameObjPtr, valObjPtr);
3432 Jim_DecrRefCount(interp, nameObjPtr);
3433 Jim_DecrRefCount(interp, valObjPtr);
3437 int Jim_SetVariableLink(Jim_Interp *interp, Jim_Obj *nameObjPtr,
3438 Jim_Obj *targetNameObjPtr, Jim_CallFrame *targetCallFrame)
3440 const char *varName;
3443 /* Check for cycles. */
3444 if (interp->framePtr == targetCallFrame) {
3445 Jim_Obj *objPtr = targetNameObjPtr;
3447 /* Cycles are only possible with 'uplevel 0' */
3449 if (Jim_StringEqObj(objPtr, nameObjPtr, 0)) {
3450 Jim_SetResultString(interp,
3451 "can't upvar from variable to itself", -1);
3454 if (SetVariableFromAny(interp, objPtr) != JIM_OK)
3456 varPtr = objPtr->internalRep.varValue.varPtr;
3457 if (varPtr->linkFramePtr != targetCallFrame) break;
3458 objPtr = varPtr->objPtr;
3461 varName = Jim_GetString(nameObjPtr, &len);
3462 if (Jim_NameIsDictSugar(varName, len)) {
3463 Jim_SetResultString(interp,
3464 "Dict key syntax invalid as link source", -1);
3467 /* Perform the binding */
3468 Jim_SetVariable(interp, nameObjPtr, targetNameObjPtr);
3469 /* We are now sure 'nameObjPtr' type is variableObjType */
3470 nameObjPtr->internalRep.varValue.varPtr->linkFramePtr = targetCallFrame;
3474 /* Return the Jim_Obj pointer associated with a variable name,
3475 * or NULL if the variable was not found in the current context.
3476 * The same optimization discussed in the comment to the
3477 * 'SetVariable' function should apply here. */
3478 Jim_Obj *Jim_GetVariable(Jim_Interp *interp, Jim_Obj *nameObjPtr, int flags)
3482 /* All the rest is handled here */
3483 if ((err = SetVariableFromAny(interp, nameObjPtr)) != JIM_OK) {
3484 /* Check for [dict] syntax sugar. */
3485 if (err == JIM_DICT_SUGAR)
3486 return JimDictSugarGet(interp, nameObjPtr);
3487 if (flags & JIM_ERRMSG) {
3488 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3489 Jim_AppendStrings(interp, Jim_GetResult(interp),
3490 "can't read \"", nameObjPtr->bytes,
3491 "\": no such variable", NULL);
3497 Jim_CallFrame *savedCallFrame;
3499 varPtr = nameObjPtr->internalRep.varValue.varPtr;
3500 if (varPtr->linkFramePtr == NULL)
3501 return varPtr->objPtr;
3502 /* The variable is a link? Resolve it. */
3503 savedCallFrame = interp->framePtr;
3504 interp->framePtr = varPtr->linkFramePtr;
3505 objPtr = Jim_GetVariable(interp, varPtr->objPtr, JIM_NONE);
3506 if (objPtr == NULL && flags & JIM_ERRMSG) {
3507 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3508 Jim_AppendStrings(interp, Jim_GetResult(interp),
3509 "can't read \"", nameObjPtr->bytes,
3510 "\": no such variable", NULL);
3512 interp->framePtr = savedCallFrame;
3517 Jim_Obj *Jim_GetGlobalVariable(Jim_Interp *interp, Jim_Obj *nameObjPtr,
3520 Jim_CallFrame *savedFramePtr;
3523 savedFramePtr = interp->framePtr;
3524 interp->framePtr = interp->topFramePtr;
3525 objPtr = Jim_GetVariable(interp, nameObjPtr, flags);
3526 interp->framePtr = savedFramePtr;
3531 Jim_Obj *Jim_GetVariableStr(Jim_Interp *interp, const char *name, int flags)
3533 Jim_Obj *nameObjPtr, *varObjPtr;
3535 nameObjPtr = Jim_NewStringObj(interp, name, -1);
3536 Jim_IncrRefCount(nameObjPtr);
3537 varObjPtr = Jim_GetVariable(interp, nameObjPtr, flags);
3538 Jim_DecrRefCount(interp, nameObjPtr);
3542 Jim_Obj *Jim_GetGlobalVariableStr(Jim_Interp *interp, const char *name,
3545 Jim_CallFrame *savedFramePtr;
3548 savedFramePtr = interp->framePtr;
3549 interp->framePtr = interp->topFramePtr;
3550 objPtr = Jim_GetVariableStr(interp, name, flags);
3551 interp->framePtr = savedFramePtr;
3556 /* Unset a variable.
3557 * Note: On success unset invalidates all the variable objects created
3558 * in the current call frame incrementing. */
3559 int Jim_UnsetVariable(Jim_Interp *interp, Jim_Obj *nameObjPtr, int flags)
3565 if ((err = SetVariableFromAny(interp, nameObjPtr)) != JIM_OK) {
3566 /* Check for [dict] syntax sugar. */
3567 if (err == JIM_DICT_SUGAR)
3568 return JimDictSugarSet(interp, nameObjPtr, NULL);
3569 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3570 Jim_AppendStrings(interp, Jim_GetResult(interp),
3571 "can't unset \"", nameObjPtr->bytes,
3572 "\": no such variable", NULL);
3573 return JIM_ERR; /* var not found */
3575 varPtr = nameObjPtr->internalRep.varValue.varPtr;
3576 /* If it's a link call UnsetVariable recursively */
3577 if (varPtr->linkFramePtr) {
3580 Jim_CallFrame *savedCallFrame;
3582 savedCallFrame = interp->framePtr;
3583 interp->framePtr = varPtr->linkFramePtr;
3584 retval = Jim_UnsetVariable(interp, varPtr->objPtr, JIM_NONE);
3585 interp->framePtr = savedCallFrame;
3586 if (retval != JIM_OK && flags & JIM_ERRMSG) {
3587 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3588 Jim_AppendStrings(interp, Jim_GetResult(interp),
3589 "can't unset \"", nameObjPtr->bytes,
3590 "\": no such variable", NULL);
3594 name = Jim_GetString(nameObjPtr, NULL);
3595 if (Jim_DeleteHashEntry(&interp->framePtr->vars, name)
3596 != JIM_OK) return JIM_ERR;
3597 /* Change the callframe id, invalidating var lookup caching */
3598 JimChangeCallFrameId(interp, interp->framePtr);
3603 /* ---------- Dict syntax sugar (similar to array Tcl syntax) -------------- */
3605 /* Given a variable name for [dict] operation syntax sugar,
3606 * this function returns two objects, the first with the name
3607 * of the variable to set, and the second with the rispective key.
3608 * For example "foo(bar)" will return objects with string repr. of
3611 * The returned objects have refcount = 1. The function can't fail. */
3612 static void JimDictSugarParseVarKey(Jim_Interp *interp, Jim_Obj *objPtr,
3613 Jim_Obj **varPtrPtr, Jim_Obj **keyPtrPtr)
3615 const char *str, *p;
3617 int len, keyLen, nameLen;
3618 Jim_Obj *varObjPtr, *keyObjPtr;
3620 str = Jim_GetString(objPtr, &len);
3621 p = strchr(str, '(');
3623 keyLen = len-((p-str)+1);
3624 nameLen = (p-str)-1;
3625 /* Create the objects with the variable name and key. */
3626 t = Jim_Alloc(nameLen+1);
3627 memcpy(t, str, nameLen);
3629 varObjPtr = Jim_NewStringObjNoAlloc(interp, t, nameLen);
3631 t = Jim_Alloc(keyLen+1);
3632 memcpy(t, p, keyLen);
3634 keyObjPtr = Jim_NewStringObjNoAlloc(interp, t, keyLen);
3636 Jim_IncrRefCount(varObjPtr);
3637 Jim_IncrRefCount(keyObjPtr);
3638 *varPtrPtr = varObjPtr;
3639 *keyPtrPtr = keyObjPtr;
3642 /* Helper of Jim_SetVariable() to deal with dict-syntax variable names.
3643 * Also used by Jim_UnsetVariable() with valObjPtr = NULL. */
3644 static int JimDictSugarSet(Jim_Interp *interp, Jim_Obj *objPtr,
3647 Jim_Obj *varObjPtr, *keyObjPtr;
3650 JimDictSugarParseVarKey(interp, objPtr, &varObjPtr, &keyObjPtr);
3651 err = Jim_SetDictKeysVector(interp, varObjPtr, &keyObjPtr, 1,
3653 Jim_DecrRefCount(interp, varObjPtr);
3654 Jim_DecrRefCount(interp, keyObjPtr);
3658 /* Helper of Jim_GetVariable() to deal with dict-syntax variable names */
3659 static Jim_Obj *JimDictSugarGet(Jim_Interp *interp, Jim_Obj *objPtr)
3661 Jim_Obj *varObjPtr, *keyObjPtr, *dictObjPtr, *resObjPtr;
3663 JimDictSugarParseVarKey(interp, objPtr, &varObjPtr, &keyObjPtr);
3664 dictObjPtr = Jim_GetVariable(interp, varObjPtr, JIM_ERRMSG);
3669 if (Jim_DictKey(interp, dictObjPtr, keyObjPtr, &resObjPtr, JIM_ERRMSG)
3674 Jim_DecrRefCount(interp, varObjPtr);
3675 Jim_DecrRefCount(interp, keyObjPtr);
3679 /* --------- $var(INDEX) substitution, using a specialized object ----------- */
3681 static void FreeDictSubstInternalRep(Jim_Interp *interp, Jim_Obj *objPtr);
3682 static void DupDictSubstInternalRep(Jim_Interp *interp, Jim_Obj *srcPtr,
3685 static Jim_ObjType dictSubstObjType = {
3686 "dict-substitution",
3687 FreeDictSubstInternalRep,
3688 DupDictSubstInternalRep,
3693 void FreeDictSubstInternalRep(Jim_Interp *interp, Jim_Obj *objPtr)
3695 Jim_DecrRefCount(interp, objPtr->internalRep.dictSubstValue.varNameObjPtr);
3696 Jim_DecrRefCount(interp, objPtr->internalRep.dictSubstValue.indexObjPtr);
3699 void DupDictSubstInternalRep(Jim_Interp *interp, Jim_Obj *srcPtr,
3702 JIM_NOTUSED(interp);
3704 dupPtr->internalRep.dictSubstValue.varNameObjPtr =
3705 srcPtr->internalRep.dictSubstValue.varNameObjPtr;
3706 dupPtr->internalRep.dictSubstValue.indexObjPtr =
3707 srcPtr->internalRep.dictSubstValue.indexObjPtr;
3708 dupPtr->typePtr = &dictSubstObjType;
3711 /* This function is used to expand [dict get] sugar in the form
3712 * of $var(INDEX). The function is mainly used by Jim_EvalObj()
3713 * to deal with tokens of type JIM_TT_DICTSUGAR. objPtr points to an
3714 * object that is *guaranteed* to be in the form VARNAME(INDEX).
3715 * The 'index' part is [subst]ituted, and is used to lookup a key inside
3716 * the [dict]ionary contained in variable VARNAME. */
3717 Jim_Obj *Jim_ExpandDictSugar(Jim_Interp *interp, Jim_Obj *objPtr)
3719 Jim_Obj *varObjPtr, *keyObjPtr, *dictObjPtr, *resObjPtr;
3720 Jim_Obj *substKeyObjPtr = NULL;
3722 if (objPtr->typePtr != &dictSubstObjType) {
3723 JimDictSugarParseVarKey(interp, objPtr, &varObjPtr, &keyObjPtr);
3724 Jim_FreeIntRep(interp, objPtr);
3725 objPtr->typePtr = &dictSubstObjType;
3726 objPtr->internalRep.dictSubstValue.varNameObjPtr = varObjPtr;
3727 objPtr->internalRep.dictSubstValue.indexObjPtr = keyObjPtr;
3729 if (Jim_SubstObj(interp, objPtr->internalRep.dictSubstValue.indexObjPtr,
3730 &substKeyObjPtr, JIM_NONE)
3732 substKeyObjPtr = NULL;
3735 Jim_IncrRefCount(substKeyObjPtr);
3736 dictObjPtr = Jim_GetVariable(interp,
3737 objPtr->internalRep.dictSubstValue.varNameObjPtr, JIM_ERRMSG);
3742 if (Jim_DictKey(interp, dictObjPtr, substKeyObjPtr, &resObjPtr, JIM_ERRMSG)
3748 if (substKeyObjPtr) Jim_DecrRefCount(interp, substKeyObjPtr);
3752 /* -----------------------------------------------------------------------------
3754 * ---------------------------------------------------------------------------*/
3756 static Jim_CallFrame *JimCreateCallFrame(Jim_Interp *interp)
3759 if (interp->freeFramesList) {
3760 cf = interp->freeFramesList;
3761 interp->freeFramesList = cf->nextFramePtr;
3763 cf = Jim_Alloc(sizeof(*cf));
3764 cf->vars.table = NULL;
3767 cf->id = interp->callFrameEpoch++;
3768 cf->parentCallFrame = NULL;
3771 cf->procArgsObjPtr = NULL;
3772 cf->procBodyObjPtr = NULL;
3773 cf->nextFramePtr = NULL;
3774 cf->staticVars = NULL;
3775 if (cf->vars.table == NULL)
3776 Jim_InitHashTable(&cf->vars, &JimVariablesHashTableType, interp);
3780 /* Used to invalidate every caching related to callframe stability. */
3781 static void JimChangeCallFrameId(Jim_Interp *interp, Jim_CallFrame *cf)
3783 cf->id = interp->callFrameEpoch++;
3786 #define JIM_FCF_NONE 0 /* no flags */
3787 #define JIM_FCF_NOHT 1 /* don't free the hash table */
3788 static void JimFreeCallFrame(Jim_Interp *interp, Jim_CallFrame *cf,
3791 if (cf->procArgsObjPtr) Jim_DecrRefCount(interp, cf->procArgsObjPtr);
3792 if (cf->procBodyObjPtr) Jim_DecrRefCount(interp, cf->procBodyObjPtr);
3793 if (!(flags & JIM_FCF_NOHT))
3794 Jim_FreeHashTable(&cf->vars);
3797 Jim_HashEntry **table = cf->vars.table, *he;
3799 for (i = 0; i < JIM_HT_INITIAL_SIZE; i++) {
3801 while (he != NULL) {
3802 Jim_HashEntry *nextEntry = he->next;
3803 Jim_Var *varPtr = (void*) he->val;
3805 Jim_DecrRefCount(interp, varPtr->objPtr);
3807 Jim_Free((void*)he->key); /* ATTENTION: const cast */
3815 cf->nextFramePtr = interp->freeFramesList;
3816 interp->freeFramesList = cf;
3819 /* -----------------------------------------------------------------------------
3821 * ---------------------------------------------------------------------------*/
3823 /* References HashTable Type.
3825 * Keys are jim_wide integers, dynamically allocated for now but in the
3826 * future it's worth to cache this 8 bytes objects. Values are poitners
3827 * to Jim_References. */
3828 static void JimReferencesHTValDestructor(void *interp, void *val)
3830 Jim_Reference *refPtr = (void*) val;
3832 Jim_DecrRefCount(interp, refPtr->objPtr);
3833 if (refPtr->finalizerCmdNamePtr != NULL) {
3834 Jim_DecrRefCount(interp, refPtr->finalizerCmdNamePtr);
3839 unsigned int JimReferencesHTHashFunction(const void *key)
3841 /* Only the least significant bits are used. */
3842 const jim_wide *widePtr = key;
3843 unsigned int intValue = (unsigned int) *widePtr;
3844 return Jim_IntHashFunction(intValue);
3847 unsigned int JimReferencesHTDoubleHashFunction(const void *key)
3849 /* Only the least significant bits are used. */
3850 const jim_wide *widePtr = key;
3851 unsigned int intValue = (unsigned int) *widePtr;
3852 return intValue; /* identity function. */
3855 const void *JimReferencesHTKeyDup(void *privdata, const void *key)
3857 void *copy = Jim_Alloc(sizeof(jim_wide));
3858 JIM_NOTUSED(privdata);
3860 memcpy(copy, key, sizeof(jim_wide));
3864 int JimReferencesHTKeyCompare(void *privdata, const void *key1,
3867 JIM_NOTUSED(privdata);
3869 return memcmp(key1, key2, sizeof(jim_wide)) == 0;
3872 void JimReferencesHTKeyDestructor(void *privdata, const void *key)
3874 JIM_NOTUSED(privdata);
3876 Jim_Free((void*)key);
3879 static Jim_HashTableType JimReferencesHashTableType = {
3880 JimReferencesHTHashFunction, /* hash function */
3881 JimReferencesHTKeyDup, /* key dup */
3883 JimReferencesHTKeyCompare, /* key compare */
3884 JimReferencesHTKeyDestructor, /* key destructor */
3885 JimReferencesHTValDestructor /* val destructor */
3888 /* -----------------------------------------------------------------------------
3889 * Reference object type and References API
3890 * ---------------------------------------------------------------------------*/
3892 static void UpdateStringOfReference(struct Jim_Obj *objPtr);
3894 static Jim_ObjType referenceObjType = {
3898 UpdateStringOfReference,
3899 JIM_TYPE_REFERENCES,
3902 void UpdateStringOfReference(struct Jim_Obj *objPtr)
3905 char buf[JIM_REFERENCE_SPACE+1];
3906 Jim_Reference *refPtr;
3908 refPtr = objPtr->internalRep.refValue.refPtr;
3909 len = JimFormatReference(buf, refPtr, objPtr->internalRep.refValue.id);
3910 objPtr->bytes = Jim_Alloc(len+1);
3911 memcpy(objPtr->bytes, buf, len+1);
3912 objPtr->length = len;
3915 /* returns true if 'c' is a valid reference tag character.
3916 * i.e. inside the range [_a-zA-Z0-9] */
3917 static int isrefchar(int c)
3919 if (c == '_' || (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') ||
3920 (c >= '0' && c <= '9')) return 1;
3924 int SetReferenceFromAny(Jim_Interp *interp, Jim_Obj *objPtr)
3928 const char *str, *start, *end;
3930 Jim_Reference *refPtr;
3933 /* Get the string representation */
3934 str = Jim_GetString(objPtr, &len);
3935 /* Check if it looks like a reference */
3936 if (len < JIM_REFERENCE_SPACE) goto badformat;
3940 while (*start == ' ') start++;
3941 while (*end == ' ' && end > start) end--;
3942 if (end-start+1 != JIM_REFERENCE_SPACE) goto badformat;
3943 /* <reference.<1234567>.%020> */
3944 if (memcmp(start, "<reference.<", 12) != 0) goto badformat;
3945 if (start[12+JIM_REFERENCE_TAGLEN] != '>' || end[0] != '>') goto badformat;
3946 /* The tag can't contain chars other than a-zA-Z0-9 + '_'. */
3947 for (i = 0; i < JIM_REFERENCE_TAGLEN; i++) {
3948 if (!isrefchar(start[12+i])) goto badformat;
3950 /* Extract info from the refernece. */
3951 memcpy(refId, start+14+JIM_REFERENCE_TAGLEN, 20);
3953 /* Try to convert the ID into a jim_wide */
3954 if (Jim_StringToWide(refId, &wideValue, 10) != JIM_OK) goto badformat;
3955 /* Check if the reference really exists! */
3956 he = Jim_FindHashEntry(&interp->references, &wideValue);
3958 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3959 Jim_AppendStrings(interp, Jim_GetResult(interp),
3960 "Invalid reference ID \"", str, "\"", NULL);
3964 /* Free the old internal repr and set the new one. */
3965 Jim_FreeIntRep(interp, objPtr);
3966 objPtr->typePtr = &referenceObjType;
3967 objPtr->internalRep.refValue.id = wideValue;
3968 objPtr->internalRep.refValue.refPtr = refPtr;
3972 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3973 Jim_AppendStrings(interp, Jim_GetResult(interp),
3974 "expected reference but got \"", str, "\"", NULL);
3978 /* Returns a new reference pointing to objPtr, having cmdNamePtr
3979 * as finalizer command (or NULL if there is no finalizer).
3980 * The returned reference object has refcount = 0. */
3981 Jim_Obj *Jim_NewReference(Jim_Interp *interp, Jim_Obj *objPtr, Jim_Obj *tagPtr,
3982 Jim_Obj *cmdNamePtr)
3984 struct Jim_Reference *refPtr;
3985 jim_wide wideValue = interp->referenceNextId;
3990 /* Perform the Garbage Collection if needed. */
3991 Jim_CollectIfNeeded(interp);
3993 refPtr = Jim_Alloc(sizeof(*refPtr));
3994 refPtr->objPtr = objPtr;
3995 Jim_IncrRefCount(objPtr);
3996 refPtr->finalizerCmdNamePtr = cmdNamePtr;
3998 Jim_IncrRefCount(cmdNamePtr);
3999 Jim_AddHashEntry(&interp->references, &wideValue, refPtr);
4000 refObjPtr = Jim_NewObj(interp);
4001 refObjPtr->typePtr = &referenceObjType;
4002 refObjPtr->bytes = NULL;
4003 refObjPtr->internalRep.refValue.id = interp->referenceNextId;
4004 refObjPtr->internalRep.refValue.refPtr = refPtr;
4005 interp->referenceNextId++;
4006 /* Set the tag. Trimmered at JIM_REFERENCE_TAGLEN. Everything
4007 * that does not pass the 'isrefchar' test is replaced with '_' */
4008 tag = Jim_GetString(tagPtr, &tagLen);
4009 if (tagLen > JIM_REFERENCE_TAGLEN)
4010 tagLen = JIM_REFERENCE_TAGLEN;
4011 for (i = 0; i < JIM_REFERENCE_TAGLEN; i++) {
4013 refPtr->tag[i] = tag[i];
4015 refPtr->tag[i] = '_';
4017 refPtr->tag[JIM_REFERENCE_TAGLEN] = '\0';
4021 Jim_Reference *Jim_GetReference(Jim_Interp *interp, Jim_Obj *objPtr)
4023 if (objPtr->typePtr != &referenceObjType &&
4024 SetReferenceFromAny(interp, objPtr) == JIM_ERR)
4026 return objPtr->internalRep.refValue.refPtr;
4029 int Jim_SetFinalizer(Jim_Interp *interp, Jim_Obj *objPtr, Jim_Obj *cmdNamePtr)
4031 Jim_Reference *refPtr;
4033 if ((refPtr = Jim_GetReference(interp, objPtr)) == NULL)
4035 Jim_IncrRefCount(cmdNamePtr);
4036 if (refPtr->finalizerCmdNamePtr)
4037 Jim_DecrRefCount(interp, refPtr->finalizerCmdNamePtr);
4038 refPtr->finalizerCmdNamePtr = cmdNamePtr;
4042 int Jim_GetFinalizer(Jim_Interp *interp, Jim_Obj *objPtr, Jim_Obj **cmdNamePtrPtr)
4044 Jim_Reference *refPtr;
4046 if ((refPtr = Jim_GetReference(interp, objPtr)) == NULL)
4048 *cmdNamePtrPtr = refPtr->finalizerCmdNamePtr;
4052 /* -----------------------------------------------------------------------------
4053 * References Garbage Collection
4054 * ---------------------------------------------------------------------------*/
4056 /* This the hash table type for the "MARK" phase of the GC */
4057 static Jim_HashTableType JimRefMarkHashTableType = {
4058 JimReferencesHTHashFunction, /* hash function */
4059 JimReferencesHTKeyDup, /* key dup */
4061 JimReferencesHTKeyCompare, /* key compare */
4062 JimReferencesHTKeyDestructor, /* key destructor */
4063 NULL /* val destructor */
4066 /* #define JIM_DEBUG_GC 1 */
4068 /* Performs the garbage collection. */
4069 int Jim_Collect(Jim_Interp *interp)
4071 Jim_HashTable marks;
4072 Jim_HashTableIterator *htiter;
4077 /* Avoid recursive calls */
4078 if (interp->lastCollectId == -1) {
4079 /* Jim_Collect() already running. Return just now. */
4082 interp->lastCollectId = -1;
4084 /* Mark all the references found into the 'mark' hash table.
4085 * The references are searched in every live object that
4086 * is of a type that can contain references. */
4087 Jim_InitHashTable(&marks, &JimRefMarkHashTableType, NULL);
4088 objPtr = interp->liveList;
4090 if (objPtr->typePtr == NULL ||
4091 objPtr->typePtr->flags & JIM_TYPE_REFERENCES) {
4092 const char *str, *p;
4095 /* If the object is of type reference, to get the
4096 * Id is simple... */
4097 if (objPtr->typePtr == &referenceObjType) {
4098 Jim_AddHashEntry(&marks,
4099 &objPtr->internalRep.refValue.id, NULL);
4101 Jim_fprintf(interp,interp->cookie_stdout,
4102 "MARK (reference): %d refcount: %d" JIM_NL,
4103 (int) objPtr->internalRep.refValue.id,
4106 objPtr = objPtr->nextObjPtr;
4109 /* Get the string repr of the object we want
4110 * to scan for references. */
4111 p = str = Jim_GetString(objPtr, &len);
4112 /* Skip objects too little to contain references. */
4113 if (len < JIM_REFERENCE_SPACE) {
4114 objPtr = objPtr->nextObjPtr;
4117 /* Extract references from the object string repr. */
4123 if ((p = strstr(p, "<reference.<")) == NULL)
4125 /* Check if it's a valid reference. */
4126 if (len-(p-str) < JIM_REFERENCE_SPACE) break;
4127 if (p[41] != '>' || p[19] != '>' || p[20] != '.') break;
4128 for (i = 21; i <= 40; i++)
4129 if (!isdigit((int)p[i]))
4132 memcpy(buf, p+21, 20);
4134 Jim_StringToWide(buf, &id, 10);
4136 /* Ok, a reference for the given ID
4137 * was found. Mark it. */
4138 Jim_AddHashEntry(&marks, &id, NULL);
4140 Jim_fprintf(interp,interp->cookie_stdout,"MARK: %d" JIM_NL, (int)id);
4142 p += JIM_REFERENCE_SPACE;
4145 objPtr = objPtr->nextObjPtr;
4148 /* Run the references hash table to destroy every reference that
4149 * is not referenced outside (not present in the mark HT). */
4150 htiter = Jim_GetHashTableIterator(&interp->references);
4151 while ((he = Jim_NextHashEntry(htiter)) != NULL) {
4152 const jim_wide *refId;
4153 Jim_Reference *refPtr;
4156 /* Check if in the mark phase we encountered
4157 * this reference. */
4158 if (Jim_FindHashEntry(&marks, refId) == NULL) {
4160 Jim_fprintf(interp,interp->cookie_stdout,"COLLECTING %d" JIM_NL, (int)*refId);
4163 /* Drop the reference, but call the
4164 * finalizer first if registered. */
4166 if (refPtr->finalizerCmdNamePtr) {
4167 char *refstr = Jim_Alloc(JIM_REFERENCE_SPACE+1);
4168 Jim_Obj *objv[3], *oldResult;
4170 JimFormatReference(refstr, refPtr, *refId);
4172 objv[0] = refPtr->finalizerCmdNamePtr;
4173 objv[1] = Jim_NewStringObjNoAlloc(interp,
4175 objv[2] = refPtr->objPtr;
4176 Jim_IncrRefCount(objv[0]);
4177 Jim_IncrRefCount(objv[1]);
4178 Jim_IncrRefCount(objv[2]);
4180 /* Drop the reference itself */
4181 Jim_DeleteHashEntry(&interp->references, refId);
4183 /* Call the finalizer. Errors ignored. */
4184 oldResult = interp->result;
4185 Jim_IncrRefCount(oldResult);
4186 Jim_EvalObjVector(interp, 3, objv);
4187 Jim_SetResult(interp, oldResult);
4188 Jim_DecrRefCount(interp, oldResult);
4190 Jim_DecrRefCount(interp, objv[0]);
4191 Jim_DecrRefCount(interp, objv[1]);
4192 Jim_DecrRefCount(interp, objv[2]);
4194 Jim_DeleteHashEntry(&interp->references, refId);
4198 Jim_FreeHashTableIterator(htiter);
4199 Jim_FreeHashTable(&marks);
4200 interp->lastCollectId = interp->referenceNextId;
4201 interp->lastCollectTime = time(NULL);
4205 #define JIM_COLLECT_ID_PERIOD 5000
4206 #define JIM_COLLECT_TIME_PERIOD 300
4208 void Jim_CollectIfNeeded(Jim_Interp *interp)
4213 elapsedId = interp->referenceNextId - interp->lastCollectId;
4214 elapsedTime = time(NULL) - interp->lastCollectTime;
4217 if (elapsedId > JIM_COLLECT_ID_PERIOD ||
4218 elapsedTime > JIM_COLLECT_TIME_PERIOD) {
4219 Jim_Collect(interp);
4223 /* -----------------------------------------------------------------------------
4224 * Interpreter related functions
4225 * ---------------------------------------------------------------------------*/
4227 Jim_Interp *Jim_CreateInterp(void)
4229 Jim_Interp *i = Jim_Alloc(sizeof(*i));
4233 i->errorFileName = Jim_StrDup("");
4235 i->maxNestingDepth = JIM_MAX_NESTING_DEPTH;
4236 i->returnCode = JIM_OK;
4239 i->callFrameEpoch = 0;
4240 i->liveList = i->freeList = NULL;
4241 i->scriptFileName = Jim_StrDup("");
4242 i->referenceNextId = 0;
4243 i->lastCollectId = 0;
4244 i->lastCollectTime = time(NULL);
4245 i->freeFramesList = NULL;
4246 i->prngState = NULL;
4247 i->evalRetcodeLevel = -1;
4248 i->cookie_stdin = stdin;
4249 i->cookie_stdout = stdout;
4250 i->cookie_stderr = stderr;
4251 i->cb_fwrite = ((size_t (*)( const void *, size_t, size_t, void *))(fwrite));
4252 i->cb_fread = ((size_t (*)( void *, size_t, size_t, void *))(fread));
4253 i->cb_vfprintf = ((int (*)( void *, const char *fmt, va_list ))(vfprintf));
4254 i->cb_fflush = ((int (*)( void *))(fflush));
4255 i->cb_fgets = ((char * (*)( char *, int, void *))(fgets));
4257 /* Note that we can create objects only after the
4258 * interpreter liveList and freeList pointers are
4259 * initialized to NULL. */
4260 Jim_InitHashTable(&i->commands, &JimCommandsHashTableType, i);
4261 Jim_InitHashTable(&i->references, &JimReferencesHashTableType, i);
4262 Jim_InitHashTable(&i->sharedStrings, &JimSharedStringsHashTableType,
4264 Jim_InitHashTable(&i->stub, &JimStringCopyHashTableType, NULL);
4265 Jim_InitHashTable(&i->assocData, &JimAssocDataHashTableType, i);
4266 Jim_InitHashTable(&i->packages, &JimStringKeyValCopyHashTableType, NULL);
4267 i->framePtr = i->topFramePtr = JimCreateCallFrame(i);
4268 i->emptyObj = Jim_NewEmptyStringObj(i);
4269 i->result = i->emptyObj;
4270 i->stackTrace = Jim_NewListObj(i, NULL, 0);
4271 i->unknown = Jim_NewStringObj(i, "unknown", -1);
4272 Jim_IncrRefCount(i->emptyObj);
4273 Jim_IncrRefCount(i->result);
4274 Jim_IncrRefCount(i->stackTrace);
4275 Jim_IncrRefCount(i->unknown);
4277 /* Initialize key variables every interpreter should contain */
4278 pathPtr = Jim_NewStringObj(i, "./", -1);
4279 Jim_SetVariableStr(i, "jim_libpath", pathPtr);
4280 Jim_SetVariableStrWithStr(i, "jim_interactive", "0");
4282 /* Export the core API to extensions */
4283 JimRegisterCoreApi(i);
4287 /* This is the only function Jim exports directly without
4288 * to use the STUB system. It is only used by embedders
4289 * in order to get an interpreter with the Jim API pointers
4291 Jim_Interp *ExportedJimCreateInterp(void)
4293 return Jim_CreateInterp();
4296 void Jim_FreeInterp(Jim_Interp *i)
4298 Jim_CallFrame *cf = i->framePtr, *prevcf, *nextcf;
4299 Jim_Obj *objPtr, *nextObjPtr;
4301 Jim_DecrRefCount(i, i->emptyObj);
4302 Jim_DecrRefCount(i, i->result);
4303 Jim_DecrRefCount(i, i->stackTrace);
4304 Jim_DecrRefCount(i, i->unknown);
4305 Jim_Free((void*)i->errorFileName);
4306 Jim_Free((void*)i->scriptFileName);
4307 Jim_FreeHashTable(&i->commands);
4308 Jim_FreeHashTable(&i->references);
4309 Jim_FreeHashTable(&i->stub);
4310 Jim_FreeHashTable(&i->assocData);
4311 Jim_FreeHashTable(&i->packages);
4312 Jim_Free(i->prngState);
4313 /* Free the call frames list */
4315 prevcf = cf->parentCallFrame;
4316 JimFreeCallFrame(i, cf, JIM_FCF_NONE);
4319 /* Check that the live object list is empty, otherwise
4320 * there is a memory leak. */
4321 if (i->liveList != NULL) {
4322 Jim_Obj *objPtr = i->liveList;
4324 Jim_fprintf( i, i->cookie_stdout,JIM_NL "-------------------------------------" JIM_NL);
4325 Jim_fprintf( i, i->cookie_stdout,"Objects still in the free list:" JIM_NL);
4327 const char *type = objPtr->typePtr ?
4328 objPtr->typePtr->name : "";
4329 Jim_fprintf( i, i->cookie_stdout,"%p \"%-10s\": '%.20s' (refCount: %d)" JIM_NL,
4331 objPtr->bytes ? objPtr->bytes
4332 : "(null)", objPtr->refCount);
4333 if (objPtr->typePtr == &sourceObjType) {
4334 Jim_fprintf( i, i->cookie_stdout, "FILE %s LINE %d" JIM_NL,
4335 objPtr->internalRep.sourceValue.fileName,
4336 objPtr->internalRep.sourceValue.lineNumber);
4338 objPtr = objPtr->nextObjPtr;
4340 Jim_fprintf( i, i->cookie_stdout, "-------------------------------------" JIM_NL JIM_NL);
4341 Jim_Panic(i,"Live list non empty freeing the interpreter! Leak?");
4343 /* Free all the freed objects. */
4344 objPtr = i->freeList;
4346 nextObjPtr = objPtr->nextObjPtr;
4348 objPtr = nextObjPtr;
4350 /* Free cached CallFrame structures */
4351 cf = i->freeFramesList;
4353 nextcf = cf->nextFramePtr;
4354 if (cf->vars.table != NULL)
4355 Jim_Free(cf->vars.table);
4359 /* Free the sharedString hash table. Make sure to free it
4360 * after every other Jim_Object was freed. */
4361 Jim_FreeHashTable(&i->sharedStrings);
4362 /* Free the interpreter structure. */
4366 /* Store the call frame relative to the level represented by
4367 * levelObjPtr into *framePtrPtr. If levelObjPtr == NULL, the
4368 * level is assumed to be '1'.
4370 * If a newLevelptr int pointer is specified, the function stores
4371 * the absolute level integer value of the new target callframe into
4372 * *newLevelPtr. (this is used to adjust interp->numLevels
4373 * in the implementation of [uplevel], so that [info level] will
4374 * return a correct information).
4376 * This function accepts the 'level' argument in the form
4377 * of the commands [uplevel] and [upvar].
4379 * For a function accepting a relative integer as level suitable
4380 * for implementation of [info level ?level?] check the
4381 * GetCallFrameByInteger() function. */
4382 int Jim_GetCallFrameByLevel(Jim_Interp *interp, Jim_Obj *levelObjPtr,
4383 Jim_CallFrame **framePtrPtr, int *newLevelPtr)
4387 Jim_CallFrame *framePtr;
4389 if (newLevelPtr) *newLevelPtr = interp->numLevels;
4391 str = Jim_GetString(levelObjPtr, NULL);
4392 if (str[0] == '#') {
4394 /* speedup for the toplevel (level #0) */
4395 if (str[1] == '0' && str[2] == '\0') {
4396 if (newLevelPtr) *newLevelPtr = 0;
4397 *framePtrPtr = interp->topFramePtr;
4401 level = strtol(str+1, &endptr, 0);
4402 if (str[1] == '\0' || endptr[0] != '\0' || level < 0)
4404 /* An 'absolute' level is converted into the
4405 * 'number of levels to go back' format. */
4406 level = interp->numLevels - level;
4407 if (level < 0) goto badlevel;
4409 if (Jim_GetLong(interp, levelObjPtr, &level) != JIM_OK || level < 0)
4413 str = "1"; /* Needed to format the error message. */
4417 framePtr = interp->framePtr;
4418 if (newLevelPtr) *newLevelPtr = (*newLevelPtr)-level;
4420 framePtr = framePtr->parentCallFrame;
4421 if (framePtr == NULL) goto badlevel;
4423 *framePtrPtr = framePtr;
4426 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4427 Jim_AppendStrings(interp, Jim_GetResult(interp),
4428 "bad level \"", str, "\"", NULL);
4432 /* Similar to Jim_GetCallFrameByLevel() but the level is specified
4433 * as a relative integer like in the [info level ?level?] command. */
4434 static int JimGetCallFrameByInteger(Jim_Interp *interp, Jim_Obj *levelObjPtr,
4435 Jim_CallFrame **framePtrPtr)
4438 jim_wide relLevel; /* level relative to the current one. */
4439 Jim_CallFrame *framePtr;
4441 if (Jim_GetWide(interp, levelObjPtr, &level) != JIM_OK)
4444 /* An 'absolute' level is converted into the
4445 * 'number of levels to go back' format. */
4446 relLevel = interp->numLevels - level;
4451 framePtr = interp->framePtr;
4452 while (relLevel--) {
4453 framePtr = framePtr->parentCallFrame;
4454 if (framePtr == NULL) goto badlevel;
4456 *framePtrPtr = framePtr;
4459 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4460 Jim_AppendStrings(interp, Jim_GetResult(interp),
4461 "bad level \"", Jim_GetString(levelObjPtr, NULL), "\"", NULL);
4465 static void JimSetErrorFileName(Jim_Interp *interp, char *filename)
4467 Jim_Free((void*)interp->errorFileName);
4468 interp->errorFileName = Jim_StrDup(filename);
4471 static void JimSetErrorLineNumber(Jim_Interp *interp, int linenr)
4473 interp->errorLine = linenr;
4476 static void JimResetStackTrace(Jim_Interp *interp)
4478 Jim_DecrRefCount(interp, interp->stackTrace);
4479 interp->stackTrace = Jim_NewListObj(interp, NULL, 0);
4480 Jim_IncrRefCount(interp->stackTrace);
4483 static void JimAppendStackTrace(Jim_Interp *interp, const char *procname,
4484 const char *filename, int linenr)
4486 if (Jim_IsShared(interp->stackTrace)) {
4487 interp->stackTrace =
4488 Jim_DuplicateObj(interp, interp->stackTrace);
4489 Jim_IncrRefCount(interp->stackTrace);
4491 Jim_ListAppendElement(interp, interp->stackTrace,
4492 Jim_NewStringObj(interp, procname, -1));
4493 Jim_ListAppendElement(interp, interp->stackTrace,
4494 Jim_NewStringObj(interp, filename, -1));
4495 Jim_ListAppendElement(interp, interp->stackTrace,
4496 Jim_NewIntObj(interp, linenr));
4499 int Jim_SetAssocData(Jim_Interp *interp, const char *key, Jim_InterpDeleteProc *delProc, void *data)
4501 AssocDataValue *assocEntryPtr = (AssocDataValue *)Jim_Alloc(sizeof(AssocDataValue));
4502 assocEntryPtr->delProc = delProc;
4503 assocEntryPtr->data = data;
4504 return Jim_AddHashEntry(&interp->assocData, key, assocEntryPtr);
4507 void *Jim_GetAssocData(Jim_Interp *interp, const char *key)
4509 Jim_HashEntry *entryPtr = Jim_FindHashEntry(&interp->assocData, key);
4510 if (entryPtr != NULL) {
4511 AssocDataValue *assocEntryPtr = (AssocDataValue *)entryPtr->val;
4512 return assocEntryPtr->data;
4517 int Jim_DeleteAssocData(Jim_Interp *interp, const char *key)
4519 return Jim_DeleteHashEntry(&interp->assocData, key);
4522 int Jim_GetExitCode(Jim_Interp *interp) {
4523 return interp->exitCode;
4526 void *Jim_SetStdin(Jim_Interp *interp, void *fp)
4528 if (fp != NULL) interp->cookie_stdin = fp;
4529 return interp->cookie_stdin;
4532 void *Jim_SetStdout(Jim_Interp *interp, void *fp)
4534 if (fp != NULL) interp->cookie_stdout = fp;
4535 return interp->cookie_stdout;
4538 void *Jim_SetStderr(Jim_Interp *interp, void *fp)
4540 if (fp != NULL) interp->cookie_stderr = fp;
4541 return interp->cookie_stderr;
4544 /* -----------------------------------------------------------------------------
4546 * Every interpreter has an hash table where to put shared dynamically
4547 * allocate strings that are likely to be used a lot of times.
4548 * For example, in the 'source' object type, there is a pointer to
4549 * the filename associated with that object. Every script has a lot
4550 * of this objects with the identical file name, so it is wise to share
4553 * The API is trivial: Jim_GetSharedString(interp, "foobar")
4554 * returns the pointer to the shared string. Every time a reference
4555 * to the string is no longer used, the user should call
4556 * Jim_ReleaseSharedString(interp, stringPointer). Once no one is using
4557 * a given string, it is removed from the hash table.
4558 * ---------------------------------------------------------------------------*/
4559 const char *Jim_GetSharedString(Jim_Interp *interp, const char *str)
4561 Jim_HashEntry *he = Jim_FindHashEntry(&interp->sharedStrings, str);
4564 char *strCopy = Jim_StrDup(str);
4566 Jim_AddHashEntry(&interp->sharedStrings, strCopy, (void*)1);
4569 long refCount = (long) he->val;
4572 he->val = (void*) refCount;
4577 void Jim_ReleaseSharedString(Jim_Interp *interp, const char *str)
4580 Jim_HashEntry *he = Jim_FindHashEntry(&interp->sharedStrings, str);
4583 Jim_Panic(interp,"Jim_ReleaseSharedString called with "
4584 "unknown shared string '%s'", str);
4585 refCount = (long) he->val;
4587 if (refCount == 0) {
4588 Jim_DeleteHashEntry(&interp->sharedStrings, str);
4590 he->val = (void*) refCount;
4594 /* -----------------------------------------------------------------------------
4596 * ---------------------------------------------------------------------------*/
4597 #define JIM_INTEGER_SPACE 24
4599 static void UpdateStringOfInt(struct Jim_Obj *objPtr);
4600 static int SetIntFromAny(Jim_Interp *interp, Jim_Obj *objPtr, int flags);
4602 static Jim_ObjType intObjType = {
4610 void UpdateStringOfInt(struct Jim_Obj *objPtr)
4613 char buf[JIM_INTEGER_SPACE+1];
4615 len = Jim_WideToString(buf, objPtr->internalRep.wideValue);
4616 objPtr->bytes = Jim_Alloc(len+1);
4617 memcpy(objPtr->bytes, buf, len+1);
4618 objPtr->length = len;
4621 int SetIntFromAny(Jim_Interp *interp, Jim_Obj *objPtr, int flags)
4626 /* Get the string representation */
4627 str = Jim_GetString(objPtr, NULL);
4628 /* Try to convert into a jim_wide */
4629 if (Jim_StringToWide(str, &wideValue, 0) != JIM_OK) {
4630 if (flags & JIM_ERRMSG) {
4631 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4632 Jim_AppendStrings(interp, Jim_GetResult(interp),
4633 "expected integer but got \"", str, "\"", NULL);
4637 if ((wideValue == JIM_WIDE_MIN || wideValue == JIM_WIDE_MAX) &&
4639 Jim_SetResultString(interp,
4640 "Integer value too big to be represented", -1);
4643 /* Free the old internal repr and set the new one. */
4644 Jim_FreeIntRep(interp, objPtr);
4645 objPtr->typePtr = &intObjType;
4646 objPtr->internalRep.wideValue = wideValue;
4650 int Jim_GetWide(Jim_Interp *interp, Jim_Obj *objPtr, jim_wide *widePtr)
4652 if (objPtr->typePtr != &intObjType &&
4653 SetIntFromAny(interp, objPtr, JIM_ERRMSG) == JIM_ERR)
4655 *widePtr = objPtr->internalRep.wideValue;
4659 /* Get a wide but does not set an error if the format is bad. */
4660 static int JimGetWideNoErr(Jim_Interp *interp, Jim_Obj *objPtr,
4663 if (objPtr->typePtr != &intObjType &&
4664 SetIntFromAny(interp, objPtr, JIM_NONE) == JIM_ERR)
4666 *widePtr = objPtr->internalRep.wideValue;
4670 int Jim_GetLong(Jim_Interp *interp, Jim_Obj *objPtr, long *longPtr)
4675 retval = Jim_GetWide(interp, objPtr, &wideValue);
4676 if (retval == JIM_OK) {
4677 *longPtr = (long) wideValue;
4683 void Jim_SetWide(Jim_Interp *interp, Jim_Obj *objPtr, jim_wide wideValue)
4685 if (Jim_IsShared(objPtr))
4686 Jim_Panic(interp,"Jim_SetWide called with shared object");
4687 if (objPtr->typePtr != &intObjType) {
4688 Jim_FreeIntRep(interp, objPtr);
4689 objPtr->typePtr = &intObjType;
4691 Jim_InvalidateStringRep(objPtr);
4692 objPtr->internalRep.wideValue = wideValue;
4695 Jim_Obj *Jim_NewIntObj(Jim_Interp *interp, jim_wide wideValue)
4699 objPtr = Jim_NewObj(interp);
4700 objPtr->typePtr = &intObjType;
4701 objPtr->bytes = NULL;
4702 objPtr->internalRep.wideValue = wideValue;
4706 /* -----------------------------------------------------------------------------
4708 * ---------------------------------------------------------------------------*/
4709 #define JIM_DOUBLE_SPACE 30
4711 static void UpdateStringOfDouble(struct Jim_Obj *objPtr);
4712 static int SetDoubleFromAny(Jim_Interp *interp, Jim_Obj *objPtr);
4714 static Jim_ObjType doubleObjType = {
4718 UpdateStringOfDouble,
4722 void UpdateStringOfDouble(struct Jim_Obj *objPtr)
4725 char buf[JIM_DOUBLE_SPACE+1];
4727 len = Jim_DoubleToString(buf, objPtr->internalRep.doubleValue);
4728 objPtr->bytes = Jim_Alloc(len+1);
4729 memcpy(objPtr->bytes, buf, len+1);
4730 objPtr->length = len;
4733 int SetDoubleFromAny(Jim_Interp *interp, Jim_Obj *objPtr)
4738 /* Get the string representation */
4739 str = Jim_GetString(objPtr, NULL);
4740 /* Try to convert into a double */
4741 if (Jim_StringToDouble(str, &doubleValue) != JIM_OK) {
4742 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4743 Jim_AppendStrings(interp, Jim_GetResult(interp),
4744 "expected number but got '", str, "'", NULL);
4747 /* Free the old internal repr and set the new one. */
4748 Jim_FreeIntRep(interp, objPtr);
4749 objPtr->typePtr = &doubleObjType;
4750 objPtr->internalRep.doubleValue = doubleValue;
4754 int Jim_GetDouble(Jim_Interp *interp, Jim_Obj *objPtr, double *doublePtr)
4756 if (objPtr->typePtr != &doubleObjType &&
4757 SetDoubleFromAny(interp, objPtr) == JIM_ERR)
4759 *doublePtr = objPtr->internalRep.doubleValue;
4763 void Jim_SetDouble(Jim_Interp *interp, Jim_Obj *objPtr, double doubleValue)
4765 if (Jim_IsShared(objPtr))
4766 Jim_Panic(interp,"Jim_SetDouble called with shared object");
4767 if (objPtr->typePtr != &doubleObjType) {
4768 Jim_FreeIntRep(interp, objPtr);
4769 objPtr->typePtr = &doubleObjType;
4771 Jim_InvalidateStringRep(objPtr);
4772 objPtr->internalRep.doubleValue = doubleValue;
4775 Jim_Obj *Jim_NewDoubleObj(Jim_Interp *interp, double doubleValue)
4779 objPtr = Jim_NewObj(interp);
4780 objPtr->typePtr = &doubleObjType;
4781 objPtr->bytes = NULL;
4782 objPtr->internalRep.doubleValue = doubleValue;
4786 /* -----------------------------------------------------------------------------
4788 * ---------------------------------------------------------------------------*/
4789 static void ListAppendElement(Jim_Obj *listPtr, Jim_Obj *objPtr);
4790 static void FreeListInternalRep(Jim_Interp *interp, Jim_Obj *objPtr);
4791 static void DupListInternalRep(Jim_Interp *interp, Jim_Obj *srcPtr, Jim_Obj *dupPtr);
4792 static void UpdateStringOfList(struct Jim_Obj *objPtr);
4793 static int SetListFromAny(Jim_Interp *interp, struct Jim_Obj *objPtr);
4795 /* Note that while the elements of the list may contain references,
4796 * the list object itself can't. This basically means that the
4797 * list object string representation as a whole can't contain references
4798 * that are not presents in the single elements. */
4799 static Jim_ObjType listObjType = {
4801 FreeListInternalRep,
4807 void FreeListInternalRep(Jim_Interp *interp, Jim_Obj *objPtr)
4811 for (i = 0; i < objPtr->internalRep.listValue.len; i++) {
4812 Jim_DecrRefCount(interp, objPtr->internalRep.listValue.ele[i]);
4814 Jim_Free(objPtr->internalRep.listValue.ele);
4817 void DupListInternalRep(Jim_Interp *interp, Jim_Obj *srcPtr, Jim_Obj *dupPtr)
4820 JIM_NOTUSED(interp);
4822 dupPtr->internalRep.listValue.len = srcPtr->internalRep.listValue.len;
4823 dupPtr->internalRep.listValue.maxLen = srcPtr->internalRep.listValue.maxLen;
4824 dupPtr->internalRep.listValue.ele =
4825 Jim_Alloc(sizeof(Jim_Obj*)*srcPtr->internalRep.listValue.maxLen);
4826 memcpy(dupPtr->internalRep.listValue.ele, srcPtr->internalRep.listValue.ele,
4827 sizeof(Jim_Obj*)*srcPtr->internalRep.listValue.len);
4828 for (i = 0; i < dupPtr->internalRep.listValue.len; i++) {
4829 Jim_IncrRefCount(dupPtr->internalRep.listValue.ele[i]);
4831 dupPtr->typePtr = &listObjType;
4834 /* The following function checks if a given string can be encoded
4835 * into a list element without any kind of quoting, surrounded by braces,
4836 * or using escapes to quote. */
4837 #define JIM_ELESTR_SIMPLE 0
4838 #define JIM_ELESTR_BRACE 1
4839 #define JIM_ELESTR_QUOTE 2
4840 static int ListElementQuotingType(const char *s, int len)
4842 int i, level, trySimple = 1;
4844 /* Try with the SIMPLE case */
4845 if (len == 0) return JIM_ELESTR_BRACE;
4846 if (s[0] == '"' || s[0] == '{') {
4850 for (i = 0; i < len; i++) {
4870 return JIM_ELESTR_SIMPLE;
4873 /* Test if it's possible to do with braces */
4874 if (s[len-1] == '\\' ||
4875 s[len-1] == ']') return JIM_ELESTR_QUOTE;
4877 for (i = 0; i < len; i++) {
4879 case '{': level++; break;
4881 if (level < 0) return JIM_ELESTR_QUOTE;
4885 return JIM_ELESTR_QUOTE;
4887 if (s[i+1] != '\0') i++;
4892 if (!trySimple) return JIM_ELESTR_BRACE;
4893 for (i = 0; i < len; i++) {
4907 return JIM_ELESTR_BRACE;
4911 return JIM_ELESTR_SIMPLE;
4913 return JIM_ELESTR_QUOTE;
4916 /* Returns the malloc-ed representation of a string
4917 * using backslash to quote special chars. */
4918 char *BackslashQuoteString(const char *s, int len, int *qlenPtr)
4920 char *q = Jim_Alloc(len*2+1), *p;
4937 case '\n': *p++ = '\\'; *p++ = 'n'; s++; break;
4938 case '\r': *p++ = '\\'; *p++ = 'r'; s++; break;
4939 case '\t': *p++ = '\\'; *p++ = 't'; s++; break;
4940 case '\f': *p++ = '\\'; *p++ = 'f'; s++; break;
4941 case '\v': *p++ = '\\'; *p++ = 'v'; s++; break;
4952 void UpdateStringOfList(struct Jim_Obj *objPtr)
4954 int i, bufLen, realLength;
4958 Jim_Obj **ele = objPtr->internalRep.listValue.ele;
4960 /* (Over) Estimate the space needed. */
4961 quotingType = Jim_Alloc(sizeof(int)*objPtr->internalRep.listValue.len+1);
4963 for (i = 0; i < objPtr->internalRep.listValue.len; i++) {
4966 strRep = Jim_GetString(ele[i], &len);
4967 quotingType[i] = ListElementQuotingType(strRep, len);
4968 switch (quotingType[i]) {
4969 case JIM_ELESTR_SIMPLE: bufLen += len; break;
4970 case JIM_ELESTR_BRACE: bufLen += len+2; break;
4971 case JIM_ELESTR_QUOTE: bufLen += len*2; break;
4973 bufLen++; /* elements separator. */
4977 /* Generate the string rep. */
4978 p = objPtr->bytes = Jim_Alloc(bufLen+1);
4980 for (i = 0; i < objPtr->internalRep.listValue.len; i++) {
4982 const char *strRep = Jim_GetString(ele[i], &len);
4985 switch(quotingType[i]) {
4986 case JIM_ELESTR_SIMPLE:
4987 memcpy(p, strRep, len);
4991 case JIM_ELESTR_BRACE:
4993 memcpy(p, strRep, len);
4996 realLength += len+2;
4998 case JIM_ELESTR_QUOTE:
4999 q = BackslashQuoteString(strRep, len, &qlen);
5006 /* Add a separating space */
5007 if (i+1 != objPtr->internalRep.listValue.len) {
5012 *p = '\0'; /* nul term. */
5013 objPtr->length = realLength;
5014 Jim_Free(quotingType);
5017 int SetListFromAny(Jim_Interp *interp, struct Jim_Obj *objPtr)
5019 struct JimParserCtx parser;
5023 /* Get the string representation */
5024 str = Jim_GetString(objPtr, &strLen);
5026 /* Free the old internal repr just now and initialize the
5027 * new one just now. The string->list conversion can't fail. */
5028 Jim_FreeIntRep(interp, objPtr);
5029 objPtr->typePtr = &listObjType;
5030 objPtr->internalRep.listValue.len = 0;
5031 objPtr->internalRep.listValue.maxLen = 0;
5032 objPtr->internalRep.listValue.ele = NULL;
5034 /* Convert into a list */
5035 JimParserInit(&parser, str, strLen, 1);
5036 while(!JimParserEof(&parser)) {
5039 Jim_Obj *elementPtr;
5041 JimParseList(&parser);
5042 if (JimParserTtype(&parser) != JIM_TT_STR &&
5043 JimParserTtype(&parser) != JIM_TT_ESC)
5045 token = JimParserGetToken(&parser, &tokenLen, &type, NULL);
5046 elementPtr = Jim_NewStringObjNoAlloc(interp, token, tokenLen);
5047 ListAppendElement(objPtr, elementPtr);
5052 Jim_Obj *Jim_NewListObj(Jim_Interp *interp, Jim_Obj *const *elements,
5058 objPtr = Jim_NewObj(interp);
5059 objPtr->typePtr = &listObjType;
5060 objPtr->bytes = NULL;
5061 objPtr->internalRep.listValue.ele = NULL;
5062 objPtr->internalRep.listValue.len = 0;
5063 objPtr->internalRep.listValue.maxLen = 0;
5064 for (i = 0; i < len; i++) {
5065 ListAppendElement(objPtr, elements[i]);
5070 /* Return a vector of Jim_Obj with the elements of a Jim list, and the
5071 * length of the vector. Note that the user of this function should make
5072 * sure that the list object can't shimmer while the vector returned
5073 * is in use, this vector is the one stored inside the internal representation
5074 * of the list object. This function is not exported, extensions should
5075 * always access to the List object elements using Jim_ListIndex(). */
5076 static void JimListGetElements(Jim_Interp *interp, Jim_Obj *listObj, int *argc,
5079 Jim_ListLength(interp, listObj, argc);
5080 assert(listObj->typePtr == &listObjType);
5081 *listVec = listObj->internalRep.listValue.ele;
5084 /* ListSortElements type values */
5085 enum {JIM_LSORT_ASCII, JIM_LSORT_NOCASE, JIM_LSORT_ASCII_DECR,
5086 JIM_LSORT_NOCASE_DECR};
5088 /* Sort the internal rep of a list. */
5089 static int ListSortString(Jim_Obj **lhsObj, Jim_Obj **rhsObj)
5091 return Jim_StringCompareObj(*lhsObj, *rhsObj, 0);
5094 static int ListSortStringDecr(Jim_Obj **lhsObj, Jim_Obj **rhsObj)
5096 return Jim_StringCompareObj(*lhsObj, *rhsObj, 0) * -1;
5099 static int ListSortStringNoCase(Jim_Obj **lhsObj, Jim_Obj **rhsObj)
5101 return Jim_StringCompareObj(*lhsObj, *rhsObj, 1);
5104 static int ListSortStringNoCaseDecr(Jim_Obj **lhsObj, Jim_Obj **rhsObj)
5106 return Jim_StringCompareObj(*lhsObj, *rhsObj, 1) * -1;
5109 /* Sort a list *in place*. MUST be called with non-shared objects. */
5110 static void ListSortElements(Jim_Interp *interp, Jim_Obj *listObjPtr, int type)
5112 typedef int (qsort_comparator)(const void *, const void *);
5113 int (*fn)(Jim_Obj**, Jim_Obj**);
5117 if (Jim_IsShared(listObjPtr))
5118 Jim_Panic(interp,"Jim_ListSortElements called with shared object");
5119 if (listObjPtr->typePtr != &listObjType)
5120 SetListFromAny(interp, listObjPtr);
5122 vector = listObjPtr->internalRep.listValue.ele;
5123 len = listObjPtr->internalRep.listValue.len;
5125 case JIM_LSORT_ASCII: fn = ListSortString; break;
5126 case JIM_LSORT_NOCASE: fn = ListSortStringNoCase; break;
5127 case JIM_LSORT_ASCII_DECR: fn = ListSortStringDecr; break;
5128 case JIM_LSORT_NOCASE_DECR: fn = ListSortStringNoCaseDecr; break;
5130 fn = NULL; /* avoid warning */
5131 Jim_Panic(interp,"ListSort called with invalid sort type");
5133 qsort(vector, len, sizeof(Jim_Obj *), (qsort_comparator *)fn);
5134 Jim_InvalidateStringRep(listObjPtr);
5137 /* This is the low-level function to append an element to a list.
5138 * The higher-level Jim_ListAppendElement() performs shared object
5139 * check and invalidate the string repr. This version is used
5140 * in the internals of the List Object and is not exported.
5142 * NOTE: this function can be called only against objects
5143 * with internal type of List. */
5144 void ListAppendElement(Jim_Obj *listPtr, Jim_Obj *objPtr)
5146 int requiredLen = listPtr->internalRep.listValue.len + 1;
5148 if (requiredLen > listPtr->internalRep.listValue.maxLen) {
5149 int maxLen = requiredLen * 2;
5151 listPtr->internalRep.listValue.ele =
5152 Jim_Realloc(listPtr->internalRep.listValue.ele,
5153 sizeof(Jim_Obj*)*maxLen);
5154 listPtr->internalRep.listValue.maxLen = maxLen;
5156 listPtr->internalRep.listValue.ele[listPtr->internalRep.listValue.len] =
5158 listPtr->internalRep.listValue.len ++;
5159 Jim_IncrRefCount(objPtr);
5162 /* This is the low-level function to insert elements into a list.
5163 * The higher-level Jim_ListInsertElements() performs shared object
5164 * check and invalidate the string repr. This version is used
5165 * in the internals of the List Object and is not exported.
5167 * NOTE: this function can be called only against objects
5168 * with internal type of List. */
5169 void ListInsertElements(Jim_Obj *listPtr, int index, int elemc,
5170 Jim_Obj *const *elemVec)
5172 int currentLen = listPtr->internalRep.listValue.len;
5173 int requiredLen = currentLen + elemc;
5177 if (requiredLen > listPtr->internalRep.listValue.maxLen) {
5178 int maxLen = requiredLen * 2;
5180 listPtr->internalRep.listValue.ele =
5181 Jim_Realloc(listPtr->internalRep.listValue.ele,
5182 sizeof(Jim_Obj*)*maxLen);
5183 listPtr->internalRep.listValue.maxLen = maxLen;
5185 point = listPtr->internalRep.listValue.ele + index;
5186 memmove(point+elemc, point, (currentLen-index) * sizeof(Jim_Obj*));
5187 for (i=0; i < elemc; ++i) {
5188 point[i] = elemVec[i];
5189 Jim_IncrRefCount(point[i]);
5191 listPtr->internalRep.listValue.len += elemc;
5194 /* Appends every element of appendListPtr into listPtr.
5195 * Both have to be of the list type. */
5196 void ListAppendList(Jim_Obj *listPtr, Jim_Obj *appendListPtr)
5198 int i, oldLen = listPtr->internalRep.listValue.len;
5199 int appendLen = appendListPtr->internalRep.listValue.len;
5200 int requiredLen = oldLen + appendLen;
5202 if (requiredLen > listPtr->internalRep.listValue.maxLen) {
5203 int maxLen = requiredLen * 2;
5205 listPtr->internalRep.listValue.ele =
5206 Jim_Realloc(listPtr->internalRep.listValue.ele,
5207 sizeof(Jim_Obj*)*maxLen);
5208 listPtr->internalRep.listValue.maxLen = maxLen;
5210 for (i = 0; i < appendLen; i++) {
5211 Jim_Obj *objPtr = appendListPtr->internalRep.listValue.ele[i];
5212 listPtr->internalRep.listValue.ele[oldLen+i] = objPtr;
5213 Jim_IncrRefCount(objPtr);
5215 listPtr->internalRep.listValue.len += appendLen;
5218 void Jim_ListAppendElement(Jim_Interp *interp, Jim_Obj *listPtr, Jim_Obj *objPtr)
5220 if (Jim_IsShared(listPtr))
5221 Jim_Panic(interp,"Jim_ListAppendElement called with shared object");
5222 if (listPtr->typePtr != &listObjType)
5223 SetListFromAny(interp, listPtr);
5224 Jim_InvalidateStringRep(listPtr);
5225 ListAppendElement(listPtr, objPtr);
5228 void Jim_ListAppendList(Jim_Interp *interp, Jim_Obj *listPtr, Jim_Obj *appendListPtr)
5230 if (Jim_IsShared(listPtr))
5231 Jim_Panic(interp,"Jim_ListAppendList called with shared object");
5232 if (listPtr->typePtr != &listObjType)
5233 SetListFromAny(interp, listPtr);
5234 Jim_InvalidateStringRep(listPtr);
5235 ListAppendList(listPtr, appendListPtr);
5238 void Jim_ListLength(Jim_Interp *interp, Jim_Obj *listPtr, int *intPtr)
5240 if (listPtr->typePtr != &listObjType)
5241 SetListFromAny(interp, listPtr);
5242 *intPtr = listPtr->internalRep.listValue.len;
5245 void Jim_ListInsertElements(Jim_Interp *interp, Jim_Obj *listPtr, int index,
5246 int objc, Jim_Obj *const *objVec)
5248 if (Jim_IsShared(listPtr))
5249 Jim_Panic(interp,"Jim_ListInsertElement called with shared object");
5250 if (listPtr->typePtr != &listObjType)
5251 SetListFromAny(interp, listPtr);
5252 if (index >= 0 && index > listPtr->internalRep.listValue.len)
5253 index = listPtr->internalRep.listValue.len;
5254 else if (index < 0 )
5256 Jim_InvalidateStringRep(listPtr);
5257 ListInsertElements(listPtr, index, objc, objVec);
5260 int Jim_ListIndex(Jim_Interp *interp, Jim_Obj *listPtr, int index,
5261 Jim_Obj **objPtrPtr, int flags)
5263 if (listPtr->typePtr != &listObjType)
5264 SetListFromAny(interp, listPtr);
5265 if ((index >= 0 && index >= listPtr->internalRep.listValue.len) ||
5266 (index < 0 && (-index-1) >= listPtr->internalRep.listValue.len)) {
5267 if (flags & JIM_ERRMSG) {
5268 Jim_SetResultString(interp,
5269 "list index out of range", -1);
5274 index = listPtr->internalRep.listValue.len+index;
5275 *objPtrPtr = listPtr->internalRep.listValue.ele[index];
5279 static int ListSetIndex(Jim_Interp *interp, Jim_Obj *listPtr, int index,
5280 Jim_Obj *newObjPtr, int flags)
5282 if (listPtr->typePtr != &listObjType)
5283 SetListFromAny(interp, listPtr);
5284 if ((index >= 0 && index >= listPtr->internalRep.listValue.len) ||
5285 (index < 0 && (-index-1) >= listPtr->internalRep.listValue.len)) {
5286 if (flags & JIM_ERRMSG) {
5287 Jim_SetResultString(interp,
5288 "list index out of range", -1);
5293 index = listPtr->internalRep.listValue.len+index;
5294 Jim_DecrRefCount(interp, listPtr->internalRep.listValue.ele[index]);
5295 listPtr->internalRep.listValue.ele[index] = newObjPtr;
5296 Jim_IncrRefCount(newObjPtr);
5300 /* Modify the list stored into the variable named 'varNamePtr'
5301 * setting the element specified by the 'indexc' indexes objects in 'indexv',
5302 * with the new element 'newObjptr'. */
5303 int Jim_SetListIndex(Jim_Interp *interp, Jim_Obj *varNamePtr,
5304 Jim_Obj *const *indexv, int indexc, Jim_Obj *newObjPtr)
5306 Jim_Obj *varObjPtr, *objPtr, *listObjPtr;
5307 int shared, i, index;
5309 varObjPtr = objPtr = Jim_GetVariable(interp, varNamePtr, JIM_ERRMSG);
5312 if ((shared = Jim_IsShared(objPtr)))
5313 varObjPtr = objPtr = Jim_DuplicateObj(interp, objPtr);
5314 for (i = 0; i < indexc-1; i++) {
5315 listObjPtr = objPtr;
5316 if (Jim_GetIndex(interp, indexv[i], &index) != JIM_OK)
5318 if (Jim_ListIndex(interp, listObjPtr, index, &objPtr,
5319 JIM_ERRMSG) != JIM_OK) {
5322 if (Jim_IsShared(objPtr)) {
5323 objPtr = Jim_DuplicateObj(interp, objPtr);
5324 ListSetIndex(interp, listObjPtr, index, objPtr, JIM_NONE);
5326 Jim_InvalidateStringRep(listObjPtr);
5328 if (Jim_GetIndex(interp, indexv[indexc-1], &index) != JIM_OK)
5330 if (ListSetIndex(interp, objPtr, index, newObjPtr, JIM_ERRMSG) == JIM_ERR)
5332 Jim_InvalidateStringRep(objPtr);
5333 Jim_InvalidateStringRep(varObjPtr);
5334 if (Jim_SetVariable(interp, varNamePtr, varObjPtr) != JIM_OK)
5336 Jim_SetResult(interp, varObjPtr);
5340 Jim_FreeNewObj(interp, varObjPtr);
5345 Jim_Obj *Jim_ConcatObj(Jim_Interp *interp, int objc, Jim_Obj *const *objv)
5349 /* If all the objects in objv are lists without string rep.
5350 * it's possible to return a list as result, that's the
5351 * concatenation of all the lists. */
5352 for (i = 0; i < objc; i++) {
5353 if (objv[i]->typePtr != &listObjType || objv[i]->bytes)
5357 Jim_Obj *objPtr = Jim_NewListObj(interp, NULL, 0);
5358 for (i = 0; i < objc; i++)
5359 Jim_ListAppendList(interp, objPtr, objv[i]);
5362 /* Else... we have to glue strings together */
5363 int len = 0, objLen;
5366 /* Compute the length */
5367 for (i = 0; i < objc; i++) {
5368 Jim_GetString(objv[i], &objLen);
5371 if (objc) len += objc-1;
5372 /* Create the string rep, and a stinrg object holding it. */
5373 p = bytes = Jim_Alloc(len+1);
5374 for (i = 0; i < objc; i++) {
5375 const char *s = Jim_GetString(objv[i], &objLen);
5376 while (objLen && (*s == ' ' || *s == '\t' || *s == '\n'))
5378 s++; objLen--; len--;
5380 while (objLen && (s[objLen-1] == ' ' ||
5381 s[objLen-1] == '\n' || s[objLen-1] == '\t')) {
5384 memcpy(p, s, objLen);
5386 if (objLen && i+1 != objc) {
5388 } else if (i+1 != objc) {
5389 /* Drop the space calcuated for this
5390 * element that is instead null. */
5395 return Jim_NewStringObjNoAlloc(interp, bytes, len);
5399 /* Returns a list composed of the elements in the specified range.
5400 * first and start are directly accepted as Jim_Objects and
5401 * processed for the end?-index? case. */
5402 Jim_Obj *Jim_ListRange(Jim_Interp *interp, Jim_Obj *listObjPtr, Jim_Obj *firstObjPtr, Jim_Obj *lastObjPtr)
5407 if (Jim_GetIndex(interp, firstObjPtr, &first) != JIM_OK ||
5408 Jim_GetIndex(interp, lastObjPtr, &last) != JIM_OK)
5410 Jim_ListLength(interp, listObjPtr, &len); /* will convert into list */
5411 first = JimRelToAbsIndex(len, first);
5412 last = JimRelToAbsIndex(len, last);
5413 JimRelToAbsRange(len, first, last, &first, &last, &rangeLen);
5414 return Jim_NewListObj(interp,
5415 listObjPtr->internalRep.listValue.ele+first, rangeLen);
5418 /* -----------------------------------------------------------------------------
5420 * ---------------------------------------------------------------------------*/
5421 static void FreeDictInternalRep(Jim_Interp *interp, Jim_Obj *objPtr);
5422 static void DupDictInternalRep(Jim_Interp *interp, Jim_Obj *srcPtr, Jim_Obj *dupPtr);
5423 static void UpdateStringOfDict(struct Jim_Obj *objPtr);
5424 static int SetDictFromAny(Jim_Interp *interp, struct Jim_Obj *objPtr);
5426 /* Dict HashTable Type.
5428 * Keys and Values are Jim objects. */
5430 unsigned int JimObjectHTHashFunction(const void *key)
5433 Jim_Obj *objPtr = (Jim_Obj*) key;
5436 str = Jim_GetString(objPtr, &len);
5437 h = Jim_GenHashFunction((unsigned char*)str, len);
5441 int JimObjectHTKeyCompare(void *privdata, const void *key1, const void *key2)
5443 JIM_NOTUSED(privdata);
5445 return Jim_StringEqObj((Jim_Obj*)key1, (Jim_Obj*)key2, 0);
5448 static void JimObjectHTKeyValDestructor(void *interp, void *val)
5450 Jim_Obj *objPtr = val;
5452 Jim_DecrRefCount(interp, objPtr);
5455 static Jim_HashTableType JimDictHashTableType = {
5456 JimObjectHTHashFunction, /* hash function */
5459 JimObjectHTKeyCompare, /* key compare */
5460 (void(*)(void*, const void*)) /* ATTENTION: const cast */
5461 JimObjectHTKeyValDestructor, /* key destructor */
5462 JimObjectHTKeyValDestructor /* val destructor */
5465 /* Note that while the elements of the dict may contain references,
5466 * the list object itself can't. This basically means that the
5467 * dict object string representation as a whole can't contain references
5468 * that are not presents in the single elements. */
5469 static Jim_ObjType dictObjType = {
5471 FreeDictInternalRep,
5477 void FreeDictInternalRep(Jim_Interp *interp, Jim_Obj *objPtr)
5479 JIM_NOTUSED(interp);
5481 Jim_FreeHashTable(objPtr->internalRep.ptr);
5482 Jim_Free(objPtr->internalRep.ptr);
5485 void DupDictInternalRep(Jim_Interp *interp, Jim_Obj *srcPtr, Jim_Obj *dupPtr)
5487 Jim_HashTable *ht, *dupHt;
5488 Jim_HashTableIterator *htiter;
5491 /* Create a new hash table */
5492 ht = srcPtr->internalRep.ptr;
5493 dupHt = Jim_Alloc(sizeof(*dupHt));
5494 Jim_InitHashTable(dupHt, &JimDictHashTableType, interp);
5496 Jim_ExpandHashTable(dupHt, ht->size);
5497 /* Copy every element from the source to the dup hash table */
5498 htiter = Jim_GetHashTableIterator(ht);
5499 while ((he = Jim_NextHashEntry(htiter)) != NULL) {
5500 const Jim_Obj *keyObjPtr = he->key;
5501 Jim_Obj *valObjPtr = he->val;
5503 Jim_IncrRefCount((Jim_Obj*)keyObjPtr); /* ATTENTION: const cast */
5504 Jim_IncrRefCount(valObjPtr);
5505 Jim_AddHashEntry(dupHt, keyObjPtr, valObjPtr);
5507 Jim_FreeHashTableIterator(htiter);
5509 dupPtr->internalRep.ptr = dupHt;
5510 dupPtr->typePtr = &dictObjType;
5513 void UpdateStringOfDict(struct Jim_Obj *objPtr)
5515 int i, bufLen, realLength;
5518 int *quotingType, objc;
5520 Jim_HashTableIterator *htiter;
5524 /* Trun the hash table into a flat vector of Jim_Objects. */
5525 ht = objPtr->internalRep.ptr;
5527 objv = Jim_Alloc(objc*sizeof(Jim_Obj*));
5528 htiter = Jim_GetHashTableIterator(ht);
5530 while ((he = Jim_NextHashEntry(htiter)) != NULL) {
5531 objv[i++] = (Jim_Obj*)he->key; /* ATTENTION: const cast */
5532 objv[i++] = he->val;
5534 Jim_FreeHashTableIterator(htiter);
5535 /* (Over) Estimate the space needed. */
5536 quotingType = Jim_Alloc(sizeof(int)*objc);
5538 for (i = 0; i < objc; i++) {
5541 strRep = Jim_GetString(objv[i], &len);
5542 quotingType[i] = ListElementQuotingType(strRep, len);
5543 switch (quotingType[i]) {
5544 case JIM_ELESTR_SIMPLE: bufLen += len; break;
5545 case JIM_ELESTR_BRACE: bufLen += len+2; break;
5546 case JIM_ELESTR_QUOTE: bufLen += len*2; break;
5548 bufLen++; /* elements separator. */
5552 /* Generate the string rep. */
5553 p = objPtr->bytes = Jim_Alloc(bufLen+1);
5555 for (i = 0; i < objc; i++) {
5557 const char *strRep = Jim_GetString(objv[i], &len);
5560 switch(quotingType[i]) {
5561 case JIM_ELESTR_SIMPLE:
5562 memcpy(p, strRep, len);
5566 case JIM_ELESTR_BRACE:
5568 memcpy(p, strRep, len);
5571 realLength += len+2;
5573 case JIM_ELESTR_QUOTE:
5574 q = BackslashQuoteString(strRep, len, &qlen);
5581 /* Add a separating space */
5587 *p = '\0'; /* nul term. */
5588 objPtr->length = realLength;
5589 Jim_Free(quotingType);
5593 int SetDictFromAny(Jim_Interp *interp, struct Jim_Obj *objPtr)
5595 struct JimParserCtx parser;
5601 /* Get the string representation */
5602 str = Jim_GetString(objPtr, &strLen);
5604 /* Free the old internal repr just now and initialize the
5605 * new one just now. The string->list conversion can't fail. */
5606 Jim_FreeIntRep(interp, objPtr);
5607 ht = Jim_Alloc(sizeof(*ht));
5608 Jim_InitHashTable(ht, &JimDictHashTableType, interp);
5609 objPtr->typePtr = &dictObjType;
5610 objPtr->internalRep.ptr = ht;
5612 /* Convert into a dict */
5613 JimParserInit(&parser, str, strLen, 1);
5615 while(!JimParserEof(&parser)) {
5619 JimParseList(&parser);
5620 if (JimParserTtype(&parser) != JIM_TT_STR &&
5621 JimParserTtype(&parser) != JIM_TT_ESC)
5623 token = JimParserGetToken(&parser, &tokenLen, &type, NULL);
5624 objv[i++] = Jim_NewStringObjNoAlloc(interp, token, tokenLen);
5627 Jim_IncrRefCount(objv[0]);
5628 Jim_IncrRefCount(objv[1]);
5629 if (Jim_AddHashEntry(ht, objv[0], objv[1]) != JIM_OK) {
5631 he = Jim_FindHashEntry(ht, objv[0]);
5632 Jim_DecrRefCount(interp, objv[0]);
5633 /* ATTENTION: const cast */
5634 Jim_DecrRefCount(interp, (Jim_Obj*)he->val);
5640 Jim_FreeNewObj(interp, objv[0]);
5641 objPtr->typePtr = NULL;
5642 Jim_FreeHashTable(ht);
5643 Jim_SetResultString(interp, "invalid dictionary value: must be a list with an even number of elements", -1);
5649 /* Dict object API */
5651 /* Add an element to a dict. objPtr must be of the "dict" type.
5652 * The higer-level exported function is Jim_DictAddElement().
5653 * If an element with the specified key already exists, the value
5654 * associated is replaced with the new one.
5656 * if valueObjPtr == NULL, the key is instead removed if it exists. */
5657 static void DictAddElement(Jim_Interp *interp, Jim_Obj *objPtr,
5658 Jim_Obj *keyObjPtr, Jim_Obj *valueObjPtr)
5660 Jim_HashTable *ht = objPtr->internalRep.ptr;
5662 if (valueObjPtr == NULL) { /* unset */
5663 Jim_DeleteHashEntry(ht, keyObjPtr);
5666 Jim_IncrRefCount(keyObjPtr);
5667 Jim_IncrRefCount(valueObjPtr);
5668 if (Jim_AddHashEntry(ht, keyObjPtr, valueObjPtr) != JIM_OK) {
5669 Jim_HashEntry *he = Jim_FindHashEntry(ht, keyObjPtr);
5670 Jim_DecrRefCount(interp, keyObjPtr);
5671 /* ATTENTION: const cast */
5672 Jim_DecrRefCount(interp, (Jim_Obj*)he->val);
5673 he->val = valueObjPtr;
5677 /* Add an element, higher-level interface for DictAddElement().
5678 * If valueObjPtr == NULL, the key is removed if it exists. */
5679 int Jim_DictAddElement(Jim_Interp *interp, Jim_Obj *objPtr,
5680 Jim_Obj *keyObjPtr, Jim_Obj *valueObjPtr)
5682 if (Jim_IsShared(objPtr))
5683 Jim_Panic(interp,"Jim_DictAddElement called with shared object");
5684 if (objPtr->typePtr != &dictObjType) {
5685 if (SetDictFromAny(interp, objPtr) != JIM_OK)
5688 DictAddElement(interp, objPtr, keyObjPtr, valueObjPtr);
5689 Jim_InvalidateStringRep(objPtr);
5693 Jim_Obj *Jim_NewDictObj(Jim_Interp *interp, Jim_Obj *const *elements, int len)
5699 Jim_Panic(interp,"Jim_NewDicObj() 'len' argument must be even");
5701 objPtr = Jim_NewObj(interp);
5702 objPtr->typePtr = &dictObjType;
5703 objPtr->bytes = NULL;
5704 objPtr->internalRep.ptr = Jim_Alloc(sizeof(Jim_HashTable));
5705 Jim_InitHashTable(objPtr->internalRep.ptr, &JimDictHashTableType, interp);
5706 for (i = 0; i < len; i += 2)
5707 DictAddElement(interp, objPtr, elements[i], elements[i+1]);
5711 /* Return the value associated to the specified dict key */
5712 int Jim_DictKey(Jim_Interp *interp, Jim_Obj *dictPtr, Jim_Obj *keyPtr,
5713 Jim_Obj **objPtrPtr, int flags)
5718 if (dictPtr->typePtr != &dictObjType) {
5719 if (SetDictFromAny(interp, dictPtr) != JIM_OK)
5722 ht = dictPtr->internalRep.ptr;
5723 if ((he = Jim_FindHashEntry(ht, keyPtr)) == NULL) {
5724 if (flags & JIM_ERRMSG) {
5725 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
5726 Jim_AppendStrings(interp, Jim_GetResult(interp),
5727 "key \"", Jim_GetString(keyPtr, NULL),
5728 "\" not found in dictionary", NULL);
5732 *objPtrPtr = he->val;
5736 /* Return the value associated to the specified dict keys */
5737 int Jim_DictKeysVector(Jim_Interp *interp, Jim_Obj *dictPtr,
5738 Jim_Obj *const *keyv, int keyc, Jim_Obj **objPtrPtr, int flags)
5744 *objPtrPtr = dictPtr;
5748 for (i = 0; i < keyc; i++) {
5749 if (Jim_DictKey(interp, dictPtr, keyv[i], &objPtr, flags)
5754 *objPtrPtr = objPtr;
5758 /* Modify the dict stored into the variable named 'varNamePtr'
5759 * setting the element specified by the 'keyc' keys objects in 'keyv',
5760 * with the new value of the element 'newObjPtr'.
5762 * If newObjPtr == NULL the operation is to remove the given key
5763 * from the dictionary. */
5764 int Jim_SetDictKeysVector(Jim_Interp *interp, Jim_Obj *varNamePtr,
5765 Jim_Obj *const *keyv, int keyc, Jim_Obj *newObjPtr)
5767 Jim_Obj *varObjPtr, *objPtr, *dictObjPtr;
5770 varObjPtr = objPtr = Jim_GetVariable(interp, varNamePtr, JIM_ERRMSG);
5771 if (objPtr == NULL) {
5772 if (newObjPtr == NULL) /* Cannot remove a key from non existing var */
5774 varObjPtr = objPtr = Jim_NewDictObj(interp, NULL, 0);
5775 if (Jim_SetVariable(interp, varNamePtr, objPtr) != JIM_OK) {
5776 Jim_FreeNewObj(interp, varObjPtr);
5780 if ((shared = Jim_IsShared(objPtr)))
5781 varObjPtr = objPtr = Jim_DuplicateObj(interp, objPtr);
5782 for (i = 0; i < keyc-1; i++) {
5783 dictObjPtr = objPtr;
5785 /* Check if it's a valid dictionary */
5786 if (dictObjPtr->typePtr != &dictObjType) {
5787 if (SetDictFromAny(interp, dictObjPtr) != JIM_OK)
5790 /* Check if the given key exists. */
5791 Jim_InvalidateStringRep(dictObjPtr);
5792 if (Jim_DictKey(interp, dictObjPtr, keyv[i], &objPtr,
5793 newObjPtr ? JIM_NONE : JIM_ERRMSG) == JIM_OK)
5795 /* This key exists at the current level.
5796 * Make sure it's not shared!. */
5797 if (Jim_IsShared(objPtr)) {
5798 objPtr = Jim_DuplicateObj(interp, objPtr);
5799 DictAddElement(interp, dictObjPtr, keyv[i], objPtr);
5802 /* Key not found. If it's an [unset] operation
5803 * this is an error. Only the last key may not
5805 if (newObjPtr == NULL)
5807 /* Otherwise set an empty dictionary
5808 * as key's value. */
5809 objPtr = Jim_NewDictObj(interp, NULL, 0);
5810 DictAddElement(interp, dictObjPtr, keyv[i], objPtr);
5813 if (Jim_DictAddElement(interp, objPtr, keyv[keyc-1], newObjPtr)
5816 Jim_InvalidateStringRep(objPtr);
5817 Jim_InvalidateStringRep(varObjPtr);
5818 if (Jim_SetVariable(interp, varNamePtr, varObjPtr) != JIM_OK)
5820 Jim_SetResult(interp, varObjPtr);
5824 Jim_FreeNewObj(interp, varObjPtr);
5829 /* -----------------------------------------------------------------------------
5831 * ---------------------------------------------------------------------------*/
5832 static void UpdateStringOfIndex(struct Jim_Obj *objPtr);
5833 static int SetIndexFromAny(Jim_Interp *interp, struct Jim_Obj *objPtr);
5835 static Jim_ObjType indexObjType = {
5839 UpdateStringOfIndex,
5843 void UpdateStringOfIndex(struct Jim_Obj *objPtr)
5846 char buf[JIM_INTEGER_SPACE+1];
5848 if (objPtr->internalRep.indexValue >= 0)
5849 len = sprintf(buf, "%d", objPtr->internalRep.indexValue);
5850 else if (objPtr->internalRep.indexValue == -1)
5851 len = sprintf(buf, "end");
5853 len = sprintf(buf, "end%d", objPtr->internalRep.indexValue+1);
5855 objPtr->bytes = Jim_Alloc(len+1);
5856 memcpy(objPtr->bytes, buf, len+1);
5857 objPtr->length = len;
5860 int SetIndexFromAny(Jim_Interp *interp, Jim_Obj *objPtr)
5865 /* Get the string representation */
5866 str = Jim_GetString(objPtr, NULL);
5867 /* Try to convert into an index */
5868 if (!strcmp(str, "end")) {
5872 if (!strncmp(str, "end-", 4)) {
5876 if (Jim_StringToIndex(str, &index) != JIM_OK) {
5877 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
5878 Jim_AppendStrings(interp, Jim_GetResult(interp),
5879 "bad index \"", Jim_GetString(objPtr, NULL), "\": "
5880 "must be integer or end?-integer?", NULL);
5889 } else if (!end && index < 0)
5891 /* Free the old internal repr and set the new one. */
5892 Jim_FreeIntRep(interp, objPtr);
5893 objPtr->typePtr = &indexObjType;
5894 objPtr->internalRep.indexValue = index;
5898 int Jim_GetIndex(Jim_Interp *interp, Jim_Obj *objPtr, int *indexPtr)
5900 /* Avoid shimmering if the object is an integer. */
5901 if (objPtr->typePtr == &intObjType) {
5902 jim_wide val = objPtr->internalRep.wideValue;
5903 if (!(val < LONG_MIN) && !(val > LONG_MAX)) {
5904 *indexPtr = (val < 0) ? -INT_MAX : (long)val;;
5908 if (objPtr->typePtr != &indexObjType &&
5909 SetIndexFromAny(interp, objPtr) == JIM_ERR)
5911 *indexPtr = objPtr->internalRep.indexValue;
5915 /* -----------------------------------------------------------------------------
5916 * Return Code Object.
5917 * ---------------------------------------------------------------------------*/
5919 static int SetReturnCodeFromAny(Jim_Interp *interp, Jim_Obj *objPtr);
5921 static Jim_ObjType returnCodeObjType = {
5929 int SetReturnCodeFromAny(Jim_Interp *interp, Jim_Obj *objPtr)
5932 int strLen, returnCode;
5935 /* Get the string representation */
5936 str = Jim_GetString(objPtr, &strLen);
5937 /* Try to convert into an integer */
5938 if (JimGetWideNoErr(interp, objPtr, &wideValue) != JIM_ERR)
5939 returnCode = (int) wideValue;
5940 else if (!JimStringCompare(str, strLen, "ok", 2, JIM_NOCASE))
5941 returnCode = JIM_OK;
5942 else if (!JimStringCompare(str, strLen, "error", 5, JIM_NOCASE))
5943 returnCode = JIM_ERR;
5944 else if (!JimStringCompare(str, strLen, "return", 6, JIM_NOCASE))
5945 returnCode = JIM_RETURN;
5946 else if (!JimStringCompare(str, strLen, "break", 5, JIM_NOCASE))
5947 returnCode = JIM_BREAK;
5948 else if (!JimStringCompare(str, strLen, "continue", 8, JIM_NOCASE))
5949 returnCode = JIM_CONTINUE;
5950 else if (!JimStringCompare(str, strLen, "eval", 4, JIM_NOCASE))
5951 returnCode = JIM_EVAL;
5952 else if (!JimStringCompare(str, strLen, "exit", 4, JIM_NOCASE))
5953 returnCode = JIM_EXIT;
5955 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
5956 Jim_AppendStrings(interp, Jim_GetResult(interp),
5957 "expected return code but got '", str, "'",
5961 /* Free the old internal repr and set the new one. */
5962 Jim_FreeIntRep(interp, objPtr);
5963 objPtr->typePtr = &returnCodeObjType;
5964 objPtr->internalRep.returnCode = returnCode;
5968 int Jim_GetReturnCode(Jim_Interp *interp, Jim_Obj *objPtr, int *intPtr)
5970 if (objPtr->typePtr != &returnCodeObjType &&
5971 SetReturnCodeFromAny(interp, objPtr) == JIM_ERR)
5973 *intPtr = objPtr->internalRep.returnCode;
5977 /* -----------------------------------------------------------------------------
5978 * Expression Parsing
5979 * ---------------------------------------------------------------------------*/
5980 static int JimParseExprOperator(struct JimParserCtx *pc);
5981 static int JimParseExprNumber(struct JimParserCtx *pc);
5982 static int JimParseExprIrrational(struct JimParserCtx *pc);
5984 /* Exrp's Stack machine operators opcodes. */
5986 /* Binary operators (numbers) */
5987 #define JIM_EXPROP_BINARY_NUM_FIRST 0 /* first */
5988 #define JIM_EXPROP_MUL 0
5989 #define JIM_EXPROP_DIV 1
5990 #define JIM_EXPROP_MOD 2
5991 #define JIM_EXPROP_SUB 3
5992 #define JIM_EXPROP_ADD 4
5993 #define JIM_EXPROP_LSHIFT 5
5994 #define JIM_EXPROP_RSHIFT 6
5995 #define JIM_EXPROP_ROTL 7
5996 #define JIM_EXPROP_ROTR 8
5997 #define JIM_EXPROP_LT 9
5998 #define JIM_EXPROP_GT 10
5999 #define JIM_EXPROP_LTE 11
6000 #define JIM_EXPROP_GTE 12
6001 #define JIM_EXPROP_NUMEQ 13
6002 #define JIM_EXPROP_NUMNE 14
6003 #define JIM_EXPROP_BITAND 15
6004 #define JIM_EXPROP_BITXOR 16
6005 #define JIM_EXPROP_BITOR 17
6006 #define JIM_EXPROP_LOGICAND 18
6007 #define JIM_EXPROP_LOGICOR 19
6008 #define JIM_EXPROP_LOGICAND_LEFT 20
6009 #define JIM_EXPROP_LOGICOR_LEFT 21
6010 #define JIM_EXPROP_POW 22
6011 #define JIM_EXPROP_BINARY_NUM_LAST 22 /* last */
6013 /* Binary operators (strings) */
6014 #define JIM_EXPROP_STREQ 23
6015 #define JIM_EXPROP_STRNE 24
6017 /* Unary operators (numbers) */
6018 #define JIM_EXPROP_NOT 25
6019 #define JIM_EXPROP_BITNOT 26
6020 #define JIM_EXPROP_UNARYMINUS 27
6021 #define JIM_EXPROP_UNARYPLUS 28
6022 #define JIM_EXPROP_LOGICAND_RIGHT 29
6023 #define JIM_EXPROP_LOGICOR_RIGHT 30
6025 /* Ternary operators */
6026 #define JIM_EXPROP_TERNARY 31
6029 #define JIM_EXPROP_NUMBER 32
6030 #define JIM_EXPROP_COMMAND 33
6031 #define JIM_EXPROP_VARIABLE 34
6032 #define JIM_EXPROP_DICTSUGAR 35
6033 #define JIM_EXPROP_SUBST 36
6034 #define JIM_EXPROP_STRING 37
6036 /* Operators table */
6037 typedef struct Jim_ExprOperator {
6044 /* name - precedence - arity - opcode */
6045 static struct Jim_ExprOperator Jim_ExprOperators[] = {
6046 {"!", 300, 1, JIM_EXPROP_NOT},
6047 {"~", 300, 1, JIM_EXPROP_BITNOT},
6048 {"unarymin", 300, 1, JIM_EXPROP_UNARYMINUS},
6049 {"unaryplus", 300, 1, JIM_EXPROP_UNARYPLUS},
6051 {"**", 250, 2, JIM_EXPROP_POW},
6053 {"*", 200, 2, JIM_EXPROP_MUL},
6054 {"/", 200, 2, JIM_EXPROP_DIV},
6055 {"%", 200, 2, JIM_EXPROP_MOD},
6057 {"-", 100, 2, JIM_EXPROP_SUB},
6058 {"+", 100, 2, JIM_EXPROP_ADD},
6060 {"<<<", 90, 3, JIM_EXPROP_ROTL},
6061 {">>>", 90, 3, JIM_EXPROP_ROTR},
6062 {"<<", 90, 2, JIM_EXPROP_LSHIFT},
6063 {">>", 90, 2, JIM_EXPROP_RSHIFT},
6065 {"<", 80, 2, JIM_EXPROP_LT},
6066 {">", 80, 2, JIM_EXPROP_GT},
6067 {"<=", 80, 2, JIM_EXPROP_LTE},
6068 {">=", 80, 2, JIM_EXPROP_GTE},
6070 {"==", 70, 2, JIM_EXPROP_NUMEQ},
6071 {"!=", 70, 2, JIM_EXPROP_NUMNE},
6073 {"eq", 60, 2, JIM_EXPROP_STREQ},
6074 {"ne", 60, 2, JIM_EXPROP_STRNE},
6076 {"&", 50, 2, JIM_EXPROP_BITAND},
6077 {"^", 49, 2, JIM_EXPROP_BITXOR},
6078 {"|", 48, 2, JIM_EXPROP_BITOR},
6080 {"&&", 10, 2, JIM_EXPROP_LOGICAND},
6081 {"||", 10, 2, JIM_EXPROP_LOGICOR},
6083 {"?", 5, 3, JIM_EXPROP_TERNARY},
6084 /* private operators */
6085 {NULL, 10, 2, JIM_EXPROP_LOGICAND_LEFT},
6086 {NULL, 10, 1, JIM_EXPROP_LOGICAND_RIGHT},
6087 {NULL, 10, 2, JIM_EXPROP_LOGICOR_LEFT},
6088 {NULL, 10, 1, JIM_EXPROP_LOGICOR_RIGHT},
6091 #define JIM_EXPR_OPERATORS_NUM \
6092 (sizeof(Jim_ExprOperators)/sizeof(struct Jim_ExprOperator))
6094 int JimParseExpression(struct JimParserCtx *pc)
6096 /* Discard spaces and quoted newline */
6097 while(*(pc->p) == ' ' ||
6101 (*(pc->p) == '\\' && *(pc->p+1) == '\n')) {
6106 pc->tstart = pc->tend = pc->p;
6107 pc->tline = pc->linenr;
6108 pc->tt = JIM_TT_EOL;
6114 pc->tstart = pc->tend = pc->p;
6115 pc->tline = pc->linenr;
6116 pc->tt = JIM_TT_SUBEXPR_START;
6120 pc->tstart = pc->tend = pc->p;
6121 pc->tline = pc->linenr;
6122 pc->tt = JIM_TT_SUBEXPR_END;
6126 return JimParseCmd(pc);
6129 if (JimParseVar(pc) == JIM_ERR)
6130 return JimParseExprOperator(pc);
6135 if ((pc->tt == JIM_TT_NONE || pc->tt == JIM_TT_EXPR_OPERATOR) &&
6136 isdigit((int)*(pc->p+1)))
6137 return JimParseExprNumber(pc);
6139 return JimParseExprOperator(pc);
6141 case '0': case '1': case '2': case '3': case '4':
6142 case '5': case '6': case '7': case '8': case '9': case '.':
6143 return JimParseExprNumber(pc);
6147 /* Here it's possible to reuse the List String parsing. */
6148 pc->tt = JIM_TT_NONE; /* Make sure it's sensed as a new word. */
6149 return JimParseListStr(pc);
6153 if (JimParseExprIrrational(pc) == JIM_ERR)
6154 return JimParseExprOperator(pc);
6157 return JimParseExprOperator(pc);
6163 int JimParseExprNumber(struct JimParserCtx *pc)
6169 pc->tline = pc->linenr;
6170 if (*pc->p == '-') {
6173 while ( isdigit((int)*pc->p)
6174 || (allowhex && isxdigit((int)*pc->p) )
6175 || (allowdot && *pc->p == '.')
6176 || (pc->p-pc->tstart == 1 && *pc->tstart == '0' &&
6177 (*pc->p == 'x' || *pc->p == 'X'))
6180 if ((*pc->p == 'x') || (*pc->p == 'X')) {
6187 if (!allowdot && *pc->p == 'e' && *(pc->p+1) == '-') {
6188 pc->p += 2; pc->len -= 2;
6192 pc->tt = JIM_TT_EXPR_NUMBER;
6196 int JimParseExprIrrational(struct JimParserCtx *pc)
6198 const char *Tokens[] = {"NaN", "nan", "NAN", "Inf", "inf", "INF", NULL};
6200 for (token = Tokens; *token != NULL; token++) {
6201 int len = strlen(*token);
6202 if (strncmp(*token, pc->p, len) == 0) {
6204 pc->tend = pc->p + len - 1;
6205 pc->p += len; pc->len -= len;
6206 pc->tline = pc->linenr;
6207 pc->tt = JIM_TT_EXPR_NUMBER;
6214 int JimParseExprOperator(struct JimParserCtx *pc)
6217 int bestIdx = -1, bestLen = 0;
6219 /* Try to get the longest match. */
6220 for (i = 0; i < (signed)JIM_EXPR_OPERATORS_NUM; i++) {
6224 opname = Jim_ExprOperators[i].name;
6225 if (opname == NULL) continue;
6226 oplen = strlen(opname);
6228 if (strncmp(opname, pc->p, oplen) == 0 && oplen > bestLen) {
6233 if (bestIdx == -1) return JIM_ERR;
6235 pc->tend = pc->p + bestLen - 1;
6236 pc->p += bestLen; pc->len -= bestLen;
6237 pc->tline = pc->linenr;
6238 pc->tt = JIM_TT_EXPR_OPERATOR;
6242 struct Jim_ExprOperator *JimExprOperatorInfo(const char *opname)
6245 for (i = 0; i < (signed)JIM_EXPR_OPERATORS_NUM; i++)
6246 if (Jim_ExprOperators[i].name &&
6247 strcmp(opname, Jim_ExprOperators[i].name) == 0)
6248 return &Jim_ExprOperators[i];
6252 struct Jim_ExprOperator *JimExprOperatorInfoByOpcode(int opcode)
6255 for (i = 0; i < (signed)JIM_EXPR_OPERATORS_NUM; i++)
6256 if (Jim_ExprOperators[i].opcode == opcode)
6257 return &Jim_ExprOperators[i];
6261 /* -----------------------------------------------------------------------------
6263 * ---------------------------------------------------------------------------*/
6264 static void FreeExprInternalRep(Jim_Interp *interp, Jim_Obj *objPtr);
6265 static void DupExprInternalRep(Jim_Interp *interp, Jim_Obj *srcPtr, Jim_Obj *dupPtr);
6266 static int SetExprFromAny(Jim_Interp *interp, struct Jim_Obj *objPtr);
6268 static Jim_ObjType exprObjType = {
6270 FreeExprInternalRep,
6273 JIM_TYPE_REFERENCES,
6276 /* Expr bytecode structure */
6277 typedef struct ExprByteCode {
6278 int *opcode; /* Integer array of opcodes. */
6279 Jim_Obj **obj; /* Array of associated Jim Objects. */
6280 int len; /* Bytecode length */
6281 int inUse; /* Used for sharing. */
6284 void FreeExprInternalRep(Jim_Interp *interp, Jim_Obj *objPtr)
6287 ExprByteCode *expr = (void*) objPtr->internalRep.ptr;
6290 if (expr->inUse != 0) return;
6291 for (i = 0; i < expr->len; i++)
6292 Jim_DecrRefCount(interp, expr->obj[i]);
6293 Jim_Free(expr->opcode);
6294 Jim_Free(expr->obj);
6298 void DupExprInternalRep(Jim_Interp *interp, Jim_Obj *srcPtr, Jim_Obj *dupPtr)
6300 JIM_NOTUSED(interp);
6301 JIM_NOTUSED(srcPtr);
6303 /* Just returns an simple string. */
6304 dupPtr->typePtr = NULL;
6307 /* Add a new instruction to an expression bytecode structure. */
6308 static void ExprObjAddInstr(Jim_Interp *interp, ExprByteCode *expr,
6309 int opcode, char *str, int len)
6311 expr->opcode = Jim_Realloc(expr->opcode, sizeof(int)*(expr->len+1));
6312 expr->obj = Jim_Realloc(expr->obj, sizeof(Jim_Obj*)*(expr->len+1));
6313 expr->opcode[expr->len] = opcode;
6314 expr->obj[expr->len] = Jim_NewStringObjNoAlloc(interp, str, len);
6315 Jim_IncrRefCount(expr->obj[expr->len]);
6319 /* Check if an expr program looks correct. */
6320 static int ExprCheckCorrectness(ExprByteCode *expr)
6325 /* Try to check if there are stack underflows,
6326 * and make sure at the end of the program there is
6327 * a single result on the stack. */
6328 for (i = 0; i < expr->len; i++) {
6329 switch(expr->opcode[i]) {
6330 case JIM_EXPROP_NUMBER:
6331 case JIM_EXPROP_STRING:
6332 case JIM_EXPROP_SUBST:
6333 case JIM_EXPROP_VARIABLE:
6334 case JIM_EXPROP_DICTSUGAR:
6335 case JIM_EXPROP_COMMAND:
6338 case JIM_EXPROP_NOT:
6339 case JIM_EXPROP_BITNOT:
6340 case JIM_EXPROP_UNARYMINUS:
6341 case JIM_EXPROP_UNARYPLUS:
6342 /* Unary operations */
6343 if (stacklen < 1) return JIM_ERR;
6345 case JIM_EXPROP_ADD:
6346 case JIM_EXPROP_SUB:
6347 case JIM_EXPROP_MUL:
6348 case JIM_EXPROP_DIV:
6349 case JIM_EXPROP_MOD:
6352 case JIM_EXPROP_LTE:
6353 case JIM_EXPROP_GTE:
6354 case JIM_EXPROP_ROTL:
6355 case JIM_EXPROP_ROTR:
6356 case JIM_EXPROP_LSHIFT:
6357 case JIM_EXPROP_RSHIFT:
6358 case JIM_EXPROP_NUMEQ:
6359 case JIM_EXPROP_NUMNE:
6360 case JIM_EXPROP_STREQ:
6361 case JIM_EXPROP_STRNE:
6362 case JIM_EXPROP_BITAND:
6363 case JIM_EXPROP_BITXOR:
6364 case JIM_EXPROP_BITOR:
6365 case JIM_EXPROP_LOGICAND:
6366 case JIM_EXPROP_LOGICOR:
6367 case JIM_EXPROP_POW:
6368 /* binary operations */
6369 if (stacklen < 2) return JIM_ERR;
6373 Jim_Panic(NULL,"Default opcode reached ExprCheckCorrectness");
6377 if (stacklen != 1) return JIM_ERR;
6381 static void ExprShareLiterals(Jim_Interp *interp, ExprByteCode *expr,
6382 ScriptObj *topLevelScript)
6387 for (i = 0; i < expr->len; i++) {
6388 Jim_Obj *foundObjPtr;
6390 if (expr->obj[i] == NULL) continue;
6391 foundObjPtr = ScriptSearchLiteral(interp, topLevelScript,
6392 NULL, expr->obj[i]);
6393 if (foundObjPtr != NULL) {
6394 Jim_IncrRefCount(foundObjPtr);
6395 Jim_DecrRefCount(interp, expr->obj[i]);
6396 expr->obj[i] = foundObjPtr;
6401 /* This procedure converts every occurrence of || and && opereators
6402 * in lazy unary versions.
6404 * a b || is converted into:
6406 * a <offset> |L b |R
6408 * a b && is converted into:
6410 * a <offset> &L b &R
6412 * "|L" checks if 'a' is true:
6413 * 1) if it is true pushes 1 and skips <offset> istructions to reach
6414 * the opcode just after |R.
6415 * 2) if it is false does nothing.
6416 * "|R" checks if 'b' is true:
6417 * 1) if it is true pushes 1, otherwise pushes 0.
6419 * "&L" checks if 'a' is true:
6420 * 1) if it is true does nothing.
6421 * 2) If it is false pushes 0 and skips <offset> istructions to reach
6422 * the opcode just after &R
6423 * "&R" checks if 'a' is true:
6424 * if it is true pushes 1, otherwise pushes 0.
6426 static void ExprMakeLazy(Jim_Interp *interp, ExprByteCode *expr)
6429 int index = -1, leftindex, arity, i, offset;
6430 Jim_ExprOperator *op;
6432 /* Search for || or && */
6433 for (i = 0; i < expr->len; i++) {
6434 if (expr->opcode[i] == JIM_EXPROP_LOGICAND ||
6435 expr->opcode[i] == JIM_EXPROP_LOGICOR) {
6440 if (index == -1) return;
6441 /* Search for the end of the first operator */
6442 leftindex = index-1;
6445 switch(expr->opcode[leftindex]) {
6446 case JIM_EXPROP_NUMBER:
6447 case JIM_EXPROP_COMMAND:
6448 case JIM_EXPROP_VARIABLE:
6449 case JIM_EXPROP_DICTSUGAR:
6450 case JIM_EXPROP_SUBST:
6451 case JIM_EXPROP_STRING:
6454 op = JimExprOperatorInfoByOpcode(expr->opcode[i]);
6456 Jim_Panic(interp,"Default reached in ExprMakeLazy()");
6465 expr->opcode = Jim_Realloc(expr->opcode, sizeof(int)*(expr->len+2));
6466 expr->obj = Jim_Realloc(expr->obj, sizeof(Jim_Obj*)*(expr->len+2));
6467 memmove(&expr->opcode[leftindex+2], &expr->opcode[leftindex],
6468 sizeof(int)*(expr->len-leftindex));
6469 memmove(&expr->obj[leftindex+2], &expr->obj[leftindex],
6470 sizeof(Jim_Obj*)*(expr->len-leftindex));
6473 offset = (index-leftindex)-1;
6474 Jim_DecrRefCount(interp, expr->obj[index]);
6475 if (expr->opcode[index] == JIM_EXPROP_LOGICAND) {
6476 expr->opcode[leftindex+1] = JIM_EXPROP_LOGICAND_LEFT;
6477 expr->opcode[index] = JIM_EXPROP_LOGICAND_RIGHT;
6478 expr->obj[leftindex+1] = Jim_NewStringObj(interp, "&L", -1);
6479 expr->obj[index] = Jim_NewStringObj(interp, "&R", -1);
6481 expr->opcode[leftindex+1] = JIM_EXPROP_LOGICOR_LEFT;
6482 expr->opcode[index] = JIM_EXPROP_LOGICOR_RIGHT;
6483 expr->obj[leftindex+1] = Jim_NewStringObj(interp, "|L", -1);
6484 expr->obj[index] = Jim_NewStringObj(interp, "|R", -1);
6486 expr->opcode[leftindex] = JIM_EXPROP_NUMBER;
6487 expr->obj[leftindex] = Jim_NewIntObj(interp, offset);
6488 Jim_IncrRefCount(expr->obj[index]);
6489 Jim_IncrRefCount(expr->obj[leftindex]);
6490 Jim_IncrRefCount(expr->obj[leftindex+1]);
6494 /* This method takes the string representation of an expression
6495 * and generates a program for the Expr's stack-based VM. */
6496 int SetExprFromAny(Jim_Interp *interp, struct Jim_Obj *objPtr)
6499 const char *exprText = Jim_GetString(objPtr, &exprTextLen);
6500 struct JimParserCtx parser;
6501 int i, shareLiterals;
6502 ExprByteCode *expr = Jim_Alloc(sizeof(*expr));
6504 Jim_ExprOperator *op;
6506 /* Perform literal sharing with the current procedure
6507 * running only if this expression appears to be not generated
6509 shareLiterals = objPtr->typePtr == &sourceObjType;
6511 expr->opcode = NULL;
6516 Jim_InitStack(&stack);
6517 JimParserInit(&parser, exprText, exprTextLen, 1);
6518 while(!JimParserEof(&parser)) {
6522 if (JimParseExpression(&parser) != JIM_OK) {
6523 Jim_SetResultString(interp, "Syntax error in expression", -1);
6526 token = JimParserGetToken(&parser, &len, &type, NULL);
6527 if (type == JIM_TT_EOL) {
6533 ExprObjAddInstr(interp, expr, JIM_EXPROP_STRING, token, len);
6536 ExprObjAddInstr(interp, expr, JIM_EXPROP_SUBST, token, len);
6539 ExprObjAddInstr(interp, expr, JIM_EXPROP_VARIABLE, token, len);
6541 case JIM_TT_DICTSUGAR:
6542 ExprObjAddInstr(interp, expr, JIM_EXPROP_DICTSUGAR, token, len);
6545 ExprObjAddInstr(interp, expr, JIM_EXPROP_COMMAND, token, len);
6547 case JIM_TT_EXPR_NUMBER:
6548 ExprObjAddInstr(interp, expr, JIM_EXPROP_NUMBER, token, len);
6550 case JIM_TT_EXPR_OPERATOR:
6551 op = JimExprOperatorInfo(token);
6553 Jim_ExprOperator *stackTopOp;
6555 if (Jim_StackPeek(&stack) != NULL) {
6556 stackTopOp = JimExprOperatorInfo(Jim_StackPeek(&stack));
6560 if (Jim_StackLen(&stack) && op->arity != 1 &&
6561 stackTopOp && stackTopOp->precedence >= op->precedence)
6563 ExprObjAddInstr(interp, expr, stackTopOp->opcode,
6564 Jim_StackPeek(&stack), -1);
6565 Jim_StackPop(&stack);
6570 Jim_StackPush(&stack, token);
6572 case JIM_TT_SUBEXPR_START:
6573 Jim_StackPush(&stack, Jim_StrDup("("));
6576 case JIM_TT_SUBEXPR_END:
6579 while(Jim_StackLen(&stack)) {
6580 char *opstr = Jim_StackPop(&stack);
6581 if (!strcmp(opstr, "(")) {
6586 op = JimExprOperatorInfo(opstr);
6587 ExprObjAddInstr(interp, expr, op->opcode, opstr, -1);
6590 Jim_SetResultString(interp,
6591 "Unexpected close parenthesis", -1);
6598 Jim_Panic(interp,"Default reached in SetExprFromAny()");
6602 while (Jim_StackLen(&stack)) {
6603 char *opstr = Jim_StackPop(&stack);
6604 op = JimExprOperatorInfo(opstr);
6605 if (op == NULL && !strcmp(opstr, "(")) {
6607 Jim_SetResultString(interp, "Missing close parenthesis", -1);
6610 ExprObjAddInstr(interp, expr, op->opcode, opstr, -1);
6612 /* Check program correctness. */
6613 if (ExprCheckCorrectness(expr) != JIM_OK) {
6614 Jim_SetResultString(interp, "Invalid expression", -1);
6618 /* Free the stack used for the compilation. */
6619 Jim_FreeStackElements(&stack, Jim_Free);
6620 Jim_FreeStack(&stack);
6622 /* Convert || and && operators in unary |L |R and &L &R for lazyness */
6623 ExprMakeLazy(interp, expr);
6625 /* Perform literal sharing */
6626 if (shareLiterals && interp->framePtr->procBodyObjPtr) {
6627 Jim_Obj *bodyObjPtr = interp->framePtr->procBodyObjPtr;
6628 if (bodyObjPtr->typePtr == &scriptObjType) {
6629 ScriptObj *bodyScript = bodyObjPtr->internalRep.ptr;
6630 ExprShareLiterals(interp, expr, bodyScript);
6634 /* Free the old internal rep and set the new one. */
6635 Jim_FreeIntRep(interp, objPtr);
6636 Jim_SetIntRepPtr(objPtr, expr);
6637 objPtr->typePtr = &exprObjType;
6640 err: /* we jump here on syntax/compile errors. */
6641 Jim_FreeStackElements(&stack, Jim_Free);
6642 Jim_FreeStack(&stack);
6643 Jim_Free(expr->opcode);
6644 for (i = 0; i < expr->len; i++) {
6645 Jim_DecrRefCount(interp,expr->obj[i]);
6647 Jim_Free(expr->obj);
6652 ExprByteCode *Jim_GetExpression(Jim_Interp *interp, Jim_Obj *objPtr)
6654 if (objPtr->typePtr != &exprObjType) {
6655 if (SetExprFromAny(interp, objPtr) != JIM_OK)
6658 return (ExprByteCode*) Jim_GetIntRepPtr(objPtr);
6661 /* -----------------------------------------------------------------------------
6662 * Expressions evaluation.
6663 * Jim uses a specialized stack-based virtual machine for expressions,
6664 * that takes advantage of the fact that expr's operators
6665 * can't be redefined.
6667 * Jim_EvalExpression() uses the bytecode compiled by
6668 * SetExprFromAny() method of the "expression" object.
6670 * On success a Tcl Object containing the result of the evaluation
6671 * is stored into expResultPtrPtr (having refcount of 1), and JIM_OK is
6673 * On error the function returns a retcode != to JIM_OK and set a suitable
6674 * error on the interp.
6675 * ---------------------------------------------------------------------------*/
6676 #define JIM_EE_STATICSTACK_LEN 10
6678 int Jim_EvalExpression(Jim_Interp *interp, Jim_Obj *exprObjPtr,
6679 Jim_Obj **exprResultPtrPtr)
6682 Jim_Obj **stack, *staticStack[JIM_EE_STATICSTACK_LEN];
6683 int stacklen = 0, i, error = 0, errRetCode = JIM_ERR;
6685 Jim_IncrRefCount(exprObjPtr);
6686 expr = Jim_GetExpression(interp, exprObjPtr);
6688 Jim_DecrRefCount(interp, exprObjPtr);
6689 return JIM_ERR; /* error in expression. */
6691 /* In order to avoid that the internal repr gets freed due to
6692 * shimmering of the exprObjPtr's object, we make the internal rep
6696 /* The stack-based expr VM itself */
6698 /* Stack allocation. Expr programs have the feature that
6699 * a program of length N can't require a stack longer than
6701 if (expr->len > JIM_EE_STATICSTACK_LEN)
6702 stack = Jim_Alloc(sizeof(Jim_Obj*)*expr->len);
6704 stack = staticStack;
6706 /* Execute every istruction */
6707 for (i = 0; i < expr->len; i++) {
6708 Jim_Obj *A, *B, *objPtr;
6709 jim_wide wA, wB, wC;
6711 const char *sA, *sB;
6712 int Alen, Blen, retcode;
6713 int opcode = expr->opcode[i];
6715 if (opcode == JIM_EXPROP_NUMBER || opcode == JIM_EXPROP_STRING) {
6716 stack[stacklen++] = expr->obj[i];
6717 Jim_IncrRefCount(expr->obj[i]);
6718 } else if (opcode == JIM_EXPROP_VARIABLE) {
6719 objPtr = Jim_GetVariable(interp, expr->obj[i], JIM_ERRMSG);
6720 if (objPtr == NULL) {
6724 stack[stacklen++] = objPtr;
6725 Jim_IncrRefCount(objPtr);
6726 } else if (opcode == JIM_EXPROP_SUBST) {
6727 if ((retcode = Jim_SubstObj(interp, expr->obj[i],
6728 &objPtr, JIM_NONE)) != JIM_OK)
6731 errRetCode = retcode;
6734 stack[stacklen++] = objPtr;
6735 Jim_IncrRefCount(objPtr);
6736 } else if (opcode == JIM_EXPROP_DICTSUGAR) {
6737 objPtr = Jim_ExpandDictSugar(interp, expr->obj[i]);
6738 if (objPtr == NULL) {
6742 stack[stacklen++] = objPtr;
6743 Jim_IncrRefCount(objPtr);
6744 } else if (opcode == JIM_EXPROP_COMMAND) {
6745 if ((retcode = Jim_EvalObj(interp, expr->obj[i])) != JIM_OK) {
6747 errRetCode = retcode;
6750 stack[stacklen++] = interp->result;
6751 Jim_IncrRefCount(interp->result);
6752 } else if (opcode >= JIM_EXPROP_BINARY_NUM_FIRST &&
6753 opcode <= JIM_EXPROP_BINARY_NUM_LAST)
6755 /* Note that there isn't to increment the
6756 * refcount of objects. the references are moved
6757 * from stack to A and B. */
6758 B = stack[--stacklen];
6759 A = stack[--stacklen];
6761 /* --- Integer --- */
6762 if ((A->typePtr == &doubleObjType && !A->bytes) ||
6763 (B->typePtr == &doubleObjType && !B->bytes) ||
6764 JimGetWideNoErr(interp, A, &wA) != JIM_OK ||
6765 JimGetWideNoErr(interp, B, &wB) != JIM_OK) {
6768 Jim_DecrRefCount(interp, A);
6769 Jim_DecrRefCount(interp, B);
6770 switch(expr->opcode[i]) {
6771 case JIM_EXPROP_ADD: wC = wA+wB; break;
6772 case JIM_EXPROP_SUB: wC = wA-wB; break;
6773 case JIM_EXPROP_MUL: wC = wA*wB; break;
6774 case JIM_EXPROP_LT: wC = wA<wB; break;
6775 case JIM_EXPROP_GT: wC = wA>wB; break;
6776 case JIM_EXPROP_LTE: wC = wA<=wB; break;
6777 case JIM_EXPROP_GTE: wC = wA>=wB; break;
6778 case JIM_EXPROP_LSHIFT: wC = wA<<wB; break;
6779 case JIM_EXPROP_RSHIFT: wC = wA>>wB; break;
6780 case JIM_EXPROP_NUMEQ: wC = wA==wB; break;
6781 case JIM_EXPROP_NUMNE: wC = wA!=wB; break;
6782 case JIM_EXPROP_BITAND: wC = wA&wB; break;
6783 case JIM_EXPROP_BITXOR: wC = wA^wB; break;
6784 case JIM_EXPROP_BITOR: wC = wA|wB; break;
6785 case JIM_EXPROP_POW: wC = JimPowWide(wA,wB); break;
6786 case JIM_EXPROP_LOGICAND_LEFT:
6794 case JIM_EXPROP_LOGICOR_LEFT:
6802 case JIM_EXPROP_DIV:
6803 if (wB == 0) goto divbyzero;
6806 case JIM_EXPROP_MOD:
6807 if (wB == 0) goto divbyzero;
6810 case JIM_EXPROP_ROTL: {
6811 /* uint32_t would be better. But not everyone has inttypes.h?*/
6812 unsigned long uA = (unsigned long)wA;
6814 wC = _rotl(uA,(unsigned long)wB);
6816 const unsigned int S = sizeof(unsigned long) * 8;
6817 wC = (unsigned long)((uA<<wB)|(uA>>(S-wB)));
6821 case JIM_EXPROP_ROTR: {
6822 unsigned long uA = (unsigned long)wA;
6824 wC = _rotr(uA,(unsigned long)wB);
6826 const unsigned int S = sizeof(unsigned long) * 8;
6827 wC = (unsigned long)((uA>>wB)|(uA<<(S-wB)));
6833 wC = 0; /* avoid gcc warning */
6836 stack[stacklen] = Jim_NewIntObj(interp, wC);
6837 Jim_IncrRefCount(stack[stacklen]);
6841 /* --- Double --- */
6842 if (Jim_GetDouble(interp, A, &dA) != JIM_OK ||
6843 Jim_GetDouble(interp, B, &dB) != JIM_OK) {
6844 Jim_DecrRefCount(interp, A);
6845 Jim_DecrRefCount(interp, B);
6849 Jim_DecrRefCount(interp, A);
6850 Jim_DecrRefCount(interp, B);
6851 switch(expr->opcode[i]) {
6852 case JIM_EXPROP_ROTL:
6853 case JIM_EXPROP_ROTR:
6854 case JIM_EXPROP_LSHIFT:
6855 case JIM_EXPROP_RSHIFT:
6856 case JIM_EXPROP_BITAND:
6857 case JIM_EXPROP_BITXOR:
6858 case JIM_EXPROP_BITOR:
6859 case JIM_EXPROP_MOD:
6860 case JIM_EXPROP_POW:
6861 Jim_SetResultString(interp,
6862 "Got floating-point value where integer was expected", -1);
6866 case JIM_EXPROP_ADD: dC = dA+dB; break;
6867 case JIM_EXPROP_SUB: dC = dA-dB; break;
6868 case JIM_EXPROP_MUL: dC = dA*dB; break;
6869 case JIM_EXPROP_LT: dC = dA<dB; break;
6870 case JIM_EXPROP_GT: dC = dA>dB; break;
6871 case JIM_EXPROP_LTE: dC = dA<=dB; break;
6872 case JIM_EXPROP_GTE: dC = dA>=dB; break;
6873 case JIM_EXPROP_NUMEQ: dC = dA==dB; break;
6874 case JIM_EXPROP_NUMNE: dC = dA!=dB; break;
6875 case JIM_EXPROP_LOGICAND_LEFT:
6883 case JIM_EXPROP_LOGICOR_LEFT:
6891 case JIM_EXPROP_DIV:
6892 if (dB == 0) goto divbyzero;
6896 dC = 0; /* avoid gcc warning */
6899 stack[stacklen] = Jim_NewDoubleObj(interp, dC);
6900 Jim_IncrRefCount(stack[stacklen]);
6902 } else if (opcode == JIM_EXPROP_STREQ || opcode == JIM_EXPROP_STRNE) {
6903 B = stack[--stacklen];
6904 A = stack[--stacklen];
6905 sA = Jim_GetString(A, &Alen);
6906 sB = Jim_GetString(B, &Blen);
6907 switch(expr->opcode[i]) {
6908 case JIM_EXPROP_STREQ:
6909 if (Alen == Blen && memcmp(sA, sB, Alen) ==0)
6914 case JIM_EXPROP_STRNE:
6915 if (Alen != Blen || memcmp(sA, sB, Alen) != 0)
6921 wC = 0; /* avoid gcc warning */
6924 Jim_DecrRefCount(interp, A);
6925 Jim_DecrRefCount(interp, B);
6926 stack[stacklen] = Jim_NewIntObj(interp, wC);
6927 Jim_IncrRefCount(stack[stacklen]);
6929 } else if (opcode == JIM_EXPROP_NOT ||
6930 opcode == JIM_EXPROP_BITNOT ||
6931 opcode == JIM_EXPROP_LOGICAND_RIGHT ||
6932 opcode == JIM_EXPROP_LOGICOR_RIGHT) {
6933 /* Note that there isn't to increment the
6934 * refcount of objects. the references are moved
6935 * from stack to A and B. */
6936 A = stack[--stacklen];
6938 /* --- Integer --- */
6939 if ((A->typePtr == &doubleObjType && !A->bytes) ||
6940 JimGetWideNoErr(interp, A, &wA) != JIM_OK) {
6941 goto trydouble_unary;
6943 Jim_DecrRefCount(interp, A);
6944 switch(expr->opcode[i]) {
6945 case JIM_EXPROP_NOT: wC = !wA; break;
6946 case JIM_EXPROP_BITNOT: wC = ~wA; break;
6947 case JIM_EXPROP_LOGICAND_RIGHT:
6948 case JIM_EXPROP_LOGICOR_RIGHT: wC = (wA != 0); break;
6950 wC = 0; /* avoid gcc warning */
6953 stack[stacklen] = Jim_NewIntObj(interp, wC);
6954 Jim_IncrRefCount(stack[stacklen]);
6958 /* --- Double --- */
6959 if (Jim_GetDouble(interp, A, &dA) != JIM_OK) {
6960 Jim_DecrRefCount(interp, A);
6964 Jim_DecrRefCount(interp, A);
6965 switch(expr->opcode[i]) {
6966 case JIM_EXPROP_NOT: dC = !dA; break;
6967 case JIM_EXPROP_LOGICAND_RIGHT:
6968 case JIM_EXPROP_LOGICOR_RIGHT: dC = (dA != 0); break;
6969 case JIM_EXPROP_BITNOT:
6970 Jim_SetResultString(interp,
6971 "Got floating-point value where integer was expected", -1);
6976 dC = 0; /* avoid gcc warning */
6979 stack[stacklen] = Jim_NewDoubleObj(interp, dC);
6980 Jim_IncrRefCount(stack[stacklen]);
6983 Jim_Panic(interp,"Unknown opcode in Jim_EvalExpression");
6987 /* There is no need to decerement the inUse field because
6988 * this reference is transfered back into the exprObjPtr. */
6989 Jim_FreeIntRep(interp, exprObjPtr);
6990 exprObjPtr->typePtr = &exprObjType;
6991 Jim_SetIntRepPtr(exprObjPtr, expr);
6992 Jim_DecrRefCount(interp, exprObjPtr);
6994 *exprResultPtrPtr = stack[0];
6995 Jim_IncrRefCount(stack[0]);
6996 errRetCode = JIM_OK;
6998 for (i = 0; i < stacklen; i++) {
6999 Jim_DecrRefCount(interp, stack[i]);
7001 if (stack != staticStack)
7006 Jim_SetResultString(interp, "Division by zero", -1);
7010 int Jim_GetBoolFromExpr(Jim_Interp *interp, Jim_Obj *exprObjPtr, int *boolPtr)
7015 Jim_Obj *exprResultPtr;
7017 retcode = Jim_EvalExpression(interp, exprObjPtr, &exprResultPtr);
7018 if (retcode != JIM_OK)
7020 if (JimGetWideNoErr(interp, exprResultPtr, &wideValue) != JIM_OK) {
7021 if (Jim_GetDouble(interp, exprResultPtr, &doubleValue) != JIM_OK)
7023 Jim_DecrRefCount(interp, exprResultPtr);
7026 Jim_DecrRefCount(interp, exprResultPtr);
7027 *boolPtr = doubleValue != 0;
7031 Jim_DecrRefCount(interp, exprResultPtr);
7032 *boolPtr = wideValue != 0;
7036 /* -----------------------------------------------------------------------------
7037 * ScanFormat String Object
7038 * ---------------------------------------------------------------------------*/
7040 /* This Jim_Obj will held a parsed representation of a format string passed to
7041 * the Jim_ScanString command. For error diagnostics, the scanformat string has
7042 * to be parsed in its entirely first and then, if correct, can be used for
7043 * scanning. To avoid endless re-parsing, the parsed representation will be
7044 * stored in an internal representation and re-used for performance reason. */
7046 /* A ScanFmtPartDescr will held the information of /one/ part of the whole
7047 * scanformat string. This part will later be used to extract information
7048 * out from the string to be parsed by Jim_ScanString */
7050 typedef struct ScanFmtPartDescr {
7051 char type; /* Type of conversion (e.g. c, d, f) */
7052 char modifier; /* Modify type (e.g. l - long, h - short */
7053 size_t width; /* Maximal width of input to be converted */
7054 int pos; /* -1 - no assign, 0 - natural pos, >0 - XPG3 pos */
7055 char *arg; /* Specification of a CHARSET conversion */
7056 char *prefix; /* Prefix to be scanned literally before conversion */
7059 /* The ScanFmtStringObj will held the internal representation of a scanformat
7060 * string parsed and separated in part descriptions. Furthermore it contains
7061 * the original string representation of the scanformat string to allow for
7062 * fast update of the Jim_Obj's string representation part.
7064 * As add-on the internal object representation add some scratch pad area
7065 * for usage by Jim_ScanString to avoid endless allocating and freeing of
7066 * memory for purpose of string scanning.
7068 * The error member points to a static allocated string in case of a mal-
7069 * formed scanformat string or it contains '0' (NULL) in case of a valid
7070 * parse representation.
7072 * The whole memory of the internal representation is allocated as a single
7073 * area of memory that will be internally separated. So freeing and duplicating
7074 * of such an object is cheap */
7076 typedef struct ScanFmtStringObj {
7077 jim_wide size; /* Size of internal repr in bytes */
7078 char *stringRep; /* Original string representation */
7079 size_t count; /* Number of ScanFmtPartDescr contained */
7080 size_t convCount; /* Number of conversions that will assign */
7081 size_t maxPos; /* Max position index if XPG3 is used */
7082 const char *error; /* Ptr to error text (NULL if no error */
7083 char *scratch; /* Some scratch pad used by Jim_ScanString */
7084 ScanFmtPartDescr descr[1]; /* The vector of partial descriptions */
7088 static void FreeScanFmtInternalRep(Jim_Interp *interp, Jim_Obj *objPtr);
7089 static void DupScanFmtInternalRep(Jim_Interp *interp, Jim_Obj *srcPtr, Jim_Obj *dupPtr);
7090 static void UpdateStringOfScanFmt(Jim_Obj *objPtr);
7092 static Jim_ObjType scanFmtStringObjType = {
7094 FreeScanFmtInternalRep,
7095 DupScanFmtInternalRep,
7096 UpdateStringOfScanFmt,
7100 void FreeScanFmtInternalRep(Jim_Interp *interp, Jim_Obj *objPtr)
7102 JIM_NOTUSED(interp);
7103 Jim_Free((char*)objPtr->internalRep.ptr);
7104 objPtr->internalRep.ptr = 0;
7107 void DupScanFmtInternalRep(Jim_Interp *interp, Jim_Obj *srcPtr, Jim_Obj *dupPtr)
7109 size_t size = (size_t)((ScanFmtStringObj*)srcPtr->internalRep.ptr)->size;
7110 ScanFmtStringObj *newVec = (ScanFmtStringObj*)Jim_Alloc(size);
7112 JIM_NOTUSED(interp);
7113 memcpy(newVec, srcPtr->internalRep.ptr, size);
7114 dupPtr->internalRep.ptr = newVec;
7115 dupPtr->typePtr = &scanFmtStringObjType;
7118 void UpdateStringOfScanFmt(Jim_Obj *objPtr)
7120 char *bytes = ((ScanFmtStringObj*)objPtr->internalRep.ptr)->stringRep;
7122 objPtr->bytes = Jim_StrDup(bytes);
7123 objPtr->length = strlen(bytes);
7126 /* SetScanFmtFromAny will parse a given string and create the internal
7127 * representation of the format specification. In case of an error
7128 * the error data member of the internal representation will be set
7129 * to an descriptive error text and the function will be left with
7130 * JIM_ERR to indicate unsucessful parsing (aka. malformed scanformat
7133 static int SetScanFmtFromAny(Jim_Interp *interp, Jim_Obj *objPtr)
7135 ScanFmtStringObj *fmtObj;
7137 int maxCount, i, approxSize, lastPos = -1;
7138 const char *fmt = objPtr->bytes;
7139 int maxFmtLen = objPtr->length;
7140 const char *fmtEnd = fmt + maxFmtLen;
7143 Jim_FreeIntRep(interp, objPtr);
7144 /* Count how many conversions could take place maximally */
7145 for (i=0, maxCount=0; i < maxFmtLen; ++i)
7148 /* Calculate an approximation of the memory necessary */
7149 approxSize = sizeof(ScanFmtStringObj) /* Size of the container */
7150 + (maxCount + 1) * sizeof(ScanFmtPartDescr) /* Size of all partials */
7151 + maxFmtLen * sizeof(char) + 3 + 1 /* Scratch + "%n" + '\0' */
7152 + maxFmtLen * sizeof(char) + 1 /* Original stringrep */
7153 + maxFmtLen * sizeof(char) /* Arg for CHARSETs */
7154 + (maxCount +1) * sizeof(char) /* '\0' for every partial */
7155 + 1; /* safety byte */
7156 fmtObj = (ScanFmtStringObj*)Jim_Alloc(approxSize);
7157 memset(fmtObj, 0, approxSize);
7158 fmtObj->size = approxSize;
7160 fmtObj->scratch = (char*)&fmtObj->descr[maxCount+1];
7161 fmtObj->stringRep = fmtObj->scratch + maxFmtLen + 3 + 1;
7162 memcpy(fmtObj->stringRep, fmt, maxFmtLen);
7163 buffer = fmtObj->stringRep + maxFmtLen + 1;
7164 objPtr->internalRep.ptr = fmtObj;
7165 objPtr->typePtr = &scanFmtStringObjType;
7166 for (i=0, curr=0; fmt < fmtEnd; ++fmt) {
7168 ScanFmtPartDescr *descr = &fmtObj->descr[curr];
7170 descr->width = 0; /* Assume width unspecified */
7171 /* Overread and store any "literal" prefix */
7172 if (*fmt != '%' || fmt[1] == '%') {
7174 descr->prefix = &buffer[i];
7175 for (; fmt < fmtEnd; ++fmt) {
7177 if (fmt[1] != '%') break;
7184 /* Skip the conversion introducing '%' sign */
7186 /* End reached due to non-conversion literal only? */
7189 descr->pos = 0; /* Assume "natural" positioning */
7191 descr->pos = -1; /* Okay, conversion will not be assigned */
7194 fmtObj->convCount++; /* Otherwise count as assign-conversion */
7195 /* Check if next token is a number (could be width or pos */
7196 if (sscanf(fmt, "%d%n", &width, &skip) == 1) {
7198 /* Was the number a XPG3 position specifier? */
7199 if (descr->pos != -1 && *fmt == '$') {
7204 /* Look if "natural" postioning and XPG3 one was mixed */
7205 if ((lastPos == 0 && descr->pos > 0)
7206 || (lastPos > 0 && descr->pos == 0)) {
7207 fmtObj->error = "cannot mix \"%\" and \"%n$\" conversion specifiers";
7210 /* Look if this position was already used */
7211 for (prev=0; prev < curr; ++prev) {
7212 if (fmtObj->descr[prev].pos == -1) continue;
7213 if (fmtObj->descr[prev].pos == descr->pos) {
7214 fmtObj->error = "same \"%n$\" conversion specifier "
7215 "used more than once";
7219 /* Try to find a width after the XPG3 specifier */
7220 if (sscanf(fmt, "%d%n", &width, &skip) == 1) {
7221 descr->width = width;
7224 if (descr->pos > 0 && (size_t)descr->pos > fmtObj->maxPos)
7225 fmtObj->maxPos = descr->pos;
7227 /* Number was not a XPG3, so it has to be a width */
7228 descr->width = width;
7231 /* If positioning mode was undetermined yet, fix this */
7233 lastPos = descr->pos;
7234 /* Handle CHARSET conversion type ... */
7236 int swapped = 1, beg = i, end, j;
7238 descr->arg = &buffer[i];
7240 if (*fmt == '^') buffer[i++] = *fmt++;
7241 if (*fmt == ']') buffer[i++] = *fmt++;
7242 while (*fmt && *fmt != ']') buffer[i++] = *fmt++;
7244 fmtObj->error = "unmatched [ in format string";
7249 /* In case a range fence was given "backwards", swap it */
7252 for (j=beg+1; j < end-1; ++j) {
7253 if (buffer[j] == '-' && buffer[j-1] > buffer[j+1]) {
7254 char tmp = buffer[j-1];
7255 buffer[j-1] = buffer[j+1];
7262 /* Remember any valid modifier if given */
7263 if (strchr("hlL", *fmt) != 0)
7264 descr->modifier = tolower((int)*fmt++);
7267 if (strchr("efgcsndoxui", *fmt) == 0) {
7268 fmtObj->error = "bad scan conversion character";
7270 } else if (*fmt == 'c' && descr->width != 0) {
7271 fmtObj->error = "field width may not be specified in %c "
7274 } else if (*fmt == 'u' && descr->modifier == 'l') {
7275 fmtObj->error = "unsigned wide not supported";
7282 if (fmtObj->convCount == 0) {
7283 fmtObj->error = "no any conversion specifier given";
7289 /* Some accessor macros to allow lowlevel access to fields of internal repr */
7291 #define FormatGetCnvCount(_fo_) \
7292 ((ScanFmtStringObj*)((_fo_)->internalRep.ptr))->convCount
7293 #define FormatGetMaxPos(_fo_) \
7294 ((ScanFmtStringObj*)((_fo_)->internalRep.ptr))->maxPos
7295 #define FormatGetError(_fo_) \
7296 ((ScanFmtStringObj*)((_fo_)->internalRep.ptr))->error
7298 /* Some Bit testing/setting/cleaning routines. For now only used in handling
7299 * charsets ([a-z123]) within scanning. Later on perhaps a base for a
7300 * bitvector implementation in Jim? */
7302 static int JimTestBit(const char *bitvec, char ch)
7304 div_t pos = div(ch-1, 8);
7305 return bitvec[pos.quot] & (1 << pos.rem);
7308 static void JimSetBit(char *bitvec, char ch)
7310 div_t pos = div(ch-1, 8);
7311 bitvec[pos.quot] |= (1 << pos.rem);
7314 #if 0 /* currently not used */
7315 static void JimClearBit(char *bitvec, char ch)
7317 div_t pos = div(ch-1, 8);
7318 bitvec[pos.quot] &= ~(1 << pos.rem);
7322 /* JimScanAString is used to scan an unspecified string that ends with
7323 * next WS, or a string that is specified via a charset. The charset
7324 * is currently implemented in a way to only allow for usage with
7325 * ASCII. Whenever we will switch to UNICODE, another idea has to
7328 * FIXME: Works only with ASCII */
7331 JimScanAString(Jim_Interp *interp, const char *sdescr, const char *str)
7335 char charset[256/8+1]; /* A Charset may contain max 256 chars */
7336 char *buffer = Jim_Alloc(strlen(str)+1), *anchor = buffer;
7338 /* First init charset to nothing or all, depending if a specified
7339 * or an unspecified string has to be parsed */
7340 memset(charset, (sdescr ? 0 : 255), sizeof(charset));
7342 /* There was a set description given, that means we are parsing
7343 * a specified string. So we have to build a corresponding
7344 * charset reflecting the description */
7346 /* Should the set be negated at the end? */
7347 if (*sdescr == '^') {
7351 /* Here '-' is meant literally and not to define a range */
7352 if (*sdescr == '-') {
7353 JimSetBit(charset, '-');
7357 if (sdescr[1] == '-' && sdescr[2] != 0) {
7358 /* Handle range definitions */
7360 for (i=sdescr[0]; i <= sdescr[2]; ++i)
7361 JimSetBit(charset, (char)i);
7364 /* Handle verbatim character definitions */
7365 JimSetBit(charset, *sdescr++);
7368 /* Negate the charset if there was a NOT given */
7369 for (i=0; notFlag && i < sizeof(charset); ++i)
7370 charset[i] = ~charset[i];
7372 /* And after all the mess above, the real work begin ... */
7373 while (str && *str) {
7374 if (!sdescr && isspace((int)*str))
7375 break; /* EOS via WS if unspecified */
7376 if (JimTestBit(charset, *str)) *buffer++ = *str++;
7377 else break; /* EOS via mismatch if specified scanning */
7379 *buffer = 0; /* Close the string properly ... */
7380 result = Jim_NewStringObj(interp, anchor, -1);
7381 Jim_Free(anchor); /* ... and free it afer usage */
7385 /* ScanOneEntry will scan one entry out of the string passed as argument.
7386 * It use the sscanf() function for this task. After extracting and
7387 * converting of the value, the count of scanned characters will be
7388 * returned of -1 in case of no conversion tool place and string was
7389 * already scanned thru */
7391 static int ScanOneEntry(Jim_Interp *interp, const char *str, long pos,
7392 ScanFmtStringObj *fmtObj, long index, Jim_Obj **valObjPtr)
7394 # define MAX_SIZE (sizeof(jim_wide) > sizeof(double) \
7395 ? sizeof(jim_wide) \
7397 char buffer[MAX_SIZE];
7398 char *value = buffer;
7400 const ScanFmtPartDescr *descr = &fmtObj->descr[index];
7401 size_t sLen = strlen(&str[pos]), scanned = 0;
7402 size_t anchor = pos;
7405 /* First pessimiticly assume, we will not scan anything :-) */
7407 if (descr->prefix) {
7408 /* There was a prefix given before the conversion, skip it and adjust
7409 * the string-to-be-parsed accordingly */
7410 for (i=0; str[pos] && descr->prefix[i]; ++i) {
7411 /* If prefix require, skip WS */
7412 if (isspace((int)descr->prefix[i]))
7413 while (str[pos] && isspace((int)str[pos])) ++pos;
7414 else if (descr->prefix[i] != str[pos])
7415 break; /* Prefix do not match here, leave the loop */
7417 ++pos; /* Prefix matched so far, next round */
7420 return -1; /* All of str consumed: EOF condition */
7421 else if (descr->prefix[i] != 0)
7422 return 0; /* Not whole prefix consumed, no conversion possible */
7424 /* For all but following conversion, skip leading WS */
7425 if (descr->type != 'c' && descr->type != '[' && descr->type != 'n')
7426 while (isspace((int)str[pos])) ++pos;
7427 /* Determine how much skipped/scanned so far */
7428 scanned = pos - anchor;
7429 if (descr->type == 'n') {
7430 /* Return pseudo conversion means: how much scanned so far? */
7431 *valObjPtr = Jim_NewIntObj(interp, anchor + scanned);
7432 } else if (str[pos] == 0) {
7433 /* Cannot scan anything, as str is totally consumed */
7436 /* Processing of conversions follows ... */
7437 if (descr->width > 0) {
7438 /* Do not try to scan as fas as possible but only the given width.
7439 * To ensure this, we copy the part that should be scanned. */
7440 size_t tLen = descr->width > sLen ? sLen : descr->width;
7441 tok = Jim_StrDupLen(&str[pos], tLen);
7443 /* As no width was given, simply refer to the original string */
7446 switch (descr->type) {
7448 *valObjPtr = Jim_NewIntObj(interp, *tok);
7451 case 'd': case 'o': case 'x': case 'u': case 'i': {
7452 char *endp; /* Position where the number finished */
7453 int base = descr->type == 'o' ? 8
7454 : descr->type == 'x' ? 16
7455 : descr->type == 'i' ? 0
7459 /* Try to scan a number with the given base */
7460 if (descr->modifier == 'l')
7461 #ifdef HAVE_LONG_LONG
7462 *(jim_wide*)value = JimStrtoll(tok, &endp, base);
7464 *(jim_wide*)value = strtol(tok, &endp, base);
7467 if (descr->type == 'u')
7468 *(long*)value = strtoul(tok, &endp, base);
7470 *(long*)value = strtol(tok, &endp, base);
7471 /* If scanning failed, and base was undetermined, simply
7472 * put it to 10 and try once more. This should catch the
7473 * case where %i begin to parse a number prefix (e.g.
7474 * '0x' but no further digits follows. This will be
7475 * handled as a ZERO followed by a char 'x' by Tcl */
7476 if (endp == tok && base == 0) base = 10;
7480 /* There was some number sucessfully scanned! */
7481 if (descr->modifier == 'l')
7482 *valObjPtr = Jim_NewIntObj(interp, *(jim_wide*)value);
7484 *valObjPtr = Jim_NewIntObj(interp, *(long*)value);
7485 /* Adjust the number-of-chars scanned so far */
7486 scanned += endp - tok;
7488 /* Nothing was scanned. We have to determine if this
7489 * happened due to e.g. prefix mismatch or input str
7491 scanned = *tok ? 0 : -1;
7495 case 's': case '[': {
7496 *valObjPtr = JimScanAString(interp, descr->arg, tok);
7497 scanned += Jim_Length(*valObjPtr);
7500 case 'e': case 'f': case 'g': {
7503 *(double*)value = strtod(tok, &endp);
7505 /* There was some number sucessfully scanned! */
7506 *valObjPtr = Jim_NewDoubleObj(interp, *(double*)value);
7507 /* Adjust the number-of-chars scanned so far */
7508 scanned += endp - tok;
7510 /* Nothing was scanned. We have to determine if this
7511 * happened due to e.g. prefix mismatch or input str
7513 scanned = *tok ? 0 : -1;
7518 /* If a substring was allocated (due to pre-defined width) do not
7519 * forget to free it */
7520 if (tok != &str[pos])
7521 Jim_Free((char*)tok);
7526 /* Jim_ScanString is the workhorse of string scanning. It will scan a given
7527 * string and returns all converted (and not ignored) values in a list back
7528 * to the caller. If an error occured, a NULL pointer will be returned */
7530 Jim_Obj *Jim_ScanString(Jim_Interp *interp, Jim_Obj *strObjPtr,
7531 Jim_Obj *fmtObjPtr, int flags)
7535 const char *str = Jim_GetString(strObjPtr, 0);
7536 Jim_Obj *resultList = 0;
7537 Jim_Obj **resultVec;
7539 Jim_Obj *emptyStr = 0;
7540 ScanFmtStringObj *fmtObj;
7542 /* If format specification is not an object, convert it! */
7543 if (fmtObjPtr->typePtr != &scanFmtStringObjType)
7544 SetScanFmtFromAny(interp, fmtObjPtr);
7545 fmtObj = (ScanFmtStringObj*)fmtObjPtr->internalRep.ptr;
7546 /* Check if format specification was valid */
7547 if (fmtObj->error != 0) {
7548 if (flags & JIM_ERRMSG)
7549 Jim_SetResultString(interp, fmtObj->error, -1);
7552 /* Allocate a new "shared" empty string for all unassigned conversions */
7553 emptyStr = Jim_NewEmptyStringObj(interp);
7554 Jim_IncrRefCount(emptyStr);
7555 /* Create a list and fill it with empty strings up to max specified XPG3 */
7556 resultList = Jim_NewListObj(interp, 0, 0);
7557 if (fmtObj->maxPos > 0) {
7558 for (i=0; i < fmtObj->maxPos; ++i)
7559 Jim_ListAppendElement(interp, resultList, emptyStr);
7560 JimListGetElements(interp, resultList, &resultc, &resultVec);
7562 /* Now handle every partial format description */
7563 for (i=0, pos=0; i < fmtObj->count; ++i) {
7564 ScanFmtPartDescr *descr = &(fmtObj->descr[i]);
7566 /* Only last type may be "literal" w/o conversion - skip it! */
7567 if (descr->type == 0) continue;
7568 /* As long as any conversion could be done, we will proceed */
7570 scanned = ScanOneEntry(interp, str, pos, fmtObj, i, &value);
7571 /* In case our first try results in EOF, we will leave */
7572 if (scanned == -1 && i == 0)
7574 /* Advance next pos-to-be-scanned for the amount scanned already */
7576 /* value == 0 means no conversion took place so take empty string */
7578 value = Jim_NewEmptyStringObj(interp);
7579 /* If value is a non-assignable one, skip it */
7580 if (descr->pos == -1) {
7581 Jim_FreeNewObj(interp, value);
7582 } else if (descr->pos == 0)
7583 /* Otherwise append it to the result list if no XPG3 was given */
7584 Jim_ListAppendElement(interp, resultList, value);
7585 else if (resultVec[descr->pos-1] == emptyStr) {
7586 /* But due to given XPG3, put the value into the corr. slot */
7587 Jim_DecrRefCount(interp, resultVec[descr->pos-1]);
7588 Jim_IncrRefCount(value);
7589 resultVec[descr->pos-1] = value;
7591 /* Otherwise, the slot was already used - free obj and ERROR */
7592 Jim_FreeNewObj(interp, value);
7596 Jim_DecrRefCount(interp, emptyStr);
7599 Jim_DecrRefCount(interp, emptyStr);
7600 Jim_FreeNewObj(interp, resultList);
7601 return (Jim_Obj*)EOF;
7603 Jim_DecrRefCount(interp, emptyStr);
7604 Jim_FreeNewObj(interp, resultList);
7608 /* -----------------------------------------------------------------------------
7609 * Pseudo Random Number Generation
7610 * ---------------------------------------------------------------------------*/
7611 static void JimPrngSeed(Jim_Interp *interp, const unsigned char *seed,
7614 /* Initialize the sbox with the numbers from 0 to 255 */
7615 static void JimPrngInit(Jim_Interp *interp)
7618 unsigned int seed[256];
7620 interp->prngState = Jim_Alloc(sizeof(Jim_PrngState));
7621 for (i = 0; i < 256; i++)
7622 seed[i] = (rand() ^ time(NULL) ^ clock());
7623 JimPrngSeed(interp, (unsigned char*) seed, sizeof(int)*256);
7626 /* Generates N bytes of random data */
7627 static void JimRandomBytes(Jim_Interp *interp, void *dest, unsigned int len)
7629 Jim_PrngState *prng;
7630 unsigned char *destByte = (unsigned char*) dest;
7631 unsigned int si, sj, x;
7633 /* initialization, only needed the first time */
7634 if (interp->prngState == NULL)
7635 JimPrngInit(interp);
7636 prng = interp->prngState;
7637 /* generates 'len' bytes of pseudo-random numbers */
7638 for (x = 0; x < len; x++) {
7639 prng->i = (prng->i+1) & 0xff;
7640 si = prng->sbox[prng->i];
7641 prng->j = (prng->j + si) & 0xff;
7642 sj = prng->sbox[prng->j];
7643 prng->sbox[prng->i] = sj;
7644 prng->sbox[prng->j] = si;
7645 *destByte++ = prng->sbox[(si+sj)&0xff];
7649 /* Re-seed the generator with user-provided bytes */
7650 static void JimPrngSeed(Jim_Interp *interp, const unsigned char *seed,
7654 unsigned char buf[256];
7655 Jim_PrngState *prng;
7657 /* initialization, only needed the first time */
7658 if (interp->prngState == NULL)
7659 JimPrngInit(interp);
7660 prng = interp->prngState;
7662 /* Set the sbox[i] with i */
7663 for (i = 0; i < 256; i++)
7665 /* Now use the seed to perform a random permutation of the sbox */
7666 for (i = 0; i < seedLen; i++) {
7669 t = prng->sbox[i&0xFF];
7670 prng->sbox[i&0xFF] = prng->sbox[seed[i]];
7671 prng->sbox[seed[i]] = t;
7673 prng->i = prng->j = 0;
7674 /* discard the first 256 bytes of stream. */
7675 JimRandomBytes(interp, buf, 256);
7678 /* -----------------------------------------------------------------------------
7679 * Dynamic libraries support (WIN32 not supported)
7680 * ---------------------------------------------------------------------------*/
7685 void * dlopen(const char *path, int mode)
7689 return (void *)LoadLibraryA(path);
7691 int dlclose(void *handle)
7693 FreeLibrary((HANDLE)handle);
7696 void *dlsym(void *handle, const char *symbol)
7698 return GetProcAddress((HMODULE)handle, symbol);
7700 static char win32_dlerror_string[121];
7701 const char *dlerror()
7703 FormatMessageA(FORMAT_MESSAGE_FROM_SYSTEM, NULL, GetLastError(),
7704 LANG_NEUTRAL, win32_dlerror_string, 120, NULL);
7705 return win32_dlerror_string;
7709 int Jim_LoadLibrary(Jim_Interp *interp, const char *pathName)
7711 Jim_Obj *libPathObjPtr;
7714 int (*onload)(Jim_Interp *interp);
7716 libPathObjPtr = Jim_GetGlobalVariableStr(interp, "jim_libpath", JIM_NONE);
7717 if (libPathObjPtr == NULL) {
7719 libPathObjPtr = NULL;
7721 Jim_IncrRefCount(libPathObjPtr);
7722 Jim_ListLength(interp, libPathObjPtr, &prefixc);
7725 for (i = -1; i < prefixc; i++) {
7727 handle = dlopen(pathName, RTLD_LAZY);
7730 char buf[JIM_PATH_LEN];
7733 Jim_Obj *prefixObjPtr;
7736 if (Jim_ListIndex(interp, libPathObjPtr, i,
7737 &prefixObjPtr, JIM_NONE) != JIM_OK)
7739 prefix = Jim_GetString(prefixObjPtr, NULL);
7740 prefixlen = strlen(prefix);
7741 if (prefixlen+strlen(pathName)+1 >= JIM_PATH_LEN)
7743 if (prefixlen && prefix[prefixlen-1] == '/')
7744 sprintf(buf, "%s%s", prefix, pathName);
7746 sprintf(buf, "%s/%s", prefix, pathName);
7747 printf("opening '%s'\n", buf);
7748 fp = fopen(buf, "r");
7752 handle = dlopen(buf, RTLD_LAZY);
7753 printf("got handle %p\n", handle);
7755 if (handle == NULL) {
7756 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
7757 Jim_AppendStrings(interp, Jim_GetResult(interp),
7758 "error loading extension \"", pathName,
7759 "\": ", dlerror(), NULL);
7764 if ((onload = dlsym(handle, "Jim_OnLoad")) == NULL) {
7765 Jim_SetResultString(interp,
7766 "No Jim_OnLoad symbol found on extension", -1);
7769 if (onload(interp) == JIM_ERR) {
7773 Jim_SetEmptyResult(interp);
7774 if (libPathObjPtr != NULL)
7775 Jim_DecrRefCount(interp, libPathObjPtr);
7779 if (libPathObjPtr != NULL)
7780 Jim_DecrRefCount(interp, libPathObjPtr);
7783 #else /* JIM_DYNLIB */
7784 int Jim_LoadLibrary(Jim_Interp *interp, const char *pathName)
7786 JIM_NOTUSED(interp);
7787 JIM_NOTUSED(pathName);
7789 Jim_SetResultString(interp, "the Jim binary has no support for [load]", -1);
7792 #endif/* JIM_DYNLIB */
7794 /* -----------------------------------------------------------------------------
7796 * ---------------------------------------------------------------------------*/
7798 #define JIM_PKG_ANY_VERSION -1
7800 /* Convert a string of the type "1.2" into an integer.
7801 * MAJOR.MINOR is converted as MAJOR*100+MINOR, so "1.2" is converted
7802 * to the integer with value 102 */
7803 static int JimPackageVersionToInt(Jim_Interp *interp, const char *v,
7804 int *intPtr, int flags)
7807 jim_wide major, minor;
7808 char *majorStr, *minorStr, *p;
7811 *intPtr = JIM_PKG_ANY_VERSION;
7815 copy = Jim_StrDup(v);
7816 p = strchr(copy, '.');
7817 if (p == NULL) goto badfmt;
7822 if (Jim_StringToWide(majorStr, &major, 10) != JIM_OK ||
7823 Jim_StringToWide(minorStr, &minor, 10) != JIM_OK)
7825 *intPtr = (int)(major*100+minor);
7831 if (flags & JIM_ERRMSG) {
7832 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
7833 Jim_AppendStrings(interp, Jim_GetResult(interp),
7834 "invalid package version '", v, "'", NULL);
7839 #define JIM_MATCHVER_EXACT (1<<JIM_PRIV_FLAG_SHIFT)
7840 static int JimPackageMatchVersion(int needed, int actual, int flags)
7842 if (needed == JIM_PKG_ANY_VERSION) return 1;
7843 if (flags & JIM_MATCHVER_EXACT) {
7844 return needed == actual;
7846 return needed/100 == actual/100 && (needed <= actual);
7850 int Jim_PackageProvide(Jim_Interp *interp, const char *name, const char *ver,
7854 /* Check if the version format is ok */
7855 if (JimPackageVersionToInt(interp, ver, &intVersion, JIM_ERRMSG) != JIM_OK)
7857 /* If the package was already provided returns an error. */
7858 if (Jim_FindHashEntry(&interp->packages, name) != NULL) {
7859 if (flags & JIM_ERRMSG) {
7860 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
7861 Jim_AppendStrings(interp, Jim_GetResult(interp),
7862 "package '", name, "' was already provided", NULL);
7866 Jim_AddHashEntry(&interp->packages, name, (char*) ver);
7873 # include <sys/types.h>
7874 # include <dirent.h>
7877 /* Posix dirent.h compatiblity layer for WIN32.
7878 * Copyright Kevlin Henney, 1997, 2003. All rights reserved.
7879 * Copyright Salvatore Sanfilippo ,2005.
7881 * Permission to use, copy, modify, and distribute this software and its
7882 * documentation for any purpose is hereby granted without fee, provided
7883 * that this copyright and permissions notice appear in all copies and
7886 * This software is supplied "as is" without express or implied warranty.
7887 * This software was modified by Salvatore Sanfilippo for the Jim Interpreter.
7894 typedef struct DIR {
7895 long handle; /* -1 for failed rewind */
7896 struct _finddata_t info;
7897 struct dirent result; /* d_name null iff first time */
7898 char *name; /* null-terminated char string */
7901 DIR *opendir(const char *name)
7905 if(name && name[0]) {
7906 size_t base_length = strlen(name);
7907 const char *all = /* search pattern must end with suitable wildcard */
7908 strchr("/\\", name[base_length - 1]) ? "*" : "/*";
7910 if((dir = (DIR *) Jim_Alloc(sizeof *dir)) != 0 &&
7911 (dir->name = (char *) Jim_Alloc(base_length + strlen(all) + 1)) != 0)
7913 strcat(strcpy(dir->name, name), all);
7915 if((dir->handle = (long) _findfirst(dir->name, &dir->info)) != -1)
7916 dir->result.d_name = 0;
7917 else { /* rollback */
7918 Jim_Free(dir->name);
7922 } else { /* rollback */
7933 int closedir(DIR *dir)
7938 if(dir->handle != -1)
7939 result = _findclose(dir->handle);
7940 Jim_Free(dir->name);
7943 if(result == -1) /* map all errors to EBADF */
7948 struct dirent *readdir(DIR *dir)
7950 struct dirent *result = 0;
7952 if(dir && dir->handle != -1) {
7953 if(!dir->result.d_name || _findnext(dir->handle, &dir->info) != -1) {
7954 result = &dir->result;
7955 result->d_name = dir->info.name;
7965 static char *JimFindBestPackage(Jim_Interp *interp, char **prefixes,
7966 int prefixc, const char *pkgName, int pkgVer, int flags)
7968 int bestVer = -1, i;
7969 int pkgNameLen = strlen(pkgName);
7970 char *bestPackage = NULL;
7973 for (i = 0; i < prefixc; i++) {
7975 char buf[JIM_PATH_LEN];
7978 if (prefixes[i] == NULL) continue;
7979 strncpy(buf, prefixes[i], JIM_PATH_LEN);
7980 buf[JIM_PATH_LEN-1] = '\0';
7981 prefixLen = strlen(buf);
7982 if (prefixLen && buf[prefixLen-1] == '/')
7983 buf[prefixLen-1] = '\0';
7985 if ((dir = opendir(buf)) == NULL) continue;
7986 while ((de = readdir(dir)) != NULL) {
7987 char *fileName = de->d_name;
7988 int fileNameLen = strlen(fileName);
7990 if (strncmp(fileName, "jim-", 4) == 0 &&
7991 strncmp(fileName+4, pkgName, pkgNameLen) == 0 &&
7992 *(fileName+4+pkgNameLen) == '-' &&
7993 fileNameLen > 4 && /* note that this is not really useful */
7994 (strncmp(fileName+fileNameLen-4, ".tcl", 4) == 0 ||
7995 strncmp(fileName+fileNameLen-4, ".dll", 4) == 0 ||
7996 strncmp(fileName+fileNameLen-3, ".so", 3) == 0))
7998 char ver[6]; /* xx.yy<nulterm> */
7999 char *p = strrchr(fileName, '.');
8000 int verLen, fileVer;
8002 verLen = p - (fileName+4+pkgNameLen+1);
8003 if (verLen < 3 || verLen > 5) continue;
8004 memcpy(ver, fileName+4+pkgNameLen+1, verLen);
8006 if (JimPackageVersionToInt(interp, ver, &fileVer, JIM_NONE)
8007 != JIM_OK) continue;
8008 if (JimPackageMatchVersion(pkgVer, fileVer, flags) &&
8009 (bestVer == -1 || bestVer < fileVer))
8012 Jim_Free(bestPackage);
8013 bestPackage = Jim_Alloc(strlen(buf)+strlen(fileName)+2);
8014 sprintf(bestPackage, "%s/%s", buf, fileName);
8023 #else /* JIM_ANSIC */
8025 static char *JimFindBestPackage(Jim_Interp *interp, char **prefixes,
8026 int prefixc, const char *pkgName, int pkgVer, int flags)
8028 JIM_NOTUSED(interp);
8029 JIM_NOTUSED(prefixes);
8030 JIM_NOTUSED(prefixc);
8031 JIM_NOTUSED(pkgName);
8032 JIM_NOTUSED(pkgVer);
8037 #endif /* JIM_ANSIC */
8039 /* Search for a suitable package under every dir specified by jim_libpath
8040 * and load it if possible. If a suitable package was loaded with success
8041 * JIM_OK is returned, otherwise JIM_ERR is returned. */
8042 static int JimLoadPackage(Jim_Interp *interp, const char *name, int ver,
8045 Jim_Obj *libPathObjPtr;
8046 char **prefixes, *best;
8047 int prefixc, i, retCode = JIM_OK;
8049 libPathObjPtr = Jim_GetGlobalVariableStr(interp, "jim_libpath", JIM_NONE);
8050 if (libPathObjPtr == NULL) {
8052 libPathObjPtr = NULL;
8054 Jim_IncrRefCount(libPathObjPtr);
8055 Jim_ListLength(interp, libPathObjPtr, &prefixc);
8058 prefixes = Jim_Alloc(sizeof(char*)*prefixc);
8059 for (i = 0; i < prefixc; i++) {
8060 Jim_Obj *prefixObjPtr;
8061 if (Jim_ListIndex(interp, libPathObjPtr, i,
8062 &prefixObjPtr, JIM_NONE) != JIM_OK)
8067 prefixes[i] = Jim_StrDup(Jim_GetString(prefixObjPtr, NULL));
8069 /* Scan every directory to find the "best" package. */
8070 best = JimFindBestPackage(interp, prefixes, prefixc, name, ver, flags);
8072 char *p = strrchr(best, '.');
8073 /* Try to load/source it */
8074 if (p && strcmp(p, ".tcl") == 0) {
8075 retCode = Jim_EvalFile(interp, best);
8077 retCode = Jim_LoadLibrary(interp, best);
8083 for (i = 0; i < prefixc; i++)
8084 Jim_Free(prefixes[i]);
8087 Jim_DecrRefCount(interp, libPathObjPtr);
8091 const char *Jim_PackageRequire(Jim_Interp *interp, const char *name,
8092 const char *ver, int flags)
8097 if (JimPackageVersionToInt(interp, ver, &requiredVer, JIM_ERRMSG) != JIM_OK)
8099 he = Jim_FindHashEntry(&interp->packages, name);
8101 /* Try to load the package. */
8102 if (JimLoadPackage(interp, name, requiredVer, flags) == JIM_OK) {
8103 he = Jim_FindHashEntry(&interp->packages, name);
8109 /* No way... return an error. */
8110 if (flags & JIM_ERRMSG) {
8111 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
8112 Jim_AppendStrings(interp, Jim_GetResult(interp),
8113 "Can't find package '", name, "'", NULL);
8118 if (JimPackageVersionToInt(interp, he->val, &actualVer, JIM_ERRMSG)
8123 /* Check if version matches. */
8124 if (JimPackageMatchVersion(requiredVer, actualVer, flags) == 0) {
8125 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
8126 Jim_AppendStrings(interp, Jim_GetResult(interp),
8127 "Package '", name, "' already loaded, but with version ",
8135 /* -----------------------------------------------------------------------------
8137 * ---------------------------------------------------------------------------*/
8138 #define JIM_EVAL_SARGV_LEN 8 /* static arguments vector length */
8139 #define JIM_EVAL_SINTV_LEN 8 /* static interpolation vector length */
8141 static int JimCallProcedure(Jim_Interp *interp, Jim_Cmd *cmd, int argc,
8142 Jim_Obj *const *argv);
8144 /* Handle calls to the [unknown] command */
8145 static int JimUnknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
8147 Jim_Obj **v, *sv[JIM_EVAL_SARGV_LEN];
8150 /* If the [unknown] command does not exists returns
8152 if (Jim_GetCommand(interp, interp->unknown, JIM_NONE) == NULL)
8155 /* The object interp->unknown just contains
8156 * the "unknown" string, it is used in order to
8157 * avoid to lookup the unknown command every time
8158 * but instread to cache the result. */
8159 if (argc+1 <= JIM_EVAL_SARGV_LEN)
8162 v = Jim_Alloc(sizeof(Jim_Obj*)*(argc+1));
8163 /* Make a copy of the arguments vector, but shifted on
8164 * the right of one position. The command name of the
8165 * command will be instead the first argument of the
8166 * [unknonw] call. */
8167 memcpy(v+1, argv, sizeof(Jim_Obj*)*argc);
8168 v[0] = interp->unknown;
8170 retCode = Jim_EvalObjVector(interp, argc+1, v);
8177 /* Eval the object vector 'objv' composed of 'objc' elements.
8178 * Every element is used as single argument.
8179 * Jim_EvalObj() will call this function every time its object
8180 * argument is of "list" type, with no string representation.
8182 * This is possible because the string representation of a
8183 * list object generated by the UpdateStringOfList is made
8184 * in a way that ensures that every list element is a different
8185 * command argument. */
8186 int Jim_EvalObjVector(Jim_Interp *interp, int objc, Jim_Obj *const *objv)
8191 /* Incr refcount of arguments. */
8192 for (i = 0; i < objc; i++)
8193 Jim_IncrRefCount(objv[i]);
8194 /* Command lookup */
8195 cmdPtr = Jim_GetCommand(interp, objv[0], JIM_ERRMSG);
8196 if (cmdPtr == NULL) {
8197 retcode = JimUnknown(interp, objc, objv);
8199 /* Call it -- Make sure result is an empty object. */
8200 Jim_SetEmptyResult(interp);
8201 if (cmdPtr->cmdProc) {
8202 interp->cmdPrivData = cmdPtr->privData;
8203 retcode = cmdPtr->cmdProc(interp, objc, objv);
8205 retcode = JimCallProcedure(interp, cmdPtr, objc, objv);
8206 if (retcode == JIM_ERR) {
8207 JimAppendStackTrace(interp,
8208 Jim_GetString(objv[0], NULL), "?", 1);
8212 /* Decr refcount of arguments and return the retcode */
8213 for (i = 0; i < objc; i++)
8214 Jim_DecrRefCount(interp, objv[i]);
8218 /* Interpolate the given tokens into a unique Jim_Obj returned by reference
8219 * via *objPtrPtr. This function is only called by Jim_EvalObj().
8220 * The returned object has refcount = 0. */
8221 int Jim_InterpolateTokens(Jim_Interp *interp, ScriptToken *token,
8222 int tokens, Jim_Obj **objPtrPtr)
8224 int totlen = 0, i, retcode;
8226 Jim_Obj *sintv[JIM_EVAL_SINTV_LEN];
8230 if (tokens <= JIM_EVAL_SINTV_LEN)
8233 intv = Jim_Alloc(sizeof(Jim_Obj*)*
8235 /* Compute every token forming the argument
8236 * in the intv objects vector. */
8237 for (i = 0; i < tokens; i++) {
8238 switch(token[i].type) {
8241 intv[i] = token[i].objPtr;
8244 intv[i] = Jim_GetVariable(interp, token[i].objPtr, JIM_ERRMSG);
8250 case JIM_TT_DICTSUGAR:
8251 intv[i] = Jim_ExpandDictSugar(interp, token[i].objPtr);
8258 retcode = Jim_EvalObj(interp, token[i].objPtr);
8259 if (retcode != JIM_OK)
8261 intv[i] = Jim_GetResult(interp);
8265 "default token type reached "
8266 "in Jim_InterpolateTokens().");
8269 Jim_IncrRefCount(intv[i]);
8270 /* Make sure there is a valid
8271 * string rep, and add the string
8272 * length to the total legnth. */
8273 Jim_GetString(intv[i], NULL);
8274 totlen += intv[i]->length;
8276 /* Concatenate every token in an unique
8278 objPtr = Jim_NewStringObjNoAlloc(interp,
8280 s = objPtr->bytes = Jim_Alloc(totlen+1);
8281 objPtr->length = totlen;
8282 for (i = 0; i < tokens; i++) {
8283 memcpy(s, intv[i]->bytes, intv[i]->length);
8284 s += intv[i]->length;
8285 Jim_DecrRefCount(interp, intv[i]);
8287 objPtr->bytes[totlen] = '\0';
8288 /* Free the intv vector if not static. */
8289 if (tokens > JIM_EVAL_SINTV_LEN)
8291 *objPtrPtr = objPtr;
8296 Jim_DecrRefCount(interp, intv[i]);
8297 if (tokens > JIM_EVAL_SINTV_LEN)
8302 /* Helper of Jim_EvalObj() to perform argument expansion.
8303 * Basically this function append an argument to 'argv'
8304 * (and increments argc by reference accordingly), performing
8305 * expansion of the list object if 'expand' is non-zero, or
8306 * just adding objPtr to argv if 'expand' is zero. */
8307 void Jim_ExpandArgument(Jim_Interp *interp, Jim_Obj ***argv,
8308 int *argcPtr, int expand, Jim_Obj *objPtr)
8311 (*argv) = Jim_Realloc(*argv, sizeof(Jim_Obj*)*((*argcPtr)+1));
8312 /* refcount of objPtr not incremented because
8313 * we are actually transfering a reference from
8314 * the old 'argv' to the expanded one. */
8315 (*argv)[*argcPtr] = objPtr;
8320 Jim_ListLength(interp, objPtr, &len);
8321 (*argv) = Jim_Realloc(*argv, sizeof(Jim_Obj*)*((*argcPtr)+len));
8322 for (i = 0; i < len; i++) {
8323 (*argv)[*argcPtr] = objPtr->internalRep.listValue.ele[i];
8324 Jim_IncrRefCount(objPtr->internalRep.listValue.ele[i]);
8327 /* The original object reference is no longer needed,
8328 * after the expansion it is no longer present on
8329 * the argument vector, but the single elements are
8331 Jim_DecrRefCount(interp, objPtr);
8335 int Jim_EvalObj(Jim_Interp *interp, Jim_Obj *scriptObjPtr)
8340 int *cs; /* command structure array */
8341 int retcode = JIM_OK;
8342 Jim_Obj *sargv[JIM_EVAL_SARGV_LEN], **argv = NULL, *tmpObjPtr;
8344 interp->errorFlag = 0;
8346 /* If the object is of type "list" and there is no
8347 * string representation for this object, we can call
8348 * a specialized version of Jim_EvalObj() */
8349 if (scriptObjPtr->typePtr == &listObjType &&
8350 scriptObjPtr->internalRep.listValue.len &&
8351 scriptObjPtr->bytes == NULL) {
8352 Jim_IncrRefCount(scriptObjPtr);
8353 retcode = Jim_EvalObjVector(interp,
8354 scriptObjPtr->internalRep.listValue.len,
8355 scriptObjPtr->internalRep.listValue.ele);
8356 Jim_DecrRefCount(interp, scriptObjPtr);
8360 Jim_IncrRefCount(scriptObjPtr); /* Make sure it's shared. */
8361 script = Jim_GetScript(interp, scriptObjPtr);
8362 /* Now we have to make sure the internal repr will not be
8363 * freed on shimmering.
8365 * Think for example to this:
8367 * set x {llength $x; ... some more code ...}; eval $x
8369 * In order to preserve the internal rep, we increment the
8370 * inUse field of the script internal rep structure. */
8373 token = script->token;
8375 cs = script->cmdStruct;
8376 i = 0; /* 'i' is the current token index. */
8378 /* Reset the interpreter result. This is useful to
8379 * return the emtpy result in the case of empty program. */
8380 Jim_SetEmptyResult(interp);
8382 /* Execute every command sequentially, returns on
8383 * error (i.e. if a command does not return JIM_OK) */
8386 int argc = *cs++; /* Get the number of arguments */
8389 /* Set the expand flag if needed. */
8394 /* Allocate the arguments vector */
8395 if (argc <= JIM_EVAL_SARGV_LEN)
8398 argv = Jim_Alloc(sizeof(Jim_Obj*)*argc);
8399 /* Populate the arguments objects. */
8400 for (j = 0; j < argc; j++) {
8403 /* tokens is negative if expansion is needed.
8404 * for this argument. */
8406 tokens = (-tokens)-1;
8410 /* Fast path if the token does not
8411 * need interpolation */
8412 switch(token[i].type) {
8415 argv[j] = token[i].objPtr;
8418 tmpObjPtr = Jim_GetVariable(interp, token[i].objPtr,
8424 argv[j] = tmpObjPtr;
8426 case JIM_TT_DICTSUGAR:
8427 tmpObjPtr = Jim_ExpandDictSugar(interp, token[i].objPtr);
8432 argv[j] = tmpObjPtr;
8435 retcode = Jim_EvalObj(interp, token[i].objPtr);
8436 if (retcode != JIM_OK)
8438 argv[j] = Jim_GetResult(interp);
8442 "default token type reached "
8443 "in Jim_EvalObj().");
8446 Jim_IncrRefCount(argv[j]);
8449 /* For interpolation we call an helper
8450 * function doing the work for us. */
8451 if ((retcode = Jim_InterpolateTokens(interp,
8452 token+i, tokens, &tmpObjPtr)) != JIM_OK)
8456 argv[j] = tmpObjPtr;
8457 Jim_IncrRefCount(argv[j]);
8461 /* Handle {expand} expansion */
8463 int *ecs = cs - argc;
8465 Jim_Obj **eargv = NULL;
8467 for (j = 0; j < argc; j++) {
8468 Jim_ExpandArgument( interp, &eargv, &eargc,
8469 ecs[j] < 0, argv[j]);
8477 /* Nothing to do with zero args. */
8482 /* Lookup the command to call */
8483 cmd = Jim_GetCommand(interp, argv[0], JIM_ERRMSG);
8485 /* Call it -- Make sure result is an empty object. */
8486 Jim_SetEmptyResult(interp);
8488 interp->cmdPrivData = cmd->privData;
8489 retcode = cmd->cmdProc(interp, argc, argv);
8491 retcode = JimCallProcedure(interp, cmd, argc, argv);
8492 if (retcode == JIM_ERR) {
8493 JimAppendStackTrace(interp,
8494 Jim_GetString(argv[0], NULL), script->fileName,
8495 token[i-argc*2].linenr);
8499 /* Call [unknown] */
8500 retcode = JimUnknown(interp, argc, argv);
8502 if (retcode != JIM_OK) {
8503 i -= argc*2; /* point to the command name. */
8506 /* Decrement the arguments count */
8507 for (j = 0; j < argc; j++) {
8508 Jim_DecrRefCount(interp, argv[j]);
8511 if (argv != sargv) {
8516 /* Note that we don't have to decrement inUse, because the
8517 * following code transfers our use of the reference again to
8518 * the script object. */
8519 j = 0; /* on normal termination, the argv array is already
8520 Jim_DecrRefCount-ed. */
8522 /* Handle errors. */
8523 if (retcode == JIM_ERR && !interp->errorFlag) {
8524 interp->errorFlag = 1;
8525 JimSetErrorFileName(interp, script->fileName);
8526 JimSetErrorLineNumber(interp, token[i].linenr);
8527 JimResetStackTrace(interp);
8529 Jim_FreeIntRep(interp, scriptObjPtr);
8530 scriptObjPtr->typePtr = &scriptObjType;
8531 Jim_SetIntRepPtr(scriptObjPtr, script);
8532 Jim_DecrRefCount(interp, scriptObjPtr);
8533 for (i = 0; i < j; i++) {
8534 Jim_DecrRefCount(interp, argv[i]);
8541 /* Call a procedure implemented in Tcl.
8542 * It's possible to speed-up a lot this function, currently
8543 * the callframes are not cached, but allocated and
8544 * destroied every time. What is expecially costly is
8545 * to create/destroy the local vars hash table every time.
8547 * This can be fixed just implementing callframes caching
8548 * in JimCreateCallFrame() and JimFreeCallFrame(). */
8549 int JimCallProcedure(Jim_Interp *interp, Jim_Cmd *cmd, int argc,
8550 Jim_Obj *const *argv)
8553 Jim_CallFrame *callFramePtr;
8556 if (argc < cmd->arityMin || (cmd->arityMax != -1 &&
8557 argc > cmd->arityMax)) {
8558 Jim_Obj *objPtr = Jim_NewEmptyStringObj(interp);
8559 Jim_AppendStrings(interp, objPtr,
8560 "wrong # args: should be \"", Jim_GetString(argv[0], NULL),
8561 (cmd->arityMin > 1) ? " " : "",
8562 Jim_GetString(cmd->argListObjPtr, NULL), "\"", NULL);
8563 Jim_SetResult(interp, objPtr);
8566 /* Check if there are too nested calls */
8567 if (interp->numLevels == interp->maxNestingDepth) {
8568 Jim_SetResultString(interp,
8569 "Too many nested calls. Infinite recursion?", -1);
8572 /* Create a new callframe */
8573 callFramePtr = JimCreateCallFrame(interp);
8574 callFramePtr->parentCallFrame = interp->framePtr;
8575 callFramePtr->argv = argv;
8576 callFramePtr->argc = argc;
8577 callFramePtr->procArgsObjPtr = cmd->argListObjPtr;
8578 callFramePtr->procBodyObjPtr = cmd->bodyObjPtr;
8579 callFramePtr->staticVars = cmd->staticVars;
8580 Jim_IncrRefCount(cmd->argListObjPtr);
8581 Jim_IncrRefCount(cmd->bodyObjPtr);
8582 interp->framePtr = callFramePtr;
8583 interp->numLevels ++;
8585 for (i = 0; i < cmd->arityMin-1; i++) {
8588 Jim_ListIndex(interp, cmd->argListObjPtr, i, &objPtr, JIM_NONE);
8589 Jim_SetVariable(interp, objPtr, argv[i+1]);
8591 if (cmd->arityMax == -1) {
8592 Jim_Obj *listObjPtr, *objPtr;
8594 listObjPtr = Jim_NewListObj(interp, argv+cmd->arityMin,
8595 argc-cmd->arityMin);
8596 Jim_ListIndex(interp, cmd->argListObjPtr, i, &objPtr, JIM_NONE);
8597 Jim_SetVariable(interp, objPtr, listObjPtr);
8600 retcode = Jim_EvalObj(interp, cmd->bodyObjPtr);
8602 /* Destroy the callframe */
8603 interp->numLevels --;
8604 interp->framePtr = interp->framePtr->parentCallFrame;
8605 if (callFramePtr->vars.size != JIM_HT_INITIAL_SIZE) {
8606 JimFreeCallFrame(interp, callFramePtr, JIM_FCF_NONE);
8608 JimFreeCallFrame(interp, callFramePtr, JIM_FCF_NOHT);
8610 /* Handle the JIM_EVAL return code */
8611 if (retcode == JIM_EVAL && interp->evalRetcodeLevel != interp->numLevels) {
8612 int savedLevel = interp->evalRetcodeLevel;
8614 interp->evalRetcodeLevel = interp->numLevels;
8615 while (retcode == JIM_EVAL) {
8616 Jim_Obj *resultScriptObjPtr = Jim_GetResult(interp);
8617 Jim_IncrRefCount(resultScriptObjPtr);
8618 retcode = Jim_EvalObj(interp, resultScriptObjPtr);
8619 Jim_DecrRefCount(interp, resultScriptObjPtr);
8621 interp->evalRetcodeLevel = savedLevel;
8623 /* Handle the JIM_RETURN return code */
8624 if (retcode == JIM_RETURN) {
8625 retcode = interp->returnCode;
8626 interp->returnCode = JIM_OK;
8631 int Jim_Eval(Jim_Interp *interp, const char *script)
8633 Jim_Obj *scriptObjPtr = Jim_NewStringObj(interp, script, -1);
8636 Jim_IncrRefCount(scriptObjPtr);
8637 retval = Jim_EvalObj(interp, scriptObjPtr);
8638 Jim_DecrRefCount(interp, scriptObjPtr);
8642 /* Execute script in the scope of the global level */
8643 int Jim_EvalGlobal(Jim_Interp *interp, const char *script)
8645 Jim_CallFrame *savedFramePtr;
8648 savedFramePtr = interp->framePtr;
8649 interp->framePtr = interp->topFramePtr;
8650 retval = Jim_Eval(interp, script);
8651 interp->framePtr = savedFramePtr;
8655 int Jim_EvalObjBackground(Jim_Interp *interp, Jim_Obj *scriptObjPtr)
8657 Jim_CallFrame *savedFramePtr;
8660 savedFramePtr = interp->framePtr;
8661 interp->framePtr = interp->topFramePtr;
8662 retval = Jim_EvalObj(interp, scriptObjPtr);
8663 interp->framePtr = savedFramePtr;
8664 /* Try to report the error (if any) via the bgerror proc */
8665 if (retval != JIM_OK) {
8668 objv[0] = Jim_NewStringObj(interp, "bgerror", -1);
8669 objv[1] = Jim_GetResult(interp);
8670 Jim_IncrRefCount(objv[0]);
8671 Jim_IncrRefCount(objv[1]);
8672 if (Jim_EvalObjVector(interp, 2, objv) != JIM_OK) {
8673 /* Report the error to stderr. */
8674 Jim_fprintf( interp, interp->cookie_stderr, "Background error:" JIM_NL);
8675 Jim_PrintErrorMessage(interp);
8677 Jim_DecrRefCount(interp, objv[0]);
8678 Jim_DecrRefCount(interp, objv[1]);
8683 int Jim_EvalFile(Jim_Interp *interp, const char *filename)
8687 int nread, totread, maxlen, buflen;
8689 Jim_Obj *scriptObjPtr;
8691 if ((fp = fopen(filename, "r")) == NULL) {
8692 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
8693 Jim_AppendStrings(interp, Jim_GetResult(interp),
8694 "Error loading script \"", filename, "\": ",
8695 strerror(errno), NULL);
8699 maxlen = totread = 0;
8701 if (maxlen < totread+buflen+1) {
8702 maxlen = totread+buflen+1;
8703 prg = Jim_Realloc(prg, maxlen);
8705 /* do not use Jim_fread() - this is really a file */
8706 if ((nread = fread(prg+totread, 1, buflen, fp)) == 0) break;
8709 prg[totread] = '\0';
8710 /* do not use Jim_fclose() - this is really a file */
8713 scriptObjPtr = Jim_NewStringObjNoAlloc(interp, prg, totread);
8714 JimSetSourceInfo(interp, scriptObjPtr, filename, 1);
8715 Jim_IncrRefCount(scriptObjPtr);
8716 retval = Jim_EvalObj(interp, scriptObjPtr);
8717 Jim_DecrRefCount(interp, scriptObjPtr);
8721 /* -----------------------------------------------------------------------------
8723 * ---------------------------------------------------------------------------*/
8724 static int JimParseSubstStr(struct JimParserCtx *pc)
8727 pc->tline = pc->linenr;
8728 while (*pc->p && *pc->p != '$' && *pc->p != '[') {
8732 pc->tt = JIM_TT_ESC;
8736 static int JimParseSubst(struct JimParserCtx *pc, int flags)
8741 pc->tstart = pc->tend = pc->p;
8742 pc->tline = pc->linenr;
8743 pc->tt = JIM_TT_EOL;
8749 retval = JimParseCmd(pc);
8750 if (flags & JIM_SUBST_NOCMD) {
8753 pc->tt = (flags & JIM_SUBST_NOESC) ?
8754 JIM_TT_STR : JIM_TT_ESC;
8759 if (JimParseVar(pc) == JIM_ERR) {
8760 pc->tstart = pc->tend = pc->p++; pc->len--;
8761 pc->tline = pc->linenr;
8762 pc->tt = JIM_TT_STR;
8764 if (flags & JIM_SUBST_NOVAR) {
8766 if (flags & JIM_SUBST_NOESC)
8767 pc->tt = JIM_TT_STR;
8769 pc->tt = JIM_TT_ESC;
8770 if (*pc->tstart == '{') {
8779 retval = JimParseSubstStr(pc);
8780 if (flags & JIM_SUBST_NOESC)
8781 pc->tt = JIM_TT_STR;
8788 /* The subst object type reuses most of the data structures and functions
8789 * of the script object. Script's data structures are a bit more complex
8790 * for what is needed for [subst]itution tasks, but the reuse helps to
8791 * deal with a single data structure at the cost of some more memory
8792 * usage for substitutions. */
8793 static Jim_ObjType substObjType = {
8795 FreeScriptInternalRep,
8796 DupScriptInternalRep,
8798 JIM_TYPE_REFERENCES,
8801 /* This method takes the string representation of an object
8802 * as a Tcl string where to perform [subst]itution, and generates
8803 * the pre-parsed internal representation. */
8804 int SetSubstFromAny(Jim_Interp *interp, struct Jim_Obj *objPtr, int flags)
8807 const char *scriptText = Jim_GetString(objPtr, &scriptTextLen);
8808 struct JimParserCtx parser;
8809 struct ScriptObj *script = Jim_Alloc(sizeof(*script));
8813 script->commands = 0;
8814 script->token = NULL;
8815 script->cmdStruct = NULL;
8817 script->substFlags = flags;
8818 script->fileName = NULL;
8820 JimParserInit(&parser, scriptText, scriptTextLen, 1);
8823 int len, type, linenr;
8825 JimParseSubst(&parser, flags);
8826 if (JimParserEof(&parser)) break;
8827 token = JimParserGetToken(&parser, &len, &type, &linenr);
8828 ScriptObjAddToken(interp, script, token, len, type,
8831 /* Free the old internal rep and set the new one. */
8832 Jim_FreeIntRep(interp, objPtr);
8833 Jim_SetIntRepPtr(objPtr, script);
8834 objPtr->typePtr = &scriptObjType;
8838 ScriptObj *Jim_GetSubst(Jim_Interp *interp, Jim_Obj *objPtr, int flags)
8840 struct ScriptObj *script = Jim_GetIntRepPtr(objPtr);
8842 if (objPtr->typePtr != &substObjType || script->substFlags != flags)
8843 SetSubstFromAny(interp, objPtr, flags);
8844 return (ScriptObj*) Jim_GetIntRepPtr(objPtr);
8847 /* Performs commands,variables,blackslashes substitution,
8848 * storing the result object (with refcount 0) into
8850 int Jim_SubstObj(Jim_Interp *interp, Jim_Obj *substObjPtr,
8851 Jim_Obj **resObjPtrPtr, int flags)
8855 int i, len, retcode = JIM_OK;
8856 Jim_Obj *resObjPtr, *savedResultObjPtr;
8858 script = Jim_GetSubst(interp, substObjPtr, flags);
8859 #ifdef JIM_OPTIMIZATION
8860 /* Fast path for a very common case with array-alike syntax,
8861 * that's: $foo($bar) */
8862 if (script->len == 1 && script->token[0].type == JIM_TT_VAR) {
8863 Jim_Obj *varObjPtr = script->token[0].objPtr;
8865 Jim_IncrRefCount(varObjPtr);
8866 resObjPtr = Jim_GetVariable(interp, varObjPtr, JIM_ERRMSG);
8867 if (resObjPtr == NULL) {
8868 Jim_DecrRefCount(interp, varObjPtr);
8871 Jim_DecrRefCount(interp, varObjPtr);
8872 *resObjPtrPtr = resObjPtr;
8877 Jim_IncrRefCount(substObjPtr); /* Make sure it's shared. */
8878 /* In order to preserve the internal rep, we increment the
8879 * inUse field of the script internal rep structure. */
8882 token = script->token;
8885 /* Save the interp old result, to set it again before
8887 savedResultObjPtr = interp->result;
8888 Jim_IncrRefCount(savedResultObjPtr);
8890 /* Perform the substitution. Starts with an empty object
8891 * and adds every token (performing the appropriate
8892 * var/command/escape substitution). */
8893 resObjPtr = Jim_NewStringObj(interp, "", 0);
8894 for (i = 0; i < len; i++) {
8897 switch(token[i].type) {
8900 Jim_AppendObj(interp, resObjPtr, token[i].objPtr);
8903 objPtr = Jim_GetVariable(interp, token[i].objPtr, JIM_ERRMSG);
8904 if (objPtr == NULL) goto err;
8905 Jim_IncrRefCount(objPtr);
8906 Jim_AppendObj(interp, resObjPtr, objPtr);
8907 Jim_DecrRefCount(interp, objPtr);
8910 if (Jim_EvalObj(interp, token[i].objPtr) != JIM_OK)
8912 Jim_AppendObj(interp, resObjPtr, interp->result);
8916 "default token type (%d) reached "
8917 "in Jim_SubstObj().", token[i].type);
8922 if (retcode == JIM_OK)
8923 Jim_SetResult(interp, savedResultObjPtr);
8924 Jim_DecrRefCount(interp, savedResultObjPtr);
8925 /* Note that we don't have to decrement inUse, because the
8926 * following code transfers our use of the reference again to
8927 * the script object. */
8928 Jim_FreeIntRep(interp, substObjPtr);
8929 substObjPtr->typePtr = &scriptObjType;
8930 Jim_SetIntRepPtr(substObjPtr, script);
8931 Jim_DecrRefCount(interp, substObjPtr);
8932 *resObjPtrPtr = resObjPtr;
8935 Jim_FreeNewObj(interp, resObjPtr);
8940 /* -----------------------------------------------------------------------------
8941 * API Input/Export functions
8942 * ---------------------------------------------------------------------------*/
8944 int Jim_GetApi(Jim_Interp *interp, const char *funcname, void *targetPtrPtr)
8948 he = Jim_FindHashEntry(&interp->stub, funcname);
8951 memcpy(targetPtrPtr, &he->val, sizeof(void*));
8955 int Jim_RegisterApi(Jim_Interp *interp, const char *funcname, void *funcptr)
8957 return Jim_AddHashEntry(&interp->stub, funcname, funcptr);
8960 #define JIM_REGISTER_API(name) \
8961 Jim_RegisterApi(interp, "Jim_" #name, (void *)Jim_ ## name)
8963 void JimRegisterCoreApi(Jim_Interp *interp)
8965 interp->getApiFuncPtr = Jim_GetApi;
8966 JIM_REGISTER_API(Alloc);
8967 JIM_REGISTER_API(Free);
8968 JIM_REGISTER_API(Eval);
8969 JIM_REGISTER_API(EvalGlobal);
8970 JIM_REGISTER_API(EvalFile);
8971 JIM_REGISTER_API(EvalObj);
8972 JIM_REGISTER_API(EvalObjBackground);
8973 JIM_REGISTER_API(EvalObjVector);
8974 JIM_REGISTER_API(InitHashTable);
8975 JIM_REGISTER_API(ExpandHashTable);
8976 JIM_REGISTER_API(AddHashEntry);
8977 JIM_REGISTER_API(ReplaceHashEntry);
8978 JIM_REGISTER_API(DeleteHashEntry);
8979 JIM_REGISTER_API(FreeHashTable);
8980 JIM_REGISTER_API(FindHashEntry);
8981 JIM_REGISTER_API(ResizeHashTable);
8982 JIM_REGISTER_API(GetHashTableIterator);
8983 JIM_REGISTER_API(NextHashEntry);
8984 JIM_REGISTER_API(NewObj);
8985 JIM_REGISTER_API(FreeObj);
8986 JIM_REGISTER_API(InvalidateStringRep);
8987 JIM_REGISTER_API(InitStringRep);
8988 JIM_REGISTER_API(DuplicateObj);
8989 JIM_REGISTER_API(GetString);
8990 JIM_REGISTER_API(Length);
8991 JIM_REGISTER_API(InvalidateStringRep);
8992 JIM_REGISTER_API(NewStringObj);
8993 JIM_REGISTER_API(NewStringObjNoAlloc);
8994 JIM_REGISTER_API(AppendString);
8995 JIM_REGISTER_API(AppendObj);
8996 JIM_REGISTER_API(AppendStrings);
8997 JIM_REGISTER_API(StringEqObj);
8998 JIM_REGISTER_API(StringMatchObj);
8999 JIM_REGISTER_API(StringRangeObj);
9000 JIM_REGISTER_API(FormatString);
9001 JIM_REGISTER_API(CompareStringImmediate);
9002 JIM_REGISTER_API(NewReference);
9003 JIM_REGISTER_API(GetReference);
9004 JIM_REGISTER_API(SetFinalizer);
9005 JIM_REGISTER_API(GetFinalizer);
9006 JIM_REGISTER_API(CreateInterp);
9007 JIM_REGISTER_API(FreeInterp);
9008 JIM_REGISTER_API(GetExitCode);
9009 JIM_REGISTER_API(SetStdin);
9010 JIM_REGISTER_API(SetStdout);
9011 JIM_REGISTER_API(SetStderr);
9012 JIM_REGISTER_API(CreateCommand);
9013 JIM_REGISTER_API(CreateProcedure);
9014 JIM_REGISTER_API(DeleteCommand);
9015 JIM_REGISTER_API(RenameCommand);
9016 JIM_REGISTER_API(GetCommand);
9017 JIM_REGISTER_API(SetVariable);
9018 JIM_REGISTER_API(SetVariableStr);
9019 JIM_REGISTER_API(SetGlobalVariableStr);
9020 JIM_REGISTER_API(SetVariableStrWithStr);
9021 JIM_REGISTER_API(SetVariableLink);
9022 JIM_REGISTER_API(GetVariable);
9023 JIM_REGISTER_API(GetCallFrameByLevel);
9024 JIM_REGISTER_API(Collect);
9025 JIM_REGISTER_API(CollectIfNeeded);
9026 JIM_REGISTER_API(GetIndex);
9027 JIM_REGISTER_API(NewListObj);
9028 JIM_REGISTER_API(ListAppendElement);
9029 JIM_REGISTER_API(ListAppendList);
9030 JIM_REGISTER_API(ListLength);
9031 JIM_REGISTER_API(ListIndex);
9032 JIM_REGISTER_API(SetListIndex);
9033 JIM_REGISTER_API(ConcatObj);
9034 JIM_REGISTER_API(NewDictObj);
9035 JIM_REGISTER_API(DictKey);
9036 JIM_REGISTER_API(DictKeysVector);
9037 JIM_REGISTER_API(GetIndex);
9038 JIM_REGISTER_API(GetReturnCode);
9039 JIM_REGISTER_API(EvalExpression);
9040 JIM_REGISTER_API(GetBoolFromExpr);
9041 JIM_REGISTER_API(GetWide);
9042 JIM_REGISTER_API(GetLong);
9043 JIM_REGISTER_API(SetWide);
9044 JIM_REGISTER_API(NewIntObj);
9045 JIM_REGISTER_API(GetDouble);
9046 JIM_REGISTER_API(SetDouble);
9047 JIM_REGISTER_API(NewDoubleObj);
9048 JIM_REGISTER_API(WrongNumArgs);
9049 JIM_REGISTER_API(SetDictKeysVector);
9050 JIM_REGISTER_API(SubstObj);
9051 JIM_REGISTER_API(RegisterApi);
9052 JIM_REGISTER_API(PrintErrorMessage);
9053 JIM_REGISTER_API(InteractivePrompt);
9054 JIM_REGISTER_API(RegisterCoreCommands);
9055 JIM_REGISTER_API(GetSharedString);
9056 JIM_REGISTER_API(ReleaseSharedString);
9057 JIM_REGISTER_API(Panic);
9058 JIM_REGISTER_API(StrDup);
9059 JIM_REGISTER_API(UnsetVariable);
9060 JIM_REGISTER_API(GetVariableStr);
9061 JIM_REGISTER_API(GetGlobalVariable);
9062 JIM_REGISTER_API(GetGlobalVariableStr);
9063 JIM_REGISTER_API(GetAssocData);
9064 JIM_REGISTER_API(SetAssocData);
9065 JIM_REGISTER_API(DeleteAssocData);
9066 JIM_REGISTER_API(GetEnum);
9067 JIM_REGISTER_API(ScriptIsComplete);
9068 JIM_REGISTER_API(PackageRequire);
9069 JIM_REGISTER_API(PackageProvide);
9070 JIM_REGISTER_API(InitStack);
9071 JIM_REGISTER_API(FreeStack);
9072 JIM_REGISTER_API(StackLen);
9073 JIM_REGISTER_API(StackPush);
9074 JIM_REGISTER_API(StackPop);
9075 JIM_REGISTER_API(StackPeek);
9076 JIM_REGISTER_API(FreeStackElements);
9079 /* -----------------------------------------------------------------------------
9080 * Core commands utility functions
9081 * ---------------------------------------------------------------------------*/
9082 void Jim_WrongNumArgs(Jim_Interp *interp, int argc, Jim_Obj *const *argv,
9086 Jim_Obj *objPtr = Jim_NewEmptyStringObj(interp);
9088 Jim_AppendString(interp, objPtr, "wrong # args: should be \"", -1);
9089 for (i = 0; i < argc; i++) {
9090 Jim_AppendObj(interp, objPtr, argv[i]);
9091 if (!(i+1 == argc && msg[0] == '\0'))
9092 Jim_AppendString(interp, objPtr, " ", 1);
9094 Jim_AppendString(interp, objPtr, msg, -1);
9095 Jim_AppendString(interp, objPtr, "\"", 1);
9096 Jim_SetResult(interp, objPtr);
9099 static Jim_Obj *JimCommandsList(Jim_Interp *interp, Jim_Obj *patternObjPtr)
9101 Jim_HashTableIterator *htiter;
9103 Jim_Obj *listObjPtr = Jim_NewListObj(interp, NULL, 0);
9104 const char *pattern;
9107 pattern = patternObjPtr ? Jim_GetString(patternObjPtr, &patternLen) : NULL;
9108 htiter = Jim_GetHashTableIterator(&interp->commands);
9109 while ((he = Jim_NextHashEntry(htiter)) != NULL) {
9110 if (pattern && !JimStringMatch(pattern, patternLen, he->key,
9111 strlen((const char*)he->key), 0))
9113 Jim_ListAppendElement(interp, listObjPtr,
9114 Jim_NewStringObj(interp, he->key, -1));
9116 Jim_FreeHashTableIterator(htiter);
9120 #define JIM_VARLIST_GLOBALS 0
9121 #define JIM_VARLIST_LOCALS 1
9122 #define JIM_VARLIST_VARS 2
9124 static Jim_Obj *JimVariablesList(Jim_Interp *interp, Jim_Obj *patternObjPtr,
9127 Jim_HashTableIterator *htiter;
9129 Jim_Obj *listObjPtr = Jim_NewListObj(interp, NULL, 0);
9130 const char *pattern;
9133 pattern = patternObjPtr ? Jim_GetString(patternObjPtr, &patternLen) : NULL;
9134 if (mode == JIM_VARLIST_GLOBALS) {
9135 htiter = Jim_GetHashTableIterator(&interp->topFramePtr->vars);
9137 /* For [info locals], if we are at top level an emtpy list
9138 * is returned. I don't agree, but we aim at compatibility (SS) */
9139 if (mode == JIM_VARLIST_LOCALS &&
9140 interp->framePtr == interp->topFramePtr)
9142 htiter = Jim_GetHashTableIterator(&interp->framePtr->vars);
9144 while ((he = Jim_NextHashEntry(htiter)) != NULL) {
9145 Jim_Var *varPtr = (Jim_Var*) he->val;
9146 if (mode == JIM_VARLIST_LOCALS) {
9147 if (varPtr->linkFramePtr != NULL)
9150 if (pattern && !JimStringMatch(pattern, patternLen, he->key,
9151 strlen((const char*)he->key), 0))
9153 Jim_ListAppendElement(interp, listObjPtr,
9154 Jim_NewStringObj(interp, he->key, -1));
9156 Jim_FreeHashTableIterator(htiter);
9160 static int JimInfoLevel(Jim_Interp *interp, Jim_Obj *levelObjPtr,
9161 Jim_Obj **objPtrPtr)
9163 Jim_CallFrame *targetCallFrame;
9165 if (JimGetCallFrameByInteger(interp, levelObjPtr, &targetCallFrame)
9168 /* No proc call at toplevel callframe */
9169 if (targetCallFrame == interp->topFramePtr) {
9170 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
9171 Jim_AppendStrings(interp, Jim_GetResult(interp),
9173 Jim_GetString(levelObjPtr, NULL), "\"", NULL);
9176 *objPtrPtr = Jim_NewListObj(interp,
9177 targetCallFrame->argv,
9178 targetCallFrame->argc);
9182 /* -----------------------------------------------------------------------------
9184 * ---------------------------------------------------------------------------*/
9186 /* fake [puts] -- not the real puts, just for debugging. */
9187 static int Jim_PutsCoreCommand(Jim_Interp *interp, int argc,
9188 Jim_Obj *const *argv)
9191 int len, nonewline = 0;
9193 if (argc != 2 && argc != 3) {
9194 Jim_WrongNumArgs(interp, 1, argv, "-nonewline string");
9198 if (!Jim_CompareStringImmediate(interp, argv[1], "-nonewline"))
9200 Jim_SetResultString(interp, "The second argument must "
9201 "be -nonewline", -1);
9208 str = Jim_GetString(argv[1], &len);
9209 Jim_fwrite(interp, str, 1, len, interp->cookie_stdout);
9210 if (!nonewline) Jim_fprintf( interp, interp->cookie_stdout, JIM_NL);
9214 /* Helper for [+] and [*] */
9215 static int Jim_AddMulHelper(Jim_Interp *interp, int argc,
9216 Jim_Obj *const *argv, int op)
9218 jim_wide wideValue, res;
9219 double doubleValue, doubleRes;
9222 res = (op == JIM_EXPROP_ADD) ? 0 : 1;
9224 for (i = 1; i < argc; i++) {
9225 if (Jim_GetWide(interp, argv[i], &wideValue) != JIM_OK)
9227 if (op == JIM_EXPROP_ADD)
9232 Jim_SetResult(interp, Jim_NewIntObj(interp, res));
9235 doubleRes = (double) res;
9236 for (;i < argc; i++) {
9237 if (Jim_GetDouble(interp, argv[i], &doubleValue) != JIM_OK)
9239 if (op == JIM_EXPROP_ADD)
9240 doubleRes += doubleValue;
9242 doubleRes *= doubleValue;
9244 Jim_SetResult(interp, Jim_NewDoubleObj(interp, doubleRes));
9248 /* Helper for [-] and [/] */
9249 static int Jim_SubDivHelper(Jim_Interp *interp, int argc,
9250 Jim_Obj *const *argv, int op)
9252 jim_wide wideValue, res = 0;
9253 double doubleValue, doubleRes = 0;
9257 Jim_WrongNumArgs(interp, 1, argv, "number ?number ... number?");
9259 } else if (argc == 2) {
9260 /* The arity = 2 case is different. For [- x] returns -x,
9261 * while [/ x] returns 1/x. */
9262 if (Jim_GetWide(interp, argv[1], &wideValue) != JIM_OK) {
9263 if (Jim_GetDouble(interp, argv[1], &doubleValue) !=
9268 if (op == JIM_EXPROP_SUB)
9269 doubleRes = -doubleValue;
9271 doubleRes = 1.0/doubleValue;
9272 Jim_SetResult(interp, Jim_NewDoubleObj(interp,
9277 if (op == JIM_EXPROP_SUB) {
9279 Jim_SetResult(interp, Jim_NewIntObj(interp, res));
9281 doubleRes = 1.0/wideValue;
9282 Jim_SetResult(interp, Jim_NewDoubleObj(interp,
9287 if (Jim_GetWide(interp, argv[1], &res) != JIM_OK) {
9288 if (Jim_GetDouble(interp, argv[1], &doubleRes)
9296 for (i = 2; i < argc; i++) {
9297 if (Jim_GetWide(interp, argv[i], &wideValue) != JIM_OK) {
9298 doubleRes = (double) res;
9301 if (op == JIM_EXPROP_SUB)
9306 Jim_SetResult(interp, Jim_NewIntObj(interp, res));
9309 for (;i < argc; i++) {
9310 if (Jim_GetDouble(interp, argv[i], &doubleValue) != JIM_OK)
9312 if (op == JIM_EXPROP_SUB)
9313 doubleRes -= doubleValue;
9315 doubleRes /= doubleValue;
9317 Jim_SetResult(interp, Jim_NewDoubleObj(interp, doubleRes));
9323 static int Jim_AddCoreCommand(Jim_Interp *interp, int argc,
9324 Jim_Obj *const *argv)
9326 return Jim_AddMulHelper(interp, argc, argv, JIM_EXPROP_ADD);
9330 static int Jim_MulCoreCommand(Jim_Interp *interp, int argc,
9331 Jim_Obj *const *argv)
9333 return Jim_AddMulHelper(interp, argc, argv, JIM_EXPROP_MUL);
9337 static int Jim_SubCoreCommand(Jim_Interp *interp, int argc,
9338 Jim_Obj *const *argv)
9340 return Jim_SubDivHelper(interp, argc, argv, JIM_EXPROP_SUB);
9344 static int Jim_DivCoreCommand(Jim_Interp *interp, int argc,
9345 Jim_Obj *const *argv)
9347 return Jim_SubDivHelper(interp, argc, argv, JIM_EXPROP_DIV);
9351 static int Jim_SetCoreCommand(Jim_Interp *interp, int argc,
9352 Jim_Obj *const *argv)
9354 if (argc != 2 && argc != 3) {
9355 Jim_WrongNumArgs(interp, 1, argv, "varName ?newValue?");
9360 objPtr = Jim_GetVariable(interp, argv[1], JIM_ERRMSG);
9363 Jim_SetResult(interp, objPtr);
9366 /* argc == 3 case. */
9367 if (Jim_SetVariable(interp, argv[1], argv[2]) != JIM_OK)
9369 Jim_SetResult(interp, argv[2]);
9374 static int Jim_UnsetCoreCommand(Jim_Interp *interp, int argc,
9375 Jim_Obj *const *argv)
9380 Jim_WrongNumArgs(interp, 1, argv, "varName ?varName ...?");
9383 for (i = 1; i < argc; i++) {
9384 if (Jim_UnsetVariable(interp, argv[i], JIM_ERRMSG) != JIM_OK)
9391 static int Jim_IncrCoreCommand(Jim_Interp *interp, int argc,
9392 Jim_Obj *const *argv)
9394 jim_wide wideValue, increment = 1;
9397 if (argc != 2 && argc != 3) {
9398 Jim_WrongNumArgs(interp, 1, argv, "varName ?increment?");
9402 if (Jim_GetWide(interp, argv[2], &increment) != JIM_OK)
9405 intObjPtr = Jim_GetVariable(interp, argv[1], JIM_ERRMSG);
9406 if (!intObjPtr) return JIM_ERR;
9407 if (Jim_GetWide(interp, intObjPtr, &wideValue) != JIM_OK)
9409 if (Jim_IsShared(intObjPtr)) {
9410 intObjPtr = Jim_NewIntObj(interp, wideValue+increment);
9411 if (Jim_SetVariable(interp, argv[1], intObjPtr) != JIM_OK) {
9412 Jim_FreeNewObj(interp, intObjPtr);
9416 Jim_SetWide(interp, intObjPtr, wideValue+increment);
9417 /* The following step is required in order to invalidate the
9418 * string repr of "FOO" if the var name is on the form of "FOO(IDX)" */
9419 if (Jim_SetVariable(interp, argv[1], intObjPtr) != JIM_OK) {
9423 Jim_SetResult(interp, intObjPtr);
9428 static int Jim_WhileCoreCommand(Jim_Interp *interp, int argc,
9429 Jim_Obj *const *argv)
9432 Jim_WrongNumArgs(interp, 1, argv, "condition body");
9435 /* Try to run a specialized version of while if the expression
9436 * is in one of the following forms:
9438 * $a < CONST, $a < $b
9439 * $a <= CONST, $a <= $b
9440 * $a > CONST, $a > $b
9441 * $a >= CONST, $a >= $b
9442 * $a != CONST, $a != $b
9443 * $a == CONST, $a == $b
9449 #ifdef JIM_OPTIMIZATION
9452 Jim_Obj *varAObjPtr = NULL, *varBObjPtr = NULL, *objPtr;
9453 int exprLen, retval;
9455 /* STEP 1 -- Check if there are the conditions to run the specialized
9456 * version of while */
9458 if ((expr = Jim_GetExpression(interp, argv[1])) == NULL) goto noopt;
9459 if (expr->len <= 0 || expr->len > 3) goto noopt;
9462 if (expr->opcode[0] != JIM_EXPROP_VARIABLE &&
9463 expr->opcode[0] != JIM_EXPROP_NUMBER)
9467 if (expr->opcode[1] != JIM_EXPROP_NOT ||
9468 expr->opcode[0] != JIM_EXPROP_VARIABLE)
9472 if (expr->opcode[0] != JIM_EXPROP_VARIABLE ||
9473 (expr->opcode[1] != JIM_EXPROP_NUMBER &&
9474 expr->opcode[1] != JIM_EXPROP_VARIABLE))
9476 switch(expr->opcode[2]) {
9478 case JIM_EXPROP_LTE:
9480 case JIM_EXPROP_GTE:
9481 case JIM_EXPROP_NUMEQ:
9482 case JIM_EXPROP_NUMNE:
9491 "Unexpected default reached in Jim_WhileCoreCommand()");
9495 /* STEP 2 -- conditions meet. Initialization. Take different
9496 * branches for different expression lengths. */
9497 exprLen = expr->len;
9502 if (expr->opcode[0] == JIM_EXPROP_VARIABLE) {
9503 varAObjPtr = expr->obj[0];
9504 Jim_IncrRefCount(varAObjPtr);
9506 if (Jim_GetWide(interp, expr->obj[0], &wideValue) != JIM_OK)
9512 Jim_GetVariable(interp, varAObjPtr, JIM_NONE)) ||
9513 Jim_GetWide(interp, objPtr, &wideValue) != JIM_OK)
9515 Jim_DecrRefCount(interp, varAObjPtr);
9519 if (!wideValue) break;
9520 if ((retval = Jim_EvalObj(interp, argv[2])) != JIM_OK) {
9524 Jim_DecrRefCount(interp, varAObjPtr);
9532 Jim_DecrRefCount(interp, varAObjPtr);
9538 Jim_DecrRefCount(interp, varAObjPtr);
9539 } else if (exprLen == 3) {
9540 jim_wide wideValueA, wideValueB, cmpRes = 0;
9541 int cmpType = expr->opcode[2];
9543 varAObjPtr = expr->obj[0];
9544 Jim_IncrRefCount(varAObjPtr);
9545 if (expr->opcode[1] == JIM_EXPROP_VARIABLE) {
9546 varBObjPtr = expr->obj[1];
9547 Jim_IncrRefCount(varBObjPtr);
9549 if (Jim_GetWide(interp, expr->obj[1], &wideValueB) != JIM_OK)
9553 if (!(objPtr = Jim_GetVariable(interp, varAObjPtr, JIM_NONE)) ||
9554 Jim_GetWide(interp, objPtr, &wideValueA) != JIM_OK)
9556 Jim_DecrRefCount(interp, varAObjPtr);
9558 Jim_DecrRefCount(interp, varBObjPtr);
9563 Jim_GetVariable(interp, varBObjPtr, JIM_NONE)) ||
9564 Jim_GetWide(interp, objPtr, &wideValueB) != JIM_OK)
9566 Jim_DecrRefCount(interp, varAObjPtr);
9568 Jim_DecrRefCount(interp, varBObjPtr);
9574 cmpRes = wideValueA < wideValueB; break;
9575 case JIM_EXPROP_LTE:
9576 cmpRes = wideValueA <= wideValueB; break;
9578 cmpRes = wideValueA > wideValueB; break;
9579 case JIM_EXPROP_GTE:
9580 cmpRes = wideValueA >= wideValueB; break;
9581 case JIM_EXPROP_NUMEQ:
9582 cmpRes = wideValueA == wideValueB; break;
9583 case JIM_EXPROP_NUMNE:
9584 cmpRes = wideValueA != wideValueB; break;
9587 if ((retval = Jim_EvalObj(interp, argv[2])) != JIM_OK) {
9590 Jim_DecrRefCount(interp, varAObjPtr);
9592 Jim_DecrRefCount(interp, varBObjPtr);
9599 Jim_DecrRefCount(interp, varAObjPtr);
9601 Jim_DecrRefCount(interp, varBObjPtr);
9606 Jim_DecrRefCount(interp, varAObjPtr);
9608 Jim_DecrRefCount(interp, varBObjPtr);
9610 /* TODO: case for len == 2 */
9613 Jim_SetEmptyResult(interp);
9619 /* The general purpose implementation of while starts here */
9621 int boolean, retval;
9623 if ((retval = Jim_GetBoolFromExpr(interp, argv[1],
9624 &boolean)) != JIM_OK)
9626 if (!boolean) break;
9627 if ((retval = Jim_EvalObj(interp, argv[2])) != JIM_OK) {
9641 Jim_SetEmptyResult(interp);
9646 static int Jim_ForCoreCommand(Jim_Interp *interp, int argc,
9647 Jim_Obj *const *argv)
9652 Jim_WrongNumArgs(interp, 1, argv, "start test next body");
9655 /* Check if the for is on the form:
9656 * for {set i CONST} {$i < CONST} {incr i}
9657 * for {set i CONST} {$i < $j} {incr i}
9658 * for {set i CONST} {$i <= CONST} {incr i}
9659 * for {set i CONST} {$i <= $j} {incr i}
9660 * XXX: NOTE: if variable traces are implemented, this optimization
9661 * need to be modified to check for the proc epoch at every variable
9663 #ifdef JIM_OPTIMIZATION
9665 ScriptObj *initScript, *incrScript;
9667 jim_wide start, stop, currentVal;
9668 unsigned jim_wide procEpoch = interp->procEpoch;
9669 Jim_Obj *varNamePtr, *stopVarNamePtr = NULL, *objPtr;
9671 struct Jim_Cmd *cmdPtr;
9673 /* Do it only if there aren't shared arguments */
9674 if (argv[1] == argv[2] || argv[2] == argv[3] || argv[1] == argv[3])
9676 initScript = Jim_GetScript(interp, argv[1]);
9677 expr = Jim_GetExpression(interp, argv[2]);
9678 incrScript = Jim_GetScript(interp, argv[3]);
9680 /* Ensure proper lengths to start */
9681 if (initScript->len != 6) goto evalstart;
9682 if (incrScript->len != 4) goto evalstart;
9683 if (expr->len != 3) goto evalstart;
9684 /* Ensure proper token types. */
9685 if (initScript->token[2].type != JIM_TT_ESC ||
9686 initScript->token[4].type != JIM_TT_ESC ||
9687 incrScript->token[2].type != JIM_TT_ESC ||
9688 expr->opcode[0] != JIM_EXPROP_VARIABLE ||
9689 (expr->opcode[1] != JIM_EXPROP_NUMBER &&
9690 expr->opcode[1] != JIM_EXPROP_VARIABLE) ||
9691 (expr->opcode[2] != JIM_EXPROP_LT &&
9692 expr->opcode[2] != JIM_EXPROP_LTE))
9694 cmpType = expr->opcode[2];
9695 /* Initialization command must be [set] */
9696 cmdPtr = Jim_GetCommand(interp, initScript->token[0].objPtr, JIM_NONE);
9697 if (cmdPtr == NULL || cmdPtr->cmdProc != Jim_SetCoreCommand)
9699 /* Update command must be incr */
9700 cmdPtr = Jim_GetCommand(interp, incrScript->token[0].objPtr, JIM_NONE);
9701 if (cmdPtr == NULL || cmdPtr->cmdProc != Jim_IncrCoreCommand)
9703 /* set, incr, expression must be about the same variable */
9704 if (!Jim_StringEqObj(initScript->token[2].objPtr,
9705 incrScript->token[2].objPtr, 0))
9707 if (!Jim_StringEqObj(initScript->token[2].objPtr,
9710 /* Check that the initialization and comparison are valid integers */
9711 if (Jim_GetWide(interp, initScript->token[4].objPtr, &start) == JIM_ERR)
9713 if (expr->opcode[1] == JIM_EXPROP_NUMBER &&
9714 Jim_GetWide(interp, expr->obj[1], &stop) == JIM_ERR)
9719 /* Initialization */
9720 varNamePtr = expr->obj[0];
9721 if (expr->opcode[1] == JIM_EXPROP_VARIABLE) {
9722 stopVarNamePtr = expr->obj[1];
9723 Jim_IncrRefCount(stopVarNamePtr);
9725 Jim_IncrRefCount(varNamePtr);
9727 /* --- OPTIMIZED FOR --- */
9729 objPtr = Jim_NewIntObj(interp, start);
9730 if (Jim_SetVariable(interp, varNamePtr, objPtr) != JIM_OK) {
9731 Jim_DecrRefCount(interp, varNamePtr);
9732 if (stopVarNamePtr) Jim_DecrRefCount(interp, stopVarNamePtr);
9733 Jim_FreeNewObj(interp, objPtr);
9737 /* === Check condition === */
9739 objPtr = Jim_GetVariable(interp, varNamePtr, JIM_NONE);
9740 if (objPtr == NULL ||
9741 Jim_GetWide(interp, objPtr, ¤tVal) != JIM_OK)
9743 Jim_DecrRefCount(interp, varNamePtr);
9744 if (stopVarNamePtr) Jim_DecrRefCount(interp, stopVarNamePtr);
9747 /* Immediate or Variable? get the 'stop' value if the latter. */
9748 if (stopVarNamePtr) {
9749 objPtr = Jim_GetVariable(interp, stopVarNamePtr, JIM_NONE);
9750 if (objPtr == NULL ||
9751 Jim_GetWide(interp, objPtr, &stop) != JIM_OK)
9753 Jim_DecrRefCount(interp, varNamePtr);
9754 Jim_DecrRefCount(interp, stopVarNamePtr);
9758 if (cmpType == JIM_EXPROP_LT) {
9759 if (currentVal >= stop) break;
9761 if (currentVal > stop) break;
9764 if ((retval = Jim_EvalObj(interp, argv[4])) != JIM_OK) {
9768 Jim_DecrRefCount(interp, stopVarNamePtr);
9769 Jim_DecrRefCount(interp, varNamePtr);
9776 Jim_DecrRefCount(interp, stopVarNamePtr);
9777 Jim_DecrRefCount(interp, varNamePtr);
9781 /* If there was a change in procedures/command continue
9782 * with the usual [for] command implementation */
9783 if (procEpoch != interp->procEpoch) {
9785 Jim_DecrRefCount(interp, stopVarNamePtr);
9786 Jim_DecrRefCount(interp, varNamePtr);
9790 objPtr = Jim_GetVariable(interp, varNamePtr, JIM_ERRMSG);
9791 if (objPtr->refCount == 1 && objPtr->typePtr == &intObjType) {
9792 objPtr->internalRep.wideValue ++;
9793 Jim_InvalidateStringRep(objPtr);
9797 if (Jim_GetWide(interp, objPtr, ¤tVal) == JIM_ERR) {
9799 Jim_DecrRefCount(interp, stopVarNamePtr);
9800 Jim_DecrRefCount(interp, varNamePtr);
9803 auxObjPtr = Jim_NewIntObj(interp, currentVal+1);
9804 if (Jim_SetVariable(interp, varNamePtr, auxObjPtr) == JIM_ERR) {
9806 Jim_DecrRefCount(interp, stopVarNamePtr);
9807 Jim_DecrRefCount(interp, varNamePtr);
9808 Jim_FreeNewObj(interp, auxObjPtr);
9814 Jim_DecrRefCount(interp, stopVarNamePtr);
9815 Jim_DecrRefCount(interp, varNamePtr);
9816 Jim_SetEmptyResult(interp);
9822 if ((retval = Jim_EvalObj(interp, argv[1])) != JIM_OK)
9827 /* Test the condition */
9828 if ((retval = Jim_GetBoolFromExpr(interp, argv[2], &boolean))
9831 if (!boolean) break;
9833 if ((retval = Jim_EvalObj(interp, argv[4])) != JIM_OK) {
9847 if ((retval = Jim_EvalObj(interp, argv[3])) != JIM_OK) {
9861 Jim_SetEmptyResult(interp);
9865 /* foreach + lmap implementation. */
9866 static int JimForeachMapHelper(Jim_Interp *interp, int argc,
9867 Jim_Obj *const *argv, int doMap)
9869 int result = JIM_ERR, i, nbrOfLists, *listsIdx, *listsEnd;
9871 Jim_Obj *emptyStr, *script, *mapRes = NULL;
9873 if (argc < 4 || argc % 2 != 0) {
9874 Jim_WrongNumArgs(interp, 1, argv, "varList list ?varList list ...? script");
9878 mapRes = Jim_NewListObj(interp, NULL, 0);
9879 Jim_IncrRefCount(mapRes);
9881 emptyStr = Jim_NewEmptyStringObj(interp);
9882 Jim_IncrRefCount(emptyStr);
9883 script = argv[argc-1]; /* Last argument is a script */
9884 nbrOfLists = (argc - 1 - 1) / 2; /* argc - 'foreach' - script */
9885 listsIdx = (int*)Jim_Alloc(nbrOfLists * sizeof(int));
9886 listsEnd = (int*)Jim_Alloc(nbrOfLists*2 * sizeof(int));
9887 /* Initialize iterators and remember max nbr elements each list */
9888 memset(listsIdx, 0, nbrOfLists * sizeof(int));
9889 /* Remember lengths of all lists and calculate how much rounds to loop */
9890 for (i=0; i < nbrOfLists*2; i += 2) {
9893 Jim_ListLength(interp, argv[i+1], &listsEnd[i]);
9894 Jim_ListLength(interp, argv[i+2], &listsEnd[i+1]);
9895 if (listsEnd[i] == 0) {
9896 Jim_SetResultString(interp, "foreach varlist is empty", -1);
9899 cnt = div(listsEnd[i+1], listsEnd[i]);
9900 count = cnt.quot + (cnt.rem ? 1 : 0);
9901 if (count > nbrOfLoops)
9904 for (; nbrOfLoops-- > 0; ) {
9905 for (i=0; i < nbrOfLists; ++i) {
9906 int varIdx = 0, var = i * 2;
9907 while (varIdx < listsEnd[var]) {
9908 Jim_Obj *varName, *ele;
9909 int lst = i * 2 + 1;
9910 if (Jim_ListIndex(interp, argv[var+1], varIdx, &varName, JIM_ERRMSG)
9913 if (listsIdx[i] < listsEnd[lst]) {
9914 if (Jim_ListIndex(interp, argv[lst+1], listsIdx[i], &ele, JIM_ERRMSG)
9917 if (Jim_SetVariable(interp, varName, ele) != JIM_OK) {
9918 Jim_SetResultString(interp, "couldn't set loop variable: ", -1);
9921 ++listsIdx[i]; /* Remember next iterator of current list */
9922 } else if (Jim_SetVariable(interp, varName, emptyStr) != JIM_OK) {
9923 Jim_SetResultString(interp, "couldn't set loop variable: ", -1);
9926 ++varIdx; /* Next variable */
9929 switch (result = Jim_EvalObj(interp, script)) {
9932 Jim_ListAppendElement(interp, mapRes, interp->result);
9946 Jim_SetResult(interp, mapRes);
9948 Jim_SetEmptyResult(interp);
9951 Jim_DecrRefCount(interp, mapRes);
9952 Jim_DecrRefCount(interp, emptyStr);
9959 static int Jim_ForeachCoreCommand(Jim_Interp *interp, int argc,
9960 Jim_Obj *const *argv)
9962 return JimForeachMapHelper(interp, argc, argv, 0);
9966 static int Jim_LmapCoreCommand(Jim_Interp *interp, int argc,
9967 Jim_Obj *const *argv)
9969 return JimForeachMapHelper(interp, argc, argv, 1);
9973 static int Jim_IfCoreCommand(Jim_Interp *interp, int argc,
9974 Jim_Obj *const *argv)
9976 int boolean, retval, current = 1, falsebody = 0;
9979 /* Far not enough arguments given! */
9980 if (current >= argc) goto err;
9981 if ((retval = Jim_GetBoolFromExpr(interp,
9982 argv[current++], &boolean))
9985 /* There lacks something, isn't it? */
9986 if (current >= argc) goto err;
9987 if (Jim_CompareStringImmediate(interp, argv[current],
9989 /* Tsk tsk, no then-clause? */
9990 if (current >= argc) goto err;
9992 return Jim_EvalObj(interp, argv[current]);
9993 /* Ok: no else-clause follows */
9994 if (++current >= argc) return JIM_OK;
9995 falsebody = current++;
9996 if (Jim_CompareStringImmediate(interp, argv[falsebody],
9998 /* IIICKS - else-clause isn't last cmd? */
9999 if (current != argc-1) goto err;
10000 return Jim_EvalObj(interp, argv[current]);
10001 } else if (Jim_CompareStringImmediate(interp,
10002 argv[falsebody], "elseif"))
10003 /* Ok: elseif follows meaning all the stuff
10004 * again (how boring...) */
10006 /* OOPS - else-clause is not last cmd?*/
10007 else if (falsebody != argc-1)
10009 return Jim_EvalObj(interp, argv[falsebody]);
10014 Jim_WrongNumArgs(interp, 1, argv, "condition ?then? trueBody ?elseif ...? ?else? falseBody");
10018 enum {SWITCH_EXACT, SWITCH_GLOB, SWITCH_RE, SWITCH_CMD, SWITCH_UNKNOWN};
10021 static int Jim_SwitchCoreCommand(Jim_Interp *interp, int argc,
10022 Jim_Obj *const *argv)
10024 int retcode = JIM_ERR, matchOpt = SWITCH_EXACT, opt=1, patCount, i;
10025 Jim_Obj *command = 0, *const *caseList = 0, *strObj;
10026 Jim_Obj *script = 0;
10027 if (argc < 3) goto wrongnumargs;
10028 for (opt=1; opt < argc; ++opt) {
10029 const char *option = Jim_GetString(argv[opt], 0);
10030 if (*option != '-') break;
10031 else if (strncmp(option, "--", 2) == 0) { ++opt; break; }
10032 else if (strncmp(option, "-exact", 2) == 0) matchOpt = SWITCH_EXACT;
10033 else if (strncmp(option, "-glob", 2) == 0) matchOpt = SWITCH_GLOB;
10034 else if (strncmp(option, "-regexp", 2) == 0) matchOpt = SWITCH_RE;
10035 else if (strncmp(option, "-command", 2) == 0) { matchOpt = SWITCH_CMD;
10036 if ((argc - opt) < 2) goto wrongnumargs;
10037 command = argv[++opt];
10039 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
10040 Jim_AppendStrings(interp, Jim_GetResult(interp),
10041 "bad option \"", option, "\": must be -exact, -glob, "
10042 "-regexp, -command procname or --", 0);
10045 if ((argc - opt) < 2) goto wrongnumargs;
10047 strObj = argv[opt++];
10048 patCount = argc - opt;
10049 if (patCount == 1) {
10051 JimListGetElements(interp, argv[opt], &patCount, &vector);
10054 caseList = &argv[opt];
10055 if (patCount == 0 || patCount % 2 != 0) goto wrongnumargs;
10056 for (i=0; script == 0 && i < patCount; i += 2) {
10057 Jim_Obj *patObj = caseList[i];
10058 if (!Jim_CompareStringImmediate(interp, patObj, "default")
10059 || i < (patCount-2)) {
10060 switch (matchOpt) {
10062 if (Jim_StringEqObj(strObj, patObj, 0))
10063 script = caseList[i+1];
10066 if (Jim_StringMatchObj(patObj, strObj, 0))
10067 script = caseList[i+1];
10070 command = Jim_NewStringObj(interp, "regexp", -1);
10071 /* Fall thru intentionally */
10073 Jim_Obj *parms[] = {command, patObj, strObj};
10074 int rc = Jim_EvalObjVector(interp, 3, parms);
10076 /* After the execution of a command we need to
10077 * make sure to reconvert the object into a list
10078 * again. Only for the single-list style [switch]. */
10079 if (argc-opt == 1) {
10081 JimListGetElements(interp, argv[opt], &patCount,
10085 /* command is here already decref'd */
10086 if (rc != JIM_OK) {
10090 rc = Jim_GetLong(interp, Jim_GetResult(interp), &matching);
10091 if (rc != JIM_OK) {
10096 script = caseList[i+1];
10100 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
10101 Jim_AppendStrings(interp, Jim_GetResult(interp),
10102 "internal error: no such option implemented", 0);
10106 script = caseList[i+1];
10109 for(; i < patCount && Jim_CompareStringImmediate(interp, script, "-");
10111 script = caseList[i+1];
10112 if (script && Jim_CompareStringImmediate(interp, script, "-")) {
10113 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
10114 Jim_AppendStrings(interp, Jim_GetResult(interp),
10115 "no body specified for pattern \"",
10116 Jim_GetString(caseList[i-2], 0), "\"", 0);
10120 Jim_SetEmptyResult(interp);
10122 retcode = Jim_EvalObj(interp, script);
10125 Jim_WrongNumArgs(interp, 1, argv, "?options? string "
10126 "pattern body ... ?default body? or "
10127 "{pattern body ?pattern body ...?}");
10133 static int Jim_ListCoreCommand(Jim_Interp *interp, int argc,
10134 Jim_Obj *const *argv)
10136 Jim_Obj *listObjPtr;
10138 listObjPtr = Jim_NewListObj(interp, argv+1, argc-1);
10139 Jim_SetResult(interp, listObjPtr);
10144 static int Jim_LindexCoreCommand(Jim_Interp *interp, int argc,
10145 Jim_Obj *const *argv)
10147 Jim_Obj *objPtr, *listObjPtr;
10152 Jim_WrongNumArgs(interp, 1, argv, "list index ?...?");
10156 Jim_IncrRefCount(objPtr);
10157 for (i = 2; i < argc; i++) {
10158 listObjPtr = objPtr;
10159 if (Jim_GetIndex(interp, argv[i], &index) != JIM_OK) {
10160 Jim_DecrRefCount(interp, listObjPtr);
10163 if (Jim_ListIndex(interp, listObjPtr, index, &objPtr,
10164 JIM_NONE) != JIM_OK) {
10165 /* Returns an empty object if the index
10166 * is out of range. */
10167 Jim_DecrRefCount(interp, listObjPtr);
10168 Jim_SetEmptyResult(interp);
10171 Jim_IncrRefCount(objPtr);
10172 Jim_DecrRefCount(interp, listObjPtr);
10174 Jim_SetResult(interp, objPtr);
10175 Jim_DecrRefCount(interp, objPtr);
10180 static int Jim_LlengthCoreCommand(Jim_Interp *interp, int argc,
10181 Jim_Obj *const *argv)
10186 Jim_WrongNumArgs(interp, 1, argv, "list");
10189 Jim_ListLength(interp, argv[1], &len);
10190 Jim_SetResult(interp, Jim_NewIntObj(interp, len));
10195 static int Jim_LappendCoreCommand(Jim_Interp *interp, int argc,
10196 Jim_Obj *const *argv)
10198 Jim_Obj *listObjPtr;
10202 Jim_WrongNumArgs(interp, 1, argv, "varName ?value value ...?");
10205 listObjPtr = Jim_GetVariable(interp, argv[1], JIM_NONE);
10207 /* Create the list if it does not exists */
10208 listObjPtr = Jim_NewListObj(interp, NULL, 0);
10209 if (Jim_SetVariable(interp, argv[1], listObjPtr) != JIM_OK) {
10210 Jim_FreeNewObj(interp, listObjPtr);
10214 shared = Jim_IsShared(listObjPtr);
10216 listObjPtr = Jim_DuplicateObj(interp, listObjPtr);
10217 for (i = 2; i < argc; i++)
10218 Jim_ListAppendElement(interp, listObjPtr, argv[i]);
10219 if (Jim_SetVariable(interp, argv[1], listObjPtr) != JIM_OK) {
10221 Jim_FreeNewObj(interp, listObjPtr);
10224 Jim_SetResult(interp, listObjPtr);
10229 static int Jim_LinsertCoreCommand(Jim_Interp *interp, int argc,
10230 Jim_Obj *const *argv)
10236 Jim_WrongNumArgs(interp, 1, argv, "list index element "
10241 if (Jim_IsShared(listPtr))
10242 listPtr = Jim_DuplicateObj(interp, listPtr);
10243 if (Jim_GetIndex(interp, argv[2], &index) != JIM_OK)
10245 Jim_ListLength(interp, listPtr, &len);
10248 else if (index < 0)
10249 index = len + index + 1;
10250 Jim_ListInsertElements(interp, listPtr, index, argc-3, &argv[3]);
10251 Jim_SetResult(interp, listPtr);
10254 if (listPtr != argv[1]) {
10255 Jim_FreeNewObj(interp, listPtr);
10261 static int Jim_LsetCoreCommand(Jim_Interp *interp, int argc,
10262 Jim_Obj *const *argv)
10265 Jim_WrongNumArgs(interp, 1, argv, "listVar ?index...? newVal");
10267 } else if (argc == 3) {
10268 if (Jim_SetVariable(interp, argv[1], argv[2]) != JIM_OK)
10270 Jim_SetResult(interp, argv[2]);
10273 if (Jim_SetListIndex(interp, argv[1], argv+2, argc-3, argv[argc-1])
10274 == JIM_ERR) return JIM_ERR;
10279 static int Jim_LsortCoreCommand(Jim_Interp *interp, int argc, Jim_Obj *const argv[])
10281 const char *options[] = {
10282 "-ascii", "-nocase", "-increasing", "-decreasing", NULL
10284 enum {OPT_ASCII, OPT_NOCASE, OPT_INCREASING, OPT_DECREASING};
10286 int i, lsortType = JIM_LSORT_ASCII; /* default sort type */
10287 int decreasing = 0;
10290 Jim_WrongNumArgs(interp, 1, argv, "?options? list");
10293 for (i = 1; i < (argc-1); i++) {
10296 if (Jim_GetEnum(interp, argv[i], options, &option, "option", JIM_ERRMSG)
10300 case OPT_ASCII: lsortType = JIM_LSORT_ASCII; break;
10301 case OPT_NOCASE: lsortType = JIM_LSORT_NOCASE; break;
10302 case OPT_INCREASING: decreasing = 0; break;
10303 case OPT_DECREASING: decreasing = 1; break;
10307 switch(lsortType) {
10308 case JIM_LSORT_ASCII: lsortType = JIM_LSORT_ASCII_DECR; break;
10309 case JIM_LSORT_NOCASE: lsortType = JIM_LSORT_NOCASE_DECR; break;
10312 resObj = Jim_DuplicateObj(interp, argv[argc-1]);
10313 ListSortElements(interp, resObj, lsortType);
10314 Jim_SetResult(interp, resObj);
10319 static int Jim_AppendCoreCommand(Jim_Interp *interp, int argc,
10320 Jim_Obj *const *argv)
10322 Jim_Obj *stringObjPtr;
10326 Jim_WrongNumArgs(interp, 1, argv, "varName ?value value ...?");
10330 stringObjPtr = Jim_GetVariable(interp, argv[1], JIM_ERRMSG);
10331 if (!stringObjPtr) return JIM_ERR;
10333 stringObjPtr = Jim_GetVariable(interp, argv[1], JIM_NONE);
10334 if (!stringObjPtr) {
10335 /* Create the string if it does not exists */
10336 stringObjPtr = Jim_NewEmptyStringObj(interp);
10337 if (Jim_SetVariable(interp, argv[1], stringObjPtr)
10339 Jim_FreeNewObj(interp, stringObjPtr);
10344 shared = Jim_IsShared(stringObjPtr);
10346 stringObjPtr = Jim_DuplicateObj(interp, stringObjPtr);
10347 for (i = 2; i < argc; i++)
10348 Jim_AppendObj(interp, stringObjPtr, argv[i]);
10349 if (Jim_SetVariable(interp, argv[1], stringObjPtr) != JIM_OK) {
10351 Jim_FreeNewObj(interp, stringObjPtr);
10354 Jim_SetResult(interp, stringObjPtr);
10359 static int Jim_DebugCoreCommand(Jim_Interp *interp, int argc,
10360 Jim_Obj *const *argv)
10362 const char *options[] = {
10363 "refcount", "objcount", "objects", "invstr", "scriptlen", "exprlen",
10368 OPT_REFCOUNT, OPT_OBJCOUNT, OPT_OBJECTS, OPT_INVSTR, OPT_SCRIPTLEN,
10369 OPT_EXPRLEN, OPT_EXPRBC
10374 Jim_WrongNumArgs(interp, 1, argv, "option ?...?");
10377 if (Jim_GetEnum(interp, argv[1], options, &option, "option",
10378 JIM_ERRMSG) != JIM_OK)
10380 if (option == OPT_REFCOUNT) {
10382 Jim_WrongNumArgs(interp, 2, argv, "object");
10385 Jim_SetResult(interp, Jim_NewIntObj(interp, argv[2]->refCount));
10387 } else if (option == OPT_OBJCOUNT) {
10388 int freeobj = 0, liveobj = 0;
10393 Jim_WrongNumArgs(interp, 2, argv, "");
10396 /* Count the number of free objects. */
10397 objPtr = interp->freeList;
10400 objPtr = objPtr->nextObjPtr;
10402 /* Count the number of live objects. */
10403 objPtr = interp->liveList;
10406 objPtr = objPtr->nextObjPtr;
10408 /* Set the result string and return. */
10409 sprintf(buf, "free %d used %d", freeobj, liveobj);
10410 Jim_SetResultString(interp, buf, -1);
10412 } else if (option == OPT_OBJECTS) {
10413 Jim_Obj *objPtr, *listObjPtr, *subListObjPtr;
10414 /* Count the number of live objects. */
10415 objPtr = interp->liveList;
10416 listObjPtr = Jim_NewListObj(interp, NULL, 0);
10419 const char *type = objPtr->typePtr ?
10420 objPtr->typePtr->name : "";
10421 subListObjPtr = Jim_NewListObj(interp, NULL, 0);
10422 sprintf(buf, "%p", objPtr);
10423 Jim_ListAppendElement(interp, subListObjPtr,
10424 Jim_NewStringObj(interp, buf, -1));
10425 Jim_ListAppendElement(interp, subListObjPtr,
10426 Jim_NewStringObj(interp, type, -1));
10427 Jim_ListAppendElement(interp, subListObjPtr,
10428 Jim_NewIntObj(interp, objPtr->refCount));
10429 Jim_ListAppendElement(interp, subListObjPtr, objPtr);
10430 Jim_ListAppendElement(interp, listObjPtr, subListObjPtr);
10431 objPtr = objPtr->nextObjPtr;
10433 Jim_SetResult(interp, listObjPtr);
10435 } else if (option == OPT_INVSTR) {
10439 Jim_WrongNumArgs(interp, 2, argv, "object");
10443 if (objPtr->typePtr != NULL)
10444 Jim_InvalidateStringRep(objPtr);
10445 Jim_SetEmptyResult(interp);
10447 } else if (option == OPT_SCRIPTLEN) {
10450 Jim_WrongNumArgs(interp, 2, argv, "script");
10453 script = Jim_GetScript(interp, argv[2]);
10454 Jim_SetResult(interp, Jim_NewIntObj(interp, script->len));
10456 } else if (option == OPT_EXPRLEN) {
10457 ExprByteCode *expr;
10459 Jim_WrongNumArgs(interp, 2, argv, "expression");
10462 expr = Jim_GetExpression(interp, argv[2]);
10465 Jim_SetResult(interp, Jim_NewIntObj(interp, expr->len));
10467 } else if (option == OPT_EXPRBC) {
10469 ExprByteCode *expr;
10473 Jim_WrongNumArgs(interp, 2, argv, "expression");
10476 expr = Jim_GetExpression(interp, argv[2]);
10479 objPtr = Jim_NewListObj(interp, NULL, 0);
10480 for (i = 0; i < expr->len; i++) {
10482 Jim_ExprOperator *op;
10484 switch(expr->opcode[i]) {
10485 case JIM_EXPROP_NUMBER: type = "number"; break;
10486 case JIM_EXPROP_COMMAND: type = "command"; break;
10487 case JIM_EXPROP_VARIABLE: type = "variable"; break;
10488 case JIM_EXPROP_DICTSUGAR: type = "dictsugar"; break;
10489 case JIM_EXPROP_SUBST: type = "subst"; break;
10490 case JIM_EXPROP_STRING: type = "string"; break;
10492 op = JimExprOperatorInfo(Jim_GetString(expr->obj[i], NULL));
10500 Jim_ListAppendElement(interp, objPtr,
10501 Jim_NewStringObj(interp, type, -1));
10502 Jim_ListAppendElement(interp, objPtr, expr->obj[i]);
10504 Jim_SetResult(interp, objPtr);
10507 Jim_SetResultString(interp,
10508 "bad option. Valid options are refcount, "
10509 "objcount, objects, invstr", -1);
10512 return JIM_OK; /* unreached */
10516 static int Jim_EvalCoreCommand(Jim_Interp *interp, int argc,
10517 Jim_Obj *const *argv)
10520 return Jim_EvalObj(interp, argv[1]);
10521 } else if (argc > 2) {
10525 objPtr = Jim_ConcatObj(interp, argc-1, argv+1);
10526 Jim_IncrRefCount(objPtr);
10527 retcode = Jim_EvalObj(interp, objPtr);
10528 Jim_DecrRefCount(interp, objPtr);
10531 Jim_WrongNumArgs(interp, 1, argv, "script ?...?");
10537 static int Jim_UplevelCoreCommand(Jim_Interp *interp, int argc,
10538 Jim_Obj *const *argv)
10541 int retcode, newLevel, oldLevel;
10542 Jim_CallFrame *savedCallFrame, *targetCallFrame;
10546 /* Save the old callframe pointer */
10547 savedCallFrame = interp->framePtr;
10549 /* Lookup the target frame pointer */
10550 str = Jim_GetString(argv[1], NULL);
10551 if ((str[0] >= '0' && str[0] <= '9') || str[0] == '#')
10553 if (Jim_GetCallFrameByLevel(interp, argv[1],
10555 &newLevel) != JIM_OK)
10560 if (Jim_GetCallFrameByLevel(interp, NULL,
10562 &newLevel) != JIM_OK)
10568 Jim_WrongNumArgs(interp, 1, argv,
10569 "?level? command ?arg ...?");
10572 /* Eval the code in the target callframe. */
10573 interp->framePtr = targetCallFrame;
10574 oldLevel = interp->numLevels;
10575 interp->numLevels = newLevel;
10577 retcode = Jim_EvalObj(interp, argv[1]);
10579 objPtr = Jim_ConcatObj(interp, argc-1, argv+1);
10580 Jim_IncrRefCount(objPtr);
10581 retcode = Jim_EvalObj(interp, objPtr);
10582 Jim_DecrRefCount(interp, objPtr);
10584 interp->numLevels = oldLevel;
10585 interp->framePtr = savedCallFrame;
10588 Jim_WrongNumArgs(interp, 1, argv, "?level? command ?arg ...?");
10594 static int Jim_ExprCoreCommand(Jim_Interp *interp, int argc,
10595 Jim_Obj *const *argv)
10597 Jim_Obj *exprResultPtr;
10601 retcode = Jim_EvalExpression(interp, argv[1], &exprResultPtr);
10602 } else if (argc > 2) {
10605 objPtr = Jim_ConcatObj(interp, argc-1, argv+1);
10606 Jim_IncrRefCount(objPtr);
10607 retcode = Jim_EvalExpression(interp, objPtr, &exprResultPtr);
10608 Jim_DecrRefCount(interp, objPtr);
10610 Jim_WrongNumArgs(interp, 1, argv, "expression ?...?");
10613 if (retcode != JIM_OK) return retcode;
10614 Jim_SetResult(interp, exprResultPtr);
10615 Jim_DecrRefCount(interp, exprResultPtr);
10620 static int Jim_BreakCoreCommand(Jim_Interp *interp, int argc,
10621 Jim_Obj *const *argv)
10624 Jim_WrongNumArgs(interp, 1, argv, "");
10631 static int Jim_ContinueCoreCommand(Jim_Interp *interp, int argc,
10632 Jim_Obj *const *argv)
10635 Jim_WrongNumArgs(interp, 1, argv, "");
10638 return JIM_CONTINUE;
10642 static int Jim_ReturnCoreCommand(Jim_Interp *interp, int argc,
10643 Jim_Obj *const *argv)
10647 } else if (argc == 2) {
10648 Jim_SetResult(interp, argv[1]);
10649 interp->returnCode = JIM_OK;
10651 } else if (argc == 3 || argc == 4) {
10653 if (Jim_GetReturnCode(interp, argv[2], &returnCode) == JIM_ERR)
10655 interp->returnCode = returnCode;
10657 Jim_SetResult(interp, argv[3]);
10660 Jim_WrongNumArgs(interp, 1, argv, "?-code code? ?result?");
10663 return JIM_RETURN; /* unreached */
10667 static int Jim_TailcallCoreCommand(Jim_Interp *interp, int argc,
10668 Jim_Obj *const *argv)
10672 objPtr = Jim_NewListObj(interp, argv+1, argc-1);
10673 Jim_SetResult(interp, objPtr);
10678 static int Jim_ProcCoreCommand(Jim_Interp *interp, int argc,
10679 Jim_Obj *const *argv)
10682 int arityMin, arityMax;
10684 if (argc != 4 && argc != 5) {
10685 Jim_WrongNumArgs(interp, 1, argv, "name arglist ?statics? body");
10688 Jim_ListLength(interp, argv[2], &argListLen);
10689 arityMin = arityMax = argListLen+1;
10693 Jim_Obj *lastArgPtr;
10695 Jim_ListIndex(interp, argv[2], argListLen-1, &lastArgPtr, JIM_NONE);
10696 str = Jim_GetString(lastArgPtr, &len);
10697 if (len == 4 && memcmp(str, "args", 4) == 0) {
10703 return Jim_CreateProcedure(interp, Jim_GetString(argv[1], NULL),
10704 argv[2], NULL, argv[3], arityMin, arityMax);
10706 return Jim_CreateProcedure(interp, Jim_GetString(argv[1], NULL),
10707 argv[2], argv[3], argv[4], arityMin, arityMax);
10712 static int Jim_ConcatCoreCommand(Jim_Interp *interp, int argc,
10713 Jim_Obj *const *argv)
10715 Jim_SetResult(interp, Jim_ConcatObj(interp, argc-1, argv+1));
10720 static int Jim_UpvarCoreCommand(Jim_Interp *interp, int argc,
10721 Jim_Obj *const *argv)
10725 Jim_CallFrame *targetCallFrame;
10727 /* Lookup the target frame pointer */
10728 str = Jim_GetString(argv[1], NULL);
10730 ((str[0] >= '0' && str[0] <= '9') || str[0] == '#'))
10732 if (Jim_GetCallFrameByLevel(interp, argv[1],
10733 &targetCallFrame, NULL) != JIM_OK)
10738 if (Jim_GetCallFrameByLevel(interp, NULL,
10739 &targetCallFrame, NULL) != JIM_OK)
10742 /* Check for arity */
10743 if (argc < 3 || ((argc-1)%2) != 0) {
10744 Jim_WrongNumArgs(interp, 1, argv, "?level? otherVar localVar ?otherVar localVar ...?");
10747 /* Now... for every other/local couple: */
10748 for (i = 1; i < argc; i += 2) {
10749 if (Jim_SetVariableLink(interp, argv[i+1], argv[i],
10750 targetCallFrame) != JIM_OK) return JIM_ERR;
10756 static int Jim_GlobalCoreCommand(Jim_Interp *interp, int argc,
10757 Jim_Obj *const *argv)
10762 Jim_WrongNumArgs(interp, 1, argv, "varName ?varName ...?");
10765 /* Link every var to the toplevel having the same name */
10766 if (interp->numLevels == 0) return JIM_OK; /* global at toplevel... */
10767 for (i = 1; i < argc; i++) {
10768 if (Jim_SetVariableLink(interp, argv[i], argv[i],
10769 interp->topFramePtr) != JIM_OK) return JIM_ERR;
10774 /* does the [string map] operation. On error NULL is returned,
10775 * otherwise a new string object with the result, having refcount = 0,
10777 static Jim_Obj *JimStringMap(Jim_Interp *interp, Jim_Obj *mapListObjPtr,
10778 Jim_Obj *objPtr, int nocase)
10781 const char **key, *str, *noMatchStart = NULL;
10783 int *keyLen, strLen, i;
10784 Jim_Obj *resultObjPtr;
10786 Jim_ListLength(interp, mapListObjPtr, &numMaps);
10788 Jim_SetResultString(interp,
10789 "list must contain an even number of elements", -1);
10792 /* Initialization */
10794 key = Jim_Alloc(sizeof(char*)*numMaps);
10795 keyLen = Jim_Alloc(sizeof(int)*numMaps);
10796 value = Jim_Alloc(sizeof(Jim_Obj*)*numMaps);
10797 resultObjPtr = Jim_NewStringObj(interp, "", 0);
10798 for (i = 0; i < numMaps; i++) {
10799 Jim_Obj *eleObjPtr;
10801 Jim_ListIndex(interp, mapListObjPtr, i*2, &eleObjPtr, JIM_NONE);
10802 key[i] = Jim_GetString(eleObjPtr, &keyLen[i]);
10803 Jim_ListIndex(interp, mapListObjPtr, i*2+1, &eleObjPtr, JIM_NONE);
10804 value[i] = eleObjPtr;
10806 str = Jim_GetString(objPtr, &strLen);
10809 for (i = 0; i < numMaps; i++) {
10810 if (strLen >= keyLen[i] && keyLen[i]) {
10811 if (!JimStringCompare(str, keyLen[i], key[i], keyLen[i],
10814 if (noMatchStart) {
10815 Jim_AppendString(interp, resultObjPtr,
10816 noMatchStart, str-noMatchStart);
10817 noMatchStart = NULL;
10819 Jim_AppendObj(interp, resultObjPtr, value[i]);
10821 strLen -= keyLen[i];
10826 if (i == numMaps) { /* no match */
10827 if (noMatchStart == NULL)
10828 noMatchStart = str;
10833 if (noMatchStart) {
10834 Jim_AppendString(interp, resultObjPtr,
10835 noMatchStart, str-noMatchStart);
10837 Jim_Free((void*)key);
10840 return resultObjPtr;
10844 static int Jim_StringCoreCommand(Jim_Interp *interp, int argc,
10845 Jim_Obj *const *argv)
10848 const char *options[] = {
10849 "length", "compare", "match", "equal", "range", "map", "repeat",
10850 "index", "first", "tolower", "toupper", NULL
10853 OPT_LENGTH, OPT_COMPARE, OPT_MATCH, OPT_EQUAL, OPT_RANGE,
10854 OPT_MAP, OPT_REPEAT, OPT_INDEX, OPT_FIRST, OPT_TOLOWER, OPT_TOUPPER
10858 Jim_WrongNumArgs(interp, 1, argv, "option ?arguments ...?");
10861 if (Jim_GetEnum(interp, argv[1], options, &option, "option",
10862 JIM_ERRMSG) != JIM_OK)
10865 if (option == OPT_LENGTH) {
10869 Jim_WrongNumArgs(interp, 2, argv, "string");
10872 Jim_GetString(argv[2], &len);
10873 Jim_SetResult(interp, Jim_NewIntObj(interp, len));
10875 } else if (option == OPT_COMPARE) {
10877 if ((argc != 4 && argc != 5) ||
10878 (argc == 5 && Jim_CompareStringImmediate(interp,
10879 argv[2], "-nocase") == 0)) {
10880 Jim_WrongNumArgs(interp, 2, argv, "string1 string2");
10887 Jim_SetResult(interp, Jim_NewIntObj(interp,
10888 Jim_StringCompareObj(argv[2],
10889 argv[3], nocase)));
10891 } else if (option == OPT_MATCH) {
10893 if ((argc != 4 && argc != 5) ||
10894 (argc == 5 && Jim_CompareStringImmediate(interp,
10895 argv[2], "-nocase") == 0)) {
10896 Jim_WrongNumArgs(interp, 2, argv, "?-nocase? pattern "
10904 Jim_SetResult(interp,
10905 Jim_NewIntObj(interp, Jim_StringMatchObj(argv[2],
10906 argv[3], nocase)));
10908 } else if (option == OPT_EQUAL) {
10910 Jim_WrongNumArgs(interp, 2, argv, "string1 string2");
10913 Jim_SetResult(interp,
10914 Jim_NewIntObj(interp, Jim_StringEqObj(argv[2],
10917 } else if (option == OPT_RANGE) {
10921 Jim_WrongNumArgs(interp, 2, argv, "string first last");
10924 objPtr = Jim_StringRangeObj(interp, argv[2], argv[3], argv[4]);
10925 if (objPtr == NULL)
10927 Jim_SetResult(interp, objPtr);
10929 } else if (option == OPT_MAP) {
10933 if ((argc != 4 && argc != 5) ||
10934 (argc == 5 && Jim_CompareStringImmediate(interp,
10935 argv[2], "-nocase") == 0)) {
10936 Jim_WrongNumArgs(interp, 2, argv, "?-nocase? mapList "
10944 objPtr = JimStringMap(interp, argv[2], argv[3], nocase);
10945 if (objPtr == NULL)
10947 Jim_SetResult(interp, objPtr);
10949 } else if (option == OPT_REPEAT) {
10954 Jim_WrongNumArgs(interp, 2, argv, "string count");
10957 if (Jim_GetWide(interp, argv[3], &count) != JIM_OK)
10959 objPtr = Jim_NewStringObj(interp, "", 0);
10961 Jim_AppendObj(interp, objPtr, argv[2]);
10963 Jim_SetResult(interp, objPtr);
10965 } else if (option == OPT_INDEX) {
10970 Jim_WrongNumArgs(interp, 2, argv, "string index");
10973 if (Jim_GetIndex(interp, argv[3], &index) != JIM_OK)
10975 str = Jim_GetString(argv[2], &len);
10976 if (index != INT_MIN && index != INT_MAX)
10977 index = JimRelToAbsIndex(len, index);
10978 if (index < 0 || index >= len) {
10979 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
10982 Jim_SetResult(interp, Jim_NewStringObj(interp, str+index, 1));
10985 } else if (option == OPT_FIRST) {
10986 int index = 0, l1, l2;
10987 const char *s1, *s2;
10989 if (argc != 4 && argc != 5) {
10990 Jim_WrongNumArgs(interp, 2, argv, "subString string ?startIndex?");
10993 s1 = Jim_GetString(argv[2], &l1);
10994 s2 = Jim_GetString(argv[3], &l2);
10996 if (Jim_GetIndex(interp, argv[4], &index) != JIM_OK)
10998 index = JimRelToAbsIndex(l2, index);
11000 Jim_SetResult(interp, Jim_NewIntObj(interp,
11001 JimStringFirst(s1, l1, s2, l2, index)));
11003 } else if (option == OPT_TOLOWER) {
11005 Jim_WrongNumArgs(interp, 2, argv, "string");
11008 Jim_SetResult(interp, JimStringToLower(interp, argv[2]));
11009 } else if (option == OPT_TOUPPER) {
11011 Jim_WrongNumArgs(interp, 2, argv, "string");
11014 Jim_SetResult(interp, JimStringToUpper(interp, argv[2]));
11020 static int Jim_TimeCoreCommand(Jim_Interp *interp, int argc,
11021 Jim_Obj *const *argv)
11024 jim_wide start, elapsed;
11026 const char *fmt = "%" JIM_WIDE_MODIFIER " microseconds per iteration";
11029 Jim_WrongNumArgs(interp, 1, argv, "script ?count?");
11033 if (Jim_GetLong(interp, argv[2], &count) != JIM_OK)
11039 start = JimClock();
11043 if ((retval = Jim_EvalObj(interp, argv[1])) != JIM_OK)
11046 elapsed = JimClock() - start;
11047 sprintf(buf, fmt, elapsed/count);
11048 Jim_SetResultString(interp, buf, -1);
11053 static int Jim_ExitCoreCommand(Jim_Interp *interp, int argc,
11054 Jim_Obj *const *argv)
11059 Jim_WrongNumArgs(interp, 1, argv, "?exitCode?");
11063 if (Jim_GetLong(interp, argv[1], &exitCode) != JIM_OK)
11066 interp->exitCode = exitCode;
11071 static int Jim_CatchCoreCommand(Jim_Interp *interp, int argc,
11072 Jim_Obj *const *argv)
11076 if (argc != 2 && argc != 3) {
11077 Jim_WrongNumArgs(interp, 1, argv, "script ?varName?");
11080 exitCode = Jim_EvalObj(interp, argv[1]);
11082 if (Jim_SetVariable(interp, argv[2], Jim_GetResult(interp))
11086 Jim_SetResult(interp, Jim_NewIntObj(interp, exitCode));
11091 static int Jim_RefCoreCommand(Jim_Interp *interp, int argc,
11092 Jim_Obj *const *argv)
11094 if (argc != 3 && argc != 4) {
11095 Jim_WrongNumArgs(interp, 1, argv, "string tag ?finalizer?");
11099 Jim_SetResult(interp, Jim_NewReference(interp, argv[1], argv[2], NULL));
11101 Jim_SetResult(interp, Jim_NewReference(interp, argv[1], argv[2],
11108 static int Jim_GetrefCoreCommand(Jim_Interp *interp, int argc,
11109 Jim_Obj *const *argv)
11111 Jim_Reference *refPtr;
11114 Jim_WrongNumArgs(interp, 1, argv, "reference");
11117 if ((refPtr = Jim_GetReference(interp, argv[1])) == NULL)
11119 Jim_SetResult(interp, refPtr->objPtr);
11124 static int Jim_SetrefCoreCommand(Jim_Interp *interp, int argc,
11125 Jim_Obj *const *argv)
11127 Jim_Reference *refPtr;
11130 Jim_WrongNumArgs(interp, 1, argv, "reference newValue");
11133 if ((refPtr = Jim_GetReference(interp, argv[1])) == NULL)
11135 Jim_IncrRefCount(argv[2]);
11136 Jim_DecrRefCount(interp, refPtr->objPtr);
11137 refPtr->objPtr = argv[2];
11138 Jim_SetResult(interp, argv[2]);
11143 static int Jim_CollectCoreCommand(Jim_Interp *interp, int argc,
11144 Jim_Obj *const *argv)
11147 Jim_WrongNumArgs(interp, 1, argv, "");
11150 Jim_SetResult(interp, Jim_NewIntObj(interp, Jim_Collect(interp)));
11154 /* [finalize] reference ?newValue? */
11155 static int Jim_FinalizeCoreCommand(Jim_Interp *interp, int argc,
11156 Jim_Obj *const *argv)
11158 if (argc != 2 && argc != 3) {
11159 Jim_WrongNumArgs(interp, 1, argv, "reference ?finalizerProc?");
11163 Jim_Obj *cmdNamePtr;
11165 if (Jim_GetFinalizer(interp, argv[1], &cmdNamePtr) != JIM_OK)
11167 if (cmdNamePtr != NULL) /* otherwise the null string is returned. */
11168 Jim_SetResult(interp, cmdNamePtr);
11170 if (Jim_SetFinalizer(interp, argv[1], argv[2]) != JIM_OK)
11172 Jim_SetResult(interp, argv[2]);
11178 /* [info references] (list of all the references/finalizers) */
11181 static int Jim_RenameCoreCommand(Jim_Interp *interp, int argc,
11182 Jim_Obj *const *argv)
11184 const char *oldName, *newName;
11187 Jim_WrongNumArgs(interp, 1, argv, "oldName newName");
11190 oldName = Jim_GetString(argv[1], NULL);
11191 newName = Jim_GetString(argv[2], NULL);
11192 if (Jim_RenameCommand(interp, oldName, newName) != JIM_OK) {
11193 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
11194 Jim_AppendStrings(interp, Jim_GetResult(interp),
11195 "can't rename \"", oldName, "\": ",
11196 "command doesn't exist", NULL);
11203 static int Jim_DictCoreCommand(Jim_Interp *interp, int argc,
11204 Jim_Obj *const *argv)
11207 const char *options[] = {
11208 "create", "get", "set", "unset", "exists", NULL
11211 OPT_CREATE, OPT_GET, OPT_SET, OPT_UNSET, OPT_EXIST
11215 Jim_WrongNumArgs(interp, 1, argv, "option ?arguments ...?");
11219 if (Jim_GetEnum(interp, argv[1], options, &option, "option",
11220 JIM_ERRMSG) != JIM_OK)
11223 if (option == OPT_CREATE) {
11227 Jim_WrongNumArgs(interp, 2, argv, "?key value ...?");
11230 objPtr = Jim_NewDictObj(interp, argv+2, argc-2);
11231 Jim_SetResult(interp, objPtr);
11233 } else if (option == OPT_GET) {
11236 if (Jim_DictKeysVector(interp, argv[2], argv+3, argc-3, &objPtr,
11237 JIM_ERRMSG) != JIM_OK)
11239 Jim_SetResult(interp, objPtr);
11241 } else if (option == OPT_SET) {
11243 Jim_WrongNumArgs(interp, 2, argv, "varName key ?key ...? value");
11246 return Jim_SetDictKeysVector(interp, argv[2], argv+3, argc-4,
11248 } else if (option == OPT_UNSET) {
11250 Jim_WrongNumArgs(interp, 2, argv, "varName key ?key ...?");
11253 return Jim_SetDictKeysVector(interp, argv[2], argv+3, argc-3,
11255 } else if (option == OPT_EXIST) {
11259 if (Jim_DictKeysVector(interp, argv[2], argv+3, argc-3, &objPtr,
11260 JIM_ERRMSG) == JIM_OK)
11264 Jim_SetResult(interp, Jim_NewIntObj(interp, exists));
11267 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
11268 Jim_AppendStrings(interp, Jim_GetResult(interp),
11269 "bad option \"", Jim_GetString(argv[1], NULL), "\":",
11270 " must be create, get, set", NULL);
11277 static int Jim_LoadCoreCommand(Jim_Interp *interp, int argc,
11278 Jim_Obj *const *argv)
11281 Jim_WrongNumArgs(interp, 1, argv, "libaryFile");
11284 return Jim_LoadLibrary(interp, Jim_GetString(argv[1], NULL));
11288 static int Jim_SubstCoreCommand(Jim_Interp *interp, int argc,
11289 Jim_Obj *const *argv)
11295 Jim_WrongNumArgs(interp, 1, argv,
11296 "?-nobackslashes? ?-nocommands? ?-novariables? string");
11301 if (Jim_CompareStringImmediate(interp, argv[i+1],
11303 flags |= JIM_SUBST_NOESC;
11304 else if (Jim_CompareStringImmediate(interp, argv[i+1],
11306 flags |= JIM_SUBST_NOVAR;
11307 else if (Jim_CompareStringImmediate(interp, argv[i+1],
11309 flags |= JIM_SUBST_NOCMD;
11311 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
11312 Jim_AppendStrings(interp, Jim_GetResult(interp),
11313 "bad option \"", Jim_GetString(argv[i+1], NULL),
11314 "\": must be -nobackslashes, -nocommands, or "
11315 "-novariables", NULL);
11319 if (Jim_SubstObj(interp, argv[argc-1], &objPtr, flags) != JIM_OK)
11321 Jim_SetResult(interp, objPtr);
11326 static int Jim_InfoCoreCommand(Jim_Interp *interp, int argc,
11327 Jim_Obj *const *argv)
11329 int cmd, result = JIM_OK;
11330 static const char *commands[] = {
11331 "body", "commands", "exists", "globals", "level", "locals",
11332 "vars", "version", "complete", "args", NULL
11334 enum {INFO_BODY, INFO_COMMANDS, INFO_EXISTS, INFO_GLOBALS, INFO_LEVEL,
11335 INFO_LOCALS, INFO_VARS, INFO_VERSION, INFO_COMPLETE, INFO_ARGS};
11338 Jim_WrongNumArgs(interp, 1, argv, "command ?args ...?");
11341 if (Jim_GetEnum(interp, argv[1], commands, &cmd, "command", JIM_ERRMSG)
11346 if (cmd == INFO_COMMANDS) {
11347 if (argc != 2 && argc != 3) {
11348 Jim_WrongNumArgs(interp, 2, argv, "?pattern?");
11352 Jim_SetResult(interp,JimCommandsList(interp, argv[2]));
11354 Jim_SetResult(interp, JimCommandsList(interp, NULL));
11355 } else if (cmd == INFO_EXISTS) {
11358 Jim_WrongNumArgs(interp, 2, argv, "varName");
11361 exists = Jim_GetVariable(interp, argv[2], 0);
11362 Jim_SetResult(interp, Jim_NewIntObj(interp, exists != 0));
11363 } else if (cmd == INFO_GLOBALS || cmd == INFO_LOCALS || cmd == INFO_VARS) {
11366 case INFO_GLOBALS: mode = JIM_VARLIST_GLOBALS; break;
11367 case INFO_LOCALS: mode = JIM_VARLIST_LOCALS; break;
11368 case INFO_VARS: mode = JIM_VARLIST_VARS; break;
11369 default: mode = 0; /* avoid warning */; break;
11371 if (argc != 2 && argc != 3) {
11372 Jim_WrongNumArgs(interp, 2, argv, "?pattern?");
11376 Jim_SetResult(interp,JimVariablesList(interp, argv[2], mode));
11378 Jim_SetResult(interp, JimVariablesList(interp, NULL, mode));
11379 } else if (cmd == INFO_LEVEL) {
11383 Jim_SetResult(interp,
11384 Jim_NewIntObj(interp, interp->numLevels));
11387 if (JimInfoLevel(interp, argv[2], &objPtr) != JIM_OK)
11389 Jim_SetResult(interp, objPtr);
11392 Jim_WrongNumArgs(interp, 2, argv, "?levelNum?");
11395 } else if (cmd == INFO_BODY || cmd == INFO_ARGS) {
11399 Jim_WrongNumArgs(interp, 2, argv, "procname");
11402 if ((cmdPtr = Jim_GetCommand(interp, argv[2], JIM_ERRMSG)) == NULL)
11404 if (cmdPtr->cmdProc != NULL) {
11405 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
11406 Jim_AppendStrings(interp, Jim_GetResult(interp),
11407 "command \"", Jim_GetString(argv[2], NULL),
11408 "\" is not a procedure", NULL);
11411 if (cmd == INFO_BODY)
11412 Jim_SetResult(interp, cmdPtr->bodyObjPtr);
11414 Jim_SetResult(interp, cmdPtr->argListObjPtr);
11415 } else if (cmd == INFO_VERSION) {
11416 char buf[(JIM_INTEGER_SPACE * 2) + 1];
11417 sprintf(buf, "%d.%d",
11418 JIM_VERSION / 100, JIM_VERSION % 100);
11419 Jim_SetResultString(interp, buf, -1);
11420 } else if (cmd == INFO_COMPLETE) {
11425 Jim_WrongNumArgs(interp, 2, argv, "script");
11428 s = Jim_GetString(argv[2], &len);
11429 Jim_SetResult(interp,
11430 Jim_NewIntObj(interp, Jim_ScriptIsComplete(s, len, NULL)));
11436 static int Jim_SplitCoreCommand(Jim_Interp *interp, int argc,
11437 Jim_Obj *const *argv)
11439 const char *str, *splitChars, *noMatchStart;
11440 int splitLen, strLen, i;
11441 Jim_Obj *resObjPtr;
11443 if (argc != 2 && argc != 3) {
11444 Jim_WrongNumArgs(interp, 1, argv, "string ?splitChars?");
11449 splitChars = " \n\t\r";
11452 splitChars = Jim_GetString(argv[2], &splitLen);
11454 str = Jim_GetString(argv[1], &strLen);
11455 if (!strLen) return JIM_OK;
11456 noMatchStart = str;
11457 resObjPtr = Jim_NewListObj(interp, NULL, 0);
11461 for (i = 0; i < splitLen; i++) {
11462 if (*str == splitChars[i]) {
11465 objPtr = Jim_NewStringObj(interp, noMatchStart,
11466 (str-noMatchStart));
11467 Jim_ListAppendElement(interp, resObjPtr, objPtr);
11468 noMatchStart = str+1;
11475 Jim_ListAppendElement(interp, resObjPtr,
11476 Jim_NewStringObj(interp, noMatchStart, (str-noMatchStart)));
11478 /* This handles the special case of splitchars eq {}. This
11479 * is trivial but we want to perform object sharing as Tcl does. */
11480 Jim_Obj *objCache[256];
11481 const unsigned char *u = (unsigned char*) str;
11482 memset(objCache, 0, sizeof(objCache));
11483 for (i = 0; i < strLen; i++) {
11486 if (objCache[c] == NULL)
11487 objCache[c] = Jim_NewStringObj(interp, (char*)u+i, 1);
11488 Jim_ListAppendElement(interp, resObjPtr, objCache[c]);
11491 Jim_SetResult(interp, resObjPtr);
11496 static int Jim_JoinCoreCommand(Jim_Interp *interp, int argc,
11497 Jim_Obj *const *argv)
11499 const char *joinStr;
11500 int joinStrLen, i, listLen;
11501 Jim_Obj *resObjPtr;
11503 if (argc != 2 && argc != 3) {
11504 Jim_WrongNumArgs(interp, 1, argv, "list ?joinString?");
11512 joinStr = Jim_GetString(argv[2], &joinStrLen);
11514 Jim_ListLength(interp, argv[1], &listLen);
11515 resObjPtr = Jim_NewStringObj(interp, NULL, 0);
11517 for (i = 0; i < listLen; i++) {
11520 Jim_ListIndex(interp, argv[1], i, &objPtr, JIM_NONE);
11521 Jim_AppendObj(interp, resObjPtr, objPtr);
11522 if (i+1 != listLen) {
11523 Jim_AppendString(interp, resObjPtr, joinStr, joinStrLen);
11526 Jim_SetResult(interp, resObjPtr);
11531 static int Jim_FormatCoreCommand(Jim_Interp *interp, int argc,
11532 Jim_Obj *const *argv)
11537 Jim_WrongNumArgs(interp, 1, argv, "formatString ?arg arg ...?");
11540 objPtr = Jim_FormatString(interp, argv[1], argc-2, argv+2);
11541 if (objPtr == NULL)
11543 Jim_SetResult(interp, objPtr);
11548 static int Jim_ScanCoreCommand(Jim_Interp *interp, int argc,
11549 Jim_Obj *const *argv)
11551 Jim_Obj *listPtr, **outVec;
11552 int outc, i, count = 0;
11555 Jim_WrongNumArgs(interp, 1, argv, "string formatString ?varName ...?");
11558 if (argv[2]->typePtr != &scanFmtStringObjType)
11559 SetScanFmtFromAny(interp, argv[2]);
11560 if (FormatGetError(argv[2]) != 0) {
11561 Jim_SetResultString(interp, FormatGetError(argv[2]), -1);
11565 int maxPos = FormatGetMaxPos(argv[2]);
11566 int count = FormatGetCnvCount(argv[2]);
11567 if (maxPos > argc-3) {
11568 Jim_SetResultString(interp, "\"%n$\" argument index out of range", -1);
11570 } else if (count != 0 && count < argc-3) {
11571 Jim_SetResultString(interp, "variable is not assigned by any "
11572 "conversion specifiers", -1);
11574 } else if (count > argc-3) {
11575 Jim_SetResultString(interp, "different numbers of variable names and "
11576 "field specifiers", -1);
11580 listPtr = Jim_ScanString(interp, argv[1], argv[2], JIM_ERRMSG);
11585 if (listPtr != 0 && listPtr != (Jim_Obj*)EOF)
11586 Jim_ListLength(interp, listPtr, &len);
11587 if (listPtr == (Jim_Obj*)EOF || len == 0) { // XXX
11588 Jim_SetResult(interp, Jim_NewIntObj(interp, -1));
11591 JimListGetElements(interp, listPtr, &outc, &outVec);
11592 for (i = 0; i < outc; ++i) {
11593 if (Jim_Length(outVec[i]) > 0) {
11595 if (Jim_SetVariable(interp, argv[3+i], outVec[i]) != JIM_OK)
11599 Jim_FreeNewObj(interp, listPtr);
11600 Jim_SetResult(interp, Jim_NewIntObj(interp, count));
11602 if (listPtr == (Jim_Obj*)EOF) {
11603 Jim_SetResult(interp, Jim_NewListObj(interp, 0, 0));
11606 Jim_SetResult(interp, listPtr);
11610 Jim_FreeNewObj(interp, listPtr);
11615 static int Jim_ErrorCoreCommand(Jim_Interp *interp, int argc,
11616 Jim_Obj *const *argv)
11619 Jim_WrongNumArgs(interp, 1, argv, "message");
11622 Jim_SetResult(interp, argv[1]);
11627 static int Jim_LrangeCoreCommand(Jim_Interp *interp, int argc,
11628 Jim_Obj *const *argv)
11633 Jim_WrongNumArgs(interp, 1, argv, "list first last");
11636 if ((objPtr = Jim_ListRange(interp, argv[1], argv[2], argv[3])) == NULL)
11638 Jim_SetResult(interp, objPtr);
11643 static int Jim_EnvCoreCommand(Jim_Interp *interp, int argc,
11644 Jim_Obj *const *argv)
11650 Jim_WrongNumArgs(interp, 1, argv, "varName");
11653 key = Jim_GetString(argv[1], NULL);
11656 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
11657 Jim_AppendStrings(interp, Jim_GetResult(interp),
11658 "environment variable \"",
11659 key, "\" does not exist", NULL);
11662 Jim_SetResult(interp, Jim_NewStringObj(interp, val, -1));
11667 static int Jim_SourceCoreCommand(Jim_Interp *interp, int argc,
11668 Jim_Obj *const *argv)
11673 Jim_WrongNumArgs(interp, 1, argv, "fileName");
11676 retval = Jim_EvalFile(interp, Jim_GetString(argv[1], NULL));
11677 if (retval == JIM_RETURN)
11683 static int Jim_LreverseCoreCommand(Jim_Interp *interp, int argc,
11684 Jim_Obj *const *argv)
11686 Jim_Obj *revObjPtr, **ele;
11690 Jim_WrongNumArgs(interp, 1, argv, "list");
11693 JimListGetElements(interp, argv[1], &len, &ele);
11695 revObjPtr = Jim_NewListObj(interp, NULL, 0);
11697 ListAppendElement(revObjPtr, ele[len--]);
11698 Jim_SetResult(interp, revObjPtr);
11702 static int JimRangeLen(jim_wide start, jim_wide end, jim_wide step)
11706 if (step == 0) return -1;
11707 if (start == end) return 0;
11708 else if (step > 0 && start > end) return -1;
11709 else if (step < 0 && end > start) return -1;
11711 if (len < 0) len = -len; /* abs(len) */
11712 if (step < 0) step = -step; /* abs(step) */
11713 len = 1 + ((len-1)/step);
11714 /* We can truncate safely to INT_MAX, the range command
11715 * will always return an error for a such long range
11716 * because Tcl lists can't be so long. */
11717 if (len > INT_MAX) len = INT_MAX;
11718 return (int)((len < 0) ? -1 : len);
11722 static int Jim_RangeCoreCommand(Jim_Interp *interp, int argc,
11723 Jim_Obj *const *argv)
11725 jim_wide start = 0, end, step = 1;
11729 if (argc < 2 || argc > 4) {
11730 Jim_WrongNumArgs(interp, 1, argv, "?start? end ?step?");
11734 if (Jim_GetWide(interp, argv[1], &end) != JIM_OK)
11737 if (Jim_GetWide(interp, argv[1], &start) != JIM_OK ||
11738 Jim_GetWide(interp, argv[2], &end) != JIM_OK)
11740 if (argc == 4 && Jim_GetWide(interp, argv[3], &step) != JIM_OK)
11743 if ((len = JimRangeLen(start, end, step)) == -1) {
11744 Jim_SetResultString(interp, "Invalid (infinite?) range specified", -1);
11747 objPtr = Jim_NewListObj(interp, NULL, 0);
11748 for (i = 0; i < len; i++)
11749 ListAppendElement(objPtr, Jim_NewIntObj(interp, start+i*step));
11750 Jim_SetResult(interp, objPtr);
11755 static int Jim_RandCoreCommand(Jim_Interp *interp, int argc,
11756 Jim_Obj *const *argv)
11758 jim_wide min = 0, max, len, maxMul;
11760 if (argc < 1 || argc > 3) {
11761 Jim_WrongNumArgs(interp, 1, argv, "?min? max");
11765 max = JIM_WIDE_MAX;
11766 } else if (argc == 2) {
11767 if (Jim_GetWide(interp, argv[1], &max) != JIM_OK)
11769 } else if (argc == 3) {
11770 if (Jim_GetWide(interp, argv[1], &min) != JIM_OK ||
11771 Jim_GetWide(interp, argv[2], &max) != JIM_OK)
11776 Jim_SetResultString(interp, "Invalid arguments (max < min)", -1);
11779 maxMul = JIM_WIDE_MAX - (len ? (JIM_WIDE_MAX%len) : 0);
11783 JimRandomBytes(interp, &r, sizeof(jim_wide));
11784 if (r < 0 || r >= maxMul) continue;
11785 r = (len == 0) ? 0 : r%len;
11786 Jim_SetResult(interp, Jim_NewIntObj(interp, min+r));
11792 static int Jim_PackageCoreCommand(Jim_Interp *interp, int argc,
11793 Jim_Obj *const *argv)
11796 const char *options[] = {
11797 "require", "provide", NULL
11799 enum {OPT_REQUIRE, OPT_PROVIDE};
11802 Jim_WrongNumArgs(interp, 1, argv, "option ?arguments ...?");
11805 if (Jim_GetEnum(interp, argv[1], options, &option, "option",
11806 JIM_ERRMSG) != JIM_OK)
11809 if (option == OPT_REQUIRE) {
11813 if (Jim_CompareStringImmediate(interp, argv[2], "-exact")) {
11818 if (argc != 3 && argc != 4) {
11819 Jim_WrongNumArgs(interp, 2, argv, "?-exact? package ?version?");
11822 ver = Jim_PackageRequire(interp, Jim_GetString(argv[2], NULL),
11823 argc == 4 ? Jim_GetString(argv[3], NULL) : "",
11827 Jim_SetResultString(interp, ver, -1);
11828 } else if (option == OPT_PROVIDE) {
11830 Jim_WrongNumArgs(interp, 2, argv, "package version");
11833 return Jim_PackageProvide(interp, Jim_GetString(argv[2], NULL),
11834 Jim_GetString(argv[3], NULL), JIM_ERRMSG);
11841 Jim_CmdProc cmdProc;
11842 } Jim_CoreCommandsTable[] = {
11843 {"set", Jim_SetCoreCommand},
11844 {"unset", Jim_UnsetCoreCommand},
11845 {"puts", Jim_PutsCoreCommand},
11846 {"+", Jim_AddCoreCommand},
11847 {"*", Jim_MulCoreCommand},
11848 {"-", Jim_SubCoreCommand},
11849 {"/", Jim_DivCoreCommand},
11850 {"incr", Jim_IncrCoreCommand},
11851 {"while", Jim_WhileCoreCommand},
11852 {"for", Jim_ForCoreCommand},
11853 {"foreach", Jim_ForeachCoreCommand},
11854 {"lmap", Jim_LmapCoreCommand},
11855 {"if", Jim_IfCoreCommand},
11856 {"switch", Jim_SwitchCoreCommand},
11857 {"list", Jim_ListCoreCommand},
11858 {"lindex", Jim_LindexCoreCommand},
11859 {"lset", Jim_LsetCoreCommand},
11860 {"llength", Jim_LlengthCoreCommand},
11861 {"lappend", Jim_LappendCoreCommand},
11862 {"linsert", Jim_LinsertCoreCommand},
11863 {"lsort", Jim_LsortCoreCommand},
11864 {"append", Jim_AppendCoreCommand},
11865 {"debug", Jim_DebugCoreCommand},
11866 {"eval", Jim_EvalCoreCommand},
11867 {"uplevel", Jim_UplevelCoreCommand},
11868 {"expr", Jim_ExprCoreCommand},
11869 {"break", Jim_BreakCoreCommand},
11870 {"continue", Jim_ContinueCoreCommand},
11871 {"proc", Jim_ProcCoreCommand},
11872 {"concat", Jim_ConcatCoreCommand},
11873 {"return", Jim_ReturnCoreCommand},
11874 {"upvar", Jim_UpvarCoreCommand},
11875 {"global", Jim_GlobalCoreCommand},
11876 {"string", Jim_StringCoreCommand},
11877 {"time", Jim_TimeCoreCommand},
11878 {"exit", Jim_ExitCoreCommand},
11879 {"catch", Jim_CatchCoreCommand},
11880 {"ref", Jim_RefCoreCommand},
11881 {"getref", Jim_GetrefCoreCommand},
11882 {"setref", Jim_SetrefCoreCommand},
11883 {"finalize", Jim_FinalizeCoreCommand},
11884 {"collect", Jim_CollectCoreCommand},
11885 {"rename", Jim_RenameCoreCommand},
11886 {"dict", Jim_DictCoreCommand},
11887 {"load", Jim_LoadCoreCommand},
11888 {"subst", Jim_SubstCoreCommand},
11889 {"info", Jim_InfoCoreCommand},
11890 {"split", Jim_SplitCoreCommand},
11891 {"join", Jim_JoinCoreCommand},
11892 {"format", Jim_FormatCoreCommand},
11893 {"scan", Jim_ScanCoreCommand},
11894 {"error", Jim_ErrorCoreCommand},
11895 {"lrange", Jim_LrangeCoreCommand},
11896 {"env", Jim_EnvCoreCommand},
11897 {"source", Jim_SourceCoreCommand},
11898 {"lreverse", Jim_LreverseCoreCommand},
11899 {"range", Jim_RangeCoreCommand},
11900 {"rand", Jim_RandCoreCommand},
11901 {"package", Jim_PackageCoreCommand},
11902 {"tailcall", Jim_TailcallCoreCommand},
11906 /* Some Jim core command is actually a procedure written in Jim itself. */
11907 static void Jim_RegisterCoreProcedures(Jim_Interp *interp)
11909 Jim_Eval(interp, (char*)
11910 "proc lambda {arglist args} {\n"
11911 " set name [ref {} function lambdaFinalizer]\n"
11912 " uplevel 1 [list proc $name $arglist {expand}$args]\n"
11915 "proc lambdaFinalizer {name val} {\n"
11916 " rename $name {}\n"
11921 void Jim_RegisterCoreCommands(Jim_Interp *interp)
11925 while(Jim_CoreCommandsTable[i].name != NULL) {
11926 Jim_CreateCommand(interp,
11927 Jim_CoreCommandsTable[i].name,
11928 Jim_CoreCommandsTable[i].cmdProc,
11932 Jim_RegisterCoreProcedures(interp);
11935 /* -----------------------------------------------------------------------------
11936 * Interactive prompt
11937 * ---------------------------------------------------------------------------*/
11938 void Jim_PrintErrorMessage(Jim_Interp *interp)
11942 Jim_fprintf(interp, interp->cookie_stderr, "Runtime error, file \"%s\", line %d:" JIM_NL,
11943 interp->errorFileName, interp->errorLine);
11944 Jim_fprintf(interp,interp->cookie_stderr, " %s" JIM_NL,
11945 Jim_GetString(interp->result, NULL));
11946 Jim_ListLength(interp, interp->stackTrace, &len);
11947 for (i = 0; i < len; i+= 3) {
11949 const char *proc, *file, *line;
11951 Jim_ListIndex(interp, interp->stackTrace, i, &objPtr, JIM_NONE);
11952 proc = Jim_GetString(objPtr, NULL);
11953 Jim_ListIndex(interp, interp->stackTrace, i+1, &objPtr,
11955 file = Jim_GetString(objPtr, NULL);
11956 Jim_ListIndex(interp, interp->stackTrace, i+2, &objPtr,
11958 line = Jim_GetString(objPtr, NULL);
11959 Jim_fprintf( interp, interp->cookie_stderr,
11960 "In procedure '%s' called at file \"%s\", line %s" JIM_NL,
11965 int Jim_InteractivePrompt(Jim_Interp *interp)
11967 int retcode = JIM_OK;
11968 Jim_Obj *scriptObjPtr;
11970 Jim_fprintf(interp,interp->cookie_stdout, "Welcome to Jim version %d.%d, "
11971 "Copyright (c) 2005-8 Salvatore Sanfilippo" JIM_NL,
11972 JIM_VERSION / 100, JIM_VERSION % 100);
11973 Jim_SetVariableStrWithStr(interp, "jim_interactive", "1");
11976 const char *result;
11977 const char *retcodestr[] = {
11978 "ok", "error", "return", "break", "continue", "eval", "exit"
11982 if (retcode != 0) {
11983 if (retcode >= 2 && retcode <= 6)
11984 Jim_fprintf(interp,interp->cookie_stdout, "[%s] . ", retcodestr[retcode]);
11986 Jim_fprintf(interp,interp->cookie_stdout, "[%d] . ", retcode);
11988 Jim_fprintf( interp, interp->cookie_stdout, ". ");
11989 Jim_fflush( interp, interp->cookie_stdout);
11990 scriptObjPtr = Jim_NewStringObj(interp, "", 0);
11991 Jim_IncrRefCount(scriptObjPtr);
11997 if ( Jim_fgets(interp, buf, 1024, interp->cookie_stdin) == NULL) {
11998 Jim_DecrRefCount(interp, scriptObjPtr);
12001 Jim_AppendString(interp, scriptObjPtr, buf, -1);
12002 str = Jim_GetString(scriptObjPtr, &len);
12003 if (Jim_ScriptIsComplete(str, len, &state))
12005 Jim_fprintf( interp, interp->cookie_stdout, "%c> ", state);
12006 Jim_fflush( interp, interp->cookie_stdout);
12008 retcode = Jim_EvalObj(interp, scriptObjPtr);
12009 Jim_DecrRefCount(interp, scriptObjPtr);
12010 result = Jim_GetString(Jim_GetResult(interp), &reslen);
12011 if (retcode == JIM_ERR) {
12012 Jim_PrintErrorMessage(interp);
12013 } else if (retcode == JIM_EXIT) {
12014 exit(Jim_GetExitCode(interp));
12017 Jim_fwrite( interp, result, 1, reslen, interp->cookie_stdout);
12018 Jim_fprintf( interp,interp->cookie_stdout, JIM_NL);
12026 /* -----------------------------------------------------------------------------
12027 * Jim's idea of STDIO..
12028 * ---------------------------------------------------------------------------*/
12031 Jim_fprintf( Jim_Interp *interp, void *cookie, const char *fmt, ... )
12037 r = Jim_vfprintf( interp, cookie, fmt,ap );
12044 Jim_vfprintf( Jim_Interp *interp, void *cookie, const char *fmt, va_list ap )
12046 if( (interp == NULL) || (interp->cb_vfprintf == NULL) ){
12050 return (*(interp->cb_vfprintf))( cookie, fmt, ap );
12054 Jim_fwrite( Jim_Interp *interp, const void *ptr, size_t size, size_t n, void *cookie )
12056 if( (interp == NULL) || (interp->cb_fwrite == NULL) ){
12060 return (*(interp->cb_fwrite))( ptr, size, n, cookie);
12064 Jim_fread( Jim_Interp *interp, void *ptr, size_t size, size_t n, void *cookie )
12066 if( (interp == NULL) || (interp->cb_fread == NULL) ){
12070 return (*(interp->cb_fread))( ptr, size, n, cookie);
12074 Jim_fflush( Jim_Interp *interp, void *cookie )
12076 if( (interp == NULL) || (interp->cb_fflush == NULL) ){
12077 /* pretend all is well */
12080 return (*(interp->cb_fflush))( cookie );
12084 Jim_fgets( Jim_Interp *interp, char *s, int size, void *cookie )
12086 if( (interp == NULL) || (interp->cb_fgets == NULL) ){
12090 return (*(interp->cb_fgets))( s, size, cookie );
12099 * Local Variables: **
12101 * c-basic-offset: 4 **