1 /* Jim - A small embeddable Tcl interpreter
3 * Copyright 2005 Salvatore Sanfilippo <antirez@invece.org>
4 * Copyright 2005 Clemens Hintze <c.hintze@gmx.net>
5 * Copyright 2005 patthoyts - Pat Thoyts <patthoyts@users.sf.net>
6 * Copyright 2008 oharboe - Øyvind Harboe - oyvind.harboe@zylin.com
7 * Copyright 2008 Andrew Lunn <andrew@lunn.ch>
8 * Copyright 2008 Duane Ellis <openocd@duaneellis.com>
9 * Copyright 2008 Uwe Klein <uklein@klein-messgeraete.de>
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 * 2. Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials
22 * provided with the distribution.
24 * THIS SOFTWARE IS PROVIDED BY THE JIM TCL PROJECT ``AS IS'' AND ANY
25 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
26 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
27 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
28 * JIM TCL PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
29 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
30 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
33 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
35 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 * The views and conclusions contained in the software and documentation
38 * are those of the authors and should not be interpreted as representing
39 * official policies, either expressed or implied, of the Jim Tcl Project.
42 #define JIM_OPTIMIZATION /* comment to avoid optimizations and reduce size */
45 #include <pkgconf/jimtcl.h>
48 #define JIM_DYNLIB /* Dynamic library support for UNIX and WIN32 */
49 #endif /* JIM_ANSIC */
61 #include "replacements.h"
63 /* Include the platform dependent libraries for
64 * dynamic loading of libraries. */
66 #if defined(_WIN32) || defined(WIN32)
73 #define WIN32_LEAN_AND_MEAN
76 #pragma warning(disable:4146)
81 #endif /* JIM_DYNLIB */
84 #include <cyg/jimtcl/jim.h>
93 /* -----------------------------------------------------------------------------
95 * ---------------------------------------------------------------------------*/
97 /* A shared empty string for the objects string representation.
98 * Jim_InvalidateStringRep knows about it and don't try to free. */
99 static char *JimEmptyStringRep = (char*) "";
101 /* -----------------------------------------------------------------------------
102 * Required prototypes of not exported functions
103 * ---------------------------------------------------------------------------*/
104 static void JimChangeCallFrameId(Jim_Interp *interp, Jim_CallFrame *cf);
105 static void JimFreeCallFrame(Jim_Interp *interp, Jim_CallFrame *cf, int flags);
106 static void JimRegisterCoreApi(Jim_Interp *interp);
108 static Jim_HashTableType JimVariablesHashTableType;
110 /* -----------------------------------------------------------------------------
112 * ---------------------------------------------------------------------------*/
115 * Convert a string to a jim_wide INTEGER.
116 * This function originates from BSD.
118 * Ignores `locale' stuff. Assumes that the upper and lower case
119 * alphabets and digits are each contiguous.
121 #ifdef HAVE_LONG_LONG
122 #define JimIsAscii(c) (((c) & ~0x7f) == 0)
123 static jim_wide JimStrtoll(const char *nptr, char **endptr, register int base)
125 register const char *s;
126 register unsigned jim_wide acc;
127 register unsigned char c;
128 register unsigned jim_wide qbase, cutoff;
129 register int neg, any, cutlim;
132 * Skip white space and pick up leading +/- sign if any.
133 * If base is 0, allow 0x for hex and 0 for octal, else
134 * assume decimal; if base is already 16, allow 0x.
139 } while (isspace(c));
148 if ((base == 0 || base == 16) &&
149 c == '0' && (*s == 'x' || *s == 'X')) {
155 base = c == '0' ? 8 : 10;
158 * Compute the cutoff value between legal numbers and illegal
159 * numbers. That is the largest legal value, divided by the
160 * base. An input number that is greater than this value, if
161 * followed by a legal input character, is too big. One that
162 * is equal to this value may be valid or not; the limit
163 * between valid and invalid numbers is then based on the last
164 * digit. For instance, if the range for quads is
165 * [-9223372036854775808..9223372036854775807] and the input base
166 * is 10, cutoff will be set to 922337203685477580 and cutlim to
167 * either 7 (neg==0) or 8 (neg==1), meaning that if we have
168 * accumulated a value > 922337203685477580, or equal but the
169 * next digit is > 7 (or 8), the number is too big, and we will
170 * return a range error.
172 * Set any if any `digits' consumed; make it negative to indicate
175 qbase = (unsigned)base;
176 cutoff = neg ? (unsigned jim_wide)-(LLONG_MIN + LLONG_MAX) + LLONG_MAX
178 cutlim = (int)(cutoff % qbase);
180 for (acc = 0, any = 0;; c = *s++) {
186 c -= isupper(c) ? 'A' - 10 : 'a' - 10;
191 if (any < 0 || acc > cutoff || (acc == cutoff && c > cutlim))
200 acc = neg ? LLONG_MIN : LLONG_MAX;
205 *endptr = (char *)(any ? s - 1 : nptr);
210 /* Glob-style pattern matching. */
211 static int JimStringMatch(const char *pattern, int patternLen,
212 const char *string, int stringLen, int nocase)
217 while (pattern[1] == '*') {
222 return 1; /* match */
224 if (JimStringMatch(pattern+1, patternLen-1,
225 string, stringLen, nocase))
226 return 1; /* match */
230 return 0; /* no match */
234 return 0; /* no match */
244 not = pattern[0] == '^';
251 if (pattern[0] == '\\') {
254 if (pattern[0] == string[0])
256 } else if (pattern[0] == ']') {
258 } else if (patternLen == 0) {
262 } else if (pattern[1] == '-' && patternLen >= 3) {
263 int start = pattern[0];
264 int end = pattern[2];
272 start = tolower(start);
278 if (c >= start && c <= end)
282 if (pattern[0] == string[0])
285 if (tolower((int)pattern[0]) == tolower((int)string[0]))
295 return 0; /* no match */
301 if (patternLen >= 2) {
308 if (pattern[0] != string[0])
309 return 0; /* no match */
311 if (tolower((int)pattern[0]) != tolower((int)string[0]))
312 return 0; /* no match */
320 if (stringLen == 0) {
321 while(*pattern == '*') {
328 if (patternLen == 0 && stringLen == 0)
333 int JimStringCompare(const char *s1, int l1, const char *s2, int l2,
336 unsigned char *u1 = (unsigned char*) s1, *u2 = (unsigned char*) s2;
342 u1++; u2++; l1--; l2--;
344 if (!l1 && !l2) return 0;
348 if (tolower((int)*u1) != tolower((int)*u2))
349 return tolower((int)*u1)-tolower((int)*u2);
350 u1++; u2++; l1--; l2--;
352 if (!l1 && !l2) return 0;
357 /* Search 's1' inside 's2', starting to search from char 'index' of 's2'.
358 * The index of the first occurrence of s1 in s2 is returned.
359 * If s1 is not found inside s2, -1 is returned. */
360 int JimStringFirst(const char *s1, int l1, const char *s2, int l2, int index)
364 if (!l1 || !l2 || l1 > l2) return -1;
365 if (index < 0) index = 0;
367 for (i = index; i <= l2-l1; i++) {
368 if (memcmp(s2, s1, l1) == 0)
375 int Jim_WideToString(char *buf, jim_wide wideValue)
377 const char *fmt = "%" JIM_WIDE_MODIFIER;
378 return sprintf(buf, fmt, wideValue);
381 int Jim_StringToWide(const char *str, jim_wide *widePtr, int base)
385 #ifdef HAVE_LONG_LONG
386 *widePtr = JimStrtoll(str, &endptr, base);
388 *widePtr = strtol(str, &endptr, base);
390 if ((str[0] == '\0') || (str == endptr) )
392 if (endptr[0] != '\0') {
394 if (!isspace((int)*endptr))
402 int Jim_StringToIndex(const char *str, int *intPtr)
406 *intPtr = strtol(str, &endptr, 10);
407 if ( (str[0] == '\0') || (str == endptr) )
409 if (endptr[0] != '\0') {
411 if (!isspace((int)*endptr))
419 /* The string representation of references has two features in order
420 * to make the GC faster. The first is that every reference starts
421 * with a non common character '~', in order to make the string matching
422 * fater. The second is that the reference string rep his 32 characters
423 * in length, this allows to avoid to check every object with a string
424 * repr < 32, and usually there are many of this objects. */
426 #define JIM_REFERENCE_SPACE (35+JIM_REFERENCE_TAGLEN)
428 static int JimFormatReference(char *buf, Jim_Reference *refPtr, jim_wide id)
430 const char *fmt = "<reference.<%s>.%020" JIM_WIDE_MODIFIER ">";
431 sprintf(buf, fmt, refPtr->tag, id);
432 return JIM_REFERENCE_SPACE;
435 int Jim_DoubleToString(char *buf, double doubleValue)
440 len = sprintf(buf, "%.17g", doubleValue);
443 if (*s == '.') return len;
446 /* Add a final ".0" if it's a number. But not
448 if (isdigit((int)buf[0])
449 || ((buf[0] == '-' || buf[0] == '+')
450 && isdigit((int)buf[1]))) {
459 int Jim_StringToDouble(const char *str, double *doublePtr)
463 *doublePtr = strtod(str, &endptr);
464 if (str[0] == '\0' || endptr[0] != '\0' || (str == endptr) )
469 static jim_wide JimPowWide(jim_wide b, jim_wide e)
472 if ((b==0 && e!=0) || (e<0)) return 0;
473 for(i=0; i<e; i++) {res *= b;}
477 /* -----------------------------------------------------------------------------
479 * ---------------------------------------------------------------------------*/
481 /* Note that 'interp' may be NULL if not available in the
482 * context of the panic. It's only useful to get the error
483 * file descriptor, it will default to stderr otherwise. */
484 void Jim_Panic(Jim_Interp *interp, const char *fmt, ...)
490 * Send it here first.. Assuming STDIO still works
492 fprintf(stderr, JIM_NL "JIM INTERPRETER PANIC: ");
493 vfprintf(stderr, fmt, ap);
494 fprintf(stderr, JIM_NL JIM_NL);
497 #ifdef HAVE_BACKTRACE
503 size = backtrace(array, 40);
504 strings = backtrace_symbols(array, size);
505 for (i = 0; i < size; i++)
506 fprintf(fp,"[backtrace] %s" JIM_NL, strings[i]);
507 fprintf(fp,"[backtrace] Include the above lines and the output" JIM_NL);
508 fprintf(fp,"[backtrace] of 'nm <executable>' in the bug report." JIM_NL);
512 /* This may actually crash... we do it last */
513 if( interp && interp->cookie_stderr ){
514 Jim_fprintf( interp, interp->cookie_stderr, JIM_NL "JIM INTERPRETER PANIC: ");
515 Jim_vfprintf( interp, interp->cookie_stderr, fmt, ap );
516 Jim_fprintf( interp, interp->cookie_stderr, JIM_NL JIM_NL );
521 /* -----------------------------------------------------------------------------
523 * ---------------------------------------------------------------------------*/
525 /* Macro used for memory debugging.
526 * In order for they to work you have to rename Jim_Alloc into _Jim_Alloc
527 * and similary for Jim_Realloc and Jim_Free */
529 #define Jim_Alloc(s) (printf("%s %d: Jim_Alloc(%d)\n",__FILE__,__LINE__,s),_Jim_Alloc(s))
530 #define Jim_Free(p) (printf("%s %d: Jim_Free(%p)\n",__FILE__,__LINE__,p),_Jim_Free(p))
531 #define Jim_Realloc(p,s) (printf("%s %d: Jim_Realloc(%p,%d)\n",__FILE__,__LINE__,p,s),_Jim_Realloc(p,s))
534 void *Jim_Alloc(int size)
536 /* We allocate zero length arrayes, etc. to use a single orthogonal codepath */
539 void *p = malloc(size);
541 Jim_Panic(NULL,"malloc: Out of memory");
545 void Jim_Free(void *ptr) {
549 void *Jim_Realloc(void *ptr, int size)
551 /* We allocate zero length arrayes, etc. to use a single orthogonal codepath */
554 void *p = realloc(ptr, size);
556 Jim_Panic(NULL,"realloc: Out of memory");
560 char *Jim_StrDup(const char *s)
563 char *copy = Jim_Alloc(l+1);
565 memcpy(copy, s, l+1);
569 char *Jim_StrDupLen(const char *s, int l)
571 char *copy = Jim_Alloc(l+1);
573 memcpy(copy, s, l+1);
574 copy[l] = 0; /* Just to be sure, original could be substring */
578 /* -----------------------------------------------------------------------------
579 * Time related functions
580 * ---------------------------------------------------------------------------*/
581 /* Returns microseconds of CPU used since start. */
582 static jim_wide JimClock(void)
584 #if (defined WIN32) && !(defined JIM_ANSIC)
586 QueryPerformanceFrequency(&f);
587 QueryPerformanceCounter(&t);
588 return (long)((t.QuadPart * 1000000) / f.QuadPart);
590 clock_t clocks = clock();
592 return (long)(clocks*(1000000/CLOCKS_PER_SEC));
596 /* -----------------------------------------------------------------------------
598 * ---------------------------------------------------------------------------*/
600 /* -------------------------- private prototypes ---------------------------- */
601 static int JimExpandHashTableIfNeeded(Jim_HashTable *ht);
602 static unsigned int JimHashTableNextPower(unsigned int size);
603 static int JimInsertHashEntry(Jim_HashTable *ht, const void *key);
605 /* -------------------------- hash functions -------------------------------- */
607 /* Thomas Wang's 32 bit Mix Function */
608 unsigned int Jim_IntHashFunction(unsigned int key)
619 /* Identity hash function for integer keys */
620 unsigned int Jim_IdentityHashFunction(unsigned int key)
625 /* Generic hash function (we are using to multiply by 9 and add the byte
627 unsigned int Jim_GenHashFunction(const unsigned char *buf, int len)
635 /* ----------------------------- API implementation ------------------------- */
636 /* reset an hashtable already initialized with ht_init().
637 * NOTE: This function should only called by ht_destroy(). */
638 static void JimResetHashTable(Jim_HashTable *ht)
647 /* Initialize the hash table */
648 int Jim_InitHashTable(Jim_HashTable *ht, Jim_HashTableType *type,
651 JimResetHashTable(ht);
653 ht->privdata = privDataPtr;
657 /* Resize the table to the minimal size that contains all the elements,
658 * but with the invariant of a USER/BUCKETS ration near to <= 1 */
659 int Jim_ResizeHashTable(Jim_HashTable *ht)
661 int minimal = ht->used;
663 if (minimal < JIM_HT_INITIAL_SIZE)
664 minimal = JIM_HT_INITIAL_SIZE;
665 return Jim_ExpandHashTable(ht, minimal);
668 /* Expand or create the hashtable */
669 int Jim_ExpandHashTable(Jim_HashTable *ht, unsigned int size)
671 Jim_HashTable n; /* the new hashtable */
672 unsigned int realsize = JimHashTableNextPower(size), i;
674 /* the size is invalid if it is smaller than the number of
675 * elements already inside the hashtable */
676 if (ht->used >= size)
679 Jim_InitHashTable(&n, ht->type, ht->privdata);
681 n.sizemask = realsize-1;
682 n.table = Jim_Alloc(realsize*sizeof(Jim_HashEntry*));
684 /* Initialize all the pointers to NULL */
685 memset(n.table, 0, realsize*sizeof(Jim_HashEntry*));
687 /* Copy all the elements from the old to the new table:
688 * note that if the old hash table is empty ht->size is zero,
689 * so Jim_ExpandHashTable just creates an hash table. */
691 for (i = 0; i < ht->size && ht->used > 0; i++) {
692 Jim_HashEntry *he, *nextHe;
694 if (ht->table[i] == NULL) continue;
696 /* For each hash entry on this slot... */
702 /* Get the new element index */
703 h = Jim_HashKey(ht, he->key) & n.sizemask;
704 he->next = n.table[h];
707 /* Pass to the next element */
711 assert(ht->used == 0);
714 /* Remap the new hashtable in the old */
719 /* Add an element to the target hash table */
720 int Jim_AddHashEntry(Jim_HashTable *ht, const void *key, void *val)
723 Jim_HashEntry *entry;
725 /* Get the index of the new element, or -1 if
726 * the element already exists. */
727 if ((index = JimInsertHashEntry(ht, key)) == -1)
730 /* Allocates the memory and stores key */
731 entry = Jim_Alloc(sizeof(*entry));
732 entry->next = ht->table[index];
733 ht->table[index] = entry;
735 /* Set the hash entry fields. */
736 Jim_SetHashKey(ht, entry, key);
737 Jim_SetHashVal(ht, entry, val);
742 /* Add an element, discarding the old if the key already exists */
743 int Jim_ReplaceHashEntry(Jim_HashTable *ht, const void *key, void *val)
745 Jim_HashEntry *entry;
747 /* Try to add the element. If the key
748 * does not exists Jim_AddHashEntry will suceed. */
749 if (Jim_AddHashEntry(ht, key, val) == JIM_OK)
751 /* It already exists, get the entry */
752 entry = Jim_FindHashEntry(ht, key);
753 /* Free the old value and set the new one */
754 Jim_FreeEntryVal(ht, entry);
755 Jim_SetHashVal(ht, entry, val);
759 /* Search and remove an element */
760 int Jim_DeleteHashEntry(Jim_HashTable *ht, const void *key)
763 Jim_HashEntry *he, *prevHe;
767 h = Jim_HashKey(ht, key) & ht->sizemask;
772 if (Jim_CompareHashKeys(ht, key, he->key)) {
773 /* Unlink the element from the list */
775 prevHe->next = he->next;
777 ht->table[h] = he->next;
778 Jim_FreeEntryKey(ht, he);
779 Jim_FreeEntryVal(ht, he);
787 return JIM_ERR; /* not found */
790 /* Destroy an entire hash table */
791 int Jim_FreeHashTable(Jim_HashTable *ht)
795 /* Free all the elements */
796 for (i = 0; i < ht->size && ht->used > 0; i++) {
797 Jim_HashEntry *he, *nextHe;
799 if ((he = ht->table[i]) == NULL) continue;
802 Jim_FreeEntryKey(ht, he);
803 Jim_FreeEntryVal(ht, he);
809 /* Free the table and the allocated cache structure */
811 /* Re-initialize the table */
812 JimResetHashTable(ht);
813 return JIM_OK; /* never fails */
816 Jim_HashEntry *Jim_FindHashEntry(Jim_HashTable *ht, const void *key)
821 if (ht->size == 0) return NULL;
822 h = Jim_HashKey(ht, key) & ht->sizemask;
825 if (Jim_CompareHashKeys(ht, key, he->key))
832 Jim_HashTableIterator *Jim_GetHashTableIterator(Jim_HashTable *ht)
834 Jim_HashTableIterator *iter = Jim_Alloc(sizeof(*iter));
839 iter->nextEntry = NULL;
843 Jim_HashEntry *Jim_NextHashEntry(Jim_HashTableIterator *iter)
846 if (iter->entry == NULL) {
849 (signed)iter->ht->size) break;
850 iter->entry = iter->ht->table[iter->index];
852 iter->entry = iter->nextEntry;
855 /* We need to save the 'next' here, the iterator user
856 * may delete the entry we are returning. */
857 iter->nextEntry = iter->entry->next;
864 /* ------------------------- private functions ------------------------------ */
866 /* Expand the hash table if needed */
867 static int JimExpandHashTableIfNeeded(Jim_HashTable *ht)
869 /* If the hash table is empty expand it to the intial size,
870 * if the table is "full" dobule its size. */
872 return Jim_ExpandHashTable(ht, JIM_HT_INITIAL_SIZE);
873 if (ht->size == ht->used)
874 return Jim_ExpandHashTable(ht, ht->size*2);
878 /* Our hash table capability is a power of two */
879 static unsigned int JimHashTableNextPower(unsigned int size)
881 unsigned int i = JIM_HT_INITIAL_SIZE;
883 if (size >= 2147483648U)
892 /* Returns the index of a free slot that can be populated with
893 * an hash entry for the given 'key'.
894 * If the key already exists, -1 is returned. */
895 static int JimInsertHashEntry(Jim_HashTable *ht, const void *key)
900 /* Expand the hashtable if needed */
901 if (JimExpandHashTableIfNeeded(ht) == JIM_ERR)
903 /* Compute the key hash value */
904 h = Jim_HashKey(ht, key) & ht->sizemask;
905 /* Search if this slot does not already contain the given key */
908 if (Jim_CompareHashKeys(ht, key, he->key))
915 /* ----------------------- StringCopy Hash Table Type ------------------------*/
917 static unsigned int JimStringCopyHTHashFunction(const void *key)
919 return Jim_GenHashFunction(key, strlen(key));
922 static const void *JimStringCopyHTKeyDup(void *privdata, const void *key)
924 int len = strlen(key);
925 char *copy = Jim_Alloc(len+1);
926 JIM_NOTUSED(privdata);
928 memcpy(copy, key, len);
933 static void *JimStringKeyValCopyHTValDup(void *privdata, const void *val)
935 int len = strlen(val);
936 char *copy = Jim_Alloc(len+1);
937 JIM_NOTUSED(privdata);
939 memcpy(copy, val, len);
944 static int JimStringCopyHTKeyCompare(void *privdata, const void *key1,
947 JIM_NOTUSED(privdata);
949 return strcmp(key1, key2) == 0;
952 static void JimStringCopyHTKeyDestructor(void *privdata, const void *key)
954 JIM_NOTUSED(privdata);
956 Jim_Free((void*)key); /* ATTENTION: const cast */
959 static void JimStringKeyValCopyHTValDestructor(void *privdata, void *val)
961 JIM_NOTUSED(privdata);
963 Jim_Free((void*)val); /* ATTENTION: const cast */
966 static Jim_HashTableType JimStringCopyHashTableType = {
967 JimStringCopyHTHashFunction, /* hash function */
968 JimStringCopyHTKeyDup, /* key dup */
970 JimStringCopyHTKeyCompare, /* key compare */
971 JimStringCopyHTKeyDestructor, /* key destructor */
972 NULL /* val destructor */
975 /* This is like StringCopy but does not auto-duplicate the key.
976 * It's used for intepreter's shared strings. */
977 static Jim_HashTableType JimSharedStringsHashTableType = {
978 JimStringCopyHTHashFunction, /* hash function */
981 JimStringCopyHTKeyCompare, /* key compare */
982 JimStringCopyHTKeyDestructor, /* key destructor */
983 NULL /* val destructor */
986 /* This is like StringCopy but also automatically handle dynamic
987 * allocated C strings as values. */
988 static Jim_HashTableType JimStringKeyValCopyHashTableType = {
989 JimStringCopyHTHashFunction, /* hash function */
990 JimStringCopyHTKeyDup, /* key dup */
991 JimStringKeyValCopyHTValDup, /* val dup */
992 JimStringCopyHTKeyCompare, /* key compare */
993 JimStringCopyHTKeyDestructor, /* key destructor */
994 JimStringKeyValCopyHTValDestructor, /* val destructor */
997 typedef struct AssocDataValue {
998 Jim_InterpDeleteProc *delProc;
1002 static void JimAssocDataHashTableValueDestructor(void *privdata, void *data)
1004 AssocDataValue *assocPtr = (AssocDataValue *)data;
1005 if (assocPtr->delProc != NULL)
1006 assocPtr->delProc((Jim_Interp *)privdata, assocPtr->data);
1010 static Jim_HashTableType JimAssocDataHashTableType = {
1011 JimStringCopyHTHashFunction, /* hash function */
1012 JimStringCopyHTKeyDup, /* key dup */
1014 JimStringCopyHTKeyCompare, /* key compare */
1015 JimStringCopyHTKeyDestructor, /* key destructor */
1016 JimAssocDataHashTableValueDestructor /* val destructor */
1019 /* -----------------------------------------------------------------------------
1020 * Stack - This is a simple generic stack implementation. It is used for
1021 * example in the 'expr' expression compiler.
1022 * ---------------------------------------------------------------------------*/
1023 void Jim_InitStack(Jim_Stack *stack)
1027 stack->vector = NULL;
1030 void Jim_FreeStack(Jim_Stack *stack)
1032 Jim_Free(stack->vector);
1035 int Jim_StackLen(Jim_Stack *stack)
1040 void Jim_StackPush(Jim_Stack *stack, void *element) {
1041 int neededLen = stack->len+1;
1042 if (neededLen > stack->maxlen) {
1043 stack->maxlen = neededLen*2;
1044 stack->vector = Jim_Realloc(stack->vector, sizeof(void*)*stack->maxlen);
1046 stack->vector[stack->len] = element;
1050 void *Jim_StackPop(Jim_Stack *stack)
1052 if (stack->len == 0) return NULL;
1054 return stack->vector[stack->len];
1057 void *Jim_StackPeek(Jim_Stack *stack)
1059 if (stack->len == 0) return NULL;
1060 return stack->vector[stack->len-1];
1063 void Jim_FreeStackElements(Jim_Stack *stack, void (*freeFunc)(void *ptr))
1067 for (i = 0; i < stack->len; i++)
1068 freeFunc(stack->vector[i]);
1071 /* -----------------------------------------------------------------------------
1073 * ---------------------------------------------------------------------------*/
1076 #define JIM_TT_NONE -1 /* No token returned */
1077 #define JIM_TT_STR 0 /* simple string */
1078 #define JIM_TT_ESC 1 /* string that needs escape chars conversion */
1079 #define JIM_TT_VAR 2 /* var substitution */
1080 #define JIM_TT_DICTSUGAR 3 /* Syntax sugar for [dict get], $foo(bar) */
1081 #define JIM_TT_CMD 4 /* command substitution */
1082 #define JIM_TT_SEP 5 /* word separator */
1083 #define JIM_TT_EOL 6 /* line separator */
1085 /* Additional token types needed for expressions */
1086 #define JIM_TT_SUBEXPR_START 7
1087 #define JIM_TT_SUBEXPR_END 8
1088 #define JIM_TT_EXPR_NUMBER 9
1089 #define JIM_TT_EXPR_OPERATOR 10
1092 #define JIM_PS_DEF 0 /* Default state */
1093 #define JIM_PS_QUOTE 1 /* Inside "" */
1095 /* Parser context structure. The same context is used both to parse
1096 * Tcl scripts and lists. */
1097 struct JimParserCtx {
1098 const char *prg; /* Program text */
1099 const char *p; /* Pointer to the point of the program we are parsing */
1100 int len; /* Left length of 'prg' */
1101 int linenr; /* Current line number */
1103 const char *tend; /* Returned token is at tstart-tend in 'prg'. */
1104 int tline; /* Line number of the returned token */
1105 int tt; /* Token type */
1106 int eof; /* Non zero if EOF condition is true. */
1107 int state; /* Parser state */
1108 int comment; /* Non zero if the next chars may be a comment. */
1111 #define JimParserEof(c) ((c)->eof)
1112 #define JimParserTstart(c) ((c)->tstart)
1113 #define JimParserTend(c) ((c)->tend)
1114 #define JimParserTtype(c) ((c)->tt)
1115 #define JimParserTline(c) ((c)->tline)
1117 static int JimParseScript(struct JimParserCtx *pc);
1118 static int JimParseSep(struct JimParserCtx *pc);
1119 static int JimParseEol(struct JimParserCtx *pc);
1120 static int JimParseCmd(struct JimParserCtx *pc);
1121 static int JimParseVar(struct JimParserCtx *pc);
1122 static int JimParseBrace(struct JimParserCtx *pc);
1123 static int JimParseStr(struct JimParserCtx *pc);
1124 static int JimParseComment(struct JimParserCtx *pc);
1125 static char *JimParserGetToken(struct JimParserCtx *pc,
1126 int *lenPtr, int *typePtr, int *linePtr);
1128 /* Initialize a parser context.
1129 * 'prg' is a pointer to the program text, linenr is the line
1130 * number of the first line contained in the program. */
1131 void JimParserInit(struct JimParserCtx *pc, const char *prg,
1132 int len, int linenr)
1140 pc->tt = JIM_TT_NONE;
1142 pc->state = JIM_PS_DEF;
1143 pc->linenr = linenr;
1147 int JimParseScript(struct JimParserCtx *pc)
1149 while(1) { /* the while is used to reiterate with continue if needed */
1153 pc->tline = pc->linenr;
1154 pc->tt = JIM_TT_EOL;
1160 if (*(pc->p+1) == '\n')
1161 return JimParseSep(pc);
1164 return JimParseStr(pc);
1170 if (pc->state == JIM_PS_DEF)
1171 return JimParseSep(pc);
1174 return JimParseStr(pc);
1180 if (pc->state == JIM_PS_DEF)
1181 return JimParseEol(pc);
1183 return JimParseStr(pc);
1187 return JimParseCmd(pc);
1191 if (JimParseVar(pc) == JIM_ERR) {
1192 pc->tstart = pc->tend = pc->p++; pc->len--;
1193 pc->tline = pc->linenr;
1194 pc->tt = JIM_TT_STR;
1201 JimParseComment(pc);
1204 return JimParseStr(pc);
1208 return JimParseStr(pc);
1215 int JimParseSep(struct JimParserCtx *pc)
1218 pc->tline = pc->linenr;
1219 while (*pc->p == ' ' || *pc->p == '\t' || *pc->p == '\r' ||
1220 (*pc->p == '\\' && *(pc->p+1) == '\n')) {
1221 if (*pc->p == '\\') {
1228 pc->tt = JIM_TT_SEP;
1232 int JimParseEol(struct JimParserCtx *pc)
1235 pc->tline = pc->linenr;
1236 while (*pc->p == ' ' || *pc->p == '\n' ||
1237 *pc->p == '\t' || *pc->p == '\r' || *pc->p == ';') {
1243 pc->tt = JIM_TT_EOL;
1247 /* Todo. Don't stop if ']' appears inside {} or quoted.
1248 * Also should handle the case of puts [string length "]"] */
1249 int JimParseCmd(struct JimParserCtx *pc)
1254 pc->tstart = ++pc->p; pc->len--;
1255 pc->tline = pc->linenr;
1259 } else if (*pc->p == '[' && blevel == 0) {
1261 } else if (*pc->p == ']' && blevel == 0) {
1264 } else if (*pc->p == '\\') {
1266 } else if (*pc->p == '{') {
1268 } else if (*pc->p == '}') {
1271 } else if (*pc->p == '\n')
1276 pc->tt = JIM_TT_CMD;
1277 if (*pc->p == ']') {
1283 int JimParseVar(struct JimParserCtx *pc)
1285 int brace = 0, stop = 0, ttype = JIM_TT_VAR;
1287 pc->tstart = ++pc->p; pc->len--; /* skip the $ */
1288 pc->tline = pc->linenr;
1289 if (*pc->p == '{') {
1290 pc->tstart = ++pc->p; pc->len--;
1295 if (*pc->p == '}' || pc->len == 0) {
1300 else if (*pc->p == '\n')
1310 if (!((*pc->p >= 'a' && *pc->p <= 'z') ||
1311 (*pc->p >= 'A' && *pc->p <= 'Z') ||
1312 (*pc->p >= '0' && *pc->p <= '9') || *pc->p == '_'))
1318 /* Parse [dict get] syntax sugar. */
1319 if (*pc->p == '(') {
1320 while (*pc->p != ')' && pc->len) {
1322 if (*pc->p == '\\' && pc->len >= 2) {
1323 pc->p += 2; pc->len -= 2;
1326 if (*pc->p != '\0') {
1329 ttype = JIM_TT_DICTSUGAR;
1333 /* Check if we parsed just the '$' character.
1334 * That's not a variable so an error is returned
1335 * to tell the state machine to consider this '$' just
1337 if (pc->tstart == pc->p) {
1345 int JimParseBrace(struct JimParserCtx *pc)
1349 pc->tstart = ++pc->p; pc->len--;
1350 pc->tline = pc->linenr;
1352 if (*pc->p == '\\' && pc->len >= 2) {
1356 } else if (*pc->p == '{') {
1358 } else if (pc->len == 0 || *pc->p == '}') {
1360 if (pc->len == 0 || level == 0) {
1365 pc->tt = JIM_TT_STR;
1368 } else if (*pc->p == '\n') {
1373 return JIM_OK; /* unreached */
1376 int JimParseStr(struct JimParserCtx *pc)
1378 int newword = (pc->tt == JIM_TT_SEP || pc->tt == JIM_TT_EOL ||
1379 pc->tt == JIM_TT_NONE || pc->tt == JIM_TT_STR);
1380 if (newword && *pc->p == '{') {
1381 return JimParseBrace(pc);
1382 } else if (newword && *pc->p == '"') {
1383 pc->state = JIM_PS_QUOTE;
1387 pc->tline = pc->linenr;
1391 pc->tt = JIM_TT_ESC;
1396 if (pc->state == JIM_PS_DEF &&
1397 *(pc->p+1) == '\n') {
1399 pc->tt = JIM_TT_ESC;
1409 pc->tt = JIM_TT_ESC;
1416 if (pc->state == JIM_PS_DEF) {
1418 pc->tt = JIM_TT_ESC;
1420 } else if (*pc->p == '\n') {
1425 if (pc->state == JIM_PS_QUOTE) {
1427 pc->tt = JIM_TT_ESC;
1429 pc->state = JIM_PS_DEF;
1436 return JIM_OK; /* unreached */
1439 int JimParseComment(struct JimParserCtx *pc)
1442 if (*pc->p == '\n') {
1444 if (*(pc->p-1) != '\\') {
1454 /* xdigitval and odigitval are helper functions for JimParserGetToken() */
1455 static int xdigitval(int c)
1457 if (c >= '0' && c <= '9') return c-'0';
1458 if (c >= 'a' && c <= 'f') return c-'a'+10;
1459 if (c >= 'A' && c <= 'F') return c-'A'+10;
1463 static int odigitval(int c)
1465 if (c >= '0' && c <= '7') return c-'0';
1469 /* Perform Tcl escape substitution of 's', storing the result
1470 * string into 'dest'. The escaped string is guaranteed to
1471 * be the same length or shorted than the source string.
1472 * Slen is the length of the string at 's', if it's -1 the string
1473 * length will be calculated by the function.
1475 * The function returns the length of the resulting string. */
1476 static int JimEscape(char *dest, const char *s, int slen)
1484 for (i = 0; i < slen; i++) {
1488 case 'a': *p++ = 0x7; i++; break;
1489 case 'b': *p++ = 0x8; i++; break;
1490 case 'f': *p++ = 0xc; i++; break;
1491 case 'n': *p++ = 0xa; i++; break;
1492 case 'r': *p++ = 0xd; i++; break;
1493 case 't': *p++ = 0x9; i++; break;
1494 case 'v': *p++ = 0xb; i++; break;
1495 case '\0': *p++ = '\\'; i++; break;
1496 case '\n': *p++ = ' '; i++; break;
1498 if (s[i+1] == 'x') {
1500 int c = xdigitval(s[i+2]);
1507 c = xdigitval(s[i+3]);
1517 } else if (s[i+1] >= '0' && s[i+1] <= '7')
1520 int c = odigitval(s[i+1]);
1522 c = odigitval(s[i+2]);
1529 c = odigitval(s[i+3]);
1555 /* Returns a dynamically allocated copy of the current token in the
1556 * parser context. The function perform conversion of escapes if
1557 * the token is of type JIM_TT_ESC.
1559 * Note that after the conversion, tokens that are grouped with
1560 * braces in the source code, are always recognizable from the
1561 * identical string obtained in a different way from the type.
1563 * For exmple the string:
1567 * will return as first token "expand", of type JIM_TT_STR
1573 * will return as first token "expand", of type JIM_TT_ESC
1575 char *JimParserGetToken(struct JimParserCtx *pc,
1576 int *lenPtr, int *typePtr, int *linePtr)
1578 const char *start, *end;
1582 start = JimParserTstart(pc);
1583 end = JimParserTend(pc);
1585 if (lenPtr) *lenPtr = 0;
1586 if (typePtr) *typePtr = JimParserTtype(pc);
1587 if (linePtr) *linePtr = JimParserTline(pc);
1588 token = Jim_Alloc(1);
1592 len = (end-start)+1;
1593 token = Jim_Alloc(len+1);
1594 if (JimParserTtype(pc) != JIM_TT_ESC) {
1595 /* No escape conversion needed? Just copy it. */
1596 memcpy(token, start, len);
1599 /* Else convert the escape chars. */
1600 len = JimEscape(token, start, len);
1602 if (lenPtr) *lenPtr = len;
1603 if (typePtr) *typePtr = JimParserTtype(pc);
1604 if (linePtr) *linePtr = JimParserTline(pc);
1608 /* The following functin is not really part of the parsing engine of Jim,
1609 * but it somewhat related. Given an string and its length, it tries
1610 * to guess if the script is complete or there are instead " " or { }
1611 * open and not completed. This is useful for interactive shells
1612 * implementation and for [info complete].
1614 * If 'stateCharPtr' != NULL, the function stores ' ' on complete script,
1615 * '{' on scripts incomplete missing one or more '}' to be balanced.
1616 * '"' on scripts incomplete missing a '"' char.
1618 * If the script is complete, 1 is returned, otherwise 0. */
1619 int Jim_ScriptIsComplete(const char *s, int len, char *stateCharPtr)
1633 } else if (state == '"') {
1640 } else if (state == ' ') {
1657 *stateCharPtr = state;
1658 return state == ' ';
1661 /* -----------------------------------------------------------------------------
1663 * ---------------------------------------------------------------------------*/
1664 static int JimParseListSep(struct JimParserCtx *pc);
1665 static int JimParseListStr(struct JimParserCtx *pc);
1667 int JimParseList(struct JimParserCtx *pc)
1670 pc->tstart = pc->tend = pc->p;
1671 pc->tline = pc->linenr;
1672 pc->tt = JIM_TT_EOL;
1681 if (pc->state == JIM_PS_DEF)
1682 return JimParseListSep(pc);
1684 return JimParseListStr(pc);
1687 return JimParseListStr(pc);
1693 int JimParseListSep(struct JimParserCtx *pc)
1696 pc->tline = pc->linenr;
1697 while (*pc->p == ' ' || *pc->p == '\t' || *pc->p == '\r' || *pc->p == '\n')
1702 pc->tt = JIM_TT_SEP;
1706 int JimParseListStr(struct JimParserCtx *pc)
1708 int newword = (pc->tt == JIM_TT_SEP || pc->tt == JIM_TT_EOL ||
1709 pc->tt == JIM_TT_NONE);
1710 if (newword && *pc->p == '{') {
1711 return JimParseBrace(pc);
1712 } else if (newword && *pc->p == '"') {
1713 pc->state = JIM_PS_QUOTE;
1717 pc->tline = pc->linenr;
1721 pc->tt = JIM_TT_ESC;
1732 if (pc->state == JIM_PS_DEF) {
1734 pc->tt = JIM_TT_ESC;
1736 } else if (*pc->p == '\n') {
1741 if (pc->state == JIM_PS_QUOTE) {
1743 pc->tt = JIM_TT_ESC;
1745 pc->state = JIM_PS_DEF;
1752 return JIM_OK; /* unreached */
1755 /* -----------------------------------------------------------------------------
1756 * Jim_Obj related functions
1757 * ---------------------------------------------------------------------------*/
1759 /* Return a new initialized object. */
1760 Jim_Obj *Jim_NewObj(Jim_Interp *interp)
1764 /* -- Check if there are objects in the free list -- */
1765 if (interp->freeList != NULL) {
1766 /* -- Unlink the object from the free list -- */
1767 objPtr = interp->freeList;
1768 interp->freeList = objPtr->nextObjPtr;
1770 /* -- No ready to use objects: allocate a new one -- */
1771 objPtr = Jim_Alloc(sizeof(*objPtr));
1774 /* Object is returned with refCount of 0. Every
1775 * kind of GC implemented should take care to don't try
1776 * to scan objects with refCount == 0. */
1777 objPtr->refCount = 0;
1778 /* All the other fields are left not initialized to save time.
1779 * The caller will probably want set they to the right
1782 /* -- Put the object into the live list -- */
1783 objPtr->prevObjPtr = NULL;
1784 objPtr->nextObjPtr = interp->liveList;
1785 if (interp->liveList)
1786 interp->liveList->prevObjPtr = objPtr;
1787 interp->liveList = objPtr;
1792 /* Free an object. Actually objects are never freed, but
1793 * just moved to the free objects list, where they will be
1794 * reused by Jim_NewObj(). */
1795 void Jim_FreeObj(Jim_Interp *interp, Jim_Obj *objPtr)
1797 /* Check if the object was already freed, panic. */
1798 if (objPtr->refCount != 0) {
1799 Jim_Panic(interp,"!!!Object %p freed with bad refcount %d", objPtr,
1802 /* Free the internal representation */
1803 Jim_FreeIntRep(interp, objPtr);
1804 /* Free the string representation */
1805 if (objPtr->bytes != NULL) {
1806 if (objPtr->bytes != JimEmptyStringRep)
1807 Jim_Free(objPtr->bytes);
1809 /* Unlink the object from the live objects list */
1810 if (objPtr->prevObjPtr)
1811 objPtr->prevObjPtr->nextObjPtr = objPtr->nextObjPtr;
1812 if (objPtr->nextObjPtr)
1813 objPtr->nextObjPtr->prevObjPtr = objPtr->prevObjPtr;
1814 if (interp->liveList == objPtr)
1815 interp->liveList = objPtr->nextObjPtr;
1816 /* Link the object into the free objects list */
1817 objPtr->prevObjPtr = NULL;
1818 objPtr->nextObjPtr = interp->freeList;
1819 if (interp->freeList)
1820 interp->freeList->prevObjPtr = objPtr;
1821 interp->freeList = objPtr;
1822 objPtr->refCount = -1;
1825 /* Invalidate the string representation of an object. */
1826 void Jim_InvalidateStringRep(Jim_Obj *objPtr)
1828 if (objPtr->bytes != NULL) {
1829 if (objPtr->bytes != JimEmptyStringRep)
1830 Jim_Free(objPtr->bytes);
1832 objPtr->bytes = NULL;
1835 #define Jim_SetStringRep(o, b, l) \
1836 do { (o)->bytes = b; (o)->length = l; } while (0)
1838 /* Set the initial string representation for an object.
1839 * Does not try to free an old one. */
1840 void Jim_InitStringRep(Jim_Obj *objPtr, const char *bytes, int length)
1843 objPtr->bytes = JimEmptyStringRep;
1846 objPtr->bytes = Jim_Alloc(length+1);
1847 objPtr->length = length;
1848 memcpy(objPtr->bytes, bytes, length);
1849 objPtr->bytes[length] = '\0';
1853 /* Duplicate an object. The returned object has refcount = 0. */
1854 Jim_Obj *Jim_DuplicateObj(Jim_Interp *interp, Jim_Obj *objPtr)
1858 dupPtr = Jim_NewObj(interp);
1859 if (objPtr->bytes == NULL) {
1860 /* Object does not have a valid string representation. */
1861 dupPtr->bytes = NULL;
1863 Jim_InitStringRep(dupPtr, objPtr->bytes, objPtr->length);
1865 if (objPtr->typePtr != NULL) {
1866 if (objPtr->typePtr->dupIntRepProc == NULL) {
1867 dupPtr->internalRep = objPtr->internalRep;
1869 objPtr->typePtr->dupIntRepProc(interp, objPtr, dupPtr);
1871 dupPtr->typePtr = objPtr->typePtr;
1873 dupPtr->typePtr = NULL;
1878 /* Return the string representation for objPtr. If the object
1879 * string representation is invalid, calls the method to create
1880 * a new one starting from the internal representation of the object. */
1881 const char *Jim_GetString(Jim_Obj *objPtr, int *lenPtr)
1883 if (objPtr->bytes == NULL) {
1884 /* Invalid string repr. Generate it. */
1885 if (objPtr->typePtr->updateStringProc == NULL) {
1886 Jim_Panic(NULL,"UpdataStringProc called against '%s' type.",
1887 objPtr->typePtr->name);
1889 objPtr->typePtr->updateStringProc(objPtr);
1892 *lenPtr = objPtr->length;
1893 return objPtr->bytes;
1896 /* Just returns the length of the object's string rep */
1897 int Jim_Length(Jim_Obj *objPtr)
1901 Jim_GetString(objPtr, &len);
1905 /* -----------------------------------------------------------------------------
1907 * ---------------------------------------------------------------------------*/
1908 static void DupStringInternalRep(Jim_Interp *interp, Jim_Obj *srcPtr, Jim_Obj *dupPtr);
1909 static int SetStringFromAny(Jim_Interp *interp, struct Jim_Obj *objPtr);
1911 static Jim_ObjType stringObjType = {
1914 DupStringInternalRep,
1916 JIM_TYPE_REFERENCES,
1919 void DupStringInternalRep(Jim_Interp *interp, Jim_Obj *srcPtr, Jim_Obj *dupPtr)
1921 JIM_NOTUSED(interp);
1923 /* This is a bit subtle: the only caller of this function
1924 * should be Jim_DuplicateObj(), that will copy the
1925 * string representaion. After the copy, the duplicated
1926 * object will not have more room in teh buffer than
1927 * srcPtr->length bytes. So we just set it to length. */
1928 dupPtr->internalRep.strValue.maxLength = srcPtr->length;
1931 int SetStringFromAny(Jim_Interp *interp, Jim_Obj *objPtr)
1933 /* Get a fresh string representation. */
1934 (void) Jim_GetString(objPtr, NULL);
1935 /* Free any other internal representation. */
1936 Jim_FreeIntRep(interp, objPtr);
1937 /* Set it as string, i.e. just set the maxLength field. */
1938 objPtr->typePtr = &stringObjType;
1939 objPtr->internalRep.strValue.maxLength = objPtr->length;
1943 Jim_Obj *Jim_NewStringObj(Jim_Interp *interp, const char *s, int len)
1945 Jim_Obj *objPtr = Jim_NewObj(interp);
1949 /* Alloc/Set the string rep. */
1951 objPtr->bytes = JimEmptyStringRep;
1954 objPtr->bytes = Jim_Alloc(len+1);
1955 objPtr->length = len;
1956 memcpy(objPtr->bytes, s, len);
1957 objPtr->bytes[len] = '\0';
1960 /* No typePtr field for the vanilla string object. */
1961 objPtr->typePtr = NULL;
1965 /* This version does not try to duplicate the 's' pointer, but
1966 * use it directly. */
1967 Jim_Obj *Jim_NewStringObjNoAlloc(Jim_Interp *interp, char *s, int len)
1969 Jim_Obj *objPtr = Jim_NewObj(interp);
1973 Jim_SetStringRep(objPtr, s, len);
1974 objPtr->typePtr = NULL;
1978 /* Low-level string append. Use it only against objects
1979 * of type "string". */
1980 void StringAppendString(Jim_Obj *objPtr, const char *str, int len)
1986 needlen = objPtr->length + len;
1987 if (objPtr->internalRep.strValue.maxLength < needlen ||
1988 objPtr->internalRep.strValue.maxLength == 0) {
1989 if (objPtr->bytes == JimEmptyStringRep) {
1990 objPtr->bytes = Jim_Alloc((needlen*2)+1);
1992 objPtr->bytes = Jim_Realloc(objPtr->bytes, (needlen*2)+1);
1994 objPtr->internalRep.strValue.maxLength = needlen*2;
1996 memcpy(objPtr->bytes + objPtr->length, str, len);
1997 objPtr->bytes[objPtr->length+len] = '\0';
1998 objPtr->length += len;
2001 /* Low-level wrapper to append an object. */
2002 void StringAppendObj(Jim_Obj *objPtr, Jim_Obj *appendObjPtr)
2007 str = Jim_GetString(appendObjPtr, &len);
2008 StringAppendString(objPtr, str, len);
2011 /* Higher level API to append strings to objects. */
2012 void Jim_AppendString(Jim_Interp *interp, Jim_Obj *objPtr, const char *str,
2015 if (Jim_IsShared(objPtr))
2016 Jim_Panic(interp,"Jim_AppendString called with shared object");
2017 if (objPtr->typePtr != &stringObjType)
2018 SetStringFromAny(interp, objPtr);
2019 StringAppendString(objPtr, str, len);
2022 void Jim_AppendObj(Jim_Interp *interp, Jim_Obj *objPtr,
2023 Jim_Obj *appendObjPtr)
2028 str = Jim_GetString(appendObjPtr, &len);
2029 Jim_AppendString(interp, objPtr, str, len);
2032 void Jim_AppendStrings(Jim_Interp *interp, Jim_Obj *objPtr, ...)
2036 if (objPtr->typePtr != &stringObjType)
2037 SetStringFromAny(interp, objPtr);
2038 va_start(ap, objPtr);
2040 char *s = va_arg(ap, char*);
2042 if (s == NULL) break;
2043 Jim_AppendString(interp, objPtr, s, -1);
2048 int Jim_StringEqObj(Jim_Obj *aObjPtr, Jim_Obj *bObjPtr, int nocase)
2050 const char *aStr, *bStr;
2053 if (aObjPtr == bObjPtr) return 1;
2054 aStr = Jim_GetString(aObjPtr, &aLen);
2055 bStr = Jim_GetString(bObjPtr, &bLen);
2056 if (aLen != bLen) return 0;
2058 return memcmp(aStr, bStr, aLen) == 0;
2059 for (i = 0; i < aLen; i++) {
2060 if (tolower((int)aStr[i]) != tolower((int)bStr[i]))
2066 int Jim_StringMatchObj(Jim_Obj *patternObjPtr, Jim_Obj *objPtr,
2069 const char *pattern, *string;
2070 int patternLen, stringLen;
2072 pattern = Jim_GetString(patternObjPtr, &patternLen);
2073 string = Jim_GetString(objPtr, &stringLen);
2074 return JimStringMatch(pattern, patternLen, string, stringLen, nocase);
2077 int Jim_StringCompareObj(Jim_Obj *firstObjPtr,
2078 Jim_Obj *secondObjPtr, int nocase)
2080 const char *s1, *s2;
2083 s1 = Jim_GetString(firstObjPtr, &l1);
2084 s2 = Jim_GetString(secondObjPtr, &l2);
2085 return JimStringCompare(s1, l1, s2, l2, nocase);
2088 /* Convert a range, as returned by Jim_GetRange(), into
2089 * an absolute index into an object of the specified length.
2090 * This function may return negative values, or values
2091 * bigger or equal to the length of the list if the index
2092 * is out of range. */
2093 static int JimRelToAbsIndex(int len, int index)
2100 /* Convert a pair of index as normalize by JimRelToAbsIndex(),
2101 * into a range stored in *firstPtr, *lastPtr, *rangeLenPtr, suitable
2102 * for implementation of commands like [string range] and [lrange].
2104 * The resulting range is guaranteed to address valid elements of
2106 static void JimRelToAbsRange(int len, int first, int last,
2107 int *firstPtr, int *lastPtr, int *rangeLenPtr)
2114 rangeLen = last-first+1;
2121 rangeLen -= (last-(len-1));
2126 if (rangeLen < 0) rangeLen = 0;
2130 *rangeLenPtr = rangeLen;
2133 Jim_Obj *Jim_StringRangeObj(Jim_Interp *interp,
2134 Jim_Obj *strObjPtr, Jim_Obj *firstObjPtr, Jim_Obj *lastObjPtr)
2140 if (Jim_GetIndex(interp, firstObjPtr, &first) != JIM_OK ||
2141 Jim_GetIndex(interp, lastObjPtr, &last) != JIM_OK)
2143 str = Jim_GetString(strObjPtr, &len);
2144 first = JimRelToAbsIndex(len, first);
2145 last = JimRelToAbsIndex(len, last);
2146 JimRelToAbsRange(len, first, last, &first, &last, &rangeLen);
2147 return Jim_NewStringObj(interp, str+first, rangeLen);
2150 static Jim_Obj *JimStringToLower(Jim_Interp *interp, Jim_Obj *strObjPtr)
2152 char *buf = Jim_Alloc(strObjPtr->length+1);
2155 memcpy(buf, strObjPtr->bytes, strObjPtr->length+1);
2156 for (i = 0; i < strObjPtr->length; i++)
2157 buf[i] = tolower(buf[i]);
2158 return Jim_NewStringObjNoAlloc(interp, buf, strObjPtr->length);
2161 static Jim_Obj *JimStringToUpper(Jim_Interp *interp, Jim_Obj *strObjPtr)
2163 char *buf = Jim_Alloc(strObjPtr->length+1);
2166 memcpy(buf, strObjPtr->bytes, strObjPtr->length+1);
2167 for (i = 0; i < strObjPtr->length; i++)
2168 buf[i] = toupper(buf[i]);
2169 return Jim_NewStringObjNoAlloc(interp, buf, strObjPtr->length);
2172 /* This is the core of the [format] command.
2173 * TODO: Lots of things work - via a hack
2174 * However, no format item can be >= JIM_MAX_FMT
2176 Jim_Obj *Jim_FormatString(Jim_Interp *interp, Jim_Obj *fmtObjPtr,
2177 int objc, Jim_Obj *const *objv)
2179 const char *fmt, *_fmt;
2184 fmt = Jim_GetString(fmtObjPtr, &fmtLen);
2186 resObjPtr = Jim_NewStringObj(interp, "", 0);
2188 const char *p = fmt;
2192 /* we cheat and use Sprintf()! */
2193 #define JIM_MAX_FMT 2048
2194 char sprintf_buf[JIM_MAX_FMT];
2208 while (*fmt != '%' && fmtLen) {
2211 Jim_AppendString(interp, resObjPtr, p, fmt-p);
2214 fmt++; fmtLen--; /* skip '%' */
2223 prec = -1; /* not found yet */
2230 case 'b': /* binary - not all printfs() do this */
2231 case 's': /* string */
2232 case 'i': /* integer */
2233 case 'd': /* decimal */
2235 case 'X': /* CAP hex */
2236 case 'c': /* char */
2237 case 'o': /* octal */
2238 case 'u': /* unsigned */
2239 case 'f': /* float */
2243 case '0': /* zero pad */
2253 case ' ': /* sign space */
2283 while( isdigit(*fmt) && (fmtLen > 0) ){
2284 accum = (accum * 10) + (*fmt - '0');
2295 /* suck up the next item as an integer */
2299 goto not_enough_args;
2301 if( Jim_GetWide(interp,objv[0],&wideValue )== JIM_ERR ){
2302 Jim_FreeNewObj(interp, resObjPtr );
2309 /* man 3 printf says */
2310 /* if prec is negative, it is zero */
2329 Jim_FreeNewObj(interp, resObjPtr);
2330 Jim_SetResultString(interp,
2331 "not enough arguments for all format specifiers", -1);
2339 * Create the formatter
2340 * cause we cheat and use sprintf()
2350 /* PLUS overrides */
2360 sprintf( cp, "%d", width );
2364 /* did we find a period? */
2368 /* did something occur after the period? */
2370 sprintf( cp, "%d", prec );
2376 /* here we do the work */
2377 /* actually - we make sprintf() do it for us */
2382 /* BUG: we do not handled embeded NULLs */
2383 snprintf( sprintf_buf, JIM_MAX_FMT, fmt_str, Jim_GetString( objv[0], NULL ));
2388 if (Jim_GetWide(interp, objv[0], &wideValue) == JIM_ERR) {
2389 Jim_FreeNewObj(interp, resObjPtr);
2392 c = (char) wideValue;
2393 snprintf( sprintf_buf, JIM_MAX_FMT, fmt_str, c );
2403 if( Jim_GetDouble( interp, objv[0], &doubleValue ) == JIM_ERR ){
2404 Jim_FreeNewObj( interp, resObjPtr );
2407 snprintf( sprintf_buf, JIM_MAX_FMT, fmt_str, doubleValue );
2415 /* jim widevaluse are 64bit */
2416 if( sizeof(jim_wide) == sizeof(long long) ){
2424 if (Jim_GetWide(interp, objv[0], &wideValue) == JIM_ERR) {
2425 Jim_FreeNewObj(interp, resObjPtr);
2428 snprintf(sprintf_buf, JIM_MAX_FMT, fmt_str, wideValue );
2431 sprintf_buf[0] = '%';
2433 objv--; /* undo the objv++ below */
2436 spec[0] = *fmt; spec[1] = '\0';
2437 Jim_FreeNewObj(interp, resObjPtr);
2438 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
2439 Jim_AppendStrings(interp, Jim_GetResult(interp),
2440 "bad field specifier \"", spec, "\"", NULL);
2443 /* force terminate */
2445 printf("FMT was: %s\n", fmt_str );
2446 printf("RES was: |%s|\n", sprintf_buf );
2449 sprintf_buf[ JIM_MAX_FMT - 1] = 0;
2450 Jim_AppendString( interp, resObjPtr, sprintf_buf, strlen(sprintf_buf) );
2459 /* -----------------------------------------------------------------------------
2460 * Compared String Object
2461 * ---------------------------------------------------------------------------*/
2463 /* This is strange object that allows to compare a C literal string
2464 * with a Jim object in very short time if the same comparison is done
2465 * multiple times. For example every time the [if] command is executed,
2466 * Jim has to check if a given argument is "else". This comparions if
2467 * the code has no errors are true most of the times, so we can cache
2468 * inside the object the pointer of the string of the last matching
2469 * comparison. Because most C compilers perform literal sharing,
2470 * so that: char *x = "foo", char *y = "foo", will lead to x == y,
2471 * this works pretty well even if comparisons are at different places
2472 * inside the C code. */
2474 static Jim_ObjType comparedStringObjType = {
2479 JIM_TYPE_REFERENCES,
2482 /* The only way this object is exposed to the API is via the following
2483 * function. Returns true if the string and the object string repr.
2484 * are the same, otherwise zero is returned.
2486 * Note: this isn't binary safe, but it hardly needs to be.*/
2487 int Jim_CompareStringImmediate(Jim_Interp *interp, Jim_Obj *objPtr,
2490 if (objPtr->typePtr == &comparedStringObjType &&
2491 objPtr->internalRep.ptr == str)
2494 const char *objStr = Jim_GetString(objPtr, NULL);
2495 if (strcmp(str, objStr) != 0) return 0;
2496 if (objPtr->typePtr != &comparedStringObjType) {
2497 Jim_FreeIntRep(interp, objPtr);
2498 objPtr->typePtr = &comparedStringObjType;
2500 objPtr->internalRep.ptr = (char*)str; /*ATTENTION: const cast */
2505 int qsortCompareStringPointers(const void *a, const void *b)
2507 char * const *sa = (char * const *)a;
2508 char * const *sb = (char * const *)b;
2509 return strcmp(*sa, *sb);
2512 int Jim_GetEnum(Jim_Interp *interp, Jim_Obj *objPtr,
2513 const char **tablePtr, int *indexPtr, const char *name, int flags)
2515 const char **entryPtr = NULL;
2516 char **tablePtrSorted;
2520 for (entryPtr = tablePtr, i = 0; *entryPtr != NULL; entryPtr++, i++) {
2521 if (Jim_CompareStringImmediate(interp, objPtr, *entryPtr)) {
2525 count++; /* If nothing matches, this will reach the len of tablePtr */
2527 if (flags & JIM_ERRMSG) {
2530 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
2531 Jim_AppendStrings(interp, Jim_GetResult(interp),
2532 "bad ", name, " \"", Jim_GetString(objPtr, NULL), "\": must be one of ",
2534 tablePtrSorted = Jim_Alloc(sizeof(char*)*count);
2535 memcpy(tablePtrSorted, tablePtr, sizeof(char*)*count);
2536 qsort(tablePtrSorted, count, sizeof(char*), qsortCompareStringPointers);
2537 for (i = 0; i < count; i++) {
2538 if (i+1 == count && count > 1)
2539 Jim_AppendString(interp, Jim_GetResult(interp), "or ", -1);
2540 Jim_AppendString(interp, Jim_GetResult(interp),
2541 tablePtrSorted[i], -1);
2543 Jim_AppendString(interp, Jim_GetResult(interp), ", ", -1);
2545 Jim_Free(tablePtrSorted);
2550 /* -----------------------------------------------------------------------------
2553 * This object is just a string from the language point of view, but
2554 * in the internal representation it contains the filename and line number
2555 * where this given token was read. This information is used by
2556 * Jim_EvalObj() if the object passed happens to be of type "source".
2558 * This allows to propagate the information about line numbers and file
2559 * names and give error messages with absolute line numbers.
2561 * Note that this object uses shared strings for filenames, and the
2562 * pointer to the filename together with the line number is taken into
2563 * the space for the "inline" internal represenation of the Jim_Object,
2564 * so there is almost memory zero-overhead.
2566 * Also the object will be converted to something else if the given
2567 * token it represents in the source file is not something to be
2568 * evaluated (not a script), and will be specialized in some other way,
2569 * so the time overhead is alzo null.
2570 * ---------------------------------------------------------------------------*/
2572 static void FreeSourceInternalRep(Jim_Interp *interp, Jim_Obj *objPtr);
2573 static void DupSourceInternalRep(Jim_Interp *interp, Jim_Obj *srcPtr, Jim_Obj *dupPtr);
2575 static Jim_ObjType sourceObjType = {
2577 FreeSourceInternalRep,
2578 DupSourceInternalRep,
2580 JIM_TYPE_REFERENCES,
2583 void FreeSourceInternalRep(Jim_Interp *interp, Jim_Obj *objPtr)
2585 Jim_ReleaseSharedString(interp,
2586 objPtr->internalRep.sourceValue.fileName);
2589 void DupSourceInternalRep(Jim_Interp *interp, Jim_Obj *srcPtr, Jim_Obj *dupPtr)
2591 dupPtr->internalRep.sourceValue.fileName =
2592 Jim_GetSharedString(interp,
2593 srcPtr->internalRep.sourceValue.fileName);
2594 dupPtr->internalRep.sourceValue.lineNumber =
2595 dupPtr->internalRep.sourceValue.lineNumber;
2596 dupPtr->typePtr = &sourceObjType;
2599 static void JimSetSourceInfo(Jim_Interp *interp, Jim_Obj *objPtr,
2600 const char *fileName, int lineNumber)
2602 if (Jim_IsShared(objPtr))
2603 Jim_Panic(interp,"JimSetSourceInfo called with shared object");
2604 if (objPtr->typePtr != NULL)
2605 Jim_Panic(interp,"JimSetSourceInfo called with typePtr != NULL");
2606 objPtr->internalRep.sourceValue.fileName =
2607 Jim_GetSharedString(interp, fileName);
2608 objPtr->internalRep.sourceValue.lineNumber = lineNumber;
2609 objPtr->typePtr = &sourceObjType;
2612 /* -----------------------------------------------------------------------------
2614 * ---------------------------------------------------------------------------*/
2616 #define JIM_CMDSTRUCT_EXPAND -1
2618 static void FreeScriptInternalRep(Jim_Interp *interp, Jim_Obj *objPtr);
2619 static void DupScriptInternalRep(Jim_Interp *interp, Jim_Obj *srcPtr, Jim_Obj *dupPtr);
2620 static int SetScriptFromAny(Jim_Interp *interp, struct Jim_Obj *objPtr);
2622 static Jim_ObjType scriptObjType = {
2624 FreeScriptInternalRep,
2625 DupScriptInternalRep,
2627 JIM_TYPE_REFERENCES,
2630 /* The ScriptToken structure represents every token into a scriptObj.
2631 * Every token contains an associated Jim_Obj that can be specialized
2632 * by commands operating on it. */
2633 typedef struct ScriptToken {
2639 /* This is the script object internal representation. An array of
2640 * ScriptToken structures, with an associated command structure array.
2641 * The command structure is a pre-computed representation of the
2642 * command length and arguments structure as a simple liner array
2645 * For example the script:
2648 * set $i $x$y [foo]BAR
2650 * will produce a ScriptObj with the following Tokens:
2667 * This is a description of the tokens, separators, and of lines.
2668 * The command structure instead represents the number of arguments
2669 * of every command, followed by the tokens of which every argument
2670 * is composed. So for the example script, the cmdstruct array will
2675 * Because "puts hello" has two args (2), composed of single tokens (1 1)
2676 * While "set $i $x$y [foo]BAR" has four (4) args, the first two
2677 * composed of single tokens (1 1) and the last two of double tokens
2680 * The precomputation of the command structure makes Jim_Eval() faster,
2681 * and simpler because there aren't dynamic lengths / allocations.
2683 * -- {expand} handling --
2685 * Expand is handled in a special way. When a command
2686 * contains at least an argument with the {expand} prefix,
2687 * the command structure presents a -1 before the integer
2688 * describing the number of arguments. This is used in order
2689 * to send the command exection to a different path in case
2690 * of {expand} and guarantee a fast path for the more common
2691 * case. Also, the integers describing the number of tokens
2692 * are expressed with negative sign, to allow for fast check
2693 * of what's an {expand}-prefixed argument and what not.
2695 * For example the command:
2697 * list {expand}{1 2}
2699 * Will produce the following cmdstruct array:
2703 * -- the substFlags field of the structure --
2705 * The scriptObj structure is used to represent both "script" objects
2706 * and "subst" objects. In the second case, the cmdStruct related
2707 * fields are not used at all, but there is an additional field used
2708 * that is 'substFlags': this represents the flags used to turn
2709 * the string into the intenral representation used to perform the
2710 * substitution. If this flags are not what the application requires
2711 * the scriptObj is created again. For example the script:
2713 * subst -nocommands $string
2714 * subst -novariables $string
2716 * Will recreate the internal representation of the $string object
2719 typedef struct ScriptObj {
2720 int len; /* Length as number of tokens. */
2721 int commands; /* number of top-level commands in script. */
2722 ScriptToken *token; /* Tokens array. */
2723 int *cmdStruct; /* commands structure */
2724 int csLen; /* length of the cmdStruct array. */
2725 int substFlags; /* flags used for the compilation of "subst" objects */
2726 int inUse; /* Used to share a ScriptObj. Currently
2727 only used by Jim_EvalObj() as protection against
2728 shimmering of the currently evaluated object. */
2732 void FreeScriptInternalRep(Jim_Interp *interp, Jim_Obj *objPtr)
2735 struct ScriptObj *script = (void*) objPtr->internalRep.ptr;
2738 if (script->inUse != 0) return;
2739 for (i = 0; i < script->len; i++) {
2740 if (script->token[i].objPtr != NULL)
2741 Jim_DecrRefCount(interp, script->token[i].objPtr);
2743 Jim_Free(script->token);
2744 Jim_Free(script->cmdStruct);
2745 Jim_Free(script->fileName);
2749 void DupScriptInternalRep(Jim_Interp *interp, Jim_Obj *srcPtr, Jim_Obj *dupPtr)
2751 JIM_NOTUSED(interp);
2752 JIM_NOTUSED(srcPtr);
2754 /* Just returns an simple string. */
2755 dupPtr->typePtr = NULL;
2758 /* Add a new token to the internal repr of a script object */
2759 static void ScriptObjAddToken(Jim_Interp *interp, struct ScriptObj *script,
2760 char *strtoken, int len, int type, char *filename, int linenr)
2763 struct ScriptToken *token;
2765 prevtype = (script->len == 0) ? JIM_TT_EOL : \
2766 script->token[script->len-1].type;
2767 /* Skip tokens without meaning, like words separators
2768 * following a word separator or an end of command and
2770 if (prevtype == JIM_TT_EOL) {
2771 if (type == JIM_TT_EOL || type == JIM_TT_SEP) {
2775 } else if (prevtype == JIM_TT_SEP) {
2776 if (type == JIM_TT_SEP) {
2779 } else if (type == JIM_TT_EOL) {
2780 /* If an EOL is following by a SEP, drop the previous
2783 Jim_DecrRefCount(interp, script->token[script->len].objPtr);
2785 } else if (prevtype != JIM_TT_EOL && prevtype != JIM_TT_SEP &&
2786 type == JIM_TT_ESC && len == 0)
2788 /* Don't add empty tokens used in interpolation */
2792 /* Make space for a new istruction */
2794 script->token = Jim_Realloc(script->token,
2795 sizeof(ScriptToken)*script->len);
2796 /* Initialize the new token */
2797 token = script->token+(script->len-1);
2799 /* Every object is intially as a string, but the
2800 * internal type may be specialized during execution of the
2802 token->objPtr = Jim_NewStringObjNoAlloc(interp, strtoken, len);
2803 /* To add source info to SEP and EOL tokens is useless because
2804 * they will never by called as arguments of Jim_EvalObj(). */
2805 if (filename && type != JIM_TT_SEP && type != JIM_TT_EOL)
2806 JimSetSourceInfo(interp, token->objPtr, filename, linenr);
2807 Jim_IncrRefCount(token->objPtr);
2808 token->linenr = linenr;
2811 /* Add an integer into the command structure field of the script object. */
2812 static void ScriptObjAddInt(struct ScriptObj *script, int val)
2815 script->cmdStruct = Jim_Realloc(script->cmdStruct,
2816 sizeof(int)*script->csLen);
2817 script->cmdStruct[script->csLen-1] = val;
2820 /* Search a Jim_Obj contained in 'script' with the same stinrg repr.
2821 * of objPtr. Search nested script objects recursively. */
2822 static Jim_Obj *ScriptSearchLiteral(Jim_Interp *interp, ScriptObj *script,
2823 ScriptObj *scriptBarrier, Jim_Obj *objPtr)
2827 for (i = 0; i < script->len; i++) {
2828 if (script->token[i].objPtr != objPtr &&
2829 Jim_StringEqObj(script->token[i].objPtr, objPtr, 0)) {
2830 return script->token[i].objPtr;
2832 /* Enter recursively on scripts only if the object
2833 * is not the same as the one we are searching for
2834 * shared occurrences. */
2835 if (script->token[i].objPtr->typePtr == &scriptObjType &&
2836 script->token[i].objPtr != objPtr) {
2837 Jim_Obj *foundObjPtr;
2839 ScriptObj *subScript =
2840 script->token[i].objPtr->internalRep.ptr;
2841 /* Don't recursively enter the script we are trying
2842 * to make shared to avoid circular references. */
2843 if (subScript == scriptBarrier) continue;
2844 if (subScript != script) {
2846 ScriptSearchLiteral(interp, subScript,
2847 scriptBarrier, objPtr);
2848 if (foundObjPtr != NULL)
2856 /* Share literals of a script recursively sharing sub-scripts literals. */
2857 static void ScriptShareLiterals(Jim_Interp *interp, ScriptObj *script,
2858 ScriptObj *topLevelScript)
2863 /* Try to share with toplevel object. */
2864 if (topLevelScript != NULL) {
2865 for (i = 0; i < script->len; i++) {
2866 Jim_Obj *foundObjPtr;
2867 char *str = script->token[i].objPtr->bytes;
2869 if (script->token[i].objPtr->refCount != 1) continue;
2870 if (script->token[i].objPtr->typePtr == &scriptObjType) continue;
2871 if (strchr(str, ' ') || strchr(str, '\n')) continue;
2872 foundObjPtr = ScriptSearchLiteral(interp,
2874 script, /* barrier */
2875 script->token[i].objPtr);
2876 if (foundObjPtr != NULL) {
2877 Jim_IncrRefCount(foundObjPtr);
2878 Jim_DecrRefCount(interp,
2879 script->token[i].objPtr);
2880 script->token[i].objPtr = foundObjPtr;
2884 /* Try to share locally */
2885 for (i = 0; i < script->len; i++) {
2886 char *str = script->token[i].objPtr->bytes;
2888 if (script->token[i].objPtr->refCount != 1) continue;
2889 if (strchr(str, ' ') || strchr(str, '\n')) continue;
2890 for (j = 0; j < script->len; j++) {
2891 if (script->token[i].objPtr !=
2892 script->token[j].objPtr &&
2893 Jim_StringEqObj(script->token[i].objPtr,
2894 script->token[j].objPtr, 0))
2896 Jim_IncrRefCount(script->token[j].objPtr);
2897 Jim_DecrRefCount(interp,
2898 script->token[i].objPtr);
2899 script->token[i].objPtr =
2900 script->token[j].objPtr;
2906 /* This method takes the string representation of an object
2907 * as a Tcl script, and generates the pre-parsed internal representation
2909 int SetScriptFromAny(Jim_Interp *interp, struct Jim_Obj *objPtr)
2912 const char *scriptText = Jim_GetString(objPtr, &scriptTextLen);
2913 struct JimParserCtx parser;
2914 struct ScriptObj *script = Jim_Alloc(sizeof(*script));
2916 int args, tokens, start, end, i;
2917 int initialLineNumber;
2918 int propagateSourceInfo = 0;
2922 script->commands = 0;
2923 script->token = NULL;
2924 script->cmdStruct = NULL;
2926 /* Try to get information about filename / line number */
2927 if (objPtr->typePtr == &sourceObjType) {
2929 Jim_StrDup(objPtr->internalRep.sourceValue.fileName);
2930 initialLineNumber = objPtr->internalRep.sourceValue.lineNumber;
2931 propagateSourceInfo = 1;
2933 script->fileName = Jim_StrDup("?");
2934 initialLineNumber = 1;
2937 JimParserInit(&parser, scriptText, scriptTextLen, initialLineNumber);
2938 while(!JimParserEof(&parser)) {
2940 int len, type, linenr;
2942 JimParseScript(&parser);
2943 token = JimParserGetToken(&parser, &len, &type, &linenr);
2944 ScriptObjAddToken(interp, script, token, len, type,
2945 propagateSourceInfo ? script->fileName : NULL,
2948 token = script->token;
2950 /* Compute the command structure array
2951 * (see the ScriptObj struct definition for more info) */
2952 start = 0; /* Current command start token index */
2953 end = -1; /* Current command end token index */
2955 int expand = 0; /* expand flag. set to 1 on {expand} form. */
2956 int interpolation = 0; /* set to 1 if there is at least one
2957 argument of the command obtained via
2958 interpolation of more tokens. */
2959 /* Search for the end of command, while
2960 * count the number of args. */
2962 if (start >= script->len) break;
2963 args = 1; /* Number of args in current command */
2964 while (token[end].type != JIM_TT_EOL) {
2965 if (end == 0 || token[end-1].type == JIM_TT_SEP ||
2966 token[end-1].type == JIM_TT_EOL)
2968 if (token[end].type == JIM_TT_STR &&
2969 token[end+1].type != JIM_TT_SEP &&
2970 token[end+1].type != JIM_TT_EOL &&
2971 (!strcmp(token[end].objPtr->bytes, "expand") ||
2972 !strcmp(token[end].objPtr->bytes, "*")))
2975 if (token[end].type == JIM_TT_SEP)
2979 interpolation = !((end-start+1) == args*2);
2980 /* Add the 'number of arguments' info into cmdstruct.
2981 * Negative value if there is list expansion involved. */
2983 ScriptObjAddInt(script, -1);
2984 ScriptObjAddInt(script, args);
2985 /* Now add info about the number of tokens. */
2986 tokens = 0; /* Number of tokens in current argument. */
2988 for (i = start; i <= end; i++) {
2989 if (token[i].type == JIM_TT_SEP ||
2990 token[i].type == JIM_TT_EOL)
2992 if (tokens == 1 && expand)
2994 ScriptObjAddInt(script,
2995 expand ? -tokens : tokens);
3000 } else if (tokens == 0 && token[i].type == JIM_TT_STR &&
3001 (!strcmp(token[i].objPtr->bytes, "expand") ||
3002 !strcmp(token[i].objPtr->bytes, "*")))
3009 /* Perform literal sharing, but only for objects that appear
3010 * to be scripts written as literals inside the source code,
3011 * and not computed at runtime. Literal sharing is a costly
3012 * operation that should be done only against objects that
3013 * are likely to require compilation only the first time, and
3014 * then are executed multiple times. */
3015 if (propagateSourceInfo && interp->framePtr->procBodyObjPtr) {
3016 Jim_Obj *bodyObjPtr = interp->framePtr->procBodyObjPtr;
3017 if (bodyObjPtr->typePtr == &scriptObjType) {
3018 ScriptObj *bodyScript =
3019 bodyObjPtr->internalRep.ptr;
3020 ScriptShareLiterals(interp, script, bodyScript);
3022 } else if (propagateSourceInfo) {
3023 ScriptShareLiterals(interp, script, NULL);
3025 /* Free the old internal rep and set the new one. */
3026 Jim_FreeIntRep(interp, objPtr);
3027 Jim_SetIntRepPtr(objPtr, script);
3028 objPtr->typePtr = &scriptObjType;
3032 ScriptObj *Jim_GetScript(Jim_Interp *interp, Jim_Obj *objPtr)
3034 if (objPtr->typePtr != &scriptObjType) {
3035 SetScriptFromAny(interp, objPtr);
3037 return (ScriptObj*) Jim_GetIntRepPtr(objPtr);
3040 /* -----------------------------------------------------------------------------
3042 * ---------------------------------------------------------------------------*/
3044 /* Commands HashTable Type.
3046 * Keys are dynamic allocated strings, Values are Jim_Cmd structures. */
3047 static void Jim_CommandsHT_ValDestructor(void *interp, void *val)
3049 Jim_Cmd *cmdPtr = (void*) val;
3051 if (cmdPtr->cmdProc == NULL) {
3052 Jim_DecrRefCount(interp, cmdPtr->argListObjPtr);
3053 Jim_DecrRefCount(interp, cmdPtr->bodyObjPtr);
3054 if (cmdPtr->staticVars) {
3055 Jim_FreeHashTable(cmdPtr->staticVars);
3056 Jim_Free(cmdPtr->staticVars);
3058 } else if (cmdPtr->delProc != NULL) {
3059 /* If it was a C coded command, call the delProc if any */
3060 cmdPtr->delProc(interp, cmdPtr->privData);
3065 static Jim_HashTableType JimCommandsHashTableType = {
3066 JimStringCopyHTHashFunction, /* hash function */
3067 JimStringCopyHTKeyDup, /* key dup */
3069 JimStringCopyHTKeyCompare, /* key compare */
3070 JimStringCopyHTKeyDestructor, /* key destructor */
3071 Jim_CommandsHT_ValDestructor /* val destructor */
3074 /* ------------------------- Commands related functions --------------------- */
3076 int Jim_CreateCommand(Jim_Interp *interp, const char *cmdName,
3077 Jim_CmdProc cmdProc, void *privData, Jim_DelCmdProc delProc)
3082 he = Jim_FindHashEntry(&interp->commands, cmdName);
3083 if (he == NULL) { /* New command to create */
3084 cmdPtr = Jim_Alloc(sizeof(*cmdPtr));
3085 cmdPtr->cmdProc = cmdProc;
3086 cmdPtr->privData = privData;
3087 cmdPtr->delProc = delProc;
3088 Jim_AddHashEntry(&interp->commands, cmdName, cmdPtr);
3090 Jim_InterpIncrProcEpoch(interp);
3091 /* Free the arglist/body objects if it was a Tcl procedure */
3093 if (cmdPtr->cmdProc == NULL) {
3094 Jim_DecrRefCount(interp, cmdPtr->argListObjPtr);
3095 Jim_DecrRefCount(interp, cmdPtr->bodyObjPtr);
3096 if (cmdPtr->staticVars) {
3097 Jim_FreeHashTable(cmdPtr->staticVars);
3098 Jim_Free(cmdPtr->staticVars);
3100 cmdPtr->staticVars = NULL;
3101 } else if (cmdPtr->delProc != NULL) {
3102 /* If it was a C coded command, call the delProc if any */
3103 cmdPtr->delProc(interp, cmdPtr->privData);
3105 cmdPtr->cmdProc = cmdProc;
3106 cmdPtr->privData = privData;
3108 /* There is no need to increment the 'proc epoch' because
3109 * creation of a new procedure can never affect existing
3110 * cached commands. We don't do negative caching. */
3114 int Jim_CreateProcedure(Jim_Interp *interp, const char *cmdName,
3115 Jim_Obj *argListObjPtr, Jim_Obj *staticsListObjPtr, Jim_Obj *bodyObjPtr,
3116 int arityMin, int arityMax)
3120 cmdPtr = Jim_Alloc(sizeof(*cmdPtr));
3121 cmdPtr->cmdProc = NULL; /* Not a C coded command */
3122 cmdPtr->argListObjPtr = argListObjPtr;
3123 cmdPtr->bodyObjPtr = bodyObjPtr;
3124 Jim_IncrRefCount(argListObjPtr);
3125 Jim_IncrRefCount(bodyObjPtr);
3126 cmdPtr->arityMin = arityMin;
3127 cmdPtr->arityMax = arityMax;
3128 cmdPtr->staticVars = NULL;
3130 /* Create the statics hash table. */
3131 if (staticsListObjPtr) {
3134 Jim_ListLength(interp, staticsListObjPtr, &len);
3136 cmdPtr->staticVars = Jim_Alloc(sizeof(Jim_HashTable));
3137 Jim_InitHashTable(cmdPtr->staticVars, &JimVariablesHashTableType,
3139 for (i = 0; i < len; i++) {
3140 Jim_Obj *objPtr, *initObjPtr, *nameObjPtr;
3144 Jim_ListIndex(interp, staticsListObjPtr, i, &objPtr, JIM_NONE);
3145 /* Check if it's composed of two elements. */
3146 Jim_ListLength(interp, objPtr, &subLen);
3147 if (subLen == 1 || subLen == 2) {
3148 /* Try to get the variable value from the current
3150 Jim_ListIndex(interp, objPtr, 0, &nameObjPtr, JIM_NONE);
3152 initObjPtr = Jim_GetVariable(interp, nameObjPtr,
3154 if (initObjPtr == NULL) {
3155 Jim_SetResult(interp,
3156 Jim_NewEmptyStringObj(interp));
3157 Jim_AppendStrings(interp, Jim_GetResult(interp),
3158 "variable for initialization of static \"",
3159 Jim_GetString(nameObjPtr, NULL),
3160 "\" not found in the local context",
3165 Jim_ListIndex(interp, objPtr, 1, &initObjPtr, JIM_NONE);
3167 varPtr = Jim_Alloc(sizeof(*varPtr));
3168 varPtr->objPtr = initObjPtr;
3169 Jim_IncrRefCount(initObjPtr);
3170 varPtr->linkFramePtr = NULL;
3171 if (Jim_AddHashEntry(cmdPtr->staticVars,
3172 Jim_GetString(nameObjPtr, NULL),
3175 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3176 Jim_AppendStrings(interp, Jim_GetResult(interp),
3177 "static variable name \"",
3178 Jim_GetString(objPtr, NULL), "\"",
3179 " duplicated in statics list", NULL);
3180 Jim_DecrRefCount(interp, initObjPtr);
3185 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3186 Jim_AppendStrings(interp, Jim_GetResult(interp),
3187 "too many fields in static specifier \"",
3188 objPtr, "\"", NULL);
3195 /* Add the new command */
3197 /* it may already exist, so we try to delete the old one */
3198 if (Jim_DeleteHashEntry(&interp->commands, cmdName) != JIM_ERR) {
3199 /* There was an old procedure with the same name, this requires
3200 * a 'proc epoch' update. */
3201 Jim_InterpIncrProcEpoch(interp);
3203 /* If a procedure with the same name didn't existed there is no need
3204 * to increment the 'proc epoch' because creation of a new procedure
3205 * can never affect existing cached commands. We don't do
3206 * negative caching. */
3207 Jim_AddHashEntry(&interp->commands, cmdName, cmdPtr);
3211 Jim_FreeHashTable(cmdPtr->staticVars);
3212 Jim_Free(cmdPtr->staticVars);
3213 Jim_DecrRefCount(interp, argListObjPtr);
3214 Jim_DecrRefCount(interp, bodyObjPtr);
3219 int Jim_DeleteCommand(Jim_Interp *interp, const char *cmdName)
3221 if (Jim_DeleteHashEntry(&interp->commands, cmdName) == JIM_ERR)
3223 Jim_InterpIncrProcEpoch(interp);
3227 int Jim_RenameCommand(Jim_Interp *interp, const char *oldName,
3228 const char *newName)
3232 Jim_Cmd *copyCmdPtr;
3234 if (newName[0] == '\0') /* Delete! */
3235 return Jim_DeleteCommand(interp, oldName);
3237 he = Jim_FindHashEntry(&interp->commands, oldName);
3239 return JIM_ERR; /* Invalid command name */
3241 copyCmdPtr = Jim_Alloc(sizeof(Jim_Cmd));
3242 *copyCmdPtr = *cmdPtr;
3243 /* In order to avoid that a procedure will get arglist/body/statics
3244 * freed by the hash table methods, fake a C-coded command
3245 * setting cmdPtr->cmdProc as not NULL */
3246 cmdPtr->cmdProc = (void*)1;
3247 /* Also make sure delProc is NULL. */
3248 cmdPtr->delProc = NULL;
3249 /* Destroy the old command, and make sure the new is freed
3251 Jim_DeleteHashEntry(&interp->commands, oldName);
3252 Jim_DeleteHashEntry(&interp->commands, newName);
3253 /* Now the new command. We are sure it can't fail because
3254 * the target name was already freed. */
3255 Jim_AddHashEntry(&interp->commands, newName, copyCmdPtr);
3256 /* Increment the epoch */
3257 Jim_InterpIncrProcEpoch(interp);
3261 /* -----------------------------------------------------------------------------
3263 * ---------------------------------------------------------------------------*/
3265 static int SetCommandFromAny(Jim_Interp *interp, struct Jim_Obj *objPtr);
3267 static Jim_ObjType commandObjType = {
3272 JIM_TYPE_REFERENCES,
3275 int SetCommandFromAny(Jim_Interp *interp, Jim_Obj *objPtr)
3278 const char *cmdName;
3280 /* Get the string representation */
3281 cmdName = Jim_GetString(objPtr, NULL);
3282 /* Lookup this name into the commands hash table */
3283 he = Jim_FindHashEntry(&interp->commands, cmdName);
3287 /* Free the old internal repr and set the new one. */
3288 Jim_FreeIntRep(interp, objPtr);
3289 objPtr->typePtr = &commandObjType;
3290 objPtr->internalRep.cmdValue.procEpoch = interp->procEpoch;
3291 objPtr->internalRep.cmdValue.cmdPtr = (void*)he->val;
3295 /* This function returns the command structure for the command name
3296 * stored in objPtr. It tries to specialize the objPtr to contain
3297 * a cached info instead to perform the lookup into the hash table
3298 * every time. The information cached may not be uptodate, in such
3299 * a case the lookup is performed and the cache updated. */
3300 Jim_Cmd *Jim_GetCommand(Jim_Interp *interp, Jim_Obj *objPtr, int flags)
3302 if ((objPtr->typePtr != &commandObjType ||
3303 objPtr->internalRep.cmdValue.procEpoch != interp->procEpoch) &&
3304 SetCommandFromAny(interp, objPtr) == JIM_ERR) {
3305 if (flags & JIM_ERRMSG) {
3306 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3307 Jim_AppendStrings(interp, Jim_GetResult(interp),
3308 "invalid command name \"", objPtr->bytes, "\"",
3313 return objPtr->internalRep.cmdValue.cmdPtr;
3316 /* -----------------------------------------------------------------------------
3318 * ---------------------------------------------------------------------------*/
3320 /* Variables HashTable Type.
3322 * Keys are dynamic allocated strings, Values are Jim_Var structures. */
3323 static void JimVariablesHTValDestructor(void *interp, void *val)
3325 Jim_Var *varPtr = (void*) val;
3327 Jim_DecrRefCount(interp, varPtr->objPtr);
3331 static Jim_HashTableType JimVariablesHashTableType = {
3332 JimStringCopyHTHashFunction, /* hash function */
3333 JimStringCopyHTKeyDup, /* key dup */
3335 JimStringCopyHTKeyCompare, /* key compare */
3336 JimStringCopyHTKeyDestructor, /* key destructor */
3337 JimVariablesHTValDestructor /* val destructor */
3340 /* -----------------------------------------------------------------------------
3342 * ---------------------------------------------------------------------------*/
3344 #define JIM_DICT_SUGAR 100 /* Only returned by SetVariableFromAny() */
3346 static int SetVariableFromAny(Jim_Interp *interp, struct Jim_Obj *objPtr);
3348 static Jim_ObjType variableObjType = {
3353 JIM_TYPE_REFERENCES,
3356 /* Return true if the string "str" looks like syntax sugar for [dict]. I.e.
3357 * is in the form "varname(key)". */
3358 static int Jim_NameIsDictSugar(const char *str, int len)
3362 if (len && str[len-1] == ')' && strchr(str, '(') != NULL)
3367 /* This method should be called only by the variable API.
3368 * It returns JIM_OK on success (variable already exists),
3369 * JIM_ERR if it does not exists, JIM_DICT_GLUE if it's not
3370 * a variable name, but syntax glue for [dict] i.e. the last
3371 * character is ')' */
3372 int SetVariableFromAny(Jim_Interp *interp, struct Jim_Obj *objPtr)
3375 const char *varName;
3378 /* Check if the object is already an uptodate variable */
3379 if (objPtr->typePtr == &variableObjType &&
3380 objPtr->internalRep.varValue.callFrameId == interp->framePtr->id)
3381 return JIM_OK; /* nothing to do */
3382 /* Get the string representation */
3383 varName = Jim_GetString(objPtr, &len);
3384 /* Make sure it's not syntax glue to get/set dict. */
3385 if (Jim_NameIsDictSugar(varName, len))
3386 return JIM_DICT_SUGAR;
3387 /* Lookup this name into the variables hash table */
3388 he = Jim_FindHashEntry(&interp->framePtr->vars, varName);
3390 /* Try with static vars. */
3391 if (interp->framePtr->staticVars == NULL)
3393 if (!(he = Jim_FindHashEntry(interp->framePtr->staticVars, varName)))
3396 /* Free the old internal repr and set the new one. */
3397 Jim_FreeIntRep(interp, objPtr);
3398 objPtr->typePtr = &variableObjType;
3399 objPtr->internalRep.varValue.callFrameId = interp->framePtr->id;
3400 objPtr->internalRep.varValue.varPtr = (void*)he->val;
3404 /* -------------------- Variables related functions ------------------------- */
3405 static int JimDictSugarSet(Jim_Interp *interp, Jim_Obj *ObjPtr,
3406 Jim_Obj *valObjPtr);
3407 static Jim_Obj *JimDictSugarGet(Jim_Interp *interp, Jim_Obj *ObjPtr);
3409 /* For now that's dummy. Variables lookup should be optimized
3410 * in many ways, with caching of lookups, and possibly with
3411 * a table of pre-allocated vars in every CallFrame for local vars.
3412 * All the caching should also have an 'epoch' mechanism similar
3413 * to the one used by Tcl for procedures lookup caching. */
3415 int Jim_SetVariable(Jim_Interp *interp, Jim_Obj *nameObjPtr, Jim_Obj *valObjPtr)
3421 if ((err = SetVariableFromAny(interp, nameObjPtr)) != JIM_OK) {
3422 /* Check for [dict] syntax sugar. */
3423 if (err == JIM_DICT_SUGAR)
3424 return JimDictSugarSet(interp, nameObjPtr, valObjPtr);
3425 /* New variable to create */
3426 name = Jim_GetString(nameObjPtr, NULL);
3428 var = Jim_Alloc(sizeof(*var));
3429 var->objPtr = valObjPtr;
3430 Jim_IncrRefCount(valObjPtr);
3431 var->linkFramePtr = NULL;
3432 /* Insert the new variable */
3433 Jim_AddHashEntry(&interp->framePtr->vars, name, var);
3434 /* Make the object int rep a variable */
3435 Jim_FreeIntRep(interp, nameObjPtr);
3436 nameObjPtr->typePtr = &variableObjType;
3437 nameObjPtr->internalRep.varValue.callFrameId =
3438 interp->framePtr->id;
3439 nameObjPtr->internalRep.varValue.varPtr = var;
3441 var = nameObjPtr->internalRep.varValue.varPtr;
3442 if (var->linkFramePtr == NULL) {
3443 Jim_IncrRefCount(valObjPtr);
3444 Jim_DecrRefCount(interp, var->objPtr);
3445 var->objPtr = valObjPtr;
3446 } else { /* Else handle the link */
3447 Jim_CallFrame *savedCallFrame;
3449 savedCallFrame = interp->framePtr;
3450 interp->framePtr = var->linkFramePtr;
3451 err = Jim_SetVariable(interp, var->objPtr, valObjPtr);
3452 interp->framePtr = savedCallFrame;
3460 int Jim_SetVariableStr(Jim_Interp *interp, const char *name, Jim_Obj *objPtr)
3462 Jim_Obj *nameObjPtr;
3465 nameObjPtr = Jim_NewStringObj(interp, name, -1);
3466 Jim_IncrRefCount(nameObjPtr);
3467 result = Jim_SetVariable(interp, nameObjPtr, objPtr);
3468 Jim_DecrRefCount(interp, nameObjPtr);
3472 int Jim_SetGlobalVariableStr(Jim_Interp *interp, const char *name, Jim_Obj *objPtr)
3474 Jim_CallFrame *savedFramePtr;
3477 savedFramePtr = interp->framePtr;
3478 interp->framePtr = interp->topFramePtr;
3479 result = Jim_SetVariableStr(interp, name, objPtr);
3480 interp->framePtr = savedFramePtr;
3484 int Jim_SetVariableStrWithStr(Jim_Interp *interp, const char *name, const char *val)
3486 Jim_Obj *nameObjPtr, *valObjPtr;
3489 nameObjPtr = Jim_NewStringObj(interp, name, -1);
3490 valObjPtr = Jim_NewStringObj(interp, val, -1);
3491 Jim_IncrRefCount(nameObjPtr);
3492 Jim_IncrRefCount(valObjPtr);
3493 result = Jim_SetVariable(interp, nameObjPtr, valObjPtr);
3494 Jim_DecrRefCount(interp, nameObjPtr);
3495 Jim_DecrRefCount(interp, valObjPtr);
3499 int Jim_SetVariableLink(Jim_Interp *interp, Jim_Obj *nameObjPtr,
3500 Jim_Obj *targetNameObjPtr, Jim_CallFrame *targetCallFrame)
3502 const char *varName;
3505 /* Check for cycles. */
3506 if (interp->framePtr == targetCallFrame) {
3507 Jim_Obj *objPtr = targetNameObjPtr;
3509 /* Cycles are only possible with 'uplevel 0' */
3511 if (Jim_StringEqObj(objPtr, nameObjPtr, 0)) {
3512 Jim_SetResultString(interp,
3513 "can't upvar from variable to itself", -1);
3516 if (SetVariableFromAny(interp, objPtr) != JIM_OK)
3518 varPtr = objPtr->internalRep.varValue.varPtr;
3519 if (varPtr->linkFramePtr != targetCallFrame) break;
3520 objPtr = varPtr->objPtr;
3523 varName = Jim_GetString(nameObjPtr, &len);
3524 if (Jim_NameIsDictSugar(varName, len)) {
3525 Jim_SetResultString(interp,
3526 "Dict key syntax invalid as link source", -1);
3529 /* Perform the binding */
3530 Jim_SetVariable(interp, nameObjPtr, targetNameObjPtr);
3531 /* We are now sure 'nameObjPtr' type is variableObjType */
3532 nameObjPtr->internalRep.varValue.varPtr->linkFramePtr = targetCallFrame;
3536 /* Return the Jim_Obj pointer associated with a variable name,
3537 * or NULL if the variable was not found in the current context.
3538 * The same optimization discussed in the comment to the
3539 * 'SetVariable' function should apply here. */
3540 Jim_Obj *Jim_GetVariable(Jim_Interp *interp, Jim_Obj *nameObjPtr, int flags)
3544 /* All the rest is handled here */
3545 if ((err = SetVariableFromAny(interp, nameObjPtr)) != JIM_OK) {
3546 /* Check for [dict] syntax sugar. */
3547 if (err == JIM_DICT_SUGAR)
3548 return JimDictSugarGet(interp, nameObjPtr);
3549 if (flags & JIM_ERRMSG) {
3550 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3551 Jim_AppendStrings(interp, Jim_GetResult(interp),
3552 "can't read \"", nameObjPtr->bytes,
3553 "\": no such variable", NULL);
3559 Jim_CallFrame *savedCallFrame;
3561 varPtr = nameObjPtr->internalRep.varValue.varPtr;
3562 if (varPtr->linkFramePtr == NULL)
3563 return varPtr->objPtr;
3564 /* The variable is a link? Resolve it. */
3565 savedCallFrame = interp->framePtr;
3566 interp->framePtr = varPtr->linkFramePtr;
3567 objPtr = Jim_GetVariable(interp, varPtr->objPtr, JIM_NONE);
3568 if (objPtr == NULL && flags & JIM_ERRMSG) {
3569 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3570 Jim_AppendStrings(interp, Jim_GetResult(interp),
3571 "can't read \"", nameObjPtr->bytes,
3572 "\": no such variable", NULL);
3574 interp->framePtr = savedCallFrame;
3579 Jim_Obj *Jim_GetGlobalVariable(Jim_Interp *interp, Jim_Obj *nameObjPtr,
3582 Jim_CallFrame *savedFramePtr;
3585 savedFramePtr = interp->framePtr;
3586 interp->framePtr = interp->topFramePtr;
3587 objPtr = Jim_GetVariable(interp, nameObjPtr, flags);
3588 interp->framePtr = savedFramePtr;
3593 Jim_Obj *Jim_GetVariableStr(Jim_Interp *interp, const char *name, int flags)
3595 Jim_Obj *nameObjPtr, *varObjPtr;
3597 nameObjPtr = Jim_NewStringObj(interp, name, -1);
3598 Jim_IncrRefCount(nameObjPtr);
3599 varObjPtr = Jim_GetVariable(interp, nameObjPtr, flags);
3600 Jim_DecrRefCount(interp, nameObjPtr);
3604 Jim_Obj *Jim_GetGlobalVariableStr(Jim_Interp *interp, const char *name,
3607 Jim_CallFrame *savedFramePtr;
3610 savedFramePtr = interp->framePtr;
3611 interp->framePtr = interp->topFramePtr;
3612 objPtr = Jim_GetVariableStr(interp, name, flags);
3613 interp->framePtr = savedFramePtr;
3618 /* Unset a variable.
3619 * Note: On success unset invalidates all the variable objects created
3620 * in the current call frame incrementing. */
3621 int Jim_UnsetVariable(Jim_Interp *interp, Jim_Obj *nameObjPtr, int flags)
3627 if ((err = SetVariableFromAny(interp, nameObjPtr)) != JIM_OK) {
3628 /* Check for [dict] syntax sugar. */
3629 if (err == JIM_DICT_SUGAR)
3630 return JimDictSugarSet(interp, nameObjPtr, NULL);
3631 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3632 Jim_AppendStrings(interp, Jim_GetResult(interp),
3633 "can't unset \"", nameObjPtr->bytes,
3634 "\": no such variable", NULL);
3635 return JIM_ERR; /* var not found */
3637 varPtr = nameObjPtr->internalRep.varValue.varPtr;
3638 /* If it's a link call UnsetVariable recursively */
3639 if (varPtr->linkFramePtr) {
3642 Jim_CallFrame *savedCallFrame;
3644 savedCallFrame = interp->framePtr;
3645 interp->framePtr = varPtr->linkFramePtr;
3646 retval = Jim_UnsetVariable(interp, varPtr->objPtr, JIM_NONE);
3647 interp->framePtr = savedCallFrame;
3648 if (retval != JIM_OK && flags & JIM_ERRMSG) {
3649 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
3650 Jim_AppendStrings(interp, Jim_GetResult(interp),
3651 "can't unset \"", nameObjPtr->bytes,
3652 "\": no such variable", NULL);
3656 name = Jim_GetString(nameObjPtr, NULL);
3657 if (Jim_DeleteHashEntry(&interp->framePtr->vars, name)
3658 != JIM_OK) return JIM_ERR;
3659 /* Change the callframe id, invalidating var lookup caching */
3660 JimChangeCallFrameId(interp, interp->framePtr);
3665 /* ---------- Dict syntax sugar (similar to array Tcl syntax) -------------- */
3667 /* Given a variable name for [dict] operation syntax sugar,
3668 * this function returns two objects, the first with the name
3669 * of the variable to set, and the second with the rispective key.
3670 * For example "foo(bar)" will return objects with string repr. of
3673 * The returned objects have refcount = 1. The function can't fail. */
3674 static void JimDictSugarParseVarKey(Jim_Interp *interp, Jim_Obj *objPtr,
3675 Jim_Obj **varPtrPtr, Jim_Obj **keyPtrPtr)
3677 const char *str, *p;
3679 int len, keyLen, nameLen;
3680 Jim_Obj *varObjPtr, *keyObjPtr;
3682 str = Jim_GetString(objPtr, &len);
3683 p = strchr(str, '(');
3685 keyLen = len-((p-str)+1);
3686 nameLen = (p-str)-1;
3687 /* Create the objects with the variable name and key. */
3688 t = Jim_Alloc(nameLen+1);
3689 memcpy(t, str, nameLen);
3691 varObjPtr = Jim_NewStringObjNoAlloc(interp, t, nameLen);
3693 t = Jim_Alloc(keyLen+1);
3694 memcpy(t, p, keyLen);
3696 keyObjPtr = Jim_NewStringObjNoAlloc(interp, t, keyLen);
3698 Jim_IncrRefCount(varObjPtr);
3699 Jim_IncrRefCount(keyObjPtr);
3700 *varPtrPtr = varObjPtr;
3701 *keyPtrPtr = keyObjPtr;
3704 /* Helper of Jim_SetVariable() to deal with dict-syntax variable names.
3705 * Also used by Jim_UnsetVariable() with valObjPtr = NULL. */
3706 static int JimDictSugarSet(Jim_Interp *interp, Jim_Obj *objPtr,
3709 Jim_Obj *varObjPtr, *keyObjPtr;
3712 JimDictSugarParseVarKey(interp, objPtr, &varObjPtr, &keyObjPtr);
3713 err = Jim_SetDictKeysVector(interp, varObjPtr, &keyObjPtr, 1,
3715 Jim_DecrRefCount(interp, varObjPtr);
3716 Jim_DecrRefCount(interp, keyObjPtr);
3720 /* Helper of Jim_GetVariable() to deal with dict-syntax variable names */
3721 static Jim_Obj *JimDictSugarGet(Jim_Interp *interp, Jim_Obj *objPtr)
3723 Jim_Obj *varObjPtr, *keyObjPtr, *dictObjPtr, *resObjPtr;
3725 JimDictSugarParseVarKey(interp, objPtr, &varObjPtr, &keyObjPtr);
3726 dictObjPtr = Jim_GetVariable(interp, varObjPtr, JIM_ERRMSG);
3731 if (Jim_DictKey(interp, dictObjPtr, keyObjPtr, &resObjPtr, JIM_ERRMSG)
3736 Jim_DecrRefCount(interp, varObjPtr);
3737 Jim_DecrRefCount(interp, keyObjPtr);
3741 /* --------- $var(INDEX) substitution, using a specialized object ----------- */
3743 static void FreeDictSubstInternalRep(Jim_Interp *interp, Jim_Obj *objPtr);
3744 static void DupDictSubstInternalRep(Jim_Interp *interp, Jim_Obj *srcPtr,
3747 static Jim_ObjType dictSubstObjType = {
3748 "dict-substitution",
3749 FreeDictSubstInternalRep,
3750 DupDictSubstInternalRep,
3755 void FreeDictSubstInternalRep(Jim_Interp *interp, Jim_Obj *objPtr)
3757 Jim_DecrRefCount(interp, objPtr->internalRep.dictSubstValue.varNameObjPtr);
3758 Jim_DecrRefCount(interp, objPtr->internalRep.dictSubstValue.indexObjPtr);
3761 void DupDictSubstInternalRep(Jim_Interp *interp, Jim_Obj *srcPtr,
3764 JIM_NOTUSED(interp);
3766 dupPtr->internalRep.dictSubstValue.varNameObjPtr =
3767 srcPtr->internalRep.dictSubstValue.varNameObjPtr;
3768 dupPtr->internalRep.dictSubstValue.indexObjPtr =
3769 srcPtr->internalRep.dictSubstValue.indexObjPtr;
3770 dupPtr->typePtr = &dictSubstObjType;
3773 /* This function is used to expand [dict get] sugar in the form
3774 * of $var(INDEX). The function is mainly used by Jim_EvalObj()
3775 * to deal with tokens of type JIM_TT_DICTSUGAR. objPtr points to an
3776 * object that is *guaranteed* to be in the form VARNAME(INDEX).
3777 * The 'index' part is [subst]ituted, and is used to lookup a key inside
3778 * the [dict]ionary contained in variable VARNAME. */
3779 Jim_Obj *Jim_ExpandDictSugar(Jim_Interp *interp, Jim_Obj *objPtr)
3781 Jim_Obj *varObjPtr, *keyObjPtr, *dictObjPtr, *resObjPtr;
3782 Jim_Obj *substKeyObjPtr = NULL;
3784 if (objPtr->typePtr != &dictSubstObjType) {
3785 JimDictSugarParseVarKey(interp, objPtr, &varObjPtr, &keyObjPtr);
3786 Jim_FreeIntRep(interp, objPtr);
3787 objPtr->typePtr = &dictSubstObjType;
3788 objPtr->internalRep.dictSubstValue.varNameObjPtr = varObjPtr;
3789 objPtr->internalRep.dictSubstValue.indexObjPtr = keyObjPtr;
3791 if (Jim_SubstObj(interp, objPtr->internalRep.dictSubstValue.indexObjPtr,
3792 &substKeyObjPtr, JIM_NONE)
3794 substKeyObjPtr = NULL;
3797 Jim_IncrRefCount(substKeyObjPtr);
3798 dictObjPtr = Jim_GetVariable(interp,
3799 objPtr->internalRep.dictSubstValue.varNameObjPtr, JIM_ERRMSG);
3804 if (Jim_DictKey(interp, dictObjPtr, substKeyObjPtr, &resObjPtr, JIM_ERRMSG)
3810 if (substKeyObjPtr) Jim_DecrRefCount(interp, substKeyObjPtr);
3814 /* -----------------------------------------------------------------------------
3816 * ---------------------------------------------------------------------------*/
3818 static Jim_CallFrame *JimCreateCallFrame(Jim_Interp *interp)
3821 if (interp->freeFramesList) {
3822 cf = interp->freeFramesList;
3823 interp->freeFramesList = cf->nextFramePtr;
3825 cf = Jim_Alloc(sizeof(*cf));
3826 cf->vars.table = NULL;
3829 cf->id = interp->callFrameEpoch++;
3830 cf->parentCallFrame = NULL;
3833 cf->procArgsObjPtr = NULL;
3834 cf->procBodyObjPtr = NULL;
3835 cf->nextFramePtr = NULL;
3836 cf->staticVars = NULL;
3837 if (cf->vars.table == NULL)
3838 Jim_InitHashTable(&cf->vars, &JimVariablesHashTableType, interp);
3842 /* Used to invalidate every caching related to callframe stability. */
3843 static void JimChangeCallFrameId(Jim_Interp *interp, Jim_CallFrame *cf)
3845 cf->id = interp->callFrameEpoch++;
3848 #define JIM_FCF_NONE 0 /* no flags */
3849 #define JIM_FCF_NOHT 1 /* don't free the hash table */
3850 static void JimFreeCallFrame(Jim_Interp *interp, Jim_CallFrame *cf,
3853 if (cf->procArgsObjPtr) Jim_DecrRefCount(interp, cf->procArgsObjPtr);
3854 if (cf->procBodyObjPtr) Jim_DecrRefCount(interp, cf->procBodyObjPtr);
3855 if (!(flags & JIM_FCF_NOHT))
3856 Jim_FreeHashTable(&cf->vars);
3859 Jim_HashEntry **table = cf->vars.table, *he;
3861 for (i = 0; i < JIM_HT_INITIAL_SIZE; i++) {
3863 while (he != NULL) {
3864 Jim_HashEntry *nextEntry = he->next;
3865 Jim_Var *varPtr = (void*) he->val;
3867 Jim_DecrRefCount(interp, varPtr->objPtr);
3869 Jim_Free((void*)he->key); /* ATTENTION: const cast */
3877 cf->nextFramePtr = interp->freeFramesList;
3878 interp->freeFramesList = cf;
3881 /* -----------------------------------------------------------------------------
3883 * ---------------------------------------------------------------------------*/
3885 /* References HashTable Type.
3887 * Keys are jim_wide integers, dynamically allocated for now but in the
3888 * future it's worth to cache this 8 bytes objects. Values are poitners
3889 * to Jim_References. */
3890 static void JimReferencesHTValDestructor(void *interp, void *val)
3892 Jim_Reference *refPtr = (void*) val;
3894 Jim_DecrRefCount(interp, refPtr->objPtr);
3895 if (refPtr->finalizerCmdNamePtr != NULL) {
3896 Jim_DecrRefCount(interp, refPtr->finalizerCmdNamePtr);
3901 unsigned int JimReferencesHTHashFunction(const void *key)
3903 /* Only the least significant bits are used. */
3904 const jim_wide *widePtr = key;
3905 unsigned int intValue = (unsigned int) *widePtr;
3906 return Jim_IntHashFunction(intValue);
3909 unsigned int JimReferencesHTDoubleHashFunction(const void *key)
3911 /* Only the least significant bits are used. */
3912 const jim_wide *widePtr = key;
3913 unsigned int intValue = (unsigned int) *widePtr;
3914 return intValue; /* identity function. */
3917 const void *JimReferencesHTKeyDup(void *privdata, const void *key)
3919 void *copy = Jim_Alloc(sizeof(jim_wide));
3920 JIM_NOTUSED(privdata);
3922 memcpy(copy, key, sizeof(jim_wide));
3926 int JimReferencesHTKeyCompare(void *privdata, const void *key1,
3929 JIM_NOTUSED(privdata);
3931 return memcmp(key1, key2, sizeof(jim_wide)) == 0;
3934 void JimReferencesHTKeyDestructor(void *privdata, const void *key)
3936 JIM_NOTUSED(privdata);
3938 Jim_Free((void*)key);
3941 static Jim_HashTableType JimReferencesHashTableType = {
3942 JimReferencesHTHashFunction, /* hash function */
3943 JimReferencesHTKeyDup, /* key dup */
3945 JimReferencesHTKeyCompare, /* key compare */
3946 JimReferencesHTKeyDestructor, /* key destructor */
3947 JimReferencesHTValDestructor /* val destructor */
3950 /* -----------------------------------------------------------------------------
3951 * Reference object type and References API
3952 * ---------------------------------------------------------------------------*/
3954 static void UpdateStringOfReference(struct Jim_Obj *objPtr);
3956 static Jim_ObjType referenceObjType = {
3960 UpdateStringOfReference,
3961 JIM_TYPE_REFERENCES,
3964 void UpdateStringOfReference(struct Jim_Obj *objPtr)
3967 char buf[JIM_REFERENCE_SPACE+1];
3968 Jim_Reference *refPtr;
3970 refPtr = objPtr->internalRep.refValue.refPtr;
3971 len = JimFormatReference(buf, refPtr, objPtr->internalRep.refValue.id);
3972 objPtr->bytes = Jim_Alloc(len+1);
3973 memcpy(objPtr->bytes, buf, len+1);
3974 objPtr->length = len;
3977 /* returns true if 'c' is a valid reference tag character.
3978 * i.e. inside the range [_a-zA-Z0-9] */
3979 static int isrefchar(int c)
3981 if (c == '_' || (c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z') ||
3982 (c >= '0' && c <= '9')) return 1;
3986 int SetReferenceFromAny(Jim_Interp *interp, Jim_Obj *objPtr)
3990 const char *str, *start, *end;
3992 Jim_Reference *refPtr;
3995 /* Get the string representation */
3996 str = Jim_GetString(objPtr, &len);
3997 /* Check if it looks like a reference */
3998 if (len < JIM_REFERENCE_SPACE) goto badformat;
4002 while (*start == ' ') start++;
4003 while (*end == ' ' && end > start) end--;
4004 if (end-start+1 != JIM_REFERENCE_SPACE) goto badformat;
4005 /* <reference.<1234567>.%020> */
4006 if (memcmp(start, "<reference.<", 12) != 0) goto badformat;
4007 if (start[12+JIM_REFERENCE_TAGLEN] != '>' || end[0] != '>') goto badformat;
4008 /* The tag can't contain chars other than a-zA-Z0-9 + '_'. */
4009 for (i = 0; i < JIM_REFERENCE_TAGLEN; i++) {
4010 if (!isrefchar(start[12+i])) goto badformat;
4012 /* Extract info from the refernece. */
4013 memcpy(refId, start+14+JIM_REFERENCE_TAGLEN, 20);
4015 /* Try to convert the ID into a jim_wide */
4016 if (Jim_StringToWide(refId, &wideValue, 10) != JIM_OK) goto badformat;
4017 /* Check if the reference really exists! */
4018 he = Jim_FindHashEntry(&interp->references, &wideValue);
4020 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4021 Jim_AppendStrings(interp, Jim_GetResult(interp),
4022 "Invalid reference ID \"", str, "\"", NULL);
4026 /* Free the old internal repr and set the new one. */
4027 Jim_FreeIntRep(interp, objPtr);
4028 objPtr->typePtr = &referenceObjType;
4029 objPtr->internalRep.refValue.id = wideValue;
4030 objPtr->internalRep.refValue.refPtr = refPtr;
4034 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4035 Jim_AppendStrings(interp, Jim_GetResult(interp),
4036 "expected reference but got \"", str, "\"", NULL);
4040 /* Returns a new reference pointing to objPtr, having cmdNamePtr
4041 * as finalizer command (or NULL if there is no finalizer).
4042 * The returned reference object has refcount = 0. */
4043 Jim_Obj *Jim_NewReference(Jim_Interp *interp, Jim_Obj *objPtr, Jim_Obj *tagPtr,
4044 Jim_Obj *cmdNamePtr)
4046 struct Jim_Reference *refPtr;
4047 jim_wide wideValue = interp->referenceNextId;
4052 /* Perform the Garbage Collection if needed. */
4053 Jim_CollectIfNeeded(interp);
4055 refPtr = Jim_Alloc(sizeof(*refPtr));
4056 refPtr->objPtr = objPtr;
4057 Jim_IncrRefCount(objPtr);
4058 refPtr->finalizerCmdNamePtr = cmdNamePtr;
4060 Jim_IncrRefCount(cmdNamePtr);
4061 Jim_AddHashEntry(&interp->references, &wideValue, refPtr);
4062 refObjPtr = Jim_NewObj(interp);
4063 refObjPtr->typePtr = &referenceObjType;
4064 refObjPtr->bytes = NULL;
4065 refObjPtr->internalRep.refValue.id = interp->referenceNextId;
4066 refObjPtr->internalRep.refValue.refPtr = refPtr;
4067 interp->referenceNextId++;
4068 /* Set the tag. Trimmered at JIM_REFERENCE_TAGLEN. Everything
4069 * that does not pass the 'isrefchar' test is replaced with '_' */
4070 tag = Jim_GetString(tagPtr, &tagLen);
4071 if (tagLen > JIM_REFERENCE_TAGLEN)
4072 tagLen = JIM_REFERENCE_TAGLEN;
4073 for (i = 0; i < JIM_REFERENCE_TAGLEN; i++) {
4075 refPtr->tag[i] = tag[i];
4077 refPtr->tag[i] = '_';
4079 refPtr->tag[JIM_REFERENCE_TAGLEN] = '\0';
4083 Jim_Reference *Jim_GetReference(Jim_Interp *interp, Jim_Obj *objPtr)
4085 if (objPtr->typePtr != &referenceObjType &&
4086 SetReferenceFromAny(interp, objPtr) == JIM_ERR)
4088 return objPtr->internalRep.refValue.refPtr;
4091 int Jim_SetFinalizer(Jim_Interp *interp, Jim_Obj *objPtr, Jim_Obj *cmdNamePtr)
4093 Jim_Reference *refPtr;
4095 if ((refPtr = Jim_GetReference(interp, objPtr)) == NULL)
4097 Jim_IncrRefCount(cmdNamePtr);
4098 if (refPtr->finalizerCmdNamePtr)
4099 Jim_DecrRefCount(interp, refPtr->finalizerCmdNamePtr);
4100 refPtr->finalizerCmdNamePtr = cmdNamePtr;
4104 int Jim_GetFinalizer(Jim_Interp *interp, Jim_Obj *objPtr, Jim_Obj **cmdNamePtrPtr)
4106 Jim_Reference *refPtr;
4108 if ((refPtr = Jim_GetReference(interp, objPtr)) == NULL)
4110 *cmdNamePtrPtr = refPtr->finalizerCmdNamePtr;
4114 /* -----------------------------------------------------------------------------
4115 * References Garbage Collection
4116 * ---------------------------------------------------------------------------*/
4118 /* This the hash table type for the "MARK" phase of the GC */
4119 static Jim_HashTableType JimRefMarkHashTableType = {
4120 JimReferencesHTHashFunction, /* hash function */
4121 JimReferencesHTKeyDup, /* key dup */
4123 JimReferencesHTKeyCompare, /* key compare */
4124 JimReferencesHTKeyDestructor, /* key destructor */
4125 NULL /* val destructor */
4128 /* #define JIM_DEBUG_GC 1 */
4130 /* Performs the garbage collection. */
4131 int Jim_Collect(Jim_Interp *interp)
4133 Jim_HashTable marks;
4134 Jim_HashTableIterator *htiter;
4139 /* Avoid recursive calls */
4140 if (interp->lastCollectId == -1) {
4141 /* Jim_Collect() already running. Return just now. */
4144 interp->lastCollectId = -1;
4146 /* Mark all the references found into the 'mark' hash table.
4147 * The references are searched in every live object that
4148 * is of a type that can contain references. */
4149 Jim_InitHashTable(&marks, &JimRefMarkHashTableType, NULL);
4150 objPtr = interp->liveList;
4152 if (objPtr->typePtr == NULL ||
4153 objPtr->typePtr->flags & JIM_TYPE_REFERENCES) {
4154 const char *str, *p;
4157 /* If the object is of type reference, to get the
4158 * Id is simple... */
4159 if (objPtr->typePtr == &referenceObjType) {
4160 Jim_AddHashEntry(&marks,
4161 &objPtr->internalRep.refValue.id, NULL);
4163 Jim_fprintf(interp,interp->cookie_stdout,
4164 "MARK (reference): %d refcount: %d" JIM_NL,
4165 (int) objPtr->internalRep.refValue.id,
4168 objPtr = objPtr->nextObjPtr;
4171 /* Get the string repr of the object we want
4172 * to scan for references. */
4173 p = str = Jim_GetString(objPtr, &len);
4174 /* Skip objects too little to contain references. */
4175 if (len < JIM_REFERENCE_SPACE) {
4176 objPtr = objPtr->nextObjPtr;
4179 /* Extract references from the object string repr. */
4185 if ((p = strstr(p, "<reference.<")) == NULL)
4187 /* Check if it's a valid reference. */
4188 if (len-(p-str) < JIM_REFERENCE_SPACE) break;
4189 if (p[41] != '>' || p[19] != '>' || p[20] != '.') break;
4190 for (i = 21; i <= 40; i++)
4191 if (!isdigit((int)p[i]))
4194 memcpy(buf, p+21, 20);
4196 Jim_StringToWide(buf, &id, 10);
4198 /* Ok, a reference for the given ID
4199 * was found. Mark it. */
4200 Jim_AddHashEntry(&marks, &id, NULL);
4202 Jim_fprintf(interp,interp->cookie_stdout,"MARK: %d" JIM_NL, (int)id);
4204 p += JIM_REFERENCE_SPACE;
4207 objPtr = objPtr->nextObjPtr;
4210 /* Run the references hash table to destroy every reference that
4211 * is not referenced outside (not present in the mark HT). */
4212 htiter = Jim_GetHashTableIterator(&interp->references);
4213 while ((he = Jim_NextHashEntry(htiter)) != NULL) {
4214 const jim_wide *refId;
4215 Jim_Reference *refPtr;
4218 /* Check if in the mark phase we encountered
4219 * this reference. */
4220 if (Jim_FindHashEntry(&marks, refId) == NULL) {
4222 Jim_fprintf(interp,interp->cookie_stdout,"COLLECTING %d" JIM_NL, (int)*refId);
4225 /* Drop the reference, but call the
4226 * finalizer first if registered. */
4228 if (refPtr->finalizerCmdNamePtr) {
4229 char *refstr = Jim_Alloc(JIM_REFERENCE_SPACE+1);
4230 Jim_Obj *objv[3], *oldResult;
4232 JimFormatReference(refstr, refPtr, *refId);
4234 objv[0] = refPtr->finalizerCmdNamePtr;
4235 objv[1] = Jim_NewStringObjNoAlloc(interp,
4237 objv[2] = refPtr->objPtr;
4238 Jim_IncrRefCount(objv[0]);
4239 Jim_IncrRefCount(objv[1]);
4240 Jim_IncrRefCount(objv[2]);
4242 /* Drop the reference itself */
4243 Jim_DeleteHashEntry(&interp->references, refId);
4245 /* Call the finalizer. Errors ignored. */
4246 oldResult = interp->result;
4247 Jim_IncrRefCount(oldResult);
4248 Jim_EvalObjVector(interp, 3, objv);
4249 Jim_SetResult(interp, oldResult);
4250 Jim_DecrRefCount(interp, oldResult);
4252 Jim_DecrRefCount(interp, objv[0]);
4253 Jim_DecrRefCount(interp, objv[1]);
4254 Jim_DecrRefCount(interp, objv[2]);
4256 Jim_DeleteHashEntry(&interp->references, refId);
4260 Jim_FreeHashTableIterator(htiter);
4261 Jim_FreeHashTable(&marks);
4262 interp->lastCollectId = interp->referenceNextId;
4263 interp->lastCollectTime = time(NULL);
4267 #define JIM_COLLECT_ID_PERIOD 5000
4268 #define JIM_COLLECT_TIME_PERIOD 300
4270 void Jim_CollectIfNeeded(Jim_Interp *interp)
4275 elapsedId = interp->referenceNextId - interp->lastCollectId;
4276 elapsedTime = time(NULL) - interp->lastCollectTime;
4279 if (elapsedId > JIM_COLLECT_ID_PERIOD ||
4280 elapsedTime > JIM_COLLECT_TIME_PERIOD) {
4281 Jim_Collect(interp);
4285 /* -----------------------------------------------------------------------------
4286 * Interpreter related functions
4287 * ---------------------------------------------------------------------------*/
4289 Jim_Interp *Jim_CreateInterp(void)
4291 Jim_Interp *i = Jim_Alloc(sizeof(*i));
4295 i->errorFileName = Jim_StrDup("");
4297 i->maxNestingDepth = JIM_MAX_NESTING_DEPTH;
4298 i->returnCode = JIM_OK;
4301 i->callFrameEpoch = 0;
4302 i->liveList = i->freeList = NULL;
4303 i->scriptFileName = Jim_StrDup("");
4304 i->referenceNextId = 0;
4305 i->lastCollectId = 0;
4306 i->lastCollectTime = time(NULL);
4307 i->freeFramesList = NULL;
4308 i->prngState = NULL;
4309 i->evalRetcodeLevel = -1;
4310 i->cookie_stdin = stdin;
4311 i->cookie_stdout = stdout;
4312 i->cookie_stderr = stderr;
4313 i->cb_fwrite = ((size_t (*)( const void *, size_t, size_t, void *))(fwrite));
4314 i->cb_fread = ((size_t (*)( void *, size_t, size_t, void *))(fread));
4315 i->cb_vfprintf = ((int (*)( void *, const char *fmt, va_list ))(vfprintf));
4316 i->cb_fflush = ((int (*)( void *))(fflush));
4317 i->cb_fgets = ((char * (*)( char *, int, void *))(fgets));
4319 /* Note that we can create objects only after the
4320 * interpreter liveList and freeList pointers are
4321 * initialized to NULL. */
4322 Jim_InitHashTable(&i->commands, &JimCommandsHashTableType, i);
4323 Jim_InitHashTable(&i->references, &JimReferencesHashTableType, i);
4324 Jim_InitHashTable(&i->sharedStrings, &JimSharedStringsHashTableType,
4326 Jim_InitHashTable(&i->stub, &JimStringCopyHashTableType, NULL);
4327 Jim_InitHashTable(&i->assocData, &JimAssocDataHashTableType, i);
4328 Jim_InitHashTable(&i->packages, &JimStringKeyValCopyHashTableType, NULL);
4329 i->framePtr = i->topFramePtr = JimCreateCallFrame(i);
4330 i->emptyObj = Jim_NewEmptyStringObj(i);
4331 i->result = i->emptyObj;
4332 i->stackTrace = Jim_NewListObj(i, NULL, 0);
4333 i->unknown = Jim_NewStringObj(i, "unknown", -1);
4334 Jim_IncrRefCount(i->emptyObj);
4335 Jim_IncrRefCount(i->result);
4336 Jim_IncrRefCount(i->stackTrace);
4337 Jim_IncrRefCount(i->unknown);
4339 /* Initialize key variables every interpreter should contain */
4340 pathPtr = Jim_NewStringObj(i, "./", -1);
4341 Jim_SetVariableStr(i, "jim_libpath", pathPtr);
4342 Jim_SetVariableStrWithStr(i, "jim_interactive", "0");
4344 /* Export the core API to extensions */
4345 JimRegisterCoreApi(i);
4349 /* This is the only function Jim exports directly without
4350 * to use the STUB system. It is only used by embedders
4351 * in order to get an interpreter with the Jim API pointers
4353 Jim_Interp *ExportedJimCreateInterp(void)
4355 return Jim_CreateInterp();
4358 void Jim_FreeInterp(Jim_Interp *i)
4360 Jim_CallFrame *cf = i->framePtr, *prevcf, *nextcf;
4361 Jim_Obj *objPtr, *nextObjPtr;
4363 Jim_DecrRefCount(i, i->emptyObj);
4364 Jim_DecrRefCount(i, i->result);
4365 Jim_DecrRefCount(i, i->stackTrace);
4366 Jim_DecrRefCount(i, i->unknown);
4367 Jim_Free((void*)i->errorFileName);
4368 Jim_Free((void*)i->scriptFileName);
4369 Jim_FreeHashTable(&i->commands);
4370 Jim_FreeHashTable(&i->references);
4371 Jim_FreeHashTable(&i->stub);
4372 Jim_FreeHashTable(&i->assocData);
4373 Jim_FreeHashTable(&i->packages);
4374 Jim_Free(i->prngState);
4375 /* Free the call frames list */
4377 prevcf = cf->parentCallFrame;
4378 JimFreeCallFrame(i, cf, JIM_FCF_NONE);
4381 /* Check that the live object list is empty, otherwise
4382 * there is a memory leak. */
4383 if (i->liveList != NULL) {
4384 Jim_Obj *objPtr = i->liveList;
4386 Jim_fprintf( i, i->cookie_stdout,JIM_NL "-------------------------------------" JIM_NL);
4387 Jim_fprintf( i, i->cookie_stdout,"Objects still in the free list:" JIM_NL);
4389 const char *type = objPtr->typePtr ?
4390 objPtr->typePtr->name : "";
4391 Jim_fprintf( i, i->cookie_stdout,"%p \"%-10s\": '%.20s' (refCount: %d)" JIM_NL,
4393 objPtr->bytes ? objPtr->bytes
4394 : "(null)", objPtr->refCount);
4395 if (objPtr->typePtr == &sourceObjType) {
4396 Jim_fprintf( i, i->cookie_stdout, "FILE %s LINE %d" JIM_NL,
4397 objPtr->internalRep.sourceValue.fileName,
4398 objPtr->internalRep.sourceValue.lineNumber);
4400 objPtr = objPtr->nextObjPtr;
4402 Jim_fprintf( i, i->cookie_stdout, "-------------------------------------" JIM_NL JIM_NL);
4403 Jim_Panic(i,"Live list non empty freeing the interpreter! Leak?");
4405 /* Free all the freed objects. */
4406 objPtr = i->freeList;
4408 nextObjPtr = objPtr->nextObjPtr;
4410 objPtr = nextObjPtr;
4412 /* Free cached CallFrame structures */
4413 cf = i->freeFramesList;
4415 nextcf = cf->nextFramePtr;
4416 if (cf->vars.table != NULL)
4417 Jim_Free(cf->vars.table);
4421 /* Free the sharedString hash table. Make sure to free it
4422 * after every other Jim_Object was freed. */
4423 Jim_FreeHashTable(&i->sharedStrings);
4424 /* Free the interpreter structure. */
4428 /* Store the call frame relative to the level represented by
4429 * levelObjPtr into *framePtrPtr. If levelObjPtr == NULL, the
4430 * level is assumed to be '1'.
4432 * If a newLevelptr int pointer is specified, the function stores
4433 * the absolute level integer value of the new target callframe into
4434 * *newLevelPtr. (this is used to adjust interp->numLevels
4435 * in the implementation of [uplevel], so that [info level] will
4436 * return a correct information).
4438 * This function accepts the 'level' argument in the form
4439 * of the commands [uplevel] and [upvar].
4441 * For a function accepting a relative integer as level suitable
4442 * for implementation of [info level ?level?] check the
4443 * GetCallFrameByInteger() function. */
4444 int Jim_GetCallFrameByLevel(Jim_Interp *interp, Jim_Obj *levelObjPtr,
4445 Jim_CallFrame **framePtrPtr, int *newLevelPtr)
4449 Jim_CallFrame *framePtr;
4451 if (newLevelPtr) *newLevelPtr = interp->numLevels;
4453 str = Jim_GetString(levelObjPtr, NULL);
4454 if (str[0] == '#') {
4456 /* speedup for the toplevel (level #0) */
4457 if (str[1] == '0' && str[2] == '\0') {
4458 if (newLevelPtr) *newLevelPtr = 0;
4459 *framePtrPtr = interp->topFramePtr;
4463 level = strtol(str+1, &endptr, 0);
4464 if (str[1] == '\0' || endptr[0] != '\0' || level < 0)
4466 /* An 'absolute' level is converted into the
4467 * 'number of levels to go back' format. */
4468 level = interp->numLevels - level;
4469 if (level < 0) goto badlevel;
4471 if (Jim_GetLong(interp, levelObjPtr, &level) != JIM_OK || level < 0)
4475 str = "1"; /* Needed to format the error message. */
4479 framePtr = interp->framePtr;
4480 if (newLevelPtr) *newLevelPtr = (*newLevelPtr)-level;
4482 framePtr = framePtr->parentCallFrame;
4483 if (framePtr == NULL) goto badlevel;
4485 *framePtrPtr = framePtr;
4488 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4489 Jim_AppendStrings(interp, Jim_GetResult(interp),
4490 "bad level \"", str, "\"", NULL);
4494 /* Similar to Jim_GetCallFrameByLevel() but the level is specified
4495 * as a relative integer like in the [info level ?level?] command. */
4496 static int JimGetCallFrameByInteger(Jim_Interp *interp, Jim_Obj *levelObjPtr,
4497 Jim_CallFrame **framePtrPtr)
4500 jim_wide relLevel; /* level relative to the current one. */
4501 Jim_CallFrame *framePtr;
4503 if (Jim_GetWide(interp, levelObjPtr, &level) != JIM_OK)
4506 /* An 'absolute' level is converted into the
4507 * 'number of levels to go back' format. */
4508 relLevel = interp->numLevels - level;
4513 framePtr = interp->framePtr;
4514 while (relLevel--) {
4515 framePtr = framePtr->parentCallFrame;
4516 if (framePtr == NULL) goto badlevel;
4518 *framePtrPtr = framePtr;
4521 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4522 Jim_AppendStrings(interp, Jim_GetResult(interp),
4523 "bad level \"", Jim_GetString(levelObjPtr, NULL), "\"", NULL);
4527 static void JimSetErrorFileName(Jim_Interp *interp, char *filename)
4529 Jim_Free((void*)interp->errorFileName);
4530 interp->errorFileName = Jim_StrDup(filename);
4533 static void JimSetErrorLineNumber(Jim_Interp *interp, int linenr)
4535 interp->errorLine = linenr;
4538 static void JimResetStackTrace(Jim_Interp *interp)
4540 Jim_DecrRefCount(interp, interp->stackTrace);
4541 interp->stackTrace = Jim_NewListObj(interp, NULL, 0);
4542 Jim_IncrRefCount(interp->stackTrace);
4545 static void JimAppendStackTrace(Jim_Interp *interp, const char *procname,
4546 const char *filename, int linenr)
4548 if (Jim_IsShared(interp->stackTrace)) {
4549 interp->stackTrace =
4550 Jim_DuplicateObj(interp, interp->stackTrace);
4551 Jim_IncrRefCount(interp->stackTrace);
4553 Jim_ListAppendElement(interp, interp->stackTrace,
4554 Jim_NewStringObj(interp, procname, -1));
4555 Jim_ListAppendElement(interp, interp->stackTrace,
4556 Jim_NewStringObj(interp, filename, -1));
4557 Jim_ListAppendElement(interp, interp->stackTrace,
4558 Jim_NewIntObj(interp, linenr));
4561 int Jim_SetAssocData(Jim_Interp *interp, const char *key, Jim_InterpDeleteProc *delProc, void *data)
4563 AssocDataValue *assocEntryPtr = (AssocDataValue *)Jim_Alloc(sizeof(AssocDataValue));
4564 assocEntryPtr->delProc = delProc;
4565 assocEntryPtr->data = data;
4566 return Jim_AddHashEntry(&interp->assocData, key, assocEntryPtr);
4569 void *Jim_GetAssocData(Jim_Interp *interp, const char *key)
4571 Jim_HashEntry *entryPtr = Jim_FindHashEntry(&interp->assocData, key);
4572 if (entryPtr != NULL) {
4573 AssocDataValue *assocEntryPtr = (AssocDataValue *)entryPtr->val;
4574 return assocEntryPtr->data;
4579 int Jim_DeleteAssocData(Jim_Interp *interp, const char *key)
4581 return Jim_DeleteHashEntry(&interp->assocData, key);
4584 int Jim_GetExitCode(Jim_Interp *interp) {
4585 return interp->exitCode;
4588 void *Jim_SetStdin(Jim_Interp *interp, void *fp)
4590 if (fp != NULL) interp->cookie_stdin = fp;
4591 return interp->cookie_stdin;
4594 void *Jim_SetStdout(Jim_Interp *interp, void *fp)
4596 if (fp != NULL) interp->cookie_stdout = fp;
4597 return interp->cookie_stdout;
4600 void *Jim_SetStderr(Jim_Interp *interp, void *fp)
4602 if (fp != NULL) interp->cookie_stderr = fp;
4603 return interp->cookie_stderr;
4606 /* -----------------------------------------------------------------------------
4608 * Every interpreter has an hash table where to put shared dynamically
4609 * allocate strings that are likely to be used a lot of times.
4610 * For example, in the 'source' object type, there is a pointer to
4611 * the filename associated with that object. Every script has a lot
4612 * of this objects with the identical file name, so it is wise to share
4615 * The API is trivial: Jim_GetSharedString(interp, "foobar")
4616 * returns the pointer to the shared string. Every time a reference
4617 * to the string is no longer used, the user should call
4618 * Jim_ReleaseSharedString(interp, stringPointer). Once no one is using
4619 * a given string, it is removed from the hash table.
4620 * ---------------------------------------------------------------------------*/
4621 const char *Jim_GetSharedString(Jim_Interp *interp, const char *str)
4623 Jim_HashEntry *he = Jim_FindHashEntry(&interp->sharedStrings, str);
4626 char *strCopy = Jim_StrDup(str);
4628 Jim_AddHashEntry(&interp->sharedStrings, strCopy, (void*)1);
4631 long refCount = (long) he->val;
4634 he->val = (void*) refCount;
4639 void Jim_ReleaseSharedString(Jim_Interp *interp, const char *str)
4642 Jim_HashEntry *he = Jim_FindHashEntry(&interp->sharedStrings, str);
4645 Jim_Panic(interp,"Jim_ReleaseSharedString called with "
4646 "unknown shared string '%s'", str);
4647 refCount = (long) he->val;
4649 if (refCount == 0) {
4650 Jim_DeleteHashEntry(&interp->sharedStrings, str);
4652 he->val = (void*) refCount;
4656 /* -----------------------------------------------------------------------------
4658 * ---------------------------------------------------------------------------*/
4659 #define JIM_INTEGER_SPACE 24
4661 static void UpdateStringOfInt(struct Jim_Obj *objPtr);
4662 static int SetIntFromAny(Jim_Interp *interp, Jim_Obj *objPtr, int flags);
4664 static Jim_ObjType intObjType = {
4672 void UpdateStringOfInt(struct Jim_Obj *objPtr)
4675 char buf[JIM_INTEGER_SPACE+1];
4677 len = Jim_WideToString(buf, objPtr->internalRep.wideValue);
4678 objPtr->bytes = Jim_Alloc(len+1);
4679 memcpy(objPtr->bytes, buf, len+1);
4680 objPtr->length = len;
4683 int SetIntFromAny(Jim_Interp *interp, Jim_Obj *objPtr, int flags)
4688 /* Get the string representation */
4689 str = Jim_GetString(objPtr, NULL);
4690 /* Try to convert into a jim_wide */
4691 if (Jim_StringToWide(str, &wideValue, 0) != JIM_OK) {
4692 if (flags & JIM_ERRMSG) {
4693 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4694 Jim_AppendStrings(interp, Jim_GetResult(interp),
4695 "expected integer but got \"", str, "\"", NULL);
4699 if ((wideValue == JIM_WIDE_MIN || wideValue == JIM_WIDE_MAX) &&
4701 Jim_SetResultString(interp,
4702 "Integer value too big to be represented", -1);
4705 /* Free the old internal repr and set the new one. */
4706 Jim_FreeIntRep(interp, objPtr);
4707 objPtr->typePtr = &intObjType;
4708 objPtr->internalRep.wideValue = wideValue;
4712 int Jim_GetWide(Jim_Interp *interp, Jim_Obj *objPtr, jim_wide *widePtr)
4714 if (objPtr->typePtr != &intObjType &&
4715 SetIntFromAny(interp, objPtr, JIM_ERRMSG) == JIM_ERR)
4717 *widePtr = objPtr->internalRep.wideValue;
4721 /* Get a wide but does not set an error if the format is bad. */
4722 static int JimGetWideNoErr(Jim_Interp *interp, Jim_Obj *objPtr,
4725 if (objPtr->typePtr != &intObjType &&
4726 SetIntFromAny(interp, objPtr, JIM_NONE) == JIM_ERR)
4728 *widePtr = objPtr->internalRep.wideValue;
4732 int Jim_GetLong(Jim_Interp *interp, Jim_Obj *objPtr, long *longPtr)
4737 retval = Jim_GetWide(interp, objPtr, &wideValue);
4738 if (retval == JIM_OK) {
4739 *longPtr = (long) wideValue;
4745 void Jim_SetWide(Jim_Interp *interp, Jim_Obj *objPtr, jim_wide wideValue)
4747 if (Jim_IsShared(objPtr))
4748 Jim_Panic(interp,"Jim_SetWide called with shared object");
4749 if (objPtr->typePtr != &intObjType) {
4750 Jim_FreeIntRep(interp, objPtr);
4751 objPtr->typePtr = &intObjType;
4753 Jim_InvalidateStringRep(objPtr);
4754 objPtr->internalRep.wideValue = wideValue;
4757 Jim_Obj *Jim_NewIntObj(Jim_Interp *interp, jim_wide wideValue)
4761 objPtr = Jim_NewObj(interp);
4762 objPtr->typePtr = &intObjType;
4763 objPtr->bytes = NULL;
4764 objPtr->internalRep.wideValue = wideValue;
4768 /* -----------------------------------------------------------------------------
4770 * ---------------------------------------------------------------------------*/
4771 #define JIM_DOUBLE_SPACE 30
4773 static void UpdateStringOfDouble(struct Jim_Obj *objPtr);
4774 static int SetDoubleFromAny(Jim_Interp *interp, Jim_Obj *objPtr);
4776 static Jim_ObjType doubleObjType = {
4780 UpdateStringOfDouble,
4784 void UpdateStringOfDouble(struct Jim_Obj *objPtr)
4787 char buf[JIM_DOUBLE_SPACE+1];
4789 len = Jim_DoubleToString(buf, objPtr->internalRep.doubleValue);
4790 objPtr->bytes = Jim_Alloc(len+1);
4791 memcpy(objPtr->bytes, buf, len+1);
4792 objPtr->length = len;
4795 int SetDoubleFromAny(Jim_Interp *interp, Jim_Obj *objPtr)
4800 /* Get the string representation */
4801 str = Jim_GetString(objPtr, NULL);
4802 /* Try to convert into a double */
4803 if (Jim_StringToDouble(str, &doubleValue) != JIM_OK) {
4804 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
4805 Jim_AppendStrings(interp, Jim_GetResult(interp),
4806 "expected number but got '", str, "'", NULL);
4809 /* Free the old internal repr and set the new one. */
4810 Jim_FreeIntRep(interp, objPtr);
4811 objPtr->typePtr = &doubleObjType;
4812 objPtr->internalRep.doubleValue = doubleValue;
4816 int Jim_GetDouble(Jim_Interp *interp, Jim_Obj *objPtr, double *doublePtr)
4818 if (objPtr->typePtr != &doubleObjType &&
4819 SetDoubleFromAny(interp, objPtr) == JIM_ERR)
4821 *doublePtr = objPtr->internalRep.doubleValue;
4825 void Jim_SetDouble(Jim_Interp *interp, Jim_Obj *objPtr, double doubleValue)
4827 if (Jim_IsShared(objPtr))
4828 Jim_Panic(interp,"Jim_SetDouble called with shared object");
4829 if (objPtr->typePtr != &doubleObjType) {
4830 Jim_FreeIntRep(interp, objPtr);
4831 objPtr->typePtr = &doubleObjType;
4833 Jim_InvalidateStringRep(objPtr);
4834 objPtr->internalRep.doubleValue = doubleValue;
4837 Jim_Obj *Jim_NewDoubleObj(Jim_Interp *interp, double doubleValue)
4841 objPtr = Jim_NewObj(interp);
4842 objPtr->typePtr = &doubleObjType;
4843 objPtr->bytes = NULL;
4844 objPtr->internalRep.doubleValue = doubleValue;
4848 /* -----------------------------------------------------------------------------
4850 * ---------------------------------------------------------------------------*/
4851 static void ListAppendElement(Jim_Obj *listPtr, Jim_Obj *objPtr);
4852 static void FreeListInternalRep(Jim_Interp *interp, Jim_Obj *objPtr);
4853 static void DupListInternalRep(Jim_Interp *interp, Jim_Obj *srcPtr, Jim_Obj *dupPtr);
4854 static void UpdateStringOfList(struct Jim_Obj *objPtr);
4855 static int SetListFromAny(Jim_Interp *interp, struct Jim_Obj *objPtr);
4857 /* Note that while the elements of the list may contain references,
4858 * the list object itself can't. This basically means that the
4859 * list object string representation as a whole can't contain references
4860 * that are not presents in the single elements. */
4861 static Jim_ObjType listObjType = {
4863 FreeListInternalRep,
4869 void FreeListInternalRep(Jim_Interp *interp, Jim_Obj *objPtr)
4873 for (i = 0; i < objPtr->internalRep.listValue.len; i++) {
4874 Jim_DecrRefCount(interp, objPtr->internalRep.listValue.ele[i]);
4876 Jim_Free(objPtr->internalRep.listValue.ele);
4879 void DupListInternalRep(Jim_Interp *interp, Jim_Obj *srcPtr, Jim_Obj *dupPtr)
4882 JIM_NOTUSED(interp);
4884 dupPtr->internalRep.listValue.len = srcPtr->internalRep.listValue.len;
4885 dupPtr->internalRep.listValue.maxLen = srcPtr->internalRep.listValue.maxLen;
4886 dupPtr->internalRep.listValue.ele =
4887 Jim_Alloc(sizeof(Jim_Obj*)*srcPtr->internalRep.listValue.maxLen);
4888 memcpy(dupPtr->internalRep.listValue.ele, srcPtr->internalRep.listValue.ele,
4889 sizeof(Jim_Obj*)*srcPtr->internalRep.listValue.len);
4890 for (i = 0; i < dupPtr->internalRep.listValue.len; i++) {
4891 Jim_IncrRefCount(dupPtr->internalRep.listValue.ele[i]);
4893 dupPtr->typePtr = &listObjType;
4896 /* The following function checks if a given string can be encoded
4897 * into a list element without any kind of quoting, surrounded by braces,
4898 * or using escapes to quote. */
4899 #define JIM_ELESTR_SIMPLE 0
4900 #define JIM_ELESTR_BRACE 1
4901 #define JIM_ELESTR_QUOTE 2
4902 static int ListElementQuotingType(const char *s, int len)
4904 int i, level, trySimple = 1;
4906 /* Try with the SIMPLE case */
4907 if (len == 0) return JIM_ELESTR_BRACE;
4908 if (s[0] == '"' || s[0] == '{') {
4912 for (i = 0; i < len; i++) {
4932 return JIM_ELESTR_SIMPLE;
4935 /* Test if it's possible to do with braces */
4936 if (s[len-1] == '\\' ||
4937 s[len-1] == ']') return JIM_ELESTR_QUOTE;
4939 for (i = 0; i < len; i++) {
4941 case '{': level++; break;
4943 if (level < 0) return JIM_ELESTR_QUOTE;
4947 return JIM_ELESTR_QUOTE;
4949 if (s[i+1] != '\0') i++;
4954 if (!trySimple) return JIM_ELESTR_BRACE;
4955 for (i = 0; i < len; i++) {
4969 return JIM_ELESTR_BRACE;
4973 return JIM_ELESTR_SIMPLE;
4975 return JIM_ELESTR_QUOTE;
4978 /* Returns the malloc-ed representation of a string
4979 * using backslash to quote special chars. */
4980 char *BackslashQuoteString(const char *s, int len, int *qlenPtr)
4982 char *q = Jim_Alloc(len*2+1), *p;
4999 case '\n': *p++ = '\\'; *p++ = 'n'; s++; break;
5000 case '\r': *p++ = '\\'; *p++ = 'r'; s++; break;
5001 case '\t': *p++ = '\\'; *p++ = 't'; s++; break;
5002 case '\f': *p++ = '\\'; *p++ = 'f'; s++; break;
5003 case '\v': *p++ = '\\'; *p++ = 'v'; s++; break;
5014 void UpdateStringOfList(struct Jim_Obj *objPtr)
5016 int i, bufLen, realLength;
5020 Jim_Obj **ele = objPtr->internalRep.listValue.ele;
5022 /* (Over) Estimate the space needed. */
5023 quotingType = Jim_Alloc(sizeof(int)*objPtr->internalRep.listValue.len+1);
5025 for (i = 0; i < objPtr->internalRep.listValue.len; i++) {
5028 strRep = Jim_GetString(ele[i], &len);
5029 quotingType[i] = ListElementQuotingType(strRep, len);
5030 switch (quotingType[i]) {
5031 case JIM_ELESTR_SIMPLE: bufLen += len; break;
5032 case JIM_ELESTR_BRACE: bufLen += len+2; break;
5033 case JIM_ELESTR_QUOTE: bufLen += len*2; break;
5035 bufLen++; /* elements separator. */
5039 /* Generate the string rep. */
5040 p = objPtr->bytes = Jim_Alloc(bufLen+1);
5042 for (i = 0; i < objPtr->internalRep.listValue.len; i++) {
5044 const char *strRep = Jim_GetString(ele[i], &len);
5047 switch(quotingType[i]) {
5048 case JIM_ELESTR_SIMPLE:
5049 memcpy(p, strRep, len);
5053 case JIM_ELESTR_BRACE:
5055 memcpy(p, strRep, len);
5058 realLength += len+2;
5060 case JIM_ELESTR_QUOTE:
5061 q = BackslashQuoteString(strRep, len, &qlen);
5068 /* Add a separating space */
5069 if (i+1 != objPtr->internalRep.listValue.len) {
5074 *p = '\0'; /* nul term. */
5075 objPtr->length = realLength;
5076 Jim_Free(quotingType);
5079 int SetListFromAny(Jim_Interp *interp, struct Jim_Obj *objPtr)
5081 struct JimParserCtx parser;
5085 /* Get the string representation */
5086 str = Jim_GetString(objPtr, &strLen);
5088 /* Free the old internal repr just now and initialize the
5089 * new one just now. The string->list conversion can't fail. */
5090 Jim_FreeIntRep(interp, objPtr);
5091 objPtr->typePtr = &listObjType;
5092 objPtr->internalRep.listValue.len = 0;
5093 objPtr->internalRep.listValue.maxLen = 0;
5094 objPtr->internalRep.listValue.ele = NULL;
5096 /* Convert into a list */
5097 JimParserInit(&parser, str, strLen, 1);
5098 while(!JimParserEof(&parser)) {
5101 Jim_Obj *elementPtr;
5103 JimParseList(&parser);
5104 if (JimParserTtype(&parser) != JIM_TT_STR &&
5105 JimParserTtype(&parser) != JIM_TT_ESC)
5107 token = JimParserGetToken(&parser, &tokenLen, &type, NULL);
5108 elementPtr = Jim_NewStringObjNoAlloc(interp, token, tokenLen);
5109 ListAppendElement(objPtr, elementPtr);
5114 Jim_Obj *Jim_NewListObj(Jim_Interp *interp, Jim_Obj *const *elements,
5120 objPtr = Jim_NewObj(interp);
5121 objPtr->typePtr = &listObjType;
5122 objPtr->bytes = NULL;
5123 objPtr->internalRep.listValue.ele = NULL;
5124 objPtr->internalRep.listValue.len = 0;
5125 objPtr->internalRep.listValue.maxLen = 0;
5126 for (i = 0; i < len; i++) {
5127 ListAppendElement(objPtr, elements[i]);
5132 /* Return a vector of Jim_Obj with the elements of a Jim list, and the
5133 * length of the vector. Note that the user of this function should make
5134 * sure that the list object can't shimmer while the vector returned
5135 * is in use, this vector is the one stored inside the internal representation
5136 * of the list object. This function is not exported, extensions should
5137 * always access to the List object elements using Jim_ListIndex(). */
5138 static void JimListGetElements(Jim_Interp *interp, Jim_Obj *listObj, int *argc,
5141 Jim_ListLength(interp, listObj, argc);
5142 assert(listObj->typePtr == &listObjType);
5143 *listVec = listObj->internalRep.listValue.ele;
5146 /* ListSortElements type values */
5147 enum {JIM_LSORT_ASCII, JIM_LSORT_NOCASE, JIM_LSORT_ASCII_DECR,
5148 JIM_LSORT_NOCASE_DECR};
5150 /* Sort the internal rep of a list. */
5151 static int ListSortString(Jim_Obj **lhsObj, Jim_Obj **rhsObj)
5153 return Jim_StringCompareObj(*lhsObj, *rhsObj, 0);
5156 static int ListSortStringDecr(Jim_Obj **lhsObj, Jim_Obj **rhsObj)
5158 return Jim_StringCompareObj(*lhsObj, *rhsObj, 0) * -1;
5161 static int ListSortStringNoCase(Jim_Obj **lhsObj, Jim_Obj **rhsObj)
5163 return Jim_StringCompareObj(*lhsObj, *rhsObj, 1);
5166 static int ListSortStringNoCaseDecr(Jim_Obj **lhsObj, Jim_Obj **rhsObj)
5168 return Jim_StringCompareObj(*lhsObj, *rhsObj, 1) * -1;
5171 /* Sort a list *in place*. MUST be called with non-shared objects. */
5172 static void ListSortElements(Jim_Interp *interp, Jim_Obj *listObjPtr, int type)
5174 typedef int (qsort_comparator)(const void *, const void *);
5175 int (*fn)(Jim_Obj**, Jim_Obj**);
5179 if (Jim_IsShared(listObjPtr))
5180 Jim_Panic(interp,"Jim_ListSortElements called with shared object");
5181 if (listObjPtr->typePtr != &listObjType)
5182 SetListFromAny(interp, listObjPtr);
5184 vector = listObjPtr->internalRep.listValue.ele;
5185 len = listObjPtr->internalRep.listValue.len;
5187 case JIM_LSORT_ASCII: fn = ListSortString; break;
5188 case JIM_LSORT_NOCASE: fn = ListSortStringNoCase; break;
5189 case JIM_LSORT_ASCII_DECR: fn = ListSortStringDecr; break;
5190 case JIM_LSORT_NOCASE_DECR: fn = ListSortStringNoCaseDecr; break;
5192 fn = NULL; /* avoid warning */
5193 Jim_Panic(interp,"ListSort called with invalid sort type");
5195 qsort(vector, len, sizeof(Jim_Obj *), (qsort_comparator *)fn);
5196 Jim_InvalidateStringRep(listObjPtr);
5199 /* This is the low-level function to append an element to a list.
5200 * The higher-level Jim_ListAppendElement() performs shared object
5201 * check and invalidate the string repr. This version is used
5202 * in the internals of the List Object and is not exported.
5204 * NOTE: this function can be called only against objects
5205 * with internal type of List. */
5206 void ListAppendElement(Jim_Obj *listPtr, Jim_Obj *objPtr)
5208 int requiredLen = listPtr->internalRep.listValue.len + 1;
5210 if (requiredLen > listPtr->internalRep.listValue.maxLen) {
5211 int maxLen = requiredLen * 2;
5213 listPtr->internalRep.listValue.ele =
5214 Jim_Realloc(listPtr->internalRep.listValue.ele,
5215 sizeof(Jim_Obj*)*maxLen);
5216 listPtr->internalRep.listValue.maxLen = maxLen;
5218 listPtr->internalRep.listValue.ele[listPtr->internalRep.listValue.len] =
5220 listPtr->internalRep.listValue.len ++;
5221 Jim_IncrRefCount(objPtr);
5224 /* This is the low-level function to insert elements into a list.
5225 * The higher-level Jim_ListInsertElements() performs shared object
5226 * check and invalidate the string repr. This version is used
5227 * in the internals of the List Object and is not exported.
5229 * NOTE: this function can be called only against objects
5230 * with internal type of List. */
5231 void ListInsertElements(Jim_Obj *listPtr, int index, int elemc,
5232 Jim_Obj *const *elemVec)
5234 int currentLen = listPtr->internalRep.listValue.len;
5235 int requiredLen = currentLen + elemc;
5239 if (requiredLen > listPtr->internalRep.listValue.maxLen) {
5240 int maxLen = requiredLen * 2;
5242 listPtr->internalRep.listValue.ele =
5243 Jim_Realloc(listPtr->internalRep.listValue.ele,
5244 sizeof(Jim_Obj*)*maxLen);
5245 listPtr->internalRep.listValue.maxLen = maxLen;
5247 point = listPtr->internalRep.listValue.ele + index;
5248 memmove(point+elemc, point, (currentLen-index) * sizeof(Jim_Obj*));
5249 for (i=0; i < elemc; ++i) {
5250 point[i] = elemVec[i];
5251 Jim_IncrRefCount(point[i]);
5253 listPtr->internalRep.listValue.len += elemc;
5256 /* Appends every element of appendListPtr into listPtr.
5257 * Both have to be of the list type. */
5258 void ListAppendList(Jim_Obj *listPtr, Jim_Obj *appendListPtr)
5260 int i, oldLen = listPtr->internalRep.listValue.len;
5261 int appendLen = appendListPtr->internalRep.listValue.len;
5262 int requiredLen = oldLen + appendLen;
5264 if (requiredLen > listPtr->internalRep.listValue.maxLen) {
5265 int maxLen = requiredLen * 2;
5267 listPtr->internalRep.listValue.ele =
5268 Jim_Realloc(listPtr->internalRep.listValue.ele,
5269 sizeof(Jim_Obj*)*maxLen);
5270 listPtr->internalRep.listValue.maxLen = maxLen;
5272 for (i = 0; i < appendLen; i++) {
5273 Jim_Obj *objPtr = appendListPtr->internalRep.listValue.ele[i];
5274 listPtr->internalRep.listValue.ele[oldLen+i] = objPtr;
5275 Jim_IncrRefCount(objPtr);
5277 listPtr->internalRep.listValue.len += appendLen;
5280 void Jim_ListAppendElement(Jim_Interp *interp, Jim_Obj *listPtr, Jim_Obj *objPtr)
5282 if (Jim_IsShared(listPtr))
5283 Jim_Panic(interp,"Jim_ListAppendElement called with shared object");
5284 if (listPtr->typePtr != &listObjType)
5285 SetListFromAny(interp, listPtr);
5286 Jim_InvalidateStringRep(listPtr);
5287 ListAppendElement(listPtr, objPtr);
5290 void Jim_ListAppendList(Jim_Interp *interp, Jim_Obj *listPtr, Jim_Obj *appendListPtr)
5292 if (Jim_IsShared(listPtr))
5293 Jim_Panic(interp,"Jim_ListAppendList called with shared object");
5294 if (listPtr->typePtr != &listObjType)
5295 SetListFromAny(interp, listPtr);
5296 Jim_InvalidateStringRep(listPtr);
5297 ListAppendList(listPtr, appendListPtr);
5300 void Jim_ListLength(Jim_Interp *interp, Jim_Obj *listPtr, int *intPtr)
5302 if (listPtr->typePtr != &listObjType)
5303 SetListFromAny(interp, listPtr);
5304 *intPtr = listPtr->internalRep.listValue.len;
5307 void Jim_ListInsertElements(Jim_Interp *interp, Jim_Obj *listPtr, int index,
5308 int objc, Jim_Obj *const *objVec)
5310 if (Jim_IsShared(listPtr))
5311 Jim_Panic(interp,"Jim_ListInsertElement called with shared object");
5312 if (listPtr->typePtr != &listObjType)
5313 SetListFromAny(interp, listPtr);
5314 if (index >= 0 && index > listPtr->internalRep.listValue.len)
5315 index = listPtr->internalRep.listValue.len;
5316 else if (index < 0 )
5318 Jim_InvalidateStringRep(listPtr);
5319 ListInsertElements(listPtr, index, objc, objVec);
5322 int Jim_ListIndex(Jim_Interp *interp, Jim_Obj *listPtr, int index,
5323 Jim_Obj **objPtrPtr, int flags)
5325 if (listPtr->typePtr != &listObjType)
5326 SetListFromAny(interp, listPtr);
5327 if ((index >= 0 && index >= listPtr->internalRep.listValue.len) ||
5328 (index < 0 && (-index-1) >= listPtr->internalRep.listValue.len)) {
5329 if (flags & JIM_ERRMSG) {
5330 Jim_SetResultString(interp,
5331 "list index out of range", -1);
5336 index = listPtr->internalRep.listValue.len+index;
5337 *objPtrPtr = listPtr->internalRep.listValue.ele[index];
5341 static int ListSetIndex(Jim_Interp *interp, Jim_Obj *listPtr, int index,
5342 Jim_Obj *newObjPtr, int flags)
5344 if (listPtr->typePtr != &listObjType)
5345 SetListFromAny(interp, listPtr);
5346 if ((index >= 0 && index >= listPtr->internalRep.listValue.len) ||
5347 (index < 0 && (-index-1) >= listPtr->internalRep.listValue.len)) {
5348 if (flags & JIM_ERRMSG) {
5349 Jim_SetResultString(interp,
5350 "list index out of range", -1);
5355 index = listPtr->internalRep.listValue.len+index;
5356 Jim_DecrRefCount(interp, listPtr->internalRep.listValue.ele[index]);
5357 listPtr->internalRep.listValue.ele[index] = newObjPtr;
5358 Jim_IncrRefCount(newObjPtr);
5362 /* Modify the list stored into the variable named 'varNamePtr'
5363 * setting the element specified by the 'indexc' indexes objects in 'indexv',
5364 * with the new element 'newObjptr'. */
5365 int Jim_SetListIndex(Jim_Interp *interp, Jim_Obj *varNamePtr,
5366 Jim_Obj *const *indexv, int indexc, Jim_Obj *newObjPtr)
5368 Jim_Obj *varObjPtr, *objPtr, *listObjPtr;
5369 int shared, i, index;
5371 varObjPtr = objPtr = Jim_GetVariable(interp, varNamePtr, JIM_ERRMSG);
5374 if ((shared = Jim_IsShared(objPtr)))
5375 varObjPtr = objPtr = Jim_DuplicateObj(interp, objPtr);
5376 for (i = 0; i < indexc-1; i++) {
5377 listObjPtr = objPtr;
5378 if (Jim_GetIndex(interp, indexv[i], &index) != JIM_OK)
5380 if (Jim_ListIndex(interp, listObjPtr, index, &objPtr,
5381 JIM_ERRMSG) != JIM_OK) {
5384 if (Jim_IsShared(objPtr)) {
5385 objPtr = Jim_DuplicateObj(interp, objPtr);
5386 ListSetIndex(interp, listObjPtr, index, objPtr, JIM_NONE);
5388 Jim_InvalidateStringRep(listObjPtr);
5390 if (Jim_GetIndex(interp, indexv[indexc-1], &index) != JIM_OK)
5392 if (ListSetIndex(interp, objPtr, index, newObjPtr, JIM_ERRMSG) == JIM_ERR)
5394 Jim_InvalidateStringRep(objPtr);
5395 Jim_InvalidateStringRep(varObjPtr);
5396 if (Jim_SetVariable(interp, varNamePtr, varObjPtr) != JIM_OK)
5398 Jim_SetResult(interp, varObjPtr);
5402 Jim_FreeNewObj(interp, varObjPtr);
5407 Jim_Obj *Jim_ConcatObj(Jim_Interp *interp, int objc, Jim_Obj *const *objv)
5411 /* If all the objects in objv are lists without string rep.
5412 * it's possible to return a list as result, that's the
5413 * concatenation of all the lists. */
5414 for (i = 0; i < objc; i++) {
5415 if (objv[i]->typePtr != &listObjType || objv[i]->bytes)
5419 Jim_Obj *objPtr = Jim_NewListObj(interp, NULL, 0);
5420 for (i = 0; i < objc; i++)
5421 Jim_ListAppendList(interp, objPtr, objv[i]);
5424 /* Else... we have to glue strings together */
5425 int len = 0, objLen;
5428 /* Compute the length */
5429 for (i = 0; i < objc; i++) {
5430 Jim_GetString(objv[i], &objLen);
5433 if (objc) len += objc-1;
5434 /* Create the string rep, and a stinrg object holding it. */
5435 p = bytes = Jim_Alloc(len+1);
5436 for (i = 0; i < objc; i++) {
5437 const char *s = Jim_GetString(objv[i], &objLen);
5438 while (objLen && (*s == ' ' || *s == '\t' || *s == '\n'))
5440 s++; objLen--; len--;
5442 while (objLen && (s[objLen-1] == ' ' ||
5443 s[objLen-1] == '\n' || s[objLen-1] == '\t')) {
5446 memcpy(p, s, objLen);
5448 if (objLen && i+1 != objc) {
5450 } else if (i+1 != objc) {
5451 /* Drop the space calcuated for this
5452 * element that is instead null. */
5457 return Jim_NewStringObjNoAlloc(interp, bytes, len);
5461 /* Returns a list composed of the elements in the specified range.
5462 * first and start are directly accepted as Jim_Objects and
5463 * processed for the end?-index? case. */
5464 Jim_Obj *Jim_ListRange(Jim_Interp *interp, Jim_Obj *listObjPtr, Jim_Obj *firstObjPtr, Jim_Obj *lastObjPtr)
5469 if (Jim_GetIndex(interp, firstObjPtr, &first) != JIM_OK ||
5470 Jim_GetIndex(interp, lastObjPtr, &last) != JIM_OK)
5472 Jim_ListLength(interp, listObjPtr, &len); /* will convert into list */
5473 first = JimRelToAbsIndex(len, first);
5474 last = JimRelToAbsIndex(len, last);
5475 JimRelToAbsRange(len, first, last, &first, &last, &rangeLen);
5476 return Jim_NewListObj(interp,
5477 listObjPtr->internalRep.listValue.ele+first, rangeLen);
5480 /* -----------------------------------------------------------------------------
5482 * ---------------------------------------------------------------------------*/
5483 static void FreeDictInternalRep(Jim_Interp *interp, Jim_Obj *objPtr);
5484 static void DupDictInternalRep(Jim_Interp *interp, Jim_Obj *srcPtr, Jim_Obj *dupPtr);
5485 static void UpdateStringOfDict(struct Jim_Obj *objPtr);
5486 static int SetDictFromAny(Jim_Interp *interp, struct Jim_Obj *objPtr);
5488 /* Dict HashTable Type.
5490 * Keys and Values are Jim objects. */
5492 unsigned int JimObjectHTHashFunction(const void *key)
5495 Jim_Obj *objPtr = (Jim_Obj*) key;
5498 str = Jim_GetString(objPtr, &len);
5499 h = Jim_GenHashFunction((unsigned char*)str, len);
5503 int JimObjectHTKeyCompare(void *privdata, const void *key1, const void *key2)
5505 JIM_NOTUSED(privdata);
5507 return Jim_StringEqObj((Jim_Obj*)key1, (Jim_Obj*)key2, 0);
5510 static void JimObjectHTKeyValDestructor(void *interp, void *val)
5512 Jim_Obj *objPtr = val;
5514 Jim_DecrRefCount(interp, objPtr);
5517 static Jim_HashTableType JimDictHashTableType = {
5518 JimObjectHTHashFunction, /* hash function */
5521 JimObjectHTKeyCompare, /* key compare */
5522 (void(*)(void*, const void*)) /* ATTENTION: const cast */
5523 JimObjectHTKeyValDestructor, /* key destructor */
5524 JimObjectHTKeyValDestructor /* val destructor */
5527 /* Note that while the elements of the dict may contain references,
5528 * the list object itself can't. This basically means that the
5529 * dict object string representation as a whole can't contain references
5530 * that are not presents in the single elements. */
5531 static Jim_ObjType dictObjType = {
5533 FreeDictInternalRep,
5539 void FreeDictInternalRep(Jim_Interp *interp, Jim_Obj *objPtr)
5541 JIM_NOTUSED(interp);
5543 Jim_FreeHashTable(objPtr->internalRep.ptr);
5544 Jim_Free(objPtr->internalRep.ptr);
5547 void DupDictInternalRep(Jim_Interp *interp, Jim_Obj *srcPtr, Jim_Obj *dupPtr)
5549 Jim_HashTable *ht, *dupHt;
5550 Jim_HashTableIterator *htiter;
5553 /* Create a new hash table */
5554 ht = srcPtr->internalRep.ptr;
5555 dupHt = Jim_Alloc(sizeof(*dupHt));
5556 Jim_InitHashTable(dupHt, &JimDictHashTableType, interp);
5558 Jim_ExpandHashTable(dupHt, ht->size);
5559 /* Copy every element from the source to the dup hash table */
5560 htiter = Jim_GetHashTableIterator(ht);
5561 while ((he = Jim_NextHashEntry(htiter)) != NULL) {
5562 const Jim_Obj *keyObjPtr = he->key;
5563 Jim_Obj *valObjPtr = he->val;
5565 Jim_IncrRefCount((Jim_Obj*)keyObjPtr); /* ATTENTION: const cast */
5566 Jim_IncrRefCount(valObjPtr);
5567 Jim_AddHashEntry(dupHt, keyObjPtr, valObjPtr);
5569 Jim_FreeHashTableIterator(htiter);
5571 dupPtr->internalRep.ptr = dupHt;
5572 dupPtr->typePtr = &dictObjType;
5575 void UpdateStringOfDict(struct Jim_Obj *objPtr)
5577 int i, bufLen, realLength;
5580 int *quotingType, objc;
5582 Jim_HashTableIterator *htiter;
5586 /* Trun the hash table into a flat vector of Jim_Objects. */
5587 ht = objPtr->internalRep.ptr;
5589 objv = Jim_Alloc(objc*sizeof(Jim_Obj*));
5590 htiter = Jim_GetHashTableIterator(ht);
5592 while ((he = Jim_NextHashEntry(htiter)) != NULL) {
5593 objv[i++] = (Jim_Obj*)he->key; /* ATTENTION: const cast */
5594 objv[i++] = he->val;
5596 Jim_FreeHashTableIterator(htiter);
5597 /* (Over) Estimate the space needed. */
5598 quotingType = Jim_Alloc(sizeof(int)*objc);
5600 for (i = 0; i < objc; i++) {
5603 strRep = Jim_GetString(objv[i], &len);
5604 quotingType[i] = ListElementQuotingType(strRep, len);
5605 switch (quotingType[i]) {
5606 case JIM_ELESTR_SIMPLE: bufLen += len; break;
5607 case JIM_ELESTR_BRACE: bufLen += len+2; break;
5608 case JIM_ELESTR_QUOTE: bufLen += len*2; break;
5610 bufLen++; /* elements separator. */
5614 /* Generate the string rep. */
5615 p = objPtr->bytes = Jim_Alloc(bufLen+1);
5617 for (i = 0; i < objc; i++) {
5619 const char *strRep = Jim_GetString(objv[i], &len);
5622 switch(quotingType[i]) {
5623 case JIM_ELESTR_SIMPLE:
5624 memcpy(p, strRep, len);
5628 case JIM_ELESTR_BRACE:
5630 memcpy(p, strRep, len);
5633 realLength += len+2;
5635 case JIM_ELESTR_QUOTE:
5636 q = BackslashQuoteString(strRep, len, &qlen);
5643 /* Add a separating space */
5649 *p = '\0'; /* nul term. */
5650 objPtr->length = realLength;
5651 Jim_Free(quotingType);
5655 int SetDictFromAny(Jim_Interp *interp, struct Jim_Obj *objPtr)
5657 struct JimParserCtx parser;
5663 /* Get the string representation */
5664 str = Jim_GetString(objPtr, &strLen);
5666 /* Free the old internal repr just now and initialize the
5667 * new one just now. The string->list conversion can't fail. */
5668 Jim_FreeIntRep(interp, objPtr);
5669 ht = Jim_Alloc(sizeof(*ht));
5670 Jim_InitHashTable(ht, &JimDictHashTableType, interp);
5671 objPtr->typePtr = &dictObjType;
5672 objPtr->internalRep.ptr = ht;
5674 /* Convert into a dict */
5675 JimParserInit(&parser, str, strLen, 1);
5677 while(!JimParserEof(&parser)) {
5681 JimParseList(&parser);
5682 if (JimParserTtype(&parser) != JIM_TT_STR &&
5683 JimParserTtype(&parser) != JIM_TT_ESC)
5685 token = JimParserGetToken(&parser, &tokenLen, &type, NULL);
5686 objv[i++] = Jim_NewStringObjNoAlloc(interp, token, tokenLen);
5689 Jim_IncrRefCount(objv[0]);
5690 Jim_IncrRefCount(objv[1]);
5691 if (Jim_AddHashEntry(ht, objv[0], objv[1]) != JIM_OK) {
5693 he = Jim_FindHashEntry(ht, objv[0]);
5694 Jim_DecrRefCount(interp, objv[0]);
5695 /* ATTENTION: const cast */
5696 Jim_DecrRefCount(interp, (Jim_Obj*)he->val);
5702 Jim_FreeNewObj(interp, objv[0]);
5703 objPtr->typePtr = NULL;
5704 Jim_FreeHashTable(ht);
5705 Jim_SetResultString(interp, "invalid dictionary value: must be a list with an even number of elements", -1);
5711 /* Dict object API */
5713 /* Add an element to a dict. objPtr must be of the "dict" type.
5714 * The higer-level exported function is Jim_DictAddElement().
5715 * If an element with the specified key already exists, the value
5716 * associated is replaced with the new one.
5718 * if valueObjPtr == NULL, the key is instead removed if it exists. */
5719 static void DictAddElement(Jim_Interp *interp, Jim_Obj *objPtr,
5720 Jim_Obj *keyObjPtr, Jim_Obj *valueObjPtr)
5722 Jim_HashTable *ht = objPtr->internalRep.ptr;
5724 if (valueObjPtr == NULL) { /* unset */
5725 Jim_DeleteHashEntry(ht, keyObjPtr);
5728 Jim_IncrRefCount(keyObjPtr);
5729 Jim_IncrRefCount(valueObjPtr);
5730 if (Jim_AddHashEntry(ht, keyObjPtr, valueObjPtr) != JIM_OK) {
5731 Jim_HashEntry *he = Jim_FindHashEntry(ht, keyObjPtr);
5732 Jim_DecrRefCount(interp, keyObjPtr);
5733 /* ATTENTION: const cast */
5734 Jim_DecrRefCount(interp, (Jim_Obj*)he->val);
5735 he->val = valueObjPtr;
5739 /* Add an element, higher-level interface for DictAddElement().
5740 * If valueObjPtr == NULL, the key is removed if it exists. */
5741 int Jim_DictAddElement(Jim_Interp *interp, Jim_Obj *objPtr,
5742 Jim_Obj *keyObjPtr, Jim_Obj *valueObjPtr)
5744 if (Jim_IsShared(objPtr))
5745 Jim_Panic(interp,"Jim_DictAddElement called with shared object");
5746 if (objPtr->typePtr != &dictObjType) {
5747 if (SetDictFromAny(interp, objPtr) != JIM_OK)
5750 DictAddElement(interp, objPtr, keyObjPtr, valueObjPtr);
5751 Jim_InvalidateStringRep(objPtr);
5755 Jim_Obj *Jim_NewDictObj(Jim_Interp *interp, Jim_Obj *const *elements, int len)
5761 Jim_Panic(interp,"Jim_NewDicObj() 'len' argument must be even");
5763 objPtr = Jim_NewObj(interp);
5764 objPtr->typePtr = &dictObjType;
5765 objPtr->bytes = NULL;
5766 objPtr->internalRep.ptr = Jim_Alloc(sizeof(Jim_HashTable));
5767 Jim_InitHashTable(objPtr->internalRep.ptr, &JimDictHashTableType, interp);
5768 for (i = 0; i < len; i += 2)
5769 DictAddElement(interp, objPtr, elements[i], elements[i+1]);
5773 /* Return the value associated to the specified dict key */
5774 int Jim_DictKey(Jim_Interp *interp, Jim_Obj *dictPtr, Jim_Obj *keyPtr,
5775 Jim_Obj **objPtrPtr, int flags)
5780 if (dictPtr->typePtr != &dictObjType) {
5781 if (SetDictFromAny(interp, dictPtr) != JIM_OK)
5784 ht = dictPtr->internalRep.ptr;
5785 if ((he = Jim_FindHashEntry(ht, keyPtr)) == NULL) {
5786 if (flags & JIM_ERRMSG) {
5787 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
5788 Jim_AppendStrings(interp, Jim_GetResult(interp),
5789 "key \"", Jim_GetString(keyPtr, NULL),
5790 "\" not found in dictionary", NULL);
5794 *objPtrPtr = he->val;
5798 /* Return the value associated to the specified dict keys */
5799 int Jim_DictKeysVector(Jim_Interp *interp, Jim_Obj *dictPtr,
5800 Jim_Obj *const *keyv, int keyc, Jim_Obj **objPtrPtr, int flags)
5806 *objPtrPtr = dictPtr;
5810 for (i = 0; i < keyc; i++) {
5811 if (Jim_DictKey(interp, dictPtr, keyv[i], &objPtr, flags)
5816 *objPtrPtr = objPtr;
5820 /* Modify the dict stored into the variable named 'varNamePtr'
5821 * setting the element specified by the 'keyc' keys objects in 'keyv',
5822 * with the new value of the element 'newObjPtr'.
5824 * If newObjPtr == NULL the operation is to remove the given key
5825 * from the dictionary. */
5826 int Jim_SetDictKeysVector(Jim_Interp *interp, Jim_Obj *varNamePtr,
5827 Jim_Obj *const *keyv, int keyc, Jim_Obj *newObjPtr)
5829 Jim_Obj *varObjPtr, *objPtr, *dictObjPtr;
5832 varObjPtr = objPtr = Jim_GetVariable(interp, varNamePtr, JIM_ERRMSG);
5833 if (objPtr == NULL) {
5834 if (newObjPtr == NULL) /* Cannot remove a key from non existing var */
5836 varObjPtr = objPtr = Jim_NewDictObj(interp, NULL, 0);
5837 if (Jim_SetVariable(interp, varNamePtr, objPtr) != JIM_OK) {
5838 Jim_FreeNewObj(interp, varObjPtr);
5842 if ((shared = Jim_IsShared(objPtr)))
5843 varObjPtr = objPtr = Jim_DuplicateObj(interp, objPtr);
5844 for (i = 0; i < keyc-1; i++) {
5845 dictObjPtr = objPtr;
5847 /* Check if it's a valid dictionary */
5848 if (dictObjPtr->typePtr != &dictObjType) {
5849 if (SetDictFromAny(interp, dictObjPtr) != JIM_OK)
5852 /* Check if the given key exists. */
5853 Jim_InvalidateStringRep(dictObjPtr);
5854 if (Jim_DictKey(interp, dictObjPtr, keyv[i], &objPtr,
5855 newObjPtr ? JIM_NONE : JIM_ERRMSG) == JIM_OK)
5857 /* This key exists at the current level.
5858 * Make sure it's not shared!. */
5859 if (Jim_IsShared(objPtr)) {
5860 objPtr = Jim_DuplicateObj(interp, objPtr);
5861 DictAddElement(interp, dictObjPtr, keyv[i], objPtr);
5864 /* Key not found. If it's an [unset] operation
5865 * this is an error. Only the last key may not
5867 if (newObjPtr == NULL)
5869 /* Otherwise set an empty dictionary
5870 * as key's value. */
5871 objPtr = Jim_NewDictObj(interp, NULL, 0);
5872 DictAddElement(interp, dictObjPtr, keyv[i], objPtr);
5875 if (Jim_DictAddElement(interp, objPtr, keyv[keyc-1], newObjPtr)
5878 Jim_InvalidateStringRep(objPtr);
5879 Jim_InvalidateStringRep(varObjPtr);
5880 if (Jim_SetVariable(interp, varNamePtr, varObjPtr) != JIM_OK)
5882 Jim_SetResult(interp, varObjPtr);
5886 Jim_FreeNewObj(interp, varObjPtr);
5891 /* -----------------------------------------------------------------------------
5893 * ---------------------------------------------------------------------------*/
5894 static void UpdateStringOfIndex(struct Jim_Obj *objPtr);
5895 static int SetIndexFromAny(Jim_Interp *interp, struct Jim_Obj *objPtr);
5897 static Jim_ObjType indexObjType = {
5901 UpdateStringOfIndex,
5905 void UpdateStringOfIndex(struct Jim_Obj *objPtr)
5908 char buf[JIM_INTEGER_SPACE+1];
5910 if (objPtr->internalRep.indexValue >= 0)
5911 len = sprintf(buf, "%d", objPtr->internalRep.indexValue);
5912 else if (objPtr->internalRep.indexValue == -1)
5913 len = sprintf(buf, "end");
5915 len = sprintf(buf, "end%d", objPtr->internalRep.indexValue+1);
5917 objPtr->bytes = Jim_Alloc(len+1);
5918 memcpy(objPtr->bytes, buf, len+1);
5919 objPtr->length = len;
5922 int SetIndexFromAny(Jim_Interp *interp, Jim_Obj *objPtr)
5927 /* Get the string representation */
5928 str = Jim_GetString(objPtr, NULL);
5929 /* Try to convert into an index */
5930 if (!strcmp(str, "end")) {
5934 if (!strncmp(str, "end-", 4)) {
5938 if (Jim_StringToIndex(str, &index) != JIM_OK) {
5939 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
5940 Jim_AppendStrings(interp, Jim_GetResult(interp),
5941 "bad index \"", Jim_GetString(objPtr, NULL), "\": "
5942 "must be integer or end?-integer?", NULL);
5951 } else if (!end && index < 0)
5953 /* Free the old internal repr and set the new one. */
5954 Jim_FreeIntRep(interp, objPtr);
5955 objPtr->typePtr = &indexObjType;
5956 objPtr->internalRep.indexValue = index;
5960 int Jim_GetIndex(Jim_Interp *interp, Jim_Obj *objPtr, int *indexPtr)
5962 /* Avoid shimmering if the object is an integer. */
5963 if (objPtr->typePtr == &intObjType) {
5964 jim_wide val = objPtr->internalRep.wideValue;
5965 if (!(val < LONG_MIN) && !(val > LONG_MAX)) {
5966 *indexPtr = (val < 0) ? -INT_MAX : (long)val;;
5970 if (objPtr->typePtr != &indexObjType &&
5971 SetIndexFromAny(interp, objPtr) == JIM_ERR)
5973 *indexPtr = objPtr->internalRep.indexValue;
5977 /* -----------------------------------------------------------------------------
5978 * Return Code Object.
5979 * ---------------------------------------------------------------------------*/
5981 static int SetReturnCodeFromAny(Jim_Interp *interp, Jim_Obj *objPtr);
5983 static Jim_ObjType returnCodeObjType = {
5991 int SetReturnCodeFromAny(Jim_Interp *interp, Jim_Obj *objPtr)
5994 int strLen, returnCode;
5997 /* Get the string representation */
5998 str = Jim_GetString(objPtr, &strLen);
5999 /* Try to convert into an integer */
6000 if (JimGetWideNoErr(interp, objPtr, &wideValue) != JIM_ERR)
6001 returnCode = (int) wideValue;
6002 else if (!JimStringCompare(str, strLen, "ok", 2, JIM_NOCASE))
6003 returnCode = JIM_OK;
6004 else if (!JimStringCompare(str, strLen, "error", 5, JIM_NOCASE))
6005 returnCode = JIM_ERR;
6006 else if (!JimStringCompare(str, strLen, "return", 6, JIM_NOCASE))
6007 returnCode = JIM_RETURN;
6008 else if (!JimStringCompare(str, strLen, "break", 5, JIM_NOCASE))
6009 returnCode = JIM_BREAK;
6010 else if (!JimStringCompare(str, strLen, "continue", 8, JIM_NOCASE))
6011 returnCode = JIM_CONTINUE;
6012 else if (!JimStringCompare(str, strLen, "eval", 4, JIM_NOCASE))
6013 returnCode = JIM_EVAL;
6014 else if (!JimStringCompare(str, strLen, "exit", 4, JIM_NOCASE))
6015 returnCode = JIM_EXIT;
6017 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
6018 Jim_AppendStrings(interp, Jim_GetResult(interp),
6019 "expected return code but got '", str, "'",
6023 /* Free the old internal repr and set the new one. */
6024 Jim_FreeIntRep(interp, objPtr);
6025 objPtr->typePtr = &returnCodeObjType;
6026 objPtr->internalRep.returnCode = returnCode;
6030 int Jim_GetReturnCode(Jim_Interp *interp, Jim_Obj *objPtr, int *intPtr)
6032 if (objPtr->typePtr != &returnCodeObjType &&
6033 SetReturnCodeFromAny(interp, objPtr) == JIM_ERR)
6035 *intPtr = objPtr->internalRep.returnCode;
6039 /* -----------------------------------------------------------------------------
6040 * Expression Parsing
6041 * ---------------------------------------------------------------------------*/
6042 static int JimParseExprOperator(struct JimParserCtx *pc);
6043 static int JimParseExprNumber(struct JimParserCtx *pc);
6044 static int JimParseExprIrrational(struct JimParserCtx *pc);
6046 /* Exrp's Stack machine operators opcodes. */
6048 /* Binary operators (numbers) */
6049 #define JIM_EXPROP_BINARY_NUM_FIRST 0 /* first */
6050 #define JIM_EXPROP_MUL 0
6051 #define JIM_EXPROP_DIV 1
6052 #define JIM_EXPROP_MOD 2
6053 #define JIM_EXPROP_SUB 3
6054 #define JIM_EXPROP_ADD 4
6055 #define JIM_EXPROP_LSHIFT 5
6056 #define JIM_EXPROP_RSHIFT 6
6057 #define JIM_EXPROP_ROTL 7
6058 #define JIM_EXPROP_ROTR 8
6059 #define JIM_EXPROP_LT 9
6060 #define JIM_EXPROP_GT 10
6061 #define JIM_EXPROP_LTE 11
6062 #define JIM_EXPROP_GTE 12
6063 #define JIM_EXPROP_NUMEQ 13
6064 #define JIM_EXPROP_NUMNE 14
6065 #define JIM_EXPROP_BITAND 15
6066 #define JIM_EXPROP_BITXOR 16
6067 #define JIM_EXPROP_BITOR 17
6068 #define JIM_EXPROP_LOGICAND 18
6069 #define JIM_EXPROP_LOGICOR 19
6070 #define JIM_EXPROP_LOGICAND_LEFT 20
6071 #define JIM_EXPROP_LOGICOR_LEFT 21
6072 #define JIM_EXPROP_POW 22
6073 #define JIM_EXPROP_BINARY_NUM_LAST 22 /* last */
6075 /* Binary operators (strings) */
6076 #define JIM_EXPROP_STREQ 23
6077 #define JIM_EXPROP_STRNE 24
6079 /* Unary operators (numbers) */
6080 #define JIM_EXPROP_NOT 25
6081 #define JIM_EXPROP_BITNOT 26
6082 #define JIM_EXPROP_UNARYMINUS 27
6083 #define JIM_EXPROP_UNARYPLUS 28
6084 #define JIM_EXPROP_LOGICAND_RIGHT 29
6085 #define JIM_EXPROP_LOGICOR_RIGHT 30
6087 /* Ternary operators */
6088 #define JIM_EXPROP_TERNARY 31
6091 #define JIM_EXPROP_NUMBER 32
6092 #define JIM_EXPROP_COMMAND 33
6093 #define JIM_EXPROP_VARIABLE 34
6094 #define JIM_EXPROP_DICTSUGAR 35
6095 #define JIM_EXPROP_SUBST 36
6096 #define JIM_EXPROP_STRING 37
6098 /* Operators table */
6099 typedef struct Jim_ExprOperator {
6106 /* name - precedence - arity - opcode */
6107 static struct Jim_ExprOperator Jim_ExprOperators[] = {
6108 {"!", 300, 1, JIM_EXPROP_NOT},
6109 {"~", 300, 1, JIM_EXPROP_BITNOT},
6110 {"unarymin", 300, 1, JIM_EXPROP_UNARYMINUS},
6111 {"unaryplus", 300, 1, JIM_EXPROP_UNARYPLUS},
6113 {"**", 250, 2, JIM_EXPROP_POW},
6115 {"*", 200, 2, JIM_EXPROP_MUL},
6116 {"/", 200, 2, JIM_EXPROP_DIV},
6117 {"%", 200, 2, JIM_EXPROP_MOD},
6119 {"-", 100, 2, JIM_EXPROP_SUB},
6120 {"+", 100, 2, JIM_EXPROP_ADD},
6122 {"<<<", 90, 3, JIM_EXPROP_ROTL},
6123 {">>>", 90, 3, JIM_EXPROP_ROTR},
6124 {"<<", 90, 2, JIM_EXPROP_LSHIFT},
6125 {">>", 90, 2, JIM_EXPROP_RSHIFT},
6127 {"<", 80, 2, JIM_EXPROP_LT},
6128 {">", 80, 2, JIM_EXPROP_GT},
6129 {"<=", 80, 2, JIM_EXPROP_LTE},
6130 {">=", 80, 2, JIM_EXPROP_GTE},
6132 {"==", 70, 2, JIM_EXPROP_NUMEQ},
6133 {"!=", 70, 2, JIM_EXPROP_NUMNE},
6135 {"eq", 60, 2, JIM_EXPROP_STREQ},
6136 {"ne", 60, 2, JIM_EXPROP_STRNE},
6138 {"&", 50, 2, JIM_EXPROP_BITAND},
6139 {"^", 49, 2, JIM_EXPROP_BITXOR},
6140 {"|", 48, 2, JIM_EXPROP_BITOR},
6142 {"&&", 10, 2, JIM_EXPROP_LOGICAND},
6143 {"||", 10, 2, JIM_EXPROP_LOGICOR},
6145 {"?", 5, 3, JIM_EXPROP_TERNARY},
6146 /* private operators */
6147 {NULL, 10, 2, JIM_EXPROP_LOGICAND_LEFT},
6148 {NULL, 10, 1, JIM_EXPROP_LOGICAND_RIGHT},
6149 {NULL, 10, 2, JIM_EXPROP_LOGICOR_LEFT},
6150 {NULL, 10, 1, JIM_EXPROP_LOGICOR_RIGHT},
6153 #define JIM_EXPR_OPERATORS_NUM \
6154 (sizeof(Jim_ExprOperators)/sizeof(struct Jim_ExprOperator))
6156 int JimParseExpression(struct JimParserCtx *pc)
6158 /* Discard spaces and quoted newline */
6159 while(*(pc->p) == ' ' ||
6163 (*(pc->p) == '\\' && *(pc->p+1) == '\n')) {
6168 pc->tstart = pc->tend = pc->p;
6169 pc->tline = pc->linenr;
6170 pc->tt = JIM_TT_EOL;
6176 pc->tstart = pc->tend = pc->p;
6177 pc->tline = pc->linenr;
6178 pc->tt = JIM_TT_SUBEXPR_START;
6182 pc->tstart = pc->tend = pc->p;
6183 pc->tline = pc->linenr;
6184 pc->tt = JIM_TT_SUBEXPR_END;
6188 return JimParseCmd(pc);
6191 if (JimParseVar(pc) == JIM_ERR)
6192 return JimParseExprOperator(pc);
6197 if ((pc->tt == JIM_TT_NONE || pc->tt == JIM_TT_EXPR_OPERATOR) &&
6198 isdigit((int)*(pc->p+1)))
6199 return JimParseExprNumber(pc);
6201 return JimParseExprOperator(pc);
6203 case '0': case '1': case '2': case '3': case '4':
6204 case '5': case '6': case '7': case '8': case '9': case '.':
6205 return JimParseExprNumber(pc);
6209 /* Here it's possible to reuse the List String parsing. */
6210 pc->tt = JIM_TT_NONE; /* Make sure it's sensed as a new word. */
6211 return JimParseListStr(pc);
6215 if (JimParseExprIrrational(pc) == JIM_ERR)
6216 return JimParseExprOperator(pc);
6219 return JimParseExprOperator(pc);
6225 int JimParseExprNumber(struct JimParserCtx *pc)
6231 pc->tline = pc->linenr;
6232 if (*pc->p == '-') {
6235 while ( isdigit((int)*pc->p)
6236 || (allowhex && isxdigit((int)*pc->p) )
6237 || (allowdot && *pc->p == '.')
6238 || (pc->p-pc->tstart == 1 && *pc->tstart == '0' &&
6239 (*pc->p == 'x' || *pc->p == 'X'))
6242 if ((*pc->p == 'x') || (*pc->p == 'X')) {
6249 if (!allowdot && *pc->p == 'e' && *(pc->p+1) == '-') {
6250 pc->p += 2; pc->len -= 2;
6254 pc->tt = JIM_TT_EXPR_NUMBER;
6258 int JimParseExprIrrational(struct JimParserCtx *pc)
6260 const char *Tokens[] = {"NaN", "nan", "NAN", "Inf", "inf", "INF", NULL};
6262 for (token = Tokens; *token != NULL; token++) {
6263 int len = strlen(*token);
6264 if (strncmp(*token, pc->p, len) == 0) {
6266 pc->tend = pc->p + len - 1;
6267 pc->p += len; pc->len -= len;
6268 pc->tline = pc->linenr;
6269 pc->tt = JIM_TT_EXPR_NUMBER;
6276 int JimParseExprOperator(struct JimParserCtx *pc)
6279 int bestIdx = -1, bestLen = 0;
6281 /* Try to get the longest match. */
6282 for (i = 0; i < (signed)JIM_EXPR_OPERATORS_NUM; i++) {
6286 opname = Jim_ExprOperators[i].name;
6287 if (opname == NULL) continue;
6288 oplen = strlen(opname);
6290 if (strncmp(opname, pc->p, oplen) == 0 && oplen > bestLen) {
6295 if (bestIdx == -1) return JIM_ERR;
6297 pc->tend = pc->p + bestLen - 1;
6298 pc->p += bestLen; pc->len -= bestLen;
6299 pc->tline = pc->linenr;
6300 pc->tt = JIM_TT_EXPR_OPERATOR;
6304 struct Jim_ExprOperator *JimExprOperatorInfo(const char *opname)
6307 for (i = 0; i < (signed)JIM_EXPR_OPERATORS_NUM; i++)
6308 if (Jim_ExprOperators[i].name &&
6309 strcmp(opname, Jim_ExprOperators[i].name) == 0)
6310 return &Jim_ExprOperators[i];
6314 struct Jim_ExprOperator *JimExprOperatorInfoByOpcode(int opcode)
6317 for (i = 0; i < (signed)JIM_EXPR_OPERATORS_NUM; i++)
6318 if (Jim_ExprOperators[i].opcode == opcode)
6319 return &Jim_ExprOperators[i];
6323 /* -----------------------------------------------------------------------------
6325 * ---------------------------------------------------------------------------*/
6326 static void FreeExprInternalRep(Jim_Interp *interp, Jim_Obj *objPtr);
6327 static void DupExprInternalRep(Jim_Interp *interp, Jim_Obj *srcPtr, Jim_Obj *dupPtr);
6328 static int SetExprFromAny(Jim_Interp *interp, struct Jim_Obj *objPtr);
6330 static Jim_ObjType exprObjType = {
6332 FreeExprInternalRep,
6335 JIM_TYPE_REFERENCES,
6338 /* Expr bytecode structure */
6339 typedef struct ExprByteCode {
6340 int *opcode; /* Integer array of opcodes. */
6341 Jim_Obj **obj; /* Array of associated Jim Objects. */
6342 int len; /* Bytecode length */
6343 int inUse; /* Used for sharing. */
6346 void FreeExprInternalRep(Jim_Interp *interp, Jim_Obj *objPtr)
6349 ExprByteCode *expr = (void*) objPtr->internalRep.ptr;
6352 if (expr->inUse != 0) return;
6353 for (i = 0; i < expr->len; i++)
6354 Jim_DecrRefCount(interp, expr->obj[i]);
6355 Jim_Free(expr->opcode);
6356 Jim_Free(expr->obj);
6360 void DupExprInternalRep(Jim_Interp *interp, Jim_Obj *srcPtr, Jim_Obj *dupPtr)
6362 JIM_NOTUSED(interp);
6363 JIM_NOTUSED(srcPtr);
6365 /* Just returns an simple string. */
6366 dupPtr->typePtr = NULL;
6369 /* Add a new instruction to an expression bytecode structure. */
6370 static void ExprObjAddInstr(Jim_Interp *interp, ExprByteCode *expr,
6371 int opcode, char *str, int len)
6373 expr->opcode = Jim_Realloc(expr->opcode, sizeof(int)*(expr->len+1));
6374 expr->obj = Jim_Realloc(expr->obj, sizeof(Jim_Obj*)*(expr->len+1));
6375 expr->opcode[expr->len] = opcode;
6376 expr->obj[expr->len] = Jim_NewStringObjNoAlloc(interp, str, len);
6377 Jim_IncrRefCount(expr->obj[expr->len]);
6381 /* Check if an expr program looks correct. */
6382 static int ExprCheckCorrectness(ExprByteCode *expr)
6387 /* Try to check if there are stack underflows,
6388 * and make sure at the end of the program there is
6389 * a single result on the stack. */
6390 for (i = 0; i < expr->len; i++) {
6391 switch(expr->opcode[i]) {
6392 case JIM_EXPROP_NUMBER:
6393 case JIM_EXPROP_STRING:
6394 case JIM_EXPROP_SUBST:
6395 case JIM_EXPROP_VARIABLE:
6396 case JIM_EXPROP_DICTSUGAR:
6397 case JIM_EXPROP_COMMAND:
6400 case JIM_EXPROP_NOT:
6401 case JIM_EXPROP_BITNOT:
6402 case JIM_EXPROP_UNARYMINUS:
6403 case JIM_EXPROP_UNARYPLUS:
6404 /* Unary operations */
6405 if (stacklen < 1) return JIM_ERR;
6407 case JIM_EXPROP_ADD:
6408 case JIM_EXPROP_SUB:
6409 case JIM_EXPROP_MUL:
6410 case JIM_EXPROP_DIV:
6411 case JIM_EXPROP_MOD:
6414 case JIM_EXPROP_LTE:
6415 case JIM_EXPROP_GTE:
6416 case JIM_EXPROP_ROTL:
6417 case JIM_EXPROP_ROTR:
6418 case JIM_EXPROP_LSHIFT:
6419 case JIM_EXPROP_RSHIFT:
6420 case JIM_EXPROP_NUMEQ:
6421 case JIM_EXPROP_NUMNE:
6422 case JIM_EXPROP_STREQ:
6423 case JIM_EXPROP_STRNE:
6424 case JIM_EXPROP_BITAND:
6425 case JIM_EXPROP_BITXOR:
6426 case JIM_EXPROP_BITOR:
6427 case JIM_EXPROP_LOGICAND:
6428 case JIM_EXPROP_LOGICOR:
6429 case JIM_EXPROP_POW:
6430 /* binary operations */
6431 if (stacklen < 2) return JIM_ERR;
6435 Jim_Panic(NULL,"Default opcode reached ExprCheckCorrectness");
6439 if (stacklen != 1) return JIM_ERR;
6443 static void ExprShareLiterals(Jim_Interp *interp, ExprByteCode *expr,
6444 ScriptObj *topLevelScript)
6449 for (i = 0; i < expr->len; i++) {
6450 Jim_Obj *foundObjPtr;
6452 if (expr->obj[i] == NULL) continue;
6453 foundObjPtr = ScriptSearchLiteral(interp, topLevelScript,
6454 NULL, expr->obj[i]);
6455 if (foundObjPtr != NULL) {
6456 Jim_IncrRefCount(foundObjPtr);
6457 Jim_DecrRefCount(interp, expr->obj[i]);
6458 expr->obj[i] = foundObjPtr;
6463 /* This procedure converts every occurrence of || and && opereators
6464 * in lazy unary versions.
6466 * a b || is converted into:
6468 * a <offset> |L b |R
6470 * a b && is converted into:
6472 * a <offset> &L b &R
6474 * "|L" checks if 'a' is true:
6475 * 1) if it is true pushes 1 and skips <offset> istructions to reach
6476 * the opcode just after |R.
6477 * 2) if it is false does nothing.
6478 * "|R" checks if 'b' is true:
6479 * 1) if it is true pushes 1, otherwise pushes 0.
6481 * "&L" checks if 'a' is true:
6482 * 1) if it is true does nothing.
6483 * 2) If it is false pushes 0 and skips <offset> istructions to reach
6484 * the opcode just after &R
6485 * "&R" checks if 'a' is true:
6486 * if it is true pushes 1, otherwise pushes 0.
6488 static void ExprMakeLazy(Jim_Interp *interp, ExprByteCode *expr)
6491 int index = -1, leftindex, arity, i, offset;
6492 Jim_ExprOperator *op;
6494 /* Search for || or && */
6495 for (i = 0; i < expr->len; i++) {
6496 if (expr->opcode[i] == JIM_EXPROP_LOGICAND ||
6497 expr->opcode[i] == JIM_EXPROP_LOGICOR) {
6502 if (index == -1) return;
6503 /* Search for the end of the first operator */
6504 leftindex = index-1;
6507 switch(expr->opcode[leftindex]) {
6508 case JIM_EXPROP_NUMBER:
6509 case JIM_EXPROP_COMMAND:
6510 case JIM_EXPROP_VARIABLE:
6511 case JIM_EXPROP_DICTSUGAR:
6512 case JIM_EXPROP_SUBST:
6513 case JIM_EXPROP_STRING:
6516 op = JimExprOperatorInfoByOpcode(expr->opcode[i]);
6518 Jim_Panic(interp,"Default reached in ExprMakeLazy()");
6527 expr->opcode = Jim_Realloc(expr->opcode, sizeof(int)*(expr->len+2));
6528 expr->obj = Jim_Realloc(expr->obj, sizeof(Jim_Obj*)*(expr->len+2));
6529 memmove(&expr->opcode[leftindex+2], &expr->opcode[leftindex],
6530 sizeof(int)*(expr->len-leftindex));
6531 memmove(&expr->obj[leftindex+2], &expr->obj[leftindex],
6532 sizeof(Jim_Obj*)*(expr->len-leftindex));
6535 offset = (index-leftindex)-1;
6536 Jim_DecrRefCount(interp, expr->obj[index]);
6537 if (expr->opcode[index] == JIM_EXPROP_LOGICAND) {
6538 expr->opcode[leftindex+1] = JIM_EXPROP_LOGICAND_LEFT;
6539 expr->opcode[index] = JIM_EXPROP_LOGICAND_RIGHT;
6540 expr->obj[leftindex+1] = Jim_NewStringObj(interp, "&L", -1);
6541 expr->obj[index] = Jim_NewStringObj(interp, "&R", -1);
6543 expr->opcode[leftindex+1] = JIM_EXPROP_LOGICOR_LEFT;
6544 expr->opcode[index] = JIM_EXPROP_LOGICOR_RIGHT;
6545 expr->obj[leftindex+1] = Jim_NewStringObj(interp, "|L", -1);
6546 expr->obj[index] = Jim_NewStringObj(interp, "|R", -1);
6548 expr->opcode[leftindex] = JIM_EXPROP_NUMBER;
6549 expr->obj[leftindex] = Jim_NewIntObj(interp, offset);
6550 Jim_IncrRefCount(expr->obj[index]);
6551 Jim_IncrRefCount(expr->obj[leftindex]);
6552 Jim_IncrRefCount(expr->obj[leftindex+1]);
6556 /* This method takes the string representation of an expression
6557 * and generates a program for the Expr's stack-based VM. */
6558 int SetExprFromAny(Jim_Interp *interp, struct Jim_Obj *objPtr)
6561 const char *exprText = Jim_GetString(objPtr, &exprTextLen);
6562 struct JimParserCtx parser;
6563 int i, shareLiterals;
6564 ExprByteCode *expr = Jim_Alloc(sizeof(*expr));
6566 Jim_ExprOperator *op;
6568 /* Perform literal sharing with the current procedure
6569 * running only if this expression appears to be not generated
6571 shareLiterals = objPtr->typePtr == &sourceObjType;
6573 expr->opcode = NULL;
6578 Jim_InitStack(&stack);
6579 JimParserInit(&parser, exprText, exprTextLen, 1);
6580 while(!JimParserEof(&parser)) {
6584 if (JimParseExpression(&parser) != JIM_OK) {
6585 Jim_SetResultString(interp, "Syntax error in expression", -1);
6588 token = JimParserGetToken(&parser, &len, &type, NULL);
6589 if (type == JIM_TT_EOL) {
6595 ExprObjAddInstr(interp, expr, JIM_EXPROP_STRING, token, len);
6598 ExprObjAddInstr(interp, expr, JIM_EXPROP_SUBST, token, len);
6601 ExprObjAddInstr(interp, expr, JIM_EXPROP_VARIABLE, token, len);
6603 case JIM_TT_DICTSUGAR:
6604 ExprObjAddInstr(interp, expr, JIM_EXPROP_DICTSUGAR, token, len);
6607 ExprObjAddInstr(interp, expr, JIM_EXPROP_COMMAND, token, len);
6609 case JIM_TT_EXPR_NUMBER:
6610 ExprObjAddInstr(interp, expr, JIM_EXPROP_NUMBER, token, len);
6612 case JIM_TT_EXPR_OPERATOR:
6613 op = JimExprOperatorInfo(token);
6615 Jim_ExprOperator *stackTopOp;
6617 if (Jim_StackPeek(&stack) != NULL) {
6618 stackTopOp = JimExprOperatorInfo(Jim_StackPeek(&stack));
6622 if (Jim_StackLen(&stack) && op->arity != 1 &&
6623 stackTopOp && stackTopOp->precedence >= op->precedence)
6625 ExprObjAddInstr(interp, expr, stackTopOp->opcode,
6626 Jim_StackPeek(&stack), -1);
6627 Jim_StackPop(&stack);
6632 Jim_StackPush(&stack, token);
6634 case JIM_TT_SUBEXPR_START:
6635 Jim_StackPush(&stack, Jim_StrDup("("));
6638 case JIM_TT_SUBEXPR_END:
6641 while(Jim_StackLen(&stack)) {
6642 char *opstr = Jim_StackPop(&stack);
6643 if (!strcmp(opstr, "(")) {
6648 op = JimExprOperatorInfo(opstr);
6649 ExprObjAddInstr(interp, expr, op->opcode, opstr, -1);
6652 Jim_SetResultString(interp,
6653 "Unexpected close parenthesis", -1);
6660 Jim_Panic(interp,"Default reached in SetExprFromAny()");
6664 while (Jim_StackLen(&stack)) {
6665 char *opstr = Jim_StackPop(&stack);
6666 op = JimExprOperatorInfo(opstr);
6667 if (op == NULL && !strcmp(opstr, "(")) {
6669 Jim_SetResultString(interp, "Missing close parenthesis", -1);
6672 ExprObjAddInstr(interp, expr, op->opcode, opstr, -1);
6674 /* Check program correctness. */
6675 if (ExprCheckCorrectness(expr) != JIM_OK) {
6676 Jim_SetResultString(interp, "Invalid expression", -1);
6680 /* Free the stack used for the compilation. */
6681 Jim_FreeStackElements(&stack, Jim_Free);
6682 Jim_FreeStack(&stack);
6684 /* Convert || and && operators in unary |L |R and &L &R for lazyness */
6685 ExprMakeLazy(interp, expr);
6687 /* Perform literal sharing */
6688 if (shareLiterals && interp->framePtr->procBodyObjPtr) {
6689 Jim_Obj *bodyObjPtr = interp->framePtr->procBodyObjPtr;
6690 if (bodyObjPtr->typePtr == &scriptObjType) {
6691 ScriptObj *bodyScript = bodyObjPtr->internalRep.ptr;
6692 ExprShareLiterals(interp, expr, bodyScript);
6696 /* Free the old internal rep and set the new one. */
6697 Jim_FreeIntRep(interp, objPtr);
6698 Jim_SetIntRepPtr(objPtr, expr);
6699 objPtr->typePtr = &exprObjType;
6702 err: /* we jump here on syntax/compile errors. */
6703 Jim_FreeStackElements(&stack, Jim_Free);
6704 Jim_FreeStack(&stack);
6705 Jim_Free(expr->opcode);
6706 for (i = 0; i < expr->len; i++) {
6707 Jim_DecrRefCount(interp,expr->obj[i]);
6709 Jim_Free(expr->obj);
6714 ExprByteCode *Jim_GetExpression(Jim_Interp *interp, Jim_Obj *objPtr)
6716 if (objPtr->typePtr != &exprObjType) {
6717 if (SetExprFromAny(interp, objPtr) != JIM_OK)
6720 return (ExprByteCode*) Jim_GetIntRepPtr(objPtr);
6723 /* -----------------------------------------------------------------------------
6724 * Expressions evaluation.
6725 * Jim uses a specialized stack-based virtual machine for expressions,
6726 * that takes advantage of the fact that expr's operators
6727 * can't be redefined.
6729 * Jim_EvalExpression() uses the bytecode compiled by
6730 * SetExprFromAny() method of the "expression" object.
6732 * On success a Tcl Object containing the result of the evaluation
6733 * is stored into expResultPtrPtr (having refcount of 1), and JIM_OK is
6735 * On error the function returns a retcode != to JIM_OK and set a suitable
6736 * error on the interp.
6737 * ---------------------------------------------------------------------------*/
6738 #define JIM_EE_STATICSTACK_LEN 10
6740 int Jim_EvalExpression(Jim_Interp *interp, Jim_Obj *exprObjPtr,
6741 Jim_Obj **exprResultPtrPtr)
6744 Jim_Obj **stack, *staticStack[JIM_EE_STATICSTACK_LEN];
6745 int stacklen = 0, i, error = 0, errRetCode = JIM_ERR;
6747 Jim_IncrRefCount(exprObjPtr);
6748 expr = Jim_GetExpression(interp, exprObjPtr);
6750 Jim_DecrRefCount(interp, exprObjPtr);
6751 return JIM_ERR; /* error in expression. */
6753 /* In order to avoid that the internal repr gets freed due to
6754 * shimmering of the exprObjPtr's object, we make the internal rep
6758 /* The stack-based expr VM itself */
6760 /* Stack allocation. Expr programs have the feature that
6761 * a program of length N can't require a stack longer than
6763 if (expr->len > JIM_EE_STATICSTACK_LEN)
6764 stack = Jim_Alloc(sizeof(Jim_Obj*)*expr->len);
6766 stack = staticStack;
6768 /* Execute every istruction */
6769 for (i = 0; i < expr->len; i++) {
6770 Jim_Obj *A, *B, *objPtr;
6771 jim_wide wA, wB, wC;
6773 const char *sA, *sB;
6774 int Alen, Blen, retcode;
6775 int opcode = expr->opcode[i];
6777 if (opcode == JIM_EXPROP_NUMBER || opcode == JIM_EXPROP_STRING) {
6778 stack[stacklen++] = expr->obj[i];
6779 Jim_IncrRefCount(expr->obj[i]);
6780 } else if (opcode == JIM_EXPROP_VARIABLE) {
6781 objPtr = Jim_GetVariable(interp, expr->obj[i], JIM_ERRMSG);
6782 if (objPtr == NULL) {
6786 stack[stacklen++] = objPtr;
6787 Jim_IncrRefCount(objPtr);
6788 } else if (opcode == JIM_EXPROP_SUBST) {
6789 if ((retcode = Jim_SubstObj(interp, expr->obj[i],
6790 &objPtr, JIM_NONE)) != JIM_OK)
6793 errRetCode = retcode;
6796 stack[stacklen++] = objPtr;
6797 Jim_IncrRefCount(objPtr);
6798 } else if (opcode == JIM_EXPROP_DICTSUGAR) {
6799 objPtr = Jim_ExpandDictSugar(interp, expr->obj[i]);
6800 if (objPtr == NULL) {
6804 stack[stacklen++] = objPtr;
6805 Jim_IncrRefCount(objPtr);
6806 } else if (opcode == JIM_EXPROP_COMMAND) {
6807 if ((retcode = Jim_EvalObj(interp, expr->obj[i])) != JIM_OK) {
6809 errRetCode = retcode;
6812 stack[stacklen++] = interp->result;
6813 Jim_IncrRefCount(interp->result);
6814 } else if (opcode >= JIM_EXPROP_BINARY_NUM_FIRST &&
6815 opcode <= JIM_EXPROP_BINARY_NUM_LAST)
6817 /* Note that there isn't to increment the
6818 * refcount of objects. the references are moved
6819 * from stack to A and B. */
6820 B = stack[--stacklen];
6821 A = stack[--stacklen];
6823 /* --- Integer --- */
6824 if ((A->typePtr == &doubleObjType && !A->bytes) ||
6825 (B->typePtr == &doubleObjType && !B->bytes) ||
6826 JimGetWideNoErr(interp, A, &wA) != JIM_OK ||
6827 JimGetWideNoErr(interp, B, &wB) != JIM_OK) {
6830 Jim_DecrRefCount(interp, A);
6831 Jim_DecrRefCount(interp, B);
6832 switch(expr->opcode[i]) {
6833 case JIM_EXPROP_ADD: wC = wA+wB; break;
6834 case JIM_EXPROP_SUB: wC = wA-wB; break;
6835 case JIM_EXPROP_MUL: wC = wA*wB; break;
6836 case JIM_EXPROP_LT: wC = wA<wB; break;
6837 case JIM_EXPROP_GT: wC = wA>wB; break;
6838 case JIM_EXPROP_LTE: wC = wA<=wB; break;
6839 case JIM_EXPROP_GTE: wC = wA>=wB; break;
6840 case JIM_EXPROP_LSHIFT: wC = wA<<wB; break;
6841 case JIM_EXPROP_RSHIFT: wC = wA>>wB; break;
6842 case JIM_EXPROP_NUMEQ: wC = wA==wB; break;
6843 case JIM_EXPROP_NUMNE: wC = wA!=wB; break;
6844 case JIM_EXPROP_BITAND: wC = wA&wB; break;
6845 case JIM_EXPROP_BITXOR: wC = wA^wB; break;
6846 case JIM_EXPROP_BITOR: wC = wA|wB; break;
6847 case JIM_EXPROP_POW: wC = JimPowWide(wA,wB); break;
6848 case JIM_EXPROP_LOGICAND_LEFT:
6856 case JIM_EXPROP_LOGICOR_LEFT:
6864 case JIM_EXPROP_DIV:
6865 if (wB == 0) goto divbyzero;
6868 case JIM_EXPROP_MOD:
6869 if (wB == 0) goto divbyzero;
6872 case JIM_EXPROP_ROTL: {
6873 /* uint32_t would be better. But not everyone has inttypes.h?*/
6874 unsigned long uA = (unsigned long)wA;
6876 wC = _rotl(uA,(unsigned long)wB);
6878 const unsigned int S = sizeof(unsigned long) * 8;
6879 wC = (unsigned long)((uA<<wB)|(uA>>(S-wB)));
6883 case JIM_EXPROP_ROTR: {
6884 unsigned long uA = (unsigned long)wA;
6886 wC = _rotr(uA,(unsigned long)wB);
6888 const unsigned int S = sizeof(unsigned long) * 8;
6889 wC = (unsigned long)((uA>>wB)|(uA<<(S-wB)));
6895 wC = 0; /* avoid gcc warning */
6898 stack[stacklen] = Jim_NewIntObj(interp, wC);
6899 Jim_IncrRefCount(stack[stacklen]);
6903 /* --- Double --- */
6904 if (Jim_GetDouble(interp, A, &dA) != JIM_OK ||
6905 Jim_GetDouble(interp, B, &dB) != JIM_OK) {
6906 Jim_DecrRefCount(interp, A);
6907 Jim_DecrRefCount(interp, B);
6911 Jim_DecrRefCount(interp, A);
6912 Jim_DecrRefCount(interp, B);
6913 switch(expr->opcode[i]) {
6914 case JIM_EXPROP_ROTL:
6915 case JIM_EXPROP_ROTR:
6916 case JIM_EXPROP_LSHIFT:
6917 case JIM_EXPROP_RSHIFT:
6918 case JIM_EXPROP_BITAND:
6919 case JIM_EXPROP_BITXOR:
6920 case JIM_EXPROP_BITOR:
6921 case JIM_EXPROP_MOD:
6922 case JIM_EXPROP_POW:
6923 Jim_SetResultString(interp,
6924 "Got floating-point value where integer was expected", -1);
6928 case JIM_EXPROP_ADD: dC = dA+dB; break;
6929 case JIM_EXPROP_SUB: dC = dA-dB; break;
6930 case JIM_EXPROP_MUL: dC = dA*dB; break;
6931 case JIM_EXPROP_LT: dC = dA<dB; break;
6932 case JIM_EXPROP_GT: dC = dA>dB; break;
6933 case JIM_EXPROP_LTE: dC = dA<=dB; break;
6934 case JIM_EXPROP_GTE: dC = dA>=dB; break;
6935 case JIM_EXPROP_NUMEQ: dC = dA==dB; break;
6936 case JIM_EXPROP_NUMNE: dC = dA!=dB; break;
6937 case JIM_EXPROP_LOGICAND_LEFT:
6945 case JIM_EXPROP_LOGICOR_LEFT:
6953 case JIM_EXPROP_DIV:
6954 if (dB == 0) goto divbyzero;
6958 dC = 0; /* avoid gcc warning */
6961 stack[stacklen] = Jim_NewDoubleObj(interp, dC);
6962 Jim_IncrRefCount(stack[stacklen]);
6964 } else if (opcode == JIM_EXPROP_STREQ || opcode == JIM_EXPROP_STRNE) {
6965 B = stack[--stacklen];
6966 A = stack[--stacklen];
6967 sA = Jim_GetString(A, &Alen);
6968 sB = Jim_GetString(B, &Blen);
6969 switch(expr->opcode[i]) {
6970 case JIM_EXPROP_STREQ:
6971 if (Alen == Blen && memcmp(sA, sB, Alen) ==0)
6976 case JIM_EXPROP_STRNE:
6977 if (Alen != Blen || memcmp(sA, sB, Alen) != 0)
6983 wC = 0; /* avoid gcc warning */
6986 Jim_DecrRefCount(interp, A);
6987 Jim_DecrRefCount(interp, B);
6988 stack[stacklen] = Jim_NewIntObj(interp, wC);
6989 Jim_IncrRefCount(stack[stacklen]);
6991 } else if (opcode == JIM_EXPROP_NOT ||
6992 opcode == JIM_EXPROP_BITNOT ||
6993 opcode == JIM_EXPROP_LOGICAND_RIGHT ||
6994 opcode == JIM_EXPROP_LOGICOR_RIGHT) {
6995 /* Note that there isn't to increment the
6996 * refcount of objects. the references are moved
6997 * from stack to A and B. */
6998 A = stack[--stacklen];
7000 /* --- Integer --- */
7001 if ((A->typePtr == &doubleObjType && !A->bytes) ||
7002 JimGetWideNoErr(interp, A, &wA) != JIM_OK) {
7003 goto trydouble_unary;
7005 Jim_DecrRefCount(interp, A);
7006 switch(expr->opcode[i]) {
7007 case JIM_EXPROP_NOT: wC = !wA; break;
7008 case JIM_EXPROP_BITNOT: wC = ~wA; break;
7009 case JIM_EXPROP_LOGICAND_RIGHT:
7010 case JIM_EXPROP_LOGICOR_RIGHT: wC = (wA != 0); break;
7012 wC = 0; /* avoid gcc warning */
7015 stack[stacklen] = Jim_NewIntObj(interp, wC);
7016 Jim_IncrRefCount(stack[stacklen]);
7020 /* --- Double --- */
7021 if (Jim_GetDouble(interp, A, &dA) != JIM_OK) {
7022 Jim_DecrRefCount(interp, A);
7026 Jim_DecrRefCount(interp, A);
7027 switch(expr->opcode[i]) {
7028 case JIM_EXPROP_NOT: dC = !dA; break;
7029 case JIM_EXPROP_LOGICAND_RIGHT:
7030 case JIM_EXPROP_LOGICOR_RIGHT: dC = (dA != 0); break;
7031 case JIM_EXPROP_BITNOT:
7032 Jim_SetResultString(interp,
7033 "Got floating-point value where integer was expected", -1);
7038 dC = 0; /* avoid gcc warning */
7041 stack[stacklen] = Jim_NewDoubleObj(interp, dC);
7042 Jim_IncrRefCount(stack[stacklen]);
7045 Jim_Panic(interp,"Unknown opcode in Jim_EvalExpression");
7049 /* There is no need to decerement the inUse field because
7050 * this reference is transfered back into the exprObjPtr. */
7051 Jim_FreeIntRep(interp, exprObjPtr);
7052 exprObjPtr->typePtr = &exprObjType;
7053 Jim_SetIntRepPtr(exprObjPtr, expr);
7054 Jim_DecrRefCount(interp, exprObjPtr);
7056 *exprResultPtrPtr = stack[0];
7057 Jim_IncrRefCount(stack[0]);
7058 errRetCode = JIM_OK;
7060 for (i = 0; i < stacklen; i++) {
7061 Jim_DecrRefCount(interp, stack[i]);
7063 if (stack != staticStack)
7068 Jim_SetResultString(interp, "Division by zero", -1);
7072 int Jim_GetBoolFromExpr(Jim_Interp *interp, Jim_Obj *exprObjPtr, int *boolPtr)
7077 Jim_Obj *exprResultPtr;
7079 retcode = Jim_EvalExpression(interp, exprObjPtr, &exprResultPtr);
7080 if (retcode != JIM_OK)
7082 if (JimGetWideNoErr(interp, exprResultPtr, &wideValue) != JIM_OK) {
7083 if (Jim_GetDouble(interp, exprResultPtr, &doubleValue) != JIM_OK)
7085 Jim_DecrRefCount(interp, exprResultPtr);
7088 Jim_DecrRefCount(interp, exprResultPtr);
7089 *boolPtr = doubleValue != 0;
7093 Jim_DecrRefCount(interp, exprResultPtr);
7094 *boolPtr = wideValue != 0;
7098 /* -----------------------------------------------------------------------------
7099 * ScanFormat String Object
7100 * ---------------------------------------------------------------------------*/
7102 /* This Jim_Obj will held a parsed representation of a format string passed to
7103 * the Jim_ScanString command. For error diagnostics, the scanformat string has
7104 * to be parsed in its entirely first and then, if correct, can be used for
7105 * scanning. To avoid endless re-parsing, the parsed representation will be
7106 * stored in an internal representation and re-used for performance reason. */
7108 /* A ScanFmtPartDescr will held the information of /one/ part of the whole
7109 * scanformat string. This part will later be used to extract information
7110 * out from the string to be parsed by Jim_ScanString */
7112 typedef struct ScanFmtPartDescr {
7113 char type; /* Type of conversion (e.g. c, d, f) */
7114 char modifier; /* Modify type (e.g. l - long, h - short */
7115 size_t width; /* Maximal width of input to be converted */
7116 int pos; /* -1 - no assign, 0 - natural pos, >0 - XPG3 pos */
7117 char *arg; /* Specification of a CHARSET conversion */
7118 char *prefix; /* Prefix to be scanned literally before conversion */
7121 /* The ScanFmtStringObj will held the internal representation of a scanformat
7122 * string parsed and separated in part descriptions. Furthermore it contains
7123 * the original string representation of the scanformat string to allow for
7124 * fast update of the Jim_Obj's string representation part.
7126 * As add-on the internal object representation add some scratch pad area
7127 * for usage by Jim_ScanString to avoid endless allocating and freeing of
7128 * memory for purpose of string scanning.
7130 * The error member points to a static allocated string in case of a mal-
7131 * formed scanformat string or it contains '0' (NULL) in case of a valid
7132 * parse representation.
7134 * The whole memory of the internal representation is allocated as a single
7135 * area of memory that will be internally separated. So freeing and duplicating
7136 * of such an object is cheap */
7138 typedef struct ScanFmtStringObj {
7139 jim_wide size; /* Size of internal repr in bytes */
7140 char *stringRep; /* Original string representation */
7141 size_t count; /* Number of ScanFmtPartDescr contained */
7142 size_t convCount; /* Number of conversions that will assign */
7143 size_t maxPos; /* Max position index if XPG3 is used */
7144 const char *error; /* Ptr to error text (NULL if no error */
7145 char *scratch; /* Some scratch pad used by Jim_ScanString */
7146 ScanFmtPartDescr descr[1]; /* The vector of partial descriptions */
7150 static void FreeScanFmtInternalRep(Jim_Interp *interp, Jim_Obj *objPtr);
7151 static void DupScanFmtInternalRep(Jim_Interp *interp, Jim_Obj *srcPtr, Jim_Obj *dupPtr);
7152 static void UpdateStringOfScanFmt(Jim_Obj *objPtr);
7154 static Jim_ObjType scanFmtStringObjType = {
7156 FreeScanFmtInternalRep,
7157 DupScanFmtInternalRep,
7158 UpdateStringOfScanFmt,
7162 void FreeScanFmtInternalRep(Jim_Interp *interp, Jim_Obj *objPtr)
7164 JIM_NOTUSED(interp);
7165 Jim_Free((char*)objPtr->internalRep.ptr);
7166 objPtr->internalRep.ptr = 0;
7169 void DupScanFmtInternalRep(Jim_Interp *interp, Jim_Obj *srcPtr, Jim_Obj *dupPtr)
7171 size_t size = (size_t)((ScanFmtStringObj*)srcPtr->internalRep.ptr)->size;
7172 ScanFmtStringObj *newVec = (ScanFmtStringObj*)Jim_Alloc(size);
7174 JIM_NOTUSED(interp);
7175 memcpy(newVec, srcPtr->internalRep.ptr, size);
7176 dupPtr->internalRep.ptr = newVec;
7177 dupPtr->typePtr = &scanFmtStringObjType;
7180 void UpdateStringOfScanFmt(Jim_Obj *objPtr)
7182 char *bytes = ((ScanFmtStringObj*)objPtr->internalRep.ptr)->stringRep;
7184 objPtr->bytes = Jim_StrDup(bytes);
7185 objPtr->length = strlen(bytes);
7188 /* SetScanFmtFromAny will parse a given string and create the internal
7189 * representation of the format specification. In case of an error
7190 * the error data member of the internal representation will be set
7191 * to an descriptive error text and the function will be left with
7192 * JIM_ERR to indicate unsucessful parsing (aka. malformed scanformat
7195 static int SetScanFmtFromAny(Jim_Interp *interp, Jim_Obj *objPtr)
7197 ScanFmtStringObj *fmtObj;
7199 int maxCount, i, approxSize, lastPos = -1;
7200 const char *fmt = objPtr->bytes;
7201 int maxFmtLen = objPtr->length;
7202 const char *fmtEnd = fmt + maxFmtLen;
7205 Jim_FreeIntRep(interp, objPtr);
7206 /* Count how many conversions could take place maximally */
7207 for (i=0, maxCount=0; i < maxFmtLen; ++i)
7210 /* Calculate an approximation of the memory necessary */
7211 approxSize = sizeof(ScanFmtStringObj) /* Size of the container */
7212 + (maxCount + 1) * sizeof(ScanFmtPartDescr) /* Size of all partials */
7213 + maxFmtLen * sizeof(char) + 3 + 1 /* Scratch + "%n" + '\0' */
7214 + maxFmtLen * sizeof(char) + 1 /* Original stringrep */
7215 + maxFmtLen * sizeof(char) /* Arg for CHARSETs */
7216 + (maxCount +1) * sizeof(char) /* '\0' for every partial */
7217 + 1; /* safety byte */
7218 fmtObj = (ScanFmtStringObj*)Jim_Alloc(approxSize);
7219 memset(fmtObj, 0, approxSize);
7220 fmtObj->size = approxSize;
7222 fmtObj->scratch = (char*)&fmtObj->descr[maxCount+1];
7223 fmtObj->stringRep = fmtObj->scratch + maxFmtLen + 3 + 1;
7224 memcpy(fmtObj->stringRep, fmt, maxFmtLen);
7225 buffer = fmtObj->stringRep + maxFmtLen + 1;
7226 objPtr->internalRep.ptr = fmtObj;
7227 objPtr->typePtr = &scanFmtStringObjType;
7228 for (i=0, curr=0; fmt < fmtEnd; ++fmt) {
7230 ScanFmtPartDescr *descr = &fmtObj->descr[curr];
7232 descr->width = 0; /* Assume width unspecified */
7233 /* Overread and store any "literal" prefix */
7234 if (*fmt != '%' || fmt[1] == '%') {
7236 descr->prefix = &buffer[i];
7237 for (; fmt < fmtEnd; ++fmt) {
7239 if (fmt[1] != '%') break;
7246 /* Skip the conversion introducing '%' sign */
7248 /* End reached due to non-conversion literal only? */
7251 descr->pos = 0; /* Assume "natural" positioning */
7253 descr->pos = -1; /* Okay, conversion will not be assigned */
7256 fmtObj->convCount++; /* Otherwise count as assign-conversion */
7257 /* Check if next token is a number (could be width or pos */
7258 if (sscanf(fmt, "%d%n", &width, &skip) == 1) {
7260 /* Was the number a XPG3 position specifier? */
7261 if (descr->pos != -1 && *fmt == '$') {
7266 /* Look if "natural" postioning and XPG3 one was mixed */
7267 if ((lastPos == 0 && descr->pos > 0)
7268 || (lastPos > 0 && descr->pos == 0)) {
7269 fmtObj->error = "cannot mix \"%\" and \"%n$\" conversion specifiers";
7272 /* Look if this position was already used */
7273 for (prev=0; prev < curr; ++prev) {
7274 if (fmtObj->descr[prev].pos == -1) continue;
7275 if (fmtObj->descr[prev].pos == descr->pos) {
7276 fmtObj->error = "same \"%n$\" conversion specifier "
7277 "used more than once";
7281 /* Try to find a width after the XPG3 specifier */
7282 if (sscanf(fmt, "%d%n", &width, &skip) == 1) {
7283 descr->width = width;
7286 if (descr->pos > 0 && (size_t)descr->pos > fmtObj->maxPos)
7287 fmtObj->maxPos = descr->pos;
7289 /* Number was not a XPG3, so it has to be a width */
7290 descr->width = width;
7293 /* If positioning mode was undetermined yet, fix this */
7295 lastPos = descr->pos;
7296 /* Handle CHARSET conversion type ... */
7298 int swapped = 1, beg = i, end, j;
7300 descr->arg = &buffer[i];
7302 if (*fmt == '^') buffer[i++] = *fmt++;
7303 if (*fmt == ']') buffer[i++] = *fmt++;
7304 while (*fmt && *fmt != ']') buffer[i++] = *fmt++;
7306 fmtObj->error = "unmatched [ in format string";
7311 /* In case a range fence was given "backwards", swap it */
7314 for (j=beg+1; j < end-1; ++j) {
7315 if (buffer[j] == '-' && buffer[j-1] > buffer[j+1]) {
7316 char tmp = buffer[j-1];
7317 buffer[j-1] = buffer[j+1];
7324 /* Remember any valid modifier if given */
7325 if (strchr("hlL", *fmt) != 0)
7326 descr->modifier = tolower((int)*fmt++);
7329 if (strchr("efgcsndoxui", *fmt) == 0) {
7330 fmtObj->error = "bad scan conversion character";
7332 } else if (*fmt == 'c' && descr->width != 0) {
7333 fmtObj->error = "field width may not be specified in %c "
7336 } else if (*fmt == 'u' && descr->modifier == 'l') {
7337 fmtObj->error = "unsigned wide not supported";
7344 if (fmtObj->convCount == 0) {
7345 fmtObj->error = "no any conversion specifier given";
7351 /* Some accessor macros to allow lowlevel access to fields of internal repr */
7353 #define FormatGetCnvCount(_fo_) \
7354 ((ScanFmtStringObj*)((_fo_)->internalRep.ptr))->convCount
7355 #define FormatGetMaxPos(_fo_) \
7356 ((ScanFmtStringObj*)((_fo_)->internalRep.ptr))->maxPos
7357 #define FormatGetError(_fo_) \
7358 ((ScanFmtStringObj*)((_fo_)->internalRep.ptr))->error
7360 /* Some Bit testing/setting/cleaning routines. For now only used in handling
7361 * charsets ([a-z123]) within scanning. Later on perhaps a base for a
7362 * bitvector implementation in Jim? */
7364 static int JimTestBit(const char *bitvec, char ch)
7366 div_t pos = div(ch-1, 8);
7367 return bitvec[pos.quot] & (1 << pos.rem);
7370 static void JimSetBit(char *bitvec, char ch)
7372 div_t pos = div(ch-1, 8);
7373 bitvec[pos.quot] |= (1 << pos.rem);
7376 #if 0 /* currently not used */
7377 static void JimClearBit(char *bitvec, char ch)
7379 div_t pos = div(ch-1, 8);
7380 bitvec[pos.quot] &= ~(1 << pos.rem);
7384 /* JimScanAString is used to scan an unspecified string that ends with
7385 * next WS, or a string that is specified via a charset. The charset
7386 * is currently implemented in a way to only allow for usage with
7387 * ASCII. Whenever we will switch to UNICODE, another idea has to
7390 * FIXME: Works only with ASCII */
7393 JimScanAString(Jim_Interp *interp, const char *sdescr, const char *str)
7397 char charset[256/8+1]; /* A Charset may contain max 256 chars */
7398 char *buffer = Jim_Alloc(strlen(str)+1), *anchor = buffer;
7400 /* First init charset to nothing or all, depending if a specified
7401 * or an unspecified string has to be parsed */
7402 memset(charset, (sdescr ? 0 : 255), sizeof(charset));
7404 /* There was a set description given, that means we are parsing
7405 * a specified string. So we have to build a corresponding
7406 * charset reflecting the description */
7408 /* Should the set be negated at the end? */
7409 if (*sdescr == '^') {
7413 /* Here '-' is meant literally and not to define a range */
7414 if (*sdescr == '-') {
7415 JimSetBit(charset, '-');
7419 if (sdescr[1] == '-' && sdescr[2] != 0) {
7420 /* Handle range definitions */
7422 for (i=sdescr[0]; i <= sdescr[2]; ++i)
7423 JimSetBit(charset, (char)i);
7426 /* Handle verbatim character definitions */
7427 JimSetBit(charset, *sdescr++);
7430 /* Negate the charset if there was a NOT given */
7431 for (i=0; notFlag && i < sizeof(charset); ++i)
7432 charset[i] = ~charset[i];
7434 /* And after all the mess above, the real work begin ... */
7435 while (str && *str) {
7436 if (!sdescr && isspace((int)*str))
7437 break; /* EOS via WS if unspecified */
7438 if (JimTestBit(charset, *str)) *buffer++ = *str++;
7439 else break; /* EOS via mismatch if specified scanning */
7441 *buffer = 0; /* Close the string properly ... */
7442 result = Jim_NewStringObj(interp, anchor, -1);
7443 Jim_Free(anchor); /* ... and free it afer usage */
7447 /* ScanOneEntry will scan one entry out of the string passed as argument.
7448 * It use the sscanf() function for this task. After extracting and
7449 * converting of the value, the count of scanned characters will be
7450 * returned of -1 in case of no conversion tool place and string was
7451 * already scanned thru */
7453 static int ScanOneEntry(Jim_Interp *interp, const char *str, long pos,
7454 ScanFmtStringObj *fmtObj, long index, Jim_Obj **valObjPtr)
7456 # define MAX_SIZE (sizeof(jim_wide) > sizeof(double) \
7457 ? sizeof(jim_wide) \
7459 char buffer[MAX_SIZE];
7460 char *value = buffer;
7462 const ScanFmtPartDescr *descr = &fmtObj->descr[index];
7463 size_t sLen = strlen(&str[pos]), scanned = 0;
7464 size_t anchor = pos;
7467 /* First pessimiticly assume, we will not scan anything :-) */
7469 if (descr->prefix) {
7470 /* There was a prefix given before the conversion, skip it and adjust
7471 * the string-to-be-parsed accordingly */
7472 for (i=0; str[pos] && descr->prefix[i]; ++i) {
7473 /* If prefix require, skip WS */
7474 if (isspace((int)descr->prefix[i]))
7475 while (str[pos] && isspace((int)str[pos])) ++pos;
7476 else if (descr->prefix[i] != str[pos])
7477 break; /* Prefix do not match here, leave the loop */
7479 ++pos; /* Prefix matched so far, next round */
7482 return -1; /* All of str consumed: EOF condition */
7483 else if (descr->prefix[i] != 0)
7484 return 0; /* Not whole prefix consumed, no conversion possible */
7486 /* For all but following conversion, skip leading WS */
7487 if (descr->type != 'c' && descr->type != '[' && descr->type != 'n')
7488 while (isspace((int)str[pos])) ++pos;
7489 /* Determine how much skipped/scanned so far */
7490 scanned = pos - anchor;
7491 if (descr->type == 'n') {
7492 /* Return pseudo conversion means: how much scanned so far? */
7493 *valObjPtr = Jim_NewIntObj(interp, anchor + scanned);
7494 } else if (str[pos] == 0) {
7495 /* Cannot scan anything, as str is totally consumed */
7498 /* Processing of conversions follows ... */
7499 if (descr->width > 0) {
7500 /* Do not try to scan as fas as possible but only the given width.
7501 * To ensure this, we copy the part that should be scanned. */
7502 size_t tLen = descr->width > sLen ? sLen : descr->width;
7503 tok = Jim_StrDupLen(&str[pos], tLen);
7505 /* As no width was given, simply refer to the original string */
7508 switch (descr->type) {
7510 *valObjPtr = Jim_NewIntObj(interp, *tok);
7513 case 'd': case 'o': case 'x': case 'u': case 'i': {
7514 char *endp; /* Position where the number finished */
7515 int base = descr->type == 'o' ? 8
7516 : descr->type == 'x' ? 16
7517 : descr->type == 'i' ? 0
7521 /* Try to scan a number with the given base */
7522 if (descr->modifier == 'l')
7523 #ifdef HAVE_LONG_LONG
7524 *(jim_wide*)value = JimStrtoll(tok, &endp, base);
7526 *(jim_wide*)value = strtol(tok, &endp, base);
7529 if (descr->type == 'u')
7530 *(long*)value = strtoul(tok, &endp, base);
7532 *(long*)value = strtol(tok, &endp, base);
7533 /* If scanning failed, and base was undetermined, simply
7534 * put it to 10 and try once more. This should catch the
7535 * case where %i begin to parse a number prefix (e.g.
7536 * '0x' but no further digits follows. This will be
7537 * handled as a ZERO followed by a char 'x' by Tcl */
7538 if (endp == tok && base == 0) base = 10;
7542 /* There was some number sucessfully scanned! */
7543 if (descr->modifier == 'l')
7544 *valObjPtr = Jim_NewIntObj(interp, *(jim_wide*)value);
7546 *valObjPtr = Jim_NewIntObj(interp, *(long*)value);
7547 /* Adjust the number-of-chars scanned so far */
7548 scanned += endp - tok;
7550 /* Nothing was scanned. We have to determine if this
7551 * happened due to e.g. prefix mismatch or input str
7553 scanned = *tok ? 0 : -1;
7557 case 's': case '[': {
7558 *valObjPtr = JimScanAString(interp, descr->arg, tok);
7559 scanned += Jim_Length(*valObjPtr);
7562 case 'e': case 'f': case 'g': {
7565 *(double*)value = strtod(tok, &endp);
7567 /* There was some number sucessfully scanned! */
7568 *valObjPtr = Jim_NewDoubleObj(interp, *(double*)value);
7569 /* Adjust the number-of-chars scanned so far */
7570 scanned += endp - tok;
7572 /* Nothing was scanned. We have to determine if this
7573 * happened due to e.g. prefix mismatch or input str
7575 scanned = *tok ? 0 : -1;
7580 /* If a substring was allocated (due to pre-defined width) do not
7581 * forget to free it */
7582 if (tok != &str[pos])
7583 Jim_Free((char*)tok);
7588 /* Jim_ScanString is the workhorse of string scanning. It will scan a given
7589 * string and returns all converted (and not ignored) values in a list back
7590 * to the caller. If an error occured, a NULL pointer will be returned */
7592 Jim_Obj *Jim_ScanString(Jim_Interp *interp, Jim_Obj *strObjPtr,
7593 Jim_Obj *fmtObjPtr, int flags)
7597 const char *str = Jim_GetString(strObjPtr, 0);
7598 Jim_Obj *resultList = 0;
7599 Jim_Obj **resultVec;
7601 Jim_Obj *emptyStr = 0;
7602 ScanFmtStringObj *fmtObj;
7604 /* If format specification is not an object, convert it! */
7605 if (fmtObjPtr->typePtr != &scanFmtStringObjType)
7606 SetScanFmtFromAny(interp, fmtObjPtr);
7607 fmtObj = (ScanFmtStringObj*)fmtObjPtr->internalRep.ptr;
7608 /* Check if format specification was valid */
7609 if (fmtObj->error != 0) {
7610 if (flags & JIM_ERRMSG)
7611 Jim_SetResultString(interp, fmtObj->error, -1);
7614 /* Allocate a new "shared" empty string for all unassigned conversions */
7615 emptyStr = Jim_NewEmptyStringObj(interp);
7616 Jim_IncrRefCount(emptyStr);
7617 /* Create a list and fill it with empty strings up to max specified XPG3 */
7618 resultList = Jim_NewListObj(interp, 0, 0);
7619 if (fmtObj->maxPos > 0) {
7620 for (i=0; i < fmtObj->maxPos; ++i)
7621 Jim_ListAppendElement(interp, resultList, emptyStr);
7622 JimListGetElements(interp, resultList, &resultc, &resultVec);
7624 /* Now handle every partial format description */
7625 for (i=0, pos=0; i < fmtObj->count; ++i) {
7626 ScanFmtPartDescr *descr = &(fmtObj->descr[i]);
7628 /* Only last type may be "literal" w/o conversion - skip it! */
7629 if (descr->type == 0) continue;
7630 /* As long as any conversion could be done, we will proceed */
7632 scanned = ScanOneEntry(interp, str, pos, fmtObj, i, &value);
7633 /* In case our first try results in EOF, we will leave */
7634 if (scanned == -1 && i == 0)
7636 /* Advance next pos-to-be-scanned for the amount scanned already */
7638 /* value == 0 means no conversion took place so take empty string */
7640 value = Jim_NewEmptyStringObj(interp);
7641 /* If value is a non-assignable one, skip it */
7642 if (descr->pos == -1) {
7643 Jim_FreeNewObj(interp, value);
7644 } else if (descr->pos == 0)
7645 /* Otherwise append it to the result list if no XPG3 was given */
7646 Jim_ListAppendElement(interp, resultList, value);
7647 else if (resultVec[descr->pos-1] == emptyStr) {
7648 /* But due to given XPG3, put the value into the corr. slot */
7649 Jim_DecrRefCount(interp, resultVec[descr->pos-1]);
7650 Jim_IncrRefCount(value);
7651 resultVec[descr->pos-1] = value;
7653 /* Otherwise, the slot was already used - free obj and ERROR */
7654 Jim_FreeNewObj(interp, value);
7658 Jim_DecrRefCount(interp, emptyStr);
7661 Jim_DecrRefCount(interp, emptyStr);
7662 Jim_FreeNewObj(interp, resultList);
7663 return (Jim_Obj*)EOF;
7665 Jim_DecrRefCount(interp, emptyStr);
7666 Jim_FreeNewObj(interp, resultList);
7670 /* -----------------------------------------------------------------------------
7671 * Pseudo Random Number Generation
7672 * ---------------------------------------------------------------------------*/
7673 static void JimPrngSeed(Jim_Interp *interp, const unsigned char *seed,
7676 /* Initialize the sbox with the numbers from 0 to 255 */
7677 static void JimPrngInit(Jim_Interp *interp)
7680 unsigned int seed[256];
7682 interp->prngState = Jim_Alloc(sizeof(Jim_PrngState));
7683 for (i = 0; i < 256; i++)
7684 seed[i] = (rand() ^ time(NULL) ^ clock());
7685 JimPrngSeed(interp, (unsigned char*) seed, sizeof(int)*256);
7688 /* Generates N bytes of random data */
7689 static void JimRandomBytes(Jim_Interp *interp, void *dest, unsigned int len)
7691 Jim_PrngState *prng;
7692 unsigned char *destByte = (unsigned char*) dest;
7693 unsigned int si, sj, x;
7695 /* initialization, only needed the first time */
7696 if (interp->prngState == NULL)
7697 JimPrngInit(interp);
7698 prng = interp->prngState;
7699 /* generates 'len' bytes of pseudo-random numbers */
7700 for (x = 0; x < len; x++) {
7701 prng->i = (prng->i+1) & 0xff;
7702 si = prng->sbox[prng->i];
7703 prng->j = (prng->j + si) & 0xff;
7704 sj = prng->sbox[prng->j];
7705 prng->sbox[prng->i] = sj;
7706 prng->sbox[prng->j] = si;
7707 *destByte++ = prng->sbox[(si+sj)&0xff];
7711 /* Re-seed the generator with user-provided bytes */
7712 static void JimPrngSeed(Jim_Interp *interp, const unsigned char *seed,
7716 unsigned char buf[256];
7717 Jim_PrngState *prng;
7719 /* initialization, only needed the first time */
7720 if (interp->prngState == NULL)
7721 JimPrngInit(interp);
7722 prng = interp->prngState;
7724 /* Set the sbox[i] with i */
7725 for (i = 0; i < 256; i++)
7727 /* Now use the seed to perform a random permutation of the sbox */
7728 for (i = 0; i < seedLen; i++) {
7731 t = prng->sbox[i&0xFF];
7732 prng->sbox[i&0xFF] = prng->sbox[seed[i]];
7733 prng->sbox[seed[i]] = t;
7735 prng->i = prng->j = 0;
7736 /* discard the first 256 bytes of stream. */
7737 JimRandomBytes(interp, buf, 256);
7740 /* -----------------------------------------------------------------------------
7741 * Dynamic libraries support (WIN32 not supported)
7742 * ---------------------------------------------------------------------------*/
7747 void * dlopen(const char *path, int mode)
7751 return (void *)LoadLibraryA(path);
7753 int dlclose(void *handle)
7755 FreeLibrary((HANDLE)handle);
7758 void *dlsym(void *handle, const char *symbol)
7760 return GetProcAddress((HMODULE)handle, symbol);
7762 static char win32_dlerror_string[121];
7763 const char *dlerror(void)
7765 FormatMessageA(FORMAT_MESSAGE_FROM_SYSTEM, NULL, GetLastError(),
7766 LANG_NEUTRAL, win32_dlerror_string, 120, NULL);
7767 return win32_dlerror_string;
7771 int Jim_LoadLibrary(Jim_Interp *interp, const char *pathName)
7773 Jim_Obj *libPathObjPtr;
7776 int (*onload)(Jim_Interp *interp);
7778 libPathObjPtr = Jim_GetGlobalVariableStr(interp, "jim_libpath", JIM_NONE);
7779 if (libPathObjPtr == NULL) {
7781 libPathObjPtr = NULL;
7783 Jim_IncrRefCount(libPathObjPtr);
7784 Jim_ListLength(interp, libPathObjPtr, &prefixc);
7787 for (i = -1; i < prefixc; i++) {
7789 handle = dlopen(pathName, RTLD_LAZY);
7792 char buf[JIM_PATH_LEN];
7795 Jim_Obj *prefixObjPtr;
7798 if (Jim_ListIndex(interp, libPathObjPtr, i,
7799 &prefixObjPtr, JIM_NONE) != JIM_OK)
7801 prefix = Jim_GetString(prefixObjPtr, NULL);
7802 prefixlen = strlen(prefix);
7803 if (prefixlen+strlen(pathName)+1 >= JIM_PATH_LEN)
7805 if (prefixlen && prefix[prefixlen-1] == '/')
7806 sprintf(buf, "%s%s", prefix, pathName);
7808 sprintf(buf, "%s/%s", prefix, pathName);
7809 printf("opening '%s'\n", buf);
7810 fp = fopen(buf, "r");
7814 handle = dlopen(buf, RTLD_LAZY);
7815 printf("got handle %p\n", handle);
7817 if (handle == NULL) {
7818 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
7819 Jim_AppendStrings(interp, Jim_GetResult(interp),
7820 "error loading extension \"", pathName,
7821 "\": ", dlerror(), NULL);
7826 if ((onload = dlsym(handle, "Jim_OnLoad")) == NULL) {
7827 Jim_SetResultString(interp,
7828 "No Jim_OnLoad symbol found on extension", -1);
7831 if (onload(interp) == JIM_ERR) {
7835 Jim_SetEmptyResult(interp);
7836 if (libPathObjPtr != NULL)
7837 Jim_DecrRefCount(interp, libPathObjPtr);
7841 if (libPathObjPtr != NULL)
7842 Jim_DecrRefCount(interp, libPathObjPtr);
7845 #else /* JIM_DYNLIB */
7846 int Jim_LoadLibrary(Jim_Interp *interp, const char *pathName)
7848 JIM_NOTUSED(interp);
7849 JIM_NOTUSED(pathName);
7851 Jim_SetResultString(interp, "the Jim binary has no support for [load]", -1);
7854 #endif/* JIM_DYNLIB */
7856 /* -----------------------------------------------------------------------------
7858 * ---------------------------------------------------------------------------*/
7860 #define JIM_PKG_ANY_VERSION -1
7862 /* Convert a string of the type "1.2" into an integer.
7863 * MAJOR.MINOR is converted as MAJOR*100+MINOR, so "1.2" is converted
7864 * to the integer with value 102 */
7865 static int JimPackageVersionToInt(Jim_Interp *interp, const char *v,
7866 int *intPtr, int flags)
7869 jim_wide major, minor;
7870 char *majorStr, *minorStr, *p;
7873 *intPtr = JIM_PKG_ANY_VERSION;
7877 copy = Jim_StrDup(v);
7878 p = strchr(copy, '.');
7879 if (p == NULL) goto badfmt;
7884 if (Jim_StringToWide(majorStr, &major, 10) != JIM_OK ||
7885 Jim_StringToWide(minorStr, &minor, 10) != JIM_OK)
7887 *intPtr = (int)(major*100+minor);
7893 if (flags & JIM_ERRMSG) {
7894 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
7895 Jim_AppendStrings(interp, Jim_GetResult(interp),
7896 "invalid package version '", v, "'", NULL);
7901 #define JIM_MATCHVER_EXACT (1<<JIM_PRIV_FLAG_SHIFT)
7902 static int JimPackageMatchVersion(int needed, int actual, int flags)
7904 if (needed == JIM_PKG_ANY_VERSION) return 1;
7905 if (flags & JIM_MATCHVER_EXACT) {
7906 return needed == actual;
7908 return needed/100 == actual/100 && (needed <= actual);
7912 int Jim_PackageProvide(Jim_Interp *interp, const char *name, const char *ver,
7916 /* Check if the version format is ok */
7917 if (JimPackageVersionToInt(interp, ver, &intVersion, JIM_ERRMSG) != JIM_OK)
7919 /* If the package was already provided returns an error. */
7920 if (Jim_FindHashEntry(&interp->packages, name) != NULL) {
7921 if (flags & JIM_ERRMSG) {
7922 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
7923 Jim_AppendStrings(interp, Jim_GetResult(interp),
7924 "package '", name, "' was already provided", NULL);
7928 Jim_AddHashEntry(&interp->packages, name, (char*) ver);
7935 # include <sys/types.h>
7936 # include <dirent.h>
7939 /* Posix dirent.h compatiblity layer for WIN32.
7940 * Copyright Kevlin Henney, 1997, 2003. All rights reserved.
7941 * Copyright Salvatore Sanfilippo ,2005.
7943 * Permission to use, copy, modify, and distribute this software and its
7944 * documentation for any purpose is hereby granted without fee, provided
7945 * that this copyright and permissions notice appear in all copies and
7948 * This software is supplied "as is" without express or implied warranty.
7949 * This software was modified by Salvatore Sanfilippo for the Jim Interpreter.
7956 typedef struct DIR {
7957 long handle; /* -1 for failed rewind */
7958 struct _finddata_t info;
7959 struct dirent result; /* d_name null iff first time */
7960 char *name; /* null-terminated char string */
7963 DIR *opendir(const char *name)
7967 if(name && name[0]) {
7968 size_t base_length = strlen(name);
7969 const char *all = /* search pattern must end with suitable wildcard */
7970 strchr("/\\", name[base_length - 1]) ? "*" : "/*";
7972 if((dir = (DIR *) Jim_Alloc(sizeof *dir)) != 0 &&
7973 (dir->name = (char *) Jim_Alloc(base_length + strlen(all) + 1)) != 0)
7975 strcat(strcpy(dir->name, name), all);
7977 if((dir->handle = (long) _findfirst(dir->name, &dir->info)) != -1)
7978 dir->result.d_name = 0;
7979 else { /* rollback */
7980 Jim_Free(dir->name);
7984 } else { /* rollback */
7995 int closedir(DIR *dir)
8000 if(dir->handle != -1)
8001 result = _findclose(dir->handle);
8002 Jim_Free(dir->name);
8005 if(result == -1) /* map all errors to EBADF */
8010 struct dirent *readdir(DIR *dir)
8012 struct dirent *result = 0;
8014 if(dir && dir->handle != -1) {
8015 if(!dir->result.d_name || _findnext(dir->handle, &dir->info) != -1) {
8016 result = &dir->result;
8017 result->d_name = dir->info.name;
8027 static char *JimFindBestPackage(Jim_Interp *interp, char **prefixes,
8028 int prefixc, const char *pkgName, int pkgVer, int flags)
8030 int bestVer = -1, i;
8031 int pkgNameLen = strlen(pkgName);
8032 char *bestPackage = NULL;
8035 for (i = 0; i < prefixc; i++) {
8037 char buf[JIM_PATH_LEN];
8040 if (prefixes[i] == NULL) continue;
8041 strncpy(buf, prefixes[i], JIM_PATH_LEN);
8042 buf[JIM_PATH_LEN-1] = '\0';
8043 prefixLen = strlen(buf);
8044 if (prefixLen && buf[prefixLen-1] == '/')
8045 buf[prefixLen-1] = '\0';
8047 if ((dir = opendir(buf)) == NULL) continue;
8048 while ((de = readdir(dir)) != NULL) {
8049 char *fileName = de->d_name;
8050 int fileNameLen = strlen(fileName);
8052 if (strncmp(fileName, "jim-", 4) == 0 &&
8053 strncmp(fileName+4, pkgName, pkgNameLen) == 0 &&
8054 *(fileName+4+pkgNameLen) == '-' &&
8055 fileNameLen > 4 && /* note that this is not really useful */
8056 (strncmp(fileName+fileNameLen-4, ".tcl", 4) == 0 ||
8057 strncmp(fileName+fileNameLen-4, ".dll", 4) == 0 ||
8058 strncmp(fileName+fileNameLen-3, ".so", 3) == 0))
8060 char ver[6]; /* xx.yy<nulterm> */
8061 char *p = strrchr(fileName, '.');
8062 int verLen, fileVer;
8064 verLen = p - (fileName+4+pkgNameLen+1);
8065 if (verLen < 3 || verLen > 5) continue;
8066 memcpy(ver, fileName+4+pkgNameLen+1, verLen);
8068 if (JimPackageVersionToInt(interp, ver, &fileVer, JIM_NONE)
8069 != JIM_OK) continue;
8070 if (JimPackageMatchVersion(pkgVer, fileVer, flags) &&
8071 (bestVer == -1 || bestVer < fileVer))
8074 Jim_Free(bestPackage);
8075 bestPackage = Jim_Alloc(strlen(buf)+strlen(fileName)+2);
8076 sprintf(bestPackage, "%s/%s", buf, fileName);
8085 #else /* JIM_ANSIC */
8087 static char *JimFindBestPackage(Jim_Interp *interp, char **prefixes,
8088 int prefixc, const char *pkgName, int pkgVer, int flags)
8090 JIM_NOTUSED(interp);
8091 JIM_NOTUSED(prefixes);
8092 JIM_NOTUSED(prefixc);
8093 JIM_NOTUSED(pkgName);
8094 JIM_NOTUSED(pkgVer);
8099 #endif /* JIM_ANSIC */
8101 /* Search for a suitable package under every dir specified by jim_libpath
8102 * and load it if possible. If a suitable package was loaded with success
8103 * JIM_OK is returned, otherwise JIM_ERR is returned. */
8104 static int JimLoadPackage(Jim_Interp *interp, const char *name, int ver,
8107 Jim_Obj *libPathObjPtr;
8108 char **prefixes, *best;
8109 int prefixc, i, retCode = JIM_OK;
8111 libPathObjPtr = Jim_GetGlobalVariableStr(interp, "jim_libpath", JIM_NONE);
8112 if (libPathObjPtr == NULL) {
8114 libPathObjPtr = NULL;
8116 Jim_IncrRefCount(libPathObjPtr);
8117 Jim_ListLength(interp, libPathObjPtr, &prefixc);
8120 prefixes = Jim_Alloc(sizeof(char*)*prefixc);
8121 for (i = 0; i < prefixc; i++) {
8122 Jim_Obj *prefixObjPtr;
8123 if (Jim_ListIndex(interp, libPathObjPtr, i,
8124 &prefixObjPtr, JIM_NONE) != JIM_OK)
8129 prefixes[i] = Jim_StrDup(Jim_GetString(prefixObjPtr, NULL));
8131 /* Scan every directory to find the "best" package. */
8132 best = JimFindBestPackage(interp, prefixes, prefixc, name, ver, flags);
8134 char *p = strrchr(best, '.');
8135 /* Try to load/source it */
8136 if (p && strcmp(p, ".tcl") == 0) {
8137 retCode = Jim_EvalFile(interp, best);
8139 retCode = Jim_LoadLibrary(interp, best);
8145 for (i = 0; i < prefixc; i++)
8146 Jim_Free(prefixes[i]);
8149 Jim_DecrRefCount(interp, libPathObjPtr);
8153 const char *Jim_PackageRequire(Jim_Interp *interp, const char *name,
8154 const char *ver, int flags)
8159 if (JimPackageVersionToInt(interp, ver, &requiredVer, JIM_ERRMSG) != JIM_OK)
8161 he = Jim_FindHashEntry(&interp->packages, name);
8163 /* Try to load the package. */
8164 if (JimLoadPackage(interp, name, requiredVer, flags) == JIM_OK) {
8165 he = Jim_FindHashEntry(&interp->packages, name);
8171 /* No way... return an error. */
8172 if (flags & JIM_ERRMSG) {
8173 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
8174 Jim_AppendStrings(interp, Jim_GetResult(interp),
8175 "Can't find package '", name, "'", NULL);
8180 if (JimPackageVersionToInt(interp, he->val, &actualVer, JIM_ERRMSG)
8185 /* Check if version matches. */
8186 if (JimPackageMatchVersion(requiredVer, actualVer, flags) == 0) {
8187 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
8188 Jim_AppendStrings(interp, Jim_GetResult(interp),
8189 "Package '", name, "' already loaded, but with version ",
8197 /* -----------------------------------------------------------------------------
8199 * ---------------------------------------------------------------------------*/
8200 #define JIM_EVAL_SARGV_LEN 8 /* static arguments vector length */
8201 #define JIM_EVAL_SINTV_LEN 8 /* static interpolation vector length */
8203 static int JimCallProcedure(Jim_Interp *interp, Jim_Cmd *cmd, int argc,
8204 Jim_Obj *const *argv);
8206 /* Handle calls to the [unknown] command */
8207 static int JimUnknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
8209 Jim_Obj **v, *sv[JIM_EVAL_SARGV_LEN];
8212 /* If the [unknown] command does not exists returns
8214 if (Jim_GetCommand(interp, interp->unknown, JIM_NONE) == NULL)
8217 /* The object interp->unknown just contains
8218 * the "unknown" string, it is used in order to
8219 * avoid to lookup the unknown command every time
8220 * but instread to cache the result. */
8221 if (argc+1 <= JIM_EVAL_SARGV_LEN)
8224 v = Jim_Alloc(sizeof(Jim_Obj*)*(argc+1));
8225 /* Make a copy of the arguments vector, but shifted on
8226 * the right of one position. The command name of the
8227 * command will be instead the first argument of the
8228 * [unknonw] call. */
8229 memcpy(v+1, argv, sizeof(Jim_Obj*)*argc);
8230 v[0] = interp->unknown;
8232 retCode = Jim_EvalObjVector(interp, argc+1, v);
8239 /* Eval the object vector 'objv' composed of 'objc' elements.
8240 * Every element is used as single argument.
8241 * Jim_EvalObj() will call this function every time its object
8242 * argument is of "list" type, with no string representation.
8244 * This is possible because the string representation of a
8245 * list object generated by the UpdateStringOfList is made
8246 * in a way that ensures that every list element is a different
8247 * command argument. */
8248 int Jim_EvalObjVector(Jim_Interp *interp, int objc, Jim_Obj *const *objv)
8253 /* Incr refcount of arguments. */
8254 for (i = 0; i < objc; i++)
8255 Jim_IncrRefCount(objv[i]);
8256 /* Command lookup */
8257 cmdPtr = Jim_GetCommand(interp, objv[0], JIM_ERRMSG);
8258 if (cmdPtr == NULL) {
8259 retcode = JimUnknown(interp, objc, objv);
8261 /* Call it -- Make sure result is an empty object. */
8262 Jim_SetEmptyResult(interp);
8263 if (cmdPtr->cmdProc) {
8264 interp->cmdPrivData = cmdPtr->privData;
8265 retcode = cmdPtr->cmdProc(interp, objc, objv);
8267 retcode = JimCallProcedure(interp, cmdPtr, objc, objv);
8268 if (retcode == JIM_ERR) {
8269 JimAppendStackTrace(interp,
8270 Jim_GetString(objv[0], NULL), "?", 1);
8274 /* Decr refcount of arguments and return the retcode */
8275 for (i = 0; i < objc; i++)
8276 Jim_DecrRefCount(interp, objv[i]);
8280 /* Interpolate the given tokens into a unique Jim_Obj returned by reference
8281 * via *objPtrPtr. This function is only called by Jim_EvalObj().
8282 * The returned object has refcount = 0. */
8283 int Jim_InterpolateTokens(Jim_Interp *interp, ScriptToken *token,
8284 int tokens, Jim_Obj **objPtrPtr)
8286 int totlen = 0, i, retcode;
8288 Jim_Obj *sintv[JIM_EVAL_SINTV_LEN];
8292 if (tokens <= JIM_EVAL_SINTV_LEN)
8295 intv = Jim_Alloc(sizeof(Jim_Obj*)*
8297 /* Compute every token forming the argument
8298 * in the intv objects vector. */
8299 for (i = 0; i < tokens; i++) {
8300 switch(token[i].type) {
8303 intv[i] = token[i].objPtr;
8306 intv[i] = Jim_GetVariable(interp, token[i].objPtr, JIM_ERRMSG);
8312 case JIM_TT_DICTSUGAR:
8313 intv[i] = Jim_ExpandDictSugar(interp, token[i].objPtr);
8320 retcode = Jim_EvalObj(interp, token[i].objPtr);
8321 if (retcode != JIM_OK)
8323 intv[i] = Jim_GetResult(interp);
8327 "default token type reached "
8328 "in Jim_InterpolateTokens().");
8331 Jim_IncrRefCount(intv[i]);
8332 /* Make sure there is a valid
8333 * string rep, and add the string
8334 * length to the total legnth. */
8335 Jim_GetString(intv[i], NULL);
8336 totlen += intv[i]->length;
8338 /* Concatenate every token in an unique
8340 objPtr = Jim_NewStringObjNoAlloc(interp,
8342 s = objPtr->bytes = Jim_Alloc(totlen+1);
8343 objPtr->length = totlen;
8344 for (i = 0; i < tokens; i++) {
8345 memcpy(s, intv[i]->bytes, intv[i]->length);
8346 s += intv[i]->length;
8347 Jim_DecrRefCount(interp, intv[i]);
8349 objPtr->bytes[totlen] = '\0';
8350 /* Free the intv vector if not static. */
8351 if (tokens > JIM_EVAL_SINTV_LEN)
8353 *objPtrPtr = objPtr;
8358 Jim_DecrRefCount(interp, intv[i]);
8359 if (tokens > JIM_EVAL_SINTV_LEN)
8364 /* Helper of Jim_EvalObj() to perform argument expansion.
8365 * Basically this function append an argument to 'argv'
8366 * (and increments argc by reference accordingly), performing
8367 * expansion of the list object if 'expand' is non-zero, or
8368 * just adding objPtr to argv if 'expand' is zero. */
8369 void Jim_ExpandArgument(Jim_Interp *interp, Jim_Obj ***argv,
8370 int *argcPtr, int expand, Jim_Obj *objPtr)
8373 (*argv) = Jim_Realloc(*argv, sizeof(Jim_Obj*)*((*argcPtr)+1));
8374 /* refcount of objPtr not incremented because
8375 * we are actually transfering a reference from
8376 * the old 'argv' to the expanded one. */
8377 (*argv)[*argcPtr] = objPtr;
8382 Jim_ListLength(interp, objPtr, &len);
8383 (*argv) = Jim_Realloc(*argv, sizeof(Jim_Obj*)*((*argcPtr)+len));
8384 for (i = 0; i < len; i++) {
8385 (*argv)[*argcPtr] = objPtr->internalRep.listValue.ele[i];
8386 Jim_IncrRefCount(objPtr->internalRep.listValue.ele[i]);
8389 /* The original object reference is no longer needed,
8390 * after the expansion it is no longer present on
8391 * the argument vector, but the single elements are
8393 Jim_DecrRefCount(interp, objPtr);
8397 int Jim_EvalObj(Jim_Interp *interp, Jim_Obj *scriptObjPtr)
8402 int *cs; /* command structure array */
8403 int retcode = JIM_OK;
8404 Jim_Obj *sargv[JIM_EVAL_SARGV_LEN], **argv = NULL, *tmpObjPtr;
8406 interp->errorFlag = 0;
8408 /* If the object is of type "list" and there is no
8409 * string representation for this object, we can call
8410 * a specialized version of Jim_EvalObj() */
8411 if (scriptObjPtr->typePtr == &listObjType &&
8412 scriptObjPtr->internalRep.listValue.len &&
8413 scriptObjPtr->bytes == NULL) {
8414 Jim_IncrRefCount(scriptObjPtr);
8415 retcode = Jim_EvalObjVector(interp,
8416 scriptObjPtr->internalRep.listValue.len,
8417 scriptObjPtr->internalRep.listValue.ele);
8418 Jim_DecrRefCount(interp, scriptObjPtr);
8422 Jim_IncrRefCount(scriptObjPtr); /* Make sure it's shared. */
8423 script = Jim_GetScript(interp, scriptObjPtr);
8424 /* Now we have to make sure the internal repr will not be
8425 * freed on shimmering.
8427 * Think for example to this:
8429 * set x {llength $x; ... some more code ...}; eval $x
8431 * In order to preserve the internal rep, we increment the
8432 * inUse field of the script internal rep structure. */
8435 token = script->token;
8437 cs = script->cmdStruct;
8438 i = 0; /* 'i' is the current token index. */
8440 /* Reset the interpreter result. This is useful to
8441 * return the emtpy result in the case of empty program. */
8442 Jim_SetEmptyResult(interp);
8444 /* Execute every command sequentially, returns on
8445 * error (i.e. if a command does not return JIM_OK) */
8448 int argc = *cs++; /* Get the number of arguments */
8451 /* Set the expand flag if needed. */
8456 /* Allocate the arguments vector */
8457 if (argc <= JIM_EVAL_SARGV_LEN)
8460 argv = Jim_Alloc(sizeof(Jim_Obj*)*argc);
8461 /* Populate the arguments objects. */
8462 for (j = 0; j < argc; j++) {
8465 /* tokens is negative if expansion is needed.
8466 * for this argument. */
8468 tokens = (-tokens)-1;
8472 /* Fast path if the token does not
8473 * need interpolation */
8474 switch(token[i].type) {
8477 argv[j] = token[i].objPtr;
8480 tmpObjPtr = Jim_GetVariable(interp, token[i].objPtr,
8486 argv[j] = tmpObjPtr;
8488 case JIM_TT_DICTSUGAR:
8489 tmpObjPtr = Jim_ExpandDictSugar(interp, token[i].objPtr);
8494 argv[j] = tmpObjPtr;
8497 retcode = Jim_EvalObj(interp, token[i].objPtr);
8498 if (retcode != JIM_OK)
8500 argv[j] = Jim_GetResult(interp);
8504 "default token type reached "
8505 "in Jim_EvalObj().");
8508 Jim_IncrRefCount(argv[j]);
8511 /* For interpolation we call an helper
8512 * function doing the work for us. */
8513 if ((retcode = Jim_InterpolateTokens(interp,
8514 token+i, tokens, &tmpObjPtr)) != JIM_OK)
8518 argv[j] = tmpObjPtr;
8519 Jim_IncrRefCount(argv[j]);
8523 /* Handle {expand} expansion */
8525 int *ecs = cs - argc;
8527 Jim_Obj **eargv = NULL;
8529 for (j = 0; j < argc; j++) {
8530 Jim_ExpandArgument( interp, &eargv, &eargc,
8531 ecs[j] < 0, argv[j]);
8539 /* Nothing to do with zero args. */
8544 /* Lookup the command to call */
8545 cmd = Jim_GetCommand(interp, argv[0], JIM_ERRMSG);
8547 /* Call it -- Make sure result is an empty object. */
8548 Jim_SetEmptyResult(interp);
8550 interp->cmdPrivData = cmd->privData;
8551 retcode = cmd->cmdProc(interp, argc, argv);
8553 retcode = JimCallProcedure(interp, cmd, argc, argv);
8554 if (retcode == JIM_ERR) {
8555 JimAppendStackTrace(interp,
8556 Jim_GetString(argv[0], NULL), script->fileName,
8557 token[i-argc*2].linenr);
8561 /* Call [unknown] */
8562 retcode = JimUnknown(interp, argc, argv);
8563 if (retcode == JIM_ERR) {
8564 JimAppendStackTrace(interp,
8565 Jim_GetString(argv[0], NULL), script->fileName,
8566 token[i-argc*2].linenr);
8569 if (retcode != JIM_OK) {
8570 i -= argc*2; /* point to the command name. */
8573 /* Decrement the arguments count */
8574 for (j = 0; j < argc; j++) {
8575 Jim_DecrRefCount(interp, argv[j]);
8578 if (argv != sargv) {
8583 /* Note that we don't have to decrement inUse, because the
8584 * following code transfers our use of the reference again to
8585 * the script object. */
8586 j = 0; /* on normal termination, the argv array is already
8587 Jim_DecrRefCount-ed. */
8589 /* Handle errors. */
8590 if (retcode == JIM_ERR && !interp->errorFlag) {
8591 interp->errorFlag = 1;
8592 JimSetErrorFileName(interp, script->fileName);
8593 JimSetErrorLineNumber(interp, token[i].linenr);
8594 JimResetStackTrace(interp);
8596 Jim_FreeIntRep(interp, scriptObjPtr);
8597 scriptObjPtr->typePtr = &scriptObjType;
8598 Jim_SetIntRepPtr(scriptObjPtr, script);
8599 Jim_DecrRefCount(interp, scriptObjPtr);
8600 for (i = 0; i < j; i++) {
8601 Jim_DecrRefCount(interp, argv[i]);
8608 /* Call a procedure implemented in Tcl.
8609 * It's possible to speed-up a lot this function, currently
8610 * the callframes are not cached, but allocated and
8611 * destroied every time. What is expecially costly is
8612 * to create/destroy the local vars hash table every time.
8614 * This can be fixed just implementing callframes caching
8615 * in JimCreateCallFrame() and JimFreeCallFrame(). */
8616 int JimCallProcedure(Jim_Interp *interp, Jim_Cmd *cmd, int argc,
8617 Jim_Obj *const *argv)
8620 Jim_CallFrame *callFramePtr;
8623 if (argc < cmd->arityMin || (cmd->arityMax != -1 &&
8624 argc > cmd->arityMax)) {
8625 Jim_Obj *objPtr = Jim_NewEmptyStringObj(interp);
8626 Jim_AppendStrings(interp, objPtr,
8627 "wrong # args: should be \"", Jim_GetString(argv[0], NULL),
8628 (cmd->arityMin > 1) ? " " : "",
8629 Jim_GetString(cmd->argListObjPtr, NULL), "\"", NULL);
8630 Jim_SetResult(interp, objPtr);
8633 /* Check if there are too nested calls */
8634 if (interp->numLevels == interp->maxNestingDepth) {
8635 Jim_SetResultString(interp,
8636 "Too many nested calls. Infinite recursion?", -1);
8639 /* Create a new callframe */
8640 callFramePtr = JimCreateCallFrame(interp);
8641 callFramePtr->parentCallFrame = interp->framePtr;
8642 callFramePtr->argv = argv;
8643 callFramePtr->argc = argc;
8644 callFramePtr->procArgsObjPtr = cmd->argListObjPtr;
8645 callFramePtr->procBodyObjPtr = cmd->bodyObjPtr;
8646 callFramePtr->staticVars = cmd->staticVars;
8647 Jim_IncrRefCount(cmd->argListObjPtr);
8648 Jim_IncrRefCount(cmd->bodyObjPtr);
8649 interp->framePtr = callFramePtr;
8650 interp->numLevels ++;
8652 for (i = 0; i < cmd->arityMin-1; i++) {
8655 Jim_ListIndex(interp, cmd->argListObjPtr, i, &objPtr, JIM_NONE);
8656 Jim_SetVariable(interp, objPtr, argv[i+1]);
8658 if (cmd->arityMax == -1) {
8659 Jim_Obj *listObjPtr, *objPtr;
8661 listObjPtr = Jim_NewListObj(interp, argv+cmd->arityMin,
8662 argc-cmd->arityMin);
8663 Jim_ListIndex(interp, cmd->argListObjPtr, i, &objPtr, JIM_NONE);
8664 Jim_SetVariable(interp, objPtr, listObjPtr);
8667 retcode = Jim_EvalObj(interp, cmd->bodyObjPtr);
8669 /* Destroy the callframe */
8670 interp->numLevels --;
8671 interp->framePtr = interp->framePtr->parentCallFrame;
8672 if (callFramePtr->vars.size != JIM_HT_INITIAL_SIZE) {
8673 JimFreeCallFrame(interp, callFramePtr, JIM_FCF_NONE);
8675 JimFreeCallFrame(interp, callFramePtr, JIM_FCF_NOHT);
8677 /* Handle the JIM_EVAL return code */
8678 if (retcode == JIM_EVAL && interp->evalRetcodeLevel != interp->numLevels) {
8679 int savedLevel = interp->evalRetcodeLevel;
8681 interp->evalRetcodeLevel = interp->numLevels;
8682 while (retcode == JIM_EVAL) {
8683 Jim_Obj *resultScriptObjPtr = Jim_GetResult(interp);
8684 Jim_IncrRefCount(resultScriptObjPtr);
8685 retcode = Jim_EvalObj(interp, resultScriptObjPtr);
8686 Jim_DecrRefCount(interp, resultScriptObjPtr);
8688 interp->evalRetcodeLevel = savedLevel;
8690 /* Handle the JIM_RETURN return code */
8691 if (retcode == JIM_RETURN) {
8692 retcode = interp->returnCode;
8693 interp->returnCode = JIM_OK;
8698 int Jim_Eval(Jim_Interp *interp, const char *script)
8700 Jim_Obj *scriptObjPtr = Jim_NewStringObj(interp, script, -1);
8703 Jim_IncrRefCount(scriptObjPtr);
8704 retval = Jim_EvalObj(interp, scriptObjPtr);
8705 Jim_DecrRefCount(interp, scriptObjPtr);
8709 /* Execute script in the scope of the global level */
8710 int Jim_EvalGlobal(Jim_Interp *interp, const char *script)
8712 Jim_CallFrame *savedFramePtr;
8715 savedFramePtr = interp->framePtr;
8716 interp->framePtr = interp->topFramePtr;
8717 retval = Jim_Eval(interp, script);
8718 interp->framePtr = savedFramePtr;
8722 int Jim_EvalObjBackground(Jim_Interp *interp, Jim_Obj *scriptObjPtr)
8724 Jim_CallFrame *savedFramePtr;
8727 savedFramePtr = interp->framePtr;
8728 interp->framePtr = interp->topFramePtr;
8729 retval = Jim_EvalObj(interp, scriptObjPtr);
8730 interp->framePtr = savedFramePtr;
8731 /* Try to report the error (if any) via the bgerror proc */
8732 if (retval != JIM_OK) {
8735 objv[0] = Jim_NewStringObj(interp, "bgerror", -1);
8736 objv[1] = Jim_GetResult(interp);
8737 Jim_IncrRefCount(objv[0]);
8738 Jim_IncrRefCount(objv[1]);
8739 if (Jim_EvalObjVector(interp, 2, objv) != JIM_OK) {
8740 /* Report the error to stderr. */
8741 Jim_fprintf( interp, interp->cookie_stderr, "Background error:" JIM_NL);
8742 Jim_PrintErrorMessage(interp);
8744 Jim_DecrRefCount(interp, objv[0]);
8745 Jim_DecrRefCount(interp, objv[1]);
8750 int Jim_EvalFile(Jim_Interp *interp, const char *filename)
8754 int nread, totread, maxlen, buflen;
8756 Jim_Obj *scriptObjPtr;
8759 if ((fp = fopen(filename, "r")) == NULL) {
8760 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
8761 getcwd( cwd, sizeof(cwd) );
8762 Jim_AppendStrings(interp, Jim_GetResult(interp),
8763 "Error loading script \"", filename, "\"",
8765 " err: ", strerror(errno), NULL);
8769 maxlen = totread = 0;
8771 if (maxlen < totread+buflen+1) {
8772 maxlen = totread+buflen+1;
8773 prg = Jim_Realloc(prg, maxlen);
8775 /* do not use Jim_fread() - this is really a file */
8776 if ((nread = fread(prg+totread, 1, buflen, fp)) == 0) break;
8779 prg[totread] = '\0';
8780 /* do not use Jim_fclose() - this is really a file */
8783 scriptObjPtr = Jim_NewStringObjNoAlloc(interp, prg, totread);
8784 JimSetSourceInfo(interp, scriptObjPtr, filename, 1);
8785 Jim_IncrRefCount(scriptObjPtr);
8786 retval = Jim_EvalObj(interp, scriptObjPtr);
8787 Jim_DecrRefCount(interp, scriptObjPtr);
8791 /* -----------------------------------------------------------------------------
8793 * ---------------------------------------------------------------------------*/
8794 static int JimParseSubstStr(struct JimParserCtx *pc)
8797 pc->tline = pc->linenr;
8798 while (*pc->p && *pc->p != '$' && *pc->p != '[') {
8802 pc->tt = JIM_TT_ESC;
8806 static int JimParseSubst(struct JimParserCtx *pc, int flags)
8811 pc->tstart = pc->tend = pc->p;
8812 pc->tline = pc->linenr;
8813 pc->tt = JIM_TT_EOL;
8819 retval = JimParseCmd(pc);
8820 if (flags & JIM_SUBST_NOCMD) {
8823 pc->tt = (flags & JIM_SUBST_NOESC) ?
8824 JIM_TT_STR : JIM_TT_ESC;
8829 if (JimParseVar(pc) == JIM_ERR) {
8830 pc->tstart = pc->tend = pc->p++; pc->len--;
8831 pc->tline = pc->linenr;
8832 pc->tt = JIM_TT_STR;
8834 if (flags & JIM_SUBST_NOVAR) {
8836 if (flags & JIM_SUBST_NOESC)
8837 pc->tt = JIM_TT_STR;
8839 pc->tt = JIM_TT_ESC;
8840 if (*pc->tstart == '{') {
8849 retval = JimParseSubstStr(pc);
8850 if (flags & JIM_SUBST_NOESC)
8851 pc->tt = JIM_TT_STR;
8858 /* The subst object type reuses most of the data structures and functions
8859 * of the script object. Script's data structures are a bit more complex
8860 * for what is needed for [subst]itution tasks, but the reuse helps to
8861 * deal with a single data structure at the cost of some more memory
8862 * usage for substitutions. */
8863 static Jim_ObjType substObjType = {
8865 FreeScriptInternalRep,
8866 DupScriptInternalRep,
8868 JIM_TYPE_REFERENCES,
8871 /* This method takes the string representation of an object
8872 * as a Tcl string where to perform [subst]itution, and generates
8873 * the pre-parsed internal representation. */
8874 int SetSubstFromAny(Jim_Interp *interp, struct Jim_Obj *objPtr, int flags)
8877 const char *scriptText = Jim_GetString(objPtr, &scriptTextLen);
8878 struct JimParserCtx parser;
8879 struct ScriptObj *script = Jim_Alloc(sizeof(*script));
8883 script->commands = 0;
8884 script->token = NULL;
8885 script->cmdStruct = NULL;
8887 script->substFlags = flags;
8888 script->fileName = NULL;
8890 JimParserInit(&parser, scriptText, scriptTextLen, 1);
8893 int len, type, linenr;
8895 JimParseSubst(&parser, flags);
8896 if (JimParserEof(&parser)) break;
8897 token = JimParserGetToken(&parser, &len, &type, &linenr);
8898 ScriptObjAddToken(interp, script, token, len, type,
8901 /* Free the old internal rep and set the new one. */
8902 Jim_FreeIntRep(interp, objPtr);
8903 Jim_SetIntRepPtr(objPtr, script);
8904 objPtr->typePtr = &scriptObjType;
8908 ScriptObj *Jim_GetSubst(Jim_Interp *interp, Jim_Obj *objPtr, int flags)
8910 struct ScriptObj *script = Jim_GetIntRepPtr(objPtr);
8912 if (objPtr->typePtr != &substObjType || script->substFlags != flags)
8913 SetSubstFromAny(interp, objPtr, flags);
8914 return (ScriptObj*) Jim_GetIntRepPtr(objPtr);
8917 /* Performs commands,variables,blackslashes substitution,
8918 * storing the result object (with refcount 0) into
8920 int Jim_SubstObj(Jim_Interp *interp, Jim_Obj *substObjPtr,
8921 Jim_Obj **resObjPtrPtr, int flags)
8925 int i, len, retcode = JIM_OK;
8926 Jim_Obj *resObjPtr, *savedResultObjPtr;
8928 script = Jim_GetSubst(interp, substObjPtr, flags);
8929 #ifdef JIM_OPTIMIZATION
8930 /* Fast path for a very common case with array-alike syntax,
8931 * that's: $foo($bar) */
8932 if (script->len == 1 && script->token[0].type == JIM_TT_VAR) {
8933 Jim_Obj *varObjPtr = script->token[0].objPtr;
8935 Jim_IncrRefCount(varObjPtr);
8936 resObjPtr = Jim_GetVariable(interp, varObjPtr, JIM_ERRMSG);
8937 if (resObjPtr == NULL) {
8938 Jim_DecrRefCount(interp, varObjPtr);
8941 Jim_DecrRefCount(interp, varObjPtr);
8942 *resObjPtrPtr = resObjPtr;
8947 Jim_IncrRefCount(substObjPtr); /* Make sure it's shared. */
8948 /* In order to preserve the internal rep, we increment the
8949 * inUse field of the script internal rep structure. */
8952 token = script->token;
8955 /* Save the interp old result, to set it again before
8957 savedResultObjPtr = interp->result;
8958 Jim_IncrRefCount(savedResultObjPtr);
8960 /* Perform the substitution. Starts with an empty object
8961 * and adds every token (performing the appropriate
8962 * var/command/escape substitution). */
8963 resObjPtr = Jim_NewStringObj(interp, "", 0);
8964 for (i = 0; i < len; i++) {
8967 switch(token[i].type) {
8970 Jim_AppendObj(interp, resObjPtr, token[i].objPtr);
8973 objPtr = Jim_GetVariable(interp, token[i].objPtr, JIM_ERRMSG);
8974 if (objPtr == NULL) goto err;
8975 Jim_IncrRefCount(objPtr);
8976 Jim_AppendObj(interp, resObjPtr, objPtr);
8977 Jim_DecrRefCount(interp, objPtr);
8979 case JIM_TT_DICTSUGAR:
8980 objPtr = Jim_ExpandDictSugar(interp, token[i].objPtr);
8987 if (Jim_EvalObj(interp, token[i].objPtr) != JIM_OK)
8989 Jim_AppendObj(interp, resObjPtr, interp->result);
8993 "default token type (%d) reached "
8994 "in Jim_SubstObj().", token[i].type);
8999 if (retcode == JIM_OK)
9000 Jim_SetResult(interp, savedResultObjPtr);
9001 Jim_DecrRefCount(interp, savedResultObjPtr);
9002 /* Note that we don't have to decrement inUse, because the
9003 * following code transfers our use of the reference again to
9004 * the script object. */
9005 Jim_FreeIntRep(interp, substObjPtr);
9006 substObjPtr->typePtr = &scriptObjType;
9007 Jim_SetIntRepPtr(substObjPtr, script);
9008 Jim_DecrRefCount(interp, substObjPtr);
9009 *resObjPtrPtr = resObjPtr;
9012 Jim_FreeNewObj(interp, resObjPtr);
9017 /* -----------------------------------------------------------------------------
9018 * API Input/Export functions
9019 * ---------------------------------------------------------------------------*/
9021 int Jim_GetApi(Jim_Interp *interp, const char *funcname, void *targetPtrPtr)
9025 he = Jim_FindHashEntry(&interp->stub, funcname);
9028 memcpy(targetPtrPtr, &he->val, sizeof(void*));
9032 int Jim_RegisterApi(Jim_Interp *interp, const char *funcname, void *funcptr)
9034 return Jim_AddHashEntry(&interp->stub, funcname, funcptr);
9037 #define JIM_REGISTER_API(name) \
9038 Jim_RegisterApi(interp, "Jim_" #name, (void *)Jim_ ## name)
9040 void JimRegisterCoreApi(Jim_Interp *interp)
9042 interp->getApiFuncPtr = Jim_GetApi;
9043 JIM_REGISTER_API(Alloc);
9044 JIM_REGISTER_API(Free);
9045 JIM_REGISTER_API(Eval);
9046 JIM_REGISTER_API(EvalGlobal);
9047 JIM_REGISTER_API(EvalFile);
9048 JIM_REGISTER_API(EvalObj);
9049 JIM_REGISTER_API(EvalObjBackground);
9050 JIM_REGISTER_API(EvalObjVector);
9051 JIM_REGISTER_API(InitHashTable);
9052 JIM_REGISTER_API(ExpandHashTable);
9053 JIM_REGISTER_API(AddHashEntry);
9054 JIM_REGISTER_API(ReplaceHashEntry);
9055 JIM_REGISTER_API(DeleteHashEntry);
9056 JIM_REGISTER_API(FreeHashTable);
9057 JIM_REGISTER_API(FindHashEntry);
9058 JIM_REGISTER_API(ResizeHashTable);
9059 JIM_REGISTER_API(GetHashTableIterator);
9060 JIM_REGISTER_API(NextHashEntry);
9061 JIM_REGISTER_API(NewObj);
9062 JIM_REGISTER_API(FreeObj);
9063 JIM_REGISTER_API(InvalidateStringRep);
9064 JIM_REGISTER_API(InitStringRep);
9065 JIM_REGISTER_API(DuplicateObj);
9066 JIM_REGISTER_API(GetString);
9067 JIM_REGISTER_API(Length);
9068 JIM_REGISTER_API(InvalidateStringRep);
9069 JIM_REGISTER_API(NewStringObj);
9070 JIM_REGISTER_API(NewStringObjNoAlloc);
9071 JIM_REGISTER_API(AppendString);
9072 JIM_REGISTER_API(AppendObj);
9073 JIM_REGISTER_API(AppendStrings);
9074 JIM_REGISTER_API(StringEqObj);
9075 JIM_REGISTER_API(StringMatchObj);
9076 JIM_REGISTER_API(StringRangeObj);
9077 JIM_REGISTER_API(FormatString);
9078 JIM_REGISTER_API(CompareStringImmediate);
9079 JIM_REGISTER_API(NewReference);
9080 JIM_REGISTER_API(GetReference);
9081 JIM_REGISTER_API(SetFinalizer);
9082 JIM_REGISTER_API(GetFinalizer);
9083 JIM_REGISTER_API(CreateInterp);
9084 JIM_REGISTER_API(FreeInterp);
9085 JIM_REGISTER_API(GetExitCode);
9086 JIM_REGISTER_API(SetStdin);
9087 JIM_REGISTER_API(SetStdout);
9088 JIM_REGISTER_API(SetStderr);
9089 JIM_REGISTER_API(CreateCommand);
9090 JIM_REGISTER_API(CreateProcedure);
9091 JIM_REGISTER_API(DeleteCommand);
9092 JIM_REGISTER_API(RenameCommand);
9093 JIM_REGISTER_API(GetCommand);
9094 JIM_REGISTER_API(SetVariable);
9095 JIM_REGISTER_API(SetVariableStr);
9096 JIM_REGISTER_API(SetGlobalVariableStr);
9097 JIM_REGISTER_API(SetVariableStrWithStr);
9098 JIM_REGISTER_API(SetVariableLink);
9099 JIM_REGISTER_API(GetVariable);
9100 JIM_REGISTER_API(GetCallFrameByLevel);
9101 JIM_REGISTER_API(Collect);
9102 JIM_REGISTER_API(CollectIfNeeded);
9103 JIM_REGISTER_API(GetIndex);
9104 JIM_REGISTER_API(NewListObj);
9105 JIM_REGISTER_API(ListAppendElement);
9106 JIM_REGISTER_API(ListAppendList);
9107 JIM_REGISTER_API(ListLength);
9108 JIM_REGISTER_API(ListIndex);
9109 JIM_REGISTER_API(SetListIndex);
9110 JIM_REGISTER_API(ConcatObj);
9111 JIM_REGISTER_API(NewDictObj);
9112 JIM_REGISTER_API(DictKey);
9113 JIM_REGISTER_API(DictKeysVector);
9114 JIM_REGISTER_API(GetIndex);
9115 JIM_REGISTER_API(GetReturnCode);
9116 JIM_REGISTER_API(EvalExpression);
9117 JIM_REGISTER_API(GetBoolFromExpr);
9118 JIM_REGISTER_API(GetWide);
9119 JIM_REGISTER_API(GetLong);
9120 JIM_REGISTER_API(SetWide);
9121 JIM_REGISTER_API(NewIntObj);
9122 JIM_REGISTER_API(GetDouble);
9123 JIM_REGISTER_API(SetDouble);
9124 JIM_REGISTER_API(NewDoubleObj);
9125 JIM_REGISTER_API(WrongNumArgs);
9126 JIM_REGISTER_API(SetDictKeysVector);
9127 JIM_REGISTER_API(SubstObj);
9128 JIM_REGISTER_API(RegisterApi);
9129 JIM_REGISTER_API(PrintErrorMessage);
9130 JIM_REGISTER_API(InteractivePrompt);
9131 JIM_REGISTER_API(RegisterCoreCommands);
9132 JIM_REGISTER_API(GetSharedString);
9133 JIM_REGISTER_API(ReleaseSharedString);
9134 JIM_REGISTER_API(Panic);
9135 JIM_REGISTER_API(StrDup);
9136 JIM_REGISTER_API(UnsetVariable);
9137 JIM_REGISTER_API(GetVariableStr);
9138 JIM_REGISTER_API(GetGlobalVariable);
9139 JIM_REGISTER_API(GetGlobalVariableStr);
9140 JIM_REGISTER_API(GetAssocData);
9141 JIM_REGISTER_API(SetAssocData);
9142 JIM_REGISTER_API(DeleteAssocData);
9143 JIM_REGISTER_API(GetEnum);
9144 JIM_REGISTER_API(ScriptIsComplete);
9145 JIM_REGISTER_API(PackageRequire);
9146 JIM_REGISTER_API(PackageProvide);
9147 JIM_REGISTER_API(InitStack);
9148 JIM_REGISTER_API(FreeStack);
9149 JIM_REGISTER_API(StackLen);
9150 JIM_REGISTER_API(StackPush);
9151 JIM_REGISTER_API(StackPop);
9152 JIM_REGISTER_API(StackPeek);
9153 JIM_REGISTER_API(FreeStackElements);
9156 /* -----------------------------------------------------------------------------
9157 * Core commands utility functions
9158 * ---------------------------------------------------------------------------*/
9159 void Jim_WrongNumArgs(Jim_Interp *interp, int argc, Jim_Obj *const *argv,
9163 Jim_Obj *objPtr = Jim_NewEmptyStringObj(interp);
9165 Jim_AppendString(interp, objPtr, "wrong # args: should be \"", -1);
9166 for (i = 0; i < argc; i++) {
9167 Jim_AppendObj(interp, objPtr, argv[i]);
9168 if (!(i+1 == argc && msg[0] == '\0'))
9169 Jim_AppendString(interp, objPtr, " ", 1);
9171 Jim_AppendString(interp, objPtr, msg, -1);
9172 Jim_AppendString(interp, objPtr, "\"", 1);
9173 Jim_SetResult(interp, objPtr);
9176 static Jim_Obj *JimCommandsList(Jim_Interp *interp, Jim_Obj *patternObjPtr)
9178 Jim_HashTableIterator *htiter;
9180 Jim_Obj *listObjPtr = Jim_NewListObj(interp, NULL, 0);
9181 const char *pattern;
9184 pattern = patternObjPtr ? Jim_GetString(patternObjPtr, &patternLen) : NULL;
9185 htiter = Jim_GetHashTableIterator(&interp->commands);
9186 while ((he = Jim_NextHashEntry(htiter)) != NULL) {
9187 if (pattern && !JimStringMatch(pattern, patternLen, he->key,
9188 strlen((const char*)he->key), 0))
9190 Jim_ListAppendElement(interp, listObjPtr,
9191 Jim_NewStringObj(interp, he->key, -1));
9193 Jim_FreeHashTableIterator(htiter);
9197 #define JIM_VARLIST_GLOBALS 0
9198 #define JIM_VARLIST_LOCALS 1
9199 #define JIM_VARLIST_VARS 2
9201 static Jim_Obj *JimVariablesList(Jim_Interp *interp, Jim_Obj *patternObjPtr,
9204 Jim_HashTableIterator *htiter;
9206 Jim_Obj *listObjPtr = Jim_NewListObj(interp, NULL, 0);
9207 const char *pattern;
9210 pattern = patternObjPtr ? Jim_GetString(patternObjPtr, &patternLen) : NULL;
9211 if (mode == JIM_VARLIST_GLOBALS) {
9212 htiter = Jim_GetHashTableIterator(&interp->topFramePtr->vars);
9214 /* For [info locals], if we are at top level an emtpy list
9215 * is returned. I don't agree, but we aim at compatibility (SS) */
9216 if (mode == JIM_VARLIST_LOCALS &&
9217 interp->framePtr == interp->topFramePtr)
9219 htiter = Jim_GetHashTableIterator(&interp->framePtr->vars);
9221 while ((he = Jim_NextHashEntry(htiter)) != NULL) {
9222 Jim_Var *varPtr = (Jim_Var*) he->val;
9223 if (mode == JIM_VARLIST_LOCALS) {
9224 if (varPtr->linkFramePtr != NULL)
9227 if (pattern && !JimStringMatch(pattern, patternLen, he->key,
9228 strlen((const char*)he->key), 0))
9230 Jim_ListAppendElement(interp, listObjPtr,
9231 Jim_NewStringObj(interp, he->key, -1));
9233 Jim_FreeHashTableIterator(htiter);
9237 static int JimInfoLevel(Jim_Interp *interp, Jim_Obj *levelObjPtr,
9238 Jim_Obj **objPtrPtr)
9240 Jim_CallFrame *targetCallFrame;
9242 if (JimGetCallFrameByInteger(interp, levelObjPtr, &targetCallFrame)
9245 /* No proc call at toplevel callframe */
9246 if (targetCallFrame == interp->topFramePtr) {
9247 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
9248 Jim_AppendStrings(interp, Jim_GetResult(interp),
9250 Jim_GetString(levelObjPtr, NULL), "\"", NULL);
9253 *objPtrPtr = Jim_NewListObj(interp,
9254 targetCallFrame->argv,
9255 targetCallFrame->argc);
9259 /* -----------------------------------------------------------------------------
9261 * ---------------------------------------------------------------------------*/
9263 /* fake [puts] -- not the real puts, just for debugging. */
9264 static int Jim_PutsCoreCommand(Jim_Interp *interp, int argc,
9265 Jim_Obj *const *argv)
9268 int len, nonewline = 0;
9270 if (argc != 2 && argc != 3) {
9271 Jim_WrongNumArgs(interp, 1, argv, "-nonewline string");
9275 if (!Jim_CompareStringImmediate(interp, argv[1], "-nonewline"))
9277 Jim_SetResultString(interp, "The second argument must "
9278 "be -nonewline", -1);
9285 str = Jim_GetString(argv[1], &len);
9286 Jim_fwrite(interp, str, 1, len, interp->cookie_stdout);
9287 if (!nonewline) Jim_fprintf( interp, interp->cookie_stdout, JIM_NL);
9291 /* Helper for [+] and [*] */
9292 static int Jim_AddMulHelper(Jim_Interp *interp, int argc,
9293 Jim_Obj *const *argv, int op)
9295 jim_wide wideValue, res;
9296 double doubleValue, doubleRes;
9299 res = (op == JIM_EXPROP_ADD) ? 0 : 1;
9301 for (i = 1; i < argc; i++) {
9302 if (Jim_GetWide(interp, argv[i], &wideValue) != JIM_OK)
9304 if (op == JIM_EXPROP_ADD)
9309 Jim_SetResult(interp, Jim_NewIntObj(interp, res));
9312 doubleRes = (double) res;
9313 for (;i < argc; i++) {
9314 if (Jim_GetDouble(interp, argv[i], &doubleValue) != JIM_OK)
9316 if (op == JIM_EXPROP_ADD)
9317 doubleRes += doubleValue;
9319 doubleRes *= doubleValue;
9321 Jim_SetResult(interp, Jim_NewDoubleObj(interp, doubleRes));
9325 /* Helper for [-] and [/] */
9326 static int Jim_SubDivHelper(Jim_Interp *interp, int argc,
9327 Jim_Obj *const *argv, int op)
9329 jim_wide wideValue, res = 0;
9330 double doubleValue, doubleRes = 0;
9334 Jim_WrongNumArgs(interp, 1, argv, "number ?number ... number?");
9336 } else if (argc == 2) {
9337 /* The arity = 2 case is different. For [- x] returns -x,
9338 * while [/ x] returns 1/x. */
9339 if (Jim_GetWide(interp, argv[1], &wideValue) != JIM_OK) {
9340 if (Jim_GetDouble(interp, argv[1], &doubleValue) !=
9345 if (op == JIM_EXPROP_SUB)
9346 doubleRes = -doubleValue;
9348 doubleRes = 1.0/doubleValue;
9349 Jim_SetResult(interp, Jim_NewDoubleObj(interp,
9354 if (op == JIM_EXPROP_SUB) {
9356 Jim_SetResult(interp, Jim_NewIntObj(interp, res));
9358 doubleRes = 1.0/wideValue;
9359 Jim_SetResult(interp, Jim_NewDoubleObj(interp,
9364 if (Jim_GetWide(interp, argv[1], &res) != JIM_OK) {
9365 if (Jim_GetDouble(interp, argv[1], &doubleRes)
9373 for (i = 2; i < argc; i++) {
9374 if (Jim_GetWide(interp, argv[i], &wideValue) != JIM_OK) {
9375 doubleRes = (double) res;
9378 if (op == JIM_EXPROP_SUB)
9383 Jim_SetResult(interp, Jim_NewIntObj(interp, res));
9386 for (;i < argc; i++) {
9387 if (Jim_GetDouble(interp, argv[i], &doubleValue) != JIM_OK)
9389 if (op == JIM_EXPROP_SUB)
9390 doubleRes -= doubleValue;
9392 doubleRes /= doubleValue;
9394 Jim_SetResult(interp, Jim_NewDoubleObj(interp, doubleRes));
9400 static int Jim_AddCoreCommand(Jim_Interp *interp, int argc,
9401 Jim_Obj *const *argv)
9403 return Jim_AddMulHelper(interp, argc, argv, JIM_EXPROP_ADD);
9407 static int Jim_MulCoreCommand(Jim_Interp *interp, int argc,
9408 Jim_Obj *const *argv)
9410 return Jim_AddMulHelper(interp, argc, argv, JIM_EXPROP_MUL);
9414 static int Jim_SubCoreCommand(Jim_Interp *interp, int argc,
9415 Jim_Obj *const *argv)
9417 return Jim_SubDivHelper(interp, argc, argv, JIM_EXPROP_SUB);
9421 static int Jim_DivCoreCommand(Jim_Interp *interp, int argc,
9422 Jim_Obj *const *argv)
9424 return Jim_SubDivHelper(interp, argc, argv, JIM_EXPROP_DIV);
9428 static int Jim_SetCoreCommand(Jim_Interp *interp, int argc,
9429 Jim_Obj *const *argv)
9431 if (argc != 2 && argc != 3) {
9432 Jim_WrongNumArgs(interp, 1, argv, "varName ?newValue?");
9437 objPtr = Jim_GetVariable(interp, argv[1], JIM_ERRMSG);
9440 Jim_SetResult(interp, objPtr);
9443 /* argc == 3 case. */
9444 if (Jim_SetVariable(interp, argv[1], argv[2]) != JIM_OK)
9446 Jim_SetResult(interp, argv[2]);
9451 static int Jim_UnsetCoreCommand(Jim_Interp *interp, int argc,
9452 Jim_Obj *const *argv)
9457 Jim_WrongNumArgs(interp, 1, argv, "varName ?varName ...?");
9460 for (i = 1; i < argc; i++) {
9461 if (Jim_UnsetVariable(interp, argv[i], JIM_ERRMSG) != JIM_OK)
9468 static int Jim_IncrCoreCommand(Jim_Interp *interp, int argc,
9469 Jim_Obj *const *argv)
9471 jim_wide wideValue, increment = 1;
9474 if (argc != 2 && argc != 3) {
9475 Jim_WrongNumArgs(interp, 1, argv, "varName ?increment?");
9479 if (Jim_GetWide(interp, argv[2], &increment) != JIM_OK)
9482 intObjPtr = Jim_GetVariable(interp, argv[1], JIM_ERRMSG);
9483 if (!intObjPtr) return JIM_ERR;
9484 if (Jim_GetWide(interp, intObjPtr, &wideValue) != JIM_OK)
9486 if (Jim_IsShared(intObjPtr)) {
9487 intObjPtr = Jim_NewIntObj(interp, wideValue+increment);
9488 if (Jim_SetVariable(interp, argv[1], intObjPtr) != JIM_OK) {
9489 Jim_FreeNewObj(interp, intObjPtr);
9493 Jim_SetWide(interp, intObjPtr, wideValue+increment);
9494 /* The following step is required in order to invalidate the
9495 * string repr of "FOO" if the var name is on the form of "FOO(IDX)" */
9496 if (Jim_SetVariable(interp, argv[1], intObjPtr) != JIM_OK) {
9500 Jim_SetResult(interp, intObjPtr);
9505 static int Jim_WhileCoreCommand(Jim_Interp *interp, int argc,
9506 Jim_Obj *const *argv)
9509 Jim_WrongNumArgs(interp, 1, argv, "condition body");
9512 /* Try to run a specialized version of while if the expression
9513 * is in one of the following forms:
9515 * $a < CONST, $a < $b
9516 * $a <= CONST, $a <= $b
9517 * $a > CONST, $a > $b
9518 * $a >= CONST, $a >= $b
9519 * $a != CONST, $a != $b
9520 * $a == CONST, $a == $b
9526 #ifdef JIM_OPTIMIZATION
9529 Jim_Obj *varAObjPtr = NULL, *varBObjPtr = NULL, *objPtr;
9530 int exprLen, retval;
9532 /* STEP 1 -- Check if there are the conditions to run the specialized
9533 * version of while */
9535 if ((expr = Jim_GetExpression(interp, argv[1])) == NULL) goto noopt;
9536 if (expr->len <= 0 || expr->len > 3) goto noopt;
9539 if (expr->opcode[0] != JIM_EXPROP_VARIABLE &&
9540 expr->opcode[0] != JIM_EXPROP_NUMBER)
9544 if (expr->opcode[1] != JIM_EXPROP_NOT ||
9545 expr->opcode[0] != JIM_EXPROP_VARIABLE)
9549 if (expr->opcode[0] != JIM_EXPROP_VARIABLE ||
9550 (expr->opcode[1] != JIM_EXPROP_NUMBER &&
9551 expr->opcode[1] != JIM_EXPROP_VARIABLE))
9553 switch(expr->opcode[2]) {
9555 case JIM_EXPROP_LTE:
9557 case JIM_EXPROP_GTE:
9558 case JIM_EXPROP_NUMEQ:
9559 case JIM_EXPROP_NUMNE:
9568 "Unexpected default reached in Jim_WhileCoreCommand()");
9572 /* STEP 2 -- conditions meet. Initialization. Take different
9573 * branches for different expression lengths. */
9574 exprLen = expr->len;
9579 if (expr->opcode[0] == JIM_EXPROP_VARIABLE) {
9580 varAObjPtr = expr->obj[0];
9581 Jim_IncrRefCount(varAObjPtr);
9583 if (Jim_GetWide(interp, expr->obj[0], &wideValue) != JIM_OK)
9589 Jim_GetVariable(interp, varAObjPtr, JIM_NONE)) ||
9590 Jim_GetWide(interp, objPtr, &wideValue) != JIM_OK)
9592 Jim_DecrRefCount(interp, varAObjPtr);
9596 if (!wideValue) break;
9597 if ((retval = Jim_EvalObj(interp, argv[2])) != JIM_OK) {
9601 Jim_DecrRefCount(interp, varAObjPtr);
9609 Jim_DecrRefCount(interp, varAObjPtr);
9615 Jim_DecrRefCount(interp, varAObjPtr);
9616 } else if (exprLen == 3) {
9617 jim_wide wideValueA, wideValueB, cmpRes = 0;
9618 int cmpType = expr->opcode[2];
9620 varAObjPtr = expr->obj[0];
9621 Jim_IncrRefCount(varAObjPtr);
9622 if (expr->opcode[1] == JIM_EXPROP_VARIABLE) {
9623 varBObjPtr = expr->obj[1];
9624 Jim_IncrRefCount(varBObjPtr);
9626 if (Jim_GetWide(interp, expr->obj[1], &wideValueB) != JIM_OK)
9630 if (!(objPtr = Jim_GetVariable(interp, varAObjPtr, JIM_NONE)) ||
9631 Jim_GetWide(interp, objPtr, &wideValueA) != JIM_OK)
9633 Jim_DecrRefCount(interp, varAObjPtr);
9635 Jim_DecrRefCount(interp, varBObjPtr);
9640 Jim_GetVariable(interp, varBObjPtr, JIM_NONE)) ||
9641 Jim_GetWide(interp, objPtr, &wideValueB) != JIM_OK)
9643 Jim_DecrRefCount(interp, varAObjPtr);
9645 Jim_DecrRefCount(interp, varBObjPtr);
9651 cmpRes = wideValueA < wideValueB; break;
9652 case JIM_EXPROP_LTE:
9653 cmpRes = wideValueA <= wideValueB; break;
9655 cmpRes = wideValueA > wideValueB; break;
9656 case JIM_EXPROP_GTE:
9657 cmpRes = wideValueA >= wideValueB; break;
9658 case JIM_EXPROP_NUMEQ:
9659 cmpRes = wideValueA == wideValueB; break;
9660 case JIM_EXPROP_NUMNE:
9661 cmpRes = wideValueA != wideValueB; break;
9664 if ((retval = Jim_EvalObj(interp, argv[2])) != JIM_OK) {
9667 Jim_DecrRefCount(interp, varAObjPtr);
9669 Jim_DecrRefCount(interp, varBObjPtr);
9676 Jim_DecrRefCount(interp, varAObjPtr);
9678 Jim_DecrRefCount(interp, varBObjPtr);
9683 Jim_DecrRefCount(interp, varAObjPtr);
9685 Jim_DecrRefCount(interp, varBObjPtr);
9687 /* TODO: case for len == 2 */
9690 Jim_SetEmptyResult(interp);
9696 /* The general purpose implementation of while starts here */
9698 int boolean, retval;
9700 if ((retval = Jim_GetBoolFromExpr(interp, argv[1],
9701 &boolean)) != JIM_OK)
9703 if (!boolean) break;
9704 if ((retval = Jim_EvalObj(interp, argv[2])) != JIM_OK) {
9718 Jim_SetEmptyResult(interp);
9723 static int Jim_ForCoreCommand(Jim_Interp *interp, int argc,
9724 Jim_Obj *const *argv)
9729 Jim_WrongNumArgs(interp, 1, argv, "start test next body");
9732 /* Check if the for is on the form:
9733 * for {set i CONST} {$i < CONST} {incr i}
9734 * for {set i CONST} {$i < $j} {incr i}
9735 * for {set i CONST} {$i <= CONST} {incr i}
9736 * for {set i CONST} {$i <= $j} {incr i}
9737 * XXX: NOTE: if variable traces are implemented, this optimization
9738 * need to be modified to check for the proc epoch at every variable
9740 #ifdef JIM_OPTIMIZATION
9742 ScriptObj *initScript, *incrScript;
9744 jim_wide start, stop, currentVal;
9745 unsigned jim_wide procEpoch = interp->procEpoch;
9746 Jim_Obj *varNamePtr, *stopVarNamePtr = NULL, *objPtr;
9748 struct Jim_Cmd *cmdPtr;
9750 /* Do it only if there aren't shared arguments */
9751 if (argv[1] == argv[2] || argv[2] == argv[3] || argv[1] == argv[3])
9753 initScript = Jim_GetScript(interp, argv[1]);
9754 expr = Jim_GetExpression(interp, argv[2]);
9755 incrScript = Jim_GetScript(interp, argv[3]);
9757 /* Ensure proper lengths to start */
9758 if (initScript->len != 6) goto evalstart;
9759 if (incrScript->len != 4) goto evalstart;
9760 if (expr->len != 3) goto evalstart;
9761 /* Ensure proper token types. */
9762 if (initScript->token[2].type != JIM_TT_ESC ||
9763 initScript->token[4].type != JIM_TT_ESC ||
9764 incrScript->token[2].type != JIM_TT_ESC ||
9765 expr->opcode[0] != JIM_EXPROP_VARIABLE ||
9766 (expr->opcode[1] != JIM_EXPROP_NUMBER &&
9767 expr->opcode[1] != JIM_EXPROP_VARIABLE) ||
9768 (expr->opcode[2] != JIM_EXPROP_LT &&
9769 expr->opcode[2] != JIM_EXPROP_LTE))
9771 cmpType = expr->opcode[2];
9772 /* Initialization command must be [set] */
9773 cmdPtr = Jim_GetCommand(interp, initScript->token[0].objPtr, JIM_NONE);
9774 if (cmdPtr == NULL || cmdPtr->cmdProc != Jim_SetCoreCommand)
9776 /* Update command must be incr */
9777 cmdPtr = Jim_GetCommand(interp, incrScript->token[0].objPtr, JIM_NONE);
9778 if (cmdPtr == NULL || cmdPtr->cmdProc != Jim_IncrCoreCommand)
9780 /* set, incr, expression must be about the same variable */
9781 if (!Jim_StringEqObj(initScript->token[2].objPtr,
9782 incrScript->token[2].objPtr, 0))
9784 if (!Jim_StringEqObj(initScript->token[2].objPtr,
9787 /* Check that the initialization and comparison are valid integers */
9788 if (Jim_GetWide(interp, initScript->token[4].objPtr, &start) == JIM_ERR)
9790 if (expr->opcode[1] == JIM_EXPROP_NUMBER &&
9791 Jim_GetWide(interp, expr->obj[1], &stop) == JIM_ERR)
9796 /* Initialization */
9797 varNamePtr = expr->obj[0];
9798 if (expr->opcode[1] == JIM_EXPROP_VARIABLE) {
9799 stopVarNamePtr = expr->obj[1];
9800 Jim_IncrRefCount(stopVarNamePtr);
9802 Jim_IncrRefCount(varNamePtr);
9804 /* --- OPTIMIZED FOR --- */
9806 objPtr = Jim_NewIntObj(interp, start);
9807 if (Jim_SetVariable(interp, varNamePtr, objPtr) != JIM_OK) {
9808 Jim_DecrRefCount(interp, varNamePtr);
9809 if (stopVarNamePtr) Jim_DecrRefCount(interp, stopVarNamePtr);
9810 Jim_FreeNewObj(interp, objPtr);
9814 /* === Check condition === */
9816 objPtr = Jim_GetVariable(interp, varNamePtr, JIM_NONE);
9817 if (objPtr == NULL ||
9818 Jim_GetWide(interp, objPtr, ¤tVal) != JIM_OK)
9820 Jim_DecrRefCount(interp, varNamePtr);
9821 if (stopVarNamePtr) Jim_DecrRefCount(interp, stopVarNamePtr);
9824 /* Immediate or Variable? get the 'stop' value if the latter. */
9825 if (stopVarNamePtr) {
9826 objPtr = Jim_GetVariable(interp, stopVarNamePtr, JIM_NONE);
9827 if (objPtr == NULL ||
9828 Jim_GetWide(interp, objPtr, &stop) != JIM_OK)
9830 Jim_DecrRefCount(interp, varNamePtr);
9831 Jim_DecrRefCount(interp, stopVarNamePtr);
9835 if (cmpType == JIM_EXPROP_LT) {
9836 if (currentVal >= stop) break;
9838 if (currentVal > stop) break;
9841 if ((retval = Jim_EvalObj(interp, argv[4])) != JIM_OK) {
9845 Jim_DecrRefCount(interp, stopVarNamePtr);
9846 Jim_DecrRefCount(interp, varNamePtr);
9853 Jim_DecrRefCount(interp, stopVarNamePtr);
9854 Jim_DecrRefCount(interp, varNamePtr);
9858 /* If there was a change in procedures/command continue
9859 * with the usual [for] command implementation */
9860 if (procEpoch != interp->procEpoch) {
9862 Jim_DecrRefCount(interp, stopVarNamePtr);
9863 Jim_DecrRefCount(interp, varNamePtr);
9867 objPtr = Jim_GetVariable(interp, varNamePtr, JIM_ERRMSG);
9868 if (objPtr->refCount == 1 && objPtr->typePtr == &intObjType) {
9869 objPtr->internalRep.wideValue ++;
9870 Jim_InvalidateStringRep(objPtr);
9874 if (Jim_GetWide(interp, objPtr, ¤tVal) == JIM_ERR) {
9876 Jim_DecrRefCount(interp, stopVarNamePtr);
9877 Jim_DecrRefCount(interp, varNamePtr);
9880 auxObjPtr = Jim_NewIntObj(interp, currentVal+1);
9881 if (Jim_SetVariable(interp, varNamePtr, auxObjPtr) == JIM_ERR) {
9883 Jim_DecrRefCount(interp, stopVarNamePtr);
9884 Jim_DecrRefCount(interp, varNamePtr);
9885 Jim_FreeNewObj(interp, auxObjPtr);
9891 Jim_DecrRefCount(interp, stopVarNamePtr);
9892 Jim_DecrRefCount(interp, varNamePtr);
9893 Jim_SetEmptyResult(interp);
9899 if ((retval = Jim_EvalObj(interp, argv[1])) != JIM_OK)
9904 /* Test the condition */
9905 if ((retval = Jim_GetBoolFromExpr(interp, argv[2], &boolean))
9908 if (!boolean) break;
9910 if ((retval = Jim_EvalObj(interp, argv[4])) != JIM_OK) {
9924 if ((retval = Jim_EvalObj(interp, argv[3])) != JIM_OK) {
9938 Jim_SetEmptyResult(interp);
9942 /* foreach + lmap implementation. */
9943 static int JimForeachMapHelper(Jim_Interp *interp, int argc,
9944 Jim_Obj *const *argv, int doMap)
9946 int result = JIM_ERR, i, nbrOfLists, *listsIdx, *listsEnd;
9948 Jim_Obj *emptyStr, *script, *mapRes = NULL;
9950 if (argc < 4 || argc % 2 != 0) {
9951 Jim_WrongNumArgs(interp, 1, argv, "varList list ?varList list ...? script");
9955 mapRes = Jim_NewListObj(interp, NULL, 0);
9956 Jim_IncrRefCount(mapRes);
9958 emptyStr = Jim_NewEmptyStringObj(interp);
9959 Jim_IncrRefCount(emptyStr);
9960 script = argv[argc-1]; /* Last argument is a script */
9961 nbrOfLists = (argc - 1 - 1) / 2; /* argc - 'foreach' - script */
9962 listsIdx = (int*)Jim_Alloc(nbrOfLists * sizeof(int));
9963 listsEnd = (int*)Jim_Alloc(nbrOfLists*2 * sizeof(int));
9964 /* Initialize iterators and remember max nbr elements each list */
9965 memset(listsIdx, 0, nbrOfLists * sizeof(int));
9966 /* Remember lengths of all lists and calculate how much rounds to loop */
9967 for (i=0; i < nbrOfLists*2; i += 2) {
9970 Jim_ListLength(interp, argv[i+1], &listsEnd[i]);
9971 Jim_ListLength(interp, argv[i+2], &listsEnd[i+1]);
9972 if (listsEnd[i] == 0) {
9973 Jim_SetResultString(interp, "foreach varlist is empty", -1);
9976 cnt = div(listsEnd[i+1], listsEnd[i]);
9977 count = cnt.quot + (cnt.rem ? 1 : 0);
9978 if (count > nbrOfLoops)
9981 for (; nbrOfLoops-- > 0; ) {
9982 for (i=0; i < nbrOfLists; ++i) {
9983 int varIdx = 0, var = i * 2;
9984 while (varIdx < listsEnd[var]) {
9985 Jim_Obj *varName, *ele;
9986 int lst = i * 2 + 1;
9987 if (Jim_ListIndex(interp, argv[var+1], varIdx, &varName, JIM_ERRMSG)
9990 if (listsIdx[i] < listsEnd[lst]) {
9991 if (Jim_ListIndex(interp, argv[lst+1], listsIdx[i], &ele, JIM_ERRMSG)
9994 if (Jim_SetVariable(interp, varName, ele) != JIM_OK) {
9995 Jim_SetResultString(interp, "couldn't set loop variable: ", -1);
9998 ++listsIdx[i]; /* Remember next iterator of current list */
9999 } else if (Jim_SetVariable(interp, varName, emptyStr) != JIM_OK) {
10000 Jim_SetResultString(interp, "couldn't set loop variable: ", -1);
10003 ++varIdx; /* Next variable */
10006 switch (result = Jim_EvalObj(interp, script)) {
10009 Jim_ListAppendElement(interp, mapRes, interp->result);
10023 Jim_SetResult(interp, mapRes);
10025 Jim_SetEmptyResult(interp);
10028 Jim_DecrRefCount(interp, mapRes);
10029 Jim_DecrRefCount(interp, emptyStr);
10030 Jim_Free(listsIdx);
10031 Jim_Free(listsEnd);
10036 static int Jim_ForeachCoreCommand(Jim_Interp *interp, int argc,
10037 Jim_Obj *const *argv)
10039 return JimForeachMapHelper(interp, argc, argv, 0);
10043 static int Jim_LmapCoreCommand(Jim_Interp *interp, int argc,
10044 Jim_Obj *const *argv)
10046 return JimForeachMapHelper(interp, argc, argv, 1);
10050 static int Jim_IfCoreCommand(Jim_Interp *interp, int argc,
10051 Jim_Obj *const *argv)
10053 int boolean, retval, current = 1, falsebody = 0;
10056 /* Far not enough arguments given! */
10057 if (current >= argc) goto err;
10058 if ((retval = Jim_GetBoolFromExpr(interp,
10059 argv[current++], &boolean))
10062 /* There lacks something, isn't it? */
10063 if (current >= argc) goto err;
10064 if (Jim_CompareStringImmediate(interp, argv[current],
10065 "then")) current++;
10066 /* Tsk tsk, no then-clause? */
10067 if (current >= argc) goto err;
10069 return Jim_EvalObj(interp, argv[current]);
10070 /* Ok: no else-clause follows */
10071 if (++current >= argc) {
10072 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
10075 falsebody = current++;
10076 if (Jim_CompareStringImmediate(interp, argv[falsebody],
10078 /* IIICKS - else-clause isn't last cmd? */
10079 if (current != argc-1) goto err;
10080 return Jim_EvalObj(interp, argv[current]);
10081 } else if (Jim_CompareStringImmediate(interp,
10082 argv[falsebody], "elseif"))
10083 /* Ok: elseif follows meaning all the stuff
10084 * again (how boring...) */
10086 /* OOPS - else-clause is not last cmd?*/
10087 else if (falsebody != argc-1)
10089 return Jim_EvalObj(interp, argv[falsebody]);
10094 Jim_WrongNumArgs(interp, 1, argv, "condition ?then? trueBody ?elseif ...? ?else? falseBody");
10098 enum {SWITCH_EXACT, SWITCH_GLOB, SWITCH_RE, SWITCH_CMD, SWITCH_UNKNOWN};
10101 static int Jim_SwitchCoreCommand(Jim_Interp *interp, int argc,
10102 Jim_Obj *const *argv)
10104 int retcode = JIM_ERR, matchOpt = SWITCH_EXACT, opt=1, patCount, i;
10105 Jim_Obj *command = 0, *const *caseList = 0, *strObj;
10106 Jim_Obj *script = 0;
10107 if (argc < 3) goto wrongnumargs;
10108 for (opt=1; opt < argc; ++opt) {
10109 const char *option = Jim_GetString(argv[opt], 0);
10110 if (*option != '-') break;
10111 else if (strncmp(option, "--", 2) == 0) { ++opt; break; }
10112 else if (strncmp(option, "-exact", 2) == 0) matchOpt = SWITCH_EXACT;
10113 else if (strncmp(option, "-glob", 2) == 0) matchOpt = SWITCH_GLOB;
10114 else if (strncmp(option, "-regexp", 2) == 0) matchOpt = SWITCH_RE;
10115 else if (strncmp(option, "-command", 2) == 0) { matchOpt = SWITCH_CMD;
10116 if ((argc - opt) < 2) goto wrongnumargs;
10117 command = argv[++opt];
10119 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
10120 Jim_AppendStrings(interp, Jim_GetResult(interp),
10121 "bad option \"", option, "\": must be -exact, -glob, "
10122 "-regexp, -command procname or --", 0);
10125 if ((argc - opt) < 2) goto wrongnumargs;
10127 strObj = argv[opt++];
10128 patCount = argc - opt;
10129 if (patCount == 1) {
10131 JimListGetElements(interp, argv[opt], &patCount, &vector);
10134 caseList = &argv[opt];
10135 if (patCount == 0 || patCount % 2 != 0) goto wrongnumargs;
10136 for (i=0; script == 0 && i < patCount; i += 2) {
10137 Jim_Obj *patObj = caseList[i];
10138 if (!Jim_CompareStringImmediate(interp, patObj, "default")
10139 || i < (patCount-2)) {
10140 switch (matchOpt) {
10142 if (Jim_StringEqObj(strObj, patObj, 0))
10143 script = caseList[i+1];
10146 if (Jim_StringMatchObj(patObj, strObj, 0))
10147 script = caseList[i+1];
10150 command = Jim_NewStringObj(interp, "regexp", -1);
10151 /* Fall thru intentionally */
10153 Jim_Obj *parms[] = {command, patObj, strObj};
10154 int rc = Jim_EvalObjVector(interp, 3, parms);
10156 /* After the execution of a command we need to
10157 * make sure to reconvert the object into a list
10158 * again. Only for the single-list style [switch]. */
10159 if (argc-opt == 1) {
10161 JimListGetElements(interp, argv[opt], &patCount,
10165 /* command is here already decref'd */
10166 if (rc != JIM_OK) {
10170 rc = Jim_GetLong(interp, Jim_GetResult(interp), &matching);
10171 if (rc != JIM_OK) {
10176 script = caseList[i+1];
10180 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
10181 Jim_AppendStrings(interp, Jim_GetResult(interp),
10182 "internal error: no such option implemented", 0);
10186 script = caseList[i+1];
10189 for(; i < patCount && Jim_CompareStringImmediate(interp, script, "-");
10191 script = caseList[i+1];
10192 if (script && Jim_CompareStringImmediate(interp, script, "-")) {
10193 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
10194 Jim_AppendStrings(interp, Jim_GetResult(interp),
10195 "no body specified for pattern \"",
10196 Jim_GetString(caseList[i-2], 0), "\"", 0);
10200 Jim_SetEmptyResult(interp);
10202 retcode = Jim_EvalObj(interp, script);
10205 Jim_WrongNumArgs(interp, 1, argv, "?options? string "
10206 "pattern body ... ?default body? or "
10207 "{pattern body ?pattern body ...?}");
10213 static int Jim_ListCoreCommand(Jim_Interp *interp, int argc,
10214 Jim_Obj *const *argv)
10216 Jim_Obj *listObjPtr;
10218 listObjPtr = Jim_NewListObj(interp, argv+1, argc-1);
10219 Jim_SetResult(interp, listObjPtr);
10224 static int Jim_LindexCoreCommand(Jim_Interp *interp, int argc,
10225 Jim_Obj *const *argv)
10227 Jim_Obj *objPtr, *listObjPtr;
10232 Jim_WrongNumArgs(interp, 1, argv, "list index ?...?");
10236 Jim_IncrRefCount(objPtr);
10237 for (i = 2; i < argc; i++) {
10238 listObjPtr = objPtr;
10239 if (Jim_GetIndex(interp, argv[i], &index) != JIM_OK) {
10240 Jim_DecrRefCount(interp, listObjPtr);
10243 if (Jim_ListIndex(interp, listObjPtr, index, &objPtr,
10244 JIM_NONE) != JIM_OK) {
10245 /* Returns an empty object if the index
10246 * is out of range. */
10247 Jim_DecrRefCount(interp, listObjPtr);
10248 Jim_SetEmptyResult(interp);
10251 Jim_IncrRefCount(objPtr);
10252 Jim_DecrRefCount(interp, listObjPtr);
10254 Jim_SetResult(interp, objPtr);
10255 Jim_DecrRefCount(interp, objPtr);
10260 static int Jim_LlengthCoreCommand(Jim_Interp *interp, int argc,
10261 Jim_Obj *const *argv)
10266 Jim_WrongNumArgs(interp, 1, argv, "list");
10269 Jim_ListLength(interp, argv[1], &len);
10270 Jim_SetResult(interp, Jim_NewIntObj(interp, len));
10275 static int Jim_LappendCoreCommand(Jim_Interp *interp, int argc,
10276 Jim_Obj *const *argv)
10278 Jim_Obj *listObjPtr;
10282 Jim_WrongNumArgs(interp, 1, argv, "varName ?value value ...?");
10285 listObjPtr = Jim_GetVariable(interp, argv[1], JIM_NONE);
10287 /* Create the list if it does not exists */
10288 listObjPtr = Jim_NewListObj(interp, NULL, 0);
10289 if (Jim_SetVariable(interp, argv[1], listObjPtr) != JIM_OK) {
10290 Jim_FreeNewObj(interp, listObjPtr);
10294 shared = Jim_IsShared(listObjPtr);
10296 listObjPtr = Jim_DuplicateObj(interp, listObjPtr);
10297 for (i = 2; i < argc; i++)
10298 Jim_ListAppendElement(interp, listObjPtr, argv[i]);
10299 if (Jim_SetVariable(interp, argv[1], listObjPtr) != JIM_OK) {
10301 Jim_FreeNewObj(interp, listObjPtr);
10304 Jim_SetResult(interp, listObjPtr);
10309 static int Jim_LinsertCoreCommand(Jim_Interp *interp, int argc,
10310 Jim_Obj *const *argv)
10316 Jim_WrongNumArgs(interp, 1, argv, "list index element "
10321 if (Jim_IsShared(listPtr))
10322 listPtr = Jim_DuplicateObj(interp, listPtr);
10323 if (Jim_GetIndex(interp, argv[2], &index) != JIM_OK)
10325 Jim_ListLength(interp, listPtr, &len);
10328 else if (index < 0)
10329 index = len + index + 1;
10330 Jim_ListInsertElements(interp, listPtr, index, argc-3, &argv[3]);
10331 Jim_SetResult(interp, listPtr);
10334 if (listPtr != argv[1]) {
10335 Jim_FreeNewObj(interp, listPtr);
10341 static int Jim_LsetCoreCommand(Jim_Interp *interp, int argc,
10342 Jim_Obj *const *argv)
10345 Jim_WrongNumArgs(interp, 1, argv, "listVar ?index...? newVal");
10347 } else if (argc == 3) {
10348 if (Jim_SetVariable(interp, argv[1], argv[2]) != JIM_OK)
10350 Jim_SetResult(interp, argv[2]);
10353 if (Jim_SetListIndex(interp, argv[1], argv+2, argc-3, argv[argc-1])
10354 == JIM_ERR) return JIM_ERR;
10359 static int Jim_LsortCoreCommand(Jim_Interp *interp, int argc, Jim_Obj *const argv[])
10361 const char *options[] = {
10362 "-ascii", "-nocase", "-increasing", "-decreasing", NULL
10364 enum {OPT_ASCII, OPT_NOCASE, OPT_INCREASING, OPT_DECREASING};
10366 int i, lsortType = JIM_LSORT_ASCII; /* default sort type */
10367 int decreasing = 0;
10370 Jim_WrongNumArgs(interp, 1, argv, "?options? list");
10373 for (i = 1; i < (argc-1); i++) {
10376 if (Jim_GetEnum(interp, argv[i], options, &option, "option", JIM_ERRMSG)
10380 case OPT_ASCII: lsortType = JIM_LSORT_ASCII; break;
10381 case OPT_NOCASE: lsortType = JIM_LSORT_NOCASE; break;
10382 case OPT_INCREASING: decreasing = 0; break;
10383 case OPT_DECREASING: decreasing = 1; break;
10387 switch(lsortType) {
10388 case JIM_LSORT_ASCII: lsortType = JIM_LSORT_ASCII_DECR; break;
10389 case JIM_LSORT_NOCASE: lsortType = JIM_LSORT_NOCASE_DECR; break;
10392 resObj = Jim_DuplicateObj(interp, argv[argc-1]);
10393 ListSortElements(interp, resObj, lsortType);
10394 Jim_SetResult(interp, resObj);
10399 static int Jim_AppendCoreCommand(Jim_Interp *interp, int argc,
10400 Jim_Obj *const *argv)
10402 Jim_Obj *stringObjPtr;
10406 Jim_WrongNumArgs(interp, 1, argv, "varName ?value value ...?");
10410 stringObjPtr = Jim_GetVariable(interp, argv[1], JIM_ERRMSG);
10411 if (!stringObjPtr) return JIM_ERR;
10413 stringObjPtr = Jim_GetVariable(interp, argv[1], JIM_NONE);
10414 if (!stringObjPtr) {
10415 /* Create the string if it does not exists */
10416 stringObjPtr = Jim_NewEmptyStringObj(interp);
10417 if (Jim_SetVariable(interp, argv[1], stringObjPtr)
10419 Jim_FreeNewObj(interp, stringObjPtr);
10424 shared = Jim_IsShared(stringObjPtr);
10426 stringObjPtr = Jim_DuplicateObj(interp, stringObjPtr);
10427 for (i = 2; i < argc; i++)
10428 Jim_AppendObj(interp, stringObjPtr, argv[i]);
10429 if (Jim_SetVariable(interp, argv[1], stringObjPtr) != JIM_OK) {
10431 Jim_FreeNewObj(interp, stringObjPtr);
10434 Jim_SetResult(interp, stringObjPtr);
10439 static int Jim_DebugCoreCommand(Jim_Interp *interp, int argc,
10440 Jim_Obj *const *argv)
10442 const char *options[] = {
10443 "refcount", "objcount", "objects", "invstr", "scriptlen", "exprlen",
10448 OPT_REFCOUNT, OPT_OBJCOUNT, OPT_OBJECTS, OPT_INVSTR, OPT_SCRIPTLEN,
10449 OPT_EXPRLEN, OPT_EXPRBC
10454 Jim_WrongNumArgs(interp, 1, argv, "option ?...?");
10457 if (Jim_GetEnum(interp, argv[1], options, &option, "option",
10458 JIM_ERRMSG) != JIM_OK)
10460 if (option == OPT_REFCOUNT) {
10462 Jim_WrongNumArgs(interp, 2, argv, "object");
10465 Jim_SetResult(interp, Jim_NewIntObj(interp, argv[2]->refCount));
10467 } else if (option == OPT_OBJCOUNT) {
10468 int freeobj = 0, liveobj = 0;
10473 Jim_WrongNumArgs(interp, 2, argv, "");
10476 /* Count the number of free objects. */
10477 objPtr = interp->freeList;
10480 objPtr = objPtr->nextObjPtr;
10482 /* Count the number of live objects. */
10483 objPtr = interp->liveList;
10486 objPtr = objPtr->nextObjPtr;
10488 /* Set the result string and return. */
10489 sprintf(buf, "free %d used %d", freeobj, liveobj);
10490 Jim_SetResultString(interp, buf, -1);
10492 } else if (option == OPT_OBJECTS) {
10493 Jim_Obj *objPtr, *listObjPtr, *subListObjPtr;
10494 /* Count the number of live objects. */
10495 objPtr = interp->liveList;
10496 listObjPtr = Jim_NewListObj(interp, NULL, 0);
10499 const char *type = objPtr->typePtr ?
10500 objPtr->typePtr->name : "";
10501 subListObjPtr = Jim_NewListObj(interp, NULL, 0);
10502 sprintf(buf, "%p", objPtr);
10503 Jim_ListAppendElement(interp, subListObjPtr,
10504 Jim_NewStringObj(interp, buf, -1));
10505 Jim_ListAppendElement(interp, subListObjPtr,
10506 Jim_NewStringObj(interp, type, -1));
10507 Jim_ListAppendElement(interp, subListObjPtr,
10508 Jim_NewIntObj(interp, objPtr->refCount));
10509 Jim_ListAppendElement(interp, subListObjPtr, objPtr);
10510 Jim_ListAppendElement(interp, listObjPtr, subListObjPtr);
10511 objPtr = objPtr->nextObjPtr;
10513 Jim_SetResult(interp, listObjPtr);
10515 } else if (option == OPT_INVSTR) {
10519 Jim_WrongNumArgs(interp, 2, argv, "object");
10523 if (objPtr->typePtr != NULL)
10524 Jim_InvalidateStringRep(objPtr);
10525 Jim_SetEmptyResult(interp);
10527 } else if (option == OPT_SCRIPTLEN) {
10530 Jim_WrongNumArgs(interp, 2, argv, "script");
10533 script = Jim_GetScript(interp, argv[2]);
10534 Jim_SetResult(interp, Jim_NewIntObj(interp, script->len));
10536 } else if (option == OPT_EXPRLEN) {
10537 ExprByteCode *expr;
10539 Jim_WrongNumArgs(interp, 2, argv, "expression");
10542 expr = Jim_GetExpression(interp, argv[2]);
10545 Jim_SetResult(interp, Jim_NewIntObj(interp, expr->len));
10547 } else if (option == OPT_EXPRBC) {
10549 ExprByteCode *expr;
10553 Jim_WrongNumArgs(interp, 2, argv, "expression");
10556 expr = Jim_GetExpression(interp, argv[2]);
10559 objPtr = Jim_NewListObj(interp, NULL, 0);
10560 for (i = 0; i < expr->len; i++) {
10562 Jim_ExprOperator *op;
10564 switch(expr->opcode[i]) {
10565 case JIM_EXPROP_NUMBER: type = "number"; break;
10566 case JIM_EXPROP_COMMAND: type = "command"; break;
10567 case JIM_EXPROP_VARIABLE: type = "variable"; break;
10568 case JIM_EXPROP_DICTSUGAR: type = "dictsugar"; break;
10569 case JIM_EXPROP_SUBST: type = "subst"; break;
10570 case JIM_EXPROP_STRING: type = "string"; break;
10572 op = JimExprOperatorInfo(Jim_GetString(expr->obj[i], NULL));
10580 Jim_ListAppendElement(interp, objPtr,
10581 Jim_NewStringObj(interp, type, -1));
10582 Jim_ListAppendElement(interp, objPtr, expr->obj[i]);
10584 Jim_SetResult(interp, objPtr);
10587 Jim_SetResultString(interp,
10588 "bad option. Valid options are refcount, "
10589 "objcount, objects, invstr", -1);
10592 return JIM_OK; /* unreached */
10596 static int Jim_EvalCoreCommand(Jim_Interp *interp, int argc,
10597 Jim_Obj *const *argv)
10600 return Jim_EvalObj(interp, argv[1]);
10601 } else if (argc > 2) {
10605 objPtr = Jim_ConcatObj(interp, argc-1, argv+1);
10606 Jim_IncrRefCount(objPtr);
10607 retcode = Jim_EvalObj(interp, objPtr);
10608 Jim_DecrRefCount(interp, objPtr);
10611 Jim_WrongNumArgs(interp, 1, argv, "script ?...?");
10617 static int Jim_UplevelCoreCommand(Jim_Interp *interp, int argc,
10618 Jim_Obj *const *argv)
10621 int retcode, newLevel, oldLevel;
10622 Jim_CallFrame *savedCallFrame, *targetCallFrame;
10626 /* Save the old callframe pointer */
10627 savedCallFrame = interp->framePtr;
10629 /* Lookup the target frame pointer */
10630 str = Jim_GetString(argv[1], NULL);
10631 if ((str[0] >= '0' && str[0] <= '9') || str[0] == '#')
10633 if (Jim_GetCallFrameByLevel(interp, argv[1],
10635 &newLevel) != JIM_OK)
10640 if (Jim_GetCallFrameByLevel(interp, NULL,
10642 &newLevel) != JIM_OK)
10648 Jim_WrongNumArgs(interp, 1, argv,
10649 "?level? command ?arg ...?");
10652 /* Eval the code in the target callframe. */
10653 interp->framePtr = targetCallFrame;
10654 oldLevel = interp->numLevels;
10655 interp->numLevels = newLevel;
10657 retcode = Jim_EvalObj(interp, argv[1]);
10659 objPtr = Jim_ConcatObj(interp, argc-1, argv+1);
10660 Jim_IncrRefCount(objPtr);
10661 retcode = Jim_EvalObj(interp, objPtr);
10662 Jim_DecrRefCount(interp, objPtr);
10664 interp->numLevels = oldLevel;
10665 interp->framePtr = savedCallFrame;
10668 Jim_WrongNumArgs(interp, 1, argv, "?level? command ?arg ...?");
10674 static int Jim_ExprCoreCommand(Jim_Interp *interp, int argc,
10675 Jim_Obj *const *argv)
10677 Jim_Obj *exprResultPtr;
10681 retcode = Jim_EvalExpression(interp, argv[1], &exprResultPtr);
10682 } else if (argc > 2) {
10685 objPtr = Jim_ConcatObj(interp, argc-1, argv+1);
10686 Jim_IncrRefCount(objPtr);
10687 retcode = Jim_EvalExpression(interp, objPtr, &exprResultPtr);
10688 Jim_DecrRefCount(interp, objPtr);
10690 Jim_WrongNumArgs(interp, 1, argv, "expression ?...?");
10693 if (retcode != JIM_OK) return retcode;
10694 Jim_SetResult(interp, exprResultPtr);
10695 Jim_DecrRefCount(interp, exprResultPtr);
10700 static int Jim_BreakCoreCommand(Jim_Interp *interp, int argc,
10701 Jim_Obj *const *argv)
10704 Jim_WrongNumArgs(interp, 1, argv, "");
10711 static int Jim_ContinueCoreCommand(Jim_Interp *interp, int argc,
10712 Jim_Obj *const *argv)
10715 Jim_WrongNumArgs(interp, 1, argv, "");
10718 return JIM_CONTINUE;
10722 static int Jim_ReturnCoreCommand(Jim_Interp *interp, int argc,
10723 Jim_Obj *const *argv)
10727 } else if (argc == 2) {
10728 Jim_SetResult(interp, argv[1]);
10729 interp->returnCode = JIM_OK;
10731 } else if (argc == 3 || argc == 4) {
10733 if (Jim_GetReturnCode(interp, argv[2], &returnCode) == JIM_ERR)
10735 interp->returnCode = returnCode;
10737 Jim_SetResult(interp, argv[3]);
10740 Jim_WrongNumArgs(interp, 1, argv, "?-code code? ?result?");
10743 return JIM_RETURN; /* unreached */
10747 static int Jim_TailcallCoreCommand(Jim_Interp *interp, int argc,
10748 Jim_Obj *const *argv)
10752 objPtr = Jim_NewListObj(interp, argv+1, argc-1);
10753 Jim_SetResult(interp, objPtr);
10758 static int Jim_ProcCoreCommand(Jim_Interp *interp, int argc,
10759 Jim_Obj *const *argv)
10762 int arityMin, arityMax;
10764 if (argc != 4 && argc != 5) {
10765 Jim_WrongNumArgs(interp, 1, argv, "name arglist ?statics? body");
10768 Jim_ListLength(interp, argv[2], &argListLen);
10769 arityMin = arityMax = argListLen+1;
10773 Jim_Obj *lastArgPtr;
10775 Jim_ListIndex(interp, argv[2], argListLen-1, &lastArgPtr, JIM_NONE);
10776 str = Jim_GetString(lastArgPtr, &len);
10777 if (len == 4 && memcmp(str, "args", 4) == 0) {
10783 return Jim_CreateProcedure(interp, Jim_GetString(argv[1], NULL),
10784 argv[2], NULL, argv[3], arityMin, arityMax);
10786 return Jim_CreateProcedure(interp, Jim_GetString(argv[1], NULL),
10787 argv[2], argv[3], argv[4], arityMin, arityMax);
10792 static int Jim_ConcatCoreCommand(Jim_Interp *interp, int argc,
10793 Jim_Obj *const *argv)
10795 Jim_SetResult(interp, Jim_ConcatObj(interp, argc-1, argv+1));
10800 static int Jim_UpvarCoreCommand(Jim_Interp *interp, int argc,
10801 Jim_Obj *const *argv)
10805 Jim_CallFrame *targetCallFrame;
10807 /* Lookup the target frame pointer */
10808 str = Jim_GetString(argv[1], NULL);
10810 ((str[0] >= '0' && str[0] <= '9') || str[0] == '#'))
10812 if (Jim_GetCallFrameByLevel(interp, argv[1],
10813 &targetCallFrame, NULL) != JIM_OK)
10818 if (Jim_GetCallFrameByLevel(interp, NULL,
10819 &targetCallFrame, NULL) != JIM_OK)
10822 /* Check for arity */
10823 if (argc < 3 || ((argc-1)%2) != 0) {
10824 Jim_WrongNumArgs(interp, 1, argv, "?level? otherVar localVar ?otherVar localVar ...?");
10827 /* Now... for every other/local couple: */
10828 for (i = 1; i < argc; i += 2) {
10829 if (Jim_SetVariableLink(interp, argv[i+1], argv[i],
10830 targetCallFrame) != JIM_OK) return JIM_ERR;
10836 static int Jim_GlobalCoreCommand(Jim_Interp *interp, int argc,
10837 Jim_Obj *const *argv)
10842 Jim_WrongNumArgs(interp, 1, argv, "varName ?varName ...?");
10845 /* Link every var to the toplevel having the same name */
10846 if (interp->numLevels == 0) return JIM_OK; /* global at toplevel... */
10847 for (i = 1; i < argc; i++) {
10848 if (Jim_SetVariableLink(interp, argv[i], argv[i],
10849 interp->topFramePtr) != JIM_OK) return JIM_ERR;
10854 /* does the [string map] operation. On error NULL is returned,
10855 * otherwise a new string object with the result, having refcount = 0,
10857 static Jim_Obj *JimStringMap(Jim_Interp *interp, Jim_Obj *mapListObjPtr,
10858 Jim_Obj *objPtr, int nocase)
10861 const char **key, *str, *noMatchStart = NULL;
10863 int *keyLen, strLen, i;
10864 Jim_Obj *resultObjPtr;
10866 Jim_ListLength(interp, mapListObjPtr, &numMaps);
10868 Jim_SetResultString(interp,
10869 "list must contain an even number of elements", -1);
10872 /* Initialization */
10874 key = Jim_Alloc(sizeof(char*)*numMaps);
10875 keyLen = Jim_Alloc(sizeof(int)*numMaps);
10876 value = Jim_Alloc(sizeof(Jim_Obj*)*numMaps);
10877 resultObjPtr = Jim_NewStringObj(interp, "", 0);
10878 for (i = 0; i < numMaps; i++) {
10879 Jim_Obj *eleObjPtr;
10881 Jim_ListIndex(interp, mapListObjPtr, i*2, &eleObjPtr, JIM_NONE);
10882 key[i] = Jim_GetString(eleObjPtr, &keyLen[i]);
10883 Jim_ListIndex(interp, mapListObjPtr, i*2+1, &eleObjPtr, JIM_NONE);
10884 value[i] = eleObjPtr;
10886 str = Jim_GetString(objPtr, &strLen);
10889 for (i = 0; i < numMaps; i++) {
10890 if (strLen >= keyLen[i] && keyLen[i]) {
10891 if (!JimStringCompare(str, keyLen[i], key[i], keyLen[i],
10894 if (noMatchStart) {
10895 Jim_AppendString(interp, resultObjPtr,
10896 noMatchStart, str-noMatchStart);
10897 noMatchStart = NULL;
10899 Jim_AppendObj(interp, resultObjPtr, value[i]);
10901 strLen -= keyLen[i];
10906 if (i == numMaps) { /* no match */
10907 if (noMatchStart == NULL)
10908 noMatchStart = str;
10913 if (noMatchStart) {
10914 Jim_AppendString(interp, resultObjPtr,
10915 noMatchStart, str-noMatchStart);
10917 Jim_Free((void*)key);
10920 return resultObjPtr;
10924 static int Jim_StringCoreCommand(Jim_Interp *interp, int argc,
10925 Jim_Obj *const *argv)
10928 const char *options[] = {
10929 "length", "compare", "match", "equal", "range", "map", "repeat",
10930 "index", "first", "tolower", "toupper", NULL
10933 OPT_LENGTH, OPT_COMPARE, OPT_MATCH, OPT_EQUAL, OPT_RANGE,
10934 OPT_MAP, OPT_REPEAT, OPT_INDEX, OPT_FIRST, OPT_TOLOWER, OPT_TOUPPER
10938 Jim_WrongNumArgs(interp, 1, argv, "option ?arguments ...?");
10941 if (Jim_GetEnum(interp, argv[1], options, &option, "option",
10942 JIM_ERRMSG) != JIM_OK)
10945 if (option == OPT_LENGTH) {
10949 Jim_WrongNumArgs(interp, 2, argv, "string");
10952 Jim_GetString(argv[2], &len);
10953 Jim_SetResult(interp, Jim_NewIntObj(interp, len));
10955 } else if (option == OPT_COMPARE) {
10957 if ((argc != 4 && argc != 5) ||
10958 (argc == 5 && Jim_CompareStringImmediate(interp,
10959 argv[2], "-nocase") == 0)) {
10960 Jim_WrongNumArgs(interp, 2, argv, "string1 string2");
10967 Jim_SetResult(interp, Jim_NewIntObj(interp,
10968 Jim_StringCompareObj(argv[2],
10969 argv[3], nocase)));
10971 } else if (option == OPT_MATCH) {
10973 if ((argc != 4 && argc != 5) ||
10974 (argc == 5 && Jim_CompareStringImmediate(interp,
10975 argv[2], "-nocase") == 0)) {
10976 Jim_WrongNumArgs(interp, 2, argv, "?-nocase? pattern "
10984 Jim_SetResult(interp,
10985 Jim_NewIntObj(interp, Jim_StringMatchObj(argv[2],
10986 argv[3], nocase)));
10988 } else if (option == OPT_EQUAL) {
10990 Jim_WrongNumArgs(interp, 2, argv, "string1 string2");
10993 Jim_SetResult(interp,
10994 Jim_NewIntObj(interp, Jim_StringEqObj(argv[2],
10997 } else if (option == OPT_RANGE) {
11001 Jim_WrongNumArgs(interp, 2, argv, "string first last");
11004 objPtr = Jim_StringRangeObj(interp, argv[2], argv[3], argv[4]);
11005 if (objPtr == NULL)
11007 Jim_SetResult(interp, objPtr);
11009 } else if (option == OPT_MAP) {
11013 if ((argc != 4 && argc != 5) ||
11014 (argc == 5 && Jim_CompareStringImmediate(interp,
11015 argv[2], "-nocase") == 0)) {
11016 Jim_WrongNumArgs(interp, 2, argv, "?-nocase? mapList "
11024 objPtr = JimStringMap(interp, argv[2], argv[3], nocase);
11025 if (objPtr == NULL)
11027 Jim_SetResult(interp, objPtr);
11029 } else if (option == OPT_REPEAT) {
11034 Jim_WrongNumArgs(interp, 2, argv, "string count");
11037 if (Jim_GetWide(interp, argv[3], &count) != JIM_OK)
11039 objPtr = Jim_NewStringObj(interp, "", 0);
11041 Jim_AppendObj(interp, objPtr, argv[2]);
11043 Jim_SetResult(interp, objPtr);
11045 } else if (option == OPT_INDEX) {
11050 Jim_WrongNumArgs(interp, 2, argv, "string index");
11053 if (Jim_GetIndex(interp, argv[3], &index) != JIM_OK)
11055 str = Jim_GetString(argv[2], &len);
11056 if (index != INT_MIN && index != INT_MAX)
11057 index = JimRelToAbsIndex(len, index);
11058 if (index < 0 || index >= len) {
11059 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
11062 Jim_SetResult(interp, Jim_NewStringObj(interp, str+index, 1));
11065 } else if (option == OPT_FIRST) {
11066 int index = 0, l1, l2;
11067 const char *s1, *s2;
11069 if (argc != 4 && argc != 5) {
11070 Jim_WrongNumArgs(interp, 2, argv, "subString string ?startIndex?");
11073 s1 = Jim_GetString(argv[2], &l1);
11074 s2 = Jim_GetString(argv[3], &l2);
11076 if (Jim_GetIndex(interp, argv[4], &index) != JIM_OK)
11078 index = JimRelToAbsIndex(l2, index);
11080 Jim_SetResult(interp, Jim_NewIntObj(interp,
11081 JimStringFirst(s1, l1, s2, l2, index)));
11083 } else if (option == OPT_TOLOWER) {
11085 Jim_WrongNumArgs(interp, 2, argv, "string");
11088 Jim_SetResult(interp, JimStringToLower(interp, argv[2]));
11089 } else if (option == OPT_TOUPPER) {
11091 Jim_WrongNumArgs(interp, 2, argv, "string");
11094 Jim_SetResult(interp, JimStringToUpper(interp, argv[2]));
11100 static int Jim_TimeCoreCommand(Jim_Interp *interp, int argc,
11101 Jim_Obj *const *argv)
11104 jim_wide start, elapsed;
11106 const char *fmt = "%" JIM_WIDE_MODIFIER " microseconds per iteration";
11109 Jim_WrongNumArgs(interp, 1, argv, "script ?count?");
11113 if (Jim_GetLong(interp, argv[2], &count) != JIM_OK)
11119 start = JimClock();
11123 if ((retval = Jim_EvalObj(interp, argv[1])) != JIM_OK)
11126 elapsed = JimClock() - start;
11127 sprintf(buf, fmt, elapsed/count);
11128 Jim_SetResultString(interp, buf, -1);
11133 static int Jim_ExitCoreCommand(Jim_Interp *interp, int argc,
11134 Jim_Obj *const *argv)
11139 Jim_WrongNumArgs(interp, 1, argv, "?exitCode?");
11143 if (Jim_GetLong(interp, argv[1], &exitCode) != JIM_OK)
11146 interp->exitCode = exitCode;
11151 static int Jim_CatchCoreCommand(Jim_Interp *interp, int argc,
11152 Jim_Obj *const *argv)
11156 if (argc != 2 && argc != 3) {
11157 Jim_WrongNumArgs(interp, 1, argv, "script ?varName?");
11160 exitCode = Jim_EvalObj(interp, argv[1]);
11162 if (Jim_SetVariable(interp, argv[2], Jim_GetResult(interp))
11166 Jim_SetResult(interp, Jim_NewIntObj(interp, exitCode));
11171 static int Jim_RefCoreCommand(Jim_Interp *interp, int argc,
11172 Jim_Obj *const *argv)
11174 if (argc != 3 && argc != 4) {
11175 Jim_WrongNumArgs(interp, 1, argv, "string tag ?finalizer?");
11179 Jim_SetResult(interp, Jim_NewReference(interp, argv[1], argv[2], NULL));
11181 Jim_SetResult(interp, Jim_NewReference(interp, argv[1], argv[2],
11188 static int Jim_GetrefCoreCommand(Jim_Interp *interp, int argc,
11189 Jim_Obj *const *argv)
11191 Jim_Reference *refPtr;
11194 Jim_WrongNumArgs(interp, 1, argv, "reference");
11197 if ((refPtr = Jim_GetReference(interp, argv[1])) == NULL)
11199 Jim_SetResult(interp, refPtr->objPtr);
11204 static int Jim_SetrefCoreCommand(Jim_Interp *interp, int argc,
11205 Jim_Obj *const *argv)
11207 Jim_Reference *refPtr;
11210 Jim_WrongNumArgs(interp, 1, argv, "reference newValue");
11213 if ((refPtr = Jim_GetReference(interp, argv[1])) == NULL)
11215 Jim_IncrRefCount(argv[2]);
11216 Jim_DecrRefCount(interp, refPtr->objPtr);
11217 refPtr->objPtr = argv[2];
11218 Jim_SetResult(interp, argv[2]);
11223 static int Jim_CollectCoreCommand(Jim_Interp *interp, int argc,
11224 Jim_Obj *const *argv)
11227 Jim_WrongNumArgs(interp, 1, argv, "");
11230 Jim_SetResult(interp, Jim_NewIntObj(interp, Jim_Collect(interp)));
11234 /* [finalize] reference ?newValue? */
11235 static int Jim_FinalizeCoreCommand(Jim_Interp *interp, int argc,
11236 Jim_Obj *const *argv)
11238 if (argc != 2 && argc != 3) {
11239 Jim_WrongNumArgs(interp, 1, argv, "reference ?finalizerProc?");
11243 Jim_Obj *cmdNamePtr;
11245 if (Jim_GetFinalizer(interp, argv[1], &cmdNamePtr) != JIM_OK)
11247 if (cmdNamePtr != NULL) /* otherwise the null string is returned. */
11248 Jim_SetResult(interp, cmdNamePtr);
11250 if (Jim_SetFinalizer(interp, argv[1], argv[2]) != JIM_OK)
11252 Jim_SetResult(interp, argv[2]);
11258 /* [info references] (list of all the references/finalizers) */
11261 static int Jim_RenameCoreCommand(Jim_Interp *interp, int argc,
11262 Jim_Obj *const *argv)
11264 const char *oldName, *newName;
11267 Jim_WrongNumArgs(interp, 1, argv, "oldName newName");
11270 oldName = Jim_GetString(argv[1], NULL);
11271 newName = Jim_GetString(argv[2], NULL);
11272 if (Jim_RenameCommand(interp, oldName, newName) != JIM_OK) {
11273 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
11274 Jim_AppendStrings(interp, Jim_GetResult(interp),
11275 "can't rename \"", oldName, "\": ",
11276 "command doesn't exist", NULL);
11283 static int Jim_DictCoreCommand(Jim_Interp *interp, int argc,
11284 Jim_Obj *const *argv)
11287 const char *options[] = {
11288 "create", "get", "set", "unset", "exists", NULL
11291 OPT_CREATE, OPT_GET, OPT_SET, OPT_UNSET, OPT_EXIST
11295 Jim_WrongNumArgs(interp, 1, argv, "option ?arguments ...?");
11299 if (Jim_GetEnum(interp, argv[1], options, &option, "option",
11300 JIM_ERRMSG) != JIM_OK)
11303 if (option == OPT_CREATE) {
11307 Jim_WrongNumArgs(interp, 2, argv, "?key value ...?");
11310 objPtr = Jim_NewDictObj(interp, argv+2, argc-2);
11311 Jim_SetResult(interp, objPtr);
11313 } else if (option == OPT_GET) {
11316 if (Jim_DictKeysVector(interp, argv[2], argv+3, argc-3, &objPtr,
11317 JIM_ERRMSG) != JIM_OK)
11319 Jim_SetResult(interp, objPtr);
11321 } else if (option == OPT_SET) {
11323 Jim_WrongNumArgs(interp, 2, argv, "varName key ?key ...? value");
11326 return Jim_SetDictKeysVector(interp, argv[2], argv+3, argc-4,
11328 } else if (option == OPT_UNSET) {
11330 Jim_WrongNumArgs(interp, 2, argv, "varName key ?key ...?");
11333 return Jim_SetDictKeysVector(interp, argv[2], argv+3, argc-3,
11335 } else if (option == OPT_EXIST) {
11339 if (Jim_DictKeysVector(interp, argv[2], argv+3, argc-3, &objPtr,
11340 JIM_ERRMSG) == JIM_OK)
11344 Jim_SetResult(interp, Jim_NewIntObj(interp, exists));
11347 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
11348 Jim_AppendStrings(interp, Jim_GetResult(interp),
11349 "bad option \"", Jim_GetString(argv[1], NULL), "\":",
11350 " must be create, get, set", NULL);
11357 static int Jim_LoadCoreCommand(Jim_Interp *interp, int argc,
11358 Jim_Obj *const *argv)
11361 Jim_WrongNumArgs(interp, 1, argv, "libaryFile");
11364 return Jim_LoadLibrary(interp, Jim_GetString(argv[1], NULL));
11368 static int Jim_SubstCoreCommand(Jim_Interp *interp, int argc,
11369 Jim_Obj *const *argv)
11375 Jim_WrongNumArgs(interp, 1, argv,
11376 "?-nobackslashes? ?-nocommands? ?-novariables? string");
11381 if (Jim_CompareStringImmediate(interp, argv[i+1],
11383 flags |= JIM_SUBST_NOESC;
11384 else if (Jim_CompareStringImmediate(interp, argv[i+1],
11386 flags |= JIM_SUBST_NOVAR;
11387 else if (Jim_CompareStringImmediate(interp, argv[i+1],
11389 flags |= JIM_SUBST_NOCMD;
11391 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
11392 Jim_AppendStrings(interp, Jim_GetResult(interp),
11393 "bad option \"", Jim_GetString(argv[i+1], NULL),
11394 "\": must be -nobackslashes, -nocommands, or "
11395 "-novariables", NULL);
11399 if (Jim_SubstObj(interp, argv[argc-1], &objPtr, flags) != JIM_OK)
11401 Jim_SetResult(interp, objPtr);
11406 static int Jim_InfoCoreCommand(Jim_Interp *interp, int argc,
11407 Jim_Obj *const *argv)
11409 int cmd, result = JIM_OK;
11410 static const char *commands[] = {
11411 "body", "commands", "exists", "globals", "level", "locals",
11412 "vars", "version", "complete", "args", NULL
11414 enum {INFO_BODY, INFO_COMMANDS, INFO_EXISTS, INFO_GLOBALS, INFO_LEVEL,
11415 INFO_LOCALS, INFO_VARS, INFO_VERSION, INFO_COMPLETE, INFO_ARGS};
11418 Jim_WrongNumArgs(interp, 1, argv, "command ?args ...?");
11421 if (Jim_GetEnum(interp, argv[1], commands, &cmd, "command", JIM_ERRMSG)
11426 if (cmd == INFO_COMMANDS) {
11427 if (argc != 2 && argc != 3) {
11428 Jim_WrongNumArgs(interp, 2, argv, "?pattern?");
11432 Jim_SetResult(interp,JimCommandsList(interp, argv[2]));
11434 Jim_SetResult(interp, JimCommandsList(interp, NULL));
11435 } else if (cmd == INFO_EXISTS) {
11438 Jim_WrongNumArgs(interp, 2, argv, "varName");
11441 exists = Jim_GetVariable(interp, argv[2], 0);
11442 Jim_SetResult(interp, Jim_NewIntObj(interp, exists != 0));
11443 } else if (cmd == INFO_GLOBALS || cmd == INFO_LOCALS || cmd == INFO_VARS) {
11446 case INFO_GLOBALS: mode = JIM_VARLIST_GLOBALS; break;
11447 case INFO_LOCALS: mode = JIM_VARLIST_LOCALS; break;
11448 case INFO_VARS: mode = JIM_VARLIST_VARS; break;
11449 default: mode = 0; /* avoid warning */; break;
11451 if (argc != 2 && argc != 3) {
11452 Jim_WrongNumArgs(interp, 2, argv, "?pattern?");
11456 Jim_SetResult(interp,JimVariablesList(interp, argv[2], mode));
11458 Jim_SetResult(interp, JimVariablesList(interp, NULL, mode));
11459 } else if (cmd == INFO_LEVEL) {
11463 Jim_SetResult(interp,
11464 Jim_NewIntObj(interp, interp->numLevels));
11467 if (JimInfoLevel(interp, argv[2], &objPtr) != JIM_OK)
11469 Jim_SetResult(interp, objPtr);
11472 Jim_WrongNumArgs(interp, 2, argv, "?levelNum?");
11475 } else if (cmd == INFO_BODY || cmd == INFO_ARGS) {
11479 Jim_WrongNumArgs(interp, 2, argv, "procname");
11482 if ((cmdPtr = Jim_GetCommand(interp, argv[2], JIM_ERRMSG)) == NULL)
11484 if (cmdPtr->cmdProc != NULL) {
11485 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
11486 Jim_AppendStrings(interp, Jim_GetResult(interp),
11487 "command \"", Jim_GetString(argv[2], NULL),
11488 "\" is not a procedure", NULL);
11491 if (cmd == INFO_BODY)
11492 Jim_SetResult(interp, cmdPtr->bodyObjPtr);
11494 Jim_SetResult(interp, cmdPtr->argListObjPtr);
11495 } else if (cmd == INFO_VERSION) {
11496 char buf[(JIM_INTEGER_SPACE * 2) + 1];
11497 sprintf(buf, "%d.%d",
11498 JIM_VERSION / 100, JIM_VERSION % 100);
11499 Jim_SetResultString(interp, buf, -1);
11500 } else if (cmd == INFO_COMPLETE) {
11505 Jim_WrongNumArgs(interp, 2, argv, "script");
11508 s = Jim_GetString(argv[2], &len);
11509 Jim_SetResult(interp,
11510 Jim_NewIntObj(interp, Jim_ScriptIsComplete(s, len, NULL)));
11516 static int Jim_SplitCoreCommand(Jim_Interp *interp, int argc,
11517 Jim_Obj *const *argv)
11519 const char *str, *splitChars, *noMatchStart;
11520 int splitLen, strLen, i;
11521 Jim_Obj *resObjPtr;
11523 if (argc != 2 && argc != 3) {
11524 Jim_WrongNumArgs(interp, 1, argv, "string ?splitChars?");
11529 splitChars = " \n\t\r";
11532 splitChars = Jim_GetString(argv[2], &splitLen);
11534 str = Jim_GetString(argv[1], &strLen);
11535 if (!strLen) return JIM_OK;
11536 noMatchStart = str;
11537 resObjPtr = Jim_NewListObj(interp, NULL, 0);
11541 for (i = 0; i < splitLen; i++) {
11542 if (*str == splitChars[i]) {
11545 objPtr = Jim_NewStringObj(interp, noMatchStart,
11546 (str-noMatchStart));
11547 Jim_ListAppendElement(interp, resObjPtr, objPtr);
11548 noMatchStart = str+1;
11555 Jim_ListAppendElement(interp, resObjPtr,
11556 Jim_NewStringObj(interp, noMatchStart, (str-noMatchStart)));
11558 /* This handles the special case of splitchars eq {}. This
11559 * is trivial but we want to perform object sharing as Tcl does. */
11560 Jim_Obj *objCache[256];
11561 const unsigned char *u = (unsigned char*) str;
11562 memset(objCache, 0, sizeof(objCache));
11563 for (i = 0; i < strLen; i++) {
11566 if (objCache[c] == NULL)
11567 objCache[c] = Jim_NewStringObj(interp, (char*)u+i, 1);
11568 Jim_ListAppendElement(interp, resObjPtr, objCache[c]);
11571 Jim_SetResult(interp, resObjPtr);
11576 static int Jim_JoinCoreCommand(Jim_Interp *interp, int argc,
11577 Jim_Obj *const *argv)
11579 const char *joinStr;
11580 int joinStrLen, i, listLen;
11581 Jim_Obj *resObjPtr;
11583 if (argc != 2 && argc != 3) {
11584 Jim_WrongNumArgs(interp, 1, argv, "list ?joinString?");
11592 joinStr = Jim_GetString(argv[2], &joinStrLen);
11594 Jim_ListLength(interp, argv[1], &listLen);
11595 resObjPtr = Jim_NewStringObj(interp, NULL, 0);
11597 for (i = 0; i < listLen; i++) {
11600 Jim_ListIndex(interp, argv[1], i, &objPtr, JIM_NONE);
11601 Jim_AppendObj(interp, resObjPtr, objPtr);
11602 if (i+1 != listLen) {
11603 Jim_AppendString(interp, resObjPtr, joinStr, joinStrLen);
11606 Jim_SetResult(interp, resObjPtr);
11611 static int Jim_FormatCoreCommand(Jim_Interp *interp, int argc,
11612 Jim_Obj *const *argv)
11617 Jim_WrongNumArgs(interp, 1, argv, "formatString ?arg arg ...?");
11620 objPtr = Jim_FormatString(interp, argv[1], argc-2, argv+2);
11621 if (objPtr == NULL)
11623 Jim_SetResult(interp, objPtr);
11628 static int Jim_ScanCoreCommand(Jim_Interp *interp, int argc,
11629 Jim_Obj *const *argv)
11631 Jim_Obj *listPtr, **outVec;
11632 int outc, i, count = 0;
11635 Jim_WrongNumArgs(interp, 1, argv, "string formatString ?varName ...?");
11638 if (argv[2]->typePtr != &scanFmtStringObjType)
11639 SetScanFmtFromAny(interp, argv[2]);
11640 if (FormatGetError(argv[2]) != 0) {
11641 Jim_SetResultString(interp, FormatGetError(argv[2]), -1);
11645 int maxPos = FormatGetMaxPos(argv[2]);
11646 int count = FormatGetCnvCount(argv[2]);
11647 if (maxPos > argc-3) {
11648 Jim_SetResultString(interp, "\"%n$\" argument index out of range", -1);
11650 } else if (count != 0 && count < argc-3) {
11651 Jim_SetResultString(interp, "variable is not assigned by any "
11652 "conversion specifiers", -1);
11654 } else if (count > argc-3) {
11655 Jim_SetResultString(interp, "different numbers of variable names and "
11656 "field specifiers", -1);
11660 listPtr = Jim_ScanString(interp, argv[1], argv[2], JIM_ERRMSG);
11665 if (listPtr != 0 && listPtr != (Jim_Obj*)EOF)
11666 Jim_ListLength(interp, listPtr, &len);
11667 if (listPtr == (Jim_Obj*)EOF || len == 0) { // XXX
11668 Jim_SetResult(interp, Jim_NewIntObj(interp, -1));
11671 JimListGetElements(interp, listPtr, &outc, &outVec);
11672 for (i = 0; i < outc; ++i) {
11673 if (Jim_Length(outVec[i]) > 0) {
11675 if (Jim_SetVariable(interp, argv[3+i], outVec[i]) != JIM_OK)
11679 Jim_FreeNewObj(interp, listPtr);
11680 Jim_SetResult(interp, Jim_NewIntObj(interp, count));
11682 if (listPtr == (Jim_Obj*)EOF) {
11683 Jim_SetResult(interp, Jim_NewListObj(interp, 0, 0));
11686 Jim_SetResult(interp, listPtr);
11690 Jim_FreeNewObj(interp, listPtr);
11695 static int Jim_ErrorCoreCommand(Jim_Interp *interp, int argc,
11696 Jim_Obj *const *argv)
11699 Jim_WrongNumArgs(interp, 1, argv, "message");
11702 Jim_SetResult(interp, argv[1]);
11707 static int Jim_LrangeCoreCommand(Jim_Interp *interp, int argc,
11708 Jim_Obj *const *argv)
11713 Jim_WrongNumArgs(interp, 1, argv, "list first last");
11716 if ((objPtr = Jim_ListRange(interp, argv[1], argv[2], argv[3])) == NULL)
11718 Jim_SetResult(interp, objPtr);
11723 static int Jim_EnvCoreCommand(Jim_Interp *interp, int argc,
11724 Jim_Obj *const *argv)
11730 Jim_WrongNumArgs(interp, 1, argv, "varName");
11733 key = Jim_GetString(argv[1], NULL);
11736 Jim_SetResult(interp, Jim_NewEmptyStringObj(interp));
11737 Jim_AppendStrings(interp, Jim_GetResult(interp),
11738 "environment variable \"",
11739 key, "\" does not exist", NULL);
11742 Jim_SetResult(interp, Jim_NewStringObj(interp, val, -1));
11747 static int Jim_SourceCoreCommand(Jim_Interp *interp, int argc,
11748 Jim_Obj *const *argv)
11753 Jim_WrongNumArgs(interp, 1, argv, "fileName");
11756 retval = Jim_EvalFile(interp, Jim_GetString(argv[1], NULL));
11757 if (retval == JIM_RETURN)
11763 static int Jim_LreverseCoreCommand(Jim_Interp *interp, int argc,
11764 Jim_Obj *const *argv)
11766 Jim_Obj *revObjPtr, **ele;
11770 Jim_WrongNumArgs(interp, 1, argv, "list");
11773 JimListGetElements(interp, argv[1], &len, &ele);
11775 revObjPtr = Jim_NewListObj(interp, NULL, 0);
11777 ListAppendElement(revObjPtr, ele[len--]);
11778 Jim_SetResult(interp, revObjPtr);
11782 static int JimRangeLen(jim_wide start, jim_wide end, jim_wide step)
11786 if (step == 0) return -1;
11787 if (start == end) return 0;
11788 else if (step > 0 && start > end) return -1;
11789 else if (step < 0 && end > start) return -1;
11791 if (len < 0) len = -len; /* abs(len) */
11792 if (step < 0) step = -step; /* abs(step) */
11793 len = 1 + ((len-1)/step);
11794 /* We can truncate safely to INT_MAX, the range command
11795 * will always return an error for a such long range
11796 * because Tcl lists can't be so long. */
11797 if (len > INT_MAX) len = INT_MAX;
11798 return (int)((len < 0) ? -1 : len);
11802 static int Jim_RangeCoreCommand(Jim_Interp *interp, int argc,
11803 Jim_Obj *const *argv)
11805 jim_wide start = 0, end, step = 1;
11809 if (argc < 2 || argc > 4) {
11810 Jim_WrongNumArgs(interp, 1, argv, "?start? end ?step?");
11814 if (Jim_GetWide(interp, argv[1], &end) != JIM_OK)
11817 if (Jim_GetWide(interp, argv[1], &start) != JIM_OK ||
11818 Jim_GetWide(interp, argv[2], &end) != JIM_OK)
11820 if (argc == 4 && Jim_GetWide(interp, argv[3], &step) != JIM_OK)
11823 if ((len = JimRangeLen(start, end, step)) == -1) {
11824 Jim_SetResultString(interp, "Invalid (infinite?) range specified", -1);
11827 objPtr = Jim_NewListObj(interp, NULL, 0);
11828 for (i = 0; i < len; i++)
11829 ListAppendElement(objPtr, Jim_NewIntObj(interp, start+i*step));
11830 Jim_SetResult(interp, objPtr);
11835 static int Jim_RandCoreCommand(Jim_Interp *interp, int argc,
11836 Jim_Obj *const *argv)
11838 jim_wide min = 0, max, len, maxMul;
11840 if (argc < 1 || argc > 3) {
11841 Jim_WrongNumArgs(interp, 1, argv, "?min? max");
11845 max = JIM_WIDE_MAX;
11846 } else if (argc == 2) {
11847 if (Jim_GetWide(interp, argv[1], &max) != JIM_OK)
11849 } else if (argc == 3) {
11850 if (Jim_GetWide(interp, argv[1], &min) != JIM_OK ||
11851 Jim_GetWide(interp, argv[2], &max) != JIM_OK)
11856 Jim_SetResultString(interp, "Invalid arguments (max < min)", -1);
11859 maxMul = JIM_WIDE_MAX - (len ? (JIM_WIDE_MAX%len) : 0);
11863 JimRandomBytes(interp, &r, sizeof(jim_wide));
11864 if (r < 0 || r >= maxMul) continue;
11865 r = (len == 0) ? 0 : r%len;
11866 Jim_SetResult(interp, Jim_NewIntObj(interp, min+r));
11872 static int Jim_PackageCoreCommand(Jim_Interp *interp, int argc,
11873 Jim_Obj *const *argv)
11876 const char *options[] = {
11877 "require", "provide", NULL
11879 enum {OPT_REQUIRE, OPT_PROVIDE};
11882 Jim_WrongNumArgs(interp, 1, argv, "option ?arguments ...?");
11885 if (Jim_GetEnum(interp, argv[1], options, &option, "option",
11886 JIM_ERRMSG) != JIM_OK)
11889 if (option == OPT_REQUIRE) {
11893 if (Jim_CompareStringImmediate(interp, argv[2], "-exact")) {
11898 if (argc != 3 && argc != 4) {
11899 Jim_WrongNumArgs(interp, 2, argv, "?-exact? package ?version?");
11902 ver = Jim_PackageRequire(interp, Jim_GetString(argv[2], NULL),
11903 argc == 4 ? Jim_GetString(argv[3], NULL) : "",
11907 Jim_SetResultString(interp, ver, -1);
11908 } else if (option == OPT_PROVIDE) {
11910 Jim_WrongNumArgs(interp, 2, argv, "package version");
11913 return Jim_PackageProvide(interp, Jim_GetString(argv[2], NULL),
11914 Jim_GetString(argv[3], NULL), JIM_ERRMSG);
11921 Jim_CmdProc cmdProc;
11922 } Jim_CoreCommandsTable[] = {
11923 {"set", Jim_SetCoreCommand},
11924 {"unset", Jim_UnsetCoreCommand},
11925 {"puts", Jim_PutsCoreCommand},
11926 {"+", Jim_AddCoreCommand},
11927 {"*", Jim_MulCoreCommand},
11928 {"-", Jim_SubCoreCommand},
11929 {"/", Jim_DivCoreCommand},
11930 {"incr", Jim_IncrCoreCommand},
11931 {"while", Jim_WhileCoreCommand},
11932 {"for", Jim_ForCoreCommand},
11933 {"foreach", Jim_ForeachCoreCommand},
11934 {"lmap", Jim_LmapCoreCommand},
11935 {"if", Jim_IfCoreCommand},
11936 {"switch", Jim_SwitchCoreCommand},
11937 {"list", Jim_ListCoreCommand},
11938 {"lindex", Jim_LindexCoreCommand},
11939 {"lset", Jim_LsetCoreCommand},
11940 {"llength", Jim_LlengthCoreCommand},
11941 {"lappend", Jim_LappendCoreCommand},
11942 {"linsert", Jim_LinsertCoreCommand},
11943 {"lsort", Jim_LsortCoreCommand},
11944 {"append", Jim_AppendCoreCommand},
11945 {"debug", Jim_DebugCoreCommand},
11946 {"eval", Jim_EvalCoreCommand},
11947 {"uplevel", Jim_UplevelCoreCommand},
11948 {"expr", Jim_ExprCoreCommand},
11949 {"break", Jim_BreakCoreCommand},
11950 {"continue", Jim_ContinueCoreCommand},
11951 {"proc", Jim_ProcCoreCommand},
11952 {"concat", Jim_ConcatCoreCommand},
11953 {"return", Jim_ReturnCoreCommand},
11954 {"upvar", Jim_UpvarCoreCommand},
11955 {"global", Jim_GlobalCoreCommand},
11956 {"string", Jim_StringCoreCommand},
11957 {"time", Jim_TimeCoreCommand},
11958 {"exit", Jim_ExitCoreCommand},
11959 {"catch", Jim_CatchCoreCommand},
11960 {"ref", Jim_RefCoreCommand},
11961 {"getref", Jim_GetrefCoreCommand},
11962 {"setref", Jim_SetrefCoreCommand},
11963 {"finalize", Jim_FinalizeCoreCommand},
11964 {"collect", Jim_CollectCoreCommand},
11965 {"rename", Jim_RenameCoreCommand},
11966 {"dict", Jim_DictCoreCommand},
11967 {"load", Jim_LoadCoreCommand},
11968 {"subst", Jim_SubstCoreCommand},
11969 {"info", Jim_InfoCoreCommand},
11970 {"split", Jim_SplitCoreCommand},
11971 {"join", Jim_JoinCoreCommand},
11972 {"format", Jim_FormatCoreCommand},
11973 {"scan", Jim_ScanCoreCommand},
11974 {"error", Jim_ErrorCoreCommand},
11975 {"lrange", Jim_LrangeCoreCommand},
11976 {"env", Jim_EnvCoreCommand},
11977 {"source", Jim_SourceCoreCommand},
11978 {"lreverse", Jim_LreverseCoreCommand},
11979 {"range", Jim_RangeCoreCommand},
11980 {"rand", Jim_RandCoreCommand},
11981 {"package", Jim_PackageCoreCommand},
11982 {"tailcall", Jim_TailcallCoreCommand},
11986 /* Some Jim core command is actually a procedure written in Jim itself. */
11987 static void Jim_RegisterCoreProcedures(Jim_Interp *interp)
11989 Jim_Eval(interp, (char*)
11990 "proc lambda {arglist args} {\n"
11991 " set name [ref {} function lambdaFinalizer]\n"
11992 " uplevel 1 [list proc $name $arglist {expand}$args]\n"
11995 "proc lambdaFinalizer {name val} {\n"
11996 " rename $name {}\n"
12001 void Jim_RegisterCoreCommands(Jim_Interp *interp)
12005 while(Jim_CoreCommandsTable[i].name != NULL) {
12006 Jim_CreateCommand(interp,
12007 Jim_CoreCommandsTable[i].name,
12008 Jim_CoreCommandsTable[i].cmdProc,
12012 Jim_RegisterCoreProcedures(interp);
12015 /* -----------------------------------------------------------------------------
12016 * Interactive prompt
12017 * ---------------------------------------------------------------------------*/
12018 void Jim_PrintErrorMessage(Jim_Interp *interp)
12022 Jim_fprintf(interp, interp->cookie_stderr, "Runtime error, file \"%s\", line %d:" JIM_NL,
12023 interp->errorFileName, interp->errorLine);
12024 Jim_fprintf(interp,interp->cookie_stderr, " %s" JIM_NL,
12025 Jim_GetString(interp->result, NULL));
12026 Jim_ListLength(interp, interp->stackTrace, &len);
12027 for (i = len-3; i >= 0; i-= 3) {
12029 const char *proc, *file, *line;
12031 Jim_ListIndex(interp, interp->stackTrace, i, &objPtr, JIM_NONE);
12032 proc = Jim_GetString(objPtr, NULL);
12033 Jim_ListIndex(interp, interp->stackTrace, i+1, &objPtr,
12035 file = Jim_GetString(objPtr, NULL);
12036 Jim_ListIndex(interp, interp->stackTrace, i+2, &objPtr,
12038 line = Jim_GetString(objPtr, NULL);
12039 Jim_fprintf( interp, interp->cookie_stderr,
12040 "In procedure '%s' called at file \"%s\", line %s" JIM_NL,
12045 int Jim_InteractivePrompt(Jim_Interp *interp)
12047 int retcode = JIM_OK;
12048 Jim_Obj *scriptObjPtr;
12050 Jim_fprintf(interp,interp->cookie_stdout, "Welcome to Jim version %d.%d, "
12051 "Copyright (c) 2005-8 Salvatore Sanfilippo" JIM_NL,
12052 JIM_VERSION / 100, JIM_VERSION % 100);
12053 Jim_SetVariableStrWithStr(interp, "jim_interactive", "1");
12056 const char *result;
12057 const char *retcodestr[] = {
12058 "ok", "error", "return", "break", "continue", "eval", "exit"
12062 if (retcode != 0) {
12063 if (retcode >= 2 && retcode <= 6)
12064 Jim_fprintf(interp,interp->cookie_stdout, "[%s] . ", retcodestr[retcode]);
12066 Jim_fprintf(interp,interp->cookie_stdout, "[%d] . ", retcode);
12068 Jim_fprintf( interp, interp->cookie_stdout, ". ");
12069 Jim_fflush( interp, interp->cookie_stdout);
12070 scriptObjPtr = Jim_NewStringObj(interp, "", 0);
12071 Jim_IncrRefCount(scriptObjPtr);
12077 if ( Jim_fgets(interp, buf, 1024, interp->cookie_stdin) == NULL) {
12078 Jim_DecrRefCount(interp, scriptObjPtr);
12081 Jim_AppendString(interp, scriptObjPtr, buf, -1);
12082 str = Jim_GetString(scriptObjPtr, &len);
12083 if (Jim_ScriptIsComplete(str, len, &state))
12085 Jim_fprintf( interp, interp->cookie_stdout, "%c> ", state);
12086 Jim_fflush( interp, interp->cookie_stdout);
12088 retcode = Jim_EvalObj(interp, scriptObjPtr);
12089 Jim_DecrRefCount(interp, scriptObjPtr);
12090 result = Jim_GetString(Jim_GetResult(interp), &reslen);
12091 if (retcode == JIM_ERR) {
12092 Jim_PrintErrorMessage(interp);
12093 } else if (retcode == JIM_EXIT) {
12094 exit(Jim_GetExitCode(interp));
12097 Jim_fwrite( interp, result, 1, reslen, interp->cookie_stdout);
12098 Jim_fprintf( interp,interp->cookie_stdout, JIM_NL);
12106 /* -----------------------------------------------------------------------------
12107 * Jim's idea of STDIO..
12108 * ---------------------------------------------------------------------------*/
12110 int Jim_fprintf( Jim_Interp *interp, void *cookie, const char *fmt, ... )
12116 r = Jim_vfprintf( interp, cookie, fmt,ap );
12121 int Jim_vfprintf( Jim_Interp *interp, void *cookie, const char *fmt, va_list ap )
12123 if( (interp == NULL) || (interp->cb_vfprintf == NULL) ){
12127 return (*(interp->cb_vfprintf))( cookie, fmt, ap );
12130 size_t Jim_fwrite( Jim_Interp *interp, const void *ptr, size_t size, size_t n, void *cookie )
12132 if( (interp == NULL) || (interp->cb_fwrite == NULL) ){
12136 return (*(interp->cb_fwrite))( ptr, size, n, cookie);
12139 size_t Jim_fread( Jim_Interp *interp, void *ptr, size_t size, size_t n, void *cookie )
12141 if( (interp == NULL) || (interp->cb_fread == NULL) ){
12145 return (*(interp->cb_fread))( ptr, size, n, cookie);
12148 int Jim_fflush( Jim_Interp *interp, void *cookie )
12150 if( (interp == NULL) || (interp->cb_fflush == NULL) ){
12151 /* pretend all is well */
12154 return (*(interp->cb_fflush))( cookie );
12157 char* Jim_fgets( Jim_Interp *interp, char *s, int size, void *cookie )
12159 if( (interp == NULL) || (interp->cb_fgets == NULL) ){
12163 return (*(interp->cb_fgets))( s, size, cookie );