1 /* Jim - A small embeddable Tcl interpreter
2 * Copyright 2005 Salvatore Sanfilippo <antirez@invece.org>
3 * Copyright 2005 Clemens Hintze <c.hintze@gmx.net>
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * A copy of the license is also included in the source distribution
12 * of Jim, as a TXT file name called LICENSE.
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
22 #define JIM_OPTIMIZATION /* comment to avoid optimizations and reduce size */
25 #include <pkgconf/jimtcl.h>
28 #define JIM_DYNLIB /* Dynamic library support for UNIX and WIN32 */
29 #endif /* JIM_ANSIC */
41 #include "replacements.h"
43 /* Include the platform dependent libraries for
44 * dynamic loading of libraries. */
46 #if defined(_WIN32) || defined(WIN32)
53 #define WIN32_LEAN_AND_MEAN
56 #pragma warning(disable:4146)
61 #endif /* JIM_DYNLIB */
64 #include <cyg/jimtcl/jim.h>
73 /* -----------------------------------------------------------------------------
75 * ---------------------------------------------------------------------------*/
77 /* A shared empty string for the objects string representation.
78 * Jim_InvalidateStringRep knows about it and don't try to free. */
79 static char *JimEmptyStringRep
= (char*) "";
81 /* -----------------------------------------------------------------------------
82 * Required prototypes of not exported functions
83 * ---------------------------------------------------------------------------*/
84 static void JimChangeCallFrameId(Jim_Interp
*interp
, Jim_CallFrame
*cf
);
85 static void JimFreeCallFrame(Jim_Interp
*interp
, Jim_CallFrame
*cf
, int flags
);
86 static void JimRegisterCoreApi(Jim_Interp
*interp
);
88 static Jim_HashTableType JimVariablesHashTableType
;
90 /* -----------------------------------------------------------------------------
92 * ---------------------------------------------------------------------------*/
95 * Convert a string to a jim_wide INTEGER.
96 * This function originates from BSD.
98 * Ignores `locale' stuff. Assumes that the upper and lower case
99 * alphabets and digits are each contiguous.
101 #ifdef HAVE_LONG_LONG
102 #define JimIsAscii(c) (((c) & ~0x7f) == 0)
103 static jim_wide
JimStrtoll(const char *nptr
, char **endptr
, register int base
)
105 register const char *s
;
106 register unsigned jim_wide acc
;
107 register unsigned char c
;
108 register unsigned jim_wide qbase
, cutoff
;
109 register int neg
, any
, cutlim
;
112 * Skip white space and pick up leading +/- sign if any.
113 * If base is 0, allow 0x for hex and 0 for octal, else
114 * assume decimal; if base is already 16, allow 0x.
119 } while (isspace(c
));
128 if ((base
== 0 || base
== 16) &&
129 c
== '0' && (*s
== 'x' || *s
== 'X')) {
135 base
= c
== '0' ? 8 : 10;
138 * Compute the cutoff value between legal numbers and illegal
139 * numbers. That is the largest legal value, divided by the
140 * base. An input number that is greater than this value, if
141 * followed by a legal input character, is too big. One that
142 * is equal to this value may be valid or not; the limit
143 * between valid and invalid numbers is then based on the last
144 * digit. For instance, if the range for quads is
145 * [-9223372036854775808..9223372036854775807] and the input base
146 * is 10, cutoff will be set to 922337203685477580 and cutlim to
147 * either 7 (neg==0) or 8 (neg==1), meaning that if we have
148 * accumulated a value > 922337203685477580, or equal but the
149 * next digit is > 7 (or 8), the number is too big, and we will
150 * return a range error.
152 * Set any if any `digits' consumed; make it negative to indicate
155 qbase
= (unsigned)base
;
156 cutoff
= neg
? (unsigned jim_wide
)-(LLONG_MIN
+ LLONG_MAX
) + LLONG_MAX
158 cutlim
= (int)(cutoff
% qbase
);
160 for (acc
= 0, any
= 0;; c
= *s
++) {
166 c
-= isupper(c
) ? 'A' - 10 : 'a' - 10;
171 if (any
< 0 || acc
> cutoff
|| (acc
== cutoff
&& c
> cutlim
))
180 acc
= neg
? LLONG_MIN
: LLONG_MAX
;
185 *endptr
= (char *)(any
? s
- 1 : nptr
);
190 /* Glob-style pattern matching. */
191 static int JimStringMatch(const char *pattern
, int patternLen
,
192 const char *string
, int stringLen
, int nocase
)
197 while (pattern
[1] == '*') {
202 return 1; /* match */
204 if (JimStringMatch(pattern
+1, patternLen
-1,
205 string
, stringLen
, nocase
))
206 return 1; /* match */
210 return 0; /* no match */
214 return 0; /* no match */
224 not = pattern
[0] == '^';
231 if (pattern
[0] == '\\') {
234 if (pattern
[0] == string
[0])
236 } else if (pattern
[0] == ']') {
238 } else if (patternLen
== 0) {
242 } else if (pattern
[1] == '-' && patternLen
>= 3) {
243 int start
= pattern
[0];
244 int end
= pattern
[2];
252 start
= tolower(start
);
258 if (c
>= start
&& c
<= end
)
262 if (pattern
[0] == string
[0])
265 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
275 return 0; /* no match */
281 if (patternLen
>= 2) {
288 if (pattern
[0] != string
[0])
289 return 0; /* no match */
291 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
292 return 0; /* no match */
300 if (stringLen
== 0) {
301 while(*pattern
== '*') {
308 if (patternLen
== 0 && stringLen
== 0)
313 int JimStringCompare(const char *s1
, int l1
, const char *s2
, int l2
,
316 unsigned char *u1
= (unsigned char*) s1
, *u2
= (unsigned char*) s2
;
322 u1
++; u2
++; l1
--; l2
--;
324 if (!l1
&& !l2
) return 0;
328 if (tolower((int)*u1
) != tolower((int)*u2
))
329 return tolower((int)*u1
)-tolower((int)*u2
);
330 u1
++; u2
++; l1
--; l2
--;
332 if (!l1
&& !l2
) return 0;
337 /* Search 's1' inside 's2', starting to search from char 'index' of 's2'.
338 * The index of the first occurrence of s1 in s2 is returned.
339 * If s1 is not found inside s2, -1 is returned. */
340 int JimStringFirst(const char *s1
, int l1
, const char *s2
, int l2
, int index
)
344 if (!l1
|| !l2
|| l1
> l2
) return -1;
345 if (index
< 0) index
= 0;
347 for (i
= index
; i
<= l2
-l1
; i
++) {
348 if (memcmp(s2
, s1
, l1
) == 0)
355 int Jim_WideToString(char *buf
, jim_wide wideValue
)
357 const char *fmt
= "%" JIM_WIDE_MODIFIER
;
358 return sprintf(buf
, fmt
, wideValue
);
361 int Jim_StringToWide(const char *str
, jim_wide
*widePtr
, int base
)
365 #ifdef HAVE_LONG_LONG
366 *widePtr
= JimStrtoll(str
, &endptr
, base
);
368 *widePtr
= strtol(str
, &endptr
, base
);
370 if ((str
[0] == '\0') || (str
== endptr
) )
372 if (endptr
[0] != '\0') {
374 if (!isspace((int)*endptr
))
382 int Jim_StringToIndex(const char *str
, int *intPtr
)
386 *intPtr
= strtol(str
, &endptr
, 10);
387 if ( (str
[0] == '\0') || (str
== endptr
) )
389 if (endptr
[0] != '\0') {
391 if (!isspace((int)*endptr
))
399 /* The string representation of references has two features in order
400 * to make the GC faster. The first is that every reference starts
401 * with a non common character '~', in order to make the string matching
402 * fater. The second is that the reference string rep his 32 characters
403 * in length, this allows to avoid to check every object with a string
404 * repr < 32, and usually there are many of this objects. */
406 #define JIM_REFERENCE_SPACE (35+JIM_REFERENCE_TAGLEN)
408 static int JimFormatReference(char *buf
, Jim_Reference
*refPtr
, jim_wide id
)
410 const char *fmt
= "<reference.<%s>.%020" JIM_WIDE_MODIFIER
">";
411 sprintf(buf
, fmt
, refPtr
->tag
, id
);
412 return JIM_REFERENCE_SPACE
;
415 int Jim_DoubleToString(char *buf
, double doubleValue
)
420 len
= sprintf(buf
, "%.17g", doubleValue
);
423 if (*s
== '.') return len
;
426 /* Add a final ".0" if it's a number. But not
428 if (isdigit((int)buf
[0])
429 || ((buf
[0] == '-' || buf
[0] == '+')
430 && isdigit((int)buf
[1]))) {
439 int Jim_StringToDouble(const char *str
, double *doublePtr
)
443 *doublePtr
= strtod(str
, &endptr
);
444 if (str
[0] == '\0' || endptr
[0] != '\0' || (str
== endptr
) )
449 static jim_wide
JimPowWide(jim_wide b
, jim_wide e
)
452 if ((b
==0 && e
!=0) || (e
<0)) return 0;
453 for(i
=0; i
<e
; i
++) {res
*= b
;}
457 /* -----------------------------------------------------------------------------
459 * ---------------------------------------------------------------------------*/
461 /* Note that 'interp' may be NULL if not available in the
462 * context of the panic. It's only useful to get the error
463 * file descriptor, it will default to stderr otherwise. */
464 void Jim_Panic(Jim_Interp
*interp
, const char *fmt
, ...)
470 * Send it here first.. Assuming STDIO still works
472 fprintf(stderr
, JIM_NL
"JIM INTERPRETER PANIC: ");
473 vfprintf(stderr
, fmt
, ap
);
474 fprintf(stderr
, JIM_NL JIM_NL
);
477 #ifdef HAVE_BACKTRACE
483 size
= backtrace(array
, 40);
484 strings
= backtrace_symbols(array
, size
);
485 for (i
= 0; i
< size
; i
++)
486 fprintf(fp
,"[backtrace] %s" JIM_NL
, strings
[i
]);
487 fprintf(fp
,"[backtrace] Include the above lines and the output" JIM_NL
);
488 fprintf(fp
,"[backtrace] of 'nm <executable>' in the bug report." JIM_NL
);
492 /* This may actually crash... we do it last */
493 if( interp
&& interp
->cookie_stderr
){
494 Jim_fprintf( interp
, interp
->cookie_stderr
, JIM_NL
"JIM INTERPRETER PANIC: ");
495 Jim_vfprintf( interp
, interp
->cookie_stderr
, fmt
, ap
);
496 Jim_fprintf( interp
, interp
->cookie_stderr
, JIM_NL JIM_NL
);
501 /* -----------------------------------------------------------------------------
503 * ---------------------------------------------------------------------------*/
505 /* Macro used for memory debugging.
506 * In order for they to work you have to rename Jim_Alloc into _Jim_Alloc
507 * and similary for Jim_Realloc and Jim_Free */
509 #define Jim_Alloc(s) (printf("%s %d: Jim_Alloc(%d)\n",__FILE__,__LINE__,s),_Jim_Alloc(s))
510 #define Jim_Free(p) (printf("%s %d: Jim_Free(%p)\n",__FILE__,__LINE__,p),_Jim_Free(p))
511 #define Jim_Realloc(p,s) (printf("%s %d: Jim_Realloc(%p,%d)\n",__FILE__,__LINE__,p,s),_Jim_Realloc(p,s))
514 void *Jim_Alloc(int size
)
516 /* We allocate zero length arrayes, etc. to use a single orthogonal codepath */
519 void *p
= malloc(size
);
521 Jim_Panic(NULL
,"malloc: Out of memory");
525 void Jim_Free(void *ptr
) {
529 void *Jim_Realloc(void *ptr
, int size
)
531 /* We allocate zero length arrayes, etc. to use a single orthogonal codepath */
534 void *p
= realloc(ptr
, size
);
536 Jim_Panic(NULL
,"realloc: Out of memory");
540 char *Jim_StrDup(const char *s
)
543 char *copy
= Jim_Alloc(l
+1);
545 memcpy(copy
, s
, l
+1);
549 char *Jim_StrDupLen(const char *s
, int l
)
551 char *copy
= Jim_Alloc(l
+1);
553 memcpy(copy
, s
, l
+1);
554 copy
[l
] = 0; /* Just to be sure, original could be substring */
558 /* -----------------------------------------------------------------------------
559 * Time related functions
560 * ---------------------------------------------------------------------------*/
561 /* Returns microseconds of CPU used since start. */
562 static jim_wide
JimClock(void)
564 #if (defined WIN32) && !(defined JIM_ANSIC)
566 QueryPerformanceFrequency(&f
);
567 QueryPerformanceCounter(&t
);
568 return (long)((t
.QuadPart
* 1000000) / f
.QuadPart
);
570 clock_t clocks
= clock();
572 return (long)(clocks
*(1000000/CLOCKS_PER_SEC
));
576 /* -----------------------------------------------------------------------------
578 * ---------------------------------------------------------------------------*/
580 /* -------------------------- private prototypes ---------------------------- */
581 static int JimExpandHashTableIfNeeded(Jim_HashTable
*ht
);
582 static unsigned int JimHashTableNextPower(unsigned int size
);
583 static int JimInsertHashEntry(Jim_HashTable
*ht
, const void *key
);
585 /* -------------------------- hash functions -------------------------------- */
587 /* Thomas Wang's 32 bit Mix Function */
588 unsigned int Jim_IntHashFunction(unsigned int key
)
599 /* Identity hash function for integer keys */
600 unsigned int Jim_IdentityHashFunction(unsigned int key
)
605 /* Generic hash function (we are using to multiply by 9 and add the byte
607 unsigned int Jim_GenHashFunction(const unsigned char *buf
, int len
)
615 /* ----------------------------- API implementation ------------------------- */
616 /* reset an hashtable already initialized with ht_init().
617 * NOTE: This function should only called by ht_destroy(). */
618 static void JimResetHashTable(Jim_HashTable
*ht
)
627 /* Initialize the hash table */
628 int Jim_InitHashTable(Jim_HashTable
*ht
, Jim_HashTableType
*type
,
631 JimResetHashTable(ht
);
633 ht
->privdata
= privDataPtr
;
637 /* Resize the table to the minimal size that contains all the elements,
638 * but with the invariant of a USER/BUCKETS ration near to <= 1 */
639 int Jim_ResizeHashTable(Jim_HashTable
*ht
)
641 int minimal
= ht
->used
;
643 if (minimal
< JIM_HT_INITIAL_SIZE
)
644 minimal
= JIM_HT_INITIAL_SIZE
;
645 return Jim_ExpandHashTable(ht
, minimal
);
648 /* Expand or create the hashtable */
649 int Jim_ExpandHashTable(Jim_HashTable
*ht
, unsigned int size
)
651 Jim_HashTable n
; /* the new hashtable */
652 unsigned int realsize
= JimHashTableNextPower(size
), i
;
654 /* the size is invalid if it is smaller than the number of
655 * elements already inside the hashtable */
656 if (ht
->used
>= size
)
659 Jim_InitHashTable(&n
, ht
->type
, ht
->privdata
);
661 n
.sizemask
= realsize
-1;
662 n
.table
= Jim_Alloc(realsize
*sizeof(Jim_HashEntry
*));
664 /* Initialize all the pointers to NULL */
665 memset(n
.table
, 0, realsize
*sizeof(Jim_HashEntry
*));
667 /* Copy all the elements from the old to the new table:
668 * note that if the old hash table is empty ht->size is zero,
669 * so Jim_ExpandHashTable just creates an hash table. */
671 for (i
= 0; i
< ht
->size
&& ht
->used
> 0; i
++) {
672 Jim_HashEntry
*he
, *nextHe
;
674 if (ht
->table
[i
] == NULL
) continue;
676 /* For each hash entry on this slot... */
682 /* Get the new element index */
683 h
= Jim_HashKey(ht
, he
->key
) & n
.sizemask
;
684 he
->next
= n
.table
[h
];
687 /* Pass to the next element */
691 assert(ht
->used
== 0);
694 /* Remap the new hashtable in the old */
699 /* Add an element to the target hash table */
700 int Jim_AddHashEntry(Jim_HashTable
*ht
, const void *key
, void *val
)
703 Jim_HashEntry
*entry
;
705 /* Get the index of the new element, or -1 if
706 * the element already exists. */
707 if ((index
= JimInsertHashEntry(ht
, key
)) == -1)
710 /* Allocates the memory and stores key */
711 entry
= Jim_Alloc(sizeof(*entry
));
712 entry
->next
= ht
->table
[index
];
713 ht
->table
[index
] = entry
;
715 /* Set the hash entry fields. */
716 Jim_SetHashKey(ht
, entry
, key
);
717 Jim_SetHashVal(ht
, entry
, val
);
722 /* Add an element, discarding the old if the key already exists */
723 int Jim_ReplaceHashEntry(Jim_HashTable
*ht
, const void *key
, void *val
)
725 Jim_HashEntry
*entry
;
727 /* Try to add the element. If the key
728 * does not exists Jim_AddHashEntry will suceed. */
729 if (Jim_AddHashEntry(ht
, key
, val
) == JIM_OK
)
731 /* It already exists, get the entry */
732 entry
= Jim_FindHashEntry(ht
, key
);
733 /* Free the old value and set the new one */
734 Jim_FreeEntryVal(ht
, entry
);
735 Jim_SetHashVal(ht
, entry
, val
);
739 /* Search and remove an element */
740 int Jim_DeleteHashEntry(Jim_HashTable
*ht
, const void *key
)
743 Jim_HashEntry
*he
, *prevHe
;
747 h
= Jim_HashKey(ht
, key
) & ht
->sizemask
;
752 if (Jim_CompareHashKeys(ht
, key
, he
->key
)) {
753 /* Unlink the element from the list */
755 prevHe
->next
= he
->next
;
757 ht
->table
[h
] = he
->next
;
758 Jim_FreeEntryKey(ht
, he
);
759 Jim_FreeEntryVal(ht
, he
);
767 return JIM_ERR
; /* not found */
770 /* Destroy an entire hash table */
771 int Jim_FreeHashTable(Jim_HashTable
*ht
)
775 /* Free all the elements */
776 for (i
= 0; i
< ht
->size
&& ht
->used
> 0; i
++) {
777 Jim_HashEntry
*he
, *nextHe
;
779 if ((he
= ht
->table
[i
]) == NULL
) continue;
782 Jim_FreeEntryKey(ht
, he
);
783 Jim_FreeEntryVal(ht
, he
);
789 /* Free the table and the allocated cache structure */
791 /* Re-initialize the table */
792 JimResetHashTable(ht
);
793 return JIM_OK
; /* never fails */
796 Jim_HashEntry
*Jim_FindHashEntry(Jim_HashTable
*ht
, const void *key
)
801 if (ht
->size
== 0) return NULL
;
802 h
= Jim_HashKey(ht
, key
) & ht
->sizemask
;
805 if (Jim_CompareHashKeys(ht
, key
, he
->key
))
812 Jim_HashTableIterator
*Jim_GetHashTableIterator(Jim_HashTable
*ht
)
814 Jim_HashTableIterator
*iter
= Jim_Alloc(sizeof(*iter
));
819 iter
->nextEntry
= NULL
;
823 Jim_HashEntry
*Jim_NextHashEntry(Jim_HashTableIterator
*iter
)
826 if (iter
->entry
== NULL
) {
829 (signed)iter
->ht
->size
) break;
830 iter
->entry
= iter
->ht
->table
[iter
->index
];
832 iter
->entry
= iter
->nextEntry
;
835 /* We need to save the 'next' here, the iterator user
836 * may delete the entry we are returning. */
837 iter
->nextEntry
= iter
->entry
->next
;
844 /* ------------------------- private functions ------------------------------ */
846 /* Expand the hash table if needed */
847 static int JimExpandHashTableIfNeeded(Jim_HashTable
*ht
)
849 /* If the hash table is empty expand it to the intial size,
850 * if the table is "full" dobule its size. */
852 return Jim_ExpandHashTable(ht
, JIM_HT_INITIAL_SIZE
);
853 if (ht
->size
== ht
->used
)
854 return Jim_ExpandHashTable(ht
, ht
->size
*2);
858 /* Our hash table capability is a power of two */
859 static unsigned int JimHashTableNextPower(unsigned int size
)
861 unsigned int i
= JIM_HT_INITIAL_SIZE
;
863 if (size
>= 2147483648U)
872 /* Returns the index of a free slot that can be populated with
873 * an hash entry for the given 'key'.
874 * If the key already exists, -1 is returned. */
875 static int JimInsertHashEntry(Jim_HashTable
*ht
, const void *key
)
880 /* Expand the hashtable if needed */
881 if (JimExpandHashTableIfNeeded(ht
) == JIM_ERR
)
883 /* Compute the key hash value */
884 h
= Jim_HashKey(ht
, key
) & ht
->sizemask
;
885 /* Search if this slot does not already contain the given key */
888 if (Jim_CompareHashKeys(ht
, key
, he
->key
))
895 /* ----------------------- StringCopy Hash Table Type ------------------------*/
897 static unsigned int JimStringCopyHTHashFunction(const void *key
)
899 return Jim_GenHashFunction(key
, strlen(key
));
902 static const void *JimStringCopyHTKeyDup(void *privdata
, const void *key
)
904 int len
= strlen(key
);
905 char *copy
= Jim_Alloc(len
+1);
906 JIM_NOTUSED(privdata
);
908 memcpy(copy
, key
, len
);
913 static void *JimStringKeyValCopyHTValDup(void *privdata
, const void *val
)
915 int len
= strlen(val
);
916 char *copy
= Jim_Alloc(len
+1);
917 JIM_NOTUSED(privdata
);
919 memcpy(copy
, val
, len
);
924 static int JimStringCopyHTKeyCompare(void *privdata
, const void *key1
,
927 JIM_NOTUSED(privdata
);
929 return strcmp(key1
, key2
) == 0;
932 static void JimStringCopyHTKeyDestructor(void *privdata
, const void *key
)
934 JIM_NOTUSED(privdata
);
936 Jim_Free((void*)key
); /* ATTENTION: const cast */
939 static void JimStringKeyValCopyHTValDestructor(void *privdata
, void *val
)
941 JIM_NOTUSED(privdata
);
943 Jim_Free((void*)val
); /* ATTENTION: const cast */
946 static Jim_HashTableType JimStringCopyHashTableType
= {
947 JimStringCopyHTHashFunction
, /* hash function */
948 JimStringCopyHTKeyDup
, /* key dup */
950 JimStringCopyHTKeyCompare
, /* key compare */
951 JimStringCopyHTKeyDestructor
, /* key destructor */
952 NULL
/* val destructor */
955 /* This is like StringCopy but does not auto-duplicate the key.
956 * It's used for intepreter's shared strings. */
957 static Jim_HashTableType JimSharedStringsHashTableType
= {
958 JimStringCopyHTHashFunction
, /* hash function */
961 JimStringCopyHTKeyCompare
, /* key compare */
962 JimStringCopyHTKeyDestructor
, /* key destructor */
963 NULL
/* val destructor */
966 /* This is like StringCopy but also automatically handle dynamic
967 * allocated C strings as values. */
968 static Jim_HashTableType JimStringKeyValCopyHashTableType
= {
969 JimStringCopyHTHashFunction
, /* hash function */
970 JimStringCopyHTKeyDup
, /* key dup */
971 JimStringKeyValCopyHTValDup
, /* val dup */
972 JimStringCopyHTKeyCompare
, /* key compare */
973 JimStringCopyHTKeyDestructor
, /* key destructor */
974 JimStringKeyValCopyHTValDestructor
, /* val destructor */
977 typedef struct AssocDataValue
{
978 Jim_InterpDeleteProc
*delProc
;
982 static void JimAssocDataHashTableValueDestructor(void *privdata
, void *data
)
984 AssocDataValue
*assocPtr
= (AssocDataValue
*)data
;
985 if (assocPtr
->delProc
!= NULL
)
986 assocPtr
->delProc((Jim_Interp
*)privdata
, assocPtr
->data
);
990 static Jim_HashTableType JimAssocDataHashTableType
= {
991 JimStringCopyHTHashFunction
, /* hash function */
992 JimStringCopyHTKeyDup
, /* key dup */
994 JimStringCopyHTKeyCompare
, /* key compare */
995 JimStringCopyHTKeyDestructor
, /* key destructor */
996 JimAssocDataHashTableValueDestructor
/* val destructor */
999 /* -----------------------------------------------------------------------------
1000 * Stack - This is a simple generic stack implementation. It is used for
1001 * example in the 'expr' expression compiler.
1002 * ---------------------------------------------------------------------------*/
1003 void Jim_InitStack(Jim_Stack
*stack
)
1007 stack
->vector
= NULL
;
1010 void Jim_FreeStack(Jim_Stack
*stack
)
1012 Jim_Free(stack
->vector
);
1015 int Jim_StackLen(Jim_Stack
*stack
)
1020 void Jim_StackPush(Jim_Stack
*stack
, void *element
) {
1021 int neededLen
= stack
->len
+1;
1022 if (neededLen
> stack
->maxlen
) {
1023 stack
->maxlen
= neededLen
*2;
1024 stack
->vector
= Jim_Realloc(stack
->vector
, sizeof(void*)*stack
->maxlen
);
1026 stack
->vector
[stack
->len
] = element
;
1030 void *Jim_StackPop(Jim_Stack
*stack
)
1032 if (stack
->len
== 0) return NULL
;
1034 return stack
->vector
[stack
->len
];
1037 void *Jim_StackPeek(Jim_Stack
*stack
)
1039 if (stack
->len
== 0) return NULL
;
1040 return stack
->vector
[stack
->len
-1];
1043 void Jim_FreeStackElements(Jim_Stack
*stack
, void (*freeFunc
)(void *ptr
))
1047 for (i
= 0; i
< stack
->len
; i
++)
1048 freeFunc(stack
->vector
[i
]);
1051 /* -----------------------------------------------------------------------------
1053 * ---------------------------------------------------------------------------*/
1056 #define JIM_TT_NONE -1 /* No token returned */
1057 #define JIM_TT_STR 0 /* simple string */
1058 #define JIM_TT_ESC 1 /* string that needs escape chars conversion */
1059 #define JIM_TT_VAR 2 /* var substitution */
1060 #define JIM_TT_DICTSUGAR 3 /* Syntax sugar for [dict get], $foo(bar) */
1061 #define JIM_TT_CMD 4 /* command substitution */
1062 #define JIM_TT_SEP 5 /* word separator */
1063 #define JIM_TT_EOL 6 /* line separator */
1065 /* Additional token types needed for expressions */
1066 #define JIM_TT_SUBEXPR_START 7
1067 #define JIM_TT_SUBEXPR_END 8
1068 #define JIM_TT_EXPR_NUMBER 9
1069 #define JIM_TT_EXPR_OPERATOR 10
1072 #define JIM_PS_DEF 0 /* Default state */
1073 #define JIM_PS_QUOTE 1 /* Inside "" */
1075 /* Parser context structure. The same context is used both to parse
1076 * Tcl scripts and lists. */
1077 struct JimParserCtx
{
1078 const char *prg
; /* Program text */
1079 const char *p
; /* Pointer to the point of the program we are parsing */
1080 int len
; /* Left length of 'prg' */
1081 int linenr
; /* Current line number */
1083 const char *tend
; /* Returned token is at tstart-tend in 'prg'. */
1084 int tline
; /* Line number of the returned token */
1085 int tt
; /* Token type */
1086 int eof
; /* Non zero if EOF condition is true. */
1087 int state
; /* Parser state */
1088 int comment
; /* Non zero if the next chars may be a comment. */
1091 #define JimParserEof(c) ((c)->eof)
1092 #define JimParserTstart(c) ((c)->tstart)
1093 #define JimParserTend(c) ((c)->tend)
1094 #define JimParserTtype(c) ((c)->tt)
1095 #define JimParserTline(c) ((c)->tline)
1097 static int JimParseScript(struct JimParserCtx
*pc
);
1098 static int JimParseSep(struct JimParserCtx
*pc
);
1099 static int JimParseEol(struct JimParserCtx
*pc
);
1100 static int JimParseCmd(struct JimParserCtx
*pc
);
1101 static int JimParseVar(struct JimParserCtx
*pc
);
1102 static int JimParseBrace(struct JimParserCtx
*pc
);
1103 static int JimParseStr(struct JimParserCtx
*pc
);
1104 static int JimParseComment(struct JimParserCtx
*pc
);
1105 static char *JimParserGetToken(struct JimParserCtx
*pc
,
1106 int *lenPtr
, int *typePtr
, int *linePtr
);
1108 /* Initialize a parser context.
1109 * 'prg' is a pointer to the program text, linenr is the line
1110 * number of the first line contained in the program. */
1111 void JimParserInit(struct JimParserCtx
*pc
, const char *prg
,
1112 int len
, int linenr
)
1120 pc
->tt
= JIM_TT_NONE
;
1122 pc
->state
= JIM_PS_DEF
;
1123 pc
->linenr
= linenr
;
1127 int JimParseScript(struct JimParserCtx
*pc
)
1129 while(1) { /* the while is used to reiterate with continue if needed */
1133 pc
->tline
= pc
->linenr
;
1134 pc
->tt
= JIM_TT_EOL
;
1140 if (*(pc
->p
+1) == '\n')
1141 return JimParseSep(pc
);
1144 return JimParseStr(pc
);
1150 if (pc
->state
== JIM_PS_DEF
)
1151 return JimParseSep(pc
);
1154 return JimParseStr(pc
);
1160 if (pc
->state
== JIM_PS_DEF
)
1161 return JimParseEol(pc
);
1163 return JimParseStr(pc
);
1167 return JimParseCmd(pc
);
1171 if (JimParseVar(pc
) == JIM_ERR
) {
1172 pc
->tstart
= pc
->tend
= pc
->p
++; pc
->len
--;
1173 pc
->tline
= pc
->linenr
;
1174 pc
->tt
= JIM_TT_STR
;
1181 JimParseComment(pc
);
1184 return JimParseStr(pc
);
1188 return JimParseStr(pc
);
1195 int JimParseSep(struct JimParserCtx
*pc
)
1198 pc
->tline
= pc
->linenr
;
1199 while (*pc
->p
== ' ' || *pc
->p
== '\t' || *pc
->p
== '\r' ||
1200 (*pc
->p
== '\\' && *(pc
->p
+1) == '\n')) {
1201 if (*pc
->p
== '\\') {
1208 pc
->tt
= JIM_TT_SEP
;
1212 int JimParseEol(struct JimParserCtx
*pc
)
1215 pc
->tline
= pc
->linenr
;
1216 while (*pc
->p
== ' ' || *pc
->p
== '\n' ||
1217 *pc
->p
== '\t' || *pc
->p
== '\r' || *pc
->p
== ';') {
1223 pc
->tt
= JIM_TT_EOL
;
1227 /* Todo. Don't stop if ']' appears inside {} or quoted.
1228 * Also should handle the case of puts [string length "]"] */
1229 int JimParseCmd(struct JimParserCtx
*pc
)
1234 pc
->tstart
= ++pc
->p
; pc
->len
--;
1235 pc
->tline
= pc
->linenr
;
1239 } else if (*pc
->p
== '[' && blevel
== 0) {
1241 } else if (*pc
->p
== ']' && blevel
== 0) {
1244 } else if (*pc
->p
== '\\') {
1246 } else if (*pc
->p
== '{') {
1248 } else if (*pc
->p
== '}') {
1251 } else if (*pc
->p
== '\n')
1256 pc
->tt
= JIM_TT_CMD
;
1257 if (*pc
->p
== ']') {
1263 int JimParseVar(struct JimParserCtx
*pc
)
1265 int brace
= 0, stop
= 0, ttype
= JIM_TT_VAR
;
1267 pc
->tstart
= ++pc
->p
; pc
->len
--; /* skip the $ */
1268 pc
->tline
= pc
->linenr
;
1269 if (*pc
->p
== '{') {
1270 pc
->tstart
= ++pc
->p
; pc
->len
--;
1275 if (*pc
->p
== '}' || pc
->len
== 0) {
1280 else if (*pc
->p
== '\n')
1290 if (!((*pc
->p
>= 'a' && *pc
->p
<= 'z') ||
1291 (*pc
->p
>= 'A' && *pc
->p
<= 'Z') ||
1292 (*pc
->p
>= '0' && *pc
->p
<= '9') || *pc
->p
== '_'))
1298 /* Parse [dict get] syntax sugar. */
1299 if (*pc
->p
== '(') {
1300 while (*pc
->p
!= ')' && pc
->len
) {
1302 if (*pc
->p
== '\\' && pc
->len
>= 2) {
1303 pc
->p
+= 2; pc
->len
-= 2;
1306 if (*pc
->p
!= '\0') {
1309 ttype
= JIM_TT_DICTSUGAR
;
1313 /* Check if we parsed just the '$' character.
1314 * That's not a variable so an error is returned
1315 * to tell the state machine to consider this '$' just
1317 if (pc
->tstart
== pc
->p
) {
1325 int JimParseBrace(struct JimParserCtx
*pc
)
1329 pc
->tstart
= ++pc
->p
; pc
->len
--;
1330 pc
->tline
= pc
->linenr
;
1332 if (*pc
->p
== '\\' && pc
->len
>= 2) {
1336 } else if (*pc
->p
== '{') {
1338 } else if (pc
->len
== 0 || *pc
->p
== '}') {
1340 if (pc
->len
== 0 || level
== 0) {
1345 pc
->tt
= JIM_TT_STR
;
1348 } else if (*pc
->p
== '\n') {
1353 return JIM_OK
; /* unreached */
1356 int JimParseStr(struct JimParserCtx
*pc
)
1358 int newword
= (pc
->tt
== JIM_TT_SEP
|| pc
->tt
== JIM_TT_EOL
||
1359 pc
->tt
== JIM_TT_NONE
|| pc
->tt
== JIM_TT_STR
);
1360 if (newword
&& *pc
->p
== '{') {
1361 return JimParseBrace(pc
);
1362 } else if (newword
&& *pc
->p
== '"') {
1363 pc
->state
= JIM_PS_QUOTE
;
1367 pc
->tline
= pc
->linenr
;
1371 pc
->tt
= JIM_TT_ESC
;
1376 if (pc
->state
== JIM_PS_DEF
&&
1377 *(pc
->p
+1) == '\n') {
1379 pc
->tt
= JIM_TT_ESC
;
1389 pc
->tt
= JIM_TT_ESC
;
1396 if (pc
->state
== JIM_PS_DEF
) {
1398 pc
->tt
= JIM_TT_ESC
;
1400 } else if (*pc
->p
== '\n') {
1405 if (pc
->state
== JIM_PS_QUOTE
) {
1407 pc
->tt
= JIM_TT_ESC
;
1409 pc
->state
= JIM_PS_DEF
;
1416 return JIM_OK
; /* unreached */
1419 int JimParseComment(struct JimParserCtx
*pc
)
1422 if (*pc
->p
== '\n') {
1424 if (*(pc
->p
-1) != '\\') {
1434 /* xdigitval and odigitval are helper functions for JimParserGetToken() */
1435 static int xdigitval(int c
)
1437 if (c
>= '0' && c
<= '9') return c
-'0';
1438 if (c
>= 'a' && c
<= 'f') return c
-'a'+10;
1439 if (c
>= 'A' && c
<= 'F') return c
-'A'+10;
1443 static int odigitval(int c
)
1445 if (c
>= '0' && c
<= '7') return c
-'0';
1449 /* Perform Tcl escape substitution of 's', storing the result
1450 * string into 'dest'. The escaped string is guaranteed to
1451 * be the same length or shorted than the source string.
1452 * Slen is the length of the string at 's', if it's -1 the string
1453 * length will be calculated by the function.
1455 * The function returns the length of the resulting string. */
1456 static int JimEscape(char *dest
, const char *s
, int slen
)
1464 for (i
= 0; i
< slen
; i
++) {
1468 case 'a': *p
++ = 0x7; i
++; break;
1469 case 'b': *p
++ = 0x8; i
++; break;
1470 case 'f': *p
++ = 0xc; i
++; break;
1471 case 'n': *p
++ = 0xa; i
++; break;
1472 case 'r': *p
++ = 0xd; i
++; break;
1473 case 't': *p
++ = 0x9; i
++; break;
1474 case 'v': *p
++ = 0xb; i
++; break;
1475 case '\0': *p
++ = '\\'; i
++; break;
1476 case '\n': *p
++ = ' '; i
++; break;
1478 if (s
[i
+1] == 'x') {
1480 int c
= xdigitval(s
[i
+2]);
1487 c
= xdigitval(s
[i
+3]);
1497 } else if (s
[i
+1] >= '0' && s
[i
+1] <= '7')
1500 int c
= odigitval(s
[i
+1]);
1502 c
= odigitval(s
[i
+2]);
1509 c
= odigitval(s
[i
+3]);
1535 /* Returns a dynamically allocated copy of the current token in the
1536 * parser context. The function perform conversion of escapes if
1537 * the token is of type JIM_TT_ESC.
1539 * Note that after the conversion, tokens that are grouped with
1540 * braces in the source code, are always recognizable from the
1541 * identical string obtained in a different way from the type.
1543 * For exmple the string:
1547 * will return as first token "expand", of type JIM_TT_STR
1553 * will return as first token "expand", of type JIM_TT_ESC
1555 char *JimParserGetToken(struct JimParserCtx
*pc
,
1556 int *lenPtr
, int *typePtr
, int *linePtr
)
1558 const char *start
, *end
;
1562 start
= JimParserTstart(pc
);
1563 end
= JimParserTend(pc
);
1565 if (lenPtr
) *lenPtr
= 0;
1566 if (typePtr
) *typePtr
= JimParserTtype(pc
);
1567 if (linePtr
) *linePtr
= JimParserTline(pc
);
1568 token
= Jim_Alloc(1);
1572 len
= (end
-start
)+1;
1573 token
= Jim_Alloc(len
+1);
1574 if (JimParserTtype(pc
) != JIM_TT_ESC
) {
1575 /* No escape conversion needed? Just copy it. */
1576 memcpy(token
, start
, len
);
1579 /* Else convert the escape chars. */
1580 len
= JimEscape(token
, start
, len
);
1582 if (lenPtr
) *lenPtr
= len
;
1583 if (typePtr
) *typePtr
= JimParserTtype(pc
);
1584 if (linePtr
) *linePtr
= JimParserTline(pc
);
1588 /* The following functin is not really part of the parsing engine of Jim,
1589 * but it somewhat related. Given an string and its length, it tries
1590 * to guess if the script is complete or there are instead " " or { }
1591 * open and not completed. This is useful for interactive shells
1592 * implementation and for [info complete].
1594 * If 'stateCharPtr' != NULL, the function stores ' ' on complete script,
1595 * '{' on scripts incomplete missing one or more '}' to be balanced.
1596 * '"' on scripts incomplete missing a '"' char.
1598 * If the script is complete, 1 is returned, otherwise 0. */
1599 int Jim_ScriptIsComplete(const char *s
, int len
, char *stateCharPtr
)
1613 } else if (state
== '"') {
1620 } else if (state
== ' ') {
1637 *stateCharPtr
= state
;
1638 return state
== ' ';
1641 /* -----------------------------------------------------------------------------
1643 * ---------------------------------------------------------------------------*/
1644 static int JimParseListSep(struct JimParserCtx
*pc
);
1645 static int JimParseListStr(struct JimParserCtx
*pc
);
1647 int JimParseList(struct JimParserCtx
*pc
)
1650 pc
->tstart
= pc
->tend
= pc
->p
;
1651 pc
->tline
= pc
->linenr
;
1652 pc
->tt
= JIM_TT_EOL
;
1661 if (pc
->state
== JIM_PS_DEF
)
1662 return JimParseListSep(pc
);
1664 return JimParseListStr(pc
);
1667 return JimParseListStr(pc
);
1673 int JimParseListSep(struct JimParserCtx
*pc
)
1676 pc
->tline
= pc
->linenr
;
1677 while (*pc
->p
== ' ' || *pc
->p
== '\t' || *pc
->p
== '\r' || *pc
->p
== '\n')
1682 pc
->tt
= JIM_TT_SEP
;
1686 int JimParseListStr(struct JimParserCtx
*pc
)
1688 int newword
= (pc
->tt
== JIM_TT_SEP
|| pc
->tt
== JIM_TT_EOL
||
1689 pc
->tt
== JIM_TT_NONE
);
1690 if (newword
&& *pc
->p
== '{') {
1691 return JimParseBrace(pc
);
1692 } else if (newword
&& *pc
->p
== '"') {
1693 pc
->state
= JIM_PS_QUOTE
;
1697 pc
->tline
= pc
->linenr
;
1701 pc
->tt
= JIM_TT_ESC
;
1712 if (pc
->state
== JIM_PS_DEF
) {
1714 pc
->tt
= JIM_TT_ESC
;
1716 } else if (*pc
->p
== '\n') {
1721 if (pc
->state
== JIM_PS_QUOTE
) {
1723 pc
->tt
= JIM_TT_ESC
;
1725 pc
->state
= JIM_PS_DEF
;
1732 return JIM_OK
; /* unreached */
1735 /* -----------------------------------------------------------------------------
1736 * Jim_Obj related functions
1737 * ---------------------------------------------------------------------------*/
1739 /* Return a new initialized object. */
1740 Jim_Obj
*Jim_NewObj(Jim_Interp
*interp
)
1744 /* -- Check if there are objects in the free list -- */
1745 if (interp
->freeList
!= NULL
) {
1746 /* -- Unlink the object from the free list -- */
1747 objPtr
= interp
->freeList
;
1748 interp
->freeList
= objPtr
->nextObjPtr
;
1750 /* -- No ready to use objects: allocate a new one -- */
1751 objPtr
= Jim_Alloc(sizeof(*objPtr
));
1754 /* Object is returned with refCount of 0. Every
1755 * kind of GC implemented should take care to don't try
1756 * to scan objects with refCount == 0. */
1757 objPtr
->refCount
= 0;
1758 /* All the other fields are left not initialized to save time.
1759 * The caller will probably want set they to the right
1762 /* -- Put the object into the live list -- */
1763 objPtr
->prevObjPtr
= NULL
;
1764 objPtr
->nextObjPtr
= interp
->liveList
;
1765 if (interp
->liveList
)
1766 interp
->liveList
->prevObjPtr
= objPtr
;
1767 interp
->liveList
= objPtr
;
1772 /* Free an object. Actually objects are never freed, but
1773 * just moved to the free objects list, where they will be
1774 * reused by Jim_NewObj(). */
1775 void Jim_FreeObj(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
1777 /* Check if the object was already freed, panic. */
1778 if (objPtr
->refCount
!= 0) {
1779 Jim_Panic(interp
,"!!!Object %p freed with bad refcount %d", objPtr
,
1782 /* Free the internal representation */
1783 Jim_FreeIntRep(interp
, objPtr
);
1784 /* Free the string representation */
1785 if (objPtr
->bytes
!= NULL
) {
1786 if (objPtr
->bytes
!= JimEmptyStringRep
)
1787 Jim_Free(objPtr
->bytes
);
1789 /* Unlink the object from the live objects list */
1790 if (objPtr
->prevObjPtr
)
1791 objPtr
->prevObjPtr
->nextObjPtr
= objPtr
->nextObjPtr
;
1792 if (objPtr
->nextObjPtr
)
1793 objPtr
->nextObjPtr
->prevObjPtr
= objPtr
->prevObjPtr
;
1794 if (interp
->liveList
== objPtr
)
1795 interp
->liveList
= objPtr
->nextObjPtr
;
1796 /* Link the object into the free objects list */
1797 objPtr
->prevObjPtr
= NULL
;
1798 objPtr
->nextObjPtr
= interp
->freeList
;
1799 if (interp
->freeList
)
1800 interp
->freeList
->prevObjPtr
= objPtr
;
1801 interp
->freeList
= objPtr
;
1802 objPtr
->refCount
= -1;
1805 /* Invalidate the string representation of an object. */
1806 void Jim_InvalidateStringRep(Jim_Obj
*objPtr
)
1808 if (objPtr
->bytes
!= NULL
) {
1809 if (objPtr
->bytes
!= JimEmptyStringRep
)
1810 Jim_Free(objPtr
->bytes
);
1812 objPtr
->bytes
= NULL
;
1815 #define Jim_SetStringRep(o, b, l) \
1816 do { (o)->bytes = b; (o)->length = l; } while (0)
1818 /* Set the initial string representation for an object.
1819 * Does not try to free an old one. */
1820 void Jim_InitStringRep(Jim_Obj
*objPtr
, const char *bytes
, int length
)
1823 objPtr
->bytes
= JimEmptyStringRep
;
1826 objPtr
->bytes
= Jim_Alloc(length
+1);
1827 objPtr
->length
= length
;
1828 memcpy(objPtr
->bytes
, bytes
, length
);
1829 objPtr
->bytes
[length
] = '\0';
1833 /* Duplicate an object. The returned object has refcount = 0. */
1834 Jim_Obj
*Jim_DuplicateObj(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
1838 dupPtr
= Jim_NewObj(interp
);
1839 if (objPtr
->bytes
== NULL
) {
1840 /* Object does not have a valid string representation. */
1841 dupPtr
->bytes
= NULL
;
1843 Jim_InitStringRep(dupPtr
, objPtr
->bytes
, objPtr
->length
);
1845 if (objPtr
->typePtr
!= NULL
) {
1846 if (objPtr
->typePtr
->dupIntRepProc
== NULL
) {
1847 dupPtr
->internalRep
= objPtr
->internalRep
;
1849 objPtr
->typePtr
->dupIntRepProc(interp
, objPtr
, dupPtr
);
1851 dupPtr
->typePtr
= objPtr
->typePtr
;
1853 dupPtr
->typePtr
= NULL
;
1858 /* Return the string representation for objPtr. If the object
1859 * string representation is invalid, calls the method to create
1860 * a new one starting from the internal representation of the object. */
1861 const char *Jim_GetString(Jim_Obj
*objPtr
, int *lenPtr
)
1863 if (objPtr
->bytes
== NULL
) {
1864 /* Invalid string repr. Generate it. */
1865 if (objPtr
->typePtr
->updateStringProc
== NULL
) {
1866 Jim_Panic(NULL
,"UpdataStringProc called against '%s' type.",
1867 objPtr
->typePtr
->name
);
1869 objPtr
->typePtr
->updateStringProc(objPtr
);
1872 *lenPtr
= objPtr
->length
;
1873 return objPtr
->bytes
;
1876 /* Just returns the length of the object's string rep */
1877 int Jim_Length(Jim_Obj
*objPtr
)
1881 Jim_GetString(objPtr
, &len
);
1885 /* -----------------------------------------------------------------------------
1887 * ---------------------------------------------------------------------------*/
1888 static void DupStringInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
);
1889 static int SetStringFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
);
1891 static Jim_ObjType stringObjType
= {
1894 DupStringInternalRep
,
1896 JIM_TYPE_REFERENCES
,
1899 void DupStringInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
)
1901 JIM_NOTUSED(interp
);
1903 /* This is a bit subtle: the only caller of this function
1904 * should be Jim_DuplicateObj(), that will copy the
1905 * string representaion. After the copy, the duplicated
1906 * object will not have more room in teh buffer than
1907 * srcPtr->length bytes. So we just set it to length. */
1908 dupPtr
->internalRep
.strValue
.maxLength
= srcPtr
->length
;
1911 int SetStringFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
1913 /* Get a fresh string representation. */
1914 (void) Jim_GetString(objPtr
, NULL
);
1915 /* Free any other internal representation. */
1916 Jim_FreeIntRep(interp
, objPtr
);
1917 /* Set it as string, i.e. just set the maxLength field. */
1918 objPtr
->typePtr
= &stringObjType
;
1919 objPtr
->internalRep
.strValue
.maxLength
= objPtr
->length
;
1923 Jim_Obj
*Jim_NewStringObj(Jim_Interp
*interp
, const char *s
, int len
)
1925 Jim_Obj
*objPtr
= Jim_NewObj(interp
);
1929 /* Alloc/Set the string rep. */
1931 objPtr
->bytes
= JimEmptyStringRep
;
1934 objPtr
->bytes
= Jim_Alloc(len
+1);
1935 objPtr
->length
= len
;
1936 memcpy(objPtr
->bytes
, s
, len
);
1937 objPtr
->bytes
[len
] = '\0';
1940 /* No typePtr field for the vanilla string object. */
1941 objPtr
->typePtr
= NULL
;
1945 /* This version does not try to duplicate the 's' pointer, but
1946 * use it directly. */
1947 Jim_Obj
*Jim_NewStringObjNoAlloc(Jim_Interp
*interp
, char *s
, int len
)
1949 Jim_Obj
*objPtr
= Jim_NewObj(interp
);
1953 Jim_SetStringRep(objPtr
, s
, len
);
1954 objPtr
->typePtr
= NULL
;
1958 /* Low-level string append. Use it only against objects
1959 * of type "string". */
1960 void StringAppendString(Jim_Obj
*objPtr
, const char *str
, int len
)
1966 needlen
= objPtr
->length
+ len
;
1967 if (objPtr
->internalRep
.strValue
.maxLength
< needlen
||
1968 objPtr
->internalRep
.strValue
.maxLength
== 0) {
1969 if (objPtr
->bytes
== JimEmptyStringRep
) {
1970 objPtr
->bytes
= Jim_Alloc((needlen
*2)+1);
1972 objPtr
->bytes
= Jim_Realloc(objPtr
->bytes
, (needlen
*2)+1);
1974 objPtr
->internalRep
.strValue
.maxLength
= needlen
*2;
1976 memcpy(objPtr
->bytes
+ objPtr
->length
, str
, len
);
1977 objPtr
->bytes
[objPtr
->length
+len
] = '\0';
1978 objPtr
->length
+= len
;
1981 /* Low-level wrapper to append an object. */
1982 void StringAppendObj(Jim_Obj
*objPtr
, Jim_Obj
*appendObjPtr
)
1987 str
= Jim_GetString(appendObjPtr
, &len
);
1988 StringAppendString(objPtr
, str
, len
);
1991 /* Higher level API to append strings to objects. */
1992 void Jim_AppendString(Jim_Interp
*interp
, Jim_Obj
*objPtr
, const char *str
,
1995 if (Jim_IsShared(objPtr
))
1996 Jim_Panic(interp
,"Jim_AppendString called with shared object");
1997 if (objPtr
->typePtr
!= &stringObjType
)
1998 SetStringFromAny(interp
, objPtr
);
1999 StringAppendString(objPtr
, str
, len
);
2002 void Jim_AppendObj(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
2003 Jim_Obj
*appendObjPtr
)
2008 str
= Jim_GetString(appendObjPtr
, &len
);
2009 Jim_AppendString(interp
, objPtr
, str
, len
);
2012 void Jim_AppendStrings(Jim_Interp
*interp
, Jim_Obj
*objPtr
, ...)
2016 if (objPtr
->typePtr
!= &stringObjType
)
2017 SetStringFromAny(interp
, objPtr
);
2018 va_start(ap
, objPtr
);
2020 char *s
= va_arg(ap
, char*);
2022 if (s
== NULL
) break;
2023 Jim_AppendString(interp
, objPtr
, s
, -1);
2028 int Jim_StringEqObj(Jim_Obj
*aObjPtr
, Jim_Obj
*bObjPtr
, int nocase
)
2030 const char *aStr
, *bStr
;
2033 if (aObjPtr
== bObjPtr
) return 1;
2034 aStr
= Jim_GetString(aObjPtr
, &aLen
);
2035 bStr
= Jim_GetString(bObjPtr
, &bLen
);
2036 if (aLen
!= bLen
) return 0;
2038 return memcmp(aStr
, bStr
, aLen
) == 0;
2039 for (i
= 0; i
< aLen
; i
++) {
2040 if (tolower((int)aStr
[i
]) != tolower((int)bStr
[i
]))
2046 int Jim_StringMatchObj(Jim_Obj
*patternObjPtr
, Jim_Obj
*objPtr
,
2049 const char *pattern
, *string
;
2050 int patternLen
, stringLen
;
2052 pattern
= Jim_GetString(patternObjPtr
, &patternLen
);
2053 string
= Jim_GetString(objPtr
, &stringLen
);
2054 return JimStringMatch(pattern
, patternLen
, string
, stringLen
, nocase
);
2057 int Jim_StringCompareObj(Jim_Obj
*firstObjPtr
,
2058 Jim_Obj
*secondObjPtr
, int nocase
)
2060 const char *s1
, *s2
;
2063 s1
= Jim_GetString(firstObjPtr
, &l1
);
2064 s2
= Jim_GetString(secondObjPtr
, &l2
);
2065 return JimStringCompare(s1
, l1
, s2
, l2
, nocase
);
2068 /* Convert a range, as returned by Jim_GetRange(), into
2069 * an absolute index into an object of the specified length.
2070 * This function may return negative values, or values
2071 * bigger or equal to the length of the list if the index
2072 * is out of range. */
2073 static int JimRelToAbsIndex(int len
, int index
)
2080 /* Convert a pair of index as normalize by JimRelToAbsIndex(),
2081 * into a range stored in *firstPtr, *lastPtr, *rangeLenPtr, suitable
2082 * for implementation of commands like [string range] and [lrange].
2084 * The resulting range is guaranteed to address valid elements of
2086 static void JimRelToAbsRange(int len
, int first
, int last
,
2087 int *firstPtr
, int *lastPtr
, int *rangeLenPtr
)
2094 rangeLen
= last
-first
+1;
2101 rangeLen
-= (last
-(len
-1));
2106 if (rangeLen
< 0) rangeLen
= 0;
2110 *rangeLenPtr
= rangeLen
;
2113 Jim_Obj
*Jim_StringRangeObj(Jim_Interp
*interp
,
2114 Jim_Obj
*strObjPtr
, Jim_Obj
*firstObjPtr
, Jim_Obj
*lastObjPtr
)
2120 if (Jim_GetIndex(interp
, firstObjPtr
, &first
) != JIM_OK
||
2121 Jim_GetIndex(interp
, lastObjPtr
, &last
) != JIM_OK
)
2123 str
= Jim_GetString(strObjPtr
, &len
);
2124 first
= JimRelToAbsIndex(len
, first
);
2125 last
= JimRelToAbsIndex(len
, last
);
2126 JimRelToAbsRange(len
, first
, last
, &first
, &last
, &rangeLen
);
2127 return Jim_NewStringObj(interp
, str
+first
, rangeLen
);
2130 static Jim_Obj
*JimStringToLower(Jim_Interp
*interp
, Jim_Obj
*strObjPtr
)
2132 char *buf
= Jim_Alloc(strObjPtr
->length
+1);
2135 memcpy(buf
, strObjPtr
->bytes
, strObjPtr
->length
+1);
2136 for (i
= 0; i
< strObjPtr
->length
; i
++)
2137 buf
[i
] = tolower(buf
[i
]);
2138 return Jim_NewStringObjNoAlloc(interp
, buf
, strObjPtr
->length
);
2141 static Jim_Obj
*JimStringToUpper(Jim_Interp
*interp
, Jim_Obj
*strObjPtr
)
2143 char *buf
= Jim_Alloc(strObjPtr
->length
+1);
2146 memcpy(buf
, strObjPtr
->bytes
, strObjPtr
->length
+1);
2147 for (i
= 0; i
< strObjPtr
->length
; i
++)
2148 buf
[i
] = toupper(buf
[i
]);
2149 return Jim_NewStringObjNoAlloc(interp
, buf
, strObjPtr
->length
);
2152 /* This is the core of the [format] command.
2153 * TODO: Lots of things work - via a hack
2154 * However, no format item can be >= JIM_MAX_FMT
2156 Jim_Obj
*Jim_FormatString(Jim_Interp
*interp
, Jim_Obj
*fmtObjPtr
,
2157 int objc
, Jim_Obj
*const *objv
)
2159 const char *fmt
, *_fmt
;
2164 fmt
= Jim_GetString(fmtObjPtr
, &fmtLen
);
2166 resObjPtr
= Jim_NewStringObj(interp
, "", 0);
2168 const char *p
= fmt
;
2172 /* we cheat and use Sprintf()! */
2173 #define JIM_MAX_FMT 2048
2174 char sprintf_buf
[JIM_MAX_FMT
];
2188 while (*fmt
!= '%' && fmtLen
) {
2191 Jim_AppendString(interp
, resObjPtr
, p
, fmt
-p
);
2194 fmt
++; fmtLen
--; /* skip '%' */
2203 prec
= -1; /* not found yet */
2210 case 'b': /* binary - not all printfs() do this */
2211 case 's': /* string */
2212 case 'i': /* integer */
2213 case 'd': /* decimal */
2215 case 'X': /* CAP hex */
2216 case 'c': /* char */
2217 case 'o': /* octal */
2218 case 'u': /* unsigned */
2219 case 'f': /* float */
2223 case '0': /* zero pad */
2233 case ' ': /* sign space */
2263 while( isdigit(*fmt
) && (fmtLen
> 0) ){
2264 accum
= (accum
* 10) + (*fmt
- '0');
2275 /* suck up the next item as an integer */
2279 goto not_enough_args
;
2281 if( Jim_GetWide(interp
,objv
[0],&wideValue
)== JIM_ERR
){
2282 Jim_FreeNewObj(interp
, resObjPtr
);
2289 /* man 3 printf says */
2290 /* if prec is negative, it is zero */
2309 Jim_FreeNewObj(interp
, resObjPtr
);
2310 Jim_SetResultString(interp
,
2311 "not enough arguments for all format specifiers", -1);
2319 * Create the formatter
2320 * cause we cheat and use sprintf()
2330 /* PLUS overrides */
2340 sprintf( cp
, "%d", width
);
2344 /* did we find a period? */
2348 /* did something occur after the period? */
2350 sprintf( cp
, "%d", prec
);
2356 /* here we do the work */
2357 /* actually - we make sprintf() do it for us */
2362 /* BUG: we do not handled embeded NULLs */
2363 snprintf( sprintf_buf
, JIM_MAX_FMT
, fmt_str
, Jim_GetString( objv
[0], NULL
));
2368 if (Jim_GetWide(interp
, objv
[0], &wideValue
) == JIM_ERR
) {
2369 Jim_FreeNewObj(interp
, resObjPtr
);
2372 c
= (char) wideValue
;
2373 snprintf( sprintf_buf
, JIM_MAX_FMT
, fmt_str
, c
);
2383 if( Jim_GetDouble( interp
, objv
[0], &doubleValue
) == JIM_ERR
){
2384 Jim_FreeNewObj( interp
, resObjPtr
);
2387 snprintf( sprintf_buf
, JIM_MAX_FMT
, fmt_str
, doubleValue
);
2395 /* jim widevaluse are 64bit */
2396 if( sizeof(jim_wide
) == sizeof(long long) ){
2404 if (Jim_GetWide(interp
, objv
[0], &wideValue
) == JIM_ERR
) {
2405 Jim_FreeNewObj(interp
, resObjPtr
);
2408 snprintf(sprintf_buf
, JIM_MAX_FMT
, fmt_str
, wideValue
);
2411 sprintf_buf
[0] = '%';
2413 objv
--; /* undo the objv++ below */
2416 spec
[0] = *fmt
; spec
[1] = '\0';
2417 Jim_FreeNewObj(interp
, resObjPtr
);
2418 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
2419 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
2420 "bad field specifier \"", spec
, "\"", NULL
);
2423 /* force terminate */
2425 printf("FMT was: %s\n", fmt_str
);
2426 printf("RES was: |%s|\n", sprintf_buf
);
2429 sprintf_buf
[ JIM_MAX_FMT
- 1] = 0;
2430 Jim_AppendString( interp
, resObjPtr
, sprintf_buf
, strlen(sprintf_buf
) );
2439 /* -----------------------------------------------------------------------------
2440 * Compared String Object
2441 * ---------------------------------------------------------------------------*/
2443 /* This is strange object that allows to compare a C literal string
2444 * with a Jim object in very short time if the same comparison is done
2445 * multiple times. For example every time the [if] command is executed,
2446 * Jim has to check if a given argument is "else". This comparions if
2447 * the code has no errors are true most of the times, so we can cache
2448 * inside the object the pointer of the string of the last matching
2449 * comparison. Because most C compilers perform literal sharing,
2450 * so that: char *x = "foo", char *y = "foo", will lead to x == y,
2451 * this works pretty well even if comparisons are at different places
2452 * inside the C code. */
2454 static Jim_ObjType comparedStringObjType
= {
2459 JIM_TYPE_REFERENCES
,
2462 /* The only way this object is exposed to the API is via the following
2463 * function. Returns true if the string and the object string repr.
2464 * are the same, otherwise zero is returned.
2466 * Note: this isn't binary safe, but it hardly needs to be.*/
2467 int Jim_CompareStringImmediate(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
2470 if (objPtr
->typePtr
== &comparedStringObjType
&&
2471 objPtr
->internalRep
.ptr
== str
)
2474 const char *objStr
= Jim_GetString(objPtr
, NULL
);
2475 if (strcmp(str
, objStr
) != 0) return 0;
2476 if (objPtr
->typePtr
!= &comparedStringObjType
) {
2477 Jim_FreeIntRep(interp
, objPtr
);
2478 objPtr
->typePtr
= &comparedStringObjType
;
2480 objPtr
->internalRep
.ptr
= (char*)str
; /*ATTENTION: const cast */
2485 int qsortCompareStringPointers(const void *a
, const void *b
)
2487 char * const *sa
= (char * const *)a
;
2488 char * const *sb
= (char * const *)b
;
2489 return strcmp(*sa
, *sb
);
2492 int Jim_GetEnum(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
2493 const char **tablePtr
, int *indexPtr
, const char *name
, int flags
)
2495 const char **entryPtr
= NULL
;
2496 char **tablePtrSorted
;
2500 for (entryPtr
= tablePtr
, i
= 0; *entryPtr
!= NULL
; entryPtr
++, i
++) {
2501 if (Jim_CompareStringImmediate(interp
, objPtr
, *entryPtr
)) {
2505 count
++; /* If nothing matches, this will reach the len of tablePtr */
2507 if (flags
& JIM_ERRMSG
) {
2510 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
2511 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
2512 "bad ", name
, " \"", Jim_GetString(objPtr
, NULL
), "\": must be one of ",
2514 tablePtrSorted
= Jim_Alloc(sizeof(char*)*count
);
2515 memcpy(tablePtrSorted
, tablePtr
, sizeof(char*)*count
);
2516 qsort(tablePtrSorted
, count
, sizeof(char*), qsortCompareStringPointers
);
2517 for (i
= 0; i
< count
; i
++) {
2518 if (i
+1 == count
&& count
> 1)
2519 Jim_AppendString(interp
, Jim_GetResult(interp
), "or ", -1);
2520 Jim_AppendString(interp
, Jim_GetResult(interp
),
2521 tablePtrSorted
[i
], -1);
2523 Jim_AppendString(interp
, Jim_GetResult(interp
), ", ", -1);
2525 Jim_Free(tablePtrSorted
);
2530 /* -----------------------------------------------------------------------------
2533 * This object is just a string from the language point of view, but
2534 * in the internal representation it contains the filename and line number
2535 * where this given token was read. This information is used by
2536 * Jim_EvalObj() if the object passed happens to be of type "source".
2538 * This allows to propagate the information about line numbers and file
2539 * names and give error messages with absolute line numbers.
2541 * Note that this object uses shared strings for filenames, and the
2542 * pointer to the filename together with the line number is taken into
2543 * the space for the "inline" internal represenation of the Jim_Object,
2544 * so there is almost memory zero-overhead.
2546 * Also the object will be converted to something else if the given
2547 * token it represents in the source file is not something to be
2548 * evaluated (not a script), and will be specialized in some other way,
2549 * so the time overhead is alzo null.
2550 * ---------------------------------------------------------------------------*/
2552 static void FreeSourceInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
2553 static void DupSourceInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
);
2555 static Jim_ObjType sourceObjType
= {
2557 FreeSourceInternalRep
,
2558 DupSourceInternalRep
,
2560 JIM_TYPE_REFERENCES
,
2563 void FreeSourceInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
2565 Jim_ReleaseSharedString(interp
,
2566 objPtr
->internalRep
.sourceValue
.fileName
);
2569 void DupSourceInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
)
2571 dupPtr
->internalRep
.sourceValue
.fileName
=
2572 Jim_GetSharedString(interp
,
2573 srcPtr
->internalRep
.sourceValue
.fileName
);
2574 dupPtr
->internalRep
.sourceValue
.lineNumber
=
2575 dupPtr
->internalRep
.sourceValue
.lineNumber
;
2576 dupPtr
->typePtr
= &sourceObjType
;
2579 static void JimSetSourceInfo(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
2580 const char *fileName
, int lineNumber
)
2582 if (Jim_IsShared(objPtr
))
2583 Jim_Panic(interp
,"JimSetSourceInfo called with shared object");
2584 if (objPtr
->typePtr
!= NULL
)
2585 Jim_Panic(interp
,"JimSetSourceInfo called with typePtr != NULL");
2586 objPtr
->internalRep
.sourceValue
.fileName
=
2587 Jim_GetSharedString(interp
, fileName
);
2588 objPtr
->internalRep
.sourceValue
.lineNumber
= lineNumber
;
2589 objPtr
->typePtr
= &sourceObjType
;
2592 /* -----------------------------------------------------------------------------
2594 * ---------------------------------------------------------------------------*/
2596 #define JIM_CMDSTRUCT_EXPAND -1
2598 static void FreeScriptInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
2599 static void DupScriptInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
);
2600 static int SetScriptFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
);
2602 static Jim_ObjType scriptObjType
= {
2604 FreeScriptInternalRep
,
2605 DupScriptInternalRep
,
2607 JIM_TYPE_REFERENCES
,
2610 /* The ScriptToken structure represents every token into a scriptObj.
2611 * Every token contains an associated Jim_Obj that can be specialized
2612 * by commands operating on it. */
2613 typedef struct ScriptToken
{
2619 /* This is the script object internal representation. An array of
2620 * ScriptToken structures, with an associated command structure array.
2621 * The command structure is a pre-computed representation of the
2622 * command length and arguments structure as a simple liner array
2625 * For example the script:
2628 * set $i $x$y [foo]BAR
2630 * will produce a ScriptObj with the following Tokens:
2647 * This is a description of the tokens, separators, and of lines.
2648 * The command structure instead represents the number of arguments
2649 * of every command, followed by the tokens of which every argument
2650 * is composed. So for the example script, the cmdstruct array will
2655 * Because "puts hello" has two args (2), composed of single tokens (1 1)
2656 * While "set $i $x$y [foo]BAR" has four (4) args, the first two
2657 * composed of single tokens (1 1) and the last two of double tokens
2660 * The precomputation of the command structure makes Jim_Eval() faster,
2661 * and simpler because there aren't dynamic lengths / allocations.
2663 * -- {expand} handling --
2665 * Expand is handled in a special way. When a command
2666 * contains at least an argument with the {expand} prefix,
2667 * the command structure presents a -1 before the integer
2668 * describing the number of arguments. This is used in order
2669 * to send the command exection to a different path in case
2670 * of {expand} and guarantee a fast path for the more common
2671 * case. Also, the integers describing the number of tokens
2672 * are expressed with negative sign, to allow for fast check
2673 * of what's an {expand}-prefixed argument and what not.
2675 * For example the command:
2677 * list {expand}{1 2}
2679 * Will produce the following cmdstruct array:
2683 * -- the substFlags field of the structure --
2685 * The scriptObj structure is used to represent both "script" objects
2686 * and "subst" objects. In the second case, the cmdStruct related
2687 * fields are not used at all, but there is an additional field used
2688 * that is 'substFlags': this represents the flags used to turn
2689 * the string into the intenral representation used to perform the
2690 * substitution. If this flags are not what the application requires
2691 * the scriptObj is created again. For example the script:
2693 * subst -nocommands $string
2694 * subst -novariables $string
2696 * Will recreate the internal representation of the $string object
2699 typedef struct ScriptObj
{
2700 int len
; /* Length as number of tokens. */
2701 int commands
; /* number of top-level commands in script. */
2702 ScriptToken
*token
; /* Tokens array. */
2703 int *cmdStruct
; /* commands structure */
2704 int csLen
; /* length of the cmdStruct array. */
2705 int substFlags
; /* flags used for the compilation of "subst" objects */
2706 int inUse
; /* Used to share a ScriptObj. Currently
2707 only used by Jim_EvalObj() as protection against
2708 shimmering of the currently evaluated object. */
2712 void FreeScriptInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
2715 struct ScriptObj
*script
= (void*) objPtr
->internalRep
.ptr
;
2718 if (script
->inUse
!= 0) return;
2719 for (i
= 0; i
< script
->len
; i
++) {
2720 if (script
->token
[i
].objPtr
!= NULL
)
2721 Jim_DecrRefCount(interp
, script
->token
[i
].objPtr
);
2723 Jim_Free(script
->token
);
2724 Jim_Free(script
->cmdStruct
);
2725 Jim_Free(script
->fileName
);
2729 void DupScriptInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
)
2731 JIM_NOTUSED(interp
);
2732 JIM_NOTUSED(srcPtr
);
2734 /* Just returns an simple string. */
2735 dupPtr
->typePtr
= NULL
;
2738 /* Add a new token to the internal repr of a script object */
2739 static void ScriptObjAddToken(Jim_Interp
*interp
, struct ScriptObj
*script
,
2740 char *strtoken
, int len
, int type
, char *filename
, int linenr
)
2743 struct ScriptToken
*token
;
2745 prevtype
= (script
->len
== 0) ? JIM_TT_EOL
: \
2746 script
->token
[script
->len
-1].type
;
2747 /* Skip tokens without meaning, like words separators
2748 * following a word separator or an end of command and
2750 if (prevtype
== JIM_TT_EOL
) {
2751 if (type
== JIM_TT_EOL
|| type
== JIM_TT_SEP
) {
2755 } else if (prevtype
== JIM_TT_SEP
) {
2756 if (type
== JIM_TT_SEP
) {
2759 } else if (type
== JIM_TT_EOL
) {
2760 /* If an EOL is following by a SEP, drop the previous
2763 Jim_DecrRefCount(interp
, script
->token
[script
->len
].objPtr
);
2765 } else if (prevtype
!= JIM_TT_EOL
&& prevtype
!= JIM_TT_SEP
&&
2766 type
== JIM_TT_ESC
&& len
== 0)
2768 /* Don't add empty tokens used in interpolation */
2772 /* Make space for a new istruction */
2774 script
->token
= Jim_Realloc(script
->token
,
2775 sizeof(ScriptToken
)*script
->len
);
2776 /* Initialize the new token */
2777 token
= script
->token
+(script
->len
-1);
2779 /* Every object is intially as a string, but the
2780 * internal type may be specialized during execution of the
2782 token
->objPtr
= Jim_NewStringObjNoAlloc(interp
, strtoken
, len
);
2783 /* To add source info to SEP and EOL tokens is useless because
2784 * they will never by called as arguments of Jim_EvalObj(). */
2785 if (filename
&& type
!= JIM_TT_SEP
&& type
!= JIM_TT_EOL
)
2786 JimSetSourceInfo(interp
, token
->objPtr
, filename
, linenr
);
2787 Jim_IncrRefCount(token
->objPtr
);
2788 token
->linenr
= linenr
;
2791 /* Add an integer into the command structure field of the script object. */
2792 static void ScriptObjAddInt(struct ScriptObj
*script
, int val
)
2795 script
->cmdStruct
= Jim_Realloc(script
->cmdStruct
,
2796 sizeof(int)*script
->csLen
);
2797 script
->cmdStruct
[script
->csLen
-1] = val
;
2800 /* Search a Jim_Obj contained in 'script' with the same stinrg repr.
2801 * of objPtr. Search nested script objects recursively. */
2802 static Jim_Obj
*ScriptSearchLiteral(Jim_Interp
*interp
, ScriptObj
*script
,
2803 ScriptObj
*scriptBarrier
, Jim_Obj
*objPtr
)
2807 for (i
= 0; i
< script
->len
; i
++) {
2808 if (script
->token
[i
].objPtr
!= objPtr
&&
2809 Jim_StringEqObj(script
->token
[i
].objPtr
, objPtr
, 0)) {
2810 return script
->token
[i
].objPtr
;
2812 /* Enter recursively on scripts only if the object
2813 * is not the same as the one we are searching for
2814 * shared occurrences. */
2815 if (script
->token
[i
].objPtr
->typePtr
== &scriptObjType
&&
2816 script
->token
[i
].objPtr
!= objPtr
) {
2817 Jim_Obj
*foundObjPtr
;
2819 ScriptObj
*subScript
=
2820 script
->token
[i
].objPtr
->internalRep
.ptr
;
2821 /* Don't recursively enter the script we are trying
2822 * to make shared to avoid circular references. */
2823 if (subScript
== scriptBarrier
) continue;
2824 if (subScript
!= script
) {
2826 ScriptSearchLiteral(interp
, subScript
,
2827 scriptBarrier
, objPtr
);
2828 if (foundObjPtr
!= NULL
)
2836 /* Share literals of a script recursively sharing sub-scripts literals. */
2837 static void ScriptShareLiterals(Jim_Interp
*interp
, ScriptObj
*script
,
2838 ScriptObj
*topLevelScript
)
2843 /* Try to share with toplevel object. */
2844 if (topLevelScript
!= NULL
) {
2845 for (i
= 0; i
< script
->len
; i
++) {
2846 Jim_Obj
*foundObjPtr
;
2847 char *str
= script
->token
[i
].objPtr
->bytes
;
2849 if (script
->token
[i
].objPtr
->refCount
!= 1) continue;
2850 if (script
->token
[i
].objPtr
->typePtr
== &scriptObjType
) continue;
2851 if (strchr(str
, ' ') || strchr(str
, '\n')) continue;
2852 foundObjPtr
= ScriptSearchLiteral(interp
,
2854 script
, /* barrier */
2855 script
->token
[i
].objPtr
);
2856 if (foundObjPtr
!= NULL
) {
2857 Jim_IncrRefCount(foundObjPtr
);
2858 Jim_DecrRefCount(interp
,
2859 script
->token
[i
].objPtr
);
2860 script
->token
[i
].objPtr
= foundObjPtr
;
2864 /* Try to share locally */
2865 for (i
= 0; i
< script
->len
; i
++) {
2866 char *str
= script
->token
[i
].objPtr
->bytes
;
2868 if (script
->token
[i
].objPtr
->refCount
!= 1) continue;
2869 if (strchr(str
, ' ') || strchr(str
, '\n')) continue;
2870 for (j
= 0; j
< script
->len
; j
++) {
2871 if (script
->token
[i
].objPtr
!=
2872 script
->token
[j
].objPtr
&&
2873 Jim_StringEqObj(script
->token
[i
].objPtr
,
2874 script
->token
[j
].objPtr
, 0))
2876 Jim_IncrRefCount(script
->token
[j
].objPtr
);
2877 Jim_DecrRefCount(interp
,
2878 script
->token
[i
].objPtr
);
2879 script
->token
[i
].objPtr
=
2880 script
->token
[j
].objPtr
;
2886 /* This method takes the string representation of an object
2887 * as a Tcl script, and generates the pre-parsed internal representation
2889 int SetScriptFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
)
2892 const char *scriptText
= Jim_GetString(objPtr
, &scriptTextLen
);
2893 struct JimParserCtx parser
;
2894 struct ScriptObj
*script
= Jim_Alloc(sizeof(*script
));
2896 int args
, tokens
, start
, end
, i
;
2897 int initialLineNumber
;
2898 int propagateSourceInfo
= 0;
2902 script
->commands
= 0;
2903 script
->token
= NULL
;
2904 script
->cmdStruct
= NULL
;
2906 /* Try to get information about filename / line number */
2907 if (objPtr
->typePtr
== &sourceObjType
) {
2909 Jim_StrDup(objPtr
->internalRep
.sourceValue
.fileName
);
2910 initialLineNumber
= objPtr
->internalRep
.sourceValue
.lineNumber
;
2911 propagateSourceInfo
= 1;
2913 script
->fileName
= Jim_StrDup("?");
2914 initialLineNumber
= 1;
2917 JimParserInit(&parser
, scriptText
, scriptTextLen
, initialLineNumber
);
2918 while(!JimParserEof(&parser
)) {
2920 int len
, type
, linenr
;
2922 JimParseScript(&parser
);
2923 token
= JimParserGetToken(&parser
, &len
, &type
, &linenr
);
2924 ScriptObjAddToken(interp
, script
, token
, len
, type
,
2925 propagateSourceInfo
? script
->fileName
: NULL
,
2928 token
= script
->token
;
2930 /* Compute the command structure array
2931 * (see the ScriptObj struct definition for more info) */
2932 start
= 0; /* Current command start token index */
2933 end
= -1; /* Current command end token index */
2935 int expand
= 0; /* expand flag. set to 1 on {expand} form. */
2936 int interpolation
= 0; /* set to 1 if there is at least one
2937 argument of the command obtained via
2938 interpolation of more tokens. */
2939 /* Search for the end of command, while
2940 * count the number of args. */
2942 if (start
>= script
->len
) break;
2943 args
= 1; /* Number of args in current command */
2944 while (token
[end
].type
!= JIM_TT_EOL
) {
2945 if (end
== 0 || token
[end
-1].type
== JIM_TT_SEP
||
2946 token
[end
-1].type
== JIM_TT_EOL
)
2948 if (token
[end
].type
== JIM_TT_STR
&&
2949 token
[end
+1].type
!= JIM_TT_SEP
&&
2950 token
[end
+1].type
!= JIM_TT_EOL
&&
2951 (!strcmp(token
[end
].objPtr
->bytes
, "expand") ||
2952 !strcmp(token
[end
].objPtr
->bytes
, "*")))
2955 if (token
[end
].type
== JIM_TT_SEP
)
2959 interpolation
= !((end
-start
+1) == args
*2);
2960 /* Add the 'number of arguments' info into cmdstruct.
2961 * Negative value if there is list expansion involved. */
2963 ScriptObjAddInt(script
, -1);
2964 ScriptObjAddInt(script
, args
);
2965 /* Now add info about the number of tokens. */
2966 tokens
= 0; /* Number of tokens in current argument. */
2968 for (i
= start
; i
<= end
; i
++) {
2969 if (token
[i
].type
== JIM_TT_SEP
||
2970 token
[i
].type
== JIM_TT_EOL
)
2972 if (tokens
== 1 && expand
)
2974 ScriptObjAddInt(script
,
2975 expand
? -tokens
: tokens
);
2980 } else if (tokens
== 0 && token
[i
].type
== JIM_TT_STR
&&
2981 (!strcmp(token
[i
].objPtr
->bytes
, "expand") ||
2982 !strcmp(token
[i
].objPtr
->bytes
, "*")))
2989 /* Perform literal sharing, but only for objects that appear
2990 * to be scripts written as literals inside the source code,
2991 * and not computed at runtime. Literal sharing is a costly
2992 * operation that should be done only against objects that
2993 * are likely to require compilation only the first time, and
2994 * then are executed multiple times. */
2995 if (propagateSourceInfo
&& interp
->framePtr
->procBodyObjPtr
) {
2996 Jim_Obj
*bodyObjPtr
= interp
->framePtr
->procBodyObjPtr
;
2997 if (bodyObjPtr
->typePtr
== &scriptObjType
) {
2998 ScriptObj
*bodyScript
=
2999 bodyObjPtr
->internalRep
.ptr
;
3000 ScriptShareLiterals(interp
, script
, bodyScript
);
3002 } else if (propagateSourceInfo
) {
3003 ScriptShareLiterals(interp
, script
, NULL
);
3005 /* Free the old internal rep and set the new one. */
3006 Jim_FreeIntRep(interp
, objPtr
);
3007 Jim_SetIntRepPtr(objPtr
, script
);
3008 objPtr
->typePtr
= &scriptObjType
;
3012 ScriptObj
*Jim_GetScript(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
3014 if (objPtr
->typePtr
!= &scriptObjType
) {
3015 SetScriptFromAny(interp
, objPtr
);
3017 return (ScriptObj
*) Jim_GetIntRepPtr(objPtr
);
3020 /* -----------------------------------------------------------------------------
3022 * ---------------------------------------------------------------------------*/
3024 /* Commands HashTable Type.
3026 * Keys are dynamic allocated strings, Values are Jim_Cmd structures. */
3027 static void Jim_CommandsHT_ValDestructor(void *interp
, void *val
)
3029 Jim_Cmd
*cmdPtr
= (void*) val
;
3031 if (cmdPtr
->cmdProc
== NULL
) {
3032 Jim_DecrRefCount(interp
, cmdPtr
->argListObjPtr
);
3033 Jim_DecrRefCount(interp
, cmdPtr
->bodyObjPtr
);
3034 if (cmdPtr
->staticVars
) {
3035 Jim_FreeHashTable(cmdPtr
->staticVars
);
3036 Jim_Free(cmdPtr
->staticVars
);
3038 } else if (cmdPtr
->delProc
!= NULL
) {
3039 /* If it was a C coded command, call the delProc if any */
3040 cmdPtr
->delProc(interp
, cmdPtr
->privData
);
3045 static Jim_HashTableType JimCommandsHashTableType
= {
3046 JimStringCopyHTHashFunction
, /* hash function */
3047 JimStringCopyHTKeyDup
, /* key dup */
3049 JimStringCopyHTKeyCompare
, /* key compare */
3050 JimStringCopyHTKeyDestructor
, /* key destructor */
3051 Jim_CommandsHT_ValDestructor
/* val destructor */
3054 /* ------------------------- Commands related functions --------------------- */
3056 int Jim_CreateCommand(Jim_Interp
*interp
, const char *cmdName
,
3057 Jim_CmdProc cmdProc
, void *privData
, Jim_DelCmdProc delProc
)
3062 he
= Jim_FindHashEntry(&interp
->commands
, cmdName
);
3063 if (he
== NULL
) { /* New command to create */
3064 cmdPtr
= Jim_Alloc(sizeof(*cmdPtr
));
3065 cmdPtr
->cmdProc
= cmdProc
;
3066 cmdPtr
->privData
= privData
;
3067 cmdPtr
->delProc
= delProc
;
3068 Jim_AddHashEntry(&interp
->commands
, cmdName
, cmdPtr
);
3070 Jim_InterpIncrProcEpoch(interp
);
3071 /* Free the arglist/body objects if it was a Tcl procedure */
3073 if (cmdPtr
->cmdProc
== NULL
) {
3074 Jim_DecrRefCount(interp
, cmdPtr
->argListObjPtr
);
3075 Jim_DecrRefCount(interp
, cmdPtr
->bodyObjPtr
);
3076 if (cmdPtr
->staticVars
) {
3077 Jim_FreeHashTable(cmdPtr
->staticVars
);
3078 Jim_Free(cmdPtr
->staticVars
);
3080 cmdPtr
->staticVars
= NULL
;
3081 } else if (cmdPtr
->delProc
!= NULL
) {
3082 /* If it was a C coded command, call the delProc if any */
3083 cmdPtr
->delProc(interp
, cmdPtr
->privData
);
3085 cmdPtr
->cmdProc
= cmdProc
;
3086 cmdPtr
->privData
= privData
;
3088 /* There is no need to increment the 'proc epoch' because
3089 * creation of a new procedure can never affect existing
3090 * cached commands. We don't do negative caching. */
3094 int Jim_CreateProcedure(Jim_Interp
*interp
, const char *cmdName
,
3095 Jim_Obj
*argListObjPtr
, Jim_Obj
*staticsListObjPtr
, Jim_Obj
*bodyObjPtr
,
3096 int arityMin
, int arityMax
)
3100 cmdPtr
= Jim_Alloc(sizeof(*cmdPtr
));
3101 cmdPtr
->cmdProc
= NULL
; /* Not a C coded command */
3102 cmdPtr
->argListObjPtr
= argListObjPtr
;
3103 cmdPtr
->bodyObjPtr
= bodyObjPtr
;
3104 Jim_IncrRefCount(argListObjPtr
);
3105 Jim_IncrRefCount(bodyObjPtr
);
3106 cmdPtr
->arityMin
= arityMin
;
3107 cmdPtr
->arityMax
= arityMax
;
3108 cmdPtr
->staticVars
= NULL
;
3110 /* Create the statics hash table. */
3111 if (staticsListObjPtr
) {
3114 Jim_ListLength(interp
, staticsListObjPtr
, &len
);
3116 cmdPtr
->staticVars
= Jim_Alloc(sizeof(Jim_HashTable
));
3117 Jim_InitHashTable(cmdPtr
->staticVars
, &JimVariablesHashTableType
,
3119 for (i
= 0; i
< len
; i
++) {
3120 Jim_Obj
*objPtr
, *initObjPtr
, *nameObjPtr
;
3124 Jim_ListIndex(interp
, staticsListObjPtr
, i
, &objPtr
, JIM_NONE
);
3125 /* Check if it's composed of two elements. */
3126 Jim_ListLength(interp
, objPtr
, &subLen
);
3127 if (subLen
== 1 || subLen
== 2) {
3128 /* Try to get the variable value from the current
3130 Jim_ListIndex(interp
, objPtr
, 0, &nameObjPtr
, JIM_NONE
);
3132 initObjPtr
= Jim_GetVariable(interp
, nameObjPtr
,
3134 if (initObjPtr
== NULL
) {
3135 Jim_SetResult(interp
,
3136 Jim_NewEmptyStringObj(interp
));
3137 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
3138 "variable for initialization of static \"",
3139 Jim_GetString(nameObjPtr
, NULL
),
3140 "\" not found in the local context",
3145 Jim_ListIndex(interp
, objPtr
, 1, &initObjPtr
, JIM_NONE
);
3147 varPtr
= Jim_Alloc(sizeof(*varPtr
));
3148 varPtr
->objPtr
= initObjPtr
;
3149 Jim_IncrRefCount(initObjPtr
);
3150 varPtr
->linkFramePtr
= NULL
;
3151 if (Jim_AddHashEntry(cmdPtr
->staticVars
,
3152 Jim_GetString(nameObjPtr
, NULL
),
3155 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
3156 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
3157 "static variable name \"",
3158 Jim_GetString(objPtr
, NULL
), "\"",
3159 " duplicated in statics list", NULL
);
3160 Jim_DecrRefCount(interp
, initObjPtr
);
3165 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
3166 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
3167 "too many fields in static specifier \"",
3168 objPtr
, "\"", NULL
);
3175 /* Add the new command */
3177 /* it may already exist, so we try to delete the old one */
3178 if (Jim_DeleteHashEntry(&interp
->commands
, cmdName
) != JIM_ERR
) {
3179 /* There was an old procedure with the same name, this requires
3180 * a 'proc epoch' update. */
3181 Jim_InterpIncrProcEpoch(interp
);
3183 /* If a procedure with the same name didn't existed there is no need
3184 * to increment the 'proc epoch' because creation of a new procedure
3185 * can never affect existing cached commands. We don't do
3186 * negative caching. */
3187 Jim_AddHashEntry(&interp
->commands
, cmdName
, cmdPtr
);
3191 Jim_FreeHashTable(cmdPtr
->staticVars
);
3192 Jim_Free(cmdPtr
->staticVars
);
3193 Jim_DecrRefCount(interp
, argListObjPtr
);
3194 Jim_DecrRefCount(interp
, bodyObjPtr
);
3199 int Jim_DeleteCommand(Jim_Interp
*interp
, const char *cmdName
)
3201 if (Jim_DeleteHashEntry(&interp
->commands
, cmdName
) == JIM_ERR
)
3203 Jim_InterpIncrProcEpoch(interp
);
3207 int Jim_RenameCommand(Jim_Interp
*interp
, const char *oldName
,
3208 const char *newName
)
3212 Jim_Cmd
*copyCmdPtr
;
3214 if (newName
[0] == '\0') /* Delete! */
3215 return Jim_DeleteCommand(interp
, oldName
);
3217 he
= Jim_FindHashEntry(&interp
->commands
, oldName
);
3219 return JIM_ERR
; /* Invalid command name */
3221 copyCmdPtr
= Jim_Alloc(sizeof(Jim_Cmd
));
3222 *copyCmdPtr
= *cmdPtr
;
3223 /* In order to avoid that a procedure will get arglist/body/statics
3224 * freed by the hash table methods, fake a C-coded command
3225 * setting cmdPtr->cmdProc as not NULL */
3226 cmdPtr
->cmdProc
= (void*)1;
3227 /* Also make sure delProc is NULL. */
3228 cmdPtr
->delProc
= NULL
;
3229 /* Destroy the old command, and make sure the new is freed
3231 Jim_DeleteHashEntry(&interp
->commands
, oldName
);
3232 Jim_DeleteHashEntry(&interp
->commands
, newName
);
3233 /* Now the new command. We are sure it can't fail because
3234 * the target name was already freed. */
3235 Jim_AddHashEntry(&interp
->commands
, newName
, copyCmdPtr
);
3236 /* Increment the epoch */
3237 Jim_InterpIncrProcEpoch(interp
);
3241 /* -----------------------------------------------------------------------------
3243 * ---------------------------------------------------------------------------*/
3245 static int SetCommandFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
);
3247 static Jim_ObjType commandObjType
= {
3252 JIM_TYPE_REFERENCES
,
3255 int SetCommandFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
3258 const char *cmdName
;
3260 /* Get the string representation */
3261 cmdName
= Jim_GetString(objPtr
, NULL
);
3262 /* Lookup this name into the commands hash table */
3263 he
= Jim_FindHashEntry(&interp
->commands
, cmdName
);
3267 /* Free the old internal repr and set the new one. */
3268 Jim_FreeIntRep(interp
, objPtr
);
3269 objPtr
->typePtr
= &commandObjType
;
3270 objPtr
->internalRep
.cmdValue
.procEpoch
= interp
->procEpoch
;
3271 objPtr
->internalRep
.cmdValue
.cmdPtr
= (void*)he
->val
;
3275 /* This function returns the command structure for the command name
3276 * stored in objPtr. It tries to specialize the objPtr to contain
3277 * a cached info instead to perform the lookup into the hash table
3278 * every time. The information cached may not be uptodate, in such
3279 * a case the lookup is performed and the cache updated. */
3280 Jim_Cmd
*Jim_GetCommand(Jim_Interp
*interp
, Jim_Obj
*objPtr
, int flags
)
3282 if ((objPtr
->typePtr
!= &commandObjType
||
3283 objPtr
->internalRep
.cmdValue
.procEpoch
!= interp
->procEpoch
) &&
3284 SetCommandFromAny(interp
, objPtr
) == JIM_ERR
) {
3285 if (flags
& JIM_ERRMSG
) {
3286 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
3287 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
3288 "invalid command name \"", objPtr
->bytes
, "\"",
3293 return objPtr
->internalRep
.cmdValue
.cmdPtr
;
3296 /* -----------------------------------------------------------------------------
3298 * ---------------------------------------------------------------------------*/
3300 /* Variables HashTable Type.
3302 * Keys are dynamic allocated strings, Values are Jim_Var structures. */
3303 static void JimVariablesHTValDestructor(void *interp
, void *val
)
3305 Jim_Var
*varPtr
= (void*) val
;
3307 Jim_DecrRefCount(interp
, varPtr
->objPtr
);
3311 static Jim_HashTableType JimVariablesHashTableType
= {
3312 JimStringCopyHTHashFunction
, /* hash function */
3313 JimStringCopyHTKeyDup
, /* key dup */
3315 JimStringCopyHTKeyCompare
, /* key compare */
3316 JimStringCopyHTKeyDestructor
, /* key destructor */
3317 JimVariablesHTValDestructor
/* val destructor */
3320 /* -----------------------------------------------------------------------------
3322 * ---------------------------------------------------------------------------*/
3324 #define JIM_DICT_SUGAR 100 /* Only returned by SetVariableFromAny() */
3326 static int SetVariableFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
);
3328 static Jim_ObjType variableObjType
= {
3333 JIM_TYPE_REFERENCES
,
3336 /* Return true if the string "str" looks like syntax sugar for [dict]. I.e.
3337 * is in the form "varname(key)". */
3338 static int Jim_NameIsDictSugar(const char *str
, int len
)
3342 if (len
&& str
[len
-1] == ')' && strchr(str
, '(') != NULL
)
3347 /* This method should be called only by the variable API.
3348 * It returns JIM_OK on success (variable already exists),
3349 * JIM_ERR if it does not exists, JIM_DICT_GLUE if it's not
3350 * a variable name, but syntax glue for [dict] i.e. the last
3351 * character is ')' */
3352 int SetVariableFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
)
3355 const char *varName
;
3358 /* Check if the object is already an uptodate variable */
3359 if (objPtr
->typePtr
== &variableObjType
&&
3360 objPtr
->internalRep
.varValue
.callFrameId
== interp
->framePtr
->id
)
3361 return JIM_OK
; /* nothing to do */
3362 /* Get the string representation */
3363 varName
= Jim_GetString(objPtr
, &len
);
3364 /* Make sure it's not syntax glue to get/set dict. */
3365 if (Jim_NameIsDictSugar(varName
, len
))
3366 return JIM_DICT_SUGAR
;
3367 /* Lookup this name into the variables hash table */
3368 he
= Jim_FindHashEntry(&interp
->framePtr
->vars
, varName
);
3370 /* Try with static vars. */
3371 if (interp
->framePtr
->staticVars
== NULL
)
3373 if (!(he
= Jim_FindHashEntry(interp
->framePtr
->staticVars
, varName
)))
3376 /* Free the old internal repr and set the new one. */
3377 Jim_FreeIntRep(interp
, objPtr
);
3378 objPtr
->typePtr
= &variableObjType
;
3379 objPtr
->internalRep
.varValue
.callFrameId
= interp
->framePtr
->id
;
3380 objPtr
->internalRep
.varValue
.varPtr
= (void*)he
->val
;
3384 /* -------------------- Variables related functions ------------------------- */
3385 static int JimDictSugarSet(Jim_Interp
*interp
, Jim_Obj
*ObjPtr
,
3386 Jim_Obj
*valObjPtr
);
3387 static Jim_Obj
*JimDictSugarGet(Jim_Interp
*interp
, Jim_Obj
*ObjPtr
);
3389 /* For now that's dummy. Variables lookup should be optimized
3390 * in many ways, with caching of lookups, and possibly with
3391 * a table of pre-allocated vars in every CallFrame for local vars.
3392 * All the caching should also have an 'epoch' mechanism similar
3393 * to the one used by Tcl for procedures lookup caching. */
3395 int Jim_SetVariable(Jim_Interp
*interp
, Jim_Obj
*nameObjPtr
, Jim_Obj
*valObjPtr
)
3401 if ((err
= SetVariableFromAny(interp
, nameObjPtr
)) != JIM_OK
) {
3402 /* Check for [dict] syntax sugar. */
3403 if (err
== JIM_DICT_SUGAR
)
3404 return JimDictSugarSet(interp
, nameObjPtr
, valObjPtr
);
3405 /* New variable to create */
3406 name
= Jim_GetString(nameObjPtr
, NULL
);
3408 var
= Jim_Alloc(sizeof(*var
));
3409 var
->objPtr
= valObjPtr
;
3410 Jim_IncrRefCount(valObjPtr
);
3411 var
->linkFramePtr
= NULL
;
3412 /* Insert the new variable */
3413 Jim_AddHashEntry(&interp
->framePtr
->vars
, name
, var
);
3414 /* Make the object int rep a variable */
3415 Jim_FreeIntRep(interp
, nameObjPtr
);
3416 nameObjPtr
->typePtr
= &variableObjType
;
3417 nameObjPtr
->internalRep
.varValue
.callFrameId
=
3418 interp
->framePtr
->id
;
3419 nameObjPtr
->internalRep
.varValue
.varPtr
= var
;
3421 var
= nameObjPtr
->internalRep
.varValue
.varPtr
;
3422 if (var
->linkFramePtr
== NULL
) {
3423 Jim_IncrRefCount(valObjPtr
);
3424 Jim_DecrRefCount(interp
, var
->objPtr
);
3425 var
->objPtr
= valObjPtr
;
3426 } else { /* Else handle the link */
3427 Jim_CallFrame
*savedCallFrame
;
3429 savedCallFrame
= interp
->framePtr
;
3430 interp
->framePtr
= var
->linkFramePtr
;
3431 err
= Jim_SetVariable(interp
, var
->objPtr
, valObjPtr
);
3432 interp
->framePtr
= savedCallFrame
;
3440 int Jim_SetVariableStr(Jim_Interp
*interp
, const char *name
, Jim_Obj
*objPtr
)
3442 Jim_Obj
*nameObjPtr
;
3445 nameObjPtr
= Jim_NewStringObj(interp
, name
, -1);
3446 Jim_IncrRefCount(nameObjPtr
);
3447 result
= Jim_SetVariable(interp
, nameObjPtr
, objPtr
);
3448 Jim_DecrRefCount(interp
, nameObjPtr
);
3452 int Jim_SetGlobalVariableStr(Jim_Interp
*interp
, const char *name
, Jim_Obj
*objPtr
)
3454 Jim_CallFrame
*savedFramePtr
;
3457 savedFramePtr
= interp
->framePtr
;
3458 interp
->framePtr
= interp
->topFramePtr
;
3459 result
= Jim_SetVariableStr(interp
, name
, objPtr
);
3460 interp
->framePtr
= savedFramePtr
;
3464 int Jim_SetVariableStrWithStr(Jim_Interp
*interp
, const char *name
, const char *val
)
3466 Jim_Obj
*nameObjPtr
, *valObjPtr
;
3469 nameObjPtr
= Jim_NewStringObj(interp
, name
, -1);
3470 valObjPtr
= Jim_NewStringObj(interp
, val
, -1);
3471 Jim_IncrRefCount(nameObjPtr
);
3472 Jim_IncrRefCount(valObjPtr
);
3473 result
= Jim_SetVariable(interp
, nameObjPtr
, valObjPtr
);
3474 Jim_DecrRefCount(interp
, nameObjPtr
);
3475 Jim_DecrRefCount(interp
, valObjPtr
);
3479 int Jim_SetVariableLink(Jim_Interp
*interp
, Jim_Obj
*nameObjPtr
,
3480 Jim_Obj
*targetNameObjPtr
, Jim_CallFrame
*targetCallFrame
)
3482 const char *varName
;
3485 /* Check for cycles. */
3486 if (interp
->framePtr
== targetCallFrame
) {
3487 Jim_Obj
*objPtr
= targetNameObjPtr
;
3489 /* Cycles are only possible with 'uplevel 0' */
3491 if (Jim_StringEqObj(objPtr
, nameObjPtr
, 0)) {
3492 Jim_SetResultString(interp
,
3493 "can't upvar from variable to itself", -1);
3496 if (SetVariableFromAny(interp
, objPtr
) != JIM_OK
)
3498 varPtr
= objPtr
->internalRep
.varValue
.varPtr
;
3499 if (varPtr
->linkFramePtr
!= targetCallFrame
) break;
3500 objPtr
= varPtr
->objPtr
;
3503 varName
= Jim_GetString(nameObjPtr
, &len
);
3504 if (Jim_NameIsDictSugar(varName
, len
)) {
3505 Jim_SetResultString(interp
,
3506 "Dict key syntax invalid as link source", -1);
3509 /* Perform the binding */
3510 Jim_SetVariable(interp
, nameObjPtr
, targetNameObjPtr
);
3511 /* We are now sure 'nameObjPtr' type is variableObjType */
3512 nameObjPtr
->internalRep
.varValue
.varPtr
->linkFramePtr
= targetCallFrame
;
3516 /* Return the Jim_Obj pointer associated with a variable name,
3517 * or NULL if the variable was not found in the current context.
3518 * The same optimization discussed in the comment to the
3519 * 'SetVariable' function should apply here. */
3520 Jim_Obj
*Jim_GetVariable(Jim_Interp
*interp
, Jim_Obj
*nameObjPtr
, int flags
)
3524 /* All the rest is handled here */
3525 if ((err
= SetVariableFromAny(interp
, nameObjPtr
)) != JIM_OK
) {
3526 /* Check for [dict] syntax sugar. */
3527 if (err
== JIM_DICT_SUGAR
)
3528 return JimDictSugarGet(interp
, nameObjPtr
);
3529 if (flags
& JIM_ERRMSG
) {
3530 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
3531 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
3532 "can't read \"", nameObjPtr
->bytes
,
3533 "\": no such variable", NULL
);
3539 Jim_CallFrame
*savedCallFrame
;
3541 varPtr
= nameObjPtr
->internalRep
.varValue
.varPtr
;
3542 if (varPtr
->linkFramePtr
== NULL
)
3543 return varPtr
->objPtr
;
3544 /* The variable is a link? Resolve it. */
3545 savedCallFrame
= interp
->framePtr
;
3546 interp
->framePtr
= varPtr
->linkFramePtr
;
3547 objPtr
= Jim_GetVariable(interp
, varPtr
->objPtr
, JIM_NONE
);
3548 if (objPtr
== NULL
&& flags
& JIM_ERRMSG
) {
3549 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
3550 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
3551 "can't read \"", nameObjPtr
->bytes
,
3552 "\": no such variable", NULL
);
3554 interp
->framePtr
= savedCallFrame
;
3559 Jim_Obj
*Jim_GetGlobalVariable(Jim_Interp
*interp
, Jim_Obj
*nameObjPtr
,
3562 Jim_CallFrame
*savedFramePtr
;
3565 savedFramePtr
= interp
->framePtr
;
3566 interp
->framePtr
= interp
->topFramePtr
;
3567 objPtr
= Jim_GetVariable(interp
, nameObjPtr
, flags
);
3568 interp
->framePtr
= savedFramePtr
;
3573 Jim_Obj
*Jim_GetVariableStr(Jim_Interp
*interp
, const char *name
, int flags
)
3575 Jim_Obj
*nameObjPtr
, *varObjPtr
;
3577 nameObjPtr
= Jim_NewStringObj(interp
, name
, -1);
3578 Jim_IncrRefCount(nameObjPtr
);
3579 varObjPtr
= Jim_GetVariable(interp
, nameObjPtr
, flags
);
3580 Jim_DecrRefCount(interp
, nameObjPtr
);
3584 Jim_Obj
*Jim_GetGlobalVariableStr(Jim_Interp
*interp
, const char *name
,
3587 Jim_CallFrame
*savedFramePtr
;
3590 savedFramePtr
= interp
->framePtr
;
3591 interp
->framePtr
= interp
->topFramePtr
;
3592 objPtr
= Jim_GetVariableStr(interp
, name
, flags
);
3593 interp
->framePtr
= savedFramePtr
;
3598 /* Unset a variable.
3599 * Note: On success unset invalidates all the variable objects created
3600 * in the current call frame incrementing. */
3601 int Jim_UnsetVariable(Jim_Interp
*interp
, Jim_Obj
*nameObjPtr
, int flags
)
3607 if ((err
= SetVariableFromAny(interp
, nameObjPtr
)) != JIM_OK
) {
3608 /* Check for [dict] syntax sugar. */
3609 if (err
== JIM_DICT_SUGAR
)
3610 return JimDictSugarSet(interp
, nameObjPtr
, NULL
);
3611 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
3612 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
3613 "can't unset \"", nameObjPtr
->bytes
,
3614 "\": no such variable", NULL
);
3615 return JIM_ERR
; /* var not found */
3617 varPtr
= nameObjPtr
->internalRep
.varValue
.varPtr
;
3618 /* If it's a link call UnsetVariable recursively */
3619 if (varPtr
->linkFramePtr
) {
3622 Jim_CallFrame
*savedCallFrame
;
3624 savedCallFrame
= interp
->framePtr
;
3625 interp
->framePtr
= varPtr
->linkFramePtr
;
3626 retval
= Jim_UnsetVariable(interp
, varPtr
->objPtr
, JIM_NONE
);
3627 interp
->framePtr
= savedCallFrame
;
3628 if (retval
!= JIM_OK
&& flags
& JIM_ERRMSG
) {
3629 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
3630 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
3631 "can't unset \"", nameObjPtr
->bytes
,
3632 "\": no such variable", NULL
);
3636 name
= Jim_GetString(nameObjPtr
, NULL
);
3637 if (Jim_DeleteHashEntry(&interp
->framePtr
->vars
, name
)
3638 != JIM_OK
) return JIM_ERR
;
3639 /* Change the callframe id, invalidating var lookup caching */
3640 JimChangeCallFrameId(interp
, interp
->framePtr
);
3645 /* ---------- Dict syntax sugar (similar to array Tcl syntax) -------------- */
3647 /* Given a variable name for [dict] operation syntax sugar,
3648 * this function returns two objects, the first with the name
3649 * of the variable to set, and the second with the rispective key.
3650 * For example "foo(bar)" will return objects with string repr. of
3653 * The returned objects have refcount = 1. The function can't fail. */
3654 static void JimDictSugarParseVarKey(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
3655 Jim_Obj
**varPtrPtr
, Jim_Obj
**keyPtrPtr
)
3657 const char *str
, *p
;
3659 int len
, keyLen
, nameLen
;
3660 Jim_Obj
*varObjPtr
, *keyObjPtr
;
3662 str
= Jim_GetString(objPtr
, &len
);
3663 p
= strchr(str
, '(');
3665 keyLen
= len
-((p
-str
)+1);
3666 nameLen
= (p
-str
)-1;
3667 /* Create the objects with the variable name and key. */
3668 t
= Jim_Alloc(nameLen
+1);
3669 memcpy(t
, str
, nameLen
);
3671 varObjPtr
= Jim_NewStringObjNoAlloc(interp
, t
, nameLen
);
3673 t
= Jim_Alloc(keyLen
+1);
3674 memcpy(t
, p
, keyLen
);
3676 keyObjPtr
= Jim_NewStringObjNoAlloc(interp
, t
, keyLen
);
3678 Jim_IncrRefCount(varObjPtr
);
3679 Jim_IncrRefCount(keyObjPtr
);
3680 *varPtrPtr
= varObjPtr
;
3681 *keyPtrPtr
= keyObjPtr
;
3684 /* Helper of Jim_SetVariable() to deal with dict-syntax variable names.
3685 * Also used by Jim_UnsetVariable() with valObjPtr = NULL. */
3686 static int JimDictSugarSet(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
3689 Jim_Obj
*varObjPtr
, *keyObjPtr
;
3692 JimDictSugarParseVarKey(interp
, objPtr
, &varObjPtr
, &keyObjPtr
);
3693 err
= Jim_SetDictKeysVector(interp
, varObjPtr
, &keyObjPtr
, 1,
3695 Jim_DecrRefCount(interp
, varObjPtr
);
3696 Jim_DecrRefCount(interp
, keyObjPtr
);
3700 /* Helper of Jim_GetVariable() to deal with dict-syntax variable names */
3701 static Jim_Obj
*JimDictSugarGet(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
3703 Jim_Obj
*varObjPtr
, *keyObjPtr
, *dictObjPtr
, *resObjPtr
;
3705 JimDictSugarParseVarKey(interp
, objPtr
, &varObjPtr
, &keyObjPtr
);
3706 dictObjPtr
= Jim_GetVariable(interp
, varObjPtr
, JIM_ERRMSG
);
3711 if (Jim_DictKey(interp
, dictObjPtr
, keyObjPtr
, &resObjPtr
, JIM_ERRMSG
)
3716 Jim_DecrRefCount(interp
, varObjPtr
);
3717 Jim_DecrRefCount(interp
, keyObjPtr
);
3721 /* --------- $var(INDEX) substitution, using a specialized object ----------- */
3723 static void FreeDictSubstInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
3724 static void DupDictSubstInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
,
3727 static Jim_ObjType dictSubstObjType
= {
3728 "dict-substitution",
3729 FreeDictSubstInternalRep
,
3730 DupDictSubstInternalRep
,
3735 void FreeDictSubstInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
3737 Jim_DecrRefCount(interp
, objPtr
->internalRep
.dictSubstValue
.varNameObjPtr
);
3738 Jim_DecrRefCount(interp
, objPtr
->internalRep
.dictSubstValue
.indexObjPtr
);
3741 void DupDictSubstInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
,
3744 JIM_NOTUSED(interp
);
3746 dupPtr
->internalRep
.dictSubstValue
.varNameObjPtr
=
3747 srcPtr
->internalRep
.dictSubstValue
.varNameObjPtr
;
3748 dupPtr
->internalRep
.dictSubstValue
.indexObjPtr
=
3749 srcPtr
->internalRep
.dictSubstValue
.indexObjPtr
;
3750 dupPtr
->typePtr
= &dictSubstObjType
;
3753 /* This function is used to expand [dict get] sugar in the form
3754 * of $var(INDEX). The function is mainly used by Jim_EvalObj()
3755 * to deal with tokens of type JIM_TT_DICTSUGAR. objPtr points to an
3756 * object that is *guaranteed* to be in the form VARNAME(INDEX).
3757 * The 'index' part is [subst]ituted, and is used to lookup a key inside
3758 * the [dict]ionary contained in variable VARNAME. */
3759 Jim_Obj
*Jim_ExpandDictSugar(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
3761 Jim_Obj
*varObjPtr
, *keyObjPtr
, *dictObjPtr
, *resObjPtr
;
3762 Jim_Obj
*substKeyObjPtr
= NULL
;
3764 if (objPtr
->typePtr
!= &dictSubstObjType
) {
3765 JimDictSugarParseVarKey(interp
, objPtr
, &varObjPtr
, &keyObjPtr
);
3766 Jim_FreeIntRep(interp
, objPtr
);
3767 objPtr
->typePtr
= &dictSubstObjType
;
3768 objPtr
->internalRep
.dictSubstValue
.varNameObjPtr
= varObjPtr
;
3769 objPtr
->internalRep
.dictSubstValue
.indexObjPtr
= keyObjPtr
;
3771 if (Jim_SubstObj(interp
, objPtr
->internalRep
.dictSubstValue
.indexObjPtr
,
3772 &substKeyObjPtr
, JIM_NONE
)
3774 substKeyObjPtr
= NULL
;
3777 Jim_IncrRefCount(substKeyObjPtr
);
3778 dictObjPtr
= Jim_GetVariable(interp
,
3779 objPtr
->internalRep
.dictSubstValue
.varNameObjPtr
, JIM_ERRMSG
);
3784 if (Jim_DictKey(interp
, dictObjPtr
, substKeyObjPtr
, &resObjPtr
, JIM_ERRMSG
)
3790 if (substKeyObjPtr
) Jim_DecrRefCount(interp
, substKeyObjPtr
);
3794 /* -----------------------------------------------------------------------------
3796 * ---------------------------------------------------------------------------*/
3798 static Jim_CallFrame
*JimCreateCallFrame(Jim_Interp
*interp
)
3801 if (interp
->freeFramesList
) {
3802 cf
= interp
->freeFramesList
;
3803 interp
->freeFramesList
= cf
->nextFramePtr
;
3805 cf
= Jim_Alloc(sizeof(*cf
));
3806 cf
->vars
.table
= NULL
;
3809 cf
->id
= interp
->callFrameEpoch
++;
3810 cf
->parentCallFrame
= NULL
;
3813 cf
->procArgsObjPtr
= NULL
;
3814 cf
->procBodyObjPtr
= NULL
;
3815 cf
->nextFramePtr
= NULL
;
3816 cf
->staticVars
= NULL
;
3817 if (cf
->vars
.table
== NULL
)
3818 Jim_InitHashTable(&cf
->vars
, &JimVariablesHashTableType
, interp
);
3822 /* Used to invalidate every caching related to callframe stability. */
3823 static void JimChangeCallFrameId(Jim_Interp
*interp
, Jim_CallFrame
*cf
)
3825 cf
->id
= interp
->callFrameEpoch
++;
3828 #define JIM_FCF_NONE 0 /* no flags */
3829 #define JIM_FCF_NOHT 1 /* don't free the hash table */
3830 static void JimFreeCallFrame(Jim_Interp
*interp
, Jim_CallFrame
*cf
,
3833 if (cf
->procArgsObjPtr
) Jim_DecrRefCount(interp
, cf
->procArgsObjPtr
);
3834 if (cf
->procBodyObjPtr
) Jim_DecrRefCount(interp
, cf
->procBodyObjPtr
);
3835 if (!(flags
& JIM_FCF_NOHT
))
3836 Jim_FreeHashTable(&cf
->vars
);
3839 Jim_HashEntry
**table
= cf
->vars
.table
, *he
;
3841 for (i
= 0; i
< JIM_HT_INITIAL_SIZE
; i
++) {
3843 while (he
!= NULL
) {
3844 Jim_HashEntry
*nextEntry
= he
->next
;
3845 Jim_Var
*varPtr
= (void*) he
->val
;
3847 Jim_DecrRefCount(interp
, varPtr
->objPtr
);
3849 Jim_Free((void*)he
->key
); /* ATTENTION: const cast */
3857 cf
->nextFramePtr
= interp
->freeFramesList
;
3858 interp
->freeFramesList
= cf
;
3861 /* -----------------------------------------------------------------------------
3863 * ---------------------------------------------------------------------------*/
3865 /* References HashTable Type.
3867 * Keys are jim_wide integers, dynamically allocated for now but in the
3868 * future it's worth to cache this 8 bytes objects. Values are poitners
3869 * to Jim_References. */
3870 static void JimReferencesHTValDestructor(void *interp
, void *val
)
3872 Jim_Reference
*refPtr
= (void*) val
;
3874 Jim_DecrRefCount(interp
, refPtr
->objPtr
);
3875 if (refPtr
->finalizerCmdNamePtr
!= NULL
) {
3876 Jim_DecrRefCount(interp
, refPtr
->finalizerCmdNamePtr
);
3881 unsigned int JimReferencesHTHashFunction(const void *key
)
3883 /* Only the least significant bits are used. */
3884 const jim_wide
*widePtr
= key
;
3885 unsigned int intValue
= (unsigned int) *widePtr
;
3886 return Jim_IntHashFunction(intValue
);
3889 unsigned int JimReferencesHTDoubleHashFunction(const void *key
)
3891 /* Only the least significant bits are used. */
3892 const jim_wide
*widePtr
= key
;
3893 unsigned int intValue
= (unsigned int) *widePtr
;
3894 return intValue
; /* identity function. */
3897 const void *JimReferencesHTKeyDup(void *privdata
, const void *key
)
3899 void *copy
= Jim_Alloc(sizeof(jim_wide
));
3900 JIM_NOTUSED(privdata
);
3902 memcpy(copy
, key
, sizeof(jim_wide
));
3906 int JimReferencesHTKeyCompare(void *privdata
, const void *key1
,
3909 JIM_NOTUSED(privdata
);
3911 return memcmp(key1
, key2
, sizeof(jim_wide
)) == 0;
3914 void JimReferencesHTKeyDestructor(void *privdata
, const void *key
)
3916 JIM_NOTUSED(privdata
);
3918 Jim_Free((void*)key
);
3921 static Jim_HashTableType JimReferencesHashTableType
= {
3922 JimReferencesHTHashFunction
, /* hash function */
3923 JimReferencesHTKeyDup
, /* key dup */
3925 JimReferencesHTKeyCompare
, /* key compare */
3926 JimReferencesHTKeyDestructor
, /* key destructor */
3927 JimReferencesHTValDestructor
/* val destructor */
3930 /* -----------------------------------------------------------------------------
3931 * Reference object type and References API
3932 * ---------------------------------------------------------------------------*/
3934 static void UpdateStringOfReference(struct Jim_Obj
*objPtr
);
3936 static Jim_ObjType referenceObjType
= {
3940 UpdateStringOfReference
,
3941 JIM_TYPE_REFERENCES
,
3944 void UpdateStringOfReference(struct Jim_Obj
*objPtr
)
3947 char buf
[JIM_REFERENCE_SPACE
+1];
3948 Jim_Reference
*refPtr
;
3950 refPtr
= objPtr
->internalRep
.refValue
.refPtr
;
3951 len
= JimFormatReference(buf
, refPtr
, objPtr
->internalRep
.refValue
.id
);
3952 objPtr
->bytes
= Jim_Alloc(len
+1);
3953 memcpy(objPtr
->bytes
, buf
, len
+1);
3954 objPtr
->length
= len
;
3957 /* returns true if 'c' is a valid reference tag character.
3958 * i.e. inside the range [_a-zA-Z0-9] */
3959 static int isrefchar(int c
)
3961 if (c
== '_' || (c
>= 'a' && c
<= 'z') || (c
>= 'A' && c
<= 'Z') ||
3962 (c
>= '0' && c
<= '9')) return 1;
3966 int SetReferenceFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
3970 const char *str
, *start
, *end
;
3972 Jim_Reference
*refPtr
;
3975 /* Get the string representation */
3976 str
= Jim_GetString(objPtr
, &len
);
3977 /* Check if it looks like a reference */
3978 if (len
< JIM_REFERENCE_SPACE
) goto badformat
;
3982 while (*start
== ' ') start
++;
3983 while (*end
== ' ' && end
> start
) end
--;
3984 if (end
-start
+1 != JIM_REFERENCE_SPACE
) goto badformat
;
3985 /* <reference.<1234567>.%020> */
3986 if (memcmp(start
, "<reference.<", 12) != 0) goto badformat
;
3987 if (start
[12+JIM_REFERENCE_TAGLEN
] != '>' || end
[0] != '>') goto badformat
;
3988 /* The tag can't contain chars other than a-zA-Z0-9 + '_'. */
3989 for (i
= 0; i
< JIM_REFERENCE_TAGLEN
; i
++) {
3990 if (!isrefchar(start
[12+i
])) goto badformat
;
3992 /* Extract info from the refernece. */
3993 memcpy(refId
, start
+14+JIM_REFERENCE_TAGLEN
, 20);
3995 /* Try to convert the ID into a jim_wide */
3996 if (Jim_StringToWide(refId
, &wideValue
, 10) != JIM_OK
) goto badformat
;
3997 /* Check if the reference really exists! */
3998 he
= Jim_FindHashEntry(&interp
->references
, &wideValue
);
4000 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4001 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4002 "Invalid reference ID \"", str
, "\"", NULL
);
4006 /* Free the old internal repr and set the new one. */
4007 Jim_FreeIntRep(interp
, objPtr
);
4008 objPtr
->typePtr
= &referenceObjType
;
4009 objPtr
->internalRep
.refValue
.id
= wideValue
;
4010 objPtr
->internalRep
.refValue
.refPtr
= refPtr
;
4014 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4015 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4016 "expected reference but got \"", str
, "\"", NULL
);
4020 /* Returns a new reference pointing to objPtr, having cmdNamePtr
4021 * as finalizer command (or NULL if there is no finalizer).
4022 * The returned reference object has refcount = 0. */
4023 Jim_Obj
*Jim_NewReference(Jim_Interp
*interp
, Jim_Obj
*objPtr
, Jim_Obj
*tagPtr
,
4024 Jim_Obj
*cmdNamePtr
)
4026 struct Jim_Reference
*refPtr
;
4027 jim_wide wideValue
= interp
->referenceNextId
;
4032 /* Perform the Garbage Collection if needed. */
4033 Jim_CollectIfNeeded(interp
);
4035 refPtr
= Jim_Alloc(sizeof(*refPtr
));
4036 refPtr
->objPtr
= objPtr
;
4037 Jim_IncrRefCount(objPtr
);
4038 refPtr
->finalizerCmdNamePtr
= cmdNamePtr
;
4040 Jim_IncrRefCount(cmdNamePtr
);
4041 Jim_AddHashEntry(&interp
->references
, &wideValue
, refPtr
);
4042 refObjPtr
= Jim_NewObj(interp
);
4043 refObjPtr
->typePtr
= &referenceObjType
;
4044 refObjPtr
->bytes
= NULL
;
4045 refObjPtr
->internalRep
.refValue
.id
= interp
->referenceNextId
;
4046 refObjPtr
->internalRep
.refValue
.refPtr
= refPtr
;
4047 interp
->referenceNextId
++;
4048 /* Set the tag. Trimmered at JIM_REFERENCE_TAGLEN. Everything
4049 * that does not pass the 'isrefchar' test is replaced with '_' */
4050 tag
= Jim_GetString(tagPtr
, &tagLen
);
4051 if (tagLen
> JIM_REFERENCE_TAGLEN
)
4052 tagLen
= JIM_REFERENCE_TAGLEN
;
4053 for (i
= 0; i
< JIM_REFERENCE_TAGLEN
; i
++) {
4055 refPtr
->tag
[i
] = tag
[i
];
4057 refPtr
->tag
[i
] = '_';
4059 refPtr
->tag
[JIM_REFERENCE_TAGLEN
] = '\0';
4063 Jim_Reference
*Jim_GetReference(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
4065 if (objPtr
->typePtr
!= &referenceObjType
&&
4066 SetReferenceFromAny(interp
, objPtr
) == JIM_ERR
)
4068 return objPtr
->internalRep
.refValue
.refPtr
;
4071 int Jim_SetFinalizer(Jim_Interp
*interp
, Jim_Obj
*objPtr
, Jim_Obj
*cmdNamePtr
)
4073 Jim_Reference
*refPtr
;
4075 if ((refPtr
= Jim_GetReference(interp
, objPtr
)) == NULL
)
4077 Jim_IncrRefCount(cmdNamePtr
);
4078 if (refPtr
->finalizerCmdNamePtr
)
4079 Jim_DecrRefCount(interp
, refPtr
->finalizerCmdNamePtr
);
4080 refPtr
->finalizerCmdNamePtr
= cmdNamePtr
;
4084 int Jim_GetFinalizer(Jim_Interp
*interp
, Jim_Obj
*objPtr
, Jim_Obj
**cmdNamePtrPtr
)
4086 Jim_Reference
*refPtr
;
4088 if ((refPtr
= Jim_GetReference(interp
, objPtr
)) == NULL
)
4090 *cmdNamePtrPtr
= refPtr
->finalizerCmdNamePtr
;
4094 /* -----------------------------------------------------------------------------
4095 * References Garbage Collection
4096 * ---------------------------------------------------------------------------*/
4098 /* This the hash table type for the "MARK" phase of the GC */
4099 static Jim_HashTableType JimRefMarkHashTableType
= {
4100 JimReferencesHTHashFunction
, /* hash function */
4101 JimReferencesHTKeyDup
, /* key dup */
4103 JimReferencesHTKeyCompare
, /* key compare */
4104 JimReferencesHTKeyDestructor
, /* key destructor */
4105 NULL
/* val destructor */
4108 /* #define JIM_DEBUG_GC 1 */
4110 /* Performs the garbage collection. */
4111 int Jim_Collect(Jim_Interp
*interp
)
4113 Jim_HashTable marks
;
4114 Jim_HashTableIterator
*htiter
;
4119 /* Avoid recursive calls */
4120 if (interp
->lastCollectId
== -1) {
4121 /* Jim_Collect() already running. Return just now. */
4124 interp
->lastCollectId
= -1;
4126 /* Mark all the references found into the 'mark' hash table.
4127 * The references are searched in every live object that
4128 * is of a type that can contain references. */
4129 Jim_InitHashTable(&marks
, &JimRefMarkHashTableType
, NULL
);
4130 objPtr
= interp
->liveList
;
4132 if (objPtr
->typePtr
== NULL
||
4133 objPtr
->typePtr
->flags
& JIM_TYPE_REFERENCES
) {
4134 const char *str
, *p
;
4137 /* If the object is of type reference, to get the
4138 * Id is simple... */
4139 if (objPtr
->typePtr
== &referenceObjType
) {
4140 Jim_AddHashEntry(&marks
,
4141 &objPtr
->internalRep
.refValue
.id
, NULL
);
4143 Jim_fprintf(interp
,interp
->cookie_stdout
,
4144 "MARK (reference): %d refcount: %d" JIM_NL
,
4145 (int) objPtr
->internalRep
.refValue
.id
,
4148 objPtr
= objPtr
->nextObjPtr
;
4151 /* Get the string repr of the object we want
4152 * to scan for references. */
4153 p
= str
= Jim_GetString(objPtr
, &len
);
4154 /* Skip objects too little to contain references. */
4155 if (len
< JIM_REFERENCE_SPACE
) {
4156 objPtr
= objPtr
->nextObjPtr
;
4159 /* Extract references from the object string repr. */
4165 if ((p
= strstr(p
, "<reference.<")) == NULL
)
4167 /* Check if it's a valid reference. */
4168 if (len
-(p
-str
) < JIM_REFERENCE_SPACE
) break;
4169 if (p
[41] != '>' || p
[19] != '>' || p
[20] != '.') break;
4170 for (i
= 21; i
<= 40; i
++)
4171 if (!isdigit((int)p
[i
]))
4174 memcpy(buf
, p
+21, 20);
4176 Jim_StringToWide(buf
, &id
, 10);
4178 /* Ok, a reference for the given ID
4179 * was found. Mark it. */
4180 Jim_AddHashEntry(&marks
, &id
, NULL
);
4182 Jim_fprintf(interp
,interp
->cookie_stdout
,"MARK: %d" JIM_NL
, (int)id
);
4184 p
+= JIM_REFERENCE_SPACE
;
4187 objPtr
= objPtr
->nextObjPtr
;
4190 /* Run the references hash table to destroy every reference that
4191 * is not referenced outside (not present in the mark HT). */
4192 htiter
= Jim_GetHashTableIterator(&interp
->references
);
4193 while ((he
= Jim_NextHashEntry(htiter
)) != NULL
) {
4194 const jim_wide
*refId
;
4195 Jim_Reference
*refPtr
;
4198 /* Check if in the mark phase we encountered
4199 * this reference. */
4200 if (Jim_FindHashEntry(&marks
, refId
) == NULL
) {
4202 Jim_fprintf(interp
,interp
->cookie_stdout
,"COLLECTING %d" JIM_NL
, (int)*refId
);
4205 /* Drop the reference, but call the
4206 * finalizer first if registered. */
4208 if (refPtr
->finalizerCmdNamePtr
) {
4209 char *refstr
= Jim_Alloc(JIM_REFERENCE_SPACE
+1);
4210 Jim_Obj
*objv
[3], *oldResult
;
4212 JimFormatReference(refstr
, refPtr
, *refId
);
4214 objv
[0] = refPtr
->finalizerCmdNamePtr
;
4215 objv
[1] = Jim_NewStringObjNoAlloc(interp
,
4217 objv
[2] = refPtr
->objPtr
;
4218 Jim_IncrRefCount(objv
[0]);
4219 Jim_IncrRefCount(objv
[1]);
4220 Jim_IncrRefCount(objv
[2]);
4222 /* Drop the reference itself */
4223 Jim_DeleteHashEntry(&interp
->references
, refId
);
4225 /* Call the finalizer. Errors ignored. */
4226 oldResult
= interp
->result
;
4227 Jim_IncrRefCount(oldResult
);
4228 Jim_EvalObjVector(interp
, 3, objv
);
4229 Jim_SetResult(interp
, oldResult
);
4230 Jim_DecrRefCount(interp
, oldResult
);
4232 Jim_DecrRefCount(interp
, objv
[0]);
4233 Jim_DecrRefCount(interp
, objv
[1]);
4234 Jim_DecrRefCount(interp
, objv
[2]);
4236 Jim_DeleteHashEntry(&interp
->references
, refId
);
4240 Jim_FreeHashTableIterator(htiter
);
4241 Jim_FreeHashTable(&marks
);
4242 interp
->lastCollectId
= interp
->referenceNextId
;
4243 interp
->lastCollectTime
= time(NULL
);
4247 #define JIM_COLLECT_ID_PERIOD 5000
4248 #define JIM_COLLECT_TIME_PERIOD 300
4250 void Jim_CollectIfNeeded(Jim_Interp
*interp
)
4255 elapsedId
= interp
->referenceNextId
- interp
->lastCollectId
;
4256 elapsedTime
= time(NULL
) - interp
->lastCollectTime
;
4259 if (elapsedId
> JIM_COLLECT_ID_PERIOD
||
4260 elapsedTime
> JIM_COLLECT_TIME_PERIOD
) {
4261 Jim_Collect(interp
);
4265 /* -----------------------------------------------------------------------------
4266 * Interpreter related functions
4267 * ---------------------------------------------------------------------------*/
4269 Jim_Interp
*Jim_CreateInterp(void)
4271 Jim_Interp
*i
= Jim_Alloc(sizeof(*i
));
4275 i
->errorFileName
= Jim_StrDup("");
4277 i
->maxNestingDepth
= JIM_MAX_NESTING_DEPTH
;
4278 i
->returnCode
= JIM_OK
;
4281 i
->callFrameEpoch
= 0;
4282 i
->liveList
= i
->freeList
= NULL
;
4283 i
->scriptFileName
= Jim_StrDup("");
4284 i
->referenceNextId
= 0;
4285 i
->lastCollectId
= 0;
4286 i
->lastCollectTime
= time(NULL
);
4287 i
->freeFramesList
= NULL
;
4288 i
->prngState
= NULL
;
4289 i
->evalRetcodeLevel
= -1;
4290 i
->cookie_stdin
= stdin
;
4291 i
->cookie_stdout
= stdout
;
4292 i
->cookie_stderr
= stderr
;
4293 i
->cb_fwrite
= ((size_t (*)( const void *, size_t, size_t, void *))(fwrite
));
4294 i
->cb_fread
= ((size_t (*)( void *, size_t, size_t, void *))(fread
));
4295 i
->cb_vfprintf
= ((int (*)( void *, const char *fmt
, va_list ))(vfprintf
));
4296 i
->cb_fflush
= ((int (*)( void *))(fflush
));
4297 i
->cb_fgets
= ((char * (*)( char *, int, void *))(fgets
));
4299 /* Note that we can create objects only after the
4300 * interpreter liveList and freeList pointers are
4301 * initialized to NULL. */
4302 Jim_InitHashTable(&i
->commands
, &JimCommandsHashTableType
, i
);
4303 Jim_InitHashTable(&i
->references
, &JimReferencesHashTableType
, i
);
4304 Jim_InitHashTable(&i
->sharedStrings
, &JimSharedStringsHashTableType
,
4306 Jim_InitHashTable(&i
->stub
, &JimStringCopyHashTableType
, NULL
);
4307 Jim_InitHashTable(&i
->assocData
, &JimAssocDataHashTableType
, i
);
4308 Jim_InitHashTable(&i
->packages
, &JimStringKeyValCopyHashTableType
, NULL
);
4309 i
->framePtr
= i
->topFramePtr
= JimCreateCallFrame(i
);
4310 i
->emptyObj
= Jim_NewEmptyStringObj(i
);
4311 i
->result
= i
->emptyObj
;
4312 i
->stackTrace
= Jim_NewListObj(i
, NULL
, 0);
4313 i
->unknown
= Jim_NewStringObj(i
, "unknown", -1);
4314 Jim_IncrRefCount(i
->emptyObj
);
4315 Jim_IncrRefCount(i
->result
);
4316 Jim_IncrRefCount(i
->stackTrace
);
4317 Jim_IncrRefCount(i
->unknown
);
4319 /* Initialize key variables every interpreter should contain */
4320 pathPtr
= Jim_NewStringObj(i
, "./", -1);
4321 Jim_SetVariableStr(i
, "jim_libpath", pathPtr
);
4322 Jim_SetVariableStrWithStr(i
, "jim_interactive", "0");
4324 /* Export the core API to extensions */
4325 JimRegisterCoreApi(i
);
4329 /* This is the only function Jim exports directly without
4330 * to use the STUB system. It is only used by embedders
4331 * in order to get an interpreter with the Jim API pointers
4333 Jim_Interp
*ExportedJimCreateInterp(void)
4335 return Jim_CreateInterp();
4338 void Jim_FreeInterp(Jim_Interp
*i
)
4340 Jim_CallFrame
*cf
= i
->framePtr
, *prevcf
, *nextcf
;
4341 Jim_Obj
*objPtr
, *nextObjPtr
;
4343 Jim_DecrRefCount(i
, i
->emptyObj
);
4344 Jim_DecrRefCount(i
, i
->result
);
4345 Jim_DecrRefCount(i
, i
->stackTrace
);
4346 Jim_DecrRefCount(i
, i
->unknown
);
4347 Jim_Free((void*)i
->errorFileName
);
4348 Jim_Free((void*)i
->scriptFileName
);
4349 Jim_FreeHashTable(&i
->commands
);
4350 Jim_FreeHashTable(&i
->references
);
4351 Jim_FreeHashTable(&i
->stub
);
4352 Jim_FreeHashTable(&i
->assocData
);
4353 Jim_FreeHashTable(&i
->packages
);
4354 Jim_Free(i
->prngState
);
4355 /* Free the call frames list */
4357 prevcf
= cf
->parentCallFrame
;
4358 JimFreeCallFrame(i
, cf
, JIM_FCF_NONE
);
4361 /* Check that the live object list is empty, otherwise
4362 * there is a memory leak. */
4363 if (i
->liveList
!= NULL
) {
4364 Jim_Obj
*objPtr
= i
->liveList
;
4366 Jim_fprintf( i
, i
->cookie_stdout
,JIM_NL
"-------------------------------------" JIM_NL
);
4367 Jim_fprintf( i
, i
->cookie_stdout
,"Objects still in the free list:" JIM_NL
);
4369 const char *type
= objPtr
->typePtr
?
4370 objPtr
->typePtr
->name
: "";
4371 Jim_fprintf( i
, i
->cookie_stdout
,"%p \"%-10s\": '%.20s' (refCount: %d)" JIM_NL
,
4373 objPtr
->bytes
? objPtr
->bytes
4374 : "(null)", objPtr
->refCount
);
4375 if (objPtr
->typePtr
== &sourceObjType
) {
4376 Jim_fprintf( i
, i
->cookie_stdout
, "FILE %s LINE %d" JIM_NL
,
4377 objPtr
->internalRep
.sourceValue
.fileName
,
4378 objPtr
->internalRep
.sourceValue
.lineNumber
);
4380 objPtr
= objPtr
->nextObjPtr
;
4382 Jim_fprintf( i
, i
->cookie_stdout
, "-------------------------------------" JIM_NL JIM_NL
);
4383 Jim_Panic(i
,"Live list non empty freeing the interpreter! Leak?");
4385 /* Free all the freed objects. */
4386 objPtr
= i
->freeList
;
4388 nextObjPtr
= objPtr
->nextObjPtr
;
4390 objPtr
= nextObjPtr
;
4392 /* Free cached CallFrame structures */
4393 cf
= i
->freeFramesList
;
4395 nextcf
= cf
->nextFramePtr
;
4396 if (cf
->vars
.table
!= NULL
)
4397 Jim_Free(cf
->vars
.table
);
4401 /* Free the sharedString hash table. Make sure to free it
4402 * after every other Jim_Object was freed. */
4403 Jim_FreeHashTable(&i
->sharedStrings
);
4404 /* Free the interpreter structure. */
4408 /* Store the call frame relative to the level represented by
4409 * levelObjPtr into *framePtrPtr. If levelObjPtr == NULL, the
4410 * level is assumed to be '1'.
4412 * If a newLevelptr int pointer is specified, the function stores
4413 * the absolute level integer value of the new target callframe into
4414 * *newLevelPtr. (this is used to adjust interp->numLevels
4415 * in the implementation of [uplevel], so that [info level] will
4416 * return a correct information).
4418 * This function accepts the 'level' argument in the form
4419 * of the commands [uplevel] and [upvar].
4421 * For a function accepting a relative integer as level suitable
4422 * for implementation of [info level ?level?] check the
4423 * GetCallFrameByInteger() function. */
4424 int Jim_GetCallFrameByLevel(Jim_Interp
*interp
, Jim_Obj
*levelObjPtr
,
4425 Jim_CallFrame
**framePtrPtr
, int *newLevelPtr
)
4429 Jim_CallFrame
*framePtr
;
4431 if (newLevelPtr
) *newLevelPtr
= interp
->numLevels
;
4433 str
= Jim_GetString(levelObjPtr
, NULL
);
4434 if (str
[0] == '#') {
4436 /* speedup for the toplevel (level #0) */
4437 if (str
[1] == '0' && str
[2] == '\0') {
4438 if (newLevelPtr
) *newLevelPtr
= 0;
4439 *framePtrPtr
= interp
->topFramePtr
;
4443 level
= strtol(str
+1, &endptr
, 0);
4444 if (str
[1] == '\0' || endptr
[0] != '\0' || level
< 0)
4446 /* An 'absolute' level is converted into the
4447 * 'number of levels to go back' format. */
4448 level
= interp
->numLevels
- level
;
4449 if (level
< 0) goto badlevel
;
4451 if (Jim_GetLong(interp
, levelObjPtr
, &level
) != JIM_OK
|| level
< 0)
4455 str
= "1"; /* Needed to format the error message. */
4459 framePtr
= interp
->framePtr
;
4460 if (newLevelPtr
) *newLevelPtr
= (*newLevelPtr
)-level
;
4462 framePtr
= framePtr
->parentCallFrame
;
4463 if (framePtr
== NULL
) goto badlevel
;
4465 *framePtrPtr
= framePtr
;
4468 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4469 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4470 "bad level \"", str
, "\"", NULL
);
4474 /* Similar to Jim_GetCallFrameByLevel() but the level is specified
4475 * as a relative integer like in the [info level ?level?] command. */
4476 static int JimGetCallFrameByInteger(Jim_Interp
*interp
, Jim_Obj
*levelObjPtr
,
4477 Jim_CallFrame
**framePtrPtr
)
4480 jim_wide relLevel
; /* level relative to the current one. */
4481 Jim_CallFrame
*framePtr
;
4483 if (Jim_GetWide(interp
, levelObjPtr
, &level
) != JIM_OK
)
4486 /* An 'absolute' level is converted into the
4487 * 'number of levels to go back' format. */
4488 relLevel
= interp
->numLevels
- level
;
4493 framePtr
= interp
->framePtr
;
4494 while (relLevel
--) {
4495 framePtr
= framePtr
->parentCallFrame
;
4496 if (framePtr
== NULL
) goto badlevel
;
4498 *framePtrPtr
= framePtr
;
4501 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4502 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4503 "bad level \"", Jim_GetString(levelObjPtr
, NULL
), "\"", NULL
);
4507 static void JimSetErrorFileName(Jim_Interp
*interp
, char *filename
)
4509 Jim_Free((void*)interp
->errorFileName
);
4510 interp
->errorFileName
= Jim_StrDup(filename
);
4513 static void JimSetErrorLineNumber(Jim_Interp
*interp
, int linenr
)
4515 interp
->errorLine
= linenr
;
4518 static void JimResetStackTrace(Jim_Interp
*interp
)
4520 Jim_DecrRefCount(interp
, interp
->stackTrace
);
4521 interp
->stackTrace
= Jim_NewListObj(interp
, NULL
, 0);
4522 Jim_IncrRefCount(interp
->stackTrace
);
4525 static void JimAppendStackTrace(Jim_Interp
*interp
, const char *procname
,
4526 const char *filename
, int linenr
)
4528 if (Jim_IsShared(interp
->stackTrace
)) {
4529 interp
->stackTrace
=
4530 Jim_DuplicateObj(interp
, interp
->stackTrace
);
4531 Jim_IncrRefCount(interp
->stackTrace
);
4533 Jim_ListAppendElement(interp
, interp
->stackTrace
,
4534 Jim_NewStringObj(interp
, procname
, -1));
4535 Jim_ListAppendElement(interp
, interp
->stackTrace
,
4536 Jim_NewStringObj(interp
, filename
, -1));
4537 Jim_ListAppendElement(interp
, interp
->stackTrace
,
4538 Jim_NewIntObj(interp
, linenr
));
4541 int Jim_SetAssocData(Jim_Interp
*interp
, const char *key
, Jim_InterpDeleteProc
*delProc
, void *data
)
4543 AssocDataValue
*assocEntryPtr
= (AssocDataValue
*)Jim_Alloc(sizeof(AssocDataValue
));
4544 assocEntryPtr
->delProc
= delProc
;
4545 assocEntryPtr
->data
= data
;
4546 return Jim_AddHashEntry(&interp
->assocData
, key
, assocEntryPtr
);
4549 void *Jim_GetAssocData(Jim_Interp
*interp
, const char *key
)
4551 Jim_HashEntry
*entryPtr
= Jim_FindHashEntry(&interp
->assocData
, key
);
4552 if (entryPtr
!= NULL
) {
4553 AssocDataValue
*assocEntryPtr
= (AssocDataValue
*)entryPtr
->val
;
4554 return assocEntryPtr
->data
;
4559 int Jim_DeleteAssocData(Jim_Interp
*interp
, const char *key
)
4561 return Jim_DeleteHashEntry(&interp
->assocData
, key
);
4564 int Jim_GetExitCode(Jim_Interp
*interp
) {
4565 return interp
->exitCode
;
4568 void *Jim_SetStdin(Jim_Interp
*interp
, void *fp
)
4570 if (fp
!= NULL
) interp
->cookie_stdin
= fp
;
4571 return interp
->cookie_stdin
;
4574 void *Jim_SetStdout(Jim_Interp
*interp
, void *fp
)
4576 if (fp
!= NULL
) interp
->cookie_stdout
= fp
;
4577 return interp
->cookie_stdout
;
4580 void *Jim_SetStderr(Jim_Interp
*interp
, void *fp
)
4582 if (fp
!= NULL
) interp
->cookie_stderr
= fp
;
4583 return interp
->cookie_stderr
;
4586 /* -----------------------------------------------------------------------------
4588 * Every interpreter has an hash table where to put shared dynamically
4589 * allocate strings that are likely to be used a lot of times.
4590 * For example, in the 'source' object type, there is a pointer to
4591 * the filename associated with that object. Every script has a lot
4592 * of this objects with the identical file name, so it is wise to share
4595 * The API is trivial: Jim_GetSharedString(interp, "foobar")
4596 * returns the pointer to the shared string. Every time a reference
4597 * to the string is no longer used, the user should call
4598 * Jim_ReleaseSharedString(interp, stringPointer). Once no one is using
4599 * a given string, it is removed from the hash table.
4600 * ---------------------------------------------------------------------------*/
4601 const char *Jim_GetSharedString(Jim_Interp
*interp
, const char *str
)
4603 Jim_HashEntry
*he
= Jim_FindHashEntry(&interp
->sharedStrings
, str
);
4606 char *strCopy
= Jim_StrDup(str
);
4608 Jim_AddHashEntry(&interp
->sharedStrings
, strCopy
, (void*)1);
4611 long refCount
= (long) he
->val
;
4614 he
->val
= (void*) refCount
;
4619 void Jim_ReleaseSharedString(Jim_Interp
*interp
, const char *str
)
4622 Jim_HashEntry
*he
= Jim_FindHashEntry(&interp
->sharedStrings
, str
);
4625 Jim_Panic(interp
,"Jim_ReleaseSharedString called with "
4626 "unknown shared string '%s'", str
);
4627 refCount
= (long) he
->val
;
4629 if (refCount
== 0) {
4630 Jim_DeleteHashEntry(&interp
->sharedStrings
, str
);
4632 he
->val
= (void*) refCount
;
4636 /* -----------------------------------------------------------------------------
4638 * ---------------------------------------------------------------------------*/
4639 #define JIM_INTEGER_SPACE 24
4641 static void UpdateStringOfInt(struct Jim_Obj
*objPtr
);
4642 static int SetIntFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
, int flags
);
4644 static Jim_ObjType intObjType
= {
4652 void UpdateStringOfInt(struct Jim_Obj
*objPtr
)
4655 char buf
[JIM_INTEGER_SPACE
+1];
4657 len
= Jim_WideToString(buf
, objPtr
->internalRep
.wideValue
);
4658 objPtr
->bytes
= Jim_Alloc(len
+1);
4659 memcpy(objPtr
->bytes
, buf
, len
+1);
4660 objPtr
->length
= len
;
4663 int SetIntFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
, int flags
)
4668 /* Get the string representation */
4669 str
= Jim_GetString(objPtr
, NULL
);
4670 /* Try to convert into a jim_wide */
4671 if (Jim_StringToWide(str
, &wideValue
, 0) != JIM_OK
) {
4672 if (flags
& JIM_ERRMSG
) {
4673 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4674 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4675 "expected integer but got \"", str
, "\"", NULL
);
4679 if ((wideValue
== JIM_WIDE_MIN
|| wideValue
== JIM_WIDE_MAX
) &&
4681 Jim_SetResultString(interp
,
4682 "Integer value too big to be represented", -1);
4685 /* Free the old internal repr and set the new one. */
4686 Jim_FreeIntRep(interp
, objPtr
);
4687 objPtr
->typePtr
= &intObjType
;
4688 objPtr
->internalRep
.wideValue
= wideValue
;
4692 int Jim_GetWide(Jim_Interp
*interp
, Jim_Obj
*objPtr
, jim_wide
*widePtr
)
4694 if (objPtr
->typePtr
!= &intObjType
&&
4695 SetIntFromAny(interp
, objPtr
, JIM_ERRMSG
) == JIM_ERR
)
4697 *widePtr
= objPtr
->internalRep
.wideValue
;
4701 /* Get a wide but does not set an error if the format is bad. */
4702 static int JimGetWideNoErr(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
4705 if (objPtr
->typePtr
!= &intObjType
&&
4706 SetIntFromAny(interp
, objPtr
, JIM_NONE
) == JIM_ERR
)
4708 *widePtr
= objPtr
->internalRep
.wideValue
;
4712 int Jim_GetLong(Jim_Interp
*interp
, Jim_Obj
*objPtr
, long *longPtr
)
4717 retval
= Jim_GetWide(interp
, objPtr
, &wideValue
);
4718 if (retval
== JIM_OK
) {
4719 *longPtr
= (long) wideValue
;
4725 void Jim_SetWide(Jim_Interp
*interp
, Jim_Obj
*objPtr
, jim_wide wideValue
)
4727 if (Jim_IsShared(objPtr
))
4728 Jim_Panic(interp
,"Jim_SetWide called with shared object");
4729 if (objPtr
->typePtr
!= &intObjType
) {
4730 Jim_FreeIntRep(interp
, objPtr
);
4731 objPtr
->typePtr
= &intObjType
;
4733 Jim_InvalidateStringRep(objPtr
);
4734 objPtr
->internalRep
.wideValue
= wideValue
;
4737 Jim_Obj
*Jim_NewIntObj(Jim_Interp
*interp
, jim_wide wideValue
)
4741 objPtr
= Jim_NewObj(interp
);
4742 objPtr
->typePtr
= &intObjType
;
4743 objPtr
->bytes
= NULL
;
4744 objPtr
->internalRep
.wideValue
= wideValue
;
4748 /* -----------------------------------------------------------------------------
4750 * ---------------------------------------------------------------------------*/
4751 #define JIM_DOUBLE_SPACE 30
4753 static void UpdateStringOfDouble(struct Jim_Obj
*objPtr
);
4754 static int SetDoubleFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
4756 static Jim_ObjType doubleObjType
= {
4760 UpdateStringOfDouble
,
4764 void UpdateStringOfDouble(struct Jim_Obj
*objPtr
)
4767 char buf
[JIM_DOUBLE_SPACE
+1];
4769 len
= Jim_DoubleToString(buf
, objPtr
->internalRep
.doubleValue
);
4770 objPtr
->bytes
= Jim_Alloc(len
+1);
4771 memcpy(objPtr
->bytes
, buf
, len
+1);
4772 objPtr
->length
= len
;
4775 int SetDoubleFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
4780 /* Get the string representation */
4781 str
= Jim_GetString(objPtr
, NULL
);
4782 /* Try to convert into a double */
4783 if (Jim_StringToDouble(str
, &doubleValue
) != JIM_OK
) {
4784 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4785 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4786 "expected number but got '", str
, "'", NULL
);
4789 /* Free the old internal repr and set the new one. */
4790 Jim_FreeIntRep(interp
, objPtr
);
4791 objPtr
->typePtr
= &doubleObjType
;
4792 objPtr
->internalRep
.doubleValue
= doubleValue
;
4796 int Jim_GetDouble(Jim_Interp
*interp
, Jim_Obj
*objPtr
, double *doublePtr
)
4798 if (objPtr
->typePtr
!= &doubleObjType
&&
4799 SetDoubleFromAny(interp
, objPtr
) == JIM_ERR
)
4801 *doublePtr
= objPtr
->internalRep
.doubleValue
;
4805 void Jim_SetDouble(Jim_Interp
*interp
, Jim_Obj
*objPtr
, double doubleValue
)
4807 if (Jim_IsShared(objPtr
))
4808 Jim_Panic(interp
,"Jim_SetDouble called with shared object");
4809 if (objPtr
->typePtr
!= &doubleObjType
) {
4810 Jim_FreeIntRep(interp
, objPtr
);
4811 objPtr
->typePtr
= &doubleObjType
;
4813 Jim_InvalidateStringRep(objPtr
);
4814 objPtr
->internalRep
.doubleValue
= doubleValue
;
4817 Jim_Obj
*Jim_NewDoubleObj(Jim_Interp
*interp
, double doubleValue
)
4821 objPtr
= Jim_NewObj(interp
);
4822 objPtr
->typePtr
= &doubleObjType
;
4823 objPtr
->bytes
= NULL
;
4824 objPtr
->internalRep
.doubleValue
= doubleValue
;
4828 /* -----------------------------------------------------------------------------
4830 * ---------------------------------------------------------------------------*/
4831 static void ListAppendElement(Jim_Obj
*listPtr
, Jim_Obj
*objPtr
);
4832 static void FreeListInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
4833 static void DupListInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
);
4834 static void UpdateStringOfList(struct Jim_Obj
*objPtr
);
4835 static int SetListFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
);
4837 /* Note that while the elements of the list may contain references,
4838 * the list object itself can't. This basically means that the
4839 * list object string representation as a whole can't contain references
4840 * that are not presents in the single elements. */
4841 static Jim_ObjType listObjType
= {
4843 FreeListInternalRep
,
4849 void FreeListInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
4853 for (i
= 0; i
< objPtr
->internalRep
.listValue
.len
; i
++) {
4854 Jim_DecrRefCount(interp
, objPtr
->internalRep
.listValue
.ele
[i
]);
4856 Jim_Free(objPtr
->internalRep
.listValue
.ele
);
4859 void DupListInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
)
4862 JIM_NOTUSED(interp
);
4864 dupPtr
->internalRep
.listValue
.len
= srcPtr
->internalRep
.listValue
.len
;
4865 dupPtr
->internalRep
.listValue
.maxLen
= srcPtr
->internalRep
.listValue
.maxLen
;
4866 dupPtr
->internalRep
.listValue
.ele
=
4867 Jim_Alloc(sizeof(Jim_Obj
*)*srcPtr
->internalRep
.listValue
.maxLen
);
4868 memcpy(dupPtr
->internalRep
.listValue
.ele
, srcPtr
->internalRep
.listValue
.ele
,
4869 sizeof(Jim_Obj
*)*srcPtr
->internalRep
.listValue
.len
);
4870 for (i
= 0; i
< dupPtr
->internalRep
.listValue
.len
; i
++) {
4871 Jim_IncrRefCount(dupPtr
->internalRep
.listValue
.ele
[i
]);
4873 dupPtr
->typePtr
= &listObjType
;
4876 /* The following function checks if a given string can be encoded
4877 * into a list element without any kind of quoting, surrounded by braces,
4878 * or using escapes to quote. */
4879 #define JIM_ELESTR_SIMPLE 0
4880 #define JIM_ELESTR_BRACE 1
4881 #define JIM_ELESTR_QUOTE 2
4882 static int ListElementQuotingType(const char *s
, int len
)
4884 int i
, level
, trySimple
= 1;
4886 /* Try with the SIMPLE case */
4887 if (len
== 0) return JIM_ELESTR_BRACE
;
4888 if (s
[0] == '"' || s
[0] == '{') {
4892 for (i
= 0; i
< len
; i
++) {
4912 return JIM_ELESTR_SIMPLE
;
4915 /* Test if it's possible to do with braces */
4916 if (s
[len
-1] == '\\' ||
4917 s
[len
-1] == ']') return JIM_ELESTR_QUOTE
;
4919 for (i
= 0; i
< len
; i
++) {
4921 case '{': level
++; break;
4923 if (level
< 0) return JIM_ELESTR_QUOTE
;
4927 return JIM_ELESTR_QUOTE
;
4929 if (s
[i
+1] != '\0') i
++;
4934 if (!trySimple
) return JIM_ELESTR_BRACE
;
4935 for (i
= 0; i
< len
; i
++) {
4949 return JIM_ELESTR_BRACE
;
4953 return JIM_ELESTR_SIMPLE
;
4955 return JIM_ELESTR_QUOTE
;
4958 /* Returns the malloc-ed representation of a string
4959 * using backslash to quote special chars. */
4960 char *BackslashQuoteString(const char *s
, int len
, int *qlenPtr
)
4962 char *q
= Jim_Alloc(len
*2+1), *p
;
4979 case '\n': *p
++ = '\\'; *p
++ = 'n'; s
++; break;
4980 case '\r': *p
++ = '\\'; *p
++ = 'r'; s
++; break;
4981 case '\t': *p
++ = '\\'; *p
++ = 't'; s
++; break;
4982 case '\f': *p
++ = '\\'; *p
++ = 'f'; s
++; break;
4983 case '\v': *p
++ = '\\'; *p
++ = 'v'; s
++; break;
4994 void UpdateStringOfList(struct Jim_Obj
*objPtr
)
4996 int i
, bufLen
, realLength
;
5000 Jim_Obj
**ele
= objPtr
->internalRep
.listValue
.ele
;
5002 /* (Over) Estimate the space needed. */
5003 quotingType
= Jim_Alloc(sizeof(int)*objPtr
->internalRep
.listValue
.len
+1);
5005 for (i
= 0; i
< objPtr
->internalRep
.listValue
.len
; i
++) {
5008 strRep
= Jim_GetString(ele
[i
], &len
);
5009 quotingType
[i
] = ListElementQuotingType(strRep
, len
);
5010 switch (quotingType
[i
]) {
5011 case JIM_ELESTR_SIMPLE
: bufLen
+= len
; break;
5012 case JIM_ELESTR_BRACE
: bufLen
+= len
+2; break;
5013 case JIM_ELESTR_QUOTE
: bufLen
+= len
*2; break;
5015 bufLen
++; /* elements separator. */
5019 /* Generate the string rep. */
5020 p
= objPtr
->bytes
= Jim_Alloc(bufLen
+1);
5022 for (i
= 0; i
< objPtr
->internalRep
.listValue
.len
; i
++) {
5024 const char *strRep
= Jim_GetString(ele
[i
], &len
);
5027 switch(quotingType
[i
]) {
5028 case JIM_ELESTR_SIMPLE
:
5029 memcpy(p
, strRep
, len
);
5033 case JIM_ELESTR_BRACE
:
5035 memcpy(p
, strRep
, len
);
5038 realLength
+= len
+2;
5040 case JIM_ELESTR_QUOTE
:
5041 q
= BackslashQuoteString(strRep
, len
, &qlen
);
5048 /* Add a separating space */
5049 if (i
+1 != objPtr
->internalRep
.listValue
.len
) {
5054 *p
= '\0'; /* nul term. */
5055 objPtr
->length
= realLength
;
5056 Jim_Free(quotingType
);
5059 int SetListFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
)
5061 struct JimParserCtx parser
;
5065 /* Get the string representation */
5066 str
= Jim_GetString(objPtr
, &strLen
);
5068 /* Free the old internal repr just now and initialize the
5069 * new one just now. The string->list conversion can't fail. */
5070 Jim_FreeIntRep(interp
, objPtr
);
5071 objPtr
->typePtr
= &listObjType
;
5072 objPtr
->internalRep
.listValue
.len
= 0;
5073 objPtr
->internalRep
.listValue
.maxLen
= 0;
5074 objPtr
->internalRep
.listValue
.ele
= NULL
;
5076 /* Convert into a list */
5077 JimParserInit(&parser
, str
, strLen
, 1);
5078 while(!JimParserEof(&parser
)) {
5081 Jim_Obj
*elementPtr
;
5083 JimParseList(&parser
);
5084 if (JimParserTtype(&parser
) != JIM_TT_STR
&&
5085 JimParserTtype(&parser
) != JIM_TT_ESC
)
5087 token
= JimParserGetToken(&parser
, &tokenLen
, &type
, NULL
);
5088 elementPtr
= Jim_NewStringObjNoAlloc(interp
, token
, tokenLen
);
5089 ListAppendElement(objPtr
, elementPtr
);
5094 Jim_Obj
*Jim_NewListObj(Jim_Interp
*interp
, Jim_Obj
*const *elements
,
5100 objPtr
= Jim_NewObj(interp
);
5101 objPtr
->typePtr
= &listObjType
;
5102 objPtr
->bytes
= NULL
;
5103 objPtr
->internalRep
.listValue
.ele
= NULL
;
5104 objPtr
->internalRep
.listValue
.len
= 0;
5105 objPtr
->internalRep
.listValue
.maxLen
= 0;
5106 for (i
= 0; i
< len
; i
++) {
5107 ListAppendElement(objPtr
, elements
[i
]);
5112 /* Return a vector of Jim_Obj with the elements of a Jim list, and the
5113 * length of the vector. Note that the user of this function should make
5114 * sure that the list object can't shimmer while the vector returned
5115 * is in use, this vector is the one stored inside the internal representation
5116 * of the list object. This function is not exported, extensions should
5117 * always access to the List object elements using Jim_ListIndex(). */
5118 static void JimListGetElements(Jim_Interp
*interp
, Jim_Obj
*listObj
, int *argc
,
5121 Jim_ListLength(interp
, listObj
, argc
);
5122 assert(listObj
->typePtr
== &listObjType
);
5123 *listVec
= listObj
->internalRep
.listValue
.ele
;
5126 /* ListSortElements type values */
5127 enum {JIM_LSORT_ASCII
, JIM_LSORT_NOCASE
, JIM_LSORT_ASCII_DECR
,
5128 JIM_LSORT_NOCASE_DECR
};
5130 /* Sort the internal rep of a list. */
5131 static int ListSortString(Jim_Obj
**lhsObj
, Jim_Obj
**rhsObj
)
5133 return Jim_StringCompareObj(*lhsObj
, *rhsObj
, 0);
5136 static int ListSortStringDecr(Jim_Obj
**lhsObj
, Jim_Obj
**rhsObj
)
5138 return Jim_StringCompareObj(*lhsObj
, *rhsObj
, 0) * -1;
5141 static int ListSortStringNoCase(Jim_Obj
**lhsObj
, Jim_Obj
**rhsObj
)
5143 return Jim_StringCompareObj(*lhsObj
, *rhsObj
, 1);
5146 static int ListSortStringNoCaseDecr(Jim_Obj
**lhsObj
, Jim_Obj
**rhsObj
)
5148 return Jim_StringCompareObj(*lhsObj
, *rhsObj
, 1) * -1;
5151 /* Sort a list *in place*. MUST be called with non-shared objects. */
5152 static void ListSortElements(Jim_Interp
*interp
, Jim_Obj
*listObjPtr
, int type
)
5154 typedef int (qsort_comparator
)(const void *, const void *);
5155 int (*fn
)(Jim_Obj
**, Jim_Obj
**);
5159 if (Jim_IsShared(listObjPtr
))
5160 Jim_Panic(interp
,"Jim_ListSortElements called with shared object");
5161 if (listObjPtr
->typePtr
!= &listObjType
)
5162 SetListFromAny(interp
, listObjPtr
);
5164 vector
= listObjPtr
->internalRep
.listValue
.ele
;
5165 len
= listObjPtr
->internalRep
.listValue
.len
;
5167 case JIM_LSORT_ASCII
: fn
= ListSortString
; break;
5168 case JIM_LSORT_NOCASE
: fn
= ListSortStringNoCase
; break;
5169 case JIM_LSORT_ASCII_DECR
: fn
= ListSortStringDecr
; break;
5170 case JIM_LSORT_NOCASE_DECR
: fn
= ListSortStringNoCaseDecr
; break;
5172 fn
= NULL
; /* avoid warning */
5173 Jim_Panic(interp
,"ListSort called with invalid sort type");
5175 qsort(vector
, len
, sizeof(Jim_Obj
*), (qsort_comparator
*)fn
);
5176 Jim_InvalidateStringRep(listObjPtr
);
5179 /* This is the low-level function to append an element to a list.
5180 * The higher-level Jim_ListAppendElement() performs shared object
5181 * check and invalidate the string repr. This version is used
5182 * in the internals of the List Object and is not exported.
5184 * NOTE: this function can be called only against objects
5185 * with internal type of List. */
5186 void ListAppendElement(Jim_Obj
*listPtr
, Jim_Obj
*objPtr
)
5188 int requiredLen
= listPtr
->internalRep
.listValue
.len
+ 1;
5190 if (requiredLen
> listPtr
->internalRep
.listValue
.maxLen
) {
5191 int maxLen
= requiredLen
* 2;
5193 listPtr
->internalRep
.listValue
.ele
=
5194 Jim_Realloc(listPtr
->internalRep
.listValue
.ele
,
5195 sizeof(Jim_Obj
*)*maxLen
);
5196 listPtr
->internalRep
.listValue
.maxLen
= maxLen
;
5198 listPtr
->internalRep
.listValue
.ele
[listPtr
->internalRep
.listValue
.len
] =
5200 listPtr
->internalRep
.listValue
.len
++;
5201 Jim_IncrRefCount(objPtr
);
5204 /* This is the low-level function to insert elements into a list.
5205 * The higher-level Jim_ListInsertElements() performs shared object
5206 * check and invalidate the string repr. This version is used
5207 * in the internals of the List Object and is not exported.
5209 * NOTE: this function can be called only against objects
5210 * with internal type of List. */
5211 void ListInsertElements(Jim_Obj
*listPtr
, int index
, int elemc
,
5212 Jim_Obj
*const *elemVec
)
5214 int currentLen
= listPtr
->internalRep
.listValue
.len
;
5215 int requiredLen
= currentLen
+ elemc
;
5219 if (requiredLen
> listPtr
->internalRep
.listValue
.maxLen
) {
5220 int maxLen
= requiredLen
* 2;
5222 listPtr
->internalRep
.listValue
.ele
=
5223 Jim_Realloc(listPtr
->internalRep
.listValue
.ele
,
5224 sizeof(Jim_Obj
*)*maxLen
);
5225 listPtr
->internalRep
.listValue
.maxLen
= maxLen
;
5227 point
= listPtr
->internalRep
.listValue
.ele
+ index
;
5228 memmove(point
+elemc
, point
, (currentLen
-index
) * sizeof(Jim_Obj
*));
5229 for (i
=0; i
< elemc
; ++i
) {
5230 point
[i
] = elemVec
[i
];
5231 Jim_IncrRefCount(point
[i
]);
5233 listPtr
->internalRep
.listValue
.len
+= elemc
;
5236 /* Appends every element of appendListPtr into listPtr.
5237 * Both have to be of the list type. */
5238 void ListAppendList(Jim_Obj
*listPtr
, Jim_Obj
*appendListPtr
)
5240 int i
, oldLen
= listPtr
->internalRep
.listValue
.len
;
5241 int appendLen
= appendListPtr
->internalRep
.listValue
.len
;
5242 int requiredLen
= oldLen
+ appendLen
;
5244 if (requiredLen
> listPtr
->internalRep
.listValue
.maxLen
) {
5245 int maxLen
= requiredLen
* 2;
5247 listPtr
->internalRep
.listValue
.ele
=
5248 Jim_Realloc(listPtr
->internalRep
.listValue
.ele
,
5249 sizeof(Jim_Obj
*)*maxLen
);
5250 listPtr
->internalRep
.listValue
.maxLen
= maxLen
;
5252 for (i
= 0; i
< appendLen
; i
++) {
5253 Jim_Obj
*objPtr
= appendListPtr
->internalRep
.listValue
.ele
[i
];
5254 listPtr
->internalRep
.listValue
.ele
[oldLen
+i
] = objPtr
;
5255 Jim_IncrRefCount(objPtr
);
5257 listPtr
->internalRep
.listValue
.len
+= appendLen
;
5260 void Jim_ListAppendElement(Jim_Interp
*interp
, Jim_Obj
*listPtr
, Jim_Obj
*objPtr
)
5262 if (Jim_IsShared(listPtr
))
5263 Jim_Panic(interp
,"Jim_ListAppendElement called with shared object");
5264 if (listPtr
->typePtr
!= &listObjType
)
5265 SetListFromAny(interp
, listPtr
);
5266 Jim_InvalidateStringRep(listPtr
);
5267 ListAppendElement(listPtr
, objPtr
);
5270 void Jim_ListAppendList(Jim_Interp
*interp
, Jim_Obj
*listPtr
, Jim_Obj
*appendListPtr
)
5272 if (Jim_IsShared(listPtr
))
5273 Jim_Panic(interp
,"Jim_ListAppendList called with shared object");
5274 if (listPtr
->typePtr
!= &listObjType
)
5275 SetListFromAny(interp
, listPtr
);
5276 Jim_InvalidateStringRep(listPtr
);
5277 ListAppendList(listPtr
, appendListPtr
);
5280 void Jim_ListLength(Jim_Interp
*interp
, Jim_Obj
*listPtr
, int *intPtr
)
5282 if (listPtr
->typePtr
!= &listObjType
)
5283 SetListFromAny(interp
, listPtr
);
5284 *intPtr
= listPtr
->internalRep
.listValue
.len
;
5287 void Jim_ListInsertElements(Jim_Interp
*interp
, Jim_Obj
*listPtr
, int index
,
5288 int objc
, Jim_Obj
*const *objVec
)
5290 if (Jim_IsShared(listPtr
))
5291 Jim_Panic(interp
,"Jim_ListInsertElement called with shared object");
5292 if (listPtr
->typePtr
!= &listObjType
)
5293 SetListFromAny(interp
, listPtr
);
5294 if (index
>= 0 && index
> listPtr
->internalRep
.listValue
.len
)
5295 index
= listPtr
->internalRep
.listValue
.len
;
5296 else if (index
< 0 )
5298 Jim_InvalidateStringRep(listPtr
);
5299 ListInsertElements(listPtr
, index
, objc
, objVec
);
5302 int Jim_ListIndex(Jim_Interp
*interp
, Jim_Obj
*listPtr
, int index
,
5303 Jim_Obj
**objPtrPtr
, int flags
)
5305 if (listPtr
->typePtr
!= &listObjType
)
5306 SetListFromAny(interp
, listPtr
);
5307 if ((index
>= 0 && index
>= listPtr
->internalRep
.listValue
.len
) ||
5308 (index
< 0 && (-index
-1) >= listPtr
->internalRep
.listValue
.len
)) {
5309 if (flags
& JIM_ERRMSG
) {
5310 Jim_SetResultString(interp
,
5311 "list index out of range", -1);
5316 index
= listPtr
->internalRep
.listValue
.len
+index
;
5317 *objPtrPtr
= listPtr
->internalRep
.listValue
.ele
[index
];
5321 static int ListSetIndex(Jim_Interp
*interp
, Jim_Obj
*listPtr
, int index
,
5322 Jim_Obj
*newObjPtr
, int flags
)
5324 if (listPtr
->typePtr
!= &listObjType
)
5325 SetListFromAny(interp
, listPtr
);
5326 if ((index
>= 0 && index
>= listPtr
->internalRep
.listValue
.len
) ||
5327 (index
< 0 && (-index
-1) >= listPtr
->internalRep
.listValue
.len
)) {
5328 if (flags
& JIM_ERRMSG
) {
5329 Jim_SetResultString(interp
,
5330 "list index out of range", -1);
5335 index
= listPtr
->internalRep
.listValue
.len
+index
;
5336 Jim_DecrRefCount(interp
, listPtr
->internalRep
.listValue
.ele
[index
]);
5337 listPtr
->internalRep
.listValue
.ele
[index
] = newObjPtr
;
5338 Jim_IncrRefCount(newObjPtr
);
5342 /* Modify the list stored into the variable named 'varNamePtr'
5343 * setting the element specified by the 'indexc' indexes objects in 'indexv',
5344 * with the new element 'newObjptr'. */
5345 int Jim_SetListIndex(Jim_Interp
*interp
, Jim_Obj
*varNamePtr
,
5346 Jim_Obj
*const *indexv
, int indexc
, Jim_Obj
*newObjPtr
)
5348 Jim_Obj
*varObjPtr
, *objPtr
, *listObjPtr
;
5349 int shared
, i
, index
;
5351 varObjPtr
= objPtr
= Jim_GetVariable(interp
, varNamePtr
, JIM_ERRMSG
);
5354 if ((shared
= Jim_IsShared(objPtr
)))
5355 varObjPtr
= objPtr
= Jim_DuplicateObj(interp
, objPtr
);
5356 for (i
= 0; i
< indexc
-1; i
++) {
5357 listObjPtr
= objPtr
;
5358 if (Jim_GetIndex(interp
, indexv
[i
], &index
) != JIM_OK
)
5360 if (Jim_ListIndex(interp
, listObjPtr
, index
, &objPtr
,
5361 JIM_ERRMSG
) != JIM_OK
) {
5364 if (Jim_IsShared(objPtr
)) {
5365 objPtr
= Jim_DuplicateObj(interp
, objPtr
);
5366 ListSetIndex(interp
, listObjPtr
, index
, objPtr
, JIM_NONE
);
5368 Jim_InvalidateStringRep(listObjPtr
);
5370 if (Jim_GetIndex(interp
, indexv
[indexc
-1], &index
) != JIM_OK
)
5372 if (ListSetIndex(interp
, objPtr
, index
, newObjPtr
, JIM_ERRMSG
) == JIM_ERR
)
5374 Jim_InvalidateStringRep(objPtr
);
5375 Jim_InvalidateStringRep(varObjPtr
);
5376 if (Jim_SetVariable(interp
, varNamePtr
, varObjPtr
) != JIM_OK
)
5378 Jim_SetResult(interp
, varObjPtr
);
5382 Jim_FreeNewObj(interp
, varObjPtr
);
5387 Jim_Obj
*Jim_ConcatObj(Jim_Interp
*interp
, int objc
, Jim_Obj
*const *objv
)
5391 /* If all the objects in objv are lists without string rep.
5392 * it's possible to return a list as result, that's the
5393 * concatenation of all the lists. */
5394 for (i
= 0; i
< objc
; i
++) {
5395 if (objv
[i
]->typePtr
!= &listObjType
|| objv
[i
]->bytes
)
5399 Jim_Obj
*objPtr
= Jim_NewListObj(interp
, NULL
, 0);
5400 for (i
= 0; i
< objc
; i
++)
5401 Jim_ListAppendList(interp
, objPtr
, objv
[i
]);
5404 /* Else... we have to glue strings together */
5405 int len
= 0, objLen
;
5408 /* Compute the length */
5409 for (i
= 0; i
< objc
; i
++) {
5410 Jim_GetString(objv
[i
], &objLen
);
5413 if (objc
) len
+= objc
-1;
5414 /* Create the string rep, and a stinrg object holding it. */
5415 p
= bytes
= Jim_Alloc(len
+1);
5416 for (i
= 0; i
< objc
; i
++) {
5417 const char *s
= Jim_GetString(objv
[i
], &objLen
);
5418 while (objLen
&& (*s
== ' ' || *s
== '\t' || *s
== '\n'))
5420 s
++; objLen
--; len
--;
5422 while (objLen
&& (s
[objLen
-1] == ' ' ||
5423 s
[objLen
-1] == '\n' || s
[objLen
-1] == '\t')) {
5426 memcpy(p
, s
, objLen
);
5428 if (objLen
&& i
+1 != objc
) {
5430 } else if (i
+1 != objc
) {
5431 /* Drop the space calcuated for this
5432 * element that is instead null. */
5437 return Jim_NewStringObjNoAlloc(interp
, bytes
, len
);
5441 /* Returns a list composed of the elements in the specified range.
5442 * first and start are directly accepted as Jim_Objects and
5443 * processed for the end?-index? case. */
5444 Jim_Obj
*Jim_ListRange(Jim_Interp
*interp
, Jim_Obj
*listObjPtr
, Jim_Obj
*firstObjPtr
, Jim_Obj
*lastObjPtr
)
5449 if (Jim_GetIndex(interp
, firstObjPtr
, &first
) != JIM_OK
||
5450 Jim_GetIndex(interp
, lastObjPtr
, &last
) != JIM_OK
)
5452 Jim_ListLength(interp
, listObjPtr
, &len
); /* will convert into list */
5453 first
= JimRelToAbsIndex(len
, first
);
5454 last
= JimRelToAbsIndex(len
, last
);
5455 JimRelToAbsRange(len
, first
, last
, &first
, &last
, &rangeLen
);
5456 return Jim_NewListObj(interp
,
5457 listObjPtr
->internalRep
.listValue
.ele
+first
, rangeLen
);
5460 /* -----------------------------------------------------------------------------
5462 * ---------------------------------------------------------------------------*/
5463 static void FreeDictInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
5464 static void DupDictInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
);
5465 static void UpdateStringOfDict(struct Jim_Obj
*objPtr
);
5466 static int SetDictFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
);
5468 /* Dict HashTable Type.
5470 * Keys and Values are Jim objects. */
5472 unsigned int JimObjectHTHashFunction(const void *key
)
5475 Jim_Obj
*objPtr
= (Jim_Obj
*) key
;
5478 str
= Jim_GetString(objPtr
, &len
);
5479 h
= Jim_GenHashFunction((unsigned char*)str
, len
);
5483 int JimObjectHTKeyCompare(void *privdata
, const void *key1
, const void *key2
)
5485 JIM_NOTUSED(privdata
);
5487 return Jim_StringEqObj((Jim_Obj
*)key1
, (Jim_Obj
*)key2
, 0);
5490 static void JimObjectHTKeyValDestructor(void *interp
, void *val
)
5492 Jim_Obj
*objPtr
= val
;
5494 Jim_DecrRefCount(interp
, objPtr
);
5497 static Jim_HashTableType JimDictHashTableType
= {
5498 JimObjectHTHashFunction
, /* hash function */
5501 JimObjectHTKeyCompare
, /* key compare */
5502 (void(*)(void*, const void*)) /* ATTENTION: const cast */
5503 JimObjectHTKeyValDestructor
, /* key destructor */
5504 JimObjectHTKeyValDestructor
/* val destructor */
5507 /* Note that while the elements of the dict may contain references,
5508 * the list object itself can't. This basically means that the
5509 * dict object string representation as a whole can't contain references
5510 * that are not presents in the single elements. */
5511 static Jim_ObjType dictObjType
= {
5513 FreeDictInternalRep
,
5519 void FreeDictInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
5521 JIM_NOTUSED(interp
);
5523 Jim_FreeHashTable(objPtr
->internalRep
.ptr
);
5524 Jim_Free(objPtr
->internalRep
.ptr
);
5527 void DupDictInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
)
5529 Jim_HashTable
*ht
, *dupHt
;
5530 Jim_HashTableIterator
*htiter
;
5533 /* Create a new hash table */
5534 ht
= srcPtr
->internalRep
.ptr
;
5535 dupHt
= Jim_Alloc(sizeof(*dupHt
));
5536 Jim_InitHashTable(dupHt
, &JimDictHashTableType
, interp
);
5538 Jim_ExpandHashTable(dupHt
, ht
->size
);
5539 /* Copy every element from the source to the dup hash table */
5540 htiter
= Jim_GetHashTableIterator(ht
);
5541 while ((he
= Jim_NextHashEntry(htiter
)) != NULL
) {
5542 const Jim_Obj
*keyObjPtr
= he
->key
;
5543 Jim_Obj
*valObjPtr
= he
->val
;
5545 Jim_IncrRefCount((Jim_Obj
*)keyObjPtr
); /* ATTENTION: const cast */
5546 Jim_IncrRefCount(valObjPtr
);
5547 Jim_AddHashEntry(dupHt
, keyObjPtr
, valObjPtr
);
5549 Jim_FreeHashTableIterator(htiter
);
5551 dupPtr
->internalRep
.ptr
= dupHt
;
5552 dupPtr
->typePtr
= &dictObjType
;
5555 void UpdateStringOfDict(struct Jim_Obj
*objPtr
)
5557 int i
, bufLen
, realLength
;
5560 int *quotingType
, objc
;
5562 Jim_HashTableIterator
*htiter
;
5566 /* Trun the hash table into a flat vector of Jim_Objects. */
5567 ht
= objPtr
->internalRep
.ptr
;
5569 objv
= Jim_Alloc(objc
*sizeof(Jim_Obj
*));
5570 htiter
= Jim_GetHashTableIterator(ht
);
5572 while ((he
= Jim_NextHashEntry(htiter
)) != NULL
) {
5573 objv
[i
++] = (Jim_Obj
*)he
->key
; /* ATTENTION: const cast */
5574 objv
[i
++] = he
->val
;
5576 Jim_FreeHashTableIterator(htiter
);
5577 /* (Over) Estimate the space needed. */
5578 quotingType
= Jim_Alloc(sizeof(int)*objc
);
5580 for (i
= 0; i
< objc
; i
++) {
5583 strRep
= Jim_GetString(objv
[i
], &len
);
5584 quotingType
[i
] = ListElementQuotingType(strRep
, len
);
5585 switch (quotingType
[i
]) {
5586 case JIM_ELESTR_SIMPLE
: bufLen
+= len
; break;
5587 case JIM_ELESTR_BRACE
: bufLen
+= len
+2; break;
5588 case JIM_ELESTR_QUOTE
: bufLen
+= len
*2; break;
5590 bufLen
++; /* elements separator. */
5594 /* Generate the string rep. */
5595 p
= objPtr
->bytes
= Jim_Alloc(bufLen
+1);
5597 for (i
= 0; i
< objc
; i
++) {
5599 const char *strRep
= Jim_GetString(objv
[i
], &len
);
5602 switch(quotingType
[i
]) {
5603 case JIM_ELESTR_SIMPLE
:
5604 memcpy(p
, strRep
, len
);
5608 case JIM_ELESTR_BRACE
:
5610 memcpy(p
, strRep
, len
);
5613 realLength
+= len
+2;
5615 case JIM_ELESTR_QUOTE
:
5616 q
= BackslashQuoteString(strRep
, len
, &qlen
);
5623 /* Add a separating space */
5629 *p
= '\0'; /* nul term. */
5630 objPtr
->length
= realLength
;
5631 Jim_Free(quotingType
);
5635 int SetDictFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
)
5637 struct JimParserCtx parser
;
5643 /* Get the string representation */
5644 str
= Jim_GetString(objPtr
, &strLen
);
5646 /* Free the old internal repr just now and initialize the
5647 * new one just now. The string->list conversion can't fail. */
5648 Jim_FreeIntRep(interp
, objPtr
);
5649 ht
= Jim_Alloc(sizeof(*ht
));
5650 Jim_InitHashTable(ht
, &JimDictHashTableType
, interp
);
5651 objPtr
->typePtr
= &dictObjType
;
5652 objPtr
->internalRep
.ptr
= ht
;
5654 /* Convert into a dict */
5655 JimParserInit(&parser
, str
, strLen
, 1);
5657 while(!JimParserEof(&parser
)) {
5661 JimParseList(&parser
);
5662 if (JimParserTtype(&parser
) != JIM_TT_STR
&&
5663 JimParserTtype(&parser
) != JIM_TT_ESC
)
5665 token
= JimParserGetToken(&parser
, &tokenLen
, &type
, NULL
);
5666 objv
[i
++] = Jim_NewStringObjNoAlloc(interp
, token
, tokenLen
);
5669 Jim_IncrRefCount(objv
[0]);
5670 Jim_IncrRefCount(objv
[1]);
5671 if (Jim_AddHashEntry(ht
, objv
[0], objv
[1]) != JIM_OK
) {
5673 he
= Jim_FindHashEntry(ht
, objv
[0]);
5674 Jim_DecrRefCount(interp
, objv
[0]);
5675 /* ATTENTION: const cast */
5676 Jim_DecrRefCount(interp
, (Jim_Obj
*)he
->val
);
5682 Jim_FreeNewObj(interp
, objv
[0]);
5683 objPtr
->typePtr
= NULL
;
5684 Jim_FreeHashTable(ht
);
5685 Jim_SetResultString(interp
, "invalid dictionary value: must be a list with an even number of elements", -1);
5691 /* Dict object API */
5693 /* Add an element to a dict. objPtr must be of the "dict" type.
5694 * The higer-level exported function is Jim_DictAddElement().
5695 * If an element with the specified key already exists, the value
5696 * associated is replaced with the new one.
5698 * if valueObjPtr == NULL, the key is instead removed if it exists. */
5699 static void DictAddElement(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
5700 Jim_Obj
*keyObjPtr
, Jim_Obj
*valueObjPtr
)
5702 Jim_HashTable
*ht
= objPtr
->internalRep
.ptr
;
5704 if (valueObjPtr
== NULL
) { /* unset */
5705 Jim_DeleteHashEntry(ht
, keyObjPtr
);
5708 Jim_IncrRefCount(keyObjPtr
);
5709 Jim_IncrRefCount(valueObjPtr
);
5710 if (Jim_AddHashEntry(ht
, keyObjPtr
, valueObjPtr
) != JIM_OK
) {
5711 Jim_HashEntry
*he
= Jim_FindHashEntry(ht
, keyObjPtr
);
5712 Jim_DecrRefCount(interp
, keyObjPtr
);
5713 /* ATTENTION: const cast */
5714 Jim_DecrRefCount(interp
, (Jim_Obj
*)he
->val
);
5715 he
->val
= valueObjPtr
;
5719 /* Add an element, higher-level interface for DictAddElement().
5720 * If valueObjPtr == NULL, the key is removed if it exists. */
5721 int Jim_DictAddElement(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
5722 Jim_Obj
*keyObjPtr
, Jim_Obj
*valueObjPtr
)
5724 if (Jim_IsShared(objPtr
))
5725 Jim_Panic(interp
,"Jim_DictAddElement called with shared object");
5726 if (objPtr
->typePtr
!= &dictObjType
) {
5727 if (SetDictFromAny(interp
, objPtr
) != JIM_OK
)
5730 DictAddElement(interp
, objPtr
, keyObjPtr
, valueObjPtr
);
5731 Jim_InvalidateStringRep(objPtr
);
5735 Jim_Obj
*Jim_NewDictObj(Jim_Interp
*interp
, Jim_Obj
*const *elements
, int len
)
5741 Jim_Panic(interp
,"Jim_NewDicObj() 'len' argument must be even");
5743 objPtr
= Jim_NewObj(interp
);
5744 objPtr
->typePtr
= &dictObjType
;
5745 objPtr
->bytes
= NULL
;
5746 objPtr
->internalRep
.ptr
= Jim_Alloc(sizeof(Jim_HashTable
));
5747 Jim_InitHashTable(objPtr
->internalRep
.ptr
, &JimDictHashTableType
, interp
);
5748 for (i
= 0; i
< len
; i
+= 2)
5749 DictAddElement(interp
, objPtr
, elements
[i
], elements
[i
+1]);
5753 /* Return the value associated to the specified dict key */
5754 int Jim_DictKey(Jim_Interp
*interp
, Jim_Obj
*dictPtr
, Jim_Obj
*keyPtr
,
5755 Jim_Obj
**objPtrPtr
, int flags
)
5760 if (dictPtr
->typePtr
!= &dictObjType
) {
5761 if (SetDictFromAny(interp
, dictPtr
) != JIM_OK
)
5764 ht
= dictPtr
->internalRep
.ptr
;
5765 if ((he
= Jim_FindHashEntry(ht
, keyPtr
)) == NULL
) {
5766 if (flags
& JIM_ERRMSG
) {
5767 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
5768 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
5769 "key \"", Jim_GetString(keyPtr
, NULL
),
5770 "\" not found in dictionary", NULL
);
5774 *objPtrPtr
= he
->val
;
5778 /* Return the value associated to the specified dict keys */
5779 int Jim_DictKeysVector(Jim_Interp
*interp
, Jim_Obj
*dictPtr
,
5780 Jim_Obj
*const *keyv
, int keyc
, Jim_Obj
**objPtrPtr
, int flags
)
5786 *objPtrPtr
= dictPtr
;
5790 for (i
= 0; i
< keyc
; i
++) {
5791 if (Jim_DictKey(interp
, dictPtr
, keyv
[i
], &objPtr
, flags
)
5796 *objPtrPtr
= objPtr
;
5800 /* Modify the dict stored into the variable named 'varNamePtr'
5801 * setting the element specified by the 'keyc' keys objects in 'keyv',
5802 * with the new value of the element 'newObjPtr'.
5804 * If newObjPtr == NULL the operation is to remove the given key
5805 * from the dictionary. */
5806 int Jim_SetDictKeysVector(Jim_Interp
*interp
, Jim_Obj
*varNamePtr
,
5807 Jim_Obj
*const *keyv
, int keyc
, Jim_Obj
*newObjPtr
)
5809 Jim_Obj
*varObjPtr
, *objPtr
, *dictObjPtr
;
5812 varObjPtr
= objPtr
= Jim_GetVariable(interp
, varNamePtr
, JIM_ERRMSG
);
5813 if (objPtr
== NULL
) {
5814 if (newObjPtr
== NULL
) /* Cannot remove a key from non existing var */
5816 varObjPtr
= objPtr
= Jim_NewDictObj(interp
, NULL
, 0);
5817 if (Jim_SetVariable(interp
, varNamePtr
, objPtr
) != JIM_OK
) {
5818 Jim_FreeNewObj(interp
, varObjPtr
);
5822 if ((shared
= Jim_IsShared(objPtr
)))
5823 varObjPtr
= objPtr
= Jim_DuplicateObj(interp
, objPtr
);
5824 for (i
= 0; i
< keyc
-1; i
++) {
5825 dictObjPtr
= objPtr
;
5827 /* Check if it's a valid dictionary */
5828 if (dictObjPtr
->typePtr
!= &dictObjType
) {
5829 if (SetDictFromAny(interp
, dictObjPtr
) != JIM_OK
)
5832 /* Check if the given key exists. */
5833 Jim_InvalidateStringRep(dictObjPtr
);
5834 if (Jim_DictKey(interp
, dictObjPtr
, keyv
[i
], &objPtr
,
5835 newObjPtr
? JIM_NONE
: JIM_ERRMSG
) == JIM_OK
)
5837 /* This key exists at the current level.
5838 * Make sure it's not shared!. */
5839 if (Jim_IsShared(objPtr
)) {
5840 objPtr
= Jim_DuplicateObj(interp
, objPtr
);
5841 DictAddElement(interp
, dictObjPtr
, keyv
[i
], objPtr
);
5844 /* Key not found. If it's an [unset] operation
5845 * this is an error. Only the last key may not
5847 if (newObjPtr
== NULL
)
5849 /* Otherwise set an empty dictionary
5850 * as key's value. */
5851 objPtr
= Jim_NewDictObj(interp
, NULL
, 0);
5852 DictAddElement(interp
, dictObjPtr
, keyv
[i
], objPtr
);
5855 if (Jim_DictAddElement(interp
, objPtr
, keyv
[keyc
-1], newObjPtr
)
5858 Jim_InvalidateStringRep(objPtr
);
5859 Jim_InvalidateStringRep(varObjPtr
);
5860 if (Jim_SetVariable(interp
, varNamePtr
, varObjPtr
) != JIM_OK
)
5862 Jim_SetResult(interp
, varObjPtr
);
5866 Jim_FreeNewObj(interp
, varObjPtr
);
5871 /* -----------------------------------------------------------------------------
5873 * ---------------------------------------------------------------------------*/
5874 static void UpdateStringOfIndex(struct Jim_Obj
*objPtr
);
5875 static int SetIndexFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
);
5877 static Jim_ObjType indexObjType
= {
5881 UpdateStringOfIndex
,
5885 void UpdateStringOfIndex(struct Jim_Obj
*objPtr
)
5888 char buf
[JIM_INTEGER_SPACE
+1];
5890 if (objPtr
->internalRep
.indexValue
>= 0)
5891 len
= sprintf(buf
, "%d", objPtr
->internalRep
.indexValue
);
5892 else if (objPtr
->internalRep
.indexValue
== -1)
5893 len
= sprintf(buf
, "end");
5895 len
= sprintf(buf
, "end%d", objPtr
->internalRep
.indexValue
+1);
5897 objPtr
->bytes
= Jim_Alloc(len
+1);
5898 memcpy(objPtr
->bytes
, buf
, len
+1);
5899 objPtr
->length
= len
;
5902 int SetIndexFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
5907 /* Get the string representation */
5908 str
= Jim_GetString(objPtr
, NULL
);
5909 /* Try to convert into an index */
5910 if (!strcmp(str
, "end")) {
5914 if (!strncmp(str
, "end-", 4)) {
5918 if (Jim_StringToIndex(str
, &index
) != JIM_OK
) {
5919 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
5920 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
5921 "bad index \"", Jim_GetString(objPtr
, NULL
), "\": "
5922 "must be integer or end?-integer?", NULL
);
5931 } else if (!end
&& index
< 0)
5933 /* Free the old internal repr and set the new one. */
5934 Jim_FreeIntRep(interp
, objPtr
);
5935 objPtr
->typePtr
= &indexObjType
;
5936 objPtr
->internalRep
.indexValue
= index
;
5940 int Jim_GetIndex(Jim_Interp
*interp
, Jim_Obj
*objPtr
, int *indexPtr
)
5942 /* Avoid shimmering if the object is an integer. */
5943 if (objPtr
->typePtr
== &intObjType
) {
5944 jim_wide val
= objPtr
->internalRep
.wideValue
;
5945 if (!(val
< LONG_MIN
) && !(val
> LONG_MAX
)) {
5946 *indexPtr
= (val
< 0) ? -INT_MAX
: (long)val
;;
5950 if (objPtr
->typePtr
!= &indexObjType
&&
5951 SetIndexFromAny(interp
, objPtr
) == JIM_ERR
)
5953 *indexPtr
= objPtr
->internalRep
.indexValue
;
5957 /* -----------------------------------------------------------------------------
5958 * Return Code Object.
5959 * ---------------------------------------------------------------------------*/
5961 static int SetReturnCodeFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
5963 static Jim_ObjType returnCodeObjType
= {
5971 int SetReturnCodeFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
5974 int strLen
, returnCode
;
5977 /* Get the string representation */
5978 str
= Jim_GetString(objPtr
, &strLen
);
5979 /* Try to convert into an integer */
5980 if (JimGetWideNoErr(interp
, objPtr
, &wideValue
) != JIM_ERR
)
5981 returnCode
= (int) wideValue
;
5982 else if (!JimStringCompare(str
, strLen
, "ok", 2, JIM_NOCASE
))
5983 returnCode
= JIM_OK
;
5984 else if (!JimStringCompare(str
, strLen
, "error", 5, JIM_NOCASE
))
5985 returnCode
= JIM_ERR
;
5986 else if (!JimStringCompare(str
, strLen
, "return", 6, JIM_NOCASE
))
5987 returnCode
= JIM_RETURN
;
5988 else if (!JimStringCompare(str
, strLen
, "break", 5, JIM_NOCASE
))
5989 returnCode
= JIM_BREAK
;
5990 else if (!JimStringCompare(str
, strLen
, "continue", 8, JIM_NOCASE
))
5991 returnCode
= JIM_CONTINUE
;
5992 else if (!JimStringCompare(str
, strLen
, "eval", 4, JIM_NOCASE
))
5993 returnCode
= JIM_EVAL
;
5994 else if (!JimStringCompare(str
, strLen
, "exit", 4, JIM_NOCASE
))
5995 returnCode
= JIM_EXIT
;
5997 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
5998 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
5999 "expected return code but got '", str
, "'",
6003 /* Free the old internal repr and set the new one. */
6004 Jim_FreeIntRep(interp
, objPtr
);
6005 objPtr
->typePtr
= &returnCodeObjType
;
6006 objPtr
->internalRep
.returnCode
= returnCode
;
6010 int Jim_GetReturnCode(Jim_Interp
*interp
, Jim_Obj
*objPtr
, int *intPtr
)
6012 if (objPtr
->typePtr
!= &returnCodeObjType
&&
6013 SetReturnCodeFromAny(interp
, objPtr
) == JIM_ERR
)
6015 *intPtr
= objPtr
->internalRep
.returnCode
;
6019 /* -----------------------------------------------------------------------------
6020 * Expression Parsing
6021 * ---------------------------------------------------------------------------*/
6022 static int JimParseExprOperator(struct JimParserCtx
*pc
);
6023 static int JimParseExprNumber(struct JimParserCtx
*pc
);
6024 static int JimParseExprIrrational(struct JimParserCtx
*pc
);
6026 /* Exrp's Stack machine operators opcodes. */
6028 /* Binary operators (numbers) */
6029 #define JIM_EXPROP_BINARY_NUM_FIRST 0 /* first */
6030 #define JIM_EXPROP_MUL 0
6031 #define JIM_EXPROP_DIV 1
6032 #define JIM_EXPROP_MOD 2
6033 #define JIM_EXPROP_SUB 3
6034 #define JIM_EXPROP_ADD 4
6035 #define JIM_EXPROP_LSHIFT 5
6036 #define JIM_EXPROP_RSHIFT 6
6037 #define JIM_EXPROP_ROTL 7
6038 #define JIM_EXPROP_ROTR 8
6039 #define JIM_EXPROP_LT 9
6040 #define JIM_EXPROP_GT 10
6041 #define JIM_EXPROP_LTE 11
6042 #define JIM_EXPROP_GTE 12
6043 #define JIM_EXPROP_NUMEQ 13
6044 #define JIM_EXPROP_NUMNE 14
6045 #define JIM_EXPROP_BITAND 15
6046 #define JIM_EXPROP_BITXOR 16
6047 #define JIM_EXPROP_BITOR 17
6048 #define JIM_EXPROP_LOGICAND 18
6049 #define JIM_EXPROP_LOGICOR 19
6050 #define JIM_EXPROP_LOGICAND_LEFT 20
6051 #define JIM_EXPROP_LOGICOR_LEFT 21
6052 #define JIM_EXPROP_POW 22
6053 #define JIM_EXPROP_BINARY_NUM_LAST 22 /* last */
6055 /* Binary operators (strings) */
6056 #define JIM_EXPROP_STREQ 23
6057 #define JIM_EXPROP_STRNE 24
6059 /* Unary operators (numbers) */
6060 #define JIM_EXPROP_NOT 25
6061 #define JIM_EXPROP_BITNOT 26
6062 #define JIM_EXPROP_UNARYMINUS 27
6063 #define JIM_EXPROP_UNARYPLUS 28
6064 #define JIM_EXPROP_LOGICAND_RIGHT 29
6065 #define JIM_EXPROP_LOGICOR_RIGHT 30
6067 /* Ternary operators */
6068 #define JIM_EXPROP_TERNARY 31
6071 #define JIM_EXPROP_NUMBER 32
6072 #define JIM_EXPROP_COMMAND 33
6073 #define JIM_EXPROP_VARIABLE 34
6074 #define JIM_EXPROP_DICTSUGAR 35
6075 #define JIM_EXPROP_SUBST 36
6076 #define JIM_EXPROP_STRING 37
6078 /* Operators table */
6079 typedef struct Jim_ExprOperator
{
6086 /* name - precedence - arity - opcode */
6087 static struct Jim_ExprOperator Jim_ExprOperators
[] = {
6088 {"!", 300, 1, JIM_EXPROP_NOT
},
6089 {"~", 300, 1, JIM_EXPROP_BITNOT
},
6090 {"unarymin", 300, 1, JIM_EXPROP_UNARYMINUS
},
6091 {"unaryplus", 300, 1, JIM_EXPROP_UNARYPLUS
},
6093 {"**", 250, 2, JIM_EXPROP_POW
},
6095 {"*", 200, 2, JIM_EXPROP_MUL
},
6096 {"/", 200, 2, JIM_EXPROP_DIV
},
6097 {"%", 200, 2, JIM_EXPROP_MOD
},
6099 {"-", 100, 2, JIM_EXPROP_SUB
},
6100 {"+", 100, 2, JIM_EXPROP_ADD
},
6102 {"<<<", 90, 3, JIM_EXPROP_ROTL
},
6103 {">>>", 90, 3, JIM_EXPROP_ROTR
},
6104 {"<<", 90, 2, JIM_EXPROP_LSHIFT
},
6105 {">>", 90, 2, JIM_EXPROP_RSHIFT
},
6107 {"<", 80, 2, JIM_EXPROP_LT
},
6108 {">", 80, 2, JIM_EXPROP_GT
},
6109 {"<=", 80, 2, JIM_EXPROP_LTE
},
6110 {">=", 80, 2, JIM_EXPROP_GTE
},
6112 {"==", 70, 2, JIM_EXPROP_NUMEQ
},
6113 {"!=", 70, 2, JIM_EXPROP_NUMNE
},
6115 {"eq", 60, 2, JIM_EXPROP_STREQ
},
6116 {"ne", 60, 2, JIM_EXPROP_STRNE
},
6118 {"&", 50, 2, JIM_EXPROP_BITAND
},
6119 {"^", 49, 2, JIM_EXPROP_BITXOR
},
6120 {"|", 48, 2, JIM_EXPROP_BITOR
},
6122 {"&&", 10, 2, JIM_EXPROP_LOGICAND
},
6123 {"||", 10, 2, JIM_EXPROP_LOGICOR
},
6125 {"?", 5, 3, JIM_EXPROP_TERNARY
},
6126 /* private operators */
6127 {NULL
, 10, 2, JIM_EXPROP_LOGICAND_LEFT
},
6128 {NULL
, 10, 1, JIM_EXPROP_LOGICAND_RIGHT
},
6129 {NULL
, 10, 2, JIM_EXPROP_LOGICOR_LEFT
},
6130 {NULL
, 10, 1, JIM_EXPROP_LOGICOR_RIGHT
},
6133 #define JIM_EXPR_OPERATORS_NUM \
6134 (sizeof(Jim_ExprOperators)/sizeof(struct Jim_ExprOperator))
6136 int JimParseExpression(struct JimParserCtx
*pc
)
6138 /* Discard spaces and quoted newline */
6139 while(*(pc
->p
) == ' ' ||
6143 (*(pc
->p
) == '\\' && *(pc
->p
+1) == '\n')) {
6148 pc
->tstart
= pc
->tend
= pc
->p
;
6149 pc
->tline
= pc
->linenr
;
6150 pc
->tt
= JIM_TT_EOL
;
6156 pc
->tstart
= pc
->tend
= pc
->p
;
6157 pc
->tline
= pc
->linenr
;
6158 pc
->tt
= JIM_TT_SUBEXPR_START
;
6162 pc
->tstart
= pc
->tend
= pc
->p
;
6163 pc
->tline
= pc
->linenr
;
6164 pc
->tt
= JIM_TT_SUBEXPR_END
;
6168 return JimParseCmd(pc
);
6171 if (JimParseVar(pc
) == JIM_ERR
)
6172 return JimParseExprOperator(pc
);
6177 if ((pc
->tt
== JIM_TT_NONE
|| pc
->tt
== JIM_TT_EXPR_OPERATOR
) &&
6178 isdigit((int)*(pc
->p
+1)))
6179 return JimParseExprNumber(pc
);
6181 return JimParseExprOperator(pc
);
6183 case '0': case '1': case '2': case '3': case '4':
6184 case '5': case '6': case '7': case '8': case '9': case '.':
6185 return JimParseExprNumber(pc
);
6189 /* Here it's possible to reuse the List String parsing. */
6190 pc
->tt
= JIM_TT_NONE
; /* Make sure it's sensed as a new word. */
6191 return JimParseListStr(pc
);
6195 if (JimParseExprIrrational(pc
) == JIM_ERR
)
6196 return JimParseExprOperator(pc
);
6199 return JimParseExprOperator(pc
);
6205 int JimParseExprNumber(struct JimParserCtx
*pc
)
6211 pc
->tline
= pc
->linenr
;
6212 if (*pc
->p
== '-') {
6215 while ( isdigit((int)*pc
->p
)
6216 || (allowhex
&& isxdigit((int)*pc
->p
) )
6217 || (allowdot
&& *pc
->p
== '.')
6218 || (pc
->p
-pc
->tstart
== 1 && *pc
->tstart
== '0' &&
6219 (*pc
->p
== 'x' || *pc
->p
== 'X'))
6222 if ((*pc
->p
== 'x') || (*pc
->p
== 'X')) {
6229 if (!allowdot
&& *pc
->p
== 'e' && *(pc
->p
+1) == '-') {
6230 pc
->p
+= 2; pc
->len
-= 2;
6234 pc
->tt
= JIM_TT_EXPR_NUMBER
;
6238 int JimParseExprIrrational(struct JimParserCtx
*pc
)
6240 const char *Tokens
[] = {"NaN", "nan", "NAN", "Inf", "inf", "INF", NULL
};
6242 for (token
= Tokens
; *token
!= NULL
; token
++) {
6243 int len
= strlen(*token
);
6244 if (strncmp(*token
, pc
->p
, len
) == 0) {
6246 pc
->tend
= pc
->p
+ len
- 1;
6247 pc
->p
+= len
; pc
->len
-= len
;
6248 pc
->tline
= pc
->linenr
;
6249 pc
->tt
= JIM_TT_EXPR_NUMBER
;
6256 int JimParseExprOperator(struct JimParserCtx
*pc
)
6259 int bestIdx
= -1, bestLen
= 0;
6261 /* Try to get the longest match. */
6262 for (i
= 0; i
< (signed)JIM_EXPR_OPERATORS_NUM
; i
++) {
6266 opname
= Jim_ExprOperators
[i
].name
;
6267 if (opname
== NULL
) continue;
6268 oplen
= strlen(opname
);
6270 if (strncmp(opname
, pc
->p
, oplen
) == 0 && oplen
> bestLen
) {
6275 if (bestIdx
== -1) return JIM_ERR
;
6277 pc
->tend
= pc
->p
+ bestLen
- 1;
6278 pc
->p
+= bestLen
; pc
->len
-= bestLen
;
6279 pc
->tline
= pc
->linenr
;
6280 pc
->tt
= JIM_TT_EXPR_OPERATOR
;
6284 struct Jim_ExprOperator
*JimExprOperatorInfo(const char *opname
)
6287 for (i
= 0; i
< (signed)JIM_EXPR_OPERATORS_NUM
; i
++)
6288 if (Jim_ExprOperators
[i
].name
&&
6289 strcmp(opname
, Jim_ExprOperators
[i
].name
) == 0)
6290 return &Jim_ExprOperators
[i
];
6294 struct Jim_ExprOperator
*JimExprOperatorInfoByOpcode(int opcode
)
6297 for (i
= 0; i
< (signed)JIM_EXPR_OPERATORS_NUM
; i
++)
6298 if (Jim_ExprOperators
[i
].opcode
== opcode
)
6299 return &Jim_ExprOperators
[i
];
6303 /* -----------------------------------------------------------------------------
6305 * ---------------------------------------------------------------------------*/
6306 static void FreeExprInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
6307 static void DupExprInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
);
6308 static int SetExprFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
);
6310 static Jim_ObjType exprObjType
= {
6312 FreeExprInternalRep
,
6315 JIM_TYPE_REFERENCES
,
6318 /* Expr bytecode structure */
6319 typedef struct ExprByteCode
{
6320 int *opcode
; /* Integer array of opcodes. */
6321 Jim_Obj
**obj
; /* Array of associated Jim Objects. */
6322 int len
; /* Bytecode length */
6323 int inUse
; /* Used for sharing. */
6326 void FreeExprInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
6329 ExprByteCode
*expr
= (void*) objPtr
->internalRep
.ptr
;
6332 if (expr
->inUse
!= 0) return;
6333 for (i
= 0; i
< expr
->len
; i
++)
6334 Jim_DecrRefCount(interp
, expr
->obj
[i
]);
6335 Jim_Free(expr
->opcode
);
6336 Jim_Free(expr
->obj
);
6340 void DupExprInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
)
6342 JIM_NOTUSED(interp
);
6343 JIM_NOTUSED(srcPtr
);
6345 /* Just returns an simple string. */
6346 dupPtr
->typePtr
= NULL
;
6349 /* Add a new instruction to an expression bytecode structure. */
6350 static void ExprObjAddInstr(Jim_Interp
*interp
, ExprByteCode
*expr
,
6351 int opcode
, char *str
, int len
)
6353 expr
->opcode
= Jim_Realloc(expr
->opcode
, sizeof(int)*(expr
->len
+1));
6354 expr
->obj
= Jim_Realloc(expr
->obj
, sizeof(Jim_Obj
*)*(expr
->len
+1));
6355 expr
->opcode
[expr
->len
] = opcode
;
6356 expr
->obj
[expr
->len
] = Jim_NewStringObjNoAlloc(interp
, str
, len
);
6357 Jim_IncrRefCount(expr
->obj
[expr
->len
]);
6361 /* Check if an expr program looks correct. */
6362 static int ExprCheckCorrectness(ExprByteCode
*expr
)
6367 /* Try to check if there are stack underflows,
6368 * and make sure at the end of the program there is
6369 * a single result on the stack. */
6370 for (i
= 0; i
< expr
->len
; i
++) {
6371 switch(expr
->opcode
[i
]) {
6372 case JIM_EXPROP_NUMBER
:
6373 case JIM_EXPROP_STRING
:
6374 case JIM_EXPROP_SUBST
:
6375 case JIM_EXPROP_VARIABLE
:
6376 case JIM_EXPROP_DICTSUGAR
:
6377 case JIM_EXPROP_COMMAND
:
6380 case JIM_EXPROP_NOT
:
6381 case JIM_EXPROP_BITNOT
:
6382 case JIM_EXPROP_UNARYMINUS
:
6383 case JIM_EXPROP_UNARYPLUS
:
6384 /* Unary operations */
6385 if (stacklen
< 1) return JIM_ERR
;
6387 case JIM_EXPROP_ADD
:
6388 case JIM_EXPROP_SUB
:
6389 case JIM_EXPROP_MUL
:
6390 case JIM_EXPROP_DIV
:
6391 case JIM_EXPROP_MOD
:
6394 case JIM_EXPROP_LTE
:
6395 case JIM_EXPROP_GTE
:
6396 case JIM_EXPROP_ROTL
:
6397 case JIM_EXPROP_ROTR
:
6398 case JIM_EXPROP_LSHIFT
:
6399 case JIM_EXPROP_RSHIFT
:
6400 case JIM_EXPROP_NUMEQ
:
6401 case JIM_EXPROP_NUMNE
:
6402 case JIM_EXPROP_STREQ
:
6403 case JIM_EXPROP_STRNE
:
6404 case JIM_EXPROP_BITAND
:
6405 case JIM_EXPROP_BITXOR
:
6406 case JIM_EXPROP_BITOR
:
6407 case JIM_EXPROP_LOGICAND
:
6408 case JIM_EXPROP_LOGICOR
:
6409 case JIM_EXPROP_POW
:
6410 /* binary operations */
6411 if (stacklen
< 2) return JIM_ERR
;
6415 Jim_Panic(NULL
,"Default opcode reached ExprCheckCorrectness");
6419 if (stacklen
!= 1) return JIM_ERR
;
6423 static void ExprShareLiterals(Jim_Interp
*interp
, ExprByteCode
*expr
,
6424 ScriptObj
*topLevelScript
)
6429 for (i
= 0; i
< expr
->len
; i
++) {
6430 Jim_Obj
*foundObjPtr
;
6432 if (expr
->obj
[i
] == NULL
) continue;
6433 foundObjPtr
= ScriptSearchLiteral(interp
, topLevelScript
,
6434 NULL
, expr
->obj
[i
]);
6435 if (foundObjPtr
!= NULL
) {
6436 Jim_IncrRefCount(foundObjPtr
);
6437 Jim_DecrRefCount(interp
, expr
->obj
[i
]);
6438 expr
->obj
[i
] = foundObjPtr
;
6443 /* This procedure converts every occurrence of || and && opereators
6444 * in lazy unary versions.
6446 * a b || is converted into:
6448 * a <offset> |L b |R
6450 * a b && is converted into:
6452 * a <offset> &L b &R
6454 * "|L" checks if 'a' is true:
6455 * 1) if it is true pushes 1 and skips <offset> istructions to reach
6456 * the opcode just after |R.
6457 * 2) if it is false does nothing.
6458 * "|R" checks if 'b' is true:
6459 * 1) if it is true pushes 1, otherwise pushes 0.
6461 * "&L" checks if 'a' is true:
6462 * 1) if it is true does nothing.
6463 * 2) If it is false pushes 0 and skips <offset> istructions to reach
6464 * the opcode just after &R
6465 * "&R" checks if 'a' is true:
6466 * if it is true pushes 1, otherwise pushes 0.
6468 static void ExprMakeLazy(Jim_Interp
*interp
, ExprByteCode
*expr
)
6471 int index
= -1, leftindex
, arity
, i
, offset
;
6472 Jim_ExprOperator
*op
;
6474 /* Search for || or && */
6475 for (i
= 0; i
< expr
->len
; i
++) {
6476 if (expr
->opcode
[i
] == JIM_EXPROP_LOGICAND
||
6477 expr
->opcode
[i
] == JIM_EXPROP_LOGICOR
) {
6482 if (index
== -1) return;
6483 /* Search for the end of the first operator */
6484 leftindex
= index
-1;
6487 switch(expr
->opcode
[leftindex
]) {
6488 case JIM_EXPROP_NUMBER
:
6489 case JIM_EXPROP_COMMAND
:
6490 case JIM_EXPROP_VARIABLE
:
6491 case JIM_EXPROP_DICTSUGAR
:
6492 case JIM_EXPROP_SUBST
:
6493 case JIM_EXPROP_STRING
:
6496 op
= JimExprOperatorInfoByOpcode(expr
->opcode
[i
]);
6498 Jim_Panic(interp
,"Default reached in ExprMakeLazy()");
6507 expr
->opcode
= Jim_Realloc(expr
->opcode
, sizeof(int)*(expr
->len
+2));
6508 expr
->obj
= Jim_Realloc(expr
->obj
, sizeof(Jim_Obj
*)*(expr
->len
+2));
6509 memmove(&expr
->opcode
[leftindex
+2], &expr
->opcode
[leftindex
],
6510 sizeof(int)*(expr
->len
-leftindex
));
6511 memmove(&expr
->obj
[leftindex
+2], &expr
->obj
[leftindex
],
6512 sizeof(Jim_Obj
*)*(expr
->len
-leftindex
));
6515 offset
= (index
-leftindex
)-1;
6516 Jim_DecrRefCount(interp
, expr
->obj
[index
]);
6517 if (expr
->opcode
[index
] == JIM_EXPROP_LOGICAND
) {
6518 expr
->opcode
[leftindex
+1] = JIM_EXPROP_LOGICAND_LEFT
;
6519 expr
->opcode
[index
] = JIM_EXPROP_LOGICAND_RIGHT
;
6520 expr
->obj
[leftindex
+1] = Jim_NewStringObj(interp
, "&L", -1);
6521 expr
->obj
[index
] = Jim_NewStringObj(interp
, "&R", -1);
6523 expr
->opcode
[leftindex
+1] = JIM_EXPROP_LOGICOR_LEFT
;
6524 expr
->opcode
[index
] = JIM_EXPROP_LOGICOR_RIGHT
;
6525 expr
->obj
[leftindex
+1] = Jim_NewStringObj(interp
, "|L", -1);
6526 expr
->obj
[index
] = Jim_NewStringObj(interp
, "|R", -1);
6528 expr
->opcode
[leftindex
] = JIM_EXPROP_NUMBER
;
6529 expr
->obj
[leftindex
] = Jim_NewIntObj(interp
, offset
);
6530 Jim_IncrRefCount(expr
->obj
[index
]);
6531 Jim_IncrRefCount(expr
->obj
[leftindex
]);
6532 Jim_IncrRefCount(expr
->obj
[leftindex
+1]);
6536 /* This method takes the string representation of an expression
6537 * and generates a program for the Expr's stack-based VM. */
6538 int SetExprFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
)
6541 const char *exprText
= Jim_GetString(objPtr
, &exprTextLen
);
6542 struct JimParserCtx parser
;
6543 int i
, shareLiterals
;
6544 ExprByteCode
*expr
= Jim_Alloc(sizeof(*expr
));
6546 Jim_ExprOperator
*op
;
6548 /* Perform literal sharing with the current procedure
6549 * running only if this expression appears to be not generated
6551 shareLiterals
= objPtr
->typePtr
== &sourceObjType
;
6553 expr
->opcode
= NULL
;
6558 Jim_InitStack(&stack
);
6559 JimParserInit(&parser
, exprText
, exprTextLen
, 1);
6560 while(!JimParserEof(&parser
)) {
6564 if (JimParseExpression(&parser
) != JIM_OK
) {
6565 Jim_SetResultString(interp
, "Syntax error in expression", -1);
6568 token
= JimParserGetToken(&parser
, &len
, &type
, NULL
);
6569 if (type
== JIM_TT_EOL
) {
6575 ExprObjAddInstr(interp
, expr
, JIM_EXPROP_STRING
, token
, len
);
6578 ExprObjAddInstr(interp
, expr
, JIM_EXPROP_SUBST
, token
, len
);
6581 ExprObjAddInstr(interp
, expr
, JIM_EXPROP_VARIABLE
, token
, len
);
6583 case JIM_TT_DICTSUGAR
:
6584 ExprObjAddInstr(interp
, expr
, JIM_EXPROP_DICTSUGAR
, token
, len
);
6587 ExprObjAddInstr(interp
, expr
, JIM_EXPROP_COMMAND
, token
, len
);
6589 case JIM_TT_EXPR_NUMBER
:
6590 ExprObjAddInstr(interp
, expr
, JIM_EXPROP_NUMBER
, token
, len
);
6592 case JIM_TT_EXPR_OPERATOR
:
6593 op
= JimExprOperatorInfo(token
);
6595 Jim_ExprOperator
*stackTopOp
;
6597 if (Jim_StackPeek(&stack
) != NULL
) {
6598 stackTopOp
= JimExprOperatorInfo(Jim_StackPeek(&stack
));
6602 if (Jim_StackLen(&stack
) && op
->arity
!= 1 &&
6603 stackTopOp
&& stackTopOp
->precedence
>= op
->precedence
)
6605 ExprObjAddInstr(interp
, expr
, stackTopOp
->opcode
,
6606 Jim_StackPeek(&stack
), -1);
6607 Jim_StackPop(&stack
);
6612 Jim_StackPush(&stack
, token
);
6614 case JIM_TT_SUBEXPR_START
:
6615 Jim_StackPush(&stack
, Jim_StrDup("("));
6618 case JIM_TT_SUBEXPR_END
:
6621 while(Jim_StackLen(&stack
)) {
6622 char *opstr
= Jim_StackPop(&stack
);
6623 if (!strcmp(opstr
, "(")) {
6628 op
= JimExprOperatorInfo(opstr
);
6629 ExprObjAddInstr(interp
, expr
, op
->opcode
, opstr
, -1);
6632 Jim_SetResultString(interp
,
6633 "Unexpected close parenthesis", -1);
6640 Jim_Panic(interp
,"Default reached in SetExprFromAny()");
6644 while (Jim_StackLen(&stack
)) {
6645 char *opstr
= Jim_StackPop(&stack
);
6646 op
= JimExprOperatorInfo(opstr
);
6647 if (op
== NULL
&& !strcmp(opstr
, "(")) {
6649 Jim_SetResultString(interp
, "Missing close parenthesis", -1);
6652 ExprObjAddInstr(interp
, expr
, op
->opcode
, opstr
, -1);
6654 /* Check program correctness. */
6655 if (ExprCheckCorrectness(expr
) != JIM_OK
) {
6656 Jim_SetResultString(interp
, "Invalid expression", -1);
6660 /* Free the stack used for the compilation. */
6661 Jim_FreeStackElements(&stack
, Jim_Free
);
6662 Jim_FreeStack(&stack
);
6664 /* Convert || and && operators in unary |L |R and &L &R for lazyness */
6665 ExprMakeLazy(interp
, expr
);
6667 /* Perform literal sharing */
6668 if (shareLiterals
&& interp
->framePtr
->procBodyObjPtr
) {
6669 Jim_Obj
*bodyObjPtr
= interp
->framePtr
->procBodyObjPtr
;
6670 if (bodyObjPtr
->typePtr
== &scriptObjType
) {
6671 ScriptObj
*bodyScript
= bodyObjPtr
->internalRep
.ptr
;
6672 ExprShareLiterals(interp
, expr
, bodyScript
);
6676 /* Free the old internal rep and set the new one. */
6677 Jim_FreeIntRep(interp
, objPtr
);
6678 Jim_SetIntRepPtr(objPtr
, expr
);
6679 objPtr
->typePtr
= &exprObjType
;
6682 err
: /* we jump here on syntax/compile errors. */
6683 Jim_FreeStackElements(&stack
, Jim_Free
);
6684 Jim_FreeStack(&stack
);
6685 Jim_Free(expr
->opcode
);
6686 for (i
= 0; i
< expr
->len
; i
++) {
6687 Jim_DecrRefCount(interp
,expr
->obj
[i
]);
6689 Jim_Free(expr
->obj
);
6694 ExprByteCode
*Jim_GetExpression(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
6696 if (objPtr
->typePtr
!= &exprObjType
) {
6697 if (SetExprFromAny(interp
, objPtr
) != JIM_OK
)
6700 return (ExprByteCode
*) Jim_GetIntRepPtr(objPtr
);
6703 /* -----------------------------------------------------------------------------
6704 * Expressions evaluation.
6705 * Jim uses a specialized stack-based virtual machine for expressions,
6706 * that takes advantage of the fact that expr's operators
6707 * can't be redefined.
6709 * Jim_EvalExpression() uses the bytecode compiled by
6710 * SetExprFromAny() method of the "expression" object.
6712 * On success a Tcl Object containing the result of the evaluation
6713 * is stored into expResultPtrPtr (having refcount of 1), and JIM_OK is
6715 * On error the function returns a retcode != to JIM_OK and set a suitable
6716 * error on the interp.
6717 * ---------------------------------------------------------------------------*/
6718 #define JIM_EE_STATICSTACK_LEN 10
6720 int Jim_EvalExpression(Jim_Interp
*interp
, Jim_Obj
*exprObjPtr
,
6721 Jim_Obj
**exprResultPtrPtr
)
6724 Jim_Obj
**stack
, *staticStack
[JIM_EE_STATICSTACK_LEN
];
6725 int stacklen
= 0, i
, error
= 0, errRetCode
= JIM_ERR
;
6727 Jim_IncrRefCount(exprObjPtr
);
6728 expr
= Jim_GetExpression(interp
, exprObjPtr
);
6730 Jim_DecrRefCount(interp
, exprObjPtr
);
6731 return JIM_ERR
; /* error in expression. */
6733 /* In order to avoid that the internal repr gets freed due to
6734 * shimmering of the exprObjPtr's object, we make the internal rep
6738 /* The stack-based expr VM itself */
6740 /* Stack allocation. Expr programs have the feature that
6741 * a program of length N can't require a stack longer than
6743 if (expr
->len
> JIM_EE_STATICSTACK_LEN
)
6744 stack
= Jim_Alloc(sizeof(Jim_Obj
*)*expr
->len
);
6746 stack
= staticStack
;
6748 /* Execute every istruction */
6749 for (i
= 0; i
< expr
->len
; i
++) {
6750 Jim_Obj
*A
, *B
, *objPtr
;
6751 jim_wide wA
, wB
, wC
;
6753 const char *sA
, *sB
;
6754 int Alen
, Blen
, retcode
;
6755 int opcode
= expr
->opcode
[i
];
6757 if (opcode
== JIM_EXPROP_NUMBER
|| opcode
== JIM_EXPROP_STRING
) {
6758 stack
[stacklen
++] = expr
->obj
[i
];
6759 Jim_IncrRefCount(expr
->obj
[i
]);
6760 } else if (opcode
== JIM_EXPROP_VARIABLE
) {
6761 objPtr
= Jim_GetVariable(interp
, expr
->obj
[i
], JIM_ERRMSG
);
6762 if (objPtr
== NULL
) {
6766 stack
[stacklen
++] = objPtr
;
6767 Jim_IncrRefCount(objPtr
);
6768 } else if (opcode
== JIM_EXPROP_SUBST
) {
6769 if ((retcode
= Jim_SubstObj(interp
, expr
->obj
[i
],
6770 &objPtr
, JIM_NONE
)) != JIM_OK
)
6773 errRetCode
= retcode
;
6776 stack
[stacklen
++] = objPtr
;
6777 Jim_IncrRefCount(objPtr
);
6778 } else if (opcode
== JIM_EXPROP_DICTSUGAR
) {
6779 objPtr
= Jim_ExpandDictSugar(interp
, expr
->obj
[i
]);
6780 if (objPtr
== NULL
) {
6784 stack
[stacklen
++] = objPtr
;
6785 Jim_IncrRefCount(objPtr
);
6786 } else if (opcode
== JIM_EXPROP_COMMAND
) {
6787 if ((retcode
= Jim_EvalObj(interp
, expr
->obj
[i
])) != JIM_OK
) {
6789 errRetCode
= retcode
;
6792 stack
[stacklen
++] = interp
->result
;
6793 Jim_IncrRefCount(interp
->result
);
6794 } else if (opcode
>= JIM_EXPROP_BINARY_NUM_FIRST
&&
6795 opcode
<= JIM_EXPROP_BINARY_NUM_LAST
)
6797 /* Note that there isn't to increment the
6798 * refcount of objects. the references are moved
6799 * from stack to A and B. */
6800 B
= stack
[--stacklen
];
6801 A
= stack
[--stacklen
];
6803 /* --- Integer --- */
6804 if ((A
->typePtr
== &doubleObjType
&& !A
->bytes
) ||
6805 (B
->typePtr
== &doubleObjType
&& !B
->bytes
) ||
6806 JimGetWideNoErr(interp
, A
, &wA
) != JIM_OK
||
6807 JimGetWideNoErr(interp
, B
, &wB
) != JIM_OK
) {
6810 Jim_DecrRefCount(interp
, A
);
6811 Jim_DecrRefCount(interp
, B
);
6812 switch(expr
->opcode
[i
]) {
6813 case JIM_EXPROP_ADD
: wC
= wA
+wB
; break;
6814 case JIM_EXPROP_SUB
: wC
= wA
-wB
; break;
6815 case JIM_EXPROP_MUL
: wC
= wA
*wB
; break;
6816 case JIM_EXPROP_LT
: wC
= wA
<wB
; break;
6817 case JIM_EXPROP_GT
: wC
= wA
>wB
; break;
6818 case JIM_EXPROP_LTE
: wC
= wA
<=wB
; break;
6819 case JIM_EXPROP_GTE
: wC
= wA
>=wB
; break;
6820 case JIM_EXPROP_LSHIFT
: wC
= wA
<<wB
; break;
6821 case JIM_EXPROP_RSHIFT
: wC
= wA
>>wB
; break;
6822 case JIM_EXPROP_NUMEQ
: wC
= wA
==wB
; break;
6823 case JIM_EXPROP_NUMNE
: wC
= wA
!=wB
; break;
6824 case JIM_EXPROP_BITAND
: wC
= wA
&wB
; break;
6825 case JIM_EXPROP_BITXOR
: wC
= wA
^wB
; break;
6826 case JIM_EXPROP_BITOR
: wC
= wA
|wB
; break;
6827 case JIM_EXPROP_POW
: wC
= JimPowWide(wA
,wB
); break;
6828 case JIM_EXPROP_LOGICAND_LEFT
:
6836 case JIM_EXPROP_LOGICOR_LEFT
:
6844 case JIM_EXPROP_DIV
:
6845 if (wB
== 0) goto divbyzero
;
6848 case JIM_EXPROP_MOD
:
6849 if (wB
== 0) goto divbyzero
;
6852 case JIM_EXPROP_ROTL
: {
6853 /* uint32_t would be better. But not everyone has inttypes.h?*/
6854 unsigned long uA
= (unsigned long)wA
;
6856 wC
= _rotl(uA
,(unsigned long)wB
);
6858 const unsigned int S
= sizeof(unsigned long) * 8;
6859 wC
= (unsigned long)((uA
<<wB
)|(uA
>>(S
-wB
)));
6863 case JIM_EXPROP_ROTR
: {
6864 unsigned long uA
= (unsigned long)wA
;
6866 wC
= _rotr(uA
,(unsigned long)wB
);
6868 const unsigned int S
= sizeof(unsigned long) * 8;
6869 wC
= (unsigned long)((uA
>>wB
)|(uA
<<(S
-wB
)));
6875 wC
= 0; /* avoid gcc warning */
6878 stack
[stacklen
] = Jim_NewIntObj(interp
, wC
);
6879 Jim_IncrRefCount(stack
[stacklen
]);
6883 /* --- Double --- */
6884 if (Jim_GetDouble(interp
, A
, &dA
) != JIM_OK
||
6885 Jim_GetDouble(interp
, B
, &dB
) != JIM_OK
) {
6886 Jim_DecrRefCount(interp
, A
);
6887 Jim_DecrRefCount(interp
, B
);
6891 Jim_DecrRefCount(interp
, A
);
6892 Jim_DecrRefCount(interp
, B
);
6893 switch(expr
->opcode
[i
]) {
6894 case JIM_EXPROP_ROTL
:
6895 case JIM_EXPROP_ROTR
:
6896 case JIM_EXPROP_LSHIFT
:
6897 case JIM_EXPROP_RSHIFT
:
6898 case JIM_EXPROP_BITAND
:
6899 case JIM_EXPROP_BITXOR
:
6900 case JIM_EXPROP_BITOR
:
6901 case JIM_EXPROP_MOD
:
6902 case JIM_EXPROP_POW
:
6903 Jim_SetResultString(interp
,
6904 "Got floating-point value where integer was expected", -1);
6908 case JIM_EXPROP_ADD
: dC
= dA
+dB
; break;
6909 case JIM_EXPROP_SUB
: dC
= dA
-dB
; break;
6910 case JIM_EXPROP_MUL
: dC
= dA
*dB
; break;
6911 case JIM_EXPROP_LT
: dC
= dA
<dB
; break;
6912 case JIM_EXPROP_GT
: dC
= dA
>dB
; break;
6913 case JIM_EXPROP_LTE
: dC
= dA
<=dB
; break;
6914 case JIM_EXPROP_GTE
: dC
= dA
>=dB
; break;
6915 case JIM_EXPROP_NUMEQ
: dC
= dA
==dB
; break;
6916 case JIM_EXPROP_NUMNE
: dC
= dA
!=dB
; break;
6917 case JIM_EXPROP_LOGICAND_LEFT
:
6925 case JIM_EXPROP_LOGICOR_LEFT
:
6933 case JIM_EXPROP_DIV
:
6934 if (dB
== 0) goto divbyzero
;
6938 dC
= 0; /* avoid gcc warning */
6941 stack
[stacklen
] = Jim_NewDoubleObj(interp
, dC
);
6942 Jim_IncrRefCount(stack
[stacklen
]);
6944 } else if (opcode
== JIM_EXPROP_STREQ
|| opcode
== JIM_EXPROP_STRNE
) {
6945 B
= stack
[--stacklen
];
6946 A
= stack
[--stacklen
];
6947 sA
= Jim_GetString(A
, &Alen
);
6948 sB
= Jim_GetString(B
, &Blen
);
6949 switch(expr
->opcode
[i
]) {
6950 case JIM_EXPROP_STREQ
:
6951 if (Alen
== Blen
&& memcmp(sA
, sB
, Alen
) ==0)
6956 case JIM_EXPROP_STRNE
:
6957 if (Alen
!= Blen
|| memcmp(sA
, sB
, Alen
) != 0)
6963 wC
= 0; /* avoid gcc warning */
6966 Jim_DecrRefCount(interp
, A
);
6967 Jim_DecrRefCount(interp
, B
);
6968 stack
[stacklen
] = Jim_NewIntObj(interp
, wC
);
6969 Jim_IncrRefCount(stack
[stacklen
]);
6971 } else if (opcode
== JIM_EXPROP_NOT
||
6972 opcode
== JIM_EXPROP_BITNOT
||
6973 opcode
== JIM_EXPROP_LOGICAND_RIGHT
||
6974 opcode
== JIM_EXPROP_LOGICOR_RIGHT
) {
6975 /* Note that there isn't to increment the
6976 * refcount of objects. the references are moved
6977 * from stack to A and B. */
6978 A
= stack
[--stacklen
];
6980 /* --- Integer --- */
6981 if ((A
->typePtr
== &doubleObjType
&& !A
->bytes
) ||
6982 JimGetWideNoErr(interp
, A
, &wA
) != JIM_OK
) {
6983 goto trydouble_unary
;
6985 Jim_DecrRefCount(interp
, A
);
6986 switch(expr
->opcode
[i
]) {
6987 case JIM_EXPROP_NOT
: wC
= !wA
; break;
6988 case JIM_EXPROP_BITNOT
: wC
= ~wA
; break;
6989 case JIM_EXPROP_LOGICAND_RIGHT
:
6990 case JIM_EXPROP_LOGICOR_RIGHT
: wC
= (wA
!= 0); break;
6992 wC
= 0; /* avoid gcc warning */
6995 stack
[stacklen
] = Jim_NewIntObj(interp
, wC
);
6996 Jim_IncrRefCount(stack
[stacklen
]);
7000 /* --- Double --- */
7001 if (Jim_GetDouble(interp
, A
, &dA
) != JIM_OK
) {
7002 Jim_DecrRefCount(interp
, A
);
7006 Jim_DecrRefCount(interp
, A
);
7007 switch(expr
->opcode
[i
]) {
7008 case JIM_EXPROP_NOT
: dC
= !dA
; break;
7009 case JIM_EXPROP_LOGICAND_RIGHT
:
7010 case JIM_EXPROP_LOGICOR_RIGHT
: dC
= (dA
!= 0); break;
7011 case JIM_EXPROP_BITNOT
:
7012 Jim_SetResultString(interp
,
7013 "Got floating-point value where integer was expected", -1);
7018 dC
= 0; /* avoid gcc warning */
7021 stack
[stacklen
] = Jim_NewDoubleObj(interp
, dC
);
7022 Jim_IncrRefCount(stack
[stacklen
]);
7025 Jim_Panic(interp
,"Unknown opcode in Jim_EvalExpression");
7029 /* There is no need to decerement the inUse field because
7030 * this reference is transfered back into the exprObjPtr. */
7031 Jim_FreeIntRep(interp
, exprObjPtr
);
7032 exprObjPtr
->typePtr
= &exprObjType
;
7033 Jim_SetIntRepPtr(exprObjPtr
, expr
);
7034 Jim_DecrRefCount(interp
, exprObjPtr
);
7036 *exprResultPtrPtr
= stack
[0];
7037 Jim_IncrRefCount(stack
[0]);
7038 errRetCode
= JIM_OK
;
7040 for (i
= 0; i
< stacklen
; i
++) {
7041 Jim_DecrRefCount(interp
, stack
[i
]);
7043 if (stack
!= staticStack
)
7048 Jim_SetResultString(interp
, "Division by zero", -1);
7052 int Jim_GetBoolFromExpr(Jim_Interp
*interp
, Jim_Obj
*exprObjPtr
, int *boolPtr
)
7057 Jim_Obj
*exprResultPtr
;
7059 retcode
= Jim_EvalExpression(interp
, exprObjPtr
, &exprResultPtr
);
7060 if (retcode
!= JIM_OK
)
7062 if (JimGetWideNoErr(interp
, exprResultPtr
, &wideValue
) != JIM_OK
) {
7063 if (Jim_GetDouble(interp
, exprResultPtr
, &doubleValue
) != JIM_OK
)
7065 Jim_DecrRefCount(interp
, exprResultPtr
);
7068 Jim_DecrRefCount(interp
, exprResultPtr
);
7069 *boolPtr
= doubleValue
!= 0;
7073 Jim_DecrRefCount(interp
, exprResultPtr
);
7074 *boolPtr
= wideValue
!= 0;
7078 /* -----------------------------------------------------------------------------
7079 * ScanFormat String Object
7080 * ---------------------------------------------------------------------------*/
7082 /* This Jim_Obj will held a parsed representation of a format string passed to
7083 * the Jim_ScanString command. For error diagnostics, the scanformat string has
7084 * to be parsed in its entirely first and then, if correct, can be used for
7085 * scanning. To avoid endless re-parsing, the parsed representation will be
7086 * stored in an internal representation and re-used for performance reason. */
7088 /* A ScanFmtPartDescr will held the information of /one/ part of the whole
7089 * scanformat string. This part will later be used to extract information
7090 * out from the string to be parsed by Jim_ScanString */
7092 typedef struct ScanFmtPartDescr
{
7093 char type
; /* Type of conversion (e.g. c, d, f) */
7094 char modifier
; /* Modify type (e.g. l - long, h - short */
7095 size_t width
; /* Maximal width of input to be converted */
7096 int pos
; /* -1 - no assign, 0 - natural pos, >0 - XPG3 pos */
7097 char *arg
; /* Specification of a CHARSET conversion */
7098 char *prefix
; /* Prefix to be scanned literally before conversion */
7101 /* The ScanFmtStringObj will held the internal representation of a scanformat
7102 * string parsed and separated in part descriptions. Furthermore it contains
7103 * the original string representation of the scanformat string to allow for
7104 * fast update of the Jim_Obj's string representation part.
7106 * As add-on the internal object representation add some scratch pad area
7107 * for usage by Jim_ScanString to avoid endless allocating and freeing of
7108 * memory for purpose of string scanning.
7110 * The error member points to a static allocated string in case of a mal-
7111 * formed scanformat string or it contains '0' (NULL) in case of a valid
7112 * parse representation.
7114 * The whole memory of the internal representation is allocated as a single
7115 * area of memory that will be internally separated. So freeing and duplicating
7116 * of such an object is cheap */
7118 typedef struct ScanFmtStringObj
{
7119 jim_wide size
; /* Size of internal repr in bytes */
7120 char *stringRep
; /* Original string representation */
7121 size_t count
; /* Number of ScanFmtPartDescr contained */
7122 size_t convCount
; /* Number of conversions that will assign */
7123 size_t maxPos
; /* Max position index if XPG3 is used */
7124 const char *error
; /* Ptr to error text (NULL if no error */
7125 char *scratch
; /* Some scratch pad used by Jim_ScanString */
7126 ScanFmtPartDescr descr
[1]; /* The vector of partial descriptions */
7130 static void FreeScanFmtInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
7131 static void DupScanFmtInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
);
7132 static void UpdateStringOfScanFmt(Jim_Obj
*objPtr
);
7134 static Jim_ObjType scanFmtStringObjType
= {
7136 FreeScanFmtInternalRep
,
7137 DupScanFmtInternalRep
,
7138 UpdateStringOfScanFmt
,
7142 void FreeScanFmtInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
7144 JIM_NOTUSED(interp
);
7145 Jim_Free((char*)objPtr
->internalRep
.ptr
);
7146 objPtr
->internalRep
.ptr
= 0;
7149 void DupScanFmtInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
)
7151 size_t size
= (size_t)((ScanFmtStringObj
*)srcPtr
->internalRep
.ptr
)->size
;
7152 ScanFmtStringObj
*newVec
= (ScanFmtStringObj
*)Jim_Alloc(size
);
7154 JIM_NOTUSED(interp
);
7155 memcpy(newVec
, srcPtr
->internalRep
.ptr
, size
);
7156 dupPtr
->internalRep
.ptr
= newVec
;
7157 dupPtr
->typePtr
= &scanFmtStringObjType
;
7160 void UpdateStringOfScanFmt(Jim_Obj
*objPtr
)
7162 char *bytes
= ((ScanFmtStringObj
*)objPtr
->internalRep
.ptr
)->stringRep
;
7164 objPtr
->bytes
= Jim_StrDup(bytes
);
7165 objPtr
->length
= strlen(bytes
);
7168 /* SetScanFmtFromAny will parse a given string and create the internal
7169 * representation of the format specification. In case of an error
7170 * the error data member of the internal representation will be set
7171 * to an descriptive error text and the function will be left with
7172 * JIM_ERR to indicate unsucessful parsing (aka. malformed scanformat
7175 static int SetScanFmtFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
7177 ScanFmtStringObj
*fmtObj
;
7179 int maxCount
, i
, approxSize
, lastPos
= -1;
7180 const char *fmt
= objPtr
->bytes
;
7181 int maxFmtLen
= objPtr
->length
;
7182 const char *fmtEnd
= fmt
+ maxFmtLen
;
7185 Jim_FreeIntRep(interp
, objPtr
);
7186 /* Count how many conversions could take place maximally */
7187 for (i
=0, maxCount
=0; i
< maxFmtLen
; ++i
)
7190 /* Calculate an approximation of the memory necessary */
7191 approxSize
= sizeof(ScanFmtStringObj
) /* Size of the container */
7192 + (maxCount
+ 1) * sizeof(ScanFmtPartDescr
) /* Size of all partials */
7193 + maxFmtLen
* sizeof(char) + 3 + 1 /* Scratch + "%n" + '\0' */
7194 + maxFmtLen
* sizeof(char) + 1 /* Original stringrep */
7195 + maxFmtLen
* sizeof(char) /* Arg for CHARSETs */
7196 + (maxCount
+1) * sizeof(char) /* '\0' for every partial */
7197 + 1; /* safety byte */
7198 fmtObj
= (ScanFmtStringObj
*)Jim_Alloc(approxSize
);
7199 memset(fmtObj
, 0, approxSize
);
7200 fmtObj
->size
= approxSize
;
7202 fmtObj
->scratch
= (char*)&fmtObj
->descr
[maxCount
+1];
7203 fmtObj
->stringRep
= fmtObj
->scratch
+ maxFmtLen
+ 3 + 1;
7204 memcpy(fmtObj
->stringRep
, fmt
, maxFmtLen
);
7205 buffer
= fmtObj
->stringRep
+ maxFmtLen
+ 1;
7206 objPtr
->internalRep
.ptr
= fmtObj
;
7207 objPtr
->typePtr
= &scanFmtStringObjType
;
7208 for (i
=0, curr
=0; fmt
< fmtEnd
; ++fmt
) {
7210 ScanFmtPartDescr
*descr
= &fmtObj
->descr
[curr
];
7212 descr
->width
= 0; /* Assume width unspecified */
7213 /* Overread and store any "literal" prefix */
7214 if (*fmt
!= '%' || fmt
[1] == '%') {
7216 descr
->prefix
= &buffer
[i
];
7217 for (; fmt
< fmtEnd
; ++fmt
) {
7219 if (fmt
[1] != '%') break;
7226 /* Skip the conversion introducing '%' sign */
7228 /* End reached due to non-conversion literal only? */
7231 descr
->pos
= 0; /* Assume "natural" positioning */
7233 descr
->pos
= -1; /* Okay, conversion will not be assigned */
7236 fmtObj
->convCount
++; /* Otherwise count as assign-conversion */
7237 /* Check if next token is a number (could be width or pos */
7238 if (sscanf(fmt
, "%d%n", &width
, &skip
) == 1) {
7240 /* Was the number a XPG3 position specifier? */
7241 if (descr
->pos
!= -1 && *fmt
== '$') {
7246 /* Look if "natural" postioning and XPG3 one was mixed */
7247 if ((lastPos
== 0 && descr
->pos
> 0)
7248 || (lastPos
> 0 && descr
->pos
== 0)) {
7249 fmtObj
->error
= "cannot mix \"%\" and \"%n$\" conversion specifiers";
7252 /* Look if this position was already used */
7253 for (prev
=0; prev
< curr
; ++prev
) {
7254 if (fmtObj
->descr
[prev
].pos
== -1) continue;
7255 if (fmtObj
->descr
[prev
].pos
== descr
->pos
) {
7256 fmtObj
->error
= "same \"%n$\" conversion specifier "
7257 "used more than once";
7261 /* Try to find a width after the XPG3 specifier */
7262 if (sscanf(fmt
, "%d%n", &width
, &skip
) == 1) {
7263 descr
->width
= width
;
7266 if (descr
->pos
> 0 && (size_t)descr
->pos
> fmtObj
->maxPos
)
7267 fmtObj
->maxPos
= descr
->pos
;
7269 /* Number was not a XPG3, so it has to be a width */
7270 descr
->width
= width
;
7273 /* If positioning mode was undetermined yet, fix this */
7275 lastPos
= descr
->pos
;
7276 /* Handle CHARSET conversion type ... */
7278 int swapped
= 1, beg
= i
, end
, j
;
7280 descr
->arg
= &buffer
[i
];
7282 if (*fmt
== '^') buffer
[i
++] = *fmt
++;
7283 if (*fmt
== ']') buffer
[i
++] = *fmt
++;
7284 while (*fmt
&& *fmt
!= ']') buffer
[i
++] = *fmt
++;
7286 fmtObj
->error
= "unmatched [ in format string";
7291 /* In case a range fence was given "backwards", swap it */
7294 for (j
=beg
+1; j
< end
-1; ++j
) {
7295 if (buffer
[j
] == '-' && buffer
[j
-1] > buffer
[j
+1]) {
7296 char tmp
= buffer
[j
-1];
7297 buffer
[j
-1] = buffer
[j
+1];
7304 /* Remember any valid modifier if given */
7305 if (strchr("hlL", *fmt
) != 0)
7306 descr
->modifier
= tolower((int)*fmt
++);
7309 if (strchr("efgcsndoxui", *fmt
) == 0) {
7310 fmtObj
->error
= "bad scan conversion character";
7312 } else if (*fmt
== 'c' && descr
->width
!= 0) {
7313 fmtObj
->error
= "field width may not be specified in %c "
7316 } else if (*fmt
== 'u' && descr
->modifier
== 'l') {
7317 fmtObj
->error
= "unsigned wide not supported";
7324 if (fmtObj
->convCount
== 0) {
7325 fmtObj
->error
= "no any conversion specifier given";
7331 /* Some accessor macros to allow lowlevel access to fields of internal repr */
7333 #define FormatGetCnvCount(_fo_) \
7334 ((ScanFmtStringObj*)((_fo_)->internalRep.ptr))->convCount
7335 #define FormatGetMaxPos(_fo_) \
7336 ((ScanFmtStringObj*)((_fo_)->internalRep.ptr))->maxPos
7337 #define FormatGetError(_fo_) \
7338 ((ScanFmtStringObj*)((_fo_)->internalRep.ptr))->error
7340 /* Some Bit testing/setting/cleaning routines. For now only used in handling
7341 * charsets ([a-z123]) within scanning. Later on perhaps a base for a
7342 * bitvector implementation in Jim? */
7344 static int JimTestBit(const char *bitvec
, char ch
)
7346 div_t pos
= div(ch
-1, 8);
7347 return bitvec
[pos
.quot
] & (1 << pos
.rem
);
7350 static void JimSetBit(char *bitvec
, char ch
)
7352 div_t pos
= div(ch
-1, 8);
7353 bitvec
[pos
.quot
] |= (1 << pos
.rem
);
7356 #if 0 /* currently not used */
7357 static void JimClearBit(char *bitvec
, char ch
)
7359 div_t pos
= div(ch
-1, 8);
7360 bitvec
[pos
.quot
] &= ~(1 << pos
.rem
);
7364 /* JimScanAString is used to scan an unspecified string that ends with
7365 * next WS, or a string that is specified via a charset. The charset
7366 * is currently implemented in a way to only allow for usage with
7367 * ASCII. Whenever we will switch to UNICODE, another idea has to
7370 * FIXME: Works only with ASCII */
7373 JimScanAString(Jim_Interp
*interp
, const char *sdescr
, const char *str
)
7377 char charset
[256/8+1]; /* A Charset may contain max 256 chars */
7378 char *buffer
= Jim_Alloc(strlen(str
)+1), *anchor
= buffer
;
7380 /* First init charset to nothing or all, depending if a specified
7381 * or an unspecified string has to be parsed */
7382 memset(charset
, (sdescr
? 0 : 255), sizeof(charset
));
7384 /* There was a set description given, that means we are parsing
7385 * a specified string. So we have to build a corresponding
7386 * charset reflecting the description */
7388 /* Should the set be negated at the end? */
7389 if (*sdescr
== '^') {
7393 /* Here '-' is meant literally and not to define a range */
7394 if (*sdescr
== '-') {
7395 JimSetBit(charset
, '-');
7399 if (sdescr
[1] == '-' && sdescr
[2] != 0) {
7400 /* Handle range definitions */
7402 for (i
=sdescr
[0]; i
<= sdescr
[2]; ++i
)
7403 JimSetBit(charset
, (char)i
);
7406 /* Handle verbatim character definitions */
7407 JimSetBit(charset
, *sdescr
++);
7410 /* Negate the charset if there was a NOT given */
7411 for (i
=0; notFlag
&& i
< sizeof(charset
); ++i
)
7412 charset
[i
] = ~charset
[i
];
7414 /* And after all the mess above, the real work begin ... */
7415 while (str
&& *str
) {
7416 if (!sdescr
&& isspace((int)*str
))
7417 break; /* EOS via WS if unspecified */
7418 if (JimTestBit(charset
, *str
)) *buffer
++ = *str
++;
7419 else break; /* EOS via mismatch if specified scanning */
7421 *buffer
= 0; /* Close the string properly ... */
7422 result
= Jim_NewStringObj(interp
, anchor
, -1);
7423 Jim_Free(anchor
); /* ... and free it afer usage */
7427 /* ScanOneEntry will scan one entry out of the string passed as argument.
7428 * It use the sscanf() function for this task. After extracting and
7429 * converting of the value, the count of scanned characters will be
7430 * returned of -1 in case of no conversion tool place and string was
7431 * already scanned thru */
7433 static int ScanOneEntry(Jim_Interp
*interp
, const char *str
, long pos
,
7434 ScanFmtStringObj
*fmtObj
, long index
, Jim_Obj
**valObjPtr
)
7436 # define MAX_SIZE (sizeof(jim_wide) > sizeof(double) \
7437 ? sizeof(jim_wide) \
7439 char buffer
[MAX_SIZE
];
7440 char *value
= buffer
;
7442 const ScanFmtPartDescr
*descr
= &fmtObj
->descr
[index
];
7443 size_t sLen
= strlen(&str
[pos
]), scanned
= 0;
7444 size_t anchor
= pos
;
7447 /* First pessimiticly assume, we will not scan anything :-) */
7449 if (descr
->prefix
) {
7450 /* There was a prefix given before the conversion, skip it and adjust
7451 * the string-to-be-parsed accordingly */
7452 for (i
=0; str
[pos
] && descr
->prefix
[i
]; ++i
) {
7453 /* If prefix require, skip WS */
7454 if (isspace((int)descr
->prefix
[i
]))
7455 while (str
[pos
] && isspace((int)str
[pos
])) ++pos
;
7456 else if (descr
->prefix
[i
] != str
[pos
])
7457 break; /* Prefix do not match here, leave the loop */
7459 ++pos
; /* Prefix matched so far, next round */
7462 return -1; /* All of str consumed: EOF condition */
7463 else if (descr
->prefix
[i
] != 0)
7464 return 0; /* Not whole prefix consumed, no conversion possible */
7466 /* For all but following conversion, skip leading WS */
7467 if (descr
->type
!= 'c' && descr
->type
!= '[' && descr
->type
!= 'n')
7468 while (isspace((int)str
[pos
])) ++pos
;
7469 /* Determine how much skipped/scanned so far */
7470 scanned
= pos
- anchor
;
7471 if (descr
->type
== 'n') {
7472 /* Return pseudo conversion means: how much scanned so far? */
7473 *valObjPtr
= Jim_NewIntObj(interp
, anchor
+ scanned
);
7474 } else if (str
[pos
] == 0) {
7475 /* Cannot scan anything, as str is totally consumed */
7478 /* Processing of conversions follows ... */
7479 if (descr
->width
> 0) {
7480 /* Do not try to scan as fas as possible but only the given width.
7481 * To ensure this, we copy the part that should be scanned. */
7482 size_t tLen
= descr
->width
> sLen
? sLen
: descr
->width
;
7483 tok
= Jim_StrDupLen(&str
[pos
], tLen
);
7485 /* As no width was given, simply refer to the original string */
7488 switch (descr
->type
) {
7490 *valObjPtr
= Jim_NewIntObj(interp
, *tok
);
7493 case 'd': case 'o': case 'x': case 'u': case 'i': {
7494 char *endp
; /* Position where the number finished */
7495 int base
= descr
->type
== 'o' ? 8
7496 : descr
->type
== 'x' ? 16
7497 : descr
->type
== 'i' ? 0
7501 /* Try to scan a number with the given base */
7502 if (descr
->modifier
== 'l')
7503 #ifdef HAVE_LONG_LONG
7504 *(jim_wide
*)value
= JimStrtoll(tok
, &endp
, base
);
7506 *(jim_wide
*)value
= strtol(tok
, &endp
, base
);
7509 if (descr
->type
== 'u')
7510 *(long*)value
= strtoul(tok
, &endp
, base
);
7512 *(long*)value
= strtol(tok
, &endp
, base
);
7513 /* If scanning failed, and base was undetermined, simply
7514 * put it to 10 and try once more. This should catch the
7515 * case where %i begin to parse a number prefix (e.g.
7516 * '0x' but no further digits follows. This will be
7517 * handled as a ZERO followed by a char 'x' by Tcl */
7518 if (endp
== tok
&& base
== 0) base
= 10;
7522 /* There was some number sucessfully scanned! */
7523 if (descr
->modifier
== 'l')
7524 *valObjPtr
= Jim_NewIntObj(interp
, *(jim_wide
*)value
);
7526 *valObjPtr
= Jim_NewIntObj(interp
, *(long*)value
);
7527 /* Adjust the number-of-chars scanned so far */
7528 scanned
+= endp
- tok
;
7530 /* Nothing was scanned. We have to determine if this
7531 * happened due to e.g. prefix mismatch or input str
7533 scanned
= *tok
? 0 : -1;
7537 case 's': case '[': {
7538 *valObjPtr
= JimScanAString(interp
, descr
->arg
, tok
);
7539 scanned
+= Jim_Length(*valObjPtr
);
7542 case 'e': case 'f': case 'g': {
7545 *(double*)value
= strtod(tok
, &endp
);
7547 /* There was some number sucessfully scanned! */
7548 *valObjPtr
= Jim_NewDoubleObj(interp
, *(double*)value
);
7549 /* Adjust the number-of-chars scanned so far */
7550 scanned
+= endp
- tok
;
7552 /* Nothing was scanned. We have to determine if this
7553 * happened due to e.g. prefix mismatch or input str
7555 scanned
= *tok
? 0 : -1;
7560 /* If a substring was allocated (due to pre-defined width) do not
7561 * forget to free it */
7562 if (tok
!= &str
[pos
])
7563 Jim_Free((char*)tok
);
7568 /* Jim_ScanString is the workhorse of string scanning. It will scan a given
7569 * string and returns all converted (and not ignored) values in a list back
7570 * to the caller. If an error occured, a NULL pointer will be returned */
7572 Jim_Obj
*Jim_ScanString(Jim_Interp
*interp
, Jim_Obj
*strObjPtr
,
7573 Jim_Obj
*fmtObjPtr
, int flags
)
7577 const char *str
= Jim_GetString(strObjPtr
, 0);
7578 Jim_Obj
*resultList
= 0;
7579 Jim_Obj
**resultVec
;
7581 Jim_Obj
*emptyStr
= 0;
7582 ScanFmtStringObj
*fmtObj
;
7584 /* If format specification is not an object, convert it! */
7585 if (fmtObjPtr
->typePtr
!= &scanFmtStringObjType
)
7586 SetScanFmtFromAny(interp
, fmtObjPtr
);
7587 fmtObj
= (ScanFmtStringObj
*)fmtObjPtr
->internalRep
.ptr
;
7588 /* Check if format specification was valid */
7589 if (fmtObj
->error
!= 0) {
7590 if (flags
& JIM_ERRMSG
)
7591 Jim_SetResultString(interp
, fmtObj
->error
, -1);
7594 /* Allocate a new "shared" empty string for all unassigned conversions */
7595 emptyStr
= Jim_NewEmptyStringObj(interp
);
7596 Jim_IncrRefCount(emptyStr
);
7597 /* Create a list and fill it with empty strings up to max specified XPG3 */
7598 resultList
= Jim_NewListObj(interp
, 0, 0);
7599 if (fmtObj
->maxPos
> 0) {
7600 for (i
=0; i
< fmtObj
->maxPos
; ++i
)
7601 Jim_ListAppendElement(interp
, resultList
, emptyStr
);
7602 JimListGetElements(interp
, resultList
, &resultc
, &resultVec
);
7604 /* Now handle every partial format description */
7605 for (i
=0, pos
=0; i
< fmtObj
->count
; ++i
) {
7606 ScanFmtPartDescr
*descr
= &(fmtObj
->descr
[i
]);
7608 /* Only last type may be "literal" w/o conversion - skip it! */
7609 if (descr
->type
== 0) continue;
7610 /* As long as any conversion could be done, we will proceed */
7612 scanned
= ScanOneEntry(interp
, str
, pos
, fmtObj
, i
, &value
);
7613 /* In case our first try results in EOF, we will leave */
7614 if (scanned
== -1 && i
== 0)
7616 /* Advance next pos-to-be-scanned for the amount scanned already */
7618 /* value == 0 means no conversion took place so take empty string */
7620 value
= Jim_NewEmptyStringObj(interp
);
7621 /* If value is a non-assignable one, skip it */
7622 if (descr
->pos
== -1) {
7623 Jim_FreeNewObj(interp
, value
);
7624 } else if (descr
->pos
== 0)
7625 /* Otherwise append it to the result list if no XPG3 was given */
7626 Jim_ListAppendElement(interp
, resultList
, value
);
7627 else if (resultVec
[descr
->pos
-1] == emptyStr
) {
7628 /* But due to given XPG3, put the value into the corr. slot */
7629 Jim_DecrRefCount(interp
, resultVec
[descr
->pos
-1]);
7630 Jim_IncrRefCount(value
);
7631 resultVec
[descr
->pos
-1] = value
;
7633 /* Otherwise, the slot was already used - free obj and ERROR */
7634 Jim_FreeNewObj(interp
, value
);
7638 Jim_DecrRefCount(interp
, emptyStr
);
7641 Jim_DecrRefCount(interp
, emptyStr
);
7642 Jim_FreeNewObj(interp
, resultList
);
7643 return (Jim_Obj
*)EOF
;
7645 Jim_DecrRefCount(interp
, emptyStr
);
7646 Jim_FreeNewObj(interp
, resultList
);
7650 /* -----------------------------------------------------------------------------
7651 * Pseudo Random Number Generation
7652 * ---------------------------------------------------------------------------*/
7653 static void JimPrngSeed(Jim_Interp
*interp
, const unsigned char *seed
,
7656 /* Initialize the sbox with the numbers from 0 to 255 */
7657 static void JimPrngInit(Jim_Interp
*interp
)
7660 unsigned int seed
[256];
7662 interp
->prngState
= Jim_Alloc(sizeof(Jim_PrngState
));
7663 for (i
= 0; i
< 256; i
++)
7664 seed
[i
] = (rand() ^ time(NULL
) ^ clock());
7665 JimPrngSeed(interp
, (unsigned char*) seed
, sizeof(int)*256);
7668 /* Generates N bytes of random data */
7669 static void JimRandomBytes(Jim_Interp
*interp
, void *dest
, unsigned int len
)
7671 Jim_PrngState
*prng
;
7672 unsigned char *destByte
= (unsigned char*) dest
;
7673 unsigned int si
, sj
, x
;
7675 /* initialization, only needed the first time */
7676 if (interp
->prngState
== NULL
)
7677 JimPrngInit(interp
);
7678 prng
= interp
->prngState
;
7679 /* generates 'len' bytes of pseudo-random numbers */
7680 for (x
= 0; x
< len
; x
++) {
7681 prng
->i
= (prng
->i
+1) & 0xff;
7682 si
= prng
->sbox
[prng
->i
];
7683 prng
->j
= (prng
->j
+ si
) & 0xff;
7684 sj
= prng
->sbox
[prng
->j
];
7685 prng
->sbox
[prng
->i
] = sj
;
7686 prng
->sbox
[prng
->j
] = si
;
7687 *destByte
++ = prng
->sbox
[(si
+sj
)&0xff];
7691 /* Re-seed the generator with user-provided bytes */
7692 static void JimPrngSeed(Jim_Interp
*interp
, const unsigned char *seed
,
7696 unsigned char buf
[256];
7697 Jim_PrngState
*prng
;
7699 /* initialization, only needed the first time */
7700 if (interp
->prngState
== NULL
)
7701 JimPrngInit(interp
);
7702 prng
= interp
->prngState
;
7704 /* Set the sbox[i] with i */
7705 for (i
= 0; i
< 256; i
++)
7707 /* Now use the seed to perform a random permutation of the sbox */
7708 for (i
= 0; i
< seedLen
; i
++) {
7711 t
= prng
->sbox
[i
&0xFF];
7712 prng
->sbox
[i
&0xFF] = prng
->sbox
[seed
[i
]];
7713 prng
->sbox
[seed
[i
]] = t
;
7715 prng
->i
= prng
->j
= 0;
7716 /* discard the first 256 bytes of stream. */
7717 JimRandomBytes(interp
, buf
, 256);
7720 /* -----------------------------------------------------------------------------
7721 * Dynamic libraries support (WIN32 not supported)
7722 * ---------------------------------------------------------------------------*/
7727 void * dlopen(const char *path
, int mode
)
7731 return (void *)LoadLibraryA(path
);
7733 int dlclose(void *handle
)
7735 FreeLibrary((HANDLE
)handle
);
7738 void *dlsym(void *handle
, const char *symbol
)
7740 return GetProcAddress((HMODULE
)handle
, symbol
);
7742 static char win32_dlerror_string
[121];
7743 const char *dlerror()
7745 FormatMessageA(FORMAT_MESSAGE_FROM_SYSTEM
, NULL
, GetLastError(),
7746 LANG_NEUTRAL
, win32_dlerror_string
, 120, NULL
);
7747 return win32_dlerror_string
;
7751 int Jim_LoadLibrary(Jim_Interp
*interp
, const char *pathName
)
7753 Jim_Obj
*libPathObjPtr
;
7756 int (*onload
)(Jim_Interp
*interp
);
7758 libPathObjPtr
= Jim_GetGlobalVariableStr(interp
, "jim_libpath", JIM_NONE
);
7759 if (libPathObjPtr
== NULL
) {
7761 libPathObjPtr
= NULL
;
7763 Jim_IncrRefCount(libPathObjPtr
);
7764 Jim_ListLength(interp
, libPathObjPtr
, &prefixc
);
7767 for (i
= -1; i
< prefixc
; i
++) {
7769 handle
= dlopen(pathName
, RTLD_LAZY
);
7772 char buf
[JIM_PATH_LEN
];
7775 Jim_Obj
*prefixObjPtr
;
7778 if (Jim_ListIndex(interp
, libPathObjPtr
, i
,
7779 &prefixObjPtr
, JIM_NONE
) != JIM_OK
)
7781 prefix
= Jim_GetString(prefixObjPtr
, NULL
);
7782 prefixlen
= strlen(prefix
);
7783 if (prefixlen
+strlen(pathName
)+1 >= JIM_PATH_LEN
)
7785 if (prefixlen
&& prefix
[prefixlen
-1] == '/')
7786 sprintf(buf
, "%s%s", prefix
, pathName
);
7788 sprintf(buf
, "%s/%s", prefix
, pathName
);
7789 printf("opening '%s'\n", buf
);
7790 fp
= fopen(buf
, "r");
7794 handle
= dlopen(buf
, RTLD_LAZY
);
7795 printf("got handle %p\n", handle
);
7797 if (handle
== NULL
) {
7798 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
7799 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
7800 "error loading extension \"", pathName
,
7801 "\": ", dlerror(), NULL
);
7806 if ((onload
= dlsym(handle
, "Jim_OnLoad")) == NULL
) {
7807 Jim_SetResultString(interp
,
7808 "No Jim_OnLoad symbol found on extension", -1);
7811 if (onload(interp
) == JIM_ERR
) {
7815 Jim_SetEmptyResult(interp
);
7816 if (libPathObjPtr
!= NULL
)
7817 Jim_DecrRefCount(interp
, libPathObjPtr
);
7821 if (libPathObjPtr
!= NULL
)
7822 Jim_DecrRefCount(interp
, libPathObjPtr
);
7825 #else /* JIM_DYNLIB */
7826 int Jim_LoadLibrary(Jim_Interp
*interp
, const char *pathName
)
7828 JIM_NOTUSED(interp
);
7829 JIM_NOTUSED(pathName
);
7831 Jim_SetResultString(interp
, "the Jim binary has no support for [load]", -1);
7834 #endif/* JIM_DYNLIB */
7836 /* -----------------------------------------------------------------------------
7838 * ---------------------------------------------------------------------------*/
7840 #define JIM_PKG_ANY_VERSION -1
7842 /* Convert a string of the type "1.2" into an integer.
7843 * MAJOR.MINOR is converted as MAJOR*100+MINOR, so "1.2" is converted
7844 * to the integer with value 102 */
7845 static int JimPackageVersionToInt(Jim_Interp
*interp
, const char *v
,
7846 int *intPtr
, int flags
)
7849 jim_wide major
, minor
;
7850 char *majorStr
, *minorStr
, *p
;
7853 *intPtr
= JIM_PKG_ANY_VERSION
;
7857 copy
= Jim_StrDup(v
);
7858 p
= strchr(copy
, '.');
7859 if (p
== NULL
) goto badfmt
;
7864 if (Jim_StringToWide(majorStr
, &major
, 10) != JIM_OK
||
7865 Jim_StringToWide(minorStr
, &minor
, 10) != JIM_OK
)
7867 *intPtr
= (int)(major
*100+minor
);
7873 if (flags
& JIM_ERRMSG
) {
7874 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
7875 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
7876 "invalid package version '", v
, "'", NULL
);
7881 #define JIM_MATCHVER_EXACT (1<<JIM_PRIV_FLAG_SHIFT)
7882 static int JimPackageMatchVersion(int needed
, int actual
, int flags
)
7884 if (needed
== JIM_PKG_ANY_VERSION
) return 1;
7885 if (flags
& JIM_MATCHVER_EXACT
) {
7886 return needed
== actual
;
7888 return needed
/100 == actual
/100 && (needed
<= actual
);
7892 int Jim_PackageProvide(Jim_Interp
*interp
, const char *name
, const char *ver
,
7896 /* Check if the version format is ok */
7897 if (JimPackageVersionToInt(interp
, ver
, &intVersion
, JIM_ERRMSG
) != JIM_OK
)
7899 /* If the package was already provided returns an error. */
7900 if (Jim_FindHashEntry(&interp
->packages
, name
) != NULL
) {
7901 if (flags
& JIM_ERRMSG
) {
7902 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
7903 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
7904 "package '", name
, "' was already provided", NULL
);
7908 Jim_AddHashEntry(&interp
->packages
, name
, (char*) ver
);
7915 # include <sys/types.h>
7916 # include <dirent.h>
7919 /* Posix dirent.h compatiblity layer for WIN32.
7920 * Copyright Kevlin Henney, 1997, 2003. All rights reserved.
7921 * Copyright Salvatore Sanfilippo ,2005.
7923 * Permission to use, copy, modify, and distribute this software and its
7924 * documentation for any purpose is hereby granted without fee, provided
7925 * that this copyright and permissions notice appear in all copies and
7928 * This software is supplied "as is" without express or implied warranty.
7929 * This software was modified by Salvatore Sanfilippo for the Jim Interpreter.
7936 typedef struct DIR {
7937 long handle
; /* -1 for failed rewind */
7938 struct _finddata_t info
;
7939 struct dirent result
; /* d_name null iff first time */
7940 char *name
; /* null-terminated char string */
7943 DIR *opendir(const char *name
)
7947 if(name
&& name
[0]) {
7948 size_t base_length
= strlen(name
);
7949 const char *all
= /* search pattern must end with suitable wildcard */
7950 strchr("/\\", name
[base_length
- 1]) ? "*" : "/*";
7952 if((dir
= (DIR *) Jim_Alloc(sizeof *dir
)) != 0 &&
7953 (dir
->name
= (char *) Jim_Alloc(base_length
+ strlen(all
) + 1)) != 0)
7955 strcat(strcpy(dir
->name
, name
), all
);
7957 if((dir
->handle
= (long) _findfirst(dir
->name
, &dir
->info
)) != -1)
7958 dir
->result
.d_name
= 0;
7959 else { /* rollback */
7960 Jim_Free(dir
->name
);
7964 } else { /* rollback */
7975 int closedir(DIR *dir
)
7980 if(dir
->handle
!= -1)
7981 result
= _findclose(dir
->handle
);
7982 Jim_Free(dir
->name
);
7985 if(result
== -1) /* map all errors to EBADF */
7990 struct dirent
*readdir(DIR *dir
)
7992 struct dirent
*result
= 0;
7994 if(dir
&& dir
->handle
!= -1) {
7995 if(!dir
->result
.d_name
|| _findnext(dir
->handle
, &dir
->info
) != -1) {
7996 result
= &dir
->result
;
7997 result
->d_name
= dir
->info
.name
;
8007 static char *JimFindBestPackage(Jim_Interp
*interp
, char **prefixes
,
8008 int prefixc
, const char *pkgName
, int pkgVer
, int flags
)
8010 int bestVer
= -1, i
;
8011 int pkgNameLen
= strlen(pkgName
);
8012 char *bestPackage
= NULL
;
8015 for (i
= 0; i
< prefixc
; i
++) {
8017 char buf
[JIM_PATH_LEN
];
8020 if (prefixes
[i
] == NULL
) continue;
8021 strncpy(buf
, prefixes
[i
], JIM_PATH_LEN
);
8022 buf
[JIM_PATH_LEN
-1] = '\0';
8023 prefixLen
= strlen(buf
);
8024 if (prefixLen
&& buf
[prefixLen
-1] == '/')
8025 buf
[prefixLen
-1] = '\0';
8027 if ((dir
= opendir(buf
)) == NULL
) continue;
8028 while ((de
= readdir(dir
)) != NULL
) {
8029 char *fileName
= de
->d_name
;
8030 int fileNameLen
= strlen(fileName
);
8032 if (strncmp(fileName
, "jim-", 4) == 0 &&
8033 strncmp(fileName
+4, pkgName
, pkgNameLen
) == 0 &&
8034 *(fileName
+4+pkgNameLen
) == '-' &&
8035 fileNameLen
> 4 && /* note that this is not really useful */
8036 (strncmp(fileName
+fileNameLen
-4, ".tcl", 4) == 0 ||
8037 strncmp(fileName
+fileNameLen
-4, ".dll", 4) == 0 ||
8038 strncmp(fileName
+fileNameLen
-3, ".so", 3) == 0))
8040 char ver
[6]; /* xx.yy<nulterm> */
8041 char *p
= strrchr(fileName
, '.');
8042 int verLen
, fileVer
;
8044 verLen
= p
- (fileName
+4+pkgNameLen
+1);
8045 if (verLen
< 3 || verLen
> 5) continue;
8046 memcpy(ver
, fileName
+4+pkgNameLen
+1, verLen
);
8048 if (JimPackageVersionToInt(interp
, ver
, &fileVer
, JIM_NONE
)
8049 != JIM_OK
) continue;
8050 if (JimPackageMatchVersion(pkgVer
, fileVer
, flags
) &&
8051 (bestVer
== -1 || bestVer
< fileVer
))
8054 Jim_Free(bestPackage
);
8055 bestPackage
= Jim_Alloc(strlen(buf
)+strlen(fileName
)+2);
8056 sprintf(bestPackage
, "%s/%s", buf
, fileName
);
8065 #else /* JIM_ANSIC */
8067 static char *JimFindBestPackage(Jim_Interp
*interp
, char **prefixes
,
8068 int prefixc
, const char *pkgName
, int pkgVer
, int flags
)
8070 JIM_NOTUSED(interp
);
8071 JIM_NOTUSED(prefixes
);
8072 JIM_NOTUSED(prefixc
);
8073 JIM_NOTUSED(pkgName
);
8074 JIM_NOTUSED(pkgVer
);
8079 #endif /* JIM_ANSIC */
8081 /* Search for a suitable package under every dir specified by jim_libpath
8082 * and load it if possible. If a suitable package was loaded with success
8083 * JIM_OK is returned, otherwise JIM_ERR is returned. */
8084 static int JimLoadPackage(Jim_Interp
*interp
, const char *name
, int ver
,
8087 Jim_Obj
*libPathObjPtr
;
8088 char **prefixes
, *best
;
8089 int prefixc
, i
, retCode
= JIM_OK
;
8091 libPathObjPtr
= Jim_GetGlobalVariableStr(interp
, "jim_libpath", JIM_NONE
);
8092 if (libPathObjPtr
== NULL
) {
8094 libPathObjPtr
= NULL
;
8096 Jim_IncrRefCount(libPathObjPtr
);
8097 Jim_ListLength(interp
, libPathObjPtr
, &prefixc
);
8100 prefixes
= Jim_Alloc(sizeof(char*)*prefixc
);
8101 for (i
= 0; i
< prefixc
; i
++) {
8102 Jim_Obj
*prefixObjPtr
;
8103 if (Jim_ListIndex(interp
, libPathObjPtr
, i
,
8104 &prefixObjPtr
, JIM_NONE
) != JIM_OK
)
8109 prefixes
[i
] = Jim_StrDup(Jim_GetString(prefixObjPtr
, NULL
));
8111 /* Scan every directory to find the "best" package. */
8112 best
= JimFindBestPackage(interp
, prefixes
, prefixc
, name
, ver
, flags
);
8114 char *p
= strrchr(best
, '.');
8115 /* Try to load/source it */
8116 if (p
&& strcmp(p
, ".tcl") == 0) {
8117 retCode
= Jim_EvalFile(interp
, best
);
8119 retCode
= Jim_LoadLibrary(interp
, best
);
8125 for (i
= 0; i
< prefixc
; i
++)
8126 Jim_Free(prefixes
[i
]);
8129 Jim_DecrRefCount(interp
, libPathObjPtr
);
8133 const char *Jim_PackageRequire(Jim_Interp
*interp
, const char *name
,
8134 const char *ver
, int flags
)
8139 if (JimPackageVersionToInt(interp
, ver
, &requiredVer
, JIM_ERRMSG
) != JIM_OK
)
8141 he
= Jim_FindHashEntry(&interp
->packages
, name
);
8143 /* Try to load the package. */
8144 if (JimLoadPackage(interp
, name
, requiredVer
, flags
) == JIM_OK
) {
8145 he
= Jim_FindHashEntry(&interp
->packages
, name
);
8151 /* No way... return an error. */
8152 if (flags
& JIM_ERRMSG
) {
8153 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
8154 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
8155 "Can't find package '", name
, "'", NULL
);
8160 if (JimPackageVersionToInt(interp
, he
->val
, &actualVer
, JIM_ERRMSG
)
8165 /* Check if version matches. */
8166 if (JimPackageMatchVersion(requiredVer
, actualVer
, flags
) == 0) {
8167 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
8168 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
8169 "Package '", name
, "' already loaded, but with version ",
8177 /* -----------------------------------------------------------------------------
8179 * ---------------------------------------------------------------------------*/
8180 #define JIM_EVAL_SARGV_LEN 8 /* static arguments vector length */
8181 #define JIM_EVAL_SINTV_LEN 8 /* static interpolation vector length */
8183 static int JimCallProcedure(Jim_Interp
*interp
, Jim_Cmd
*cmd
, int argc
,
8184 Jim_Obj
*const *argv
);
8186 /* Handle calls to the [unknown] command */
8187 static int JimUnknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
8189 Jim_Obj
**v
, *sv
[JIM_EVAL_SARGV_LEN
];
8192 /* If the [unknown] command does not exists returns
8194 if (Jim_GetCommand(interp
, interp
->unknown
, JIM_NONE
) == NULL
)
8197 /* The object interp->unknown just contains
8198 * the "unknown" string, it is used in order to
8199 * avoid to lookup the unknown command every time
8200 * but instread to cache the result. */
8201 if (argc
+1 <= JIM_EVAL_SARGV_LEN
)
8204 v
= Jim_Alloc(sizeof(Jim_Obj
*)*(argc
+1));
8205 /* Make a copy of the arguments vector, but shifted on
8206 * the right of one position. The command name of the
8207 * command will be instead the first argument of the
8208 * [unknonw] call. */
8209 memcpy(v
+1, argv
, sizeof(Jim_Obj
*)*argc
);
8210 v
[0] = interp
->unknown
;
8212 retCode
= Jim_EvalObjVector(interp
, argc
+1, v
);
8219 /* Eval the object vector 'objv' composed of 'objc' elements.
8220 * Every element is used as single argument.
8221 * Jim_EvalObj() will call this function every time its object
8222 * argument is of "list" type, with no string representation.
8224 * This is possible because the string representation of a
8225 * list object generated by the UpdateStringOfList is made
8226 * in a way that ensures that every list element is a different
8227 * command argument. */
8228 int Jim_EvalObjVector(Jim_Interp
*interp
, int objc
, Jim_Obj
*const *objv
)
8233 /* Incr refcount of arguments. */
8234 for (i
= 0; i
< objc
; i
++)
8235 Jim_IncrRefCount(objv
[i
]);
8236 /* Command lookup */
8237 cmdPtr
= Jim_GetCommand(interp
, objv
[0], JIM_ERRMSG
);
8238 if (cmdPtr
== NULL
) {
8239 retcode
= JimUnknown(interp
, objc
, objv
);
8241 /* Call it -- Make sure result is an empty object. */
8242 Jim_SetEmptyResult(interp
);
8243 if (cmdPtr
->cmdProc
) {
8244 interp
->cmdPrivData
= cmdPtr
->privData
;
8245 retcode
= cmdPtr
->cmdProc(interp
, objc
, objv
);
8247 retcode
= JimCallProcedure(interp
, cmdPtr
, objc
, objv
);
8248 if (retcode
== JIM_ERR
) {
8249 JimAppendStackTrace(interp
,
8250 Jim_GetString(objv
[0], NULL
), "?", 1);
8254 /* Decr refcount of arguments and return the retcode */
8255 for (i
= 0; i
< objc
; i
++)
8256 Jim_DecrRefCount(interp
, objv
[i
]);
8260 /* Interpolate the given tokens into a unique Jim_Obj returned by reference
8261 * via *objPtrPtr. This function is only called by Jim_EvalObj().
8262 * The returned object has refcount = 0. */
8263 int Jim_InterpolateTokens(Jim_Interp
*interp
, ScriptToken
*token
,
8264 int tokens
, Jim_Obj
**objPtrPtr
)
8266 int totlen
= 0, i
, retcode
;
8268 Jim_Obj
*sintv
[JIM_EVAL_SINTV_LEN
];
8272 if (tokens
<= JIM_EVAL_SINTV_LEN
)
8275 intv
= Jim_Alloc(sizeof(Jim_Obj
*)*
8277 /* Compute every token forming the argument
8278 * in the intv objects vector. */
8279 for (i
= 0; i
< tokens
; i
++) {
8280 switch(token
[i
].type
) {
8283 intv
[i
] = token
[i
].objPtr
;
8286 intv
[i
] = Jim_GetVariable(interp
, token
[i
].objPtr
, JIM_ERRMSG
);
8292 case JIM_TT_DICTSUGAR
:
8293 intv
[i
] = Jim_ExpandDictSugar(interp
, token
[i
].objPtr
);
8300 retcode
= Jim_EvalObj(interp
, token
[i
].objPtr
);
8301 if (retcode
!= JIM_OK
)
8303 intv
[i
] = Jim_GetResult(interp
);
8307 "default token type reached "
8308 "in Jim_InterpolateTokens().");
8311 Jim_IncrRefCount(intv
[i
]);
8312 /* Make sure there is a valid
8313 * string rep, and add the string
8314 * length to the total legnth. */
8315 Jim_GetString(intv
[i
], NULL
);
8316 totlen
+= intv
[i
]->length
;
8318 /* Concatenate every token in an unique
8320 objPtr
= Jim_NewStringObjNoAlloc(interp
,
8322 s
= objPtr
->bytes
= Jim_Alloc(totlen
+1);
8323 objPtr
->length
= totlen
;
8324 for (i
= 0; i
< tokens
; i
++) {
8325 memcpy(s
, intv
[i
]->bytes
, intv
[i
]->length
);
8326 s
+= intv
[i
]->length
;
8327 Jim_DecrRefCount(interp
, intv
[i
]);
8329 objPtr
->bytes
[totlen
] = '\0';
8330 /* Free the intv vector if not static. */
8331 if (tokens
> JIM_EVAL_SINTV_LEN
)
8333 *objPtrPtr
= objPtr
;
8338 Jim_DecrRefCount(interp
, intv
[i
]);
8339 if (tokens
> JIM_EVAL_SINTV_LEN
)
8344 /* Helper of Jim_EvalObj() to perform argument expansion.
8345 * Basically this function append an argument to 'argv'
8346 * (and increments argc by reference accordingly), performing
8347 * expansion of the list object if 'expand' is non-zero, or
8348 * just adding objPtr to argv if 'expand' is zero. */
8349 void Jim_ExpandArgument(Jim_Interp
*interp
, Jim_Obj
***argv
,
8350 int *argcPtr
, int expand
, Jim_Obj
*objPtr
)
8353 (*argv
) = Jim_Realloc(*argv
, sizeof(Jim_Obj
*)*((*argcPtr
)+1));
8354 /* refcount of objPtr not incremented because
8355 * we are actually transfering a reference from
8356 * the old 'argv' to the expanded one. */
8357 (*argv
)[*argcPtr
] = objPtr
;
8362 Jim_ListLength(interp
, objPtr
, &len
);
8363 (*argv
) = Jim_Realloc(*argv
, sizeof(Jim_Obj
*)*((*argcPtr
)+len
));
8364 for (i
= 0; i
< len
; i
++) {
8365 (*argv
)[*argcPtr
] = objPtr
->internalRep
.listValue
.ele
[i
];
8366 Jim_IncrRefCount(objPtr
->internalRep
.listValue
.ele
[i
]);
8369 /* The original object reference is no longer needed,
8370 * after the expansion it is no longer present on
8371 * the argument vector, but the single elements are
8373 Jim_DecrRefCount(interp
, objPtr
);
8377 int Jim_EvalObj(Jim_Interp
*interp
, Jim_Obj
*scriptObjPtr
)
8382 int *cs
; /* command structure array */
8383 int retcode
= JIM_OK
;
8384 Jim_Obj
*sargv
[JIM_EVAL_SARGV_LEN
], **argv
= NULL
, *tmpObjPtr
;
8386 interp
->errorFlag
= 0;
8388 /* If the object is of type "list" and there is no
8389 * string representation for this object, we can call
8390 * a specialized version of Jim_EvalObj() */
8391 if (scriptObjPtr
->typePtr
== &listObjType
&&
8392 scriptObjPtr
->internalRep
.listValue
.len
&&
8393 scriptObjPtr
->bytes
== NULL
) {
8394 Jim_IncrRefCount(scriptObjPtr
);
8395 retcode
= Jim_EvalObjVector(interp
,
8396 scriptObjPtr
->internalRep
.listValue
.len
,
8397 scriptObjPtr
->internalRep
.listValue
.ele
);
8398 Jim_DecrRefCount(interp
, scriptObjPtr
);
8402 Jim_IncrRefCount(scriptObjPtr
); /* Make sure it's shared. */
8403 script
= Jim_GetScript(interp
, scriptObjPtr
);
8404 /* Now we have to make sure the internal repr will not be
8405 * freed on shimmering.
8407 * Think for example to this:
8409 * set x {llength $x; ... some more code ...}; eval $x
8411 * In order to preserve the internal rep, we increment the
8412 * inUse field of the script internal rep structure. */
8415 token
= script
->token
;
8417 cs
= script
->cmdStruct
;
8418 i
= 0; /* 'i' is the current token index. */
8420 /* Reset the interpreter result. This is useful to
8421 * return the emtpy result in the case of empty program. */
8422 Jim_SetEmptyResult(interp
);
8424 /* Execute every command sequentially, returns on
8425 * error (i.e. if a command does not return JIM_OK) */
8428 int argc
= *cs
++; /* Get the number of arguments */
8431 /* Set the expand flag if needed. */
8436 /* Allocate the arguments vector */
8437 if (argc
<= JIM_EVAL_SARGV_LEN
)
8440 argv
= Jim_Alloc(sizeof(Jim_Obj
*)*argc
);
8441 /* Populate the arguments objects. */
8442 for (j
= 0; j
< argc
; j
++) {
8445 /* tokens is negative if expansion is needed.
8446 * for this argument. */
8448 tokens
= (-tokens
)-1;
8452 /* Fast path if the token does not
8453 * need interpolation */
8454 switch(token
[i
].type
) {
8457 argv
[j
] = token
[i
].objPtr
;
8460 tmpObjPtr
= Jim_GetVariable(interp
, token
[i
].objPtr
,
8466 argv
[j
] = tmpObjPtr
;
8468 case JIM_TT_DICTSUGAR
:
8469 tmpObjPtr
= Jim_ExpandDictSugar(interp
, token
[i
].objPtr
);
8474 argv
[j
] = tmpObjPtr
;
8477 retcode
= Jim_EvalObj(interp
, token
[i
].objPtr
);
8478 if (retcode
!= JIM_OK
)
8480 argv
[j
] = Jim_GetResult(interp
);
8484 "default token type reached "
8485 "in Jim_EvalObj().");
8488 Jim_IncrRefCount(argv
[j
]);
8491 /* For interpolation we call an helper
8492 * function doing the work for us. */
8493 if ((retcode
= Jim_InterpolateTokens(interp
,
8494 token
+i
, tokens
, &tmpObjPtr
)) != JIM_OK
)
8498 argv
[j
] = tmpObjPtr
;
8499 Jim_IncrRefCount(argv
[j
]);
8503 /* Handle {expand} expansion */
8505 int *ecs
= cs
- argc
;
8507 Jim_Obj
**eargv
= NULL
;
8509 for (j
= 0; j
< argc
; j
++) {
8510 Jim_ExpandArgument( interp
, &eargv
, &eargc
,
8511 ecs
[j
] < 0, argv
[j
]);
8519 /* Nothing to do with zero args. */
8524 /* Lookup the command to call */
8525 cmd
= Jim_GetCommand(interp
, argv
[0], JIM_ERRMSG
);
8527 /* Call it -- Make sure result is an empty object. */
8528 Jim_SetEmptyResult(interp
);
8530 interp
->cmdPrivData
= cmd
->privData
;
8531 retcode
= cmd
->cmdProc(interp
, argc
, argv
);
8533 retcode
= JimCallProcedure(interp
, cmd
, argc
, argv
);
8534 if (retcode
== JIM_ERR
) {
8535 JimAppendStackTrace(interp
,
8536 Jim_GetString(argv
[0], NULL
), script
->fileName
,
8537 token
[i
-argc
*2].linenr
);
8541 /* Call [unknown] */
8542 retcode
= JimUnknown(interp
, argc
, argv
);
8544 if (retcode
!= JIM_OK
) {
8545 i
-= argc
*2; /* point to the command name. */
8548 /* Decrement the arguments count */
8549 for (j
= 0; j
< argc
; j
++) {
8550 Jim_DecrRefCount(interp
, argv
[j
]);
8553 if (argv
!= sargv
) {
8558 /* Note that we don't have to decrement inUse, because the
8559 * following code transfers our use of the reference again to
8560 * the script object. */
8561 j
= 0; /* on normal termination, the argv array is already
8562 Jim_DecrRefCount-ed. */
8564 /* Handle errors. */
8565 if (retcode
== JIM_ERR
&& !interp
->errorFlag
) {
8566 interp
->errorFlag
= 1;
8567 JimSetErrorFileName(interp
, script
->fileName
);
8568 JimSetErrorLineNumber(interp
, token
[i
].linenr
);
8569 JimResetStackTrace(interp
);
8571 Jim_FreeIntRep(interp
, scriptObjPtr
);
8572 scriptObjPtr
->typePtr
= &scriptObjType
;
8573 Jim_SetIntRepPtr(scriptObjPtr
, script
);
8574 Jim_DecrRefCount(interp
, scriptObjPtr
);
8575 for (i
= 0; i
< j
; i
++) {
8576 Jim_DecrRefCount(interp
, argv
[i
]);
8583 /* Call a procedure implemented in Tcl.
8584 * It's possible to speed-up a lot this function, currently
8585 * the callframes are not cached, but allocated and
8586 * destroied every time. What is expecially costly is
8587 * to create/destroy the local vars hash table every time.
8589 * This can be fixed just implementing callframes caching
8590 * in JimCreateCallFrame() and JimFreeCallFrame(). */
8591 int JimCallProcedure(Jim_Interp
*interp
, Jim_Cmd
*cmd
, int argc
,
8592 Jim_Obj
*const *argv
)
8595 Jim_CallFrame
*callFramePtr
;
8598 if (argc
< cmd
->arityMin
|| (cmd
->arityMax
!= -1 &&
8599 argc
> cmd
->arityMax
)) {
8600 Jim_Obj
*objPtr
= Jim_NewEmptyStringObj(interp
);
8601 Jim_AppendStrings(interp
, objPtr
,
8602 "wrong # args: should be \"", Jim_GetString(argv
[0], NULL
),
8603 (cmd
->arityMin
> 1) ? " " : "",
8604 Jim_GetString(cmd
->argListObjPtr
, NULL
), "\"", NULL
);
8605 Jim_SetResult(interp
, objPtr
);
8608 /* Check if there are too nested calls */
8609 if (interp
->numLevels
== interp
->maxNestingDepth
) {
8610 Jim_SetResultString(interp
,
8611 "Too many nested calls. Infinite recursion?", -1);
8614 /* Create a new callframe */
8615 callFramePtr
= JimCreateCallFrame(interp
);
8616 callFramePtr
->parentCallFrame
= interp
->framePtr
;
8617 callFramePtr
->argv
= argv
;
8618 callFramePtr
->argc
= argc
;
8619 callFramePtr
->procArgsObjPtr
= cmd
->argListObjPtr
;
8620 callFramePtr
->procBodyObjPtr
= cmd
->bodyObjPtr
;
8621 callFramePtr
->staticVars
= cmd
->staticVars
;
8622 Jim_IncrRefCount(cmd
->argListObjPtr
);
8623 Jim_IncrRefCount(cmd
->bodyObjPtr
);
8624 interp
->framePtr
= callFramePtr
;
8625 interp
->numLevels
++;
8627 for (i
= 0; i
< cmd
->arityMin
-1; i
++) {
8630 Jim_ListIndex(interp
, cmd
->argListObjPtr
, i
, &objPtr
, JIM_NONE
);
8631 Jim_SetVariable(interp
, objPtr
, argv
[i
+1]);
8633 if (cmd
->arityMax
== -1) {
8634 Jim_Obj
*listObjPtr
, *objPtr
;
8636 listObjPtr
= Jim_NewListObj(interp
, argv
+cmd
->arityMin
,
8637 argc
-cmd
->arityMin
);
8638 Jim_ListIndex(interp
, cmd
->argListObjPtr
, i
, &objPtr
, JIM_NONE
);
8639 Jim_SetVariable(interp
, objPtr
, listObjPtr
);
8642 retcode
= Jim_EvalObj(interp
, cmd
->bodyObjPtr
);
8644 /* Destroy the callframe */
8645 interp
->numLevels
--;
8646 interp
->framePtr
= interp
->framePtr
->parentCallFrame
;
8647 if (callFramePtr
->vars
.size
!= JIM_HT_INITIAL_SIZE
) {
8648 JimFreeCallFrame(interp
, callFramePtr
, JIM_FCF_NONE
);
8650 JimFreeCallFrame(interp
, callFramePtr
, JIM_FCF_NOHT
);
8652 /* Handle the JIM_EVAL return code */
8653 if (retcode
== JIM_EVAL
&& interp
->evalRetcodeLevel
!= interp
->numLevels
) {
8654 int savedLevel
= interp
->evalRetcodeLevel
;
8656 interp
->evalRetcodeLevel
= interp
->numLevels
;
8657 while (retcode
== JIM_EVAL
) {
8658 Jim_Obj
*resultScriptObjPtr
= Jim_GetResult(interp
);
8659 Jim_IncrRefCount(resultScriptObjPtr
);
8660 retcode
= Jim_EvalObj(interp
, resultScriptObjPtr
);
8661 Jim_DecrRefCount(interp
, resultScriptObjPtr
);
8663 interp
->evalRetcodeLevel
= savedLevel
;
8665 /* Handle the JIM_RETURN return code */
8666 if (retcode
== JIM_RETURN
) {
8667 retcode
= interp
->returnCode
;
8668 interp
->returnCode
= JIM_OK
;
8673 int Jim_Eval(Jim_Interp
*interp
, const char *script
)
8675 Jim_Obj
*scriptObjPtr
= Jim_NewStringObj(interp
, script
, -1);
8678 Jim_IncrRefCount(scriptObjPtr
);
8679 retval
= Jim_EvalObj(interp
, scriptObjPtr
);
8680 Jim_DecrRefCount(interp
, scriptObjPtr
);
8684 /* Execute script in the scope of the global level */
8685 int Jim_EvalGlobal(Jim_Interp
*interp
, const char *script
)
8687 Jim_CallFrame
*savedFramePtr
;
8690 savedFramePtr
= interp
->framePtr
;
8691 interp
->framePtr
= interp
->topFramePtr
;
8692 retval
= Jim_Eval(interp
, script
);
8693 interp
->framePtr
= savedFramePtr
;
8697 int Jim_EvalObjBackground(Jim_Interp
*interp
, Jim_Obj
*scriptObjPtr
)
8699 Jim_CallFrame
*savedFramePtr
;
8702 savedFramePtr
= interp
->framePtr
;
8703 interp
->framePtr
= interp
->topFramePtr
;
8704 retval
= Jim_EvalObj(interp
, scriptObjPtr
);
8705 interp
->framePtr
= savedFramePtr
;
8706 /* Try to report the error (if any) via the bgerror proc */
8707 if (retval
!= JIM_OK
) {
8710 objv
[0] = Jim_NewStringObj(interp
, "bgerror", -1);
8711 objv
[1] = Jim_GetResult(interp
);
8712 Jim_IncrRefCount(objv
[0]);
8713 Jim_IncrRefCount(objv
[1]);
8714 if (Jim_EvalObjVector(interp
, 2, objv
) != JIM_OK
) {
8715 /* Report the error to stderr. */
8716 Jim_fprintf( interp
, interp
->cookie_stderr
, "Background error:" JIM_NL
);
8717 Jim_PrintErrorMessage(interp
);
8719 Jim_DecrRefCount(interp
, objv
[0]);
8720 Jim_DecrRefCount(interp
, objv
[1]);
8725 int Jim_EvalFile(Jim_Interp
*interp
, const char *filename
)
8729 int nread
, totread
, maxlen
, buflen
;
8731 Jim_Obj
*scriptObjPtr
;
8733 if ((fp
= fopen(filename
, "r")) == NULL
) {
8734 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
8735 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
8736 "Error loading script \"", filename
, "\": ",
8737 strerror(errno
), NULL
);
8741 maxlen
= totread
= 0;
8743 if (maxlen
< totread
+buflen
+1) {
8744 maxlen
= totread
+buflen
+1;
8745 prg
= Jim_Realloc(prg
, maxlen
);
8747 /* do not use Jim_fread() - this is really a file */
8748 if ((nread
= fread(prg
+totread
, 1, buflen
, fp
)) == 0) break;
8751 prg
[totread
] = '\0';
8752 /* do not use Jim_fclose() - this is really a file */
8755 scriptObjPtr
= Jim_NewStringObjNoAlloc(interp
, prg
, totread
);
8756 JimSetSourceInfo(interp
, scriptObjPtr
, filename
, 1);
8757 Jim_IncrRefCount(scriptObjPtr
);
8758 retval
= Jim_EvalObj(interp
, scriptObjPtr
);
8759 Jim_DecrRefCount(interp
, scriptObjPtr
);
8763 /* -----------------------------------------------------------------------------
8765 * ---------------------------------------------------------------------------*/
8766 static int JimParseSubstStr(struct JimParserCtx
*pc
)
8769 pc
->tline
= pc
->linenr
;
8770 while (*pc
->p
&& *pc
->p
!= '$' && *pc
->p
!= '[') {
8774 pc
->tt
= JIM_TT_ESC
;
8778 static int JimParseSubst(struct JimParserCtx
*pc
, int flags
)
8783 pc
->tstart
= pc
->tend
= pc
->p
;
8784 pc
->tline
= pc
->linenr
;
8785 pc
->tt
= JIM_TT_EOL
;
8791 retval
= JimParseCmd(pc
);
8792 if (flags
& JIM_SUBST_NOCMD
) {
8795 pc
->tt
= (flags
& JIM_SUBST_NOESC
) ?
8796 JIM_TT_STR
: JIM_TT_ESC
;
8801 if (JimParseVar(pc
) == JIM_ERR
) {
8802 pc
->tstart
= pc
->tend
= pc
->p
++; pc
->len
--;
8803 pc
->tline
= pc
->linenr
;
8804 pc
->tt
= JIM_TT_STR
;
8806 if (flags
& JIM_SUBST_NOVAR
) {
8808 if (flags
& JIM_SUBST_NOESC
)
8809 pc
->tt
= JIM_TT_STR
;
8811 pc
->tt
= JIM_TT_ESC
;
8812 if (*pc
->tstart
== '{') {
8821 retval
= JimParseSubstStr(pc
);
8822 if (flags
& JIM_SUBST_NOESC
)
8823 pc
->tt
= JIM_TT_STR
;
8830 /* The subst object type reuses most of the data structures and functions
8831 * of the script object. Script's data structures are a bit more complex
8832 * for what is needed for [subst]itution tasks, but the reuse helps to
8833 * deal with a single data structure at the cost of some more memory
8834 * usage for substitutions. */
8835 static Jim_ObjType substObjType
= {
8837 FreeScriptInternalRep
,
8838 DupScriptInternalRep
,
8840 JIM_TYPE_REFERENCES
,
8843 /* This method takes the string representation of an object
8844 * as a Tcl string where to perform [subst]itution, and generates
8845 * the pre-parsed internal representation. */
8846 int SetSubstFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
, int flags
)
8849 const char *scriptText
= Jim_GetString(objPtr
, &scriptTextLen
);
8850 struct JimParserCtx parser
;
8851 struct ScriptObj
*script
= Jim_Alloc(sizeof(*script
));
8855 script
->commands
= 0;
8856 script
->token
= NULL
;
8857 script
->cmdStruct
= NULL
;
8859 script
->substFlags
= flags
;
8860 script
->fileName
= NULL
;
8862 JimParserInit(&parser
, scriptText
, scriptTextLen
, 1);
8865 int len
, type
, linenr
;
8867 JimParseSubst(&parser
, flags
);
8868 if (JimParserEof(&parser
)) break;
8869 token
= JimParserGetToken(&parser
, &len
, &type
, &linenr
);
8870 ScriptObjAddToken(interp
, script
, token
, len
, type
,
8873 /* Free the old internal rep and set the new one. */
8874 Jim_FreeIntRep(interp
, objPtr
);
8875 Jim_SetIntRepPtr(objPtr
, script
);
8876 objPtr
->typePtr
= &scriptObjType
;
8880 ScriptObj
*Jim_GetSubst(Jim_Interp
*interp
, Jim_Obj
*objPtr
, int flags
)
8882 struct ScriptObj
*script
= Jim_GetIntRepPtr(objPtr
);
8884 if (objPtr
->typePtr
!= &substObjType
|| script
->substFlags
!= flags
)
8885 SetSubstFromAny(interp
, objPtr
, flags
);
8886 return (ScriptObj
*) Jim_GetIntRepPtr(objPtr
);
8889 /* Performs commands,variables,blackslashes substitution,
8890 * storing the result object (with refcount 0) into
8892 int Jim_SubstObj(Jim_Interp
*interp
, Jim_Obj
*substObjPtr
,
8893 Jim_Obj
**resObjPtrPtr
, int flags
)
8897 int i
, len
, retcode
= JIM_OK
;
8898 Jim_Obj
*resObjPtr
, *savedResultObjPtr
;
8900 script
= Jim_GetSubst(interp
, substObjPtr
, flags
);
8901 #ifdef JIM_OPTIMIZATION
8902 /* Fast path for a very common case with array-alike syntax,
8903 * that's: $foo($bar) */
8904 if (script
->len
== 1 && script
->token
[0].type
== JIM_TT_VAR
) {
8905 Jim_Obj
*varObjPtr
= script
->token
[0].objPtr
;
8907 Jim_IncrRefCount(varObjPtr
);
8908 resObjPtr
= Jim_GetVariable(interp
, varObjPtr
, JIM_ERRMSG
);
8909 if (resObjPtr
== NULL
) {
8910 Jim_DecrRefCount(interp
, varObjPtr
);
8913 Jim_DecrRefCount(interp
, varObjPtr
);
8914 *resObjPtrPtr
= resObjPtr
;
8919 Jim_IncrRefCount(substObjPtr
); /* Make sure it's shared. */
8920 /* In order to preserve the internal rep, we increment the
8921 * inUse field of the script internal rep structure. */
8924 token
= script
->token
;
8927 /* Save the interp old result, to set it again before
8929 savedResultObjPtr
= interp
->result
;
8930 Jim_IncrRefCount(savedResultObjPtr
);
8932 /* Perform the substitution. Starts with an empty object
8933 * and adds every token (performing the appropriate
8934 * var/command/escape substitution). */
8935 resObjPtr
= Jim_NewStringObj(interp
, "", 0);
8936 for (i
= 0; i
< len
; i
++) {
8939 switch(token
[i
].type
) {
8942 Jim_AppendObj(interp
, resObjPtr
, token
[i
].objPtr
);
8945 objPtr
= Jim_GetVariable(interp
, token
[i
].objPtr
, JIM_ERRMSG
);
8946 if (objPtr
== NULL
) goto err
;
8947 Jim_IncrRefCount(objPtr
);
8948 Jim_AppendObj(interp
, resObjPtr
, objPtr
);
8949 Jim_DecrRefCount(interp
, objPtr
);
8952 if (Jim_EvalObj(interp
, token
[i
].objPtr
) != JIM_OK
)
8954 Jim_AppendObj(interp
, resObjPtr
, interp
->result
);
8958 "default token type (%d) reached "
8959 "in Jim_SubstObj().", token
[i
].type
);
8964 if (retcode
== JIM_OK
)
8965 Jim_SetResult(interp
, savedResultObjPtr
);
8966 Jim_DecrRefCount(interp
, savedResultObjPtr
);
8967 /* Note that we don't have to decrement inUse, because the
8968 * following code transfers our use of the reference again to
8969 * the script object. */
8970 Jim_FreeIntRep(interp
, substObjPtr
);
8971 substObjPtr
->typePtr
= &scriptObjType
;
8972 Jim_SetIntRepPtr(substObjPtr
, script
);
8973 Jim_DecrRefCount(interp
, substObjPtr
);
8974 *resObjPtrPtr
= resObjPtr
;
8977 Jim_FreeNewObj(interp
, resObjPtr
);
8982 /* -----------------------------------------------------------------------------
8983 * API Input/Export functions
8984 * ---------------------------------------------------------------------------*/
8986 int Jim_GetApi(Jim_Interp
*interp
, const char *funcname
, void *targetPtrPtr
)
8990 he
= Jim_FindHashEntry(&interp
->stub
, funcname
);
8993 memcpy(targetPtrPtr
, &he
->val
, sizeof(void*));
8997 int Jim_RegisterApi(Jim_Interp
*interp
, const char *funcname
, void *funcptr
)
8999 return Jim_AddHashEntry(&interp
->stub
, funcname
, funcptr
);
9002 #define JIM_REGISTER_API(name) \
9003 Jim_RegisterApi(interp, "Jim_" #name, (void *)Jim_ ## name)
9005 void JimRegisterCoreApi(Jim_Interp
*interp
)
9007 interp
->getApiFuncPtr
= Jim_GetApi
;
9008 JIM_REGISTER_API(Alloc
);
9009 JIM_REGISTER_API(Free
);
9010 JIM_REGISTER_API(Eval
);
9011 JIM_REGISTER_API(EvalGlobal
);
9012 JIM_REGISTER_API(EvalFile
);
9013 JIM_REGISTER_API(EvalObj
);
9014 JIM_REGISTER_API(EvalObjBackground
);
9015 JIM_REGISTER_API(EvalObjVector
);
9016 JIM_REGISTER_API(InitHashTable
);
9017 JIM_REGISTER_API(ExpandHashTable
);
9018 JIM_REGISTER_API(AddHashEntry
);
9019 JIM_REGISTER_API(ReplaceHashEntry
);
9020 JIM_REGISTER_API(DeleteHashEntry
);
9021 JIM_REGISTER_API(FreeHashTable
);
9022 JIM_REGISTER_API(FindHashEntry
);
9023 JIM_REGISTER_API(ResizeHashTable
);
9024 JIM_REGISTER_API(GetHashTableIterator
);
9025 JIM_REGISTER_API(NextHashEntry
);
9026 JIM_REGISTER_API(NewObj
);
9027 JIM_REGISTER_API(FreeObj
);
9028 JIM_REGISTER_API(InvalidateStringRep
);
9029 JIM_REGISTER_API(InitStringRep
);
9030 JIM_REGISTER_API(DuplicateObj
);
9031 JIM_REGISTER_API(GetString
);
9032 JIM_REGISTER_API(Length
);
9033 JIM_REGISTER_API(InvalidateStringRep
);
9034 JIM_REGISTER_API(NewStringObj
);
9035 JIM_REGISTER_API(NewStringObjNoAlloc
);
9036 JIM_REGISTER_API(AppendString
);
9037 JIM_REGISTER_API(AppendObj
);
9038 JIM_REGISTER_API(AppendStrings
);
9039 JIM_REGISTER_API(StringEqObj
);
9040 JIM_REGISTER_API(StringMatchObj
);
9041 JIM_REGISTER_API(StringRangeObj
);
9042 JIM_REGISTER_API(FormatString
);
9043 JIM_REGISTER_API(CompareStringImmediate
);
9044 JIM_REGISTER_API(NewReference
);
9045 JIM_REGISTER_API(GetReference
);
9046 JIM_REGISTER_API(SetFinalizer
);
9047 JIM_REGISTER_API(GetFinalizer
);
9048 JIM_REGISTER_API(CreateInterp
);
9049 JIM_REGISTER_API(FreeInterp
);
9050 JIM_REGISTER_API(GetExitCode
);
9051 JIM_REGISTER_API(SetStdin
);
9052 JIM_REGISTER_API(SetStdout
);
9053 JIM_REGISTER_API(SetStderr
);
9054 JIM_REGISTER_API(CreateCommand
);
9055 JIM_REGISTER_API(CreateProcedure
);
9056 JIM_REGISTER_API(DeleteCommand
);
9057 JIM_REGISTER_API(RenameCommand
);
9058 JIM_REGISTER_API(GetCommand
);
9059 JIM_REGISTER_API(SetVariable
);
9060 JIM_REGISTER_API(SetVariableStr
);
9061 JIM_REGISTER_API(SetGlobalVariableStr
);
9062 JIM_REGISTER_API(SetVariableStrWithStr
);
9063 JIM_REGISTER_API(SetVariableLink
);
9064 JIM_REGISTER_API(GetVariable
);
9065 JIM_REGISTER_API(GetCallFrameByLevel
);
9066 JIM_REGISTER_API(Collect
);
9067 JIM_REGISTER_API(CollectIfNeeded
);
9068 JIM_REGISTER_API(GetIndex
);
9069 JIM_REGISTER_API(NewListObj
);
9070 JIM_REGISTER_API(ListAppendElement
);
9071 JIM_REGISTER_API(ListAppendList
);
9072 JIM_REGISTER_API(ListLength
);
9073 JIM_REGISTER_API(ListIndex
);
9074 JIM_REGISTER_API(SetListIndex
);
9075 JIM_REGISTER_API(ConcatObj
);
9076 JIM_REGISTER_API(NewDictObj
);
9077 JIM_REGISTER_API(DictKey
);
9078 JIM_REGISTER_API(DictKeysVector
);
9079 JIM_REGISTER_API(GetIndex
);
9080 JIM_REGISTER_API(GetReturnCode
);
9081 JIM_REGISTER_API(EvalExpression
);
9082 JIM_REGISTER_API(GetBoolFromExpr
);
9083 JIM_REGISTER_API(GetWide
);
9084 JIM_REGISTER_API(GetLong
);
9085 JIM_REGISTER_API(SetWide
);
9086 JIM_REGISTER_API(NewIntObj
);
9087 JIM_REGISTER_API(GetDouble
);
9088 JIM_REGISTER_API(SetDouble
);
9089 JIM_REGISTER_API(NewDoubleObj
);
9090 JIM_REGISTER_API(WrongNumArgs
);
9091 JIM_REGISTER_API(SetDictKeysVector
);
9092 JIM_REGISTER_API(SubstObj
);
9093 JIM_REGISTER_API(RegisterApi
);
9094 JIM_REGISTER_API(PrintErrorMessage
);
9095 JIM_REGISTER_API(InteractivePrompt
);
9096 JIM_REGISTER_API(RegisterCoreCommands
);
9097 JIM_REGISTER_API(GetSharedString
);
9098 JIM_REGISTER_API(ReleaseSharedString
);
9099 JIM_REGISTER_API(Panic
);
9100 JIM_REGISTER_API(StrDup
);
9101 JIM_REGISTER_API(UnsetVariable
);
9102 JIM_REGISTER_API(GetVariableStr
);
9103 JIM_REGISTER_API(GetGlobalVariable
);
9104 JIM_REGISTER_API(GetGlobalVariableStr
);
9105 JIM_REGISTER_API(GetAssocData
);
9106 JIM_REGISTER_API(SetAssocData
);
9107 JIM_REGISTER_API(DeleteAssocData
);
9108 JIM_REGISTER_API(GetEnum
);
9109 JIM_REGISTER_API(ScriptIsComplete
);
9110 JIM_REGISTER_API(PackageRequire
);
9111 JIM_REGISTER_API(PackageProvide
);
9112 JIM_REGISTER_API(InitStack
);
9113 JIM_REGISTER_API(FreeStack
);
9114 JIM_REGISTER_API(StackLen
);
9115 JIM_REGISTER_API(StackPush
);
9116 JIM_REGISTER_API(StackPop
);
9117 JIM_REGISTER_API(StackPeek
);
9118 JIM_REGISTER_API(FreeStackElements
);
9121 /* -----------------------------------------------------------------------------
9122 * Core commands utility functions
9123 * ---------------------------------------------------------------------------*/
9124 void Jim_WrongNumArgs(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
,
9128 Jim_Obj
*objPtr
= Jim_NewEmptyStringObj(interp
);
9130 Jim_AppendString(interp
, objPtr
, "wrong # args: should be \"", -1);
9131 for (i
= 0; i
< argc
; i
++) {
9132 Jim_AppendObj(interp
, objPtr
, argv
[i
]);
9133 if (!(i
+1 == argc
&& msg
[0] == '\0'))
9134 Jim_AppendString(interp
, objPtr
, " ", 1);
9136 Jim_AppendString(interp
, objPtr
, msg
, -1);
9137 Jim_AppendString(interp
, objPtr
, "\"", 1);
9138 Jim_SetResult(interp
, objPtr
);
9141 static Jim_Obj
*JimCommandsList(Jim_Interp
*interp
, Jim_Obj
*patternObjPtr
)
9143 Jim_HashTableIterator
*htiter
;
9145 Jim_Obj
*listObjPtr
= Jim_NewListObj(interp
, NULL
, 0);
9146 const char *pattern
;
9149 pattern
= patternObjPtr
? Jim_GetString(patternObjPtr
, &patternLen
) : NULL
;
9150 htiter
= Jim_GetHashTableIterator(&interp
->commands
);
9151 while ((he
= Jim_NextHashEntry(htiter
)) != NULL
) {
9152 if (pattern
&& !JimStringMatch(pattern
, patternLen
, he
->key
,
9153 strlen((const char*)he
->key
), 0))
9155 Jim_ListAppendElement(interp
, listObjPtr
,
9156 Jim_NewStringObj(interp
, he
->key
, -1));
9158 Jim_FreeHashTableIterator(htiter
);
9162 #define JIM_VARLIST_GLOBALS 0
9163 #define JIM_VARLIST_LOCALS 1
9164 #define JIM_VARLIST_VARS 2
9166 static Jim_Obj
*JimVariablesList(Jim_Interp
*interp
, Jim_Obj
*patternObjPtr
,
9169 Jim_HashTableIterator
*htiter
;
9171 Jim_Obj
*listObjPtr
= Jim_NewListObj(interp
, NULL
, 0);
9172 const char *pattern
;
9175 pattern
= patternObjPtr
? Jim_GetString(patternObjPtr
, &patternLen
) : NULL
;
9176 if (mode
== JIM_VARLIST_GLOBALS
) {
9177 htiter
= Jim_GetHashTableIterator(&interp
->topFramePtr
->vars
);
9179 /* For [info locals], if we are at top level an emtpy list
9180 * is returned. I don't agree, but we aim at compatibility (SS) */
9181 if (mode
== JIM_VARLIST_LOCALS
&&
9182 interp
->framePtr
== interp
->topFramePtr
)
9184 htiter
= Jim_GetHashTableIterator(&interp
->framePtr
->vars
);
9186 while ((he
= Jim_NextHashEntry(htiter
)) != NULL
) {
9187 Jim_Var
*varPtr
= (Jim_Var
*) he
->val
;
9188 if (mode
== JIM_VARLIST_LOCALS
) {
9189 if (varPtr
->linkFramePtr
!= NULL
)
9192 if (pattern
&& !JimStringMatch(pattern
, patternLen
, he
->key
,
9193 strlen((const char*)he
->key
), 0))
9195 Jim_ListAppendElement(interp
, listObjPtr
,
9196 Jim_NewStringObj(interp
, he
->key
, -1));
9198 Jim_FreeHashTableIterator(htiter
);
9202 static int JimInfoLevel(Jim_Interp
*interp
, Jim_Obj
*levelObjPtr
,
9203 Jim_Obj
**objPtrPtr
)
9205 Jim_CallFrame
*targetCallFrame
;
9207 if (JimGetCallFrameByInteger(interp
, levelObjPtr
, &targetCallFrame
)
9210 /* No proc call at toplevel callframe */
9211 if (targetCallFrame
== interp
->topFramePtr
) {
9212 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
9213 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
9215 Jim_GetString(levelObjPtr
, NULL
), "\"", NULL
);
9218 *objPtrPtr
= Jim_NewListObj(interp
,
9219 targetCallFrame
->argv
,
9220 targetCallFrame
->argc
);
9224 /* -----------------------------------------------------------------------------
9226 * ---------------------------------------------------------------------------*/
9228 /* fake [puts] -- not the real puts, just for debugging. */
9229 static int Jim_PutsCoreCommand(Jim_Interp
*interp
, int argc
,
9230 Jim_Obj
*const *argv
)
9233 int len
, nonewline
= 0;
9235 if (argc
!= 2 && argc
!= 3) {
9236 Jim_WrongNumArgs(interp
, 1, argv
, "-nonewline string");
9240 if (!Jim_CompareStringImmediate(interp
, argv
[1], "-nonewline"))
9242 Jim_SetResultString(interp
, "The second argument must "
9243 "be -nonewline", -1);
9250 str
= Jim_GetString(argv
[1], &len
);
9251 Jim_fwrite(interp
, str
, 1, len
, interp
->cookie_stdout
);
9252 if (!nonewline
) Jim_fprintf( interp
, interp
->cookie_stdout
, JIM_NL
);
9256 /* Helper for [+] and [*] */
9257 static int Jim_AddMulHelper(Jim_Interp
*interp
, int argc
,
9258 Jim_Obj
*const *argv
, int op
)
9260 jim_wide wideValue
, res
;
9261 double doubleValue
, doubleRes
;
9264 res
= (op
== JIM_EXPROP_ADD
) ? 0 : 1;
9266 for (i
= 1; i
< argc
; i
++) {
9267 if (Jim_GetWide(interp
, argv
[i
], &wideValue
) != JIM_OK
)
9269 if (op
== JIM_EXPROP_ADD
)
9274 Jim_SetResult(interp
, Jim_NewIntObj(interp
, res
));
9277 doubleRes
= (double) res
;
9278 for (;i
< argc
; i
++) {
9279 if (Jim_GetDouble(interp
, argv
[i
], &doubleValue
) != JIM_OK
)
9281 if (op
== JIM_EXPROP_ADD
)
9282 doubleRes
+= doubleValue
;
9284 doubleRes
*= doubleValue
;
9286 Jim_SetResult(interp
, Jim_NewDoubleObj(interp
, doubleRes
));
9290 /* Helper for [-] and [/] */
9291 static int Jim_SubDivHelper(Jim_Interp
*interp
, int argc
,
9292 Jim_Obj
*const *argv
, int op
)
9294 jim_wide wideValue
, res
= 0;
9295 double doubleValue
, doubleRes
= 0;
9299 Jim_WrongNumArgs(interp
, 1, argv
, "number ?number ... number?");
9301 } else if (argc
== 2) {
9302 /* The arity = 2 case is different. For [- x] returns -x,
9303 * while [/ x] returns 1/x. */
9304 if (Jim_GetWide(interp
, argv
[1], &wideValue
) != JIM_OK
) {
9305 if (Jim_GetDouble(interp
, argv
[1], &doubleValue
) !=
9310 if (op
== JIM_EXPROP_SUB
)
9311 doubleRes
= -doubleValue
;
9313 doubleRes
= 1.0/doubleValue
;
9314 Jim_SetResult(interp
, Jim_NewDoubleObj(interp
,
9319 if (op
== JIM_EXPROP_SUB
) {
9321 Jim_SetResult(interp
, Jim_NewIntObj(interp
, res
));
9323 doubleRes
= 1.0/wideValue
;
9324 Jim_SetResult(interp
, Jim_NewDoubleObj(interp
,
9329 if (Jim_GetWide(interp
, argv
[1], &res
) != JIM_OK
) {
9330 if (Jim_GetDouble(interp
, argv
[1], &doubleRes
)
9338 for (i
= 2; i
< argc
; i
++) {
9339 if (Jim_GetWide(interp
, argv
[i
], &wideValue
) != JIM_OK
) {
9340 doubleRes
= (double) res
;
9343 if (op
== JIM_EXPROP_SUB
)
9348 Jim_SetResult(interp
, Jim_NewIntObj(interp
, res
));
9351 for (;i
< argc
; i
++) {
9352 if (Jim_GetDouble(interp
, argv
[i
], &doubleValue
) != JIM_OK
)
9354 if (op
== JIM_EXPROP_SUB
)
9355 doubleRes
-= doubleValue
;
9357 doubleRes
/= doubleValue
;
9359 Jim_SetResult(interp
, Jim_NewDoubleObj(interp
, doubleRes
));
9365 static int Jim_AddCoreCommand(Jim_Interp
*interp
, int argc
,
9366 Jim_Obj
*const *argv
)
9368 return Jim_AddMulHelper(interp
, argc
, argv
, JIM_EXPROP_ADD
);
9372 static int Jim_MulCoreCommand(Jim_Interp
*interp
, int argc
,
9373 Jim_Obj
*const *argv
)
9375 return Jim_AddMulHelper(interp
, argc
, argv
, JIM_EXPROP_MUL
);
9379 static int Jim_SubCoreCommand(Jim_Interp
*interp
, int argc
,
9380 Jim_Obj
*const *argv
)
9382 return Jim_SubDivHelper(interp
, argc
, argv
, JIM_EXPROP_SUB
);
9386 static int Jim_DivCoreCommand(Jim_Interp
*interp
, int argc
,
9387 Jim_Obj
*const *argv
)
9389 return Jim_SubDivHelper(interp
, argc
, argv
, JIM_EXPROP_DIV
);
9393 static int Jim_SetCoreCommand(Jim_Interp
*interp
, int argc
,
9394 Jim_Obj
*const *argv
)
9396 if (argc
!= 2 && argc
!= 3) {
9397 Jim_WrongNumArgs(interp
, 1, argv
, "varName ?newValue?");
9402 objPtr
= Jim_GetVariable(interp
, argv
[1], JIM_ERRMSG
);
9405 Jim_SetResult(interp
, objPtr
);
9408 /* argc == 3 case. */
9409 if (Jim_SetVariable(interp
, argv
[1], argv
[2]) != JIM_OK
)
9411 Jim_SetResult(interp
, argv
[2]);
9416 static int Jim_UnsetCoreCommand(Jim_Interp
*interp
, int argc
,
9417 Jim_Obj
*const *argv
)
9422 Jim_WrongNumArgs(interp
, 1, argv
, "varName ?varName ...?");
9425 for (i
= 1; i
< argc
; i
++) {
9426 if (Jim_UnsetVariable(interp
, argv
[i
], JIM_ERRMSG
) != JIM_OK
)
9433 static int Jim_IncrCoreCommand(Jim_Interp
*interp
, int argc
,
9434 Jim_Obj
*const *argv
)
9436 jim_wide wideValue
, increment
= 1;
9439 if (argc
!= 2 && argc
!= 3) {
9440 Jim_WrongNumArgs(interp
, 1, argv
, "varName ?increment?");
9444 if (Jim_GetWide(interp
, argv
[2], &increment
) != JIM_OK
)
9447 intObjPtr
= Jim_GetVariable(interp
, argv
[1], JIM_ERRMSG
);
9448 if (!intObjPtr
) return JIM_ERR
;
9449 if (Jim_GetWide(interp
, intObjPtr
, &wideValue
) != JIM_OK
)
9451 if (Jim_IsShared(intObjPtr
)) {
9452 intObjPtr
= Jim_NewIntObj(interp
, wideValue
+increment
);
9453 if (Jim_SetVariable(interp
, argv
[1], intObjPtr
) != JIM_OK
) {
9454 Jim_FreeNewObj(interp
, intObjPtr
);
9458 Jim_SetWide(interp
, intObjPtr
, wideValue
+increment
);
9459 /* The following step is required in order to invalidate the
9460 * string repr of "FOO" if the var name is on the form of "FOO(IDX)" */
9461 if (Jim_SetVariable(interp
, argv
[1], intObjPtr
) != JIM_OK
) {
9465 Jim_SetResult(interp
, intObjPtr
);
9470 static int Jim_WhileCoreCommand(Jim_Interp
*interp
, int argc
,
9471 Jim_Obj
*const *argv
)
9474 Jim_WrongNumArgs(interp
, 1, argv
, "condition body");
9477 /* Try to run a specialized version of while if the expression
9478 * is in one of the following forms:
9480 * $a < CONST, $a < $b
9481 * $a <= CONST, $a <= $b
9482 * $a > CONST, $a > $b
9483 * $a >= CONST, $a >= $b
9484 * $a != CONST, $a != $b
9485 * $a == CONST, $a == $b
9491 #ifdef JIM_OPTIMIZATION
9494 Jim_Obj
*varAObjPtr
= NULL
, *varBObjPtr
= NULL
, *objPtr
;
9495 int exprLen
, retval
;
9497 /* STEP 1 -- Check if there are the conditions to run the specialized
9498 * version of while */
9500 if ((expr
= Jim_GetExpression(interp
, argv
[1])) == NULL
) goto noopt
;
9501 if (expr
->len
<= 0 || expr
->len
> 3) goto noopt
;
9504 if (expr
->opcode
[0] != JIM_EXPROP_VARIABLE
&&
9505 expr
->opcode
[0] != JIM_EXPROP_NUMBER
)
9509 if (expr
->opcode
[1] != JIM_EXPROP_NOT
||
9510 expr
->opcode
[0] != JIM_EXPROP_VARIABLE
)
9514 if (expr
->opcode
[0] != JIM_EXPROP_VARIABLE
||
9515 (expr
->opcode
[1] != JIM_EXPROP_NUMBER
&&
9516 expr
->opcode
[1] != JIM_EXPROP_VARIABLE
))
9518 switch(expr
->opcode
[2]) {
9520 case JIM_EXPROP_LTE
:
9522 case JIM_EXPROP_GTE
:
9523 case JIM_EXPROP_NUMEQ
:
9524 case JIM_EXPROP_NUMNE
:
9533 "Unexpected default reached in Jim_WhileCoreCommand()");
9537 /* STEP 2 -- conditions meet. Initialization. Take different
9538 * branches for different expression lengths. */
9539 exprLen
= expr
->len
;
9544 if (expr
->opcode
[0] == JIM_EXPROP_VARIABLE
) {
9545 varAObjPtr
= expr
->obj
[0];
9546 Jim_IncrRefCount(varAObjPtr
);
9548 if (Jim_GetWide(interp
, expr
->obj
[0], &wideValue
) != JIM_OK
)
9554 Jim_GetVariable(interp
, varAObjPtr
, JIM_NONE
)) ||
9555 Jim_GetWide(interp
, objPtr
, &wideValue
) != JIM_OK
)
9557 Jim_DecrRefCount(interp
, varAObjPtr
);
9561 if (!wideValue
) break;
9562 if ((retval
= Jim_EvalObj(interp
, argv
[2])) != JIM_OK
) {
9566 Jim_DecrRefCount(interp
, varAObjPtr
);
9574 Jim_DecrRefCount(interp
, varAObjPtr
);
9580 Jim_DecrRefCount(interp
, varAObjPtr
);
9581 } else if (exprLen
== 3) {
9582 jim_wide wideValueA
, wideValueB
, cmpRes
= 0;
9583 int cmpType
= expr
->opcode
[2];
9585 varAObjPtr
= expr
->obj
[0];
9586 Jim_IncrRefCount(varAObjPtr
);
9587 if (expr
->opcode
[1] == JIM_EXPROP_VARIABLE
) {
9588 varBObjPtr
= expr
->obj
[1];
9589 Jim_IncrRefCount(varBObjPtr
);
9591 if (Jim_GetWide(interp
, expr
->obj
[1], &wideValueB
) != JIM_OK
)
9595 if (!(objPtr
= Jim_GetVariable(interp
, varAObjPtr
, JIM_NONE
)) ||
9596 Jim_GetWide(interp
, objPtr
, &wideValueA
) != JIM_OK
)
9598 Jim_DecrRefCount(interp
, varAObjPtr
);
9600 Jim_DecrRefCount(interp
, varBObjPtr
);
9605 Jim_GetVariable(interp
, varBObjPtr
, JIM_NONE
)) ||
9606 Jim_GetWide(interp
, objPtr
, &wideValueB
) != JIM_OK
)
9608 Jim_DecrRefCount(interp
, varAObjPtr
);
9610 Jim_DecrRefCount(interp
, varBObjPtr
);
9616 cmpRes
= wideValueA
< wideValueB
; break;
9617 case JIM_EXPROP_LTE
:
9618 cmpRes
= wideValueA
<= wideValueB
; break;
9620 cmpRes
= wideValueA
> wideValueB
; break;
9621 case JIM_EXPROP_GTE
:
9622 cmpRes
= wideValueA
>= wideValueB
; break;
9623 case JIM_EXPROP_NUMEQ
:
9624 cmpRes
= wideValueA
== wideValueB
; break;
9625 case JIM_EXPROP_NUMNE
:
9626 cmpRes
= wideValueA
!= wideValueB
; break;
9629 if ((retval
= Jim_EvalObj(interp
, argv
[2])) != JIM_OK
) {
9632 Jim_DecrRefCount(interp
, varAObjPtr
);
9634 Jim_DecrRefCount(interp
, varBObjPtr
);
9641 Jim_DecrRefCount(interp
, varAObjPtr
);
9643 Jim_DecrRefCount(interp
, varBObjPtr
);
9648 Jim_DecrRefCount(interp
, varAObjPtr
);
9650 Jim_DecrRefCount(interp
, varBObjPtr
);
9652 /* TODO: case for len == 2 */
9655 Jim_SetEmptyResult(interp
);
9661 /* The general purpose implementation of while starts here */
9663 int boolean
, retval
;
9665 if ((retval
= Jim_GetBoolFromExpr(interp
, argv
[1],
9666 &boolean
)) != JIM_OK
)
9668 if (!boolean
) break;
9669 if ((retval
= Jim_EvalObj(interp
, argv
[2])) != JIM_OK
) {
9683 Jim_SetEmptyResult(interp
);
9688 static int Jim_ForCoreCommand(Jim_Interp
*interp
, int argc
,
9689 Jim_Obj
*const *argv
)
9694 Jim_WrongNumArgs(interp
, 1, argv
, "start test next body");
9697 /* Check if the for is on the form:
9698 * for {set i CONST} {$i < CONST} {incr i}
9699 * for {set i CONST} {$i < $j} {incr i}
9700 * for {set i CONST} {$i <= CONST} {incr i}
9701 * for {set i CONST} {$i <= $j} {incr i}
9702 * XXX: NOTE: if variable traces are implemented, this optimization
9703 * need to be modified to check for the proc epoch at every variable
9705 #ifdef JIM_OPTIMIZATION
9707 ScriptObj
*initScript
, *incrScript
;
9709 jim_wide start
, stop
, currentVal
;
9710 unsigned jim_wide procEpoch
= interp
->procEpoch
;
9711 Jim_Obj
*varNamePtr
, *stopVarNamePtr
= NULL
, *objPtr
;
9713 struct Jim_Cmd
*cmdPtr
;
9715 /* Do it only if there aren't shared arguments */
9716 if (argv
[1] == argv
[2] || argv
[2] == argv
[3] || argv
[1] == argv
[3])
9718 initScript
= Jim_GetScript(interp
, argv
[1]);
9719 expr
= Jim_GetExpression(interp
, argv
[2]);
9720 incrScript
= Jim_GetScript(interp
, argv
[3]);
9722 /* Ensure proper lengths to start */
9723 if (initScript
->len
!= 6) goto evalstart
;
9724 if (incrScript
->len
!= 4) goto evalstart
;
9725 if (expr
->len
!= 3) goto evalstart
;
9726 /* Ensure proper token types. */
9727 if (initScript
->token
[2].type
!= JIM_TT_ESC
||
9728 initScript
->token
[4].type
!= JIM_TT_ESC
||
9729 incrScript
->token
[2].type
!= JIM_TT_ESC
||
9730 expr
->opcode
[0] != JIM_EXPROP_VARIABLE
||
9731 (expr
->opcode
[1] != JIM_EXPROP_NUMBER
&&
9732 expr
->opcode
[1] != JIM_EXPROP_VARIABLE
) ||
9733 (expr
->opcode
[2] != JIM_EXPROP_LT
&&
9734 expr
->opcode
[2] != JIM_EXPROP_LTE
))
9736 cmpType
= expr
->opcode
[2];
9737 /* Initialization command must be [set] */
9738 cmdPtr
= Jim_GetCommand(interp
, initScript
->token
[0].objPtr
, JIM_NONE
);
9739 if (cmdPtr
== NULL
|| cmdPtr
->cmdProc
!= Jim_SetCoreCommand
)
9741 /* Update command must be incr */
9742 cmdPtr
= Jim_GetCommand(interp
, incrScript
->token
[0].objPtr
, JIM_NONE
);
9743 if (cmdPtr
== NULL
|| cmdPtr
->cmdProc
!= Jim_IncrCoreCommand
)
9745 /* set, incr, expression must be about the same variable */
9746 if (!Jim_StringEqObj(initScript
->token
[2].objPtr
,
9747 incrScript
->token
[2].objPtr
, 0))
9749 if (!Jim_StringEqObj(initScript
->token
[2].objPtr
,
9752 /* Check that the initialization and comparison are valid integers */
9753 if (Jim_GetWide(interp
, initScript
->token
[4].objPtr
, &start
) == JIM_ERR
)
9755 if (expr
->opcode
[1] == JIM_EXPROP_NUMBER
&&
9756 Jim_GetWide(interp
, expr
->obj
[1], &stop
) == JIM_ERR
)
9761 /* Initialization */
9762 varNamePtr
= expr
->obj
[0];
9763 if (expr
->opcode
[1] == JIM_EXPROP_VARIABLE
) {
9764 stopVarNamePtr
= expr
->obj
[1];
9765 Jim_IncrRefCount(stopVarNamePtr
);
9767 Jim_IncrRefCount(varNamePtr
);
9769 /* --- OPTIMIZED FOR --- */
9771 objPtr
= Jim_NewIntObj(interp
, start
);
9772 if (Jim_SetVariable(interp
, varNamePtr
, objPtr
) != JIM_OK
) {
9773 Jim_DecrRefCount(interp
, varNamePtr
);
9774 if (stopVarNamePtr
) Jim_DecrRefCount(interp
, stopVarNamePtr
);
9775 Jim_FreeNewObj(interp
, objPtr
);
9779 /* === Check condition === */
9781 objPtr
= Jim_GetVariable(interp
, varNamePtr
, JIM_NONE
);
9782 if (objPtr
== NULL
||
9783 Jim_GetWide(interp
, objPtr
, ¤tVal
) != JIM_OK
)
9785 Jim_DecrRefCount(interp
, varNamePtr
);
9786 if (stopVarNamePtr
) Jim_DecrRefCount(interp
, stopVarNamePtr
);
9789 /* Immediate or Variable? get the 'stop' value if the latter. */
9790 if (stopVarNamePtr
) {
9791 objPtr
= Jim_GetVariable(interp
, stopVarNamePtr
, JIM_NONE
);
9792 if (objPtr
== NULL
||
9793 Jim_GetWide(interp
, objPtr
, &stop
) != JIM_OK
)
9795 Jim_DecrRefCount(interp
, varNamePtr
);
9796 Jim_DecrRefCount(interp
, stopVarNamePtr
);
9800 if (cmpType
== JIM_EXPROP_LT
) {
9801 if (currentVal
>= stop
) break;
9803 if (currentVal
> stop
) break;
9806 if ((retval
= Jim_EvalObj(interp
, argv
[4])) != JIM_OK
) {
9810 Jim_DecrRefCount(interp
, stopVarNamePtr
);
9811 Jim_DecrRefCount(interp
, varNamePtr
);
9818 Jim_DecrRefCount(interp
, stopVarNamePtr
);
9819 Jim_DecrRefCount(interp
, varNamePtr
);
9823 /* If there was a change in procedures/command continue
9824 * with the usual [for] command implementation */
9825 if (procEpoch
!= interp
->procEpoch
) {
9827 Jim_DecrRefCount(interp
, stopVarNamePtr
);
9828 Jim_DecrRefCount(interp
, varNamePtr
);
9832 objPtr
= Jim_GetVariable(interp
, varNamePtr
, JIM_ERRMSG
);
9833 if (objPtr
->refCount
== 1 && objPtr
->typePtr
== &intObjType
) {
9834 objPtr
->internalRep
.wideValue
++;
9835 Jim_InvalidateStringRep(objPtr
);
9839 if (Jim_GetWide(interp
, objPtr
, ¤tVal
) == JIM_ERR
) {
9841 Jim_DecrRefCount(interp
, stopVarNamePtr
);
9842 Jim_DecrRefCount(interp
, varNamePtr
);
9845 auxObjPtr
= Jim_NewIntObj(interp
, currentVal
+1);
9846 if (Jim_SetVariable(interp
, varNamePtr
, auxObjPtr
) == JIM_ERR
) {
9848 Jim_DecrRefCount(interp
, stopVarNamePtr
);
9849 Jim_DecrRefCount(interp
, varNamePtr
);
9850 Jim_FreeNewObj(interp
, auxObjPtr
);
9856 Jim_DecrRefCount(interp
, stopVarNamePtr
);
9857 Jim_DecrRefCount(interp
, varNamePtr
);
9858 Jim_SetEmptyResult(interp
);
9864 if ((retval
= Jim_EvalObj(interp
, argv
[1])) != JIM_OK
)
9869 /* Test the condition */
9870 if ((retval
= Jim_GetBoolFromExpr(interp
, argv
[2], &boolean
))
9873 if (!boolean
) break;
9875 if ((retval
= Jim_EvalObj(interp
, argv
[4])) != JIM_OK
) {
9889 if ((retval
= Jim_EvalObj(interp
, argv
[3])) != JIM_OK
) {
9903 Jim_SetEmptyResult(interp
);
9907 /* foreach + lmap implementation. */
9908 static int JimForeachMapHelper(Jim_Interp
*interp
, int argc
,
9909 Jim_Obj
*const *argv
, int doMap
)
9911 int result
= JIM_ERR
, i
, nbrOfLists
, *listsIdx
, *listsEnd
;
9913 Jim_Obj
*emptyStr
, *script
, *mapRes
= NULL
;
9915 if (argc
< 4 || argc
% 2 != 0) {
9916 Jim_WrongNumArgs(interp
, 1, argv
, "varList list ?varList list ...? script");
9920 mapRes
= Jim_NewListObj(interp
, NULL
, 0);
9921 Jim_IncrRefCount(mapRes
);
9923 emptyStr
= Jim_NewEmptyStringObj(interp
);
9924 Jim_IncrRefCount(emptyStr
);
9925 script
= argv
[argc
-1]; /* Last argument is a script */
9926 nbrOfLists
= (argc
- 1 - 1) / 2; /* argc - 'foreach' - script */
9927 listsIdx
= (int*)Jim_Alloc(nbrOfLists
* sizeof(int));
9928 listsEnd
= (int*)Jim_Alloc(nbrOfLists
*2 * sizeof(int));
9929 /* Initialize iterators and remember max nbr elements each list */
9930 memset(listsIdx
, 0, nbrOfLists
* sizeof(int));
9931 /* Remember lengths of all lists and calculate how much rounds to loop */
9932 for (i
=0; i
< nbrOfLists
*2; i
+= 2) {
9935 Jim_ListLength(interp
, argv
[i
+1], &listsEnd
[i
]);
9936 Jim_ListLength(interp
, argv
[i
+2], &listsEnd
[i
+1]);
9937 if (listsEnd
[i
] == 0) {
9938 Jim_SetResultString(interp
, "foreach varlist is empty", -1);
9941 cnt
= div(listsEnd
[i
+1], listsEnd
[i
]);
9942 count
= cnt
.quot
+ (cnt
.rem
? 1 : 0);
9943 if (count
> nbrOfLoops
)
9946 for (; nbrOfLoops
-- > 0; ) {
9947 for (i
=0; i
< nbrOfLists
; ++i
) {
9948 int varIdx
= 0, var
= i
* 2;
9949 while (varIdx
< listsEnd
[var
]) {
9950 Jim_Obj
*varName
, *ele
;
9951 int lst
= i
* 2 + 1;
9952 if (Jim_ListIndex(interp
, argv
[var
+1], varIdx
, &varName
, JIM_ERRMSG
)
9955 if (listsIdx
[i
] < listsEnd
[lst
]) {
9956 if (Jim_ListIndex(interp
, argv
[lst
+1], listsIdx
[i
], &ele
, JIM_ERRMSG
)
9959 if (Jim_SetVariable(interp
, varName
, ele
) != JIM_OK
) {
9960 Jim_SetResultString(interp
, "couldn't set loop variable: ", -1);
9963 ++listsIdx
[i
]; /* Remember next iterator of current list */
9964 } else if (Jim_SetVariable(interp
, varName
, emptyStr
) != JIM_OK
) {
9965 Jim_SetResultString(interp
, "couldn't set loop variable: ", -1);
9968 ++varIdx
; /* Next variable */
9971 switch (result
= Jim_EvalObj(interp
, script
)) {
9974 Jim_ListAppendElement(interp
, mapRes
, interp
->result
);
9988 Jim_SetResult(interp
, mapRes
);
9990 Jim_SetEmptyResult(interp
);
9993 Jim_DecrRefCount(interp
, mapRes
);
9994 Jim_DecrRefCount(interp
, emptyStr
);
10001 static int Jim_ForeachCoreCommand(Jim_Interp
*interp
, int argc
,
10002 Jim_Obj
*const *argv
)
10004 return JimForeachMapHelper(interp
, argc
, argv
, 0);
10008 static int Jim_LmapCoreCommand(Jim_Interp
*interp
, int argc
,
10009 Jim_Obj
*const *argv
)
10011 return JimForeachMapHelper(interp
, argc
, argv
, 1);
10015 static int Jim_IfCoreCommand(Jim_Interp
*interp
, int argc
,
10016 Jim_Obj
*const *argv
)
10018 int boolean
, retval
, current
= 1, falsebody
= 0;
10021 /* Far not enough arguments given! */
10022 if (current
>= argc
) goto err
;
10023 if ((retval
= Jim_GetBoolFromExpr(interp
,
10024 argv
[current
++], &boolean
))
10027 /* There lacks something, isn't it? */
10028 if (current
>= argc
) goto err
;
10029 if (Jim_CompareStringImmediate(interp
, argv
[current
],
10030 "then")) current
++;
10031 /* Tsk tsk, no then-clause? */
10032 if (current
>= argc
) goto err
;
10034 return Jim_EvalObj(interp
, argv
[current
]);
10035 /* Ok: no else-clause follows */
10036 if (++current
>= argc
) return JIM_OK
;
10037 falsebody
= current
++;
10038 if (Jim_CompareStringImmediate(interp
, argv
[falsebody
],
10040 /* IIICKS - else-clause isn't last cmd? */
10041 if (current
!= argc
-1) goto err
;
10042 return Jim_EvalObj(interp
, argv
[current
]);
10043 } else if (Jim_CompareStringImmediate(interp
,
10044 argv
[falsebody
], "elseif"))
10045 /* Ok: elseif follows meaning all the stuff
10046 * again (how boring...) */
10048 /* OOPS - else-clause is not last cmd?*/
10049 else if (falsebody
!= argc
-1)
10051 return Jim_EvalObj(interp
, argv
[falsebody
]);
10056 Jim_WrongNumArgs(interp
, 1, argv
, "condition ?then? trueBody ?elseif ...? ?else? falseBody");
10060 enum {SWITCH_EXACT
, SWITCH_GLOB
, SWITCH_RE
, SWITCH_CMD
, SWITCH_UNKNOWN
};
10063 static int Jim_SwitchCoreCommand(Jim_Interp
*interp
, int argc
,
10064 Jim_Obj
*const *argv
)
10066 int retcode
= JIM_ERR
, matchOpt
= SWITCH_EXACT
, opt
=1, patCount
, i
;
10067 Jim_Obj
*command
= 0, *const *caseList
= 0, *strObj
;
10068 Jim_Obj
*script
= 0;
10069 if (argc
< 3) goto wrongnumargs
;
10070 for (opt
=1; opt
< argc
; ++opt
) {
10071 const char *option
= Jim_GetString(argv
[opt
], 0);
10072 if (*option
!= '-') break;
10073 else if (strncmp(option
, "--", 2) == 0) { ++opt
; break; }
10074 else if (strncmp(option
, "-exact", 2) == 0) matchOpt
= SWITCH_EXACT
;
10075 else if (strncmp(option
, "-glob", 2) == 0) matchOpt
= SWITCH_GLOB
;
10076 else if (strncmp(option
, "-regexp", 2) == 0) matchOpt
= SWITCH_RE
;
10077 else if (strncmp(option
, "-command", 2) == 0) { matchOpt
= SWITCH_CMD
;
10078 if ((argc
- opt
) < 2) goto wrongnumargs
;
10079 command
= argv
[++opt
];
10081 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
10082 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
10083 "bad option \"", option
, "\": must be -exact, -glob, "
10084 "-regexp, -command procname or --", 0);
10087 if ((argc
- opt
) < 2) goto wrongnumargs
;
10089 strObj
= argv
[opt
++];
10090 patCount
= argc
- opt
;
10091 if (patCount
== 1) {
10093 JimListGetElements(interp
, argv
[opt
], &patCount
, &vector
);
10096 caseList
= &argv
[opt
];
10097 if (patCount
== 0 || patCount
% 2 != 0) goto wrongnumargs
;
10098 for (i
=0; script
== 0 && i
< patCount
; i
+= 2) {
10099 Jim_Obj
*patObj
= caseList
[i
];
10100 if (!Jim_CompareStringImmediate(interp
, patObj
, "default")
10101 || i
< (patCount
-2)) {
10102 switch (matchOpt
) {
10104 if (Jim_StringEqObj(strObj
, patObj
, 0))
10105 script
= caseList
[i
+1];
10108 if (Jim_StringMatchObj(patObj
, strObj
, 0))
10109 script
= caseList
[i
+1];
10112 command
= Jim_NewStringObj(interp
, "regexp", -1);
10113 /* Fall thru intentionally */
10115 Jim_Obj
*parms
[] = {command
, patObj
, strObj
};
10116 int rc
= Jim_EvalObjVector(interp
, 3, parms
);
10118 /* After the execution of a command we need to
10119 * make sure to reconvert the object into a list
10120 * again. Only for the single-list style [switch]. */
10121 if (argc
-opt
== 1) {
10123 JimListGetElements(interp
, argv
[opt
], &patCount
,
10127 /* command is here already decref'd */
10128 if (rc
!= JIM_OK
) {
10132 rc
= Jim_GetLong(interp
, Jim_GetResult(interp
), &matching
);
10133 if (rc
!= JIM_OK
) {
10138 script
= caseList
[i
+1];
10142 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
10143 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
10144 "internal error: no such option implemented", 0);
10148 script
= caseList
[i
+1];
10151 for(; i
< patCount
&& Jim_CompareStringImmediate(interp
, script
, "-");
10153 script
= caseList
[i
+1];
10154 if (script
&& Jim_CompareStringImmediate(interp
, script
, "-")) {
10155 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
10156 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
10157 "no body specified for pattern \"",
10158 Jim_GetString(caseList
[i
-2], 0), "\"", 0);
10162 Jim_SetEmptyResult(interp
);
10164 retcode
= Jim_EvalObj(interp
, script
);
10167 Jim_WrongNumArgs(interp
, 1, argv
, "?options? string "
10168 "pattern body ... ?default body? or "
10169 "{pattern body ?pattern body ...?}");
10175 static int Jim_ListCoreCommand(Jim_Interp
*interp
, int argc
,
10176 Jim_Obj
*const *argv
)
10178 Jim_Obj
*listObjPtr
;
10180 listObjPtr
= Jim_NewListObj(interp
, argv
+1, argc
-1);
10181 Jim_SetResult(interp
, listObjPtr
);
10186 static int Jim_LindexCoreCommand(Jim_Interp
*interp
, int argc
,
10187 Jim_Obj
*const *argv
)
10189 Jim_Obj
*objPtr
, *listObjPtr
;
10194 Jim_WrongNumArgs(interp
, 1, argv
, "list index ?...?");
10198 Jim_IncrRefCount(objPtr
);
10199 for (i
= 2; i
< argc
; i
++) {
10200 listObjPtr
= objPtr
;
10201 if (Jim_GetIndex(interp
, argv
[i
], &index
) != JIM_OK
) {
10202 Jim_DecrRefCount(interp
, listObjPtr
);
10205 if (Jim_ListIndex(interp
, listObjPtr
, index
, &objPtr
,
10206 JIM_NONE
) != JIM_OK
) {
10207 /* Returns an empty object if the index
10208 * is out of range. */
10209 Jim_DecrRefCount(interp
, listObjPtr
);
10210 Jim_SetEmptyResult(interp
);
10213 Jim_IncrRefCount(objPtr
);
10214 Jim_DecrRefCount(interp
, listObjPtr
);
10216 Jim_SetResult(interp
, objPtr
);
10217 Jim_DecrRefCount(interp
, objPtr
);
10222 static int Jim_LlengthCoreCommand(Jim_Interp
*interp
, int argc
,
10223 Jim_Obj
*const *argv
)
10228 Jim_WrongNumArgs(interp
, 1, argv
, "list");
10231 Jim_ListLength(interp
, argv
[1], &len
);
10232 Jim_SetResult(interp
, Jim_NewIntObj(interp
, len
));
10237 static int Jim_LappendCoreCommand(Jim_Interp
*interp
, int argc
,
10238 Jim_Obj
*const *argv
)
10240 Jim_Obj
*listObjPtr
;
10244 Jim_WrongNumArgs(interp
, 1, argv
, "varName ?value value ...?");
10247 listObjPtr
= Jim_GetVariable(interp
, argv
[1], JIM_NONE
);
10249 /* Create the list if it does not exists */
10250 listObjPtr
= Jim_NewListObj(interp
, NULL
, 0);
10251 if (Jim_SetVariable(interp
, argv
[1], listObjPtr
) != JIM_OK
) {
10252 Jim_FreeNewObj(interp
, listObjPtr
);
10256 shared
= Jim_IsShared(listObjPtr
);
10258 listObjPtr
= Jim_DuplicateObj(interp
, listObjPtr
);
10259 for (i
= 2; i
< argc
; i
++)
10260 Jim_ListAppendElement(interp
, listObjPtr
, argv
[i
]);
10261 if (Jim_SetVariable(interp
, argv
[1], listObjPtr
) != JIM_OK
) {
10263 Jim_FreeNewObj(interp
, listObjPtr
);
10266 Jim_SetResult(interp
, listObjPtr
);
10271 static int Jim_LinsertCoreCommand(Jim_Interp
*interp
, int argc
,
10272 Jim_Obj
*const *argv
)
10278 Jim_WrongNumArgs(interp
, 1, argv
, "list index element "
10283 if (Jim_IsShared(listPtr
))
10284 listPtr
= Jim_DuplicateObj(interp
, listPtr
);
10285 if (Jim_GetIndex(interp
, argv
[2], &index
) != JIM_OK
)
10287 Jim_ListLength(interp
, listPtr
, &len
);
10290 else if (index
< 0)
10291 index
= len
+ index
+ 1;
10292 Jim_ListInsertElements(interp
, listPtr
, index
, argc
-3, &argv
[3]);
10293 Jim_SetResult(interp
, listPtr
);
10296 if (listPtr
!= argv
[1]) {
10297 Jim_FreeNewObj(interp
, listPtr
);
10303 static int Jim_LsetCoreCommand(Jim_Interp
*interp
, int argc
,
10304 Jim_Obj
*const *argv
)
10307 Jim_WrongNumArgs(interp
, 1, argv
, "listVar ?index...? newVal");
10309 } else if (argc
== 3) {
10310 if (Jim_SetVariable(interp
, argv
[1], argv
[2]) != JIM_OK
)
10312 Jim_SetResult(interp
, argv
[2]);
10315 if (Jim_SetListIndex(interp
, argv
[1], argv
+2, argc
-3, argv
[argc
-1])
10316 == JIM_ERR
) return JIM_ERR
;
10321 static int Jim_LsortCoreCommand(Jim_Interp
*interp
, int argc
, Jim_Obj
*const argv
[])
10323 const char *options
[] = {
10324 "-ascii", "-nocase", "-increasing", "-decreasing", NULL
10326 enum {OPT_ASCII
, OPT_NOCASE
, OPT_INCREASING
, OPT_DECREASING
};
10328 int i
, lsortType
= JIM_LSORT_ASCII
; /* default sort type */
10329 int decreasing
= 0;
10332 Jim_WrongNumArgs(interp
, 1, argv
, "?options? list");
10335 for (i
= 1; i
< (argc
-1); i
++) {
10338 if (Jim_GetEnum(interp
, argv
[i
], options
, &option
, "option", JIM_ERRMSG
)
10342 case OPT_ASCII
: lsortType
= JIM_LSORT_ASCII
; break;
10343 case OPT_NOCASE
: lsortType
= JIM_LSORT_NOCASE
; break;
10344 case OPT_INCREASING
: decreasing
= 0; break;
10345 case OPT_DECREASING
: decreasing
= 1; break;
10349 switch(lsortType
) {
10350 case JIM_LSORT_ASCII
: lsortType
= JIM_LSORT_ASCII_DECR
; break;
10351 case JIM_LSORT_NOCASE
: lsortType
= JIM_LSORT_NOCASE_DECR
; break;
10354 resObj
= Jim_DuplicateObj(interp
, argv
[argc
-1]);
10355 ListSortElements(interp
, resObj
, lsortType
);
10356 Jim_SetResult(interp
, resObj
);
10361 static int Jim_AppendCoreCommand(Jim_Interp
*interp
, int argc
,
10362 Jim_Obj
*const *argv
)
10364 Jim_Obj
*stringObjPtr
;
10368 Jim_WrongNumArgs(interp
, 1, argv
, "varName ?value value ...?");
10372 stringObjPtr
= Jim_GetVariable(interp
, argv
[1], JIM_ERRMSG
);
10373 if (!stringObjPtr
) return JIM_ERR
;
10375 stringObjPtr
= Jim_GetVariable(interp
, argv
[1], JIM_NONE
);
10376 if (!stringObjPtr
) {
10377 /* Create the string if it does not exists */
10378 stringObjPtr
= Jim_NewEmptyStringObj(interp
);
10379 if (Jim_SetVariable(interp
, argv
[1], stringObjPtr
)
10381 Jim_FreeNewObj(interp
, stringObjPtr
);
10386 shared
= Jim_IsShared(stringObjPtr
);
10388 stringObjPtr
= Jim_DuplicateObj(interp
, stringObjPtr
);
10389 for (i
= 2; i
< argc
; i
++)
10390 Jim_AppendObj(interp
, stringObjPtr
, argv
[i
]);
10391 if (Jim_SetVariable(interp
, argv
[1], stringObjPtr
) != JIM_OK
) {
10393 Jim_FreeNewObj(interp
, stringObjPtr
);
10396 Jim_SetResult(interp
, stringObjPtr
);
10401 static int Jim_DebugCoreCommand(Jim_Interp
*interp
, int argc
,
10402 Jim_Obj
*const *argv
)
10404 const char *options
[] = {
10405 "refcount", "objcount", "objects", "invstr", "scriptlen", "exprlen",
10410 OPT_REFCOUNT
, OPT_OBJCOUNT
, OPT_OBJECTS
, OPT_INVSTR
, OPT_SCRIPTLEN
,
10411 OPT_EXPRLEN
, OPT_EXPRBC
10416 Jim_WrongNumArgs(interp
, 1, argv
, "option ?...?");
10419 if (Jim_GetEnum(interp
, argv
[1], options
, &option
, "option",
10420 JIM_ERRMSG
) != JIM_OK
)
10422 if (option
== OPT_REFCOUNT
) {
10424 Jim_WrongNumArgs(interp
, 2, argv
, "object");
10427 Jim_SetResult(interp
, Jim_NewIntObj(interp
, argv
[2]->refCount
));
10429 } else if (option
== OPT_OBJCOUNT
) {
10430 int freeobj
= 0, liveobj
= 0;
10435 Jim_WrongNumArgs(interp
, 2, argv
, "");
10438 /* Count the number of free objects. */
10439 objPtr
= interp
->freeList
;
10442 objPtr
= objPtr
->nextObjPtr
;
10444 /* Count the number of live objects. */
10445 objPtr
= interp
->liveList
;
10448 objPtr
= objPtr
->nextObjPtr
;
10450 /* Set the result string and return. */
10451 sprintf(buf
, "free %d used %d", freeobj
, liveobj
);
10452 Jim_SetResultString(interp
, buf
, -1);
10454 } else if (option
== OPT_OBJECTS
) {
10455 Jim_Obj
*objPtr
, *listObjPtr
, *subListObjPtr
;
10456 /* Count the number of live objects. */
10457 objPtr
= interp
->liveList
;
10458 listObjPtr
= Jim_NewListObj(interp
, NULL
, 0);
10461 const char *type
= objPtr
->typePtr
?
10462 objPtr
->typePtr
->name
: "";
10463 subListObjPtr
= Jim_NewListObj(interp
, NULL
, 0);
10464 sprintf(buf
, "%p", objPtr
);
10465 Jim_ListAppendElement(interp
, subListObjPtr
,
10466 Jim_NewStringObj(interp
, buf
, -1));
10467 Jim_ListAppendElement(interp
, subListObjPtr
,
10468 Jim_NewStringObj(interp
, type
, -1));
10469 Jim_ListAppendElement(interp
, subListObjPtr
,
10470 Jim_NewIntObj(interp
, objPtr
->refCount
));
10471 Jim_ListAppendElement(interp
, subListObjPtr
, objPtr
);
10472 Jim_ListAppendElement(interp
, listObjPtr
, subListObjPtr
);
10473 objPtr
= objPtr
->nextObjPtr
;
10475 Jim_SetResult(interp
, listObjPtr
);
10477 } else if (option
== OPT_INVSTR
) {
10481 Jim_WrongNumArgs(interp
, 2, argv
, "object");
10485 if (objPtr
->typePtr
!= NULL
)
10486 Jim_InvalidateStringRep(objPtr
);
10487 Jim_SetEmptyResult(interp
);
10489 } else if (option
== OPT_SCRIPTLEN
) {
10492 Jim_WrongNumArgs(interp
, 2, argv
, "script");
10495 script
= Jim_GetScript(interp
, argv
[2]);
10496 Jim_SetResult(interp
, Jim_NewIntObj(interp
, script
->len
));
10498 } else if (option
== OPT_EXPRLEN
) {
10499 ExprByteCode
*expr
;
10501 Jim_WrongNumArgs(interp
, 2, argv
, "expression");
10504 expr
= Jim_GetExpression(interp
, argv
[2]);
10507 Jim_SetResult(interp
, Jim_NewIntObj(interp
, expr
->len
));
10509 } else if (option
== OPT_EXPRBC
) {
10511 ExprByteCode
*expr
;
10515 Jim_WrongNumArgs(interp
, 2, argv
, "expression");
10518 expr
= Jim_GetExpression(interp
, argv
[2]);
10521 objPtr
= Jim_NewListObj(interp
, NULL
, 0);
10522 for (i
= 0; i
< expr
->len
; i
++) {
10524 Jim_ExprOperator
*op
;
10526 switch(expr
->opcode
[i
]) {
10527 case JIM_EXPROP_NUMBER
: type
= "number"; break;
10528 case JIM_EXPROP_COMMAND
: type
= "command"; break;
10529 case JIM_EXPROP_VARIABLE
: type
= "variable"; break;
10530 case JIM_EXPROP_DICTSUGAR
: type
= "dictsugar"; break;
10531 case JIM_EXPROP_SUBST
: type
= "subst"; break;
10532 case JIM_EXPROP_STRING
: type
= "string"; break;
10534 op
= JimExprOperatorInfo(Jim_GetString(expr
->obj
[i
], NULL
));
10542 Jim_ListAppendElement(interp
, objPtr
,
10543 Jim_NewStringObj(interp
, type
, -1));
10544 Jim_ListAppendElement(interp
, objPtr
, expr
->obj
[i
]);
10546 Jim_SetResult(interp
, objPtr
);
10549 Jim_SetResultString(interp
,
10550 "bad option. Valid options are refcount, "
10551 "objcount, objects, invstr", -1);
10554 return JIM_OK
; /* unreached */
10558 static int Jim_EvalCoreCommand(Jim_Interp
*interp
, int argc
,
10559 Jim_Obj
*const *argv
)
10562 return Jim_EvalObj(interp
, argv
[1]);
10563 } else if (argc
> 2) {
10567 objPtr
= Jim_ConcatObj(interp
, argc
-1, argv
+1);
10568 Jim_IncrRefCount(objPtr
);
10569 retcode
= Jim_EvalObj(interp
, objPtr
);
10570 Jim_DecrRefCount(interp
, objPtr
);
10573 Jim_WrongNumArgs(interp
, 1, argv
, "script ?...?");
10579 static int Jim_UplevelCoreCommand(Jim_Interp
*interp
, int argc
,
10580 Jim_Obj
*const *argv
)
10583 int retcode
, newLevel
, oldLevel
;
10584 Jim_CallFrame
*savedCallFrame
, *targetCallFrame
;
10588 /* Save the old callframe pointer */
10589 savedCallFrame
= interp
->framePtr
;
10591 /* Lookup the target frame pointer */
10592 str
= Jim_GetString(argv
[1], NULL
);
10593 if ((str
[0] >= '0' && str
[0] <= '9') || str
[0] == '#')
10595 if (Jim_GetCallFrameByLevel(interp
, argv
[1],
10597 &newLevel
) != JIM_OK
)
10602 if (Jim_GetCallFrameByLevel(interp
, NULL
,
10604 &newLevel
) != JIM_OK
)
10610 Jim_WrongNumArgs(interp
, 1, argv
,
10611 "?level? command ?arg ...?");
10614 /* Eval the code in the target callframe. */
10615 interp
->framePtr
= targetCallFrame
;
10616 oldLevel
= interp
->numLevels
;
10617 interp
->numLevels
= newLevel
;
10619 retcode
= Jim_EvalObj(interp
, argv
[1]);
10621 objPtr
= Jim_ConcatObj(interp
, argc
-1, argv
+1);
10622 Jim_IncrRefCount(objPtr
);
10623 retcode
= Jim_EvalObj(interp
, objPtr
);
10624 Jim_DecrRefCount(interp
, objPtr
);
10626 interp
->numLevels
= oldLevel
;
10627 interp
->framePtr
= savedCallFrame
;
10630 Jim_WrongNumArgs(interp
, 1, argv
, "?level? command ?arg ...?");
10636 static int Jim_ExprCoreCommand(Jim_Interp
*interp
, int argc
,
10637 Jim_Obj
*const *argv
)
10639 Jim_Obj
*exprResultPtr
;
10643 retcode
= Jim_EvalExpression(interp
, argv
[1], &exprResultPtr
);
10644 } else if (argc
> 2) {
10647 objPtr
= Jim_ConcatObj(interp
, argc
-1, argv
+1);
10648 Jim_IncrRefCount(objPtr
);
10649 retcode
= Jim_EvalExpression(interp
, objPtr
, &exprResultPtr
);
10650 Jim_DecrRefCount(interp
, objPtr
);
10652 Jim_WrongNumArgs(interp
, 1, argv
, "expression ?...?");
10655 if (retcode
!= JIM_OK
) return retcode
;
10656 Jim_SetResult(interp
, exprResultPtr
);
10657 Jim_DecrRefCount(interp
, exprResultPtr
);
10662 static int Jim_BreakCoreCommand(Jim_Interp
*interp
, int argc
,
10663 Jim_Obj
*const *argv
)
10666 Jim_WrongNumArgs(interp
, 1, argv
, "");
10673 static int Jim_ContinueCoreCommand(Jim_Interp
*interp
, int argc
,
10674 Jim_Obj
*const *argv
)
10677 Jim_WrongNumArgs(interp
, 1, argv
, "");
10680 return JIM_CONTINUE
;
10684 static int Jim_ReturnCoreCommand(Jim_Interp
*interp
, int argc
,
10685 Jim_Obj
*const *argv
)
10689 } else if (argc
== 2) {
10690 Jim_SetResult(interp
, argv
[1]);
10691 interp
->returnCode
= JIM_OK
;
10693 } else if (argc
== 3 || argc
== 4) {
10695 if (Jim_GetReturnCode(interp
, argv
[2], &returnCode
) == JIM_ERR
)
10697 interp
->returnCode
= returnCode
;
10699 Jim_SetResult(interp
, argv
[3]);
10702 Jim_WrongNumArgs(interp
, 1, argv
, "?-code code? ?result?");
10705 return JIM_RETURN
; /* unreached */
10709 static int Jim_TailcallCoreCommand(Jim_Interp
*interp
, int argc
,
10710 Jim_Obj
*const *argv
)
10714 objPtr
= Jim_NewListObj(interp
, argv
+1, argc
-1);
10715 Jim_SetResult(interp
, objPtr
);
10720 static int Jim_ProcCoreCommand(Jim_Interp
*interp
, int argc
,
10721 Jim_Obj
*const *argv
)
10724 int arityMin
, arityMax
;
10726 if (argc
!= 4 && argc
!= 5) {
10727 Jim_WrongNumArgs(interp
, 1, argv
, "name arglist ?statics? body");
10730 Jim_ListLength(interp
, argv
[2], &argListLen
);
10731 arityMin
= arityMax
= argListLen
+1;
10735 Jim_Obj
*lastArgPtr
;
10737 Jim_ListIndex(interp
, argv
[2], argListLen
-1, &lastArgPtr
, JIM_NONE
);
10738 str
= Jim_GetString(lastArgPtr
, &len
);
10739 if (len
== 4 && memcmp(str
, "args", 4) == 0) {
10745 return Jim_CreateProcedure(interp
, Jim_GetString(argv
[1], NULL
),
10746 argv
[2], NULL
, argv
[3], arityMin
, arityMax
);
10748 return Jim_CreateProcedure(interp
, Jim_GetString(argv
[1], NULL
),
10749 argv
[2], argv
[3], argv
[4], arityMin
, arityMax
);
10754 static int Jim_ConcatCoreCommand(Jim_Interp
*interp
, int argc
,
10755 Jim_Obj
*const *argv
)
10757 Jim_SetResult(interp
, Jim_ConcatObj(interp
, argc
-1, argv
+1));
10762 static int Jim_UpvarCoreCommand(Jim_Interp
*interp
, int argc
,
10763 Jim_Obj
*const *argv
)
10767 Jim_CallFrame
*targetCallFrame
;
10769 /* Lookup the target frame pointer */
10770 str
= Jim_GetString(argv
[1], NULL
);
10772 ((str
[0] >= '0' && str
[0] <= '9') || str
[0] == '#'))
10774 if (Jim_GetCallFrameByLevel(interp
, argv
[1],
10775 &targetCallFrame
, NULL
) != JIM_OK
)
10780 if (Jim_GetCallFrameByLevel(interp
, NULL
,
10781 &targetCallFrame
, NULL
) != JIM_OK
)
10784 /* Check for arity */
10785 if (argc
< 3 || ((argc
-1)%2) != 0) {
10786 Jim_WrongNumArgs(interp
, 1, argv
, "?level? otherVar localVar ?otherVar localVar ...?");
10789 /* Now... for every other/local couple: */
10790 for (i
= 1; i
< argc
; i
+= 2) {
10791 if (Jim_SetVariableLink(interp
, argv
[i
+1], argv
[i
],
10792 targetCallFrame
) != JIM_OK
) return JIM_ERR
;
10798 static int Jim_GlobalCoreCommand(Jim_Interp
*interp
, int argc
,
10799 Jim_Obj
*const *argv
)
10804 Jim_WrongNumArgs(interp
, 1, argv
, "varName ?varName ...?");
10807 /* Link every var to the toplevel having the same name */
10808 if (interp
->numLevels
== 0) return JIM_OK
; /* global at toplevel... */
10809 for (i
= 1; i
< argc
; i
++) {
10810 if (Jim_SetVariableLink(interp
, argv
[i
], argv
[i
],
10811 interp
->topFramePtr
) != JIM_OK
) return JIM_ERR
;
10816 /* does the [string map] operation. On error NULL is returned,
10817 * otherwise a new string object with the result, having refcount = 0,
10819 static Jim_Obj
*JimStringMap(Jim_Interp
*interp
, Jim_Obj
*mapListObjPtr
,
10820 Jim_Obj
*objPtr
, int nocase
)
10823 const char **key
, *str
, *noMatchStart
= NULL
;
10825 int *keyLen
, strLen
, i
;
10826 Jim_Obj
*resultObjPtr
;
10828 Jim_ListLength(interp
, mapListObjPtr
, &numMaps
);
10830 Jim_SetResultString(interp
,
10831 "list must contain an even number of elements", -1);
10834 /* Initialization */
10836 key
= Jim_Alloc(sizeof(char*)*numMaps
);
10837 keyLen
= Jim_Alloc(sizeof(int)*numMaps
);
10838 value
= Jim_Alloc(sizeof(Jim_Obj
*)*numMaps
);
10839 resultObjPtr
= Jim_NewStringObj(interp
, "", 0);
10840 for (i
= 0; i
< numMaps
; i
++) {
10841 Jim_Obj
*eleObjPtr
;
10843 Jim_ListIndex(interp
, mapListObjPtr
, i
*2, &eleObjPtr
, JIM_NONE
);
10844 key
[i
] = Jim_GetString(eleObjPtr
, &keyLen
[i
]);
10845 Jim_ListIndex(interp
, mapListObjPtr
, i
*2+1, &eleObjPtr
, JIM_NONE
);
10846 value
[i
] = eleObjPtr
;
10848 str
= Jim_GetString(objPtr
, &strLen
);
10851 for (i
= 0; i
< numMaps
; i
++) {
10852 if (strLen
>= keyLen
[i
] && keyLen
[i
]) {
10853 if (!JimStringCompare(str
, keyLen
[i
], key
[i
], keyLen
[i
],
10856 if (noMatchStart
) {
10857 Jim_AppendString(interp
, resultObjPtr
,
10858 noMatchStart
, str
-noMatchStart
);
10859 noMatchStart
= NULL
;
10861 Jim_AppendObj(interp
, resultObjPtr
, value
[i
]);
10863 strLen
-= keyLen
[i
];
10868 if (i
== numMaps
) { /* no match */
10869 if (noMatchStart
== NULL
)
10870 noMatchStart
= str
;
10875 if (noMatchStart
) {
10876 Jim_AppendString(interp
, resultObjPtr
,
10877 noMatchStart
, str
-noMatchStart
);
10879 Jim_Free((void*)key
);
10882 return resultObjPtr
;
10886 static int Jim_StringCoreCommand(Jim_Interp
*interp
, int argc
,
10887 Jim_Obj
*const *argv
)
10890 const char *options
[] = {
10891 "length", "compare", "match", "equal", "range", "map", "repeat",
10892 "index", "first", "tolower", "toupper", NULL
10895 OPT_LENGTH
, OPT_COMPARE
, OPT_MATCH
, OPT_EQUAL
, OPT_RANGE
,
10896 OPT_MAP
, OPT_REPEAT
, OPT_INDEX
, OPT_FIRST
, OPT_TOLOWER
, OPT_TOUPPER
10900 Jim_WrongNumArgs(interp
, 1, argv
, "option ?arguments ...?");
10903 if (Jim_GetEnum(interp
, argv
[1], options
, &option
, "option",
10904 JIM_ERRMSG
) != JIM_OK
)
10907 if (option
== OPT_LENGTH
) {
10911 Jim_WrongNumArgs(interp
, 2, argv
, "string");
10914 Jim_GetString(argv
[2], &len
);
10915 Jim_SetResult(interp
, Jim_NewIntObj(interp
, len
));
10917 } else if (option
== OPT_COMPARE
) {
10919 if ((argc
!= 4 && argc
!= 5) ||
10920 (argc
== 5 && Jim_CompareStringImmediate(interp
,
10921 argv
[2], "-nocase") == 0)) {
10922 Jim_WrongNumArgs(interp
, 2, argv
, "string1 string2");
10929 Jim_SetResult(interp
, Jim_NewIntObj(interp
,
10930 Jim_StringCompareObj(argv
[2],
10931 argv
[3], nocase
)));
10933 } else if (option
== OPT_MATCH
) {
10935 if ((argc
!= 4 && argc
!= 5) ||
10936 (argc
== 5 && Jim_CompareStringImmediate(interp
,
10937 argv
[2], "-nocase") == 0)) {
10938 Jim_WrongNumArgs(interp
, 2, argv
, "?-nocase? pattern "
10946 Jim_SetResult(interp
,
10947 Jim_NewIntObj(interp
, Jim_StringMatchObj(argv
[2],
10948 argv
[3], nocase
)));
10950 } else if (option
== OPT_EQUAL
) {
10952 Jim_WrongNumArgs(interp
, 2, argv
, "string1 string2");
10955 Jim_SetResult(interp
,
10956 Jim_NewIntObj(interp
, Jim_StringEqObj(argv
[2],
10959 } else if (option
== OPT_RANGE
) {
10963 Jim_WrongNumArgs(interp
, 2, argv
, "string first last");
10966 objPtr
= Jim_StringRangeObj(interp
, argv
[2], argv
[3], argv
[4]);
10967 if (objPtr
== NULL
)
10969 Jim_SetResult(interp
, objPtr
);
10971 } else if (option
== OPT_MAP
) {
10975 if ((argc
!= 4 && argc
!= 5) ||
10976 (argc
== 5 && Jim_CompareStringImmediate(interp
,
10977 argv
[2], "-nocase") == 0)) {
10978 Jim_WrongNumArgs(interp
, 2, argv
, "?-nocase? mapList "
10986 objPtr
= JimStringMap(interp
, argv
[2], argv
[3], nocase
);
10987 if (objPtr
== NULL
)
10989 Jim_SetResult(interp
, objPtr
);
10991 } else if (option
== OPT_REPEAT
) {
10996 Jim_WrongNumArgs(interp
, 2, argv
, "string count");
10999 if (Jim_GetWide(interp
, argv
[3], &count
) != JIM_OK
)
11001 objPtr
= Jim_NewStringObj(interp
, "", 0);
11003 Jim_AppendObj(interp
, objPtr
, argv
[2]);
11005 Jim_SetResult(interp
, objPtr
);
11007 } else if (option
== OPT_INDEX
) {
11012 Jim_WrongNumArgs(interp
, 2, argv
, "string index");
11015 if (Jim_GetIndex(interp
, argv
[3], &index
) != JIM_OK
)
11017 str
= Jim_GetString(argv
[2], &len
);
11018 if (index
!= INT_MIN
&& index
!= INT_MAX
)
11019 index
= JimRelToAbsIndex(len
, index
);
11020 if (index
< 0 || index
>= len
) {
11021 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
11024 Jim_SetResult(interp
, Jim_NewStringObj(interp
, str
+index
, 1));
11027 } else if (option
== OPT_FIRST
) {
11028 int index
= 0, l1
, l2
;
11029 const char *s1
, *s2
;
11031 if (argc
!= 4 && argc
!= 5) {
11032 Jim_WrongNumArgs(interp
, 2, argv
, "subString string ?startIndex?");
11035 s1
= Jim_GetString(argv
[2], &l1
);
11036 s2
= Jim_GetString(argv
[3], &l2
);
11038 if (Jim_GetIndex(interp
, argv
[4], &index
) != JIM_OK
)
11040 index
= JimRelToAbsIndex(l2
, index
);
11042 Jim_SetResult(interp
, Jim_NewIntObj(interp
,
11043 JimStringFirst(s1
, l1
, s2
, l2
, index
)));
11045 } else if (option
== OPT_TOLOWER
) {
11047 Jim_WrongNumArgs(interp
, 2, argv
, "string");
11050 Jim_SetResult(interp
, JimStringToLower(interp
, argv
[2]));
11051 } else if (option
== OPT_TOUPPER
) {
11053 Jim_WrongNumArgs(interp
, 2, argv
, "string");
11056 Jim_SetResult(interp
, JimStringToUpper(interp
, argv
[2]));
11062 static int Jim_TimeCoreCommand(Jim_Interp
*interp
, int argc
,
11063 Jim_Obj
*const *argv
)
11066 jim_wide start
, elapsed
;
11068 const char *fmt
= "%" JIM_WIDE_MODIFIER
" microseconds per iteration";
11071 Jim_WrongNumArgs(interp
, 1, argv
, "script ?count?");
11075 if (Jim_GetLong(interp
, argv
[2], &count
) != JIM_OK
)
11081 start
= JimClock();
11085 if ((retval
= Jim_EvalObj(interp
, argv
[1])) != JIM_OK
)
11088 elapsed
= JimClock() - start
;
11089 sprintf(buf
, fmt
, elapsed
/count
);
11090 Jim_SetResultString(interp
, buf
, -1);
11095 static int Jim_ExitCoreCommand(Jim_Interp
*interp
, int argc
,
11096 Jim_Obj
*const *argv
)
11101 Jim_WrongNumArgs(interp
, 1, argv
, "?exitCode?");
11105 if (Jim_GetLong(interp
, argv
[1], &exitCode
) != JIM_OK
)
11108 interp
->exitCode
= exitCode
;
11113 static int Jim_CatchCoreCommand(Jim_Interp
*interp
, int argc
,
11114 Jim_Obj
*const *argv
)
11118 if (argc
!= 2 && argc
!= 3) {
11119 Jim_WrongNumArgs(interp
, 1, argv
, "script ?varName?");
11122 exitCode
= Jim_EvalObj(interp
, argv
[1]);
11124 if (Jim_SetVariable(interp
, argv
[2], Jim_GetResult(interp
))
11128 Jim_SetResult(interp
, Jim_NewIntObj(interp
, exitCode
));
11133 static int Jim_RefCoreCommand(Jim_Interp
*interp
, int argc
,
11134 Jim_Obj
*const *argv
)
11136 if (argc
!= 3 && argc
!= 4) {
11137 Jim_WrongNumArgs(interp
, 1, argv
, "string tag ?finalizer?");
11141 Jim_SetResult(interp
, Jim_NewReference(interp
, argv
[1], argv
[2], NULL
));
11143 Jim_SetResult(interp
, Jim_NewReference(interp
, argv
[1], argv
[2],
11150 static int Jim_GetrefCoreCommand(Jim_Interp
*interp
, int argc
,
11151 Jim_Obj
*const *argv
)
11153 Jim_Reference
*refPtr
;
11156 Jim_WrongNumArgs(interp
, 1, argv
, "reference");
11159 if ((refPtr
= Jim_GetReference(interp
, argv
[1])) == NULL
)
11161 Jim_SetResult(interp
, refPtr
->objPtr
);
11166 static int Jim_SetrefCoreCommand(Jim_Interp
*interp
, int argc
,
11167 Jim_Obj
*const *argv
)
11169 Jim_Reference
*refPtr
;
11172 Jim_WrongNumArgs(interp
, 1, argv
, "reference newValue");
11175 if ((refPtr
= Jim_GetReference(interp
, argv
[1])) == NULL
)
11177 Jim_IncrRefCount(argv
[2]);
11178 Jim_DecrRefCount(interp
, refPtr
->objPtr
);
11179 refPtr
->objPtr
= argv
[2];
11180 Jim_SetResult(interp
, argv
[2]);
11185 static int Jim_CollectCoreCommand(Jim_Interp
*interp
, int argc
,
11186 Jim_Obj
*const *argv
)
11189 Jim_WrongNumArgs(interp
, 1, argv
, "");
11192 Jim_SetResult(interp
, Jim_NewIntObj(interp
, Jim_Collect(interp
)));
11196 /* [finalize] reference ?newValue? */
11197 static int Jim_FinalizeCoreCommand(Jim_Interp
*interp
, int argc
,
11198 Jim_Obj
*const *argv
)
11200 if (argc
!= 2 && argc
!= 3) {
11201 Jim_WrongNumArgs(interp
, 1, argv
, "reference ?finalizerProc?");
11205 Jim_Obj
*cmdNamePtr
;
11207 if (Jim_GetFinalizer(interp
, argv
[1], &cmdNamePtr
) != JIM_OK
)
11209 if (cmdNamePtr
!= NULL
) /* otherwise the null string is returned. */
11210 Jim_SetResult(interp
, cmdNamePtr
);
11212 if (Jim_SetFinalizer(interp
, argv
[1], argv
[2]) != JIM_OK
)
11214 Jim_SetResult(interp
, argv
[2]);
11220 /* [info references] (list of all the references/finalizers) */
11223 static int Jim_RenameCoreCommand(Jim_Interp
*interp
, int argc
,
11224 Jim_Obj
*const *argv
)
11226 const char *oldName
, *newName
;
11229 Jim_WrongNumArgs(interp
, 1, argv
, "oldName newName");
11232 oldName
= Jim_GetString(argv
[1], NULL
);
11233 newName
= Jim_GetString(argv
[2], NULL
);
11234 if (Jim_RenameCommand(interp
, oldName
, newName
) != JIM_OK
) {
11235 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
11236 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
11237 "can't rename \"", oldName
, "\": ",
11238 "command doesn't exist", NULL
);
11245 static int Jim_DictCoreCommand(Jim_Interp
*interp
, int argc
,
11246 Jim_Obj
*const *argv
)
11249 const char *options
[] = {
11250 "create", "get", "set", "unset", "exists", NULL
11253 OPT_CREATE
, OPT_GET
, OPT_SET
, OPT_UNSET
, OPT_EXIST
11257 Jim_WrongNumArgs(interp
, 1, argv
, "option ?arguments ...?");
11261 if (Jim_GetEnum(interp
, argv
[1], options
, &option
, "option",
11262 JIM_ERRMSG
) != JIM_OK
)
11265 if (option
== OPT_CREATE
) {
11269 Jim_WrongNumArgs(interp
, 2, argv
, "?key value ...?");
11272 objPtr
= Jim_NewDictObj(interp
, argv
+2, argc
-2);
11273 Jim_SetResult(interp
, objPtr
);
11275 } else if (option
== OPT_GET
) {
11278 if (Jim_DictKeysVector(interp
, argv
[2], argv
+3, argc
-3, &objPtr
,
11279 JIM_ERRMSG
) != JIM_OK
)
11281 Jim_SetResult(interp
, objPtr
);
11283 } else if (option
== OPT_SET
) {
11285 Jim_WrongNumArgs(interp
, 2, argv
, "varName key ?key ...? value");
11288 return Jim_SetDictKeysVector(interp
, argv
[2], argv
+3, argc
-4,
11290 } else if (option
== OPT_UNSET
) {
11292 Jim_WrongNumArgs(interp
, 2, argv
, "varName key ?key ...?");
11295 return Jim_SetDictKeysVector(interp
, argv
[2], argv
+3, argc
-3,
11297 } else if (option
== OPT_EXIST
) {
11301 if (Jim_DictKeysVector(interp
, argv
[2], argv
+3, argc
-3, &objPtr
,
11302 JIM_ERRMSG
) == JIM_OK
)
11306 Jim_SetResult(interp
, Jim_NewIntObj(interp
, exists
));
11309 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
11310 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
11311 "bad option \"", Jim_GetString(argv
[1], NULL
), "\":",
11312 " must be create, get, set", NULL
);
11319 static int Jim_LoadCoreCommand(Jim_Interp
*interp
, int argc
,
11320 Jim_Obj
*const *argv
)
11323 Jim_WrongNumArgs(interp
, 1, argv
, "libaryFile");
11326 return Jim_LoadLibrary(interp
, Jim_GetString(argv
[1], NULL
));
11330 static int Jim_SubstCoreCommand(Jim_Interp
*interp
, int argc
,
11331 Jim_Obj
*const *argv
)
11337 Jim_WrongNumArgs(interp
, 1, argv
,
11338 "?-nobackslashes? ?-nocommands? ?-novariables? string");
11343 if (Jim_CompareStringImmediate(interp
, argv
[i
+1],
11345 flags
|= JIM_SUBST_NOESC
;
11346 else if (Jim_CompareStringImmediate(interp
, argv
[i
+1],
11348 flags
|= JIM_SUBST_NOVAR
;
11349 else if (Jim_CompareStringImmediate(interp
, argv
[i
+1],
11351 flags
|= JIM_SUBST_NOCMD
;
11353 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
11354 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
11355 "bad option \"", Jim_GetString(argv
[i
+1], NULL
),
11356 "\": must be -nobackslashes, -nocommands, or "
11357 "-novariables", NULL
);
11361 if (Jim_SubstObj(interp
, argv
[argc
-1], &objPtr
, flags
) != JIM_OK
)
11363 Jim_SetResult(interp
, objPtr
);
11368 static int Jim_InfoCoreCommand(Jim_Interp
*interp
, int argc
,
11369 Jim_Obj
*const *argv
)
11371 int cmd
, result
= JIM_OK
;
11372 static const char *commands
[] = {
11373 "body", "commands", "exists", "globals", "level", "locals",
11374 "vars", "version", "complete", "args", NULL
11376 enum {INFO_BODY
, INFO_COMMANDS
, INFO_EXISTS
, INFO_GLOBALS
, INFO_LEVEL
,
11377 INFO_LOCALS
, INFO_VARS
, INFO_VERSION
, INFO_COMPLETE
, INFO_ARGS
};
11380 Jim_WrongNumArgs(interp
, 1, argv
, "command ?args ...?");
11383 if (Jim_GetEnum(interp
, argv
[1], commands
, &cmd
, "command", JIM_ERRMSG
)
11388 if (cmd
== INFO_COMMANDS
) {
11389 if (argc
!= 2 && argc
!= 3) {
11390 Jim_WrongNumArgs(interp
, 2, argv
, "?pattern?");
11394 Jim_SetResult(interp
,JimCommandsList(interp
, argv
[2]));
11396 Jim_SetResult(interp
, JimCommandsList(interp
, NULL
));
11397 } else if (cmd
== INFO_EXISTS
) {
11400 Jim_WrongNumArgs(interp
, 2, argv
, "varName");
11403 exists
= Jim_GetVariable(interp
, argv
[2], 0);
11404 Jim_SetResult(interp
, Jim_NewIntObj(interp
, exists
!= 0));
11405 } else if (cmd
== INFO_GLOBALS
|| cmd
== INFO_LOCALS
|| cmd
== INFO_VARS
) {
11408 case INFO_GLOBALS
: mode
= JIM_VARLIST_GLOBALS
; break;
11409 case INFO_LOCALS
: mode
= JIM_VARLIST_LOCALS
; break;
11410 case INFO_VARS
: mode
= JIM_VARLIST_VARS
; break;
11411 default: mode
= 0; /* avoid warning */; break;
11413 if (argc
!= 2 && argc
!= 3) {
11414 Jim_WrongNumArgs(interp
, 2, argv
, "?pattern?");
11418 Jim_SetResult(interp
,JimVariablesList(interp
, argv
[2], mode
));
11420 Jim_SetResult(interp
, JimVariablesList(interp
, NULL
, mode
));
11421 } else if (cmd
== INFO_LEVEL
) {
11425 Jim_SetResult(interp
,
11426 Jim_NewIntObj(interp
, interp
->numLevels
));
11429 if (JimInfoLevel(interp
, argv
[2], &objPtr
) != JIM_OK
)
11431 Jim_SetResult(interp
, objPtr
);
11434 Jim_WrongNumArgs(interp
, 2, argv
, "?levelNum?");
11437 } else if (cmd
== INFO_BODY
|| cmd
== INFO_ARGS
) {
11441 Jim_WrongNumArgs(interp
, 2, argv
, "procname");
11444 if ((cmdPtr
= Jim_GetCommand(interp
, argv
[2], JIM_ERRMSG
)) == NULL
)
11446 if (cmdPtr
->cmdProc
!= NULL
) {
11447 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
11448 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
11449 "command \"", Jim_GetString(argv
[2], NULL
),
11450 "\" is not a procedure", NULL
);
11453 if (cmd
== INFO_BODY
)
11454 Jim_SetResult(interp
, cmdPtr
->bodyObjPtr
);
11456 Jim_SetResult(interp
, cmdPtr
->argListObjPtr
);
11457 } else if (cmd
== INFO_VERSION
) {
11458 char buf
[(JIM_INTEGER_SPACE
* 2) + 1];
11459 sprintf(buf
, "%d.%d",
11460 JIM_VERSION
/ 100, JIM_VERSION
% 100);
11461 Jim_SetResultString(interp
, buf
, -1);
11462 } else if (cmd
== INFO_COMPLETE
) {
11467 Jim_WrongNumArgs(interp
, 2, argv
, "script");
11470 s
= Jim_GetString(argv
[2], &len
);
11471 Jim_SetResult(interp
,
11472 Jim_NewIntObj(interp
, Jim_ScriptIsComplete(s
, len
, NULL
)));
11478 static int Jim_SplitCoreCommand(Jim_Interp
*interp
, int argc
,
11479 Jim_Obj
*const *argv
)
11481 const char *str
, *splitChars
, *noMatchStart
;
11482 int splitLen
, strLen
, i
;
11483 Jim_Obj
*resObjPtr
;
11485 if (argc
!= 2 && argc
!= 3) {
11486 Jim_WrongNumArgs(interp
, 1, argv
, "string ?splitChars?");
11491 splitChars
= " \n\t\r";
11494 splitChars
= Jim_GetString(argv
[2], &splitLen
);
11496 str
= Jim_GetString(argv
[1], &strLen
);
11497 if (!strLen
) return JIM_OK
;
11498 noMatchStart
= str
;
11499 resObjPtr
= Jim_NewListObj(interp
, NULL
, 0);
11503 for (i
= 0; i
< splitLen
; i
++) {
11504 if (*str
== splitChars
[i
]) {
11507 objPtr
= Jim_NewStringObj(interp
, noMatchStart
,
11508 (str
-noMatchStart
));
11509 Jim_ListAppendElement(interp
, resObjPtr
, objPtr
);
11510 noMatchStart
= str
+1;
11517 Jim_ListAppendElement(interp
, resObjPtr
,
11518 Jim_NewStringObj(interp
, noMatchStart
, (str
-noMatchStart
)));
11520 /* This handles the special case of splitchars eq {}. This
11521 * is trivial but we want to perform object sharing as Tcl does. */
11522 Jim_Obj
*objCache
[256];
11523 const unsigned char *u
= (unsigned char*) str
;
11524 memset(objCache
, 0, sizeof(objCache
));
11525 for (i
= 0; i
< strLen
; i
++) {
11528 if (objCache
[c
] == NULL
)
11529 objCache
[c
] = Jim_NewStringObj(interp
, (char*)u
+i
, 1);
11530 Jim_ListAppendElement(interp
, resObjPtr
, objCache
[c
]);
11533 Jim_SetResult(interp
, resObjPtr
);
11538 static int Jim_JoinCoreCommand(Jim_Interp
*interp
, int argc
,
11539 Jim_Obj
*const *argv
)
11541 const char *joinStr
;
11542 int joinStrLen
, i
, listLen
;
11543 Jim_Obj
*resObjPtr
;
11545 if (argc
!= 2 && argc
!= 3) {
11546 Jim_WrongNumArgs(interp
, 1, argv
, "list ?joinString?");
11554 joinStr
= Jim_GetString(argv
[2], &joinStrLen
);
11556 Jim_ListLength(interp
, argv
[1], &listLen
);
11557 resObjPtr
= Jim_NewStringObj(interp
, NULL
, 0);
11559 for (i
= 0; i
< listLen
; i
++) {
11562 Jim_ListIndex(interp
, argv
[1], i
, &objPtr
, JIM_NONE
);
11563 Jim_AppendObj(interp
, resObjPtr
, objPtr
);
11564 if (i
+1 != listLen
) {
11565 Jim_AppendString(interp
, resObjPtr
, joinStr
, joinStrLen
);
11568 Jim_SetResult(interp
, resObjPtr
);
11573 static int Jim_FormatCoreCommand(Jim_Interp
*interp
, int argc
,
11574 Jim_Obj
*const *argv
)
11579 Jim_WrongNumArgs(interp
, 1, argv
, "formatString ?arg arg ...?");
11582 objPtr
= Jim_FormatString(interp
, argv
[1], argc
-2, argv
+2);
11583 if (objPtr
== NULL
)
11585 Jim_SetResult(interp
, objPtr
);
11590 static int Jim_ScanCoreCommand(Jim_Interp
*interp
, int argc
,
11591 Jim_Obj
*const *argv
)
11593 Jim_Obj
*listPtr
, **outVec
;
11594 int outc
, i
, count
= 0;
11597 Jim_WrongNumArgs(interp
, 1, argv
, "string formatString ?varName ...?");
11600 if (argv
[2]->typePtr
!= &scanFmtStringObjType
)
11601 SetScanFmtFromAny(interp
, argv
[2]);
11602 if (FormatGetError(argv
[2]) != 0) {
11603 Jim_SetResultString(interp
, FormatGetError(argv
[2]), -1);
11607 int maxPos
= FormatGetMaxPos(argv
[2]);
11608 int count
= FormatGetCnvCount(argv
[2]);
11609 if (maxPos
> argc
-3) {
11610 Jim_SetResultString(interp
, "\"%n$\" argument index out of range", -1);
11612 } else if (count
!= 0 && count
< argc
-3) {
11613 Jim_SetResultString(interp
, "variable is not assigned by any "
11614 "conversion specifiers", -1);
11616 } else if (count
> argc
-3) {
11617 Jim_SetResultString(interp
, "different numbers of variable names and "
11618 "field specifiers", -1);
11622 listPtr
= Jim_ScanString(interp
, argv
[1], argv
[2], JIM_ERRMSG
);
11627 if (listPtr
!= 0 && listPtr
!= (Jim_Obj
*)EOF
)
11628 Jim_ListLength(interp
, listPtr
, &len
);
11629 if (listPtr
== (Jim_Obj
*)EOF
|| len
== 0) { // XXX
11630 Jim_SetResult(interp
, Jim_NewIntObj(interp
, -1));
11633 JimListGetElements(interp
, listPtr
, &outc
, &outVec
);
11634 for (i
= 0; i
< outc
; ++i
) {
11635 if (Jim_Length(outVec
[i
]) > 0) {
11637 if (Jim_SetVariable(interp
, argv
[3+i
], outVec
[i
]) != JIM_OK
)
11641 Jim_FreeNewObj(interp
, listPtr
);
11642 Jim_SetResult(interp
, Jim_NewIntObj(interp
, count
));
11644 if (listPtr
== (Jim_Obj
*)EOF
) {
11645 Jim_SetResult(interp
, Jim_NewListObj(interp
, 0, 0));
11648 Jim_SetResult(interp
, listPtr
);
11652 Jim_FreeNewObj(interp
, listPtr
);
11657 static int Jim_ErrorCoreCommand(Jim_Interp
*interp
, int argc
,
11658 Jim_Obj
*const *argv
)
11661 Jim_WrongNumArgs(interp
, 1, argv
, "message");
11664 Jim_SetResult(interp
, argv
[1]);
11669 static int Jim_LrangeCoreCommand(Jim_Interp
*interp
, int argc
,
11670 Jim_Obj
*const *argv
)
11675 Jim_WrongNumArgs(interp
, 1, argv
, "list first last");
11678 if ((objPtr
= Jim_ListRange(interp
, argv
[1], argv
[2], argv
[3])) == NULL
)
11680 Jim_SetResult(interp
, objPtr
);
11685 static int Jim_EnvCoreCommand(Jim_Interp
*interp
, int argc
,
11686 Jim_Obj
*const *argv
)
11692 Jim_WrongNumArgs(interp
, 1, argv
, "varName");
11695 key
= Jim_GetString(argv
[1], NULL
);
11698 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
11699 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
11700 "environment variable \"",
11701 key
, "\" does not exist", NULL
);
11704 Jim_SetResult(interp
, Jim_NewStringObj(interp
, val
, -1));
11709 static int Jim_SourceCoreCommand(Jim_Interp
*interp
, int argc
,
11710 Jim_Obj
*const *argv
)
11715 Jim_WrongNumArgs(interp
, 1, argv
, "fileName");
11718 retval
= Jim_EvalFile(interp
, Jim_GetString(argv
[1], NULL
));
11719 if (retval
== JIM_RETURN
)
11725 static int Jim_LreverseCoreCommand(Jim_Interp
*interp
, int argc
,
11726 Jim_Obj
*const *argv
)
11728 Jim_Obj
*revObjPtr
, **ele
;
11732 Jim_WrongNumArgs(interp
, 1, argv
, "list");
11735 JimListGetElements(interp
, argv
[1], &len
, &ele
);
11737 revObjPtr
= Jim_NewListObj(interp
, NULL
, 0);
11739 ListAppendElement(revObjPtr
, ele
[len
--]);
11740 Jim_SetResult(interp
, revObjPtr
);
11744 static int JimRangeLen(jim_wide start
, jim_wide end
, jim_wide step
)
11748 if (step
== 0) return -1;
11749 if (start
== end
) return 0;
11750 else if (step
> 0 && start
> end
) return -1;
11751 else if (step
< 0 && end
> start
) return -1;
11753 if (len
< 0) len
= -len
; /* abs(len) */
11754 if (step
< 0) step
= -step
; /* abs(step) */
11755 len
= 1 + ((len
-1)/step
);
11756 /* We can truncate safely to INT_MAX, the range command
11757 * will always return an error for a such long range
11758 * because Tcl lists can't be so long. */
11759 if (len
> INT_MAX
) len
= INT_MAX
;
11760 return (int)((len
< 0) ? -1 : len
);
11764 static int Jim_RangeCoreCommand(Jim_Interp
*interp
, int argc
,
11765 Jim_Obj
*const *argv
)
11767 jim_wide start
= 0, end
, step
= 1;
11771 if (argc
< 2 || argc
> 4) {
11772 Jim_WrongNumArgs(interp
, 1, argv
, "?start? end ?step?");
11776 if (Jim_GetWide(interp
, argv
[1], &end
) != JIM_OK
)
11779 if (Jim_GetWide(interp
, argv
[1], &start
) != JIM_OK
||
11780 Jim_GetWide(interp
, argv
[2], &end
) != JIM_OK
)
11782 if (argc
== 4 && Jim_GetWide(interp
, argv
[3], &step
) != JIM_OK
)
11785 if ((len
= JimRangeLen(start
, end
, step
)) == -1) {
11786 Jim_SetResultString(interp
, "Invalid (infinite?) range specified", -1);
11789 objPtr
= Jim_NewListObj(interp
, NULL
, 0);
11790 for (i
= 0; i
< len
; i
++)
11791 ListAppendElement(objPtr
, Jim_NewIntObj(interp
, start
+i
*step
));
11792 Jim_SetResult(interp
, objPtr
);
11797 static int Jim_RandCoreCommand(Jim_Interp
*interp
, int argc
,
11798 Jim_Obj
*const *argv
)
11800 jim_wide min
= 0, max
, len
, maxMul
;
11802 if (argc
< 1 || argc
> 3) {
11803 Jim_WrongNumArgs(interp
, 1, argv
, "?min? max");
11807 max
= JIM_WIDE_MAX
;
11808 } else if (argc
== 2) {
11809 if (Jim_GetWide(interp
, argv
[1], &max
) != JIM_OK
)
11811 } else if (argc
== 3) {
11812 if (Jim_GetWide(interp
, argv
[1], &min
) != JIM_OK
||
11813 Jim_GetWide(interp
, argv
[2], &max
) != JIM_OK
)
11818 Jim_SetResultString(interp
, "Invalid arguments (max < min)", -1);
11821 maxMul
= JIM_WIDE_MAX
- (len
? (JIM_WIDE_MAX
%len
) : 0);
11825 JimRandomBytes(interp
, &r
, sizeof(jim_wide
));
11826 if (r
< 0 || r
>= maxMul
) continue;
11827 r
= (len
== 0) ? 0 : r
%len
;
11828 Jim_SetResult(interp
, Jim_NewIntObj(interp
, min
+r
));
11834 static int Jim_PackageCoreCommand(Jim_Interp
*interp
, int argc
,
11835 Jim_Obj
*const *argv
)
11838 const char *options
[] = {
11839 "require", "provide", NULL
11841 enum {OPT_REQUIRE
, OPT_PROVIDE
};
11844 Jim_WrongNumArgs(interp
, 1, argv
, "option ?arguments ...?");
11847 if (Jim_GetEnum(interp
, argv
[1], options
, &option
, "option",
11848 JIM_ERRMSG
) != JIM_OK
)
11851 if (option
== OPT_REQUIRE
) {
11855 if (Jim_CompareStringImmediate(interp
, argv
[2], "-exact")) {
11860 if (argc
!= 3 && argc
!= 4) {
11861 Jim_WrongNumArgs(interp
, 2, argv
, "?-exact? package ?version?");
11864 ver
= Jim_PackageRequire(interp
, Jim_GetString(argv
[2], NULL
),
11865 argc
== 4 ? Jim_GetString(argv
[3], NULL
) : "",
11869 Jim_SetResultString(interp
, ver
, -1);
11870 } else if (option
== OPT_PROVIDE
) {
11872 Jim_WrongNumArgs(interp
, 2, argv
, "package version");
11875 return Jim_PackageProvide(interp
, Jim_GetString(argv
[2], NULL
),
11876 Jim_GetString(argv
[3], NULL
), JIM_ERRMSG
);
11883 Jim_CmdProc cmdProc
;
11884 } Jim_CoreCommandsTable
[] = {
11885 {"set", Jim_SetCoreCommand
},
11886 {"unset", Jim_UnsetCoreCommand
},
11887 {"puts", Jim_PutsCoreCommand
},
11888 {"+", Jim_AddCoreCommand
},
11889 {"*", Jim_MulCoreCommand
},
11890 {"-", Jim_SubCoreCommand
},
11891 {"/", Jim_DivCoreCommand
},
11892 {"incr", Jim_IncrCoreCommand
},
11893 {"while", Jim_WhileCoreCommand
},
11894 {"for", Jim_ForCoreCommand
},
11895 {"foreach", Jim_ForeachCoreCommand
},
11896 {"lmap", Jim_LmapCoreCommand
},
11897 {"if", Jim_IfCoreCommand
},
11898 {"switch", Jim_SwitchCoreCommand
},
11899 {"list", Jim_ListCoreCommand
},
11900 {"lindex", Jim_LindexCoreCommand
},
11901 {"lset", Jim_LsetCoreCommand
},
11902 {"llength", Jim_LlengthCoreCommand
},
11903 {"lappend", Jim_LappendCoreCommand
},
11904 {"linsert", Jim_LinsertCoreCommand
},
11905 {"lsort", Jim_LsortCoreCommand
},
11906 {"append", Jim_AppendCoreCommand
},
11907 {"debug", Jim_DebugCoreCommand
},
11908 {"eval", Jim_EvalCoreCommand
},
11909 {"uplevel", Jim_UplevelCoreCommand
},
11910 {"expr", Jim_ExprCoreCommand
},
11911 {"break", Jim_BreakCoreCommand
},
11912 {"continue", Jim_ContinueCoreCommand
},
11913 {"proc", Jim_ProcCoreCommand
},
11914 {"concat", Jim_ConcatCoreCommand
},
11915 {"return", Jim_ReturnCoreCommand
},
11916 {"upvar", Jim_UpvarCoreCommand
},
11917 {"global", Jim_GlobalCoreCommand
},
11918 {"string", Jim_StringCoreCommand
},
11919 {"time", Jim_TimeCoreCommand
},
11920 {"exit", Jim_ExitCoreCommand
},
11921 {"catch", Jim_CatchCoreCommand
},
11922 {"ref", Jim_RefCoreCommand
},
11923 {"getref", Jim_GetrefCoreCommand
},
11924 {"setref", Jim_SetrefCoreCommand
},
11925 {"finalize", Jim_FinalizeCoreCommand
},
11926 {"collect", Jim_CollectCoreCommand
},
11927 {"rename", Jim_RenameCoreCommand
},
11928 {"dict", Jim_DictCoreCommand
},
11929 {"load", Jim_LoadCoreCommand
},
11930 {"subst", Jim_SubstCoreCommand
},
11931 {"info", Jim_InfoCoreCommand
},
11932 {"split", Jim_SplitCoreCommand
},
11933 {"join", Jim_JoinCoreCommand
},
11934 {"format", Jim_FormatCoreCommand
},
11935 {"scan", Jim_ScanCoreCommand
},
11936 {"error", Jim_ErrorCoreCommand
},
11937 {"lrange", Jim_LrangeCoreCommand
},
11938 {"env", Jim_EnvCoreCommand
},
11939 {"source", Jim_SourceCoreCommand
},
11940 {"lreverse", Jim_LreverseCoreCommand
},
11941 {"range", Jim_RangeCoreCommand
},
11942 {"rand", Jim_RandCoreCommand
},
11943 {"package", Jim_PackageCoreCommand
},
11944 {"tailcall", Jim_TailcallCoreCommand
},
11948 /* Some Jim core command is actually a procedure written in Jim itself. */
11949 static void Jim_RegisterCoreProcedures(Jim_Interp
*interp
)
11951 Jim_Eval(interp
, (char*)
11952 "proc lambda {arglist args} {\n"
11953 " set name [ref {} function lambdaFinalizer]\n"
11954 " uplevel 1 [list proc $name $arglist {expand}$args]\n"
11957 "proc lambdaFinalizer {name val} {\n"
11958 " rename $name {}\n"
11963 void Jim_RegisterCoreCommands(Jim_Interp
*interp
)
11967 while(Jim_CoreCommandsTable
[i
].name
!= NULL
) {
11968 Jim_CreateCommand(interp
,
11969 Jim_CoreCommandsTable
[i
].name
,
11970 Jim_CoreCommandsTable
[i
].cmdProc
,
11974 Jim_RegisterCoreProcedures(interp
);
11977 /* -----------------------------------------------------------------------------
11978 * Interactive prompt
11979 * ---------------------------------------------------------------------------*/
11980 void Jim_PrintErrorMessage(Jim_Interp
*interp
)
11984 Jim_fprintf(interp
, interp
->cookie_stderr
, "Runtime error, file \"%s\", line %d:" JIM_NL
,
11985 interp
->errorFileName
, interp
->errorLine
);
11986 Jim_fprintf(interp
,interp
->cookie_stderr
, " %s" JIM_NL
,
11987 Jim_GetString(interp
->result
, NULL
));
11988 Jim_ListLength(interp
, interp
->stackTrace
, &len
);
11989 for (i
= 0; i
< len
; i
+= 3) {
11991 const char *proc
, *file
, *line
;
11993 Jim_ListIndex(interp
, interp
->stackTrace
, i
, &objPtr
, JIM_NONE
);
11994 proc
= Jim_GetString(objPtr
, NULL
);
11995 Jim_ListIndex(interp
, interp
->stackTrace
, i
+1, &objPtr
,
11997 file
= Jim_GetString(objPtr
, NULL
);
11998 Jim_ListIndex(interp
, interp
->stackTrace
, i
+2, &objPtr
,
12000 line
= Jim_GetString(objPtr
, NULL
);
12001 Jim_fprintf( interp
, interp
->cookie_stderr
,
12002 "In procedure '%s' called at file \"%s\", line %s" JIM_NL
,
12007 int Jim_InteractivePrompt(Jim_Interp
*interp
)
12009 int retcode
= JIM_OK
;
12010 Jim_Obj
*scriptObjPtr
;
12012 Jim_fprintf(interp
,interp
->cookie_stdout
, "Welcome to Jim version %d.%d, "
12013 "Copyright (c) 2005-8 Salvatore Sanfilippo" JIM_NL
,
12014 JIM_VERSION
/ 100, JIM_VERSION
% 100);
12015 Jim_SetVariableStrWithStr(interp
, "jim_interactive", "1");
12018 const char *result
;
12019 const char *retcodestr
[] = {
12020 "ok", "error", "return", "break", "continue", "eval", "exit"
12024 if (retcode
!= 0) {
12025 if (retcode
>= 2 && retcode
<= 6)
12026 Jim_fprintf(interp
,interp
->cookie_stdout
, "[%s] . ", retcodestr
[retcode
]);
12028 Jim_fprintf(interp
,interp
->cookie_stdout
, "[%d] . ", retcode
);
12030 Jim_fprintf( interp
, interp
->cookie_stdout
, ". ");
12031 Jim_fflush( interp
, interp
->cookie_stdout
);
12032 scriptObjPtr
= Jim_NewStringObj(interp
, "", 0);
12033 Jim_IncrRefCount(scriptObjPtr
);
12039 if ( Jim_fgets(interp
, buf
, 1024, interp
->cookie_stdin
) == NULL
) {
12040 Jim_DecrRefCount(interp
, scriptObjPtr
);
12043 Jim_AppendString(interp
, scriptObjPtr
, buf
, -1);
12044 str
= Jim_GetString(scriptObjPtr
, &len
);
12045 if (Jim_ScriptIsComplete(str
, len
, &state
))
12047 Jim_fprintf( interp
, interp
->cookie_stdout
, "%c> ", state
);
12048 Jim_fflush( interp
, interp
->cookie_stdout
);
12050 retcode
= Jim_EvalObj(interp
, scriptObjPtr
);
12051 Jim_DecrRefCount(interp
, scriptObjPtr
);
12052 result
= Jim_GetString(Jim_GetResult(interp
), &reslen
);
12053 if (retcode
== JIM_ERR
) {
12054 Jim_PrintErrorMessage(interp
);
12055 } else if (retcode
== JIM_EXIT
) {
12056 exit(Jim_GetExitCode(interp
));
12059 Jim_fwrite( interp
, result
, 1, reslen
, interp
->cookie_stdout
);
12060 Jim_fprintf( interp
,interp
->cookie_stdout
, JIM_NL
);
12068 /* -----------------------------------------------------------------------------
12069 * Jim's idea of STDIO..
12070 * ---------------------------------------------------------------------------*/
12072 int Jim_fprintf( Jim_Interp
*interp
, void *cookie
, const char *fmt
, ... )
12078 r
= Jim_vfprintf( interp
, cookie
, fmt
,ap
);
12083 int Jim_vfprintf( Jim_Interp
*interp
, void *cookie
, const char *fmt
, va_list ap
)
12085 if( (interp
== NULL
) || (interp
->cb_vfprintf
== NULL
) ){
12089 return (*(interp
->cb_vfprintf
))( cookie
, fmt
, ap
);
12092 size_t Jim_fwrite( Jim_Interp
*interp
, const void *ptr
, size_t size
, size_t n
, void *cookie
)
12094 if( (interp
== NULL
) || (interp
->cb_fwrite
== NULL
) ){
12098 return (*(interp
->cb_fwrite
))( ptr
, size
, n
, cookie
);
12101 size_t Jim_fread( Jim_Interp
*interp
, void *ptr
, size_t size
, size_t n
, void *cookie
)
12103 if( (interp
== NULL
) || (interp
->cb_fread
== NULL
) ){
12107 return (*(interp
->cb_fread
))( ptr
, size
, n
, cookie
);
12110 int Jim_fflush( Jim_Interp
*interp
, void *cookie
)
12112 if( (interp
== NULL
) || (interp
->cb_fflush
== NULL
) ){
12113 /* pretend all is well */
12116 return (*(interp
->cb_fflush
))( cookie
);
12119 char* Jim_fgets( Jim_Interp
*interp
, char *s
, int size
, void *cookie
)
12121 if( (interp
== NULL
) || (interp
->cb_fgets
== NULL
) ){
12125 return (*(interp
->cb_fgets
))( s
, size
, cookie
);