1 /* Jim - A small embeddable Tcl interpreter
3 * Copyright 2005 Salvatore Sanfilippo <antirez@invece.org>
4 * Copyright 2005 Clemens Hintze <c.hintze@gmx.net>
5 * Copyright 2005 patthoyts - Pat Thoyts <patthoyts@users.sf.net>
6 * Copyright 2008,2009 oharboe - Øyvind Harboe - oyvind.harboe@zylin.com
7 * Copyright 2008 Andrew Lunn <andrew@lunn.ch>
8 * Copyright 2008 Duane Ellis <openocd@duaneellis.com>
9 * Copyright 2008 Uwe Klein <uklein@klein-messgeraete.de>
10 * Copyright 2008 Steve Bennett <steveb@workware.net.au>
11 * Copyright 2009 Nico Coesel <ncoesel@dealogic.nl>
12 * Copyright 2009 Zachary T Welch zw@superlucidity.net
13 * Copyright 2009 David Brownell
15 * Redistribution and use in source and binary forms, with or without
16 * modification, are permitted provided that the following conditions
19 * 1. Redistributions of source code must retain the above copyright
20 * notice, this list of conditions and the following disclaimer.
21 * 2. Redistributions in binary form must reproduce the above
22 * copyright notice, this list of conditions and the following
23 * disclaimer in the documentation and/or other materials
24 * provided with the distribution.
26 * THIS SOFTWARE IS PROVIDED BY THE JIM TCL PROJECT ``AS IS'' AND ANY
27 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
28 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
29 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
30 * JIM TCL PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
31 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
32 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
35 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
37 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 * The views and conclusions contained in the software and documentation
40 * are those of the authors and should not be interpreted as representing
41 * official policies, either expressed or implied, of the Jim Tcl Project.
49 #define JIM_OPTIMIZATION /* comment to avoid optimizations and reduce size */
52 #include <pkgconf/jimtcl.h>
56 typedef CYG_ADDRWORD
intptr_t;
57 typedef CYG_ADDRWORD
uintptr_t;
67 #include <sys/param.h>
77 #define NEED_ENVIRON_EXTERN (1)
81 #define JIM_DYNLIB /* Dynamic library support for UNIX and WIN32 */
82 #endif /* JIM_ANSIC */
87 /* Include the platform dependent libraries for
88 * dynamic loading of libraries. */
90 #if defined(_WIN32) || defined(WIN32)
97 #define WIN32_LEAN_AND_MEAN
100 #pragma warning(disable:4146)
101 #endif /* _MSC_VER */
105 #endif /* JIM_DYNLIB */
108 #include <cyg/jimtcl/jim.h>
113 #ifdef HAVE_BACKTRACE
114 #include <execinfo.h>
117 /* -----------------------------------------------------------------------------
119 * ---------------------------------------------------------------------------*/
121 /* A shared empty string for the objects string representation.
122 * Jim_InvalidateStringRep knows about it and don't try to free. */
123 static char *JimEmptyStringRep
= (char*) "";
125 /* -----------------------------------------------------------------------------
126 * Required prototypes of not exported functions
127 * ---------------------------------------------------------------------------*/
128 static void JimChangeCallFrameId(Jim_Interp
*interp
, Jim_CallFrame
*cf
);
129 static void JimFreeCallFrame(Jim_Interp
*interp
, Jim_CallFrame
*cf
, int flags
);
130 static void JimRegisterCoreApi(Jim_Interp
*interp
);
132 static Jim_HashTableType
*getJimVariablesHashTableType(void);
134 /* -----------------------------------------------------------------------------
136 * ---------------------------------------------------------------------------*/
139 jim_vasprintf(const char *fmt
, va_list ap
)
141 #ifndef HAVE_VASPRINTF
143 static char buf
[2048];
144 vsnprintf(buf
, sizeof(buf
), fmt
, ap
);
145 /* garentee termination */
146 buf
[sizeof(buf
)-1] = 0;
150 result
= vasprintf(&buf
, fmt
, ap
);
151 if (result
< 0) exit(-1);
157 jim_vasprintf_done(void *buf
)
159 #ifndef HAVE_VASPRINTF
168 * Convert a string to a jim_wide INTEGER.
169 * This function originates from BSD.
171 * Ignores `locale' stuff. Assumes that the upper and lower case
172 * alphabets and digits are each contiguous.
174 #ifdef HAVE_LONG_LONG_INT
175 #define JimIsAscii(c) (((c) & ~0x7f) == 0)
176 static jim_wide
JimStrtoll(const char *nptr
, char **endptr
, register int base
)
178 register const char *s
;
179 register unsigned jim_wide acc
;
180 register unsigned char c
;
181 register unsigned jim_wide qbase
, cutoff
;
182 register int neg
, any
, cutlim
;
185 * Skip white space and pick up leading +/- sign if any.
186 * If base is 0, allow 0x for hex and 0 for octal, else
187 * assume decimal; if base is already 16, allow 0x.
192 } while (isspace(c
));
201 if ((base
== 0 || base
== 16) &&
202 c
== '0' && (*s
== 'x' || *s
== 'X')) {
208 base
= c
== '0' ? 8 : 10;
211 * Compute the cutoff value between legal numbers and illegal
212 * numbers. That is the largest legal value, divided by the
213 * base. An input number that is greater than this value, if
214 * followed by a legal input character, is too big. One that
215 * is equal to this value may be valid or not; the limit
216 * between valid and invalid numbers is then based on the last
217 * digit. For instance, if the range for quads is
218 * [-9223372036854775808..9223372036854775807] and the input base
219 * is 10, cutoff will be set to 922337203685477580 and cutlim to
220 * either 7 (neg == 0) or 8 (neg == 1), meaning that if we have
221 * accumulated a value > 922337203685477580, or equal but the
222 * next digit is > 7 (or 8), the number is too big, and we will
223 * return a range error.
225 * Set any if any `digits' consumed; make it negative to indicate
228 qbase
= (unsigned)base
;
229 cutoff
= neg
? (unsigned jim_wide
)-(LLONG_MIN
+ LLONG_MAX
) + LLONG_MAX
231 cutlim
= (int)(cutoff
% qbase
);
233 for (acc
= 0, any
= 0;; c
= *s
++) {
239 c
-= isupper(c
) ? 'A' - 10 : 'a' - 10;
244 if (any
< 0 || acc
> cutoff
|| (acc
== cutoff
&& c
> cutlim
))
253 acc
= neg
? LLONG_MIN
: LLONG_MAX
;
258 *endptr
= (char *)(any
? s
- 1 : nptr
);
263 /* Glob-style pattern matching. */
264 static int JimStringMatch(const char *pattern
, int patternLen
,
265 const char *string
, int stringLen
, int nocase
)
268 switch (pattern
[0]) {
270 while (pattern
[1] == '*') {
275 return 1; /* match */
277 if (JimStringMatch(pattern
+ 1, patternLen
-1,
278 string
, stringLen
, nocase
))
279 return 1; /* match */
283 return 0; /* no match */
287 return 0; /* no match */
297 not = pattern
[0] == '^';
304 if (pattern
[0] == '\\') {
307 if (pattern
[0] == string
[0])
309 } else if (pattern
[0] == ']') {
311 } else if (patternLen
== 0) {
315 } else if (pattern
[1] == '-' && patternLen
>= 3) {
316 int start
= pattern
[0];
317 int end
= pattern
[2];
325 start
= tolower(start
);
331 if (c
>= start
&& c
<= end
)
335 if (pattern
[0] == string
[0])
338 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
348 return 0; /* no match */
354 if (patternLen
>= 2) {
361 if (pattern
[0] != string
[0])
362 return 0; /* no match */
364 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
365 return 0; /* no match */
373 if (stringLen
== 0) {
374 while (*pattern
== '*') {
381 if (patternLen
== 0 && stringLen
== 0)
386 int JimStringCompare(const char *s1
, int l1
, const char *s2
, int l2
,
389 unsigned char *u1
= (unsigned char*) s1
, *u2
= (unsigned char*) s2
;
395 u1
++; u2
++; l1
--; l2
--;
397 if (!l1
&& !l2
) return 0;
401 if (tolower((int)*u1
) != tolower((int)*u2
))
402 return tolower((int)*u1
)-tolower((int)*u2
);
403 u1
++; u2
++; l1
--; l2
--;
405 if (!l1
&& !l2
) return 0;
410 /* Search 's1' inside 's2', starting to search from char 'index' of 's2'.
411 * The index of the first occurrence of s1 in s2 is returned.
412 * If s1 is not found inside s2, -1 is returned. */
413 int JimStringFirst(const char *s1
, int l1
, const char *s2
, int l2
, int index
)
417 if (!l1
|| !l2
|| l1
> l2
) return -1;
418 if (index
< 0) index
= 0;
420 for (i
= index
; i
<= l2
-l1
; i
++) {
421 if (memcmp(s2
, s1
, l1
) == 0)
428 int Jim_WideToString(char *buf
, jim_wide wideValue
)
430 const char *fmt
= "%" JIM_WIDE_MODIFIER
;
431 return sprintf(buf
, fmt
, wideValue
);
434 int Jim_StringToWide(const char *str
, jim_wide
*widePtr
, int base
)
438 #ifdef HAVE_LONG_LONG_INT
439 *widePtr
= JimStrtoll(str
, &endptr
, base
);
441 *widePtr
= strtol(str
, &endptr
, base
);
443 if ((str
[0] == '\0') || (str
== endptr
))
445 if (endptr
[0] != '\0') {
447 if (!isspace((int)*endptr
))
455 int Jim_StringToIndex(const char *str
, int *intPtr
)
459 *intPtr
= strtol(str
, &endptr
, 10);
460 if ((str
[0] == '\0') || (str
== endptr
))
462 if (endptr
[0] != '\0') {
464 if (!isspace((int)*endptr
))
472 /* The string representation of references has two features in order
473 * to make the GC faster. The first is that every reference starts
474 * with a non common character '~', in order to make the string matching
475 * fater. The second is that the reference string rep his 32 characters
476 * in length, this allows to avoid to check every object with a string
477 * repr < 32, and usually there are many of this objects. */
479 #define JIM_REFERENCE_SPACE (35 + JIM_REFERENCE_TAGLEN)
481 static int JimFormatReference(char *buf
, Jim_Reference
*refPtr
, jim_wide id
)
483 const char *fmt
= "<reference.<%s>.%020" JIM_WIDE_MODIFIER
">";
484 sprintf(buf
, fmt
, refPtr
->tag
, id
);
485 return JIM_REFERENCE_SPACE
;
488 int Jim_DoubleToString(char *buf
, double doubleValue
)
493 len
= sprintf(buf
, "%.17g", doubleValue
);
496 if (*s
== '.') return len
;
499 /* Add a final ".0" if it's a number. But not
501 if (isdigit((int)buf
[0])
502 || ((buf
[0] == '-' || buf
[0] == '+')
503 && isdigit((int)buf
[1]))) {
512 int Jim_StringToDouble(const char *str
, double *doublePtr
)
516 *doublePtr
= strtod(str
, &endptr
);
517 if (str
[0] == '\0' || endptr
[0] != '\0' || (str
== endptr
))
522 static jim_wide
JimPowWide(jim_wide b
, jim_wide e
)
525 if ((b
== 0 && e
!= 0) || (e
< 0)) return 0;
526 for (i
= 0; i
< e
; i
++) {res
*= b
;}
530 /* -----------------------------------------------------------------------------
532 * ---------------------------------------------------------------------------*/
534 /* Note that 'interp' may be NULL if not available in the
535 * context of the panic. It's only useful to get the error
536 * file descriptor, it will default to stderr otherwise. */
537 void Jim_Panic(Jim_Interp
*interp
, const char *fmt
, ...)
543 * Send it here first.. Assuming STDIO still works
545 fprintf(stderr
, JIM_NL
"JIM INTERPRETER PANIC: ");
546 vfprintf(stderr
, fmt
, ap
);
547 fprintf(stderr
, JIM_NL JIM_NL
);
550 #ifdef HAVE_BACKTRACE
556 size
= backtrace(array
, 40);
557 strings
= backtrace_symbols(array
, size
);
558 for (i
= 0; i
< size
; i
++)
559 fprintf(fp
,"[backtrace] %s" JIM_NL
, strings
[i
]);
560 fprintf(fp
,"[backtrace] Include the above lines and the output" JIM_NL
);
561 fprintf(fp
,"[backtrace] of 'nm <executable>' in the bug report." JIM_NL
);
565 /* This may actually crash... we do it last */
566 if (interp
&& interp
->cookie_stderr
) {
567 Jim_fprintf(interp
, interp
->cookie_stderr
, JIM_NL
"JIM INTERPRETER PANIC: ");
568 Jim_vfprintf(interp
, interp
->cookie_stderr
, fmt
, ap
);
569 Jim_fprintf(interp
, interp
->cookie_stderr
, JIM_NL JIM_NL
);
574 /* -----------------------------------------------------------------------------
576 * ---------------------------------------------------------------------------*/
578 /* Macro used for memory debugging.
579 * In order for they to work you have to rename Jim_Alloc into _Jim_Alloc
580 * and similary for Jim_Realloc and Jim_Free */
582 #define Jim_Alloc(s) (printf("%s %d: Jim_Alloc(%d)\n",__FILE__,__LINE__,s),_Jim_Alloc(s))
583 #define Jim_Free(p) (printf("%s %d: Jim_Free(%p)\n",__FILE__,__LINE__,p),_Jim_Free(p))
584 #define Jim_Realloc(p,s) (printf("%s %d: Jim_Realloc(%p,%d)\n",__FILE__,__LINE__,p,s),_Jim_Realloc(p,s))
587 void *Jim_Alloc(int size
)
590 /* We allocate zero length arrayes, etc. to use a single orthogonal codepath */
595 Jim_Panic(NULL
,"malloc: Out of memory");
599 void Jim_Free(void *ptr
) {
603 void *Jim_Realloc(void *ptr
, int size
)
606 /* We allocate zero length arrayes, etc. to use a single orthogonal codepath */
609 p
= realloc(ptr
, size
);
611 Jim_Panic(NULL
,"realloc: Out of memory");
615 char *Jim_StrDup(const char *s
)
618 char *copy
= Jim_Alloc(l
+ 1);
620 memcpy(copy
, s
, l
+ 1);
624 char *Jim_StrDupLen(const char *s
, int l
)
626 char *copy
= Jim_Alloc(l
+ 1);
628 memcpy(copy
, s
, l
+ 1);
629 copy
[l
] = 0; /* Just to be sure, original could be substring */
633 /* -----------------------------------------------------------------------------
634 * Time related functions
635 * ---------------------------------------------------------------------------*/
636 /* Returns microseconds of CPU used since start. */
637 static jim_wide
JimClock(void)
639 #if (defined WIN32) && !(defined JIM_ANSIC)
641 QueryPerformanceFrequency(&f
);
642 QueryPerformanceCounter(&t
);
643 return (long)((t
.QuadPart
* 1000000) / f
.QuadPart
);
645 clock_t clocks
= clock();
647 return (long)(clocks
*(1000000/CLOCKS_PER_SEC
));
651 /* -----------------------------------------------------------------------------
653 * ---------------------------------------------------------------------------*/
655 /* -------------------------- private prototypes ---------------------------- */
656 static int JimExpandHashTableIfNeeded(Jim_HashTable
*ht
);
657 static unsigned int JimHashTableNextPower(unsigned int size
);
658 static int JimInsertHashEntry(Jim_HashTable
*ht
, const void *key
);
660 /* -------------------------- hash functions -------------------------------- */
662 /* Thomas Wang's 32 bit Mix Function */
663 unsigned int Jim_IntHashFunction(unsigned int key
)
674 /* Identity hash function for integer keys */
675 unsigned int Jim_IdentityHashFunction(unsigned int key
)
680 /* Generic hash function (we are using to multiply by 9 and add the byte
682 unsigned int Jim_GenHashFunction(const unsigned char *buf
, int len
)
686 h
+= (h
<< 3)+*buf
++;
690 /* ----------------------------- API implementation ------------------------- */
691 /* reset an hashtable already initialized with ht_init().
692 * NOTE: This function should only called by ht_destroy(). */
693 static void JimResetHashTable(Jim_HashTable
*ht
)
702 /* Initialize the hash table */
703 int Jim_InitHashTable(Jim_HashTable
*ht
, Jim_HashTableType
*type
,
706 JimResetHashTable(ht
);
708 ht
->privdata
= privDataPtr
;
712 /* Resize the table to the minimal size that contains all the elements,
713 * but with the invariant of a USER/BUCKETS ration near to <= 1 */
714 int Jim_ResizeHashTable(Jim_HashTable
*ht
)
716 int minimal
= ht
->used
;
718 if (minimal
< JIM_HT_INITIAL_SIZE
)
719 minimal
= JIM_HT_INITIAL_SIZE
;
720 return Jim_ExpandHashTable(ht
, minimal
);
723 /* Expand or create the hashtable */
724 int Jim_ExpandHashTable(Jim_HashTable
*ht
, unsigned int size
)
726 Jim_HashTable n
; /* the new hashtable */
727 unsigned int realsize
= JimHashTableNextPower(size
), i
;
729 /* the size is invalid if it is smaller than the number of
730 * elements already inside the hashtable */
731 if (ht
->used
>= size
)
734 Jim_InitHashTable(&n
, ht
->type
, ht
->privdata
);
736 n
.sizemask
= realsize
-1;
737 n
.table
= Jim_Alloc(realsize
*sizeof(Jim_HashEntry
*));
739 /* Initialize all the pointers to NULL */
740 memset(n
.table
, 0, realsize
*sizeof(Jim_HashEntry
*));
742 /* Copy all the elements from the old to the new table:
743 * note that if the old hash table is empty ht->size is zero,
744 * so Jim_ExpandHashTable just creates an hash table. */
746 for (i
= 0; i
< ht
->size
&& ht
->used
> 0; i
++) {
747 Jim_HashEntry
*he
, *nextHe
;
749 if (ht
->table
[i
] == NULL
) continue;
751 /* For each hash entry on this slot... */
757 /* Get the new element index */
758 h
= Jim_HashKey(ht
, he
->key
) & n
.sizemask
;
759 he
->next
= n
.table
[h
];
762 /* Pass to the next element */
766 assert(ht
->used
== 0);
769 /* Remap the new hashtable in the old */
774 /* Add an element to the target hash table */
775 int Jim_AddHashEntry(Jim_HashTable
*ht
, const void *key
, void *val
)
778 Jim_HashEntry
*entry
;
780 /* Get the index of the new element, or -1 if
781 * the element already exists. */
782 if ((index
= JimInsertHashEntry(ht
, key
)) == -1)
785 /* Allocates the memory and stores key */
786 entry
= Jim_Alloc(sizeof(*entry
));
787 entry
->next
= ht
->table
[index
];
788 ht
->table
[index
] = entry
;
790 /* Set the hash entry fields. */
791 Jim_SetHashKey(ht
, entry
, key
);
792 Jim_SetHashVal(ht
, entry
, val
);
797 /* Add an element, discarding the old if the key already exists */
798 int Jim_ReplaceHashEntry(Jim_HashTable
*ht
, const void *key
, void *val
)
800 Jim_HashEntry
*entry
;
802 /* Try to add the element. If the key
803 * does not exists Jim_AddHashEntry will suceed. */
804 if (Jim_AddHashEntry(ht
, key
, val
) == JIM_OK
)
806 /* It already exists, get the entry */
807 entry
= Jim_FindHashEntry(ht
, key
);
808 /* Free the old value and set the new one */
809 Jim_FreeEntryVal(ht
, entry
);
810 Jim_SetHashVal(ht
, entry
, val
);
814 /* Search and remove an element */
815 int Jim_DeleteHashEntry(Jim_HashTable
*ht
, const void *key
)
818 Jim_HashEntry
*he
, *prevHe
;
822 h
= Jim_HashKey(ht
, key
) & ht
->sizemask
;
827 if (Jim_CompareHashKeys(ht
, key
, he
->key
)) {
828 /* Unlink the element from the list */
830 prevHe
->next
= he
->next
;
832 ht
->table
[h
] = he
->next
;
833 Jim_FreeEntryKey(ht
, he
);
834 Jim_FreeEntryVal(ht
, he
);
842 return JIM_ERR
; /* not found */
845 /* Destroy an entire hash table */
846 int Jim_FreeHashTable(Jim_HashTable
*ht
)
850 /* Free all the elements */
851 for (i
= 0; i
< ht
->size
&& ht
->used
> 0; i
++) {
852 Jim_HashEntry
*he
, *nextHe
;
854 if ((he
= ht
->table
[i
]) == NULL
) continue;
857 Jim_FreeEntryKey(ht
, he
);
858 Jim_FreeEntryVal(ht
, he
);
864 /* Free the table and the allocated cache structure */
866 /* Re-initialize the table */
867 JimResetHashTable(ht
);
868 return JIM_OK
; /* never fails */
871 Jim_HashEntry
*Jim_FindHashEntry(Jim_HashTable
*ht
, const void *key
)
876 if (ht
->size
== 0) return NULL
;
877 h
= Jim_HashKey(ht
, key
) & ht
->sizemask
;
880 if (Jim_CompareHashKeys(ht
, key
, he
->key
))
887 Jim_HashTableIterator
*Jim_GetHashTableIterator(Jim_HashTable
*ht
)
889 Jim_HashTableIterator
*iter
= Jim_Alloc(sizeof(*iter
));
894 iter
->nextEntry
= NULL
;
898 Jim_HashEntry
*Jim_NextHashEntry(Jim_HashTableIterator
*iter
)
901 if (iter
->entry
== NULL
) {
904 (signed)iter
->ht
->size
) break;
905 iter
->entry
= iter
->ht
->table
[iter
->index
];
907 iter
->entry
= iter
->nextEntry
;
910 /* We need to save the 'next' here, the iterator user
911 * may delete the entry we are returning. */
912 iter
->nextEntry
= iter
->entry
->next
;
919 /* ------------------------- private functions ------------------------------ */
921 /* Expand the hash table if needed */
922 static int JimExpandHashTableIfNeeded(Jim_HashTable
*ht
)
924 /* If the hash table is empty expand it to the intial size,
925 * if the table is "full" dobule its size. */
927 return Jim_ExpandHashTable(ht
, JIM_HT_INITIAL_SIZE
);
928 if (ht
->size
== ht
->used
)
929 return Jim_ExpandHashTable(ht
, ht
->size
*2);
933 /* Our hash table capability is a power of two */
934 static unsigned int JimHashTableNextPower(unsigned int size
)
936 unsigned int i
= JIM_HT_INITIAL_SIZE
;
938 if (size
>= 2147483648U)
947 /* Returns the index of a free slot that can be populated with
948 * an hash entry for the given 'key'.
949 * If the key already exists, -1 is returned. */
950 static int JimInsertHashEntry(Jim_HashTable
*ht
, const void *key
)
955 /* Expand the hashtable if needed */
956 if (JimExpandHashTableIfNeeded(ht
) == JIM_ERR
)
958 /* Compute the key hash value */
959 h
= Jim_HashKey(ht
, key
) & ht
->sizemask
;
960 /* Search if this slot does not already contain the given key */
963 if (Jim_CompareHashKeys(ht
, key
, he
->key
))
970 /* ----------------------- StringCopy Hash Table Type ------------------------*/
972 static unsigned int JimStringCopyHTHashFunction(const void *key
)
974 return Jim_GenHashFunction(key
, strlen(key
));
977 static const void *JimStringCopyHTKeyDup(void *privdata
, const void *key
)
979 int len
= strlen(key
);
980 char *copy
= Jim_Alloc(len
+ 1);
981 JIM_NOTUSED(privdata
);
983 memcpy(copy
, key
, len
);
988 static void *JimStringKeyValCopyHTValDup(void *privdata
, const void *val
)
990 int len
= strlen(val
);
991 char *copy
= Jim_Alloc(len
+ 1);
992 JIM_NOTUSED(privdata
);
994 memcpy(copy
, val
, len
);
999 static int JimStringCopyHTKeyCompare(void *privdata
, const void *key1
,
1002 JIM_NOTUSED(privdata
);
1004 return strcmp(key1
, key2
) == 0;
1007 static void JimStringCopyHTKeyDestructor(void *privdata
, const void *key
)
1009 JIM_NOTUSED(privdata
);
1011 Jim_Free((void*)key
); /* ATTENTION: const cast */
1014 static void JimStringKeyValCopyHTValDestructor(void *privdata
, void *val
)
1016 JIM_NOTUSED(privdata
);
1018 Jim_Free((void*)val
); /* ATTENTION: const cast */
1021 static Jim_HashTableType JimStringCopyHashTableType
= {
1022 JimStringCopyHTHashFunction
, /* hash function */
1023 JimStringCopyHTKeyDup
, /* key dup */
1025 JimStringCopyHTKeyCompare
, /* key compare */
1026 JimStringCopyHTKeyDestructor
, /* key destructor */
1027 NULL
/* val destructor */
1030 /* This is like StringCopy but does not auto-duplicate the key.
1031 * It's used for intepreter's shared strings. */
1032 static Jim_HashTableType JimSharedStringsHashTableType
= {
1033 JimStringCopyHTHashFunction
, /* hash function */
1036 JimStringCopyHTKeyCompare
, /* key compare */
1037 JimStringCopyHTKeyDestructor
, /* key destructor */
1038 NULL
/* val destructor */
1041 /* This is like StringCopy but also automatically handle dynamic
1042 * allocated C strings as values. */
1043 static Jim_HashTableType JimStringKeyValCopyHashTableType
= {
1044 JimStringCopyHTHashFunction
, /* hash function */
1045 JimStringCopyHTKeyDup
, /* key dup */
1046 JimStringKeyValCopyHTValDup
, /* val dup */
1047 JimStringCopyHTKeyCompare
, /* key compare */
1048 JimStringCopyHTKeyDestructor
, /* key destructor */
1049 JimStringKeyValCopyHTValDestructor
, /* val destructor */
1052 typedef struct AssocDataValue
{
1053 Jim_InterpDeleteProc
*delProc
;
1057 static void JimAssocDataHashTableValueDestructor(void *privdata
, void *data
)
1059 AssocDataValue
*assocPtr
= (AssocDataValue
*)data
;
1060 if (assocPtr
->delProc
!= NULL
)
1061 assocPtr
->delProc((Jim_Interp
*)privdata
, assocPtr
->data
);
1065 static Jim_HashTableType JimAssocDataHashTableType
= {
1066 JimStringCopyHTHashFunction
, /* hash function */
1067 JimStringCopyHTKeyDup
, /* key dup */
1069 JimStringCopyHTKeyCompare
, /* key compare */
1070 JimStringCopyHTKeyDestructor
, /* key destructor */
1071 JimAssocDataHashTableValueDestructor
/* val destructor */
1074 /* -----------------------------------------------------------------------------
1075 * Stack - This is a simple generic stack implementation. It is used for
1076 * example in the 'expr' expression compiler.
1077 * ---------------------------------------------------------------------------*/
1078 void Jim_InitStack(Jim_Stack
*stack
)
1082 stack
->vector
= NULL
;
1085 void Jim_FreeStack(Jim_Stack
*stack
)
1087 Jim_Free(stack
->vector
);
1090 int Jim_StackLen(Jim_Stack
*stack
)
1095 void Jim_StackPush(Jim_Stack
*stack
, void *element
) {
1096 int neededLen
= stack
->len
+ 1;
1097 if (neededLen
> stack
->maxlen
) {
1098 stack
->maxlen
= neededLen
*2;
1099 stack
->vector
= Jim_Realloc(stack
->vector
, sizeof(void*)*stack
->maxlen
);
1101 stack
->vector
[stack
->len
] = element
;
1105 void *Jim_StackPop(Jim_Stack
*stack
)
1107 if (stack
->len
== 0) return NULL
;
1109 return stack
->vector
[stack
->len
];
1112 void *Jim_StackPeek(Jim_Stack
*stack
)
1114 if (stack
->len
== 0) return NULL
;
1115 return stack
->vector
[stack
->len
-1];
1118 void Jim_FreeStackElements(Jim_Stack
*stack
, void (*freeFunc
)(void *ptr
))
1122 for (i
= 0; i
< stack
->len
; i
++)
1123 freeFunc(stack
->vector
[i
]);
1126 /* -----------------------------------------------------------------------------
1128 * ---------------------------------------------------------------------------*/
1131 #define JIM_TT_NONE -1 /* No token returned */
1132 #define JIM_TT_STR 0 /* simple string */
1133 #define JIM_TT_ESC 1 /* string that needs escape chars conversion */
1134 #define JIM_TT_VAR 2 /* var substitution */
1135 #define JIM_TT_DICTSUGAR 3 /* Syntax sugar for [dict get], $foo(bar) */
1136 #define JIM_TT_CMD 4 /* command substitution */
1137 #define JIM_TT_SEP 5 /* word separator */
1138 #define JIM_TT_EOL 6 /* line separator */
1140 /* Additional token types needed for expressions */
1141 #define JIM_TT_SUBEXPR_START 7
1142 #define JIM_TT_SUBEXPR_END 8
1143 #define JIM_TT_EXPR_NUMBER 9
1144 #define JIM_TT_EXPR_OPERATOR 10
1147 #define JIM_PS_DEF 0 /* Default state */
1148 #define JIM_PS_QUOTE 1 /* Inside "" */
1150 /* Parser context structure. The same context is used both to parse
1151 * Tcl scripts and lists. */
1152 struct JimParserCtx
{
1153 const char *prg
; /* Program text */
1154 const char *p
; /* Pointer to the point of the program we are parsing */
1155 int len
; /* Left length of 'prg' */
1156 int linenr
; /* Current line number */
1158 const char *tend
; /* Returned token is at tstart-tend in 'prg'. */
1159 int tline
; /* Line number of the returned token */
1160 int tt
; /* Token type */
1161 int eof
; /* Non zero if EOF condition is true. */
1162 int state
; /* Parser state */
1163 int comment
; /* Non zero if the next chars may be a comment. */
1166 #define JimParserEof(c) ((c)->eof)
1167 #define JimParserTstart(c) ((c)->tstart)
1168 #define JimParserTend(c) ((c)->tend)
1169 #define JimParserTtype(c) ((c)->tt)
1170 #define JimParserTline(c) ((c)->tline)
1172 static int JimParseScript(struct JimParserCtx
*pc
);
1173 static int JimParseSep(struct JimParserCtx
*pc
);
1174 static int JimParseEol(struct JimParserCtx
*pc
);
1175 static int JimParseCmd(struct JimParserCtx
*pc
);
1176 static int JimParseVar(struct JimParserCtx
*pc
);
1177 static int JimParseBrace(struct JimParserCtx
*pc
);
1178 static int JimParseStr(struct JimParserCtx
*pc
);
1179 static int JimParseComment(struct JimParserCtx
*pc
);
1180 static char *JimParserGetToken(struct JimParserCtx
*pc
,
1181 int *lenPtr
, int *typePtr
, int *linePtr
);
1183 /* Initialize a parser context.
1184 * 'prg' is a pointer to the program text, linenr is the line
1185 * number of the first line contained in the program. */
1186 void JimParserInit(struct JimParserCtx
*pc
, const char *prg
,
1187 int len
, int linenr
)
1195 pc
->tt
= JIM_TT_NONE
;
1197 pc
->state
= JIM_PS_DEF
;
1198 pc
->linenr
= linenr
;
1202 int JimParseScript(struct JimParserCtx
*pc
)
1204 while (1) { /* the while is used to reiterate with continue if needed */
1208 pc
->tline
= pc
->linenr
;
1209 pc
->tt
= JIM_TT_EOL
;
1215 if (*(pc
->p
+ 1) == '\n')
1216 return JimParseSep(pc
);
1219 return JimParseStr(pc
);
1225 if (pc
->state
== JIM_PS_DEF
)
1226 return JimParseSep(pc
);
1229 return JimParseStr(pc
);
1235 if (pc
->state
== JIM_PS_DEF
)
1236 return JimParseEol(pc
);
1238 return JimParseStr(pc
);
1242 return JimParseCmd(pc
);
1246 if (JimParseVar(pc
) == JIM_ERR
) {
1247 pc
->tstart
= pc
->tend
= pc
->p
++; pc
->len
--;
1248 pc
->tline
= pc
->linenr
;
1249 pc
->tt
= JIM_TT_STR
;
1256 JimParseComment(pc
);
1259 return JimParseStr(pc
);
1263 return JimParseStr(pc
);
1270 int JimParseSep(struct JimParserCtx
*pc
)
1273 pc
->tline
= pc
->linenr
;
1274 while (*pc
->p
== ' ' || *pc
->p
== '\t' || *pc
->p
== '\r' ||
1275 (*pc
->p
== '\\' && *(pc
->p
+ 1) == '\n')) {
1276 if (*pc
->p
== '\\') {
1283 pc
->tt
= JIM_TT_SEP
;
1287 int JimParseEol(struct JimParserCtx
*pc
)
1290 pc
->tline
= pc
->linenr
;
1291 while (*pc
->p
== ' ' || *pc
->p
== '\n' ||
1292 *pc
->p
== '\t' || *pc
->p
== '\r' || *pc
->p
== ';') {
1298 pc
->tt
= JIM_TT_EOL
;
1302 /* Todo. Don't stop if ']' appears inside {} or quoted.
1303 * Also should handle the case of puts [string length "]"] */
1304 int JimParseCmd(struct JimParserCtx
*pc
)
1309 pc
->tstart
= ++pc
->p
; pc
->len
--;
1310 pc
->tline
= pc
->linenr
;
1314 } else if (*pc
->p
== '[' && blevel
== 0) {
1316 } else if (*pc
->p
== ']' && blevel
== 0) {
1319 } else if (*pc
->p
== '\\') {
1321 } else if (*pc
->p
== '{') {
1323 } else if (*pc
->p
== '}') {
1326 } else if (*pc
->p
== '\n')
1331 pc
->tt
= JIM_TT_CMD
;
1332 if (*pc
->p
== ']') {
1338 int JimParseVar(struct JimParserCtx
*pc
)
1340 int brace
= 0, stop
= 0, ttype
= JIM_TT_VAR
;
1342 pc
->tstart
= ++pc
->p
; pc
->len
--; /* skip the $ */
1343 pc
->tline
= pc
->linenr
;
1344 if (*pc
->p
== '{') {
1345 pc
->tstart
= ++pc
->p
; pc
->len
--;
1350 if (*pc
->p
== '}' || pc
->len
== 0) {
1356 else if (*pc
->p
== '\n')
1361 /* Include leading colons */
1362 while (*pc
->p
== ':') {
1367 if (!((*pc
->p
>= 'a' && *pc
->p
<= 'z') ||
1368 (*pc
->p
>= 'A' && *pc
->p
<= 'Z') ||
1369 (*pc
->p
>= '0' && *pc
->p
<= '9') || *pc
->p
== '_'))
1375 /* Parse [dict get] syntax sugar. */
1376 if (*pc
->p
== '(') {
1377 while (*pc
->p
!= ')' && pc
->len
) {
1379 if (*pc
->p
== '\\' && pc
->len
>= 2) {
1380 pc
->p
+= 2; pc
->len
-= 2;
1383 if (*pc
->p
!= '\0') {
1386 ttype
= JIM_TT_DICTSUGAR
;
1390 /* Check if we parsed just the '$' character.
1391 * That's not a variable so an error is returned
1392 * to tell the state machine to consider this '$' just
1394 if (pc
->tstart
== pc
->p
) {
1402 int JimParseBrace(struct JimParserCtx
*pc
)
1406 pc
->tstart
= ++pc
->p
; pc
->len
--;
1407 pc
->tline
= pc
->linenr
;
1409 if (*pc
->p
== '\\' && pc
->len
>= 2) {
1413 } else if (*pc
->p
== '{') {
1415 } else if (pc
->len
== 0 || *pc
->p
== '}') {
1417 if (pc
->len
== 0 || level
== 0) {
1422 pc
->tt
= JIM_TT_STR
;
1425 } else if (*pc
->p
== '\n') {
1430 return JIM_OK
; /* unreached */
1433 int JimParseStr(struct JimParserCtx
*pc
)
1435 int newword
= (pc
->tt
== JIM_TT_SEP
|| pc
->tt
== JIM_TT_EOL
||
1436 pc
->tt
== JIM_TT_NONE
|| pc
->tt
== JIM_TT_STR
);
1437 if (newword
&& *pc
->p
== '{') {
1438 return JimParseBrace(pc
);
1439 } else if (newword
&& *pc
->p
== '"') {
1440 pc
->state
= JIM_PS_QUOTE
;
1444 pc
->tline
= pc
->linenr
;
1448 pc
->tt
= JIM_TT_ESC
;
1453 if (pc
->state
== JIM_PS_DEF
&&
1454 *(pc
->p
+ 1) == '\n') {
1456 pc
->tt
= JIM_TT_ESC
;
1466 pc
->tt
= JIM_TT_ESC
;
1473 if (pc
->state
== JIM_PS_DEF
) {
1475 pc
->tt
= JIM_TT_ESC
;
1477 } else if (*pc
->p
== '\n') {
1482 if (pc
->state
== JIM_PS_QUOTE
) {
1484 pc
->tt
= JIM_TT_ESC
;
1486 pc
->state
= JIM_PS_DEF
;
1493 return JIM_OK
; /* unreached */
1496 int JimParseComment(struct JimParserCtx
*pc
)
1499 if (*pc
->p
== '\n') {
1501 if (*(pc
->p
-1) != '\\') {
1511 /* xdigitval and odigitval are helper functions for JimParserGetToken() */
1512 static int xdigitval(int c
)
1514 if (c
>= '0' && c
<= '9') return c
-'0';
1515 if (c
>= 'a' && c
<= 'f') return c
-'a'+10;
1516 if (c
>= 'A' && c
<= 'F') return c
-'A'+10;
1520 static int odigitval(int c
)
1522 if (c
>= '0' && c
<= '7') return c
-'0';
1526 /* Perform Tcl escape substitution of 's', storing the result
1527 * string into 'dest'. The escaped string is guaranteed to
1528 * be the same length or shorted than the source string.
1529 * Slen is the length of the string at 's', if it's -1 the string
1530 * length will be calculated by the function.
1532 * The function returns the length of the resulting string. */
1533 static int JimEscape(char *dest
, const char *s
, int slen
)
1541 for (i
= 0; i
< slen
; i
++) {
1545 case 'a': *p
++ = 0x7; i
++; break;
1546 case 'b': *p
++ = 0x8; i
++; break;
1547 case 'f': *p
++ = 0xc; i
++; break;
1548 case 'n': *p
++ = 0xa; i
++; break;
1549 case 'r': *p
++ = 0xd; i
++; break;
1550 case 't': *p
++ = 0x9; i
++; break;
1551 case 'v': *p
++ = 0xb; i
++; break;
1552 case '\0': *p
++ = '\\'; i
++; break;
1553 case '\n': *p
++ = ' '; i
++; break;
1555 if (s
[i
+ 1] == 'x') {
1557 int c
= xdigitval(s
[i
+ 2]);
1564 c
= xdigitval(s
[i
+ 3]);
1574 } else if (s
[i
+ 1] >= '0' && s
[i
+ 1] <= '7')
1577 int c
= odigitval(s
[i
+ 1]);
1579 c
= odigitval(s
[i
+ 2]);
1586 c
= odigitval(s
[i
+ 3]);
1612 /* Returns a dynamically allocated copy of the current token in the
1613 * parser context. The function perform conversion of escapes if
1614 * the token is of type JIM_TT_ESC.
1616 * Note that after the conversion, tokens that are grouped with
1617 * braces in the source code, are always recognizable from the
1618 * identical string obtained in a different way from the type.
1620 * For exmple the string:
1624 * will return as first token "expand", of type JIM_TT_STR
1630 * will return as first token "expand", of type JIM_TT_ESC
1632 char *JimParserGetToken(struct JimParserCtx
*pc
,
1633 int *lenPtr
, int *typePtr
, int *linePtr
)
1635 const char *start
, *end
;
1639 start
= JimParserTstart(pc
);
1640 end
= JimParserTend(pc
);
1642 if (lenPtr
) *lenPtr
= 0;
1643 if (typePtr
) *typePtr
= JimParserTtype(pc
);
1644 if (linePtr
) *linePtr
= JimParserTline(pc
);
1645 token
= Jim_Alloc(1);
1649 len
= (end
-start
) + 1;
1650 token
= Jim_Alloc(len
+ 1);
1651 if (JimParserTtype(pc
) != JIM_TT_ESC
) {
1652 /* No escape conversion needed? Just copy it. */
1653 memcpy(token
, start
, len
);
1656 /* Else convert the escape chars. */
1657 len
= JimEscape(token
, start
, len
);
1659 if (lenPtr
) *lenPtr
= len
;
1660 if (typePtr
) *typePtr
= JimParserTtype(pc
);
1661 if (linePtr
) *linePtr
= JimParserTline(pc
);
1665 /* The following functin is not really part of the parsing engine of Jim,
1666 * but it somewhat related. Given an string and its length, it tries
1667 * to guess if the script is complete or there are instead " " or { }
1668 * open and not completed. This is useful for interactive shells
1669 * implementation and for [info complete].
1671 * If 'stateCharPtr' != NULL, the function stores ' ' on complete script,
1672 * '{' on scripts incomplete missing one or more '}' to be balanced.
1673 * '"' on scripts incomplete missing a '"' char.
1675 * If the script is complete, 1 is returned, otherwise 0. */
1676 int Jim_ScriptIsComplete(const char *s
, int len
, char *stateCharPtr
)
1690 } else if (state
== '"') {
1697 } else if (state
== ' ') {
1714 *stateCharPtr
= state
;
1715 return state
== ' ';
1718 /* -----------------------------------------------------------------------------
1720 * ---------------------------------------------------------------------------*/
1721 static int JimParseListSep(struct JimParserCtx
*pc
);
1722 static int JimParseListStr(struct JimParserCtx
*pc
);
1724 int JimParseList(struct JimParserCtx
*pc
)
1727 pc
->tstart
= pc
->tend
= pc
->p
;
1728 pc
->tline
= pc
->linenr
;
1729 pc
->tt
= JIM_TT_EOL
;
1738 if (pc
->state
== JIM_PS_DEF
)
1739 return JimParseListSep(pc
);
1741 return JimParseListStr(pc
);
1744 return JimParseListStr(pc
);
1750 int JimParseListSep(struct JimParserCtx
*pc
)
1753 pc
->tline
= pc
->linenr
;
1754 while (*pc
->p
== ' ' || *pc
->p
== '\t' || *pc
->p
== '\r' || *pc
->p
== '\n')
1759 pc
->tt
= JIM_TT_SEP
;
1763 int JimParseListStr(struct JimParserCtx
*pc
)
1765 int newword
= (pc
->tt
== JIM_TT_SEP
|| pc
->tt
== JIM_TT_EOL
||
1766 pc
->tt
== JIM_TT_NONE
);
1767 if (newword
&& *pc
->p
== '{') {
1768 return JimParseBrace(pc
);
1769 } else if (newword
&& *pc
->p
== '"') {
1770 pc
->state
= JIM_PS_QUOTE
;
1774 pc
->tline
= pc
->linenr
;
1778 pc
->tt
= JIM_TT_ESC
;
1789 if (pc
->state
== JIM_PS_DEF
) {
1791 pc
->tt
= JIM_TT_ESC
;
1793 } else if (*pc
->p
== '\n') {
1798 if (pc
->state
== JIM_PS_QUOTE
) {
1800 pc
->tt
= JIM_TT_ESC
;
1802 pc
->state
= JIM_PS_DEF
;
1809 return JIM_OK
; /* unreached */
1812 /* -----------------------------------------------------------------------------
1813 * Jim_Obj related functions
1814 * ---------------------------------------------------------------------------*/
1816 /* Return a new initialized object. */
1817 Jim_Obj
*Jim_NewObj(Jim_Interp
*interp
)
1821 /* -- Check if there are objects in the free list -- */
1822 if (interp
->freeList
!= NULL
) {
1823 /* -- Unlink the object from the free list -- */
1824 objPtr
= interp
->freeList
;
1825 interp
->freeList
= objPtr
->nextObjPtr
;
1827 /* -- No ready to use objects: allocate a new one -- */
1828 objPtr
= Jim_Alloc(sizeof(*objPtr
));
1831 /* Object is returned with refCount of 0. Every
1832 * kind of GC implemented should take care to don't try
1833 * to scan objects with refCount == 0. */
1834 objPtr
->refCount
= 0;
1835 /* All the other fields are left not initialized to save time.
1836 * The caller will probably want set they to the right
1839 /* -- Put the object into the live list -- */
1840 objPtr
->prevObjPtr
= NULL
;
1841 objPtr
->nextObjPtr
= interp
->liveList
;
1842 if (interp
->liveList
)
1843 interp
->liveList
->prevObjPtr
= objPtr
;
1844 interp
->liveList
= objPtr
;
1849 /* Free an object. Actually objects are never freed, but
1850 * just moved to the free objects list, where they will be
1851 * reused by Jim_NewObj(). */
1852 void Jim_FreeObj(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
1854 /* Check if the object was already freed, panic. */
1855 if (objPtr
->refCount
!= 0) {
1856 Jim_Panic(interp
,"!!!Object %p freed with bad refcount %d", objPtr
,
1859 /* Free the internal representation */
1860 Jim_FreeIntRep(interp
, objPtr
);
1861 /* Free the string representation */
1862 if (objPtr
->bytes
!= NULL
) {
1863 if (objPtr
->bytes
!= JimEmptyStringRep
)
1864 Jim_Free(objPtr
->bytes
);
1866 /* Unlink the object from the live objects list */
1867 if (objPtr
->prevObjPtr
)
1868 objPtr
->prevObjPtr
->nextObjPtr
= objPtr
->nextObjPtr
;
1869 if (objPtr
->nextObjPtr
)
1870 objPtr
->nextObjPtr
->prevObjPtr
= objPtr
->prevObjPtr
;
1871 if (interp
->liveList
== objPtr
)
1872 interp
->liveList
= objPtr
->nextObjPtr
;
1873 /* Link the object into the free objects list */
1874 objPtr
->prevObjPtr
= NULL
;
1875 objPtr
->nextObjPtr
= interp
->freeList
;
1876 if (interp
->freeList
)
1877 interp
->freeList
->prevObjPtr
= objPtr
;
1878 interp
->freeList
= objPtr
;
1879 objPtr
->refCount
= -1;
1882 /* Invalidate the string representation of an object. */
1883 void Jim_InvalidateStringRep(Jim_Obj
*objPtr
)
1885 if (objPtr
->bytes
!= NULL
) {
1886 if (objPtr
->bytes
!= JimEmptyStringRep
)
1887 Jim_Free(objPtr
->bytes
);
1889 objPtr
->bytes
= NULL
;
1892 #define Jim_SetStringRep(o, b, l) \
1893 do { (o)->bytes = b; (o)->length = l; } while (0)
1895 /* Set the initial string representation for an object.
1896 * Does not try to free an old one. */
1897 void Jim_InitStringRep(Jim_Obj
*objPtr
, const char *bytes
, int length
)
1900 objPtr
->bytes
= JimEmptyStringRep
;
1903 objPtr
->bytes
= Jim_Alloc(length
+ 1);
1904 objPtr
->length
= length
;
1905 memcpy(objPtr
->bytes
, bytes
, length
);
1906 objPtr
->bytes
[length
] = '\0';
1910 /* Duplicate an object. The returned object has refcount = 0. */
1911 Jim_Obj
*Jim_DuplicateObj(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
1915 dupPtr
= Jim_NewObj(interp
);
1916 if (objPtr
->bytes
== NULL
) {
1917 /* Object does not have a valid string representation. */
1918 dupPtr
->bytes
= NULL
;
1920 Jim_InitStringRep(dupPtr
, objPtr
->bytes
, objPtr
->length
);
1922 if (objPtr
->typePtr
!= NULL
) {
1923 if (objPtr
->typePtr
->dupIntRepProc
== NULL
) {
1924 dupPtr
->internalRep
= objPtr
->internalRep
;
1926 objPtr
->typePtr
->dupIntRepProc(interp
, objPtr
, dupPtr
);
1928 dupPtr
->typePtr
= objPtr
->typePtr
;
1930 dupPtr
->typePtr
= NULL
;
1935 /* Return the string representation for objPtr. If the object
1936 * string representation is invalid, calls the method to create
1937 * a new one starting from the internal representation of the object. */
1938 const char *Jim_GetString(Jim_Obj
*objPtr
, int *lenPtr
)
1940 if (objPtr
->bytes
== NULL
) {
1941 /* Invalid string repr. Generate it. */
1942 if (objPtr
->typePtr
->updateStringProc
== NULL
) {
1943 Jim_Panic(NULL
,"UpdataStringProc called against '%s' type.",
1944 objPtr
->typePtr
->name
);
1946 objPtr
->typePtr
->updateStringProc(objPtr
);
1949 *lenPtr
= objPtr
->length
;
1950 return objPtr
->bytes
;
1953 /* Just returns the length of the object's string rep */
1954 int Jim_Length(Jim_Obj
*objPtr
)
1958 Jim_GetString(objPtr
, &len
);
1962 /* -----------------------------------------------------------------------------
1964 * ---------------------------------------------------------------------------*/
1965 static void DupStringInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
);
1966 static int SetStringFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
);
1968 static Jim_ObjType stringObjType
= {
1971 DupStringInternalRep
,
1973 JIM_TYPE_REFERENCES
,
1976 void DupStringInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
)
1978 JIM_NOTUSED(interp
);
1980 /* This is a bit subtle: the only caller of this function
1981 * should be Jim_DuplicateObj(), that will copy the
1982 * string representaion. After the copy, the duplicated
1983 * object will not have more room in teh buffer than
1984 * srcPtr->length bytes. So we just set it to length. */
1985 dupPtr
->internalRep
.strValue
.maxLength
= srcPtr
->length
;
1988 int SetStringFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
1990 /* Get a fresh string representation. */
1991 (void) Jim_GetString(objPtr
, NULL
);
1992 /* Free any other internal representation. */
1993 Jim_FreeIntRep(interp
, objPtr
);
1994 /* Set it as string, i.e. just set the maxLength field. */
1995 objPtr
->typePtr
= &stringObjType
;
1996 objPtr
->internalRep
.strValue
.maxLength
= objPtr
->length
;
2000 Jim_Obj
*Jim_NewStringObj(Jim_Interp
*interp
, const char *s
, int len
)
2002 Jim_Obj
*objPtr
= Jim_NewObj(interp
);
2006 /* Alloc/Set the string rep. */
2008 objPtr
->bytes
= JimEmptyStringRep
;
2011 objPtr
->bytes
= Jim_Alloc(len
+ 1);
2012 objPtr
->length
= len
;
2013 memcpy(objPtr
->bytes
, s
, len
);
2014 objPtr
->bytes
[len
] = '\0';
2017 /* No typePtr field for the vanilla string object. */
2018 objPtr
->typePtr
= NULL
;
2022 /* This version does not try to duplicate the 's' pointer, but
2023 * use it directly. */
2024 Jim_Obj
*Jim_NewStringObjNoAlloc(Jim_Interp
*interp
, char *s
, int len
)
2026 Jim_Obj
*objPtr
= Jim_NewObj(interp
);
2030 Jim_SetStringRep(objPtr
, s
, len
);
2031 objPtr
->typePtr
= NULL
;
2035 /* Low-level string append. Use it only against objects
2036 * of type "string". */
2037 void StringAppendString(Jim_Obj
*objPtr
, const char *str
, int len
)
2043 needlen
= objPtr
->length
+ len
;
2044 if (objPtr
->internalRep
.strValue
.maxLength
< needlen
||
2045 objPtr
->internalRep
.strValue
.maxLength
== 0) {
2046 if (objPtr
->bytes
== JimEmptyStringRep
) {
2047 objPtr
->bytes
= Jim_Alloc((needlen
*2) + 1);
2049 objPtr
->bytes
= Jim_Realloc(objPtr
->bytes
, (needlen
*2) + 1);
2051 objPtr
->internalRep
.strValue
.maxLength
= needlen
*2;
2053 memcpy(objPtr
->bytes
+ objPtr
->length
, str
, len
);
2054 objPtr
->bytes
[objPtr
->length
+ len
] = '\0';
2055 objPtr
->length
+= len
;
2058 /* Low-level wrapper to append an object. */
2059 void StringAppendObj(Jim_Obj
*objPtr
, Jim_Obj
*appendObjPtr
)
2064 str
= Jim_GetString(appendObjPtr
, &len
);
2065 StringAppendString(objPtr
, str
, len
);
2068 /* Higher level API to append strings to objects. */
2069 void Jim_AppendString(Jim_Interp
*interp
, Jim_Obj
*objPtr
, const char *str
,
2072 if (Jim_IsShared(objPtr
))
2073 Jim_Panic(interp
,"Jim_AppendString called with shared object");
2074 if (objPtr
->typePtr
!= &stringObjType
)
2075 SetStringFromAny(interp
, objPtr
);
2076 StringAppendString(objPtr
, str
, len
);
2079 void Jim_AppendString_sprintf(Jim_Interp
*interp
, Jim_Obj
*objPtr
, const char *fmt
, ...)
2085 buf
= jim_vasprintf(fmt
, ap
);
2089 Jim_AppendString(interp
, objPtr
, buf
, -1);
2090 jim_vasprintf_done(buf
);
2095 void Jim_AppendObj(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
2096 Jim_Obj
*appendObjPtr
)
2101 str
= Jim_GetString(appendObjPtr
, &len
);
2102 Jim_AppendString(interp
, objPtr
, str
, len
);
2105 void Jim_AppendStrings(Jim_Interp
*interp
, Jim_Obj
*objPtr
, ...)
2109 if (objPtr
->typePtr
!= &stringObjType
)
2110 SetStringFromAny(interp
, objPtr
);
2111 va_start(ap
, objPtr
);
2113 char *s
= va_arg(ap
, char*);
2115 if (s
== NULL
) break;
2116 Jim_AppendString(interp
, objPtr
, s
, -1);
2121 int Jim_StringEqObj(Jim_Obj
*aObjPtr
, Jim_Obj
*bObjPtr
, int nocase
)
2123 const char *aStr
, *bStr
;
2126 if (aObjPtr
== bObjPtr
) return 1;
2127 aStr
= Jim_GetString(aObjPtr
, &aLen
);
2128 bStr
= Jim_GetString(bObjPtr
, &bLen
);
2129 if (aLen
!= bLen
) return 0;
2131 return memcmp(aStr
, bStr
, aLen
) == 0;
2132 for (i
= 0; i
< aLen
; i
++) {
2133 if (tolower((int)aStr
[i
]) != tolower((int)bStr
[i
]))
2139 int Jim_StringMatchObj(Jim_Obj
*patternObjPtr
, Jim_Obj
*objPtr
,
2142 const char *pattern
, *string
;
2143 int patternLen
, stringLen
;
2145 pattern
= Jim_GetString(patternObjPtr
, &patternLen
);
2146 string
= Jim_GetString(objPtr
, &stringLen
);
2147 return JimStringMatch(pattern
, patternLen
, string
, stringLen
, nocase
);
2150 int Jim_StringCompareObj(Jim_Obj
*firstObjPtr
,
2151 Jim_Obj
*secondObjPtr
, int nocase
)
2153 const char *s1
, *s2
;
2156 s1
= Jim_GetString(firstObjPtr
, &l1
);
2157 s2
= Jim_GetString(secondObjPtr
, &l2
);
2158 return JimStringCompare(s1
, l1
, s2
, l2
, nocase
);
2161 /* Convert a range, as returned by Jim_GetRange(), into
2162 * an absolute index into an object of the specified length.
2163 * This function may return negative values, or values
2164 * bigger or equal to the length of the list if the index
2165 * is out of range. */
2166 static int JimRelToAbsIndex(int len
, int index
)
2173 /* Convert a pair of index as normalize by JimRelToAbsIndex(),
2174 * into a range stored in *firstPtr, *lastPtr, *rangeLenPtr, suitable
2175 * for implementation of commands like [string range] and [lrange].
2177 * The resulting range is guaranteed to address valid elements of
2179 static void JimRelToAbsRange(int len
, int first
, int last
,
2180 int *firstPtr
, int *lastPtr
, int *rangeLenPtr
)
2187 rangeLen
= last
-first
+ 1;
2194 rangeLen
-= (last
-(len
-1));
2199 if (rangeLen
< 0) rangeLen
= 0;
2203 *rangeLenPtr
= rangeLen
;
2206 Jim_Obj
*Jim_StringRangeObj(Jim_Interp
*interp
,
2207 Jim_Obj
*strObjPtr
, Jim_Obj
*firstObjPtr
, Jim_Obj
*lastObjPtr
)
2213 if (Jim_GetIndex(interp
, firstObjPtr
, &first
) != JIM_OK
||
2214 Jim_GetIndex(interp
, lastObjPtr
, &last
) != JIM_OK
)
2216 str
= Jim_GetString(strObjPtr
, &len
);
2217 first
= JimRelToAbsIndex(len
, first
);
2218 last
= JimRelToAbsIndex(len
, last
);
2219 JimRelToAbsRange(len
, first
, last
, &first
, &last
, &rangeLen
);
2220 return Jim_NewStringObj(interp
, str
+ first
, rangeLen
);
2223 static Jim_Obj
*JimStringToLower(Jim_Interp
*interp
, Jim_Obj
*strObjPtr
)
2227 if (strObjPtr
->typePtr
!= &stringObjType
) {
2228 SetStringFromAny(interp
, strObjPtr
);
2231 buf
= Jim_Alloc(strObjPtr
->length
+ 1);
2233 memcpy(buf
, strObjPtr
->bytes
, strObjPtr
->length
+ 1);
2234 for (i
= 0; i
< strObjPtr
->length
; i
++)
2235 buf
[i
] = tolower((int)buf
[i
]);
2236 return Jim_NewStringObjNoAlloc(interp
, buf
, strObjPtr
->length
);
2239 static Jim_Obj
*JimStringToUpper(Jim_Interp
*interp
, Jim_Obj
*strObjPtr
)
2243 if (strObjPtr
->typePtr
!= &stringObjType
) {
2244 SetStringFromAny(interp
, strObjPtr
);
2247 buf
= Jim_Alloc(strObjPtr
->length
+ 1);
2249 memcpy(buf
, strObjPtr
->bytes
, strObjPtr
->length
+ 1);
2250 for (i
= 0; i
< strObjPtr
->length
; i
++)
2251 buf
[i
] = toupper((int)buf
[i
]);
2252 return Jim_NewStringObjNoAlloc(interp
, buf
, strObjPtr
->length
);
2255 /* This is the core of the [format] command.
2256 * TODO: Lots of things work - via a hack
2257 * However, no format item can be >= JIM_MAX_FMT
2259 #define JIM_MAX_FMT 2048
2260 static Jim_Obj
*Jim_FormatString_Inner(Jim_Interp
*interp
, Jim_Obj
*fmtObjPtr
,
2261 int objc
, Jim_Obj
*const *objv
, char *sprintf_buf
)
2263 const char *fmt
, *_fmt
;
2268 fmt
= Jim_GetString(fmtObjPtr
, &fmtLen
);
2270 resObjPtr
= Jim_NewStringObj(interp
, "", 0);
2272 const char *p
= fmt
;
2276 /* we cheat and use Sprintf()! */
2290 while (*fmt
!= '%' && fmtLen
) {
2293 Jim_AppendString(interp
, resObjPtr
, p
, fmt
-p
);
2296 fmt
++; fmtLen
--; /* skip '%' */
2305 prec
= -1; /* not found yet */
2312 case 'b': /* binary - not all printfs() do this */
2313 case 's': /* string */
2314 case 'i': /* integer */
2315 case 'd': /* decimal */
2317 case 'X': /* CAP hex */
2318 case 'c': /* char */
2319 case 'o': /* octal */
2320 case 'u': /* unsigned */
2321 case 'f': /* float */
2325 case '0': /* zero pad */
2335 case ' ': /* sign space */
2365 while (isdigit((int)*fmt
) && (fmtLen
> 0)) {
2366 accum
= (accum
* 10) + (*fmt
- '0');
2377 /* suck up the next item as an integer */
2381 goto not_enough_args
;
2383 if (Jim_GetWide(interp
,objv
[0],&wideValue
)== JIM_ERR
) {
2384 Jim_FreeNewObj(interp
, resObjPtr
);
2391 /* man 3 printf says */
2392 /* if prec is negative, it is zero */
2411 Jim_FreeNewObj(interp
, resObjPtr
);
2412 Jim_SetResultString(interp
,
2413 "not enough arguments for all format specifiers", -1);
2421 * Create the formatter
2422 * cause we cheat and use sprintf()
2432 /* PLUS overrides */
2442 sprintf(cp
, "%d", width
);
2446 /* did we find a period? */
2450 /* did something occur after the period? */
2452 sprintf(cp
, "%d", prec
);
2458 /* here we do the work */
2459 /* actually - we make sprintf() do it for us */
2464 /* BUG: we do not handled embeded NULLs */
2465 snprintf(sprintf_buf
, JIM_MAX_FMT
, fmt_str
, Jim_GetString(objv
[0], NULL
));
2470 if (Jim_GetWide(interp
, objv
[0], &wideValue
) == JIM_ERR
) {
2471 Jim_FreeNewObj(interp
, resObjPtr
);
2474 c
= (char) wideValue
;
2475 snprintf(sprintf_buf
, JIM_MAX_FMT
, fmt_str
, c
);
2485 if (Jim_GetDouble(interp
, objv
[0], &doubleValue
) == JIM_ERR
) {
2486 Jim_FreeNewObj(interp
, resObjPtr
);
2489 snprintf(sprintf_buf
, JIM_MAX_FMT
, fmt_str
, doubleValue
);
2498 /* jim widevaluse are 64bit */
2499 if (sizeof(jim_wide
) == sizeof(long long)) {
2507 if (Jim_GetWide(interp
, objv
[0], &wideValue
) == JIM_ERR
) {
2508 Jim_FreeNewObj(interp
, resObjPtr
);
2511 snprintf(sprintf_buf
, JIM_MAX_FMT
, fmt_str
, wideValue
);
2514 sprintf_buf
[0] = '%';
2516 objv
--; /* undo the objv++ below */
2519 spec
[0] = *fmt
; spec
[1] = '\0';
2520 Jim_FreeNewObj(interp
, resObjPtr
);
2521 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
2522 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
2523 "bad field specifier \"", spec
, "\"", NULL
);
2526 /* force terminate */
2528 printf("FMT was: %s\n", fmt_str
);
2529 printf("RES was: |%s|\n", sprintf_buf
);
2532 sprintf_buf
[ JIM_MAX_FMT
- 1] = 0;
2533 Jim_AppendString(interp
, resObjPtr
, sprintf_buf
, strlen(sprintf_buf
));
2542 Jim_Obj
*Jim_FormatString(Jim_Interp
*interp
, Jim_Obj
*fmtObjPtr
,
2543 int objc
, Jim_Obj
*const *objv
)
2545 char *sprintf_buf
= malloc(JIM_MAX_FMT
);
2546 Jim_Obj
*t
= Jim_FormatString_Inner(interp
, fmtObjPtr
, objc
, objv
, sprintf_buf
);
2551 /* -----------------------------------------------------------------------------
2552 * Compared String Object
2553 * ---------------------------------------------------------------------------*/
2555 /* This is strange object that allows to compare a C literal string
2556 * with a Jim object in very short time if the same comparison is done
2557 * multiple times. For example every time the [if] command is executed,
2558 * Jim has to check if a given argument is "else". This comparions if
2559 * the code has no errors are true most of the times, so we can cache
2560 * inside the object the pointer of the string of the last matching
2561 * comparison. Because most C compilers perform literal sharing,
2562 * so that: char *x = "foo", char *y = "foo", will lead to x == y,
2563 * this works pretty well even if comparisons are at different places
2564 * inside the C code. */
2566 static Jim_ObjType comparedStringObjType
= {
2571 JIM_TYPE_REFERENCES
,
2574 /* The only way this object is exposed to the API is via the following
2575 * function. Returns true if the string and the object string repr.
2576 * are the same, otherwise zero is returned.
2578 * Note: this isn't binary safe, but it hardly needs to be.*/
2579 int Jim_CompareStringImmediate(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
2582 if (objPtr
->typePtr
== &comparedStringObjType
&&
2583 objPtr
->internalRep
.ptr
== str
)
2586 const char *objStr
= Jim_GetString(objPtr
, NULL
);
2587 if (strcmp(str
, objStr
) != 0) return 0;
2588 if (objPtr
->typePtr
!= &comparedStringObjType
) {
2589 Jim_FreeIntRep(interp
, objPtr
);
2590 objPtr
->typePtr
= &comparedStringObjType
;
2592 objPtr
->internalRep
.ptr
= (char*)str
; /*ATTENTION: const cast */
2597 int qsortCompareStringPointers(const void *a
, const void *b
)
2599 char * const *sa
= (char * const *)a
;
2600 char * const *sb
= (char * const *)b
;
2601 return strcmp(*sa
, *sb
);
2604 int Jim_GetEnum(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
2605 const char * const *tablePtr
, int *indexPtr
, const char *name
, int flags
)
2607 const char * const *entryPtr
= NULL
;
2608 char **tablePtrSorted
;
2612 for (entryPtr
= tablePtr
, i
= 0; *entryPtr
!= NULL
; entryPtr
++, i
++) {
2613 if (Jim_CompareStringImmediate(interp
, objPtr
, *entryPtr
)) {
2617 count
++; /* If nothing matches, this will reach the len of tablePtr */
2619 if (flags
& JIM_ERRMSG
) {
2622 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
2623 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
2624 "bad ", name
, " \"", Jim_GetString(objPtr
, NULL
), "\": must be one of ",
2626 tablePtrSorted
= Jim_Alloc(sizeof(char*)*count
);
2627 memcpy(tablePtrSorted
, tablePtr
, sizeof(char*)*count
);
2628 qsort(tablePtrSorted
, count
, sizeof(char*), qsortCompareStringPointers
);
2629 for (i
= 0; i
< count
; i
++) {
2630 if (i
+ 1 == count
&& count
> 1)
2631 Jim_AppendString(interp
, Jim_GetResult(interp
), "or ", -1);
2632 Jim_AppendString(interp
, Jim_GetResult(interp
),
2633 tablePtrSorted
[i
], -1);
2635 Jim_AppendString(interp
, Jim_GetResult(interp
), ", ", -1);
2637 Jim_Free(tablePtrSorted
);
2642 int Jim_GetNvp(Jim_Interp
*interp
,
2644 const Jim_Nvp
*nvp_table
,
2645 const Jim_Nvp
** result
)
2650 e
= Jim_Nvp_name2value_obj(interp
, nvp_table
, objPtr
, &n
);
2655 /* Success? found? */
2658 *result
= (Jim_Nvp
*)n
;
2665 /* -----------------------------------------------------------------------------
2668 * This object is just a string from the language point of view, but
2669 * in the internal representation it contains the filename and line number
2670 * where this given token was read. This information is used by
2671 * Jim_EvalObj() if the object passed happens to be of type "source".
2673 * This allows to propagate the information about line numbers and file
2674 * names and give error messages with absolute line numbers.
2676 * Note that this object uses shared strings for filenames, and the
2677 * pointer to the filename together with the line number is taken into
2678 * the space for the "inline" internal represenation of the Jim_Object,
2679 * so there is almost memory zero-overhead.
2681 * Also the object will be converted to something else if the given
2682 * token it represents in the source file is not something to be
2683 * evaluated (not a script), and will be specialized in some other way,
2684 * so the time overhead is alzo null.
2685 * ---------------------------------------------------------------------------*/
2687 static void FreeSourceInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
2688 static void DupSourceInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
);
2690 static Jim_ObjType sourceObjType
= {
2692 FreeSourceInternalRep
,
2693 DupSourceInternalRep
,
2695 JIM_TYPE_REFERENCES
,
2698 void FreeSourceInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
2700 Jim_ReleaseSharedString(interp
,
2701 objPtr
->internalRep
.sourceValue
.fileName
);
2704 void DupSourceInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
)
2706 dupPtr
->internalRep
.sourceValue
.fileName
=
2707 Jim_GetSharedString(interp
,
2708 srcPtr
->internalRep
.sourceValue
.fileName
);
2709 dupPtr
->internalRep
.sourceValue
.lineNumber
=
2710 dupPtr
->internalRep
.sourceValue
.lineNumber
;
2711 dupPtr
->typePtr
= &sourceObjType
;
2714 static void JimSetSourceInfo(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
2715 const char *fileName
, int lineNumber
)
2717 if (Jim_IsShared(objPtr
))
2718 Jim_Panic(interp
,"JimSetSourceInfo called with shared object");
2719 if (objPtr
->typePtr
!= NULL
)
2720 Jim_Panic(interp
,"JimSetSourceInfo called with typePtr != NULL");
2721 objPtr
->internalRep
.sourceValue
.fileName
=
2722 Jim_GetSharedString(interp
, fileName
);
2723 objPtr
->internalRep
.sourceValue
.lineNumber
= lineNumber
;
2724 objPtr
->typePtr
= &sourceObjType
;
2727 /* -----------------------------------------------------------------------------
2729 * ---------------------------------------------------------------------------*/
2731 #define JIM_CMDSTRUCT_EXPAND -1
2733 static void FreeScriptInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
2734 static void DupScriptInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
);
2735 static int SetScriptFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
);
2737 static Jim_ObjType scriptObjType
= {
2739 FreeScriptInternalRep
,
2740 DupScriptInternalRep
,
2742 JIM_TYPE_REFERENCES
,
2745 /* The ScriptToken structure represents every token into a scriptObj.
2746 * Every token contains an associated Jim_Obj that can be specialized
2747 * by commands operating on it. */
2748 typedef struct ScriptToken
{
2754 /* This is the script object internal representation. An array of
2755 * ScriptToken structures, with an associated command structure array.
2756 * The command structure is a pre-computed representation of the
2757 * command length and arguments structure as a simple liner array
2760 * For example the script:
2763 * set $i $x$y [foo]BAR
2765 * will produce a ScriptObj with the following Tokens:
2782 * This is a description of the tokens, separators, and of lines.
2783 * The command structure instead represents the number of arguments
2784 * of every command, followed by the tokens of which every argument
2785 * is composed. So for the example script, the cmdstruct array will
2790 * Because "puts hello" has two args (2), composed of single tokens (1 1)
2791 * While "set $i $x$y [foo]BAR" has four (4) args, the first two
2792 * composed of single tokens (1 1) and the last two of double tokens
2795 * The precomputation of the command structure makes Jim_Eval() faster,
2796 * and simpler because there aren't dynamic lengths / allocations.
2798 * -- {expand} handling --
2800 * Expand is handled in a special way. When a command
2801 * contains at least an argument with the {expand} prefix,
2802 * the command structure presents a -1 before the integer
2803 * describing the number of arguments. This is used in order
2804 * to send the command exection to a different path in case
2805 * of {expand} and guarantee a fast path for the more common
2806 * case. Also, the integers describing the number of tokens
2807 * are expressed with negative sign, to allow for fast check
2808 * of what's an {expand}-prefixed argument and what not.
2810 * For example the command:
2812 * list {expand}{1 2}
2814 * Will produce the following cmdstruct array:
2818 * -- the substFlags field of the structure --
2820 * The scriptObj structure is used to represent both "script" objects
2821 * and "subst" objects. In the second case, the cmdStruct related
2822 * fields are not used at all, but there is an additional field used
2823 * that is 'substFlags': this represents the flags used to turn
2824 * the string into the intenral representation used to perform the
2825 * substitution. If this flags are not what the application requires
2826 * the scriptObj is created again. For example the script:
2828 * subst -nocommands $string
2829 * subst -novariables $string
2831 * Will recreate the internal representation of the $string object
2834 typedef struct ScriptObj
{
2835 int len
; /* Length as number of tokens. */
2836 int commands
; /* number of top-level commands in script. */
2837 ScriptToken
*token
; /* Tokens array. */
2838 int *cmdStruct
; /* commands structure */
2839 int csLen
; /* length of the cmdStruct array. */
2840 int substFlags
; /* flags used for the compilation of "subst" objects */
2841 int inUse
; /* Used to share a ScriptObj. Currently
2842 only used by Jim_EvalObj() as protection against
2843 shimmering of the currently evaluated object. */
2847 void FreeScriptInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
2850 struct ScriptObj
*script
= (void*) objPtr
->internalRep
.ptr
;
2856 if (script
->inUse
!= 0) return;
2857 for (i
= 0; i
< script
->len
; i
++) {
2858 if (script
->token
[i
].objPtr
!= NULL
)
2859 Jim_DecrRefCount(interp
, script
->token
[i
].objPtr
);
2861 Jim_Free(script
->token
);
2862 Jim_Free(script
->cmdStruct
);
2863 Jim_Free(script
->fileName
);
2867 void DupScriptInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
)
2869 JIM_NOTUSED(interp
);
2870 JIM_NOTUSED(srcPtr
);
2872 /* Just returns an simple string. */
2873 dupPtr
->typePtr
= NULL
;
2876 /* Add a new token to the internal repr of a script object */
2877 static void ScriptObjAddToken(Jim_Interp
*interp
, struct ScriptObj
*script
,
2878 char *strtoken
, int len
, int type
, char *filename
, int linenr
)
2881 struct ScriptToken
*token
;
2883 prevtype
= (script
->len
== 0) ? JIM_TT_EOL
: \
2884 script
->token
[script
->len
-1].type
;
2885 /* Skip tokens without meaning, like words separators
2886 * following a word separator or an end of command and
2888 if (prevtype
== JIM_TT_EOL
) {
2889 if (type
== JIM_TT_EOL
|| type
== JIM_TT_SEP
) {
2893 } else if (prevtype
== JIM_TT_SEP
) {
2894 if (type
== JIM_TT_SEP
) {
2897 } else if (type
== JIM_TT_EOL
) {
2898 /* If an EOL is following by a SEP, drop the previous
2901 Jim_DecrRefCount(interp
, script
->token
[script
->len
].objPtr
);
2903 } else if (prevtype
!= JIM_TT_EOL
&& prevtype
!= JIM_TT_SEP
&&
2904 type
== JIM_TT_ESC
&& len
== 0)
2906 /* Don't add empty tokens used in interpolation */
2910 /* Make space for a new istruction */
2912 script
->token
= Jim_Realloc(script
->token
,
2913 sizeof(ScriptToken
)*script
->len
);
2914 /* Initialize the new token */
2915 token
= script
->token
+ (script
->len
-1);
2917 /* Every object is intially as a string, but the
2918 * internal type may be specialized during execution of the
2920 token
->objPtr
= Jim_NewStringObjNoAlloc(interp
, strtoken
, len
);
2921 /* To add source info to SEP and EOL tokens is useless because
2922 * they will never by called as arguments of Jim_EvalObj(). */
2923 if (filename
&& type
!= JIM_TT_SEP
&& type
!= JIM_TT_EOL
)
2924 JimSetSourceInfo(interp
, token
->objPtr
, filename
, linenr
);
2925 Jim_IncrRefCount(token
->objPtr
);
2926 token
->linenr
= linenr
;
2929 /* Add an integer into the command structure field of the script object. */
2930 static void ScriptObjAddInt(struct ScriptObj
*script
, int val
)
2933 script
->cmdStruct
= Jim_Realloc(script
->cmdStruct
,
2934 sizeof(int)*script
->csLen
);
2935 script
->cmdStruct
[script
->csLen
-1] = val
;
2938 /* Search a Jim_Obj contained in 'script' with the same stinrg repr.
2939 * of objPtr. Search nested script objects recursively. */
2940 static Jim_Obj
*ScriptSearchLiteral(Jim_Interp
*interp
, ScriptObj
*script
,
2941 ScriptObj
*scriptBarrier
, Jim_Obj
*objPtr
)
2945 for (i
= 0; i
< script
->len
; i
++) {
2946 if (script
->token
[i
].objPtr
!= objPtr
&&
2947 Jim_StringEqObj(script
->token
[i
].objPtr
, objPtr
, 0)) {
2948 return script
->token
[i
].objPtr
;
2950 /* Enter recursively on scripts only if the object
2951 * is not the same as the one we are searching for
2952 * shared occurrences. */
2953 if (script
->token
[i
].objPtr
->typePtr
== &scriptObjType
&&
2954 script
->token
[i
].objPtr
!= objPtr
) {
2955 Jim_Obj
*foundObjPtr
;
2957 ScriptObj
*subScript
=
2958 script
->token
[i
].objPtr
->internalRep
.ptr
;
2959 /* Don't recursively enter the script we are trying
2960 * to make shared to avoid circular references. */
2961 if (subScript
== scriptBarrier
) continue;
2962 if (subScript
!= script
) {
2964 ScriptSearchLiteral(interp
, subScript
,
2965 scriptBarrier
, objPtr
);
2966 if (foundObjPtr
!= NULL
)
2974 /* Share literals of a script recursively sharing sub-scripts literals. */
2975 static void ScriptShareLiterals(Jim_Interp
*interp
, ScriptObj
*script
,
2976 ScriptObj
*topLevelScript
)
2981 /* Try to share with toplevel object. */
2982 if (topLevelScript
!= NULL
) {
2983 for (i
= 0; i
< script
->len
; i
++) {
2984 Jim_Obj
*foundObjPtr
;
2985 char *str
= script
->token
[i
].objPtr
->bytes
;
2987 if (script
->token
[i
].objPtr
->refCount
!= 1) continue;
2988 if (script
->token
[i
].objPtr
->typePtr
== &scriptObjType
) continue;
2989 if (strchr(str
, ' ') || strchr(str
, '\n')) continue;
2990 foundObjPtr
= ScriptSearchLiteral(interp
,
2992 script
, /* barrier */
2993 script
->token
[i
].objPtr
);
2994 if (foundObjPtr
!= NULL
) {
2995 Jim_IncrRefCount(foundObjPtr
);
2996 Jim_DecrRefCount(interp
,
2997 script
->token
[i
].objPtr
);
2998 script
->token
[i
].objPtr
= foundObjPtr
;
3002 /* Try to share locally */
3003 for (i
= 0; i
< script
->len
; i
++) {
3004 char *str
= script
->token
[i
].objPtr
->bytes
;
3006 if (script
->token
[i
].objPtr
->refCount
!= 1) continue;
3007 if (strchr(str
, ' ') || strchr(str
, '\n')) continue;
3008 for (j
= 0; j
< script
->len
; j
++) {
3009 if (script
->token
[i
].objPtr
!=
3010 script
->token
[j
].objPtr
&&
3011 Jim_StringEqObj(script
->token
[i
].objPtr
,
3012 script
->token
[j
].objPtr
, 0))
3014 Jim_IncrRefCount(script
->token
[j
].objPtr
);
3015 Jim_DecrRefCount(interp
,
3016 script
->token
[i
].objPtr
);
3017 script
->token
[i
].objPtr
=
3018 script
->token
[j
].objPtr
;
3024 /* This method takes the string representation of an object
3025 * as a Tcl script, and generates the pre-parsed internal representation
3027 int SetScriptFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
)
3030 const char *scriptText
= Jim_GetString(objPtr
, &scriptTextLen
);
3031 struct JimParserCtx parser
;
3032 struct ScriptObj
*script
= Jim_Alloc(sizeof(*script
));
3034 int args
, tokens
, start
, end
, i
;
3035 int initialLineNumber
;
3036 int propagateSourceInfo
= 0;
3040 script
->commands
= 0;
3041 script
->token
= NULL
;
3042 script
->cmdStruct
= NULL
;
3044 /* Try to get information about filename / line number */
3045 if (objPtr
->typePtr
== &sourceObjType
) {
3047 Jim_StrDup(objPtr
->internalRep
.sourceValue
.fileName
);
3048 initialLineNumber
= objPtr
->internalRep
.sourceValue
.lineNumber
;
3049 propagateSourceInfo
= 1;
3051 script
->fileName
= Jim_StrDup("");
3052 initialLineNumber
= 1;
3055 JimParserInit(&parser
, scriptText
, scriptTextLen
, initialLineNumber
);
3056 while (!JimParserEof(&parser
)) {
3058 int len
, type
, linenr
;
3060 JimParseScript(&parser
);
3061 token
= JimParserGetToken(&parser
, &len
, &type
, &linenr
);
3062 ScriptObjAddToken(interp
, script
, token
, len
, type
,
3063 propagateSourceInfo
? script
->fileName
: NULL
,
3066 token
= script
->token
;
3068 /* Compute the command structure array
3069 * (see the ScriptObj struct definition for more info) */
3070 start
= 0; /* Current command start token index */
3071 end
= -1; /* Current command end token index */
3073 int expand
= 0; /* expand flag. set to 1 on {expand} form. */
3074 int interpolation
= 0; /* set to 1 if there is at least one
3075 argument of the command obtained via
3076 interpolation of more tokens. */
3077 /* Search for the end of command, while
3078 * count the number of args. */
3080 if (start
>= script
->len
) break;
3081 args
= 1; /* Number of args in current command */
3082 while (token
[end
].type
!= JIM_TT_EOL
) {
3083 if (end
== 0 || token
[end
-1].type
== JIM_TT_SEP
||
3084 token
[end
-1].type
== JIM_TT_EOL
)
3086 if (token
[end
].type
== JIM_TT_STR
&&
3087 token
[end
+ 1].type
!= JIM_TT_SEP
&&
3088 token
[end
+ 1].type
!= JIM_TT_EOL
&&
3089 (!strcmp(token
[end
].objPtr
->bytes
, "expand") ||
3090 !strcmp(token
[end
].objPtr
->bytes
, "*")))
3093 if (token
[end
].type
== JIM_TT_SEP
)
3097 interpolation
= !((end
-start
+ 1) == args
*2);
3098 /* Add the 'number of arguments' info into cmdstruct.
3099 * Negative value if there is list expansion involved. */
3101 ScriptObjAddInt(script
, -1);
3102 ScriptObjAddInt(script
, args
);
3103 /* Now add info about the number of tokens. */
3104 tokens
= 0; /* Number of tokens in current argument. */
3106 for (i
= start
; i
<= end
; i
++) {
3107 if (token
[i
].type
== JIM_TT_SEP
||
3108 token
[i
].type
== JIM_TT_EOL
)
3110 if (tokens
== 1 && expand
)
3112 ScriptObjAddInt(script
,
3113 expand
? -tokens
: tokens
);
3118 } else if (tokens
== 0 && token
[i
].type
== JIM_TT_STR
&&
3119 (!strcmp(token
[i
].objPtr
->bytes
, "expand") ||
3120 !strcmp(token
[i
].objPtr
->bytes
, "*")))
3127 /* Perform literal sharing, but only for objects that appear
3128 * to be scripts written as literals inside the source code,
3129 * and not computed at runtime. Literal sharing is a costly
3130 * operation that should be done only against objects that
3131 * are likely to require compilation only the first time, and
3132 * then are executed multiple times. */
3133 if (propagateSourceInfo
&& interp
->framePtr
->procBodyObjPtr
) {
3134 Jim_Obj
*bodyObjPtr
= interp
->framePtr
->procBodyObjPtr
;
3135 if (bodyObjPtr
->typePtr
== &scriptObjType
) {
3136 ScriptObj
*bodyScript
=
3137 bodyObjPtr
->internalRep
.ptr
;
3138 ScriptShareLiterals(interp
, script
, bodyScript
);
3140 } else if (propagateSourceInfo
) {
3141 ScriptShareLiterals(interp
, script
, NULL
);
3143 /* Free the old internal rep and set the new one. */
3144 Jim_FreeIntRep(interp
, objPtr
);
3145 Jim_SetIntRepPtr(objPtr
, script
);
3146 objPtr
->typePtr
= &scriptObjType
;
3150 ScriptObj
*Jim_GetScript(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
3152 if (objPtr
->typePtr
!= &scriptObjType
) {
3153 SetScriptFromAny(interp
, objPtr
);
3155 return (ScriptObj
*) Jim_GetIntRepPtr(objPtr
);
3158 /* -----------------------------------------------------------------------------
3160 * ---------------------------------------------------------------------------*/
3162 /* Commands HashTable Type.
3164 * Keys are dynamic allocated strings, Values are Jim_Cmd structures. */
3165 static void Jim_CommandsHT_ValDestructor(void *interp
, void *val
)
3167 Jim_Cmd
*cmdPtr
= (void*) val
;
3169 if (cmdPtr
->cmdProc
== NULL
) {
3170 Jim_DecrRefCount(interp
, cmdPtr
->argListObjPtr
);
3171 Jim_DecrRefCount(interp
, cmdPtr
->bodyObjPtr
);
3172 if (cmdPtr
->staticVars
) {
3173 Jim_FreeHashTable(cmdPtr
->staticVars
);
3174 Jim_Free(cmdPtr
->staticVars
);
3176 } else if (cmdPtr
->delProc
!= NULL
) {
3177 /* If it was a C coded command, call the delProc if any */
3178 cmdPtr
->delProc(interp
, cmdPtr
->privData
);
3183 static Jim_HashTableType JimCommandsHashTableType
= {
3184 JimStringCopyHTHashFunction
, /* hash function */
3185 JimStringCopyHTKeyDup
, /* key dup */
3187 JimStringCopyHTKeyCompare
, /* key compare */
3188 JimStringCopyHTKeyDestructor
, /* key destructor */
3189 Jim_CommandsHT_ValDestructor
/* val destructor */
3192 /* ------------------------- Commands related functions --------------------- */
3194 int Jim_CreateCommand(Jim_Interp
*interp
, const char *cmdName
,
3195 Jim_CmdProc cmdProc
, void *privData
, Jim_DelCmdProc delProc
)
3200 he
= Jim_FindHashEntry(&interp
->commands
, cmdName
);
3201 if (he
== NULL
) { /* New command to create */
3202 cmdPtr
= Jim_Alloc(sizeof(*cmdPtr
));
3203 Jim_AddHashEntry(&interp
->commands
, cmdName
, cmdPtr
);
3205 Jim_InterpIncrProcEpoch(interp
);
3206 /* Free the arglist/body objects if it was a Tcl procedure */
3208 if (cmdPtr
->cmdProc
== NULL
) {
3209 Jim_DecrRefCount(interp
, cmdPtr
->argListObjPtr
);
3210 Jim_DecrRefCount(interp
, cmdPtr
->bodyObjPtr
);
3211 if (cmdPtr
->staticVars
) {
3212 Jim_FreeHashTable(cmdPtr
->staticVars
);
3213 Jim_Free(cmdPtr
->staticVars
);
3215 cmdPtr
->staticVars
= NULL
;
3216 } else if (cmdPtr
->delProc
!= NULL
) {
3217 /* If it was a C coded command, call the delProc if any */
3218 cmdPtr
->delProc(interp
, cmdPtr
->privData
);
3222 /* Store the new details for this proc */
3223 cmdPtr
->delProc
= delProc
;
3224 cmdPtr
->cmdProc
= cmdProc
;
3225 cmdPtr
->privData
= privData
;
3227 /* There is no need to increment the 'proc epoch' because
3228 * creation of a new procedure can never affect existing
3229 * cached commands. We don't do negative caching. */
3233 int Jim_CreateProcedure(Jim_Interp
*interp
, const char *cmdName
,
3234 Jim_Obj
*argListObjPtr
, Jim_Obj
*staticsListObjPtr
, Jim_Obj
*bodyObjPtr
,
3235 int arityMin
, int arityMax
)
3239 cmdPtr
= Jim_Alloc(sizeof(*cmdPtr
));
3240 cmdPtr
->cmdProc
= NULL
; /* Not a C coded command */
3241 cmdPtr
->argListObjPtr
= argListObjPtr
;
3242 cmdPtr
->bodyObjPtr
= bodyObjPtr
;
3243 Jim_IncrRefCount(argListObjPtr
);
3244 Jim_IncrRefCount(bodyObjPtr
);
3245 cmdPtr
->arityMin
= arityMin
;
3246 cmdPtr
->arityMax
= arityMax
;
3247 cmdPtr
->staticVars
= NULL
;
3249 /* Create the statics hash table. */
3250 if (staticsListObjPtr
) {
3253 Jim_ListLength(interp
, staticsListObjPtr
, &len
);
3255 cmdPtr
->staticVars
= Jim_Alloc(sizeof(Jim_HashTable
));
3256 Jim_InitHashTable(cmdPtr
->staticVars
, getJimVariablesHashTableType(),
3258 for (i
= 0; i
< len
; i
++) {
3259 Jim_Obj
*objPtr
=NULL
, *initObjPtr
=NULL
, *nameObjPtr
=NULL
;
3263 Jim_ListIndex(interp
, staticsListObjPtr
, i
, &objPtr
, JIM_NONE
);
3264 /* Check if it's composed of two elements. */
3265 Jim_ListLength(interp
, objPtr
, &subLen
);
3266 if (subLen
== 1 || subLen
== 2) {
3267 /* Try to get the variable value from the current
3269 Jim_ListIndex(interp
, objPtr
, 0, &nameObjPtr
, JIM_NONE
);
3271 initObjPtr
= Jim_GetVariable(interp
, nameObjPtr
,
3273 if (initObjPtr
== NULL
) {
3274 Jim_SetResult(interp
,
3275 Jim_NewEmptyStringObj(interp
));
3276 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
3277 "variable for initialization of static \"",
3278 Jim_GetString(nameObjPtr
, NULL
),
3279 "\" not found in the local context",
3284 Jim_ListIndex(interp
, objPtr
, 1, &initObjPtr
, JIM_NONE
);
3286 varPtr
= Jim_Alloc(sizeof(*varPtr
));
3287 varPtr
->objPtr
= initObjPtr
;
3288 Jim_IncrRefCount(initObjPtr
);
3289 varPtr
->linkFramePtr
= NULL
;
3290 if (Jim_AddHashEntry(cmdPtr
->staticVars
,
3291 Jim_GetString(nameObjPtr
, NULL
),
3294 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
3295 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
3296 "static variable name \"",
3297 Jim_GetString(objPtr
, NULL
), "\"",
3298 " duplicated in statics list", NULL
);
3299 Jim_DecrRefCount(interp
, initObjPtr
);
3304 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
3305 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
3306 "too many fields in static specifier \"",
3307 objPtr
, "\"", NULL
);
3314 /* Add the new command */
3316 /* it may already exist, so we try to delete the old one */
3317 if (Jim_DeleteHashEntry(&interp
->commands
, cmdName
) != JIM_ERR
) {
3318 /* There was an old procedure with the same name, this requires
3319 * a 'proc epoch' update. */
3320 Jim_InterpIncrProcEpoch(interp
);
3322 /* If a procedure with the same name didn't existed there is no need
3323 * to increment the 'proc epoch' because creation of a new procedure
3324 * can never affect existing cached commands. We don't do
3325 * negative caching. */
3326 Jim_AddHashEntry(&interp
->commands
, cmdName
, cmdPtr
);
3330 Jim_FreeHashTable(cmdPtr
->staticVars
);
3331 Jim_Free(cmdPtr
->staticVars
);
3332 Jim_DecrRefCount(interp
, argListObjPtr
);
3333 Jim_DecrRefCount(interp
, bodyObjPtr
);
3338 int Jim_DeleteCommand(Jim_Interp
*interp
, const char *cmdName
)
3340 if (Jim_DeleteHashEntry(&interp
->commands
, cmdName
) == JIM_ERR
)
3342 Jim_InterpIncrProcEpoch(interp
);
3346 int Jim_RenameCommand(Jim_Interp
*interp
, const char *oldName
,
3347 const char *newName
)
3351 Jim_Cmd
*copyCmdPtr
;
3353 if (newName
[0] == '\0') /* Delete! */
3354 return Jim_DeleteCommand(interp
, oldName
);
3356 he
= Jim_FindHashEntry(&interp
->commands
, oldName
);
3358 return JIM_ERR
; /* Invalid command name */
3360 copyCmdPtr
= Jim_Alloc(sizeof(Jim_Cmd
));
3361 *copyCmdPtr
= *cmdPtr
;
3362 /* In order to avoid that a procedure will get arglist/body/statics
3363 * freed by the hash table methods, fake a C-coded command
3364 * setting cmdPtr->cmdProc as not NULL */
3365 cmdPtr
->cmdProc
= (Jim_CmdProc
)1;
3366 /* Also make sure delProc is NULL. */
3367 cmdPtr
->delProc
= NULL
;
3368 /* Destroy the old command, and make sure the new is freed
3370 Jim_DeleteHashEntry(&interp
->commands
, oldName
);
3371 Jim_DeleteHashEntry(&interp
->commands
, newName
);
3372 /* Now the new command. We are sure it can't fail because
3373 * the target name was already freed. */
3374 Jim_AddHashEntry(&interp
->commands
, newName
, copyCmdPtr
);
3375 /* Increment the epoch */
3376 Jim_InterpIncrProcEpoch(interp
);
3380 /* -----------------------------------------------------------------------------
3382 * ---------------------------------------------------------------------------*/
3384 static int SetCommandFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
);
3386 static Jim_ObjType commandObjType
= {
3391 JIM_TYPE_REFERENCES
,
3394 int SetCommandFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
3397 const char *cmdName
;
3399 /* Get the string representation */
3400 cmdName
= Jim_GetString(objPtr
, NULL
);
3401 /* Lookup this name into the commands hash table */
3402 he
= Jim_FindHashEntry(&interp
->commands
, cmdName
);
3406 /* Free the old internal repr and set the new one. */
3407 Jim_FreeIntRep(interp
, objPtr
);
3408 objPtr
->typePtr
= &commandObjType
;
3409 objPtr
->internalRep
.cmdValue
.procEpoch
= interp
->procEpoch
;
3410 objPtr
->internalRep
.cmdValue
.cmdPtr
= (void*)he
->val
;
3414 /* This function returns the command structure for the command name
3415 * stored in objPtr. It tries to specialize the objPtr to contain
3416 * a cached info instead to perform the lookup into the hash table
3417 * every time. The information cached may not be uptodate, in such
3418 * a case the lookup is performed and the cache updated. */
3419 Jim_Cmd
*Jim_GetCommand(Jim_Interp
*interp
, Jim_Obj
*objPtr
, int flags
)
3421 if ((objPtr
->typePtr
!= &commandObjType
||
3422 objPtr
->internalRep
.cmdValue
.procEpoch
!= interp
->procEpoch
) &&
3423 SetCommandFromAny(interp
, objPtr
) == JIM_ERR
) {
3424 if (flags
& JIM_ERRMSG
) {
3425 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
3426 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
3427 "invalid command name \"", objPtr
->bytes
, "\"",
3432 return objPtr
->internalRep
.cmdValue
.cmdPtr
;
3435 /* -----------------------------------------------------------------------------
3437 * ---------------------------------------------------------------------------*/
3439 /* Variables HashTable Type.
3441 * Keys are dynamic allocated strings, Values are Jim_Var structures. */
3442 static void JimVariablesHTValDestructor(void *interp
, void *val
)
3444 Jim_Var
*varPtr
= (void*) val
;
3446 Jim_DecrRefCount(interp
, varPtr
->objPtr
);
3450 static Jim_HashTableType JimVariablesHashTableType
= {
3451 JimStringCopyHTHashFunction
, /* hash function */
3452 JimStringCopyHTKeyDup
, /* key dup */
3454 JimStringCopyHTKeyCompare
, /* key compare */
3455 JimStringCopyHTKeyDestructor
, /* key destructor */
3456 JimVariablesHTValDestructor
/* val destructor */
3459 static Jim_HashTableType
*getJimVariablesHashTableType(void)
3461 return &JimVariablesHashTableType
;
3464 /* -----------------------------------------------------------------------------
3466 * ---------------------------------------------------------------------------*/
3468 #define JIM_DICT_SUGAR 100 /* Only returned by SetVariableFromAny() */
3470 static int SetVariableFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
);
3472 static Jim_ObjType variableObjType
= {
3477 JIM_TYPE_REFERENCES
,
3480 /* Return true if the string "str" looks like syntax sugar for [dict]. I.e.
3481 * is in the form "varname(key)". */
3482 static int Jim_NameIsDictSugar(const char *str
, int len
)
3486 if (len
&& str
[len
-1] == ')' && strchr(str
, '(') != NULL
)
3491 /* This method should be called only by the variable API.
3492 * It returns JIM_OK on success (variable already exists),
3493 * JIM_ERR if it does not exists, JIM_DICT_GLUE if it's not
3494 * a variable name, but syntax glue for [dict] i.e. the last
3495 * character is ')' */
3496 int SetVariableFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
)
3499 const char *varName
;
3502 /* Check if the object is already an uptodate variable */
3503 if (objPtr
->typePtr
== &variableObjType
&&
3504 objPtr
->internalRep
.varValue
.callFrameId
== interp
->framePtr
->id
)
3505 return JIM_OK
; /* nothing to do */
3506 /* Get the string representation */
3507 varName
= Jim_GetString(objPtr
, &len
);
3508 /* Make sure it's not syntax glue to get/set dict. */
3509 if (Jim_NameIsDictSugar(varName
, len
))
3510 return JIM_DICT_SUGAR
;
3511 if (varName
[0] == ':' && varName
[1] == ':') {
3512 he
= Jim_FindHashEntry(&interp
->topFramePtr
->vars
, varName
+ 2);
3518 /* Lookup this name into the variables hash table */
3519 he
= Jim_FindHashEntry(&interp
->framePtr
->vars
, varName
);
3521 /* Try with static vars. */
3522 if (interp
->framePtr
->staticVars
== NULL
)
3524 if (!(he
= Jim_FindHashEntry(interp
->framePtr
->staticVars
, varName
)))
3528 /* Free the old internal repr and set the new one. */
3529 Jim_FreeIntRep(interp
, objPtr
);
3530 objPtr
->typePtr
= &variableObjType
;
3531 objPtr
->internalRep
.varValue
.callFrameId
= interp
->framePtr
->id
;
3532 objPtr
->internalRep
.varValue
.varPtr
= (void*)he
->val
;
3536 /* -------------------- Variables related functions ------------------------- */
3537 static int JimDictSugarSet(Jim_Interp
*interp
, Jim_Obj
*ObjPtr
,
3538 Jim_Obj
*valObjPtr
);
3539 static Jim_Obj
*JimDictSugarGet(Jim_Interp
*interp
, Jim_Obj
*ObjPtr
);
3541 /* For now that's dummy. Variables lookup should be optimized
3542 * in many ways, with caching of lookups, and possibly with
3543 * a table of pre-allocated vars in every CallFrame for local vars.
3544 * All the caching should also have an 'epoch' mechanism similar
3545 * to the one used by Tcl for procedures lookup caching. */
3547 int Jim_SetVariable(Jim_Interp
*interp
, Jim_Obj
*nameObjPtr
, Jim_Obj
*valObjPtr
)
3553 if ((err
= SetVariableFromAny(interp
, nameObjPtr
)) != JIM_OK
) {
3554 /* Check for [dict] syntax sugar. */
3555 if (err
== JIM_DICT_SUGAR
)
3556 return JimDictSugarSet(interp
, nameObjPtr
, valObjPtr
);
3557 /* New variable to create */
3558 name
= Jim_GetString(nameObjPtr
, NULL
);
3560 var
= Jim_Alloc(sizeof(*var
));
3561 var
->objPtr
= valObjPtr
;
3562 Jim_IncrRefCount(valObjPtr
);
3563 var
->linkFramePtr
= NULL
;
3564 /* Insert the new variable */
3565 if (name
[0] == ':' && name
[1] == ':') {
3566 /* Into to the top evel frame */
3567 Jim_AddHashEntry(&interp
->topFramePtr
->vars
, name
+ 2, var
);
3570 Jim_AddHashEntry(&interp
->framePtr
->vars
, name
, var
);
3572 /* Make the object int rep a variable */
3573 Jim_FreeIntRep(interp
, nameObjPtr
);
3574 nameObjPtr
->typePtr
= &variableObjType
;
3575 nameObjPtr
->internalRep
.varValue
.callFrameId
=
3576 interp
->framePtr
->id
;
3577 nameObjPtr
->internalRep
.varValue
.varPtr
= var
;
3579 var
= nameObjPtr
->internalRep
.varValue
.varPtr
;
3580 if (var
->linkFramePtr
== NULL
) {
3581 Jim_IncrRefCount(valObjPtr
);
3582 Jim_DecrRefCount(interp
, var
->objPtr
);
3583 var
->objPtr
= valObjPtr
;
3584 } else { /* Else handle the link */
3585 Jim_CallFrame
*savedCallFrame
;
3587 savedCallFrame
= interp
->framePtr
;
3588 interp
->framePtr
= var
->linkFramePtr
;
3589 err
= Jim_SetVariable(interp
, var
->objPtr
, valObjPtr
);
3590 interp
->framePtr
= savedCallFrame
;
3598 int Jim_SetVariableStr(Jim_Interp
*interp
, const char *name
, Jim_Obj
*objPtr
)
3600 Jim_Obj
*nameObjPtr
;
3603 nameObjPtr
= Jim_NewStringObj(interp
, name
, -1);
3604 Jim_IncrRefCount(nameObjPtr
);
3605 result
= Jim_SetVariable(interp
, nameObjPtr
, objPtr
);
3606 Jim_DecrRefCount(interp
, nameObjPtr
);
3610 int Jim_SetGlobalVariableStr(Jim_Interp
*interp
, const char *name
, Jim_Obj
*objPtr
)
3612 Jim_CallFrame
*savedFramePtr
;
3615 savedFramePtr
= interp
->framePtr
;
3616 interp
->framePtr
= interp
->topFramePtr
;
3617 result
= Jim_SetVariableStr(interp
, name
, objPtr
);
3618 interp
->framePtr
= savedFramePtr
;
3622 int Jim_SetVariableStrWithStr(Jim_Interp
*interp
, const char *name
, const char *val
)
3624 Jim_Obj
*nameObjPtr
, *valObjPtr
;
3627 nameObjPtr
= Jim_NewStringObj(interp
, name
, -1);
3628 valObjPtr
= Jim_NewStringObj(interp
, val
, -1);
3629 Jim_IncrRefCount(nameObjPtr
);
3630 Jim_IncrRefCount(valObjPtr
);
3631 result
= Jim_SetVariable(interp
, nameObjPtr
, valObjPtr
);
3632 Jim_DecrRefCount(interp
, nameObjPtr
);
3633 Jim_DecrRefCount(interp
, valObjPtr
);
3637 int Jim_SetVariableLink(Jim_Interp
*interp
, Jim_Obj
*nameObjPtr
,
3638 Jim_Obj
*targetNameObjPtr
, Jim_CallFrame
*targetCallFrame
)
3640 const char *varName
;
3643 /* Check for cycles. */
3644 if (interp
->framePtr
== targetCallFrame
) {
3645 Jim_Obj
*objPtr
= targetNameObjPtr
;
3647 /* Cycles are only possible with 'uplevel 0' */
3649 if (Jim_StringEqObj(objPtr
, nameObjPtr
, 0)) {
3650 Jim_SetResultString(interp
,
3651 "can't upvar from variable to itself", -1);
3654 if (SetVariableFromAny(interp
, objPtr
) != JIM_OK
)
3656 varPtr
= objPtr
->internalRep
.varValue
.varPtr
;
3657 if (varPtr
->linkFramePtr
!= targetCallFrame
) break;
3658 objPtr
= varPtr
->objPtr
;
3661 varName
= Jim_GetString(nameObjPtr
, &len
);
3662 if (Jim_NameIsDictSugar(varName
, len
)) {
3663 Jim_SetResultString(interp
,
3664 "Dict key syntax invalid as link source", -1);
3667 /* Perform the binding */
3668 Jim_SetVariable(interp
, nameObjPtr
, targetNameObjPtr
);
3669 /* We are now sure 'nameObjPtr' type is variableObjType */
3670 nameObjPtr
->internalRep
.varValue
.varPtr
->linkFramePtr
= targetCallFrame
;
3674 /* Return the Jim_Obj pointer associated with a variable name,
3675 * or NULL if the variable was not found in the current context.
3676 * The same optimization discussed in the comment to the
3677 * 'SetVariable' function should apply here. */
3678 Jim_Obj
*Jim_GetVariable(Jim_Interp
*interp
, Jim_Obj
*nameObjPtr
, int flags
)
3682 /* All the rest is handled here */
3683 if ((err
= SetVariableFromAny(interp
, nameObjPtr
)) != JIM_OK
) {
3684 /* Check for [dict] syntax sugar. */
3685 if (err
== JIM_DICT_SUGAR
)
3686 return JimDictSugarGet(interp
, nameObjPtr
);
3687 if (flags
& JIM_ERRMSG
) {
3688 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
3689 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
3690 "can't read \"", nameObjPtr
->bytes
,
3691 "\": no such variable", NULL
);
3697 Jim_CallFrame
*savedCallFrame
;
3699 varPtr
= nameObjPtr
->internalRep
.varValue
.varPtr
;
3700 if (varPtr
->linkFramePtr
== NULL
)
3701 return varPtr
->objPtr
;
3702 /* The variable is a link? Resolve it. */
3703 savedCallFrame
= interp
->framePtr
;
3704 interp
->framePtr
= varPtr
->linkFramePtr
;
3705 objPtr
= Jim_GetVariable(interp
, varPtr
->objPtr
, JIM_NONE
);
3706 if (objPtr
== NULL
&& flags
& JIM_ERRMSG
) {
3707 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
3708 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
3709 "can't read \"", nameObjPtr
->bytes
,
3710 "\": no such variable", NULL
);
3712 interp
->framePtr
= savedCallFrame
;
3717 Jim_Obj
*Jim_GetGlobalVariable(Jim_Interp
*interp
, Jim_Obj
*nameObjPtr
,
3720 Jim_CallFrame
*savedFramePtr
;
3723 savedFramePtr
= interp
->framePtr
;
3724 interp
->framePtr
= interp
->topFramePtr
;
3725 objPtr
= Jim_GetVariable(interp
, nameObjPtr
, flags
);
3726 interp
->framePtr
= savedFramePtr
;
3731 Jim_Obj
*Jim_GetVariableStr(Jim_Interp
*interp
, const char *name
, int flags
)
3733 Jim_Obj
*nameObjPtr
, *varObjPtr
;
3735 nameObjPtr
= Jim_NewStringObj(interp
, name
, -1);
3736 Jim_IncrRefCount(nameObjPtr
);
3737 varObjPtr
= Jim_GetVariable(interp
, nameObjPtr
, flags
);
3738 Jim_DecrRefCount(interp
, nameObjPtr
);
3742 Jim_Obj
*Jim_GetGlobalVariableStr(Jim_Interp
*interp
, const char *name
,
3745 Jim_CallFrame
*savedFramePtr
;
3748 savedFramePtr
= interp
->framePtr
;
3749 interp
->framePtr
= interp
->topFramePtr
;
3750 objPtr
= Jim_GetVariableStr(interp
, name
, flags
);
3751 interp
->framePtr
= savedFramePtr
;
3756 /* Unset a variable.
3757 * Note: On success unset invalidates all the variable objects created
3758 * in the current call frame incrementing. */
3759 int Jim_UnsetVariable(Jim_Interp
*interp
, Jim_Obj
*nameObjPtr
, int flags
)
3765 if ((err
= SetVariableFromAny(interp
, nameObjPtr
)) != JIM_OK
) {
3766 /* Check for [dict] syntax sugar. */
3767 if (err
== JIM_DICT_SUGAR
)
3768 return JimDictSugarSet(interp
, nameObjPtr
, NULL
);
3769 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
3770 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
3771 "can't unset \"", nameObjPtr
->bytes
,
3772 "\": no such variable", NULL
);
3773 return JIM_ERR
; /* var not found */
3775 varPtr
= nameObjPtr
->internalRep
.varValue
.varPtr
;
3776 /* If it's a link call UnsetVariable recursively */
3777 if (varPtr
->linkFramePtr
) {
3780 Jim_CallFrame
*savedCallFrame
;
3782 savedCallFrame
= interp
->framePtr
;
3783 interp
->framePtr
= varPtr
->linkFramePtr
;
3784 retval
= Jim_UnsetVariable(interp
, varPtr
->objPtr
, JIM_NONE
);
3785 interp
->framePtr
= savedCallFrame
;
3786 if (retval
!= JIM_OK
&& flags
& JIM_ERRMSG
) {
3787 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
3788 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
3789 "can't unset \"", nameObjPtr
->bytes
,
3790 "\": no such variable", NULL
);
3794 name
= Jim_GetString(nameObjPtr
, NULL
);
3795 if (Jim_DeleteHashEntry(&interp
->framePtr
->vars
, name
)
3796 != JIM_OK
) return JIM_ERR
;
3797 /* Change the callframe id, invalidating var lookup caching */
3798 JimChangeCallFrameId(interp
, interp
->framePtr
);
3803 /* ---------- Dict syntax sugar (similar to array Tcl syntax) -------------- */
3805 /* Given a variable name for [dict] operation syntax sugar,
3806 * this function returns two objects, the first with the name
3807 * of the variable to set, and the second with the rispective key.
3808 * For example "foo(bar)" will return objects with string repr. of
3811 * The returned objects have refcount = 1. The function can't fail. */
3812 static void JimDictSugarParseVarKey(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
3813 Jim_Obj
**varPtrPtr
, Jim_Obj
**keyPtrPtr
)
3815 const char *str
, *p
;
3817 int len
, keyLen
, nameLen
;
3818 Jim_Obj
*varObjPtr
, *keyObjPtr
;
3820 str
= Jim_GetString(objPtr
, &len
);
3821 p
= strchr(str
, '(');
3823 keyLen
= len
-((p
-str
) + 1);
3824 nameLen
= (p
-str
)-1;
3825 /* Create the objects with the variable name and key. */
3826 t
= Jim_Alloc(nameLen
+ 1);
3827 memcpy(t
, str
, nameLen
);
3829 varObjPtr
= Jim_NewStringObjNoAlloc(interp
, t
, nameLen
);
3831 t
= Jim_Alloc(keyLen
+ 1);
3832 memcpy(t
, p
, keyLen
);
3834 keyObjPtr
= Jim_NewStringObjNoAlloc(interp
, t
, keyLen
);
3836 Jim_IncrRefCount(varObjPtr
);
3837 Jim_IncrRefCount(keyObjPtr
);
3838 *varPtrPtr
= varObjPtr
;
3839 *keyPtrPtr
= keyObjPtr
;
3842 /* Helper of Jim_SetVariable() to deal with dict-syntax variable names.
3843 * Also used by Jim_UnsetVariable() with valObjPtr = NULL. */
3844 static int JimDictSugarSet(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
3847 Jim_Obj
*varObjPtr
, *keyObjPtr
;
3850 JimDictSugarParseVarKey(interp
, objPtr
, &varObjPtr
, &keyObjPtr
);
3851 err
= Jim_SetDictKeysVector(interp
, varObjPtr
, &keyObjPtr
, 1,
3853 Jim_DecrRefCount(interp
, varObjPtr
);
3854 Jim_DecrRefCount(interp
, keyObjPtr
);
3858 /* Helper of Jim_GetVariable() to deal with dict-syntax variable names */
3859 static Jim_Obj
*JimDictSugarGet(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
3861 Jim_Obj
*varObjPtr
, *keyObjPtr
, *dictObjPtr
, *resObjPtr
;
3863 JimDictSugarParseVarKey(interp
, objPtr
, &varObjPtr
, &keyObjPtr
);
3864 dictObjPtr
= Jim_GetVariable(interp
, varObjPtr
, JIM_ERRMSG
);
3869 if (Jim_DictKey(interp
, dictObjPtr
, keyObjPtr
, &resObjPtr
, JIM_ERRMSG
)
3874 Jim_DecrRefCount(interp
, varObjPtr
);
3875 Jim_DecrRefCount(interp
, keyObjPtr
);
3879 /* --------- $var(INDEX) substitution, using a specialized object ----------- */
3881 static void FreeDictSubstInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
3882 static void DupDictSubstInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
,
3885 static Jim_ObjType dictSubstObjType
= {
3886 "dict-substitution",
3887 FreeDictSubstInternalRep
,
3888 DupDictSubstInternalRep
,
3893 void FreeDictSubstInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
3895 Jim_DecrRefCount(interp
, objPtr
->internalRep
.dictSubstValue
.varNameObjPtr
);
3896 Jim_DecrRefCount(interp
, objPtr
->internalRep
.dictSubstValue
.indexObjPtr
);
3899 void DupDictSubstInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
,
3902 JIM_NOTUSED(interp
);
3904 dupPtr
->internalRep
.dictSubstValue
.varNameObjPtr
=
3905 srcPtr
->internalRep
.dictSubstValue
.varNameObjPtr
;
3906 dupPtr
->internalRep
.dictSubstValue
.indexObjPtr
=
3907 srcPtr
->internalRep
.dictSubstValue
.indexObjPtr
;
3908 dupPtr
->typePtr
= &dictSubstObjType
;
3911 /* This function is used to expand [dict get] sugar in the form
3912 * of $var(INDEX). The function is mainly used by Jim_EvalObj()
3913 * to deal with tokens of type JIM_TT_DICTSUGAR. objPtr points to an
3914 * object that is *guaranteed* to be in the form VARNAME(INDEX).
3915 * The 'index' part is [subst]ituted, and is used to lookup a key inside
3916 * the [dict]ionary contained in variable VARNAME. */
3917 Jim_Obj
*Jim_ExpandDictSugar(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
3919 Jim_Obj
*varObjPtr
, *keyObjPtr
, *dictObjPtr
, *resObjPtr
;
3920 Jim_Obj
*substKeyObjPtr
= NULL
;
3922 if (objPtr
->typePtr
!= &dictSubstObjType
) {
3923 JimDictSugarParseVarKey(interp
, objPtr
, &varObjPtr
, &keyObjPtr
);
3924 Jim_FreeIntRep(interp
, objPtr
);
3925 objPtr
->typePtr
= &dictSubstObjType
;
3926 objPtr
->internalRep
.dictSubstValue
.varNameObjPtr
= varObjPtr
;
3927 objPtr
->internalRep
.dictSubstValue
.indexObjPtr
= keyObjPtr
;
3929 if (Jim_SubstObj(interp
, objPtr
->internalRep
.dictSubstValue
.indexObjPtr
,
3930 &substKeyObjPtr
, JIM_NONE
)
3932 substKeyObjPtr
= NULL
;
3935 Jim_IncrRefCount(substKeyObjPtr
);
3936 dictObjPtr
= Jim_GetVariable(interp
,
3937 objPtr
->internalRep
.dictSubstValue
.varNameObjPtr
, JIM_ERRMSG
);
3942 if (Jim_DictKey(interp
, dictObjPtr
, substKeyObjPtr
, &resObjPtr
, JIM_ERRMSG
)
3948 if (substKeyObjPtr
) Jim_DecrRefCount(interp
, substKeyObjPtr
);
3952 /* -----------------------------------------------------------------------------
3954 * ---------------------------------------------------------------------------*/
3956 static Jim_CallFrame
*JimCreateCallFrame(Jim_Interp
*interp
)
3959 if (interp
->freeFramesList
) {
3960 cf
= interp
->freeFramesList
;
3961 interp
->freeFramesList
= cf
->nextFramePtr
;
3963 cf
= Jim_Alloc(sizeof(*cf
));
3964 cf
->vars
.table
= NULL
;
3967 cf
->id
= interp
->callFrameEpoch
++;
3968 cf
->parentCallFrame
= NULL
;
3971 cf
->procArgsObjPtr
= NULL
;
3972 cf
->procBodyObjPtr
= NULL
;
3973 cf
->nextFramePtr
= NULL
;
3974 cf
->staticVars
= NULL
;
3975 if (cf
->vars
.table
== NULL
)
3976 Jim_InitHashTable(&cf
->vars
, &JimVariablesHashTableType
, interp
);
3980 /* Used to invalidate every caching related to callframe stability. */
3981 static void JimChangeCallFrameId(Jim_Interp
*interp
, Jim_CallFrame
*cf
)
3983 cf
->id
= interp
->callFrameEpoch
++;
3986 #define JIM_FCF_NONE 0 /* no flags */
3987 #define JIM_FCF_NOHT 1 /* don't free the hash table */
3988 static void JimFreeCallFrame(Jim_Interp
*interp
, Jim_CallFrame
*cf
,
3991 if (cf
->procArgsObjPtr
) Jim_DecrRefCount(interp
, cf
->procArgsObjPtr
);
3992 if (cf
->procBodyObjPtr
) Jim_DecrRefCount(interp
, cf
->procBodyObjPtr
);
3993 if (!(flags
& JIM_FCF_NOHT
))
3994 Jim_FreeHashTable(&cf
->vars
);
3997 Jim_HashEntry
**table
= cf
->vars
.table
, *he
;
3999 for (i
= 0; i
< JIM_HT_INITIAL_SIZE
; i
++) {
4001 while (he
!= NULL
) {
4002 Jim_HashEntry
*nextEntry
= he
->next
;
4003 Jim_Var
*varPtr
= (void*) he
->val
;
4005 Jim_DecrRefCount(interp
, varPtr
->objPtr
);
4007 Jim_Free((void*)he
->key
); /* ATTENTION: const cast */
4015 cf
->nextFramePtr
= interp
->freeFramesList
;
4016 interp
->freeFramesList
= cf
;
4019 /* -----------------------------------------------------------------------------
4021 * ---------------------------------------------------------------------------*/
4023 /* References HashTable Type.
4025 * Keys are jim_wide integers, dynamically allocated for now but in the
4026 * future it's worth to cache this 8 bytes objects. Values are poitners
4027 * to Jim_References. */
4028 static void JimReferencesHTValDestructor(void *interp
, void *val
)
4030 Jim_Reference
*refPtr
= (void*) val
;
4032 Jim_DecrRefCount(interp
, refPtr
->objPtr
);
4033 if (refPtr
->finalizerCmdNamePtr
!= NULL
) {
4034 Jim_DecrRefCount(interp
, refPtr
->finalizerCmdNamePtr
);
4039 unsigned int JimReferencesHTHashFunction(const void *key
)
4041 /* Only the least significant bits are used. */
4042 const jim_wide
*widePtr
= key
;
4043 unsigned int intValue
= (unsigned int) *widePtr
;
4044 return Jim_IntHashFunction(intValue
);
4047 unsigned int JimReferencesHTDoubleHashFunction(const void *key
)
4049 /* Only the least significant bits are used. */
4050 const jim_wide
*widePtr
= key
;
4051 unsigned int intValue
= (unsigned int) *widePtr
;
4052 return intValue
; /* identity function. */
4055 const void *JimReferencesHTKeyDup(void *privdata
, const void *key
)
4057 void *copy
= Jim_Alloc(sizeof(jim_wide
));
4058 JIM_NOTUSED(privdata
);
4060 memcpy(copy
, key
, sizeof(jim_wide
));
4064 int JimReferencesHTKeyCompare(void *privdata
, const void *key1
,
4067 JIM_NOTUSED(privdata
);
4069 return memcmp(key1
, key2
, sizeof(jim_wide
)) == 0;
4072 void JimReferencesHTKeyDestructor(void *privdata
, const void *key
)
4074 JIM_NOTUSED(privdata
);
4076 Jim_Free((void*)key
);
4079 static Jim_HashTableType JimReferencesHashTableType
= {
4080 JimReferencesHTHashFunction
, /* hash function */
4081 JimReferencesHTKeyDup
, /* key dup */
4083 JimReferencesHTKeyCompare
, /* key compare */
4084 JimReferencesHTKeyDestructor
, /* key destructor */
4085 JimReferencesHTValDestructor
/* val destructor */
4088 /* -----------------------------------------------------------------------------
4089 * Reference object type and References API
4090 * ---------------------------------------------------------------------------*/
4092 static void UpdateStringOfReference(struct Jim_Obj
*objPtr
);
4094 static Jim_ObjType referenceObjType
= {
4098 UpdateStringOfReference
,
4099 JIM_TYPE_REFERENCES
,
4102 void UpdateStringOfReference(struct Jim_Obj
*objPtr
)
4105 char buf
[JIM_REFERENCE_SPACE
+ 1];
4106 Jim_Reference
*refPtr
;
4108 refPtr
= objPtr
->internalRep
.refValue
.refPtr
;
4109 len
= JimFormatReference(buf
, refPtr
, objPtr
->internalRep
.refValue
.id
);
4110 objPtr
->bytes
= Jim_Alloc(len
+ 1);
4111 memcpy(objPtr
->bytes
, buf
, len
+ 1);
4112 objPtr
->length
= len
;
4115 /* returns true if 'c' is a valid reference tag character.
4116 * i.e. inside the range [_a-zA-Z0-9] */
4117 static int isrefchar(int c
)
4119 if (c
== '_' || (c
>= 'a' && c
<= 'z') || (c
>= 'A' && c
<= 'Z') ||
4120 (c
>= '0' && c
<= '9')) return 1;
4124 int SetReferenceFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
4128 const char *str
, *start
, *end
;
4130 Jim_Reference
*refPtr
;
4133 /* Get the string representation */
4134 str
= Jim_GetString(objPtr
, &len
);
4135 /* Check if it looks like a reference */
4136 if (len
< JIM_REFERENCE_SPACE
) goto badformat
;
4140 while (*start
== ' ') start
++;
4141 while (*end
== ' ' && end
> start
) end
--;
4142 if (end
-start
+ 1 != JIM_REFERENCE_SPACE
) goto badformat
;
4143 /* <reference.<1234567>.%020> */
4144 if (memcmp(start
, "<reference.<", 12) != 0) goto badformat
;
4145 if (start
[12 + JIM_REFERENCE_TAGLEN
] != '>' || end
[0] != '>') goto badformat
;
4146 /* The tag can't contain chars other than a-zA-Z0-9 + '_'. */
4147 for (i
= 0; i
< JIM_REFERENCE_TAGLEN
; i
++) {
4148 if (!isrefchar(start
[12 + i
])) goto badformat
;
4150 /* Extract info from the refernece. */
4151 memcpy(refId
, start
+ 14 + JIM_REFERENCE_TAGLEN
, 20);
4153 /* Try to convert the ID into a jim_wide */
4154 if (Jim_StringToWide(refId
, &wideValue
, 10) != JIM_OK
) goto badformat
;
4155 /* Check if the reference really exists! */
4156 he
= Jim_FindHashEntry(&interp
->references
, &wideValue
);
4158 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4159 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4160 "Invalid reference ID \"", str
, "\"", NULL
);
4164 /* Free the old internal repr and set the new one. */
4165 Jim_FreeIntRep(interp
, objPtr
);
4166 objPtr
->typePtr
= &referenceObjType
;
4167 objPtr
->internalRep
.refValue
.id
= wideValue
;
4168 objPtr
->internalRep
.refValue
.refPtr
= refPtr
;
4172 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4173 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4174 "expected reference but got \"", str
, "\"", NULL
);
4178 /* Returns a new reference pointing to objPtr, having cmdNamePtr
4179 * as finalizer command (or NULL if there is no finalizer).
4180 * The returned reference object has refcount = 0. */
4181 Jim_Obj
*Jim_NewReference(Jim_Interp
*interp
, Jim_Obj
*objPtr
, Jim_Obj
*tagPtr
,
4182 Jim_Obj
*cmdNamePtr
)
4184 struct Jim_Reference
*refPtr
;
4185 jim_wide wideValue
= interp
->referenceNextId
;
4190 /* Perform the Garbage Collection if needed. */
4191 Jim_CollectIfNeeded(interp
);
4193 refPtr
= Jim_Alloc(sizeof(*refPtr
));
4194 refPtr
->objPtr
= objPtr
;
4195 Jim_IncrRefCount(objPtr
);
4196 refPtr
->finalizerCmdNamePtr
= cmdNamePtr
;
4198 Jim_IncrRefCount(cmdNamePtr
);
4199 Jim_AddHashEntry(&interp
->references
, &wideValue
, refPtr
);
4200 refObjPtr
= Jim_NewObj(interp
);
4201 refObjPtr
->typePtr
= &referenceObjType
;
4202 refObjPtr
->bytes
= NULL
;
4203 refObjPtr
->internalRep
.refValue
.id
= interp
->referenceNextId
;
4204 refObjPtr
->internalRep
.refValue
.refPtr
= refPtr
;
4205 interp
->referenceNextId
++;
4206 /* Set the tag. Trimmered at JIM_REFERENCE_TAGLEN. Everything
4207 * that does not pass the 'isrefchar' test is replaced with '_' */
4208 tag
= Jim_GetString(tagPtr
, &tagLen
);
4209 if (tagLen
> JIM_REFERENCE_TAGLEN
)
4210 tagLen
= JIM_REFERENCE_TAGLEN
;
4211 for (i
= 0; i
< JIM_REFERENCE_TAGLEN
; i
++) {
4213 refPtr
->tag
[i
] = tag
[i
];
4215 refPtr
->tag
[i
] = '_';
4217 refPtr
->tag
[JIM_REFERENCE_TAGLEN
] = '\0';
4221 Jim_Reference
*Jim_GetReference(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
4223 if (objPtr
->typePtr
!= &referenceObjType
&&
4224 SetReferenceFromAny(interp
, objPtr
) == JIM_ERR
)
4226 return objPtr
->internalRep
.refValue
.refPtr
;
4229 int Jim_SetFinalizer(Jim_Interp
*interp
, Jim_Obj
*objPtr
, Jim_Obj
*cmdNamePtr
)
4231 Jim_Reference
*refPtr
;
4233 if ((refPtr
= Jim_GetReference(interp
, objPtr
)) == NULL
)
4235 Jim_IncrRefCount(cmdNamePtr
);
4236 if (refPtr
->finalizerCmdNamePtr
)
4237 Jim_DecrRefCount(interp
, refPtr
->finalizerCmdNamePtr
);
4238 refPtr
->finalizerCmdNamePtr
= cmdNamePtr
;
4242 int Jim_GetFinalizer(Jim_Interp
*interp
, Jim_Obj
*objPtr
, Jim_Obj
**cmdNamePtrPtr
)
4244 Jim_Reference
*refPtr
;
4246 if ((refPtr
= Jim_GetReference(interp
, objPtr
)) == NULL
)
4248 *cmdNamePtrPtr
= refPtr
->finalizerCmdNamePtr
;
4252 /* -----------------------------------------------------------------------------
4253 * References Garbage Collection
4254 * ---------------------------------------------------------------------------*/
4256 /* This the hash table type for the "MARK" phase of the GC */
4257 static Jim_HashTableType JimRefMarkHashTableType
= {
4258 JimReferencesHTHashFunction
, /* hash function */
4259 JimReferencesHTKeyDup
, /* key dup */
4261 JimReferencesHTKeyCompare
, /* key compare */
4262 JimReferencesHTKeyDestructor
, /* key destructor */
4263 NULL
/* val destructor */
4266 /* #define JIM_DEBUG_GC 1 */
4268 /* Performs the garbage collection. */
4269 int Jim_Collect(Jim_Interp
*interp
)
4271 Jim_HashTable marks
;
4272 Jim_HashTableIterator
*htiter
;
4277 /* Avoid recursive calls */
4278 if (interp
->lastCollectId
== -1) {
4279 /* Jim_Collect() already running. Return just now. */
4282 interp
->lastCollectId
= -1;
4284 /* Mark all the references found into the 'mark' hash table.
4285 * The references are searched in every live object that
4286 * is of a type that can contain references. */
4287 Jim_InitHashTable(&marks
, &JimRefMarkHashTableType
, NULL
);
4288 objPtr
= interp
->liveList
;
4290 if (objPtr
->typePtr
== NULL
||
4291 objPtr
->typePtr
->flags
& JIM_TYPE_REFERENCES
) {
4292 const char *str
, *p
;
4295 /* If the object is of type reference, to get the
4296 * Id is simple... */
4297 if (objPtr
->typePtr
== &referenceObjType
) {
4298 Jim_AddHashEntry(&marks
,
4299 &objPtr
->internalRep
.refValue
.id
, NULL
);
4301 Jim_fprintf(interp
,interp
->cookie_stdout
,
4302 "MARK (reference): %d refcount: %d" JIM_NL
,
4303 (int) objPtr
->internalRep
.refValue
.id
,
4306 objPtr
= objPtr
->nextObjPtr
;
4309 /* Get the string repr of the object we want
4310 * to scan for references. */
4311 p
= str
= Jim_GetString(objPtr
, &len
);
4312 /* Skip objects too little to contain references. */
4313 if (len
< JIM_REFERENCE_SPACE
) {
4314 objPtr
= objPtr
->nextObjPtr
;
4317 /* Extract references from the object string repr. */
4323 if ((p
= strstr(p
, "<reference.<")) == NULL
)
4325 /* Check if it's a valid reference. */
4326 if (len
-(p
-str
) < JIM_REFERENCE_SPACE
) break;
4327 if (p
[41] != '>' || p
[19] != '>' || p
[20] != '.') break;
4328 for (i
= 21; i
<= 40; i
++)
4329 if (!isdigit((int)p
[i
]))
4332 memcpy(buf
, p
+ 21, 20);
4334 Jim_StringToWide(buf
, &id
, 10);
4336 /* Ok, a reference for the given ID
4337 * was found. Mark it. */
4338 Jim_AddHashEntry(&marks
, &id
, NULL
);
4340 Jim_fprintf(interp
,interp
->cookie_stdout
,"MARK: %d" JIM_NL
, (int)id
);
4342 p
+= JIM_REFERENCE_SPACE
;
4345 objPtr
= objPtr
->nextObjPtr
;
4348 /* Run the references hash table to destroy every reference that
4349 * is not referenced outside (not present in the mark HT). */
4350 htiter
= Jim_GetHashTableIterator(&interp
->references
);
4351 while ((he
= Jim_NextHashEntry(htiter
)) != NULL
) {
4352 const jim_wide
*refId
;
4353 Jim_Reference
*refPtr
;
4356 /* Check if in the mark phase we encountered
4357 * this reference. */
4358 if (Jim_FindHashEntry(&marks
, refId
) == NULL
) {
4360 Jim_fprintf(interp
,interp
->cookie_stdout
,"COLLECTING %d" JIM_NL
, (int)*refId
);
4363 /* Drop the reference, but call the
4364 * finalizer first if registered. */
4366 if (refPtr
->finalizerCmdNamePtr
) {
4367 char *refstr
= Jim_Alloc(JIM_REFERENCE_SPACE
+ 1);
4368 Jim_Obj
*objv
[3], *oldResult
;
4370 JimFormatReference(refstr
, refPtr
, *refId
);
4372 objv
[0] = refPtr
->finalizerCmdNamePtr
;
4373 objv
[1] = Jim_NewStringObjNoAlloc(interp
,
4375 objv
[2] = refPtr
->objPtr
;
4376 Jim_IncrRefCount(objv
[0]);
4377 Jim_IncrRefCount(objv
[1]);
4378 Jim_IncrRefCount(objv
[2]);
4380 /* Drop the reference itself */
4381 Jim_DeleteHashEntry(&interp
->references
, refId
);
4383 /* Call the finalizer. Errors ignored. */
4384 oldResult
= interp
->result
;
4385 Jim_IncrRefCount(oldResult
);
4386 Jim_EvalObjVector(interp
, 3, objv
);
4387 Jim_SetResult(interp
, oldResult
);
4388 Jim_DecrRefCount(interp
, oldResult
);
4390 Jim_DecrRefCount(interp
, objv
[0]);
4391 Jim_DecrRefCount(interp
, objv
[1]);
4392 Jim_DecrRefCount(interp
, objv
[2]);
4394 Jim_DeleteHashEntry(&interp
->references
, refId
);
4398 Jim_FreeHashTableIterator(htiter
);
4399 Jim_FreeHashTable(&marks
);
4400 interp
->lastCollectId
= interp
->referenceNextId
;
4401 interp
->lastCollectTime
= time(NULL
);
4405 #define JIM_COLLECT_ID_PERIOD 5000
4406 #define JIM_COLLECT_TIME_PERIOD 300
4408 void Jim_CollectIfNeeded(Jim_Interp
*interp
)
4413 elapsedId
= interp
->referenceNextId
- interp
->lastCollectId
;
4414 elapsedTime
= time(NULL
) - interp
->lastCollectTime
;
4417 if (elapsedId
> JIM_COLLECT_ID_PERIOD
||
4418 elapsedTime
> JIM_COLLECT_TIME_PERIOD
) {
4419 Jim_Collect(interp
);
4423 /* -----------------------------------------------------------------------------
4424 * Interpreter related functions
4425 * ---------------------------------------------------------------------------*/
4427 Jim_Interp
*Jim_CreateInterp(void)
4429 Jim_Interp
*i
= Jim_Alloc(sizeof(*i
));
4433 i
->errorFileName
= Jim_StrDup("");
4435 i
->maxNestingDepth
= JIM_MAX_NESTING_DEPTH
;
4436 i
->returnCode
= JIM_OK
;
4439 i
->callFrameEpoch
= 0;
4440 i
->liveList
= i
->freeList
= NULL
;
4441 i
->scriptFileName
= Jim_StrDup("");
4442 i
->referenceNextId
= 0;
4443 i
->lastCollectId
= 0;
4444 i
->lastCollectTime
= time(NULL
);
4445 i
->freeFramesList
= NULL
;
4446 i
->prngState
= NULL
;
4447 i
->evalRetcodeLevel
= -1;
4448 i
->cookie_stdin
= stdin
;
4449 i
->cookie_stdout
= stdout
;
4450 i
->cookie_stderr
= stderr
;
4451 i
->cb_fwrite
= ((size_t (*)(const void *, size_t, size_t, void *))(fwrite
));
4452 i
->cb_fread
= ((size_t (*)(void *, size_t, size_t, void *))(fread
));
4453 i
->cb_vfprintf
= ((int (*)(void *, const char *fmt
, va_list))(vfprintf
));
4454 i
->cb_fflush
= ((int (*)(void *))(fflush
));
4455 i
->cb_fgets
= ((char * (*)(char *, int, void *))(fgets
));
4457 /* Note that we can create objects only after the
4458 * interpreter liveList and freeList pointers are
4459 * initialized to NULL. */
4460 Jim_InitHashTable(&i
->commands
, &JimCommandsHashTableType
, i
);
4461 Jim_InitHashTable(&i
->references
, &JimReferencesHashTableType
, i
);
4462 Jim_InitHashTable(&i
->sharedStrings
, &JimSharedStringsHashTableType
,
4464 Jim_InitHashTable(&i
->stub
, &JimStringCopyHashTableType
, NULL
);
4465 Jim_InitHashTable(&i
->assocData
, &JimAssocDataHashTableType
, i
);
4466 Jim_InitHashTable(&i
->packages
, &JimStringKeyValCopyHashTableType
, NULL
);
4467 i
->framePtr
= i
->topFramePtr
= JimCreateCallFrame(i
);
4468 i
->emptyObj
= Jim_NewEmptyStringObj(i
);
4469 i
->result
= i
->emptyObj
;
4470 i
->stackTrace
= Jim_NewListObj(i
, NULL
, 0);
4471 i
->unknown
= Jim_NewStringObj(i
, "unknown", -1);
4472 i
->unknown_called
= 0;
4473 Jim_IncrRefCount(i
->emptyObj
);
4474 Jim_IncrRefCount(i
->result
);
4475 Jim_IncrRefCount(i
->stackTrace
);
4476 Jim_IncrRefCount(i
->unknown
);
4478 /* Initialize key variables every interpreter should contain */
4479 pathPtr
= Jim_NewStringObj(i
, "./", -1);
4480 Jim_SetVariableStr(i
, "jim_libpath", pathPtr
);
4481 Jim_SetVariableStrWithStr(i
, "jim_interactive", "0");
4483 /* Export the core API to extensions */
4484 JimRegisterCoreApi(i
);
4488 /* This is the only function Jim exports directly without
4489 * to use the STUB system. It is only used by embedders
4490 * in order to get an interpreter with the Jim API pointers
4492 Jim_Interp
*ExportedJimCreateInterp(void)
4494 return Jim_CreateInterp();
4497 void Jim_FreeInterp(Jim_Interp
*i
)
4499 Jim_CallFrame
*cf
= i
->framePtr
, *prevcf
, *nextcf
;
4500 Jim_Obj
*objPtr
, *nextObjPtr
;
4502 Jim_DecrRefCount(i
, i
->emptyObj
);
4503 Jim_DecrRefCount(i
, i
->result
);
4504 Jim_DecrRefCount(i
, i
->stackTrace
);
4505 Jim_DecrRefCount(i
, i
->unknown
);
4506 Jim_Free((void*)i
->errorFileName
);
4507 Jim_Free((void*)i
->scriptFileName
);
4508 Jim_FreeHashTable(&i
->commands
);
4509 Jim_FreeHashTable(&i
->references
);
4510 Jim_FreeHashTable(&i
->stub
);
4511 Jim_FreeHashTable(&i
->assocData
);
4512 Jim_FreeHashTable(&i
->packages
);
4513 Jim_Free(i
->prngState
);
4514 /* Free the call frames list */
4516 prevcf
= cf
->parentCallFrame
;
4517 JimFreeCallFrame(i
, cf
, JIM_FCF_NONE
);
4520 /* Check that the live object list is empty, otherwise
4521 * there is a memory leak. */
4522 if (i
->liveList
!= NULL
) {
4523 Jim_Obj
*objPtr
= i
->liveList
;
4525 Jim_fprintf(i
, i
->cookie_stdout
,JIM_NL
"-------------------------------------" JIM_NL
);
4526 Jim_fprintf(i
, i
->cookie_stdout
,"Objects still in the free list:" JIM_NL
);
4528 const char *type
= objPtr
->typePtr
?
4529 objPtr
->typePtr
->name
: "";
4530 Jim_fprintf(i
, i
->cookie_stdout
,"%p \"%-10s\": '%.20s' (refCount: %d)" JIM_NL
,
4532 objPtr
->bytes
? objPtr
->bytes
4533 : "(null)", objPtr
->refCount
);
4534 if (objPtr
->typePtr
== &sourceObjType
) {
4535 Jim_fprintf(i
, i
->cookie_stdout
, "FILE %s LINE %d" JIM_NL
,
4536 objPtr
->internalRep
.sourceValue
.fileName
,
4537 objPtr
->internalRep
.sourceValue
.lineNumber
);
4539 objPtr
= objPtr
->nextObjPtr
;
4541 Jim_fprintf(i
, i
->cookie_stdout
, "-------------------------------------" JIM_NL JIM_NL
);
4542 Jim_Panic(i
,"Live list non empty freeing the interpreter! Leak?");
4544 /* Free all the freed objects. */
4545 objPtr
= i
->freeList
;
4547 nextObjPtr
= objPtr
->nextObjPtr
;
4549 objPtr
= nextObjPtr
;
4551 /* Free cached CallFrame structures */
4552 cf
= i
->freeFramesList
;
4554 nextcf
= cf
->nextFramePtr
;
4555 if (cf
->vars
.table
!= NULL
)
4556 Jim_Free(cf
->vars
.table
);
4560 /* Free the sharedString hash table. Make sure to free it
4561 * after every other Jim_Object was freed. */
4562 Jim_FreeHashTable(&i
->sharedStrings
);
4563 /* Free the interpreter structure. */
4567 /* Store the call frame relative to the level represented by
4568 * levelObjPtr into *framePtrPtr. If levelObjPtr == NULL, the
4569 * level is assumed to be '1'.
4571 * If a newLevelptr int pointer is specified, the function stores
4572 * the absolute level integer value of the new target callframe into
4573 * *newLevelPtr. (this is used to adjust interp->numLevels
4574 * in the implementation of [uplevel], so that [info level] will
4575 * return a correct information).
4577 * This function accepts the 'level' argument in the form
4578 * of the commands [uplevel] and [upvar].
4580 * For a function accepting a relative integer as level suitable
4581 * for implementation of [info level ?level?] check the
4582 * GetCallFrameByInteger() function. */
4583 int Jim_GetCallFrameByLevel(Jim_Interp
*interp
, Jim_Obj
*levelObjPtr
,
4584 Jim_CallFrame
**framePtrPtr
, int *newLevelPtr
)
4588 Jim_CallFrame
*framePtr
;
4590 if (newLevelPtr
) *newLevelPtr
= interp
->numLevels
;
4592 str
= Jim_GetString(levelObjPtr
, NULL
);
4593 if (str
[0] == '#') {
4595 /* speedup for the toplevel (level #0) */
4596 if (str
[1] == '0' && str
[2] == '\0') {
4597 if (newLevelPtr
) *newLevelPtr
= 0;
4598 *framePtrPtr
= interp
->topFramePtr
;
4602 level
= strtol(str
+ 1, &endptr
, 0);
4603 if (str
[1] == '\0' || endptr
[0] != '\0' || level
< 0)
4605 /* An 'absolute' level is converted into the
4606 * 'number of levels to go back' format. */
4607 level
= interp
->numLevels
- level
;
4608 if (level
< 0) goto badlevel
;
4610 if (Jim_GetLong(interp
, levelObjPtr
, &level
) != JIM_OK
|| level
< 0)
4614 str
= "1"; /* Needed to format the error message. */
4618 framePtr
= interp
->framePtr
;
4619 if (newLevelPtr
) *newLevelPtr
= (*newLevelPtr
)-level
;
4621 framePtr
= framePtr
->parentCallFrame
;
4622 if (framePtr
== NULL
) goto badlevel
;
4624 *framePtrPtr
= framePtr
;
4627 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4628 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4629 "bad level \"", str
, "\"", NULL
);
4633 /* Similar to Jim_GetCallFrameByLevel() but the level is specified
4634 * as a relative integer like in the [info level ?level?] command. */
4635 static int JimGetCallFrameByInteger(Jim_Interp
*interp
, Jim_Obj
*levelObjPtr
,
4636 Jim_CallFrame
**framePtrPtr
)
4639 jim_wide relLevel
; /* level relative to the current one. */
4640 Jim_CallFrame
*framePtr
;
4642 if (Jim_GetWide(interp
, levelObjPtr
, &level
) != JIM_OK
)
4645 /* An 'absolute' level is converted into the
4646 * 'number of levels to go back' format. */
4647 relLevel
= interp
->numLevels
- level
;
4652 framePtr
= interp
->framePtr
;
4653 while (relLevel
--) {
4654 framePtr
= framePtr
->parentCallFrame
;
4655 if (framePtr
== NULL
) goto badlevel
;
4657 *framePtrPtr
= framePtr
;
4660 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4661 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4662 "bad level \"", Jim_GetString(levelObjPtr
, NULL
), "\"", NULL
);
4666 static void JimSetErrorFileName(Jim_Interp
*interp
, char *filename
)
4668 Jim_Free((void*)interp
->errorFileName
);
4669 interp
->errorFileName
= Jim_StrDup(filename
);
4672 static void JimSetErrorLineNumber(Jim_Interp
*interp
, int linenr
)
4674 interp
->errorLine
= linenr
;
4677 static void JimResetStackTrace(Jim_Interp
*interp
)
4679 Jim_DecrRefCount(interp
, interp
->stackTrace
);
4680 interp
->stackTrace
= Jim_NewListObj(interp
, NULL
, 0);
4681 Jim_IncrRefCount(interp
->stackTrace
);
4684 static void JimAppendStackTrace(Jim_Interp
*interp
, const char *procname
,
4685 const char *filename
, int linenr
)
4687 /* No need to add this dummy entry to the stack trace */
4688 if (strcmp(procname
, "unknown") == 0) {
4692 if (Jim_IsShared(interp
->stackTrace
)) {
4693 interp
->stackTrace
=
4694 Jim_DuplicateObj(interp
, interp
->stackTrace
);
4695 Jim_IncrRefCount(interp
->stackTrace
);
4697 Jim_ListAppendElement(interp
, interp
->stackTrace
,
4698 Jim_NewStringObj(interp
, procname
, -1));
4699 Jim_ListAppendElement(interp
, interp
->stackTrace
,
4700 Jim_NewStringObj(interp
, filename
, -1));
4701 Jim_ListAppendElement(interp
, interp
->stackTrace
,
4702 Jim_NewIntObj(interp
, linenr
));
4705 int Jim_SetAssocData(Jim_Interp
*interp
, const char *key
, Jim_InterpDeleteProc
*delProc
, void *data
)
4707 AssocDataValue
*assocEntryPtr
= (AssocDataValue
*)Jim_Alloc(sizeof(AssocDataValue
));
4708 assocEntryPtr
->delProc
= delProc
;
4709 assocEntryPtr
->data
= data
;
4710 return Jim_AddHashEntry(&interp
->assocData
, key
, assocEntryPtr
);
4713 void *Jim_GetAssocData(Jim_Interp
*interp
, const char *key
)
4715 Jim_HashEntry
*entryPtr
= Jim_FindHashEntry(&interp
->assocData
, key
);
4716 if (entryPtr
!= NULL
) {
4717 AssocDataValue
*assocEntryPtr
= (AssocDataValue
*)entryPtr
->val
;
4718 return assocEntryPtr
->data
;
4723 int Jim_DeleteAssocData(Jim_Interp
*interp
, const char *key
)
4725 return Jim_DeleteHashEntry(&interp
->assocData
, key
);
4728 int Jim_GetExitCode(Jim_Interp
*interp
) {
4729 return interp
->exitCode
;
4732 void *Jim_SetStdin(Jim_Interp
*interp
, void *fp
)
4734 if (fp
!= NULL
) interp
->cookie_stdin
= fp
;
4735 return interp
->cookie_stdin
;
4738 void *Jim_SetStdout(Jim_Interp
*interp
, void *fp
)
4740 if (fp
!= NULL
) interp
->cookie_stdout
= fp
;
4741 return interp
->cookie_stdout
;
4744 void *Jim_SetStderr(Jim_Interp
*interp
, void *fp
)
4746 if (fp
!= NULL
) interp
->cookie_stderr
= fp
;
4747 return interp
->cookie_stderr
;
4750 /* -----------------------------------------------------------------------------
4752 * Every interpreter has an hash table where to put shared dynamically
4753 * allocate strings that are likely to be used a lot of times.
4754 * For example, in the 'source' object type, there is a pointer to
4755 * the filename associated with that object. Every script has a lot
4756 * of this objects with the identical file name, so it is wise to share
4759 * The API is trivial: Jim_GetSharedString(interp, "foobar")
4760 * returns the pointer to the shared string. Every time a reference
4761 * to the string is no longer used, the user should call
4762 * Jim_ReleaseSharedString(interp, stringPointer). Once no one is using
4763 * a given string, it is removed from the hash table.
4764 * ---------------------------------------------------------------------------*/
4765 const char *Jim_GetSharedString(Jim_Interp
*interp
, const char *str
)
4767 Jim_HashEntry
*he
= Jim_FindHashEntry(&interp
->sharedStrings
, str
);
4770 char *strCopy
= Jim_StrDup(str
);
4772 Jim_AddHashEntry(&interp
->sharedStrings
, strCopy
, (void*)1);
4775 intptr_t refCount
= (intptr_t) he
->val
;
4778 he
->val
= (void*) refCount
;
4783 void Jim_ReleaseSharedString(Jim_Interp
*interp
, const char *str
)
4786 Jim_HashEntry
*he
= Jim_FindHashEntry(&interp
->sharedStrings
, str
);
4789 Jim_Panic(interp
,"Jim_ReleaseSharedString called with "
4790 "unknown shared string '%s'", str
);
4791 refCount
= (intptr_t) he
->val
;
4793 if (refCount
== 0) {
4794 Jim_DeleteHashEntry(&interp
->sharedStrings
, str
);
4796 he
->val
= (void*) refCount
;
4800 /* -----------------------------------------------------------------------------
4802 * ---------------------------------------------------------------------------*/
4803 #define JIM_INTEGER_SPACE 24
4805 static void UpdateStringOfInt(struct Jim_Obj
*objPtr
);
4806 static int SetIntFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
, int flags
);
4808 static Jim_ObjType intObjType
= {
4816 void UpdateStringOfInt(struct Jim_Obj
*objPtr
)
4819 char buf
[JIM_INTEGER_SPACE
+ 1];
4821 len
= Jim_WideToString(buf
, objPtr
->internalRep
.wideValue
);
4822 objPtr
->bytes
= Jim_Alloc(len
+ 1);
4823 memcpy(objPtr
->bytes
, buf
, len
+ 1);
4824 objPtr
->length
= len
;
4827 int SetIntFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
, int flags
)
4832 /* Get the string representation */
4833 str
= Jim_GetString(objPtr
, NULL
);
4834 /* Try to convert into a jim_wide */
4835 if (Jim_StringToWide(str
, &wideValue
, 0) != JIM_OK
) {
4836 if (flags
& JIM_ERRMSG
) {
4837 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4838 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4839 "expected integer but got \"", str
, "\"", NULL
);
4843 if ((wideValue
== JIM_WIDE_MIN
|| wideValue
== JIM_WIDE_MAX
) &&
4845 Jim_SetResultString(interp
,
4846 "Integer value too big to be represented", -1);
4849 /* Free the old internal repr and set the new one. */
4850 Jim_FreeIntRep(interp
, objPtr
);
4851 objPtr
->typePtr
= &intObjType
;
4852 objPtr
->internalRep
.wideValue
= wideValue
;
4856 int Jim_GetWide(Jim_Interp
*interp
, Jim_Obj
*objPtr
, jim_wide
*widePtr
)
4858 if (objPtr
->typePtr
!= &intObjType
&&
4859 SetIntFromAny(interp
, objPtr
, JIM_ERRMSG
) == JIM_ERR
)
4861 *widePtr
= objPtr
->internalRep
.wideValue
;
4865 /* Get a wide but does not set an error if the format is bad. */
4866 static int JimGetWideNoErr(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
4869 if (objPtr
->typePtr
!= &intObjType
&&
4870 SetIntFromAny(interp
, objPtr
, JIM_NONE
) == JIM_ERR
)
4872 *widePtr
= objPtr
->internalRep
.wideValue
;
4876 int Jim_GetLong(Jim_Interp
*interp
, Jim_Obj
*objPtr
, long *longPtr
)
4881 retval
= Jim_GetWide(interp
, objPtr
, &wideValue
);
4882 if (retval
== JIM_OK
) {
4883 *longPtr
= (long) wideValue
;
4889 void Jim_SetWide(Jim_Interp
*interp
, Jim_Obj
*objPtr
, jim_wide wideValue
)
4891 if (Jim_IsShared(objPtr
))
4892 Jim_Panic(interp
,"Jim_SetWide called with shared object");
4893 if (objPtr
->typePtr
!= &intObjType
) {
4894 Jim_FreeIntRep(interp
, objPtr
);
4895 objPtr
->typePtr
= &intObjType
;
4897 Jim_InvalidateStringRep(objPtr
);
4898 objPtr
->internalRep
.wideValue
= wideValue
;
4901 Jim_Obj
*Jim_NewIntObj(Jim_Interp
*interp
, jim_wide wideValue
)
4905 objPtr
= Jim_NewObj(interp
);
4906 objPtr
->typePtr
= &intObjType
;
4907 objPtr
->bytes
= NULL
;
4908 objPtr
->internalRep
.wideValue
= wideValue
;
4912 /* -----------------------------------------------------------------------------
4914 * ---------------------------------------------------------------------------*/
4915 #define JIM_DOUBLE_SPACE 30
4917 static void UpdateStringOfDouble(struct Jim_Obj
*objPtr
);
4918 static int SetDoubleFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
4920 static Jim_ObjType doubleObjType
= {
4924 UpdateStringOfDouble
,
4928 void UpdateStringOfDouble(struct Jim_Obj
*objPtr
)
4931 char buf
[JIM_DOUBLE_SPACE
+ 1];
4933 len
= Jim_DoubleToString(buf
, objPtr
->internalRep
.doubleValue
);
4934 objPtr
->bytes
= Jim_Alloc(len
+ 1);
4935 memcpy(objPtr
->bytes
, buf
, len
+ 1);
4936 objPtr
->length
= len
;
4939 int SetDoubleFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
4944 /* Get the string representation */
4945 str
= Jim_GetString(objPtr
, NULL
);
4946 /* Try to convert into a double */
4947 if (Jim_StringToDouble(str
, &doubleValue
) != JIM_OK
) {
4948 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4949 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4950 "expected number but got '", str
, "'", NULL
);
4953 /* Free the old internal repr and set the new one. */
4954 Jim_FreeIntRep(interp
, objPtr
);
4955 objPtr
->typePtr
= &doubleObjType
;
4956 objPtr
->internalRep
.doubleValue
= doubleValue
;
4960 int Jim_GetDouble(Jim_Interp
*interp
, Jim_Obj
*objPtr
, double *doublePtr
)
4962 if (objPtr
->typePtr
!= &doubleObjType
&&
4963 SetDoubleFromAny(interp
, objPtr
) == JIM_ERR
)
4965 *doublePtr
= objPtr
->internalRep
.doubleValue
;
4969 void Jim_SetDouble(Jim_Interp
*interp
, Jim_Obj
*objPtr
, double doubleValue
)
4971 if (Jim_IsShared(objPtr
))
4972 Jim_Panic(interp
,"Jim_SetDouble called with shared object");
4973 if (objPtr
->typePtr
!= &doubleObjType
) {
4974 Jim_FreeIntRep(interp
, objPtr
);
4975 objPtr
->typePtr
= &doubleObjType
;
4977 Jim_InvalidateStringRep(objPtr
);
4978 objPtr
->internalRep
.doubleValue
= doubleValue
;
4981 Jim_Obj
*Jim_NewDoubleObj(Jim_Interp
*interp
, double doubleValue
)
4985 objPtr
= Jim_NewObj(interp
);
4986 objPtr
->typePtr
= &doubleObjType
;
4987 objPtr
->bytes
= NULL
;
4988 objPtr
->internalRep
.doubleValue
= doubleValue
;
4992 /* -----------------------------------------------------------------------------
4994 * ---------------------------------------------------------------------------*/
4995 static void ListAppendElement(Jim_Obj
*listPtr
, Jim_Obj
*objPtr
);
4996 static void FreeListInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
4997 static void DupListInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
);
4998 static void UpdateStringOfList(struct Jim_Obj
*objPtr
);
4999 static int SetListFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
);
5001 /* Note that while the elements of the list may contain references,
5002 * the list object itself can't. This basically means that the
5003 * list object string representation as a whole can't contain references
5004 * that are not presents in the single elements. */
5005 static Jim_ObjType listObjType
= {
5007 FreeListInternalRep
,
5013 void FreeListInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
5017 for (i
= 0; i
< objPtr
->internalRep
.listValue
.len
; i
++) {
5018 Jim_DecrRefCount(interp
, objPtr
->internalRep
.listValue
.ele
[i
]);
5020 Jim_Free(objPtr
->internalRep
.listValue
.ele
);
5023 void DupListInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
)
5026 JIM_NOTUSED(interp
);
5028 dupPtr
->internalRep
.listValue
.len
= srcPtr
->internalRep
.listValue
.len
;
5029 dupPtr
->internalRep
.listValue
.maxLen
= srcPtr
->internalRep
.listValue
.maxLen
;
5030 dupPtr
->internalRep
.listValue
.ele
=
5031 Jim_Alloc(sizeof(Jim_Obj
*)*srcPtr
->internalRep
.listValue
.maxLen
);
5032 memcpy(dupPtr
->internalRep
.listValue
.ele
, srcPtr
->internalRep
.listValue
.ele
,
5033 sizeof(Jim_Obj
*)*srcPtr
->internalRep
.listValue
.len
);
5034 for (i
= 0; i
< dupPtr
->internalRep
.listValue
.len
; i
++) {
5035 Jim_IncrRefCount(dupPtr
->internalRep
.listValue
.ele
[i
]);
5037 dupPtr
->typePtr
= &listObjType
;
5040 /* The following function checks if a given string can be encoded
5041 * into a list element without any kind of quoting, surrounded by braces,
5042 * or using escapes to quote. */
5043 #define JIM_ELESTR_SIMPLE 0
5044 #define JIM_ELESTR_BRACE 1
5045 #define JIM_ELESTR_QUOTE 2
5046 static int ListElementQuotingType(const char *s
, int len
)
5048 int i
, level
, trySimple
= 1;
5050 /* Try with the SIMPLE case */
5051 if (len
== 0) return JIM_ELESTR_BRACE
;
5052 if (s
[0] == '"' || s
[0] == '{') {
5056 for (i
= 0; i
< len
; i
++) {
5076 return JIM_ELESTR_SIMPLE
;
5079 /* Test if it's possible to do with braces */
5080 if (s
[len
-1] == '\\' ||
5081 s
[len
-1] == ']') return JIM_ELESTR_QUOTE
;
5083 for (i
= 0; i
< len
; i
++) {
5085 case '{': level
++; break;
5087 if (level
< 0) return JIM_ELESTR_QUOTE
;
5090 if (s
[i
+ 1] == '\n')
5091 return JIM_ELESTR_QUOTE
;
5093 if (s
[i
+ 1] != '\0') i
++;
5098 if (!trySimple
) return JIM_ELESTR_BRACE
;
5099 for (i
= 0; i
< len
; i
++) {
5113 return JIM_ELESTR_BRACE
;
5117 return JIM_ELESTR_SIMPLE
;
5119 return JIM_ELESTR_QUOTE
;
5122 /* Returns the malloc-ed representation of a string
5123 * using backslash to quote special chars. */
5124 char *BackslashQuoteString(const char *s
, int len
, int *qlenPtr
)
5126 char *q
= Jim_Alloc(len
*2 + 1), *p
;
5143 case '\n': *p
++ = '\\'; *p
++ = 'n'; s
++; break;
5144 case '\r': *p
++ = '\\'; *p
++ = 'r'; s
++; break;
5145 case '\t': *p
++ = '\\'; *p
++ = 't'; s
++; break;
5146 case '\f': *p
++ = '\\'; *p
++ = 'f'; s
++; break;
5147 case '\v': *p
++ = '\\'; *p
++ = 'v'; s
++; break;
5158 void UpdateStringOfList(struct Jim_Obj
*objPtr
)
5160 int i
, bufLen
, realLength
;
5164 Jim_Obj
**ele
= objPtr
->internalRep
.listValue
.ele
;
5166 /* (Over) Estimate the space needed. */
5167 quotingType
= Jim_Alloc(sizeof(int)*objPtr
->internalRep
.listValue
.len
+ 1);
5169 for (i
= 0; i
< objPtr
->internalRep
.listValue
.len
; i
++) {
5172 strRep
= Jim_GetString(ele
[i
], &len
);
5173 quotingType
[i
] = ListElementQuotingType(strRep
, len
);
5174 switch (quotingType
[i
]) {
5175 case JIM_ELESTR_SIMPLE
: bufLen
+= len
; break;
5176 case JIM_ELESTR_BRACE
: bufLen
+= len
+ 2; break;
5177 case JIM_ELESTR_QUOTE
: bufLen
+= len
*2; break;
5179 bufLen
++; /* elements separator. */
5183 /* Generate the string rep. */
5184 p
= objPtr
->bytes
= Jim_Alloc(bufLen
+ 1);
5186 for (i
= 0; i
< objPtr
->internalRep
.listValue
.len
; i
++) {
5188 const char *strRep
= Jim_GetString(ele
[i
], &len
);
5191 switch (quotingType
[i
]) {
5192 case JIM_ELESTR_SIMPLE
:
5193 memcpy(p
, strRep
, len
);
5197 case JIM_ELESTR_BRACE
:
5199 memcpy(p
, strRep
, len
);
5202 realLength
+= len
+ 2;
5204 case JIM_ELESTR_QUOTE
:
5205 q
= BackslashQuoteString(strRep
, len
, &qlen
);
5212 /* Add a separating space */
5213 if (i
+ 1 != objPtr
->internalRep
.listValue
.len
) {
5218 *p
= '\0'; /* nul term. */
5219 objPtr
->length
= realLength
;
5220 Jim_Free(quotingType
);
5223 int SetListFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
)
5225 struct JimParserCtx parser
;
5229 /* Get the string representation */
5230 str
= Jim_GetString(objPtr
, &strLen
);
5232 /* Free the old internal repr just now and initialize the
5233 * new one just now. The string->list conversion can't fail. */
5234 Jim_FreeIntRep(interp
, objPtr
);
5235 objPtr
->typePtr
= &listObjType
;
5236 objPtr
->internalRep
.listValue
.len
= 0;
5237 objPtr
->internalRep
.listValue
.maxLen
= 0;
5238 objPtr
->internalRep
.listValue
.ele
= NULL
;
5240 /* Convert into a list */
5241 JimParserInit(&parser
, str
, strLen
, 1);
5242 while (!JimParserEof(&parser
)) {
5245 Jim_Obj
*elementPtr
;
5247 JimParseList(&parser
);
5248 if (JimParserTtype(&parser
) != JIM_TT_STR
&&
5249 JimParserTtype(&parser
) != JIM_TT_ESC
)
5251 token
= JimParserGetToken(&parser
, &tokenLen
, &type
, NULL
);
5252 elementPtr
= Jim_NewStringObjNoAlloc(interp
, token
, tokenLen
);
5253 ListAppendElement(objPtr
, elementPtr
);
5258 Jim_Obj
*Jim_NewListObj(Jim_Interp
*interp
, Jim_Obj
*const *elements
,
5264 objPtr
= Jim_NewObj(interp
);
5265 objPtr
->typePtr
= &listObjType
;
5266 objPtr
->bytes
= NULL
;
5267 objPtr
->internalRep
.listValue
.ele
= NULL
;
5268 objPtr
->internalRep
.listValue
.len
= 0;
5269 objPtr
->internalRep
.listValue
.maxLen
= 0;
5270 for (i
= 0; i
< len
; i
++) {
5271 ListAppendElement(objPtr
, elements
[i
]);
5276 /* Return a vector of Jim_Obj with the elements of a Jim list, and the
5277 * length of the vector. Note that the user of this function should make
5278 * sure that the list object can't shimmer while the vector returned
5279 * is in use, this vector is the one stored inside the internal representation
5280 * of the list object. This function is not exported, extensions should
5281 * always access to the List object elements using Jim_ListIndex(). */
5282 static void JimListGetElements(Jim_Interp
*interp
, Jim_Obj
*listObj
, int *argc
,
5285 Jim_ListLength(interp
, listObj
, argc
);
5286 assert(listObj
->typePtr
== &listObjType
);
5287 *listVec
= listObj
->internalRep
.listValue
.ele
;
5290 /* ListSortElements type values */
5291 enum {JIM_LSORT_ASCII
, JIM_LSORT_NOCASE
, JIM_LSORT_ASCII_DECR
,
5292 JIM_LSORT_NOCASE_DECR
};
5294 /* Sort the internal rep of a list. */
5295 static int ListSortString(Jim_Obj
**lhsObj
, Jim_Obj
**rhsObj
)
5297 return Jim_StringCompareObj(*lhsObj
, *rhsObj
, 0);
5300 static int ListSortStringDecr(Jim_Obj
**lhsObj
, Jim_Obj
**rhsObj
)
5302 return Jim_StringCompareObj(*lhsObj
, *rhsObj
, 0) * -1;
5305 static int ListSortStringNoCase(Jim_Obj
**lhsObj
, Jim_Obj
**rhsObj
)
5307 return Jim_StringCompareObj(*lhsObj
, *rhsObj
, 1);
5310 static int ListSortStringNoCaseDecr(Jim_Obj
**lhsObj
, Jim_Obj
**rhsObj
)
5312 return Jim_StringCompareObj(*lhsObj
, *rhsObj
, 1) * -1;
5315 /* Sort a list *in place*. MUST be called with non-shared objects. */
5316 static void ListSortElements(Jim_Interp
*interp
, Jim_Obj
*listObjPtr
, int type
)
5318 typedef int (qsort_comparator
)(const void *, const void *);
5319 int (*fn
)(Jim_Obj
**, Jim_Obj
**);
5323 if (Jim_IsShared(listObjPtr
))
5324 Jim_Panic(interp
,"Jim_ListSortElements called with shared object");
5325 if (listObjPtr
->typePtr
!= &listObjType
)
5326 SetListFromAny(interp
, listObjPtr
);
5328 vector
= listObjPtr
->internalRep
.listValue
.ele
;
5329 len
= listObjPtr
->internalRep
.listValue
.len
;
5331 case JIM_LSORT_ASCII
: fn
= ListSortString
; break;
5332 case JIM_LSORT_NOCASE
: fn
= ListSortStringNoCase
; break;
5333 case JIM_LSORT_ASCII_DECR
: fn
= ListSortStringDecr
; break;
5334 case JIM_LSORT_NOCASE_DECR
: fn
= ListSortStringNoCaseDecr
; break;
5336 fn
= NULL
; /* avoid warning */
5337 Jim_Panic(interp
,"ListSort called with invalid sort type");
5339 qsort(vector
, len
, sizeof(Jim_Obj
*), (qsort_comparator
*)fn
);
5340 Jim_InvalidateStringRep(listObjPtr
);
5343 /* This is the low-level function to append an element to a list.
5344 * The higher-level Jim_ListAppendElement() performs shared object
5345 * check and invalidate the string repr. This version is used
5346 * in the internals of the List Object and is not exported.
5348 * NOTE: this function can be called only against objects
5349 * with internal type of List. */
5350 void ListAppendElement(Jim_Obj
*listPtr
, Jim_Obj
*objPtr
)
5352 int requiredLen
= listPtr
->internalRep
.listValue
.len
+ 1;
5354 if (requiredLen
> listPtr
->internalRep
.listValue
.maxLen
) {
5355 int maxLen
= requiredLen
* 2;
5357 listPtr
->internalRep
.listValue
.ele
=
5358 Jim_Realloc(listPtr
->internalRep
.listValue
.ele
,
5359 sizeof(Jim_Obj
*)*maxLen
);
5360 listPtr
->internalRep
.listValue
.maxLen
= maxLen
;
5362 listPtr
->internalRep
.listValue
.ele
[listPtr
->internalRep
.listValue
.len
] =
5364 listPtr
->internalRep
.listValue
.len
++;
5365 Jim_IncrRefCount(objPtr
);
5368 /* This is the low-level function to insert elements into a list.
5369 * The higher-level Jim_ListInsertElements() performs shared object
5370 * check and invalidate the string repr. This version is used
5371 * in the internals of the List Object and is not exported.
5373 * NOTE: this function can be called only against objects
5374 * with internal type of List. */
5375 void ListInsertElements(Jim_Obj
*listPtr
, int index
, int elemc
,
5376 Jim_Obj
*const *elemVec
)
5378 int currentLen
= listPtr
->internalRep
.listValue
.len
;
5379 int requiredLen
= currentLen
+ elemc
;
5383 if (requiredLen
> listPtr
->internalRep
.listValue
.maxLen
) {
5384 int maxLen
= requiredLen
* 2;
5386 listPtr
->internalRep
.listValue
.ele
=
5387 Jim_Realloc(listPtr
->internalRep
.listValue
.ele
,
5388 sizeof(Jim_Obj
*)*maxLen
);
5389 listPtr
->internalRep
.listValue
.maxLen
= maxLen
;
5391 point
= listPtr
->internalRep
.listValue
.ele
+ index
;
5392 memmove(point
+ elemc
, point
, (currentLen
-index
) * sizeof(Jim_Obj
*));
5393 for (i
= 0; i
< elemc
; ++i
) {
5394 point
[i
] = elemVec
[i
];
5395 Jim_IncrRefCount(point
[i
]);
5397 listPtr
->internalRep
.listValue
.len
+= elemc
;
5400 /* Appends every element of appendListPtr into listPtr.
5401 * Both have to be of the list type. */
5402 void ListAppendList(Jim_Obj
*listPtr
, Jim_Obj
*appendListPtr
)
5404 int i
, oldLen
= listPtr
->internalRep
.listValue
.len
;
5405 int appendLen
= appendListPtr
->internalRep
.listValue
.len
;
5406 int requiredLen
= oldLen
+ appendLen
;
5408 if (requiredLen
> listPtr
->internalRep
.listValue
.maxLen
) {
5409 int maxLen
= requiredLen
* 2;
5411 listPtr
->internalRep
.listValue
.ele
=
5412 Jim_Realloc(listPtr
->internalRep
.listValue
.ele
,
5413 sizeof(Jim_Obj
*)*maxLen
);
5414 listPtr
->internalRep
.listValue
.maxLen
= maxLen
;
5416 for (i
= 0; i
< appendLen
; i
++) {
5417 Jim_Obj
*objPtr
= appendListPtr
->internalRep
.listValue
.ele
[i
];
5418 listPtr
->internalRep
.listValue
.ele
[oldLen
+ i
] = objPtr
;
5419 Jim_IncrRefCount(objPtr
);
5421 listPtr
->internalRep
.listValue
.len
+= appendLen
;
5424 void Jim_ListAppendElement(Jim_Interp
*interp
, Jim_Obj
*listPtr
, Jim_Obj
*objPtr
)
5426 if (Jim_IsShared(listPtr
))
5427 Jim_Panic(interp
,"Jim_ListAppendElement called with shared object");
5428 if (listPtr
->typePtr
!= &listObjType
)
5429 SetListFromAny(interp
, listPtr
);
5430 Jim_InvalidateStringRep(listPtr
);
5431 ListAppendElement(listPtr
, objPtr
);
5434 void Jim_ListAppendList(Jim_Interp
*interp
, Jim_Obj
*listPtr
, Jim_Obj
*appendListPtr
)
5436 if (Jim_IsShared(listPtr
))
5437 Jim_Panic(interp
,"Jim_ListAppendList called with shared object");
5438 if (listPtr
->typePtr
!= &listObjType
)
5439 SetListFromAny(interp
, listPtr
);
5440 Jim_InvalidateStringRep(listPtr
);
5441 ListAppendList(listPtr
, appendListPtr
);
5444 void Jim_ListLength(Jim_Interp
*interp
, Jim_Obj
*listPtr
, int *intPtr
)
5446 if (listPtr
->typePtr
!= &listObjType
)
5447 SetListFromAny(interp
, listPtr
);
5448 *intPtr
= listPtr
->internalRep
.listValue
.len
;
5451 void Jim_ListInsertElements(Jim_Interp
*interp
, Jim_Obj
*listPtr
, int index
,
5452 int objc
, Jim_Obj
*const *objVec
)
5454 if (Jim_IsShared(listPtr
))
5455 Jim_Panic(interp
,"Jim_ListInsertElement called with shared object");
5456 if (listPtr
->typePtr
!= &listObjType
)
5457 SetListFromAny(interp
, listPtr
);
5458 if (index
>= 0 && index
> listPtr
->internalRep
.listValue
.len
)
5459 index
= listPtr
->internalRep
.listValue
.len
;
5462 Jim_InvalidateStringRep(listPtr
);
5463 ListInsertElements(listPtr
, index
, objc
, objVec
);
5466 int Jim_ListIndex(Jim_Interp
*interp
, Jim_Obj
*listPtr
, int index
,
5467 Jim_Obj
**objPtrPtr
, int flags
)
5469 if (listPtr
->typePtr
!= &listObjType
)
5470 SetListFromAny(interp
, listPtr
);
5471 if ((index
>= 0 && index
>= listPtr
->internalRep
.listValue
.len
) ||
5472 (index
< 0 && (-index
-1) >= listPtr
->internalRep
.listValue
.len
)) {
5473 if (flags
& JIM_ERRMSG
) {
5474 Jim_SetResultString(interp
,
5475 "list index out of range", -1);
5480 index
= listPtr
->internalRep
.listValue
.len
+ index
;
5481 *objPtrPtr
= listPtr
->internalRep
.listValue
.ele
[index
];
5485 static int ListSetIndex(Jim_Interp
*interp
, Jim_Obj
*listPtr
, int index
,
5486 Jim_Obj
*newObjPtr
, int flags
)
5488 if (listPtr
->typePtr
!= &listObjType
)
5489 SetListFromAny(interp
, listPtr
);
5490 if ((index
>= 0 && index
>= listPtr
->internalRep
.listValue
.len
) ||
5491 (index
< 0 && (-index
-1) >= listPtr
->internalRep
.listValue
.len
)) {
5492 if (flags
& JIM_ERRMSG
) {
5493 Jim_SetResultString(interp
,
5494 "list index out of range", -1);
5499 index
= listPtr
->internalRep
.listValue
.len
+ index
;
5500 Jim_DecrRefCount(interp
, listPtr
->internalRep
.listValue
.ele
[index
]);
5501 listPtr
->internalRep
.listValue
.ele
[index
] = newObjPtr
;
5502 Jim_IncrRefCount(newObjPtr
);
5506 /* Modify the list stored into the variable named 'varNamePtr'
5507 * setting the element specified by the 'indexc' indexes objects in 'indexv',
5508 * with the new element 'newObjptr'. */
5509 int Jim_SetListIndex(Jim_Interp
*interp
, Jim_Obj
*varNamePtr
,
5510 Jim_Obj
*const *indexv
, int indexc
, Jim_Obj
*newObjPtr
)
5512 Jim_Obj
*varObjPtr
, *objPtr
, *listObjPtr
;
5513 int shared
, i
, index
;
5515 varObjPtr
= objPtr
= Jim_GetVariable(interp
, varNamePtr
, JIM_ERRMSG
);
5518 if ((shared
= Jim_IsShared(objPtr
)))
5519 varObjPtr
= objPtr
= Jim_DuplicateObj(interp
, objPtr
);
5520 for (i
= 0; i
< indexc
-1; i
++) {
5521 listObjPtr
= objPtr
;
5522 if (Jim_GetIndex(interp
, indexv
[i
], &index
) != JIM_OK
)
5524 if (Jim_ListIndex(interp
, listObjPtr
, index
, &objPtr
,
5525 JIM_ERRMSG
) != JIM_OK
) {
5528 if (Jim_IsShared(objPtr
)) {
5529 objPtr
= Jim_DuplicateObj(interp
, objPtr
);
5530 ListSetIndex(interp
, listObjPtr
, index
, objPtr
, JIM_NONE
);
5532 Jim_InvalidateStringRep(listObjPtr
);
5534 if (Jim_GetIndex(interp
, indexv
[indexc
-1], &index
) != JIM_OK
)
5536 if (ListSetIndex(interp
, objPtr
, index
, newObjPtr
, JIM_ERRMSG
) == JIM_ERR
)
5538 Jim_InvalidateStringRep(objPtr
);
5539 Jim_InvalidateStringRep(varObjPtr
);
5540 if (Jim_SetVariable(interp
, varNamePtr
, varObjPtr
) != JIM_OK
)
5542 Jim_SetResult(interp
, varObjPtr
);
5546 Jim_FreeNewObj(interp
, varObjPtr
);
5551 Jim_Obj
*Jim_ConcatObj(Jim_Interp
*interp
, int objc
, Jim_Obj
*const *objv
)
5555 /* If all the objects in objv are lists without string rep.
5556 * it's possible to return a list as result, that's the
5557 * concatenation of all the lists. */
5558 for (i
= 0; i
< objc
; i
++) {
5559 if (objv
[i
]->typePtr
!= &listObjType
|| objv
[i
]->bytes
)
5563 Jim_Obj
*objPtr
= Jim_NewListObj(interp
, NULL
, 0);
5564 for (i
= 0; i
< objc
; i
++)
5565 Jim_ListAppendList(interp
, objPtr
, objv
[i
]);
5568 /* Else... we have to glue strings together */
5569 int len
= 0, objLen
;
5572 /* Compute the length */
5573 for (i
= 0; i
< objc
; i
++) {
5574 Jim_GetString(objv
[i
], &objLen
);
5577 if (objc
) len
+= objc
-1;
5578 /* Create the string rep, and a stinrg object holding it. */
5579 p
= bytes
= Jim_Alloc(len
+ 1);
5580 for (i
= 0; i
< objc
; i
++) {
5581 const char *s
= Jim_GetString(objv
[i
], &objLen
);
5582 while (objLen
&& (*s
== ' ' || *s
== '\t' || *s
== '\n'))
5584 s
++; objLen
--; len
--;
5586 while (objLen
&& (s
[objLen
-1] == ' ' ||
5587 s
[objLen
-1] == '\n' || s
[objLen
-1] == '\t')) {
5590 memcpy(p
, s
, objLen
);
5592 if (objLen
&& i
+ 1 != objc
) {
5594 } else if (i
+ 1 != objc
) {
5595 /* Drop the space calcuated for this
5596 * element that is instead null. */
5601 return Jim_NewStringObjNoAlloc(interp
, bytes
, len
);
5605 /* Returns a list composed of the elements in the specified range.
5606 * first and start are directly accepted as Jim_Objects and
5607 * processed for the end?-index? case. */
5608 Jim_Obj
*Jim_ListRange(Jim_Interp
*interp
, Jim_Obj
*listObjPtr
, Jim_Obj
*firstObjPtr
, Jim_Obj
*lastObjPtr
)
5613 if (Jim_GetIndex(interp
, firstObjPtr
, &first
) != JIM_OK
||
5614 Jim_GetIndex(interp
, lastObjPtr
, &last
) != JIM_OK
)
5616 Jim_ListLength(interp
, listObjPtr
, &len
); /* will convert into list */
5617 first
= JimRelToAbsIndex(len
, first
);
5618 last
= JimRelToAbsIndex(len
, last
);
5619 JimRelToAbsRange(len
, first
, last
, &first
, &last
, &rangeLen
);
5620 return Jim_NewListObj(interp
,
5621 listObjPtr
->internalRep
.listValue
.ele
+ first
, rangeLen
);
5624 /* -----------------------------------------------------------------------------
5626 * ---------------------------------------------------------------------------*/
5627 static void FreeDictInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
5628 static void DupDictInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
);
5629 static void UpdateStringOfDict(struct Jim_Obj
*objPtr
);
5630 static int SetDictFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
);
5632 /* Dict HashTable Type.
5634 * Keys and Values are Jim objects. */
5636 unsigned int JimObjectHTHashFunction(const void *key
)
5639 Jim_Obj
*objPtr
= (Jim_Obj
*) key
;
5642 str
= Jim_GetString(objPtr
, &len
);
5643 h
= Jim_GenHashFunction((unsigned char*)str
, len
);
5647 int JimObjectHTKeyCompare(void *privdata
, const void *key1
, const void *key2
)
5649 JIM_NOTUSED(privdata
);
5651 return Jim_StringEqObj((Jim_Obj
*)key1
, (Jim_Obj
*)key2
, 0);
5654 static void JimObjectHTKeyValDestructor(void *interp
, void *val
)
5656 Jim_Obj
*objPtr
= val
;
5658 Jim_DecrRefCount(interp
, objPtr
);
5661 static Jim_HashTableType JimDictHashTableType
= {
5662 JimObjectHTHashFunction
, /* hash function */
5665 JimObjectHTKeyCompare
, /* key compare */
5666 (void(*)(void*, const void*)) /* ATTENTION: const cast */
5667 JimObjectHTKeyValDestructor
, /* key destructor */
5668 JimObjectHTKeyValDestructor
/* val destructor */
5671 /* Note that while the elements of the dict may contain references,
5672 * the list object itself can't. This basically means that the
5673 * dict object string representation as a whole can't contain references
5674 * that are not presents in the single elements. */
5675 static Jim_ObjType dictObjType
= {
5677 FreeDictInternalRep
,
5683 void FreeDictInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
5685 JIM_NOTUSED(interp
);
5687 Jim_FreeHashTable(objPtr
->internalRep
.ptr
);
5688 Jim_Free(objPtr
->internalRep
.ptr
);
5691 void DupDictInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
)
5693 Jim_HashTable
*ht
, *dupHt
;
5694 Jim_HashTableIterator
*htiter
;
5697 /* Create a new hash table */
5698 ht
= srcPtr
->internalRep
.ptr
;
5699 dupHt
= Jim_Alloc(sizeof(*dupHt
));
5700 Jim_InitHashTable(dupHt
, &JimDictHashTableType
, interp
);
5702 Jim_ExpandHashTable(dupHt
, ht
->size
);
5703 /* Copy every element from the source to the dup hash table */
5704 htiter
= Jim_GetHashTableIterator(ht
);
5705 while ((he
= Jim_NextHashEntry(htiter
)) != NULL
) {
5706 const Jim_Obj
*keyObjPtr
= he
->key
;
5707 Jim_Obj
*valObjPtr
= he
->val
;
5709 Jim_IncrRefCount((Jim_Obj
*)keyObjPtr
); /* ATTENTION: const cast */
5710 Jim_IncrRefCount(valObjPtr
);
5711 Jim_AddHashEntry(dupHt
, keyObjPtr
, valObjPtr
);
5713 Jim_FreeHashTableIterator(htiter
);
5715 dupPtr
->internalRep
.ptr
= dupHt
;
5716 dupPtr
->typePtr
= &dictObjType
;
5719 void UpdateStringOfDict(struct Jim_Obj
*objPtr
)
5721 int i
, bufLen
, realLength
;
5724 int *quotingType
, objc
;
5726 Jim_HashTableIterator
*htiter
;
5730 /* Trun the hash table into a flat vector of Jim_Objects. */
5731 ht
= objPtr
->internalRep
.ptr
;
5733 objv
= Jim_Alloc(objc
*sizeof(Jim_Obj
*));
5734 htiter
= Jim_GetHashTableIterator(ht
);
5736 while ((he
= Jim_NextHashEntry(htiter
)) != NULL
) {
5737 objv
[i
++] = (Jim_Obj
*)he
->key
; /* ATTENTION: const cast */
5738 objv
[i
++] = he
->val
;
5740 Jim_FreeHashTableIterator(htiter
);
5741 /* (Over) Estimate the space needed. */
5742 quotingType
= Jim_Alloc(sizeof(int)*objc
);
5744 for (i
= 0; i
< objc
; i
++) {
5747 strRep
= Jim_GetString(objv
[i
], &len
);
5748 quotingType
[i
] = ListElementQuotingType(strRep
, len
);
5749 switch (quotingType
[i
]) {
5750 case JIM_ELESTR_SIMPLE
: bufLen
+= len
; break;
5751 case JIM_ELESTR_BRACE
: bufLen
+= len
+ 2; break;
5752 case JIM_ELESTR_QUOTE
: bufLen
+= len
*2; break;
5754 bufLen
++; /* elements separator. */
5758 /* Generate the string rep. */
5759 p
= objPtr
->bytes
= Jim_Alloc(bufLen
+ 1);
5761 for (i
= 0; i
< objc
; i
++) {
5763 const char *strRep
= Jim_GetString(objv
[i
], &len
);
5766 switch (quotingType
[i
]) {
5767 case JIM_ELESTR_SIMPLE
:
5768 memcpy(p
, strRep
, len
);
5772 case JIM_ELESTR_BRACE
:
5774 memcpy(p
, strRep
, len
);
5777 realLength
+= len
+ 2;
5779 case JIM_ELESTR_QUOTE
:
5780 q
= BackslashQuoteString(strRep
, len
, &qlen
);
5787 /* Add a separating space */
5788 if (i
+ 1 != objc
) {
5793 *p
= '\0'; /* nul term. */
5794 objPtr
->length
= realLength
;
5795 Jim_Free(quotingType
);
5799 int SetDictFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
)
5801 struct JimParserCtx parser
;
5807 /* Get the string representation */
5808 str
= Jim_GetString(objPtr
, &strLen
);
5810 /* Free the old internal repr just now and initialize the
5811 * new one just now. The string->list conversion can't fail. */
5812 Jim_FreeIntRep(interp
, objPtr
);
5813 ht
= Jim_Alloc(sizeof(*ht
));
5814 Jim_InitHashTable(ht
, &JimDictHashTableType
, interp
);
5815 objPtr
->typePtr
= &dictObjType
;
5816 objPtr
->internalRep
.ptr
= ht
;
5818 /* Convert into a dict */
5819 JimParserInit(&parser
, str
, strLen
, 1);
5821 while (!JimParserEof(&parser
)) {
5825 JimParseList(&parser
);
5826 if (JimParserTtype(&parser
) != JIM_TT_STR
&&
5827 JimParserTtype(&parser
) != JIM_TT_ESC
)
5829 token
= JimParserGetToken(&parser
, &tokenLen
, &type
, NULL
);
5830 objv
[i
++] = Jim_NewStringObjNoAlloc(interp
, token
, tokenLen
);
5833 Jim_IncrRefCount(objv
[0]);
5834 Jim_IncrRefCount(objv
[1]);
5835 if (Jim_AddHashEntry(ht
, objv
[0], objv
[1]) != JIM_OK
) {
5837 he
= Jim_FindHashEntry(ht
, objv
[0]);
5838 Jim_DecrRefCount(interp
, objv
[0]);
5839 /* ATTENTION: const cast */
5840 Jim_DecrRefCount(interp
, (Jim_Obj
*)he
->val
);
5846 Jim_FreeNewObj(interp
, objv
[0]);
5847 objPtr
->typePtr
= NULL
;
5848 Jim_FreeHashTable(ht
);
5849 Jim_SetResultString(interp
, "invalid dictionary value: must be a list with an even number of elements", -1);
5855 /* Dict object API */
5857 /* Add an element to a dict. objPtr must be of the "dict" type.
5858 * The higer-level exported function is Jim_DictAddElement().
5859 * If an element with the specified key already exists, the value
5860 * associated is replaced with the new one.
5862 * if valueObjPtr == NULL, the key is instead removed if it exists. */
5863 static void DictAddElement(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
5864 Jim_Obj
*keyObjPtr
, Jim_Obj
*valueObjPtr
)
5866 Jim_HashTable
*ht
= objPtr
->internalRep
.ptr
;
5868 if (valueObjPtr
== NULL
) { /* unset */
5869 Jim_DeleteHashEntry(ht
, keyObjPtr
);
5872 Jim_IncrRefCount(keyObjPtr
);
5873 Jim_IncrRefCount(valueObjPtr
);
5874 if (Jim_AddHashEntry(ht
, keyObjPtr
, valueObjPtr
) != JIM_OK
) {
5875 Jim_HashEntry
*he
= Jim_FindHashEntry(ht
, keyObjPtr
);
5876 Jim_DecrRefCount(interp
, keyObjPtr
);
5877 /* ATTENTION: const cast */
5878 Jim_DecrRefCount(interp
, (Jim_Obj
*)he
->val
);
5879 he
->val
= valueObjPtr
;
5883 /* Add an element, higher-level interface for DictAddElement().
5884 * If valueObjPtr == NULL, the key is removed if it exists. */
5885 int Jim_DictAddElement(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
5886 Jim_Obj
*keyObjPtr
, Jim_Obj
*valueObjPtr
)
5888 if (Jim_IsShared(objPtr
))
5889 Jim_Panic(interp
,"Jim_DictAddElement called with shared object");
5890 if (objPtr
->typePtr
!= &dictObjType
) {
5891 if (SetDictFromAny(interp
, objPtr
) != JIM_OK
)
5894 DictAddElement(interp
, objPtr
, keyObjPtr
, valueObjPtr
);
5895 Jim_InvalidateStringRep(objPtr
);
5899 Jim_Obj
*Jim_NewDictObj(Jim_Interp
*interp
, Jim_Obj
*const *elements
, int len
)
5905 Jim_Panic(interp
,"Jim_NewDicObj() 'len' argument must be even");
5907 objPtr
= Jim_NewObj(interp
);
5908 objPtr
->typePtr
= &dictObjType
;
5909 objPtr
->bytes
= NULL
;
5910 objPtr
->internalRep
.ptr
= Jim_Alloc(sizeof(Jim_HashTable
));
5911 Jim_InitHashTable(objPtr
->internalRep
.ptr
, &JimDictHashTableType
, interp
);
5912 for (i
= 0; i
< len
; i
+= 2)
5913 DictAddElement(interp
, objPtr
, elements
[i
], elements
[i
+ 1]);
5917 /* Return the value associated to the specified dict key */
5918 int Jim_DictKey(Jim_Interp
*interp
, Jim_Obj
*dictPtr
, Jim_Obj
*keyPtr
,
5919 Jim_Obj
**objPtrPtr
, int flags
)
5924 if (dictPtr
->typePtr
!= &dictObjType
) {
5925 if (SetDictFromAny(interp
, dictPtr
) != JIM_OK
)
5928 ht
= dictPtr
->internalRep
.ptr
;
5929 if ((he
= Jim_FindHashEntry(ht
, keyPtr
)) == NULL
) {
5930 if (flags
& JIM_ERRMSG
) {
5931 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
5932 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
5933 "key \"", Jim_GetString(keyPtr
, NULL
),
5934 "\" not found in dictionary", NULL
);
5938 *objPtrPtr
= he
->val
;
5942 /* Return the value associated to the specified dict keys */
5943 int Jim_DictKeysVector(Jim_Interp
*interp
, Jim_Obj
*dictPtr
,
5944 Jim_Obj
*const *keyv
, int keyc
, Jim_Obj
**objPtrPtr
, int flags
)
5946 Jim_Obj
*objPtr
= NULL
;
5950 *objPtrPtr
= dictPtr
;
5954 for (i
= 0; i
< keyc
; i
++) {
5955 if (Jim_DictKey(interp
, dictPtr
, keyv
[i
], &objPtr
, flags
)
5960 *objPtrPtr
= objPtr
;
5964 /* Modify the dict stored into the variable named 'varNamePtr'
5965 * setting the element specified by the 'keyc' keys objects in 'keyv',
5966 * with the new value of the element 'newObjPtr'.
5968 * If newObjPtr == NULL the operation is to remove the given key
5969 * from the dictionary. */
5970 int Jim_SetDictKeysVector(Jim_Interp
*interp
, Jim_Obj
*varNamePtr
,
5971 Jim_Obj
*const *keyv
, int keyc
, Jim_Obj
*newObjPtr
)
5973 Jim_Obj
*varObjPtr
, *objPtr
, *dictObjPtr
;
5976 varObjPtr
= objPtr
= Jim_GetVariable(interp
, varNamePtr
, JIM_ERRMSG
);
5977 if (objPtr
== NULL
) {
5978 if (newObjPtr
== NULL
) /* Cannot remove a key from non existing var */
5980 varObjPtr
= objPtr
= Jim_NewDictObj(interp
, NULL
, 0);
5981 if (Jim_SetVariable(interp
, varNamePtr
, objPtr
) != JIM_OK
) {
5982 Jim_FreeNewObj(interp
, varObjPtr
);
5986 if ((shared
= Jim_IsShared(objPtr
)))
5987 varObjPtr
= objPtr
= Jim_DuplicateObj(interp
, objPtr
);
5988 for (i
= 0; i
< keyc
-1; i
++) {
5989 dictObjPtr
= objPtr
;
5991 /* Check if it's a valid dictionary */
5992 if (dictObjPtr
->typePtr
!= &dictObjType
) {
5993 if (SetDictFromAny(interp
, dictObjPtr
) != JIM_OK
)
5996 /* Check if the given key exists. */
5997 Jim_InvalidateStringRep(dictObjPtr
);
5998 if (Jim_DictKey(interp
, dictObjPtr
, keyv
[i
], &objPtr
,
5999 newObjPtr
? JIM_NONE
: JIM_ERRMSG
) == JIM_OK
)
6001 /* This key exists at the current level.
6002 * Make sure it's not shared!. */
6003 if (Jim_IsShared(objPtr
)) {
6004 objPtr
= Jim_DuplicateObj(interp
, objPtr
);
6005 DictAddElement(interp
, dictObjPtr
, keyv
[i
], objPtr
);
6008 /* Key not found. If it's an [unset] operation
6009 * this is an error. Only the last key may not
6011 if (newObjPtr
== NULL
)
6013 /* Otherwise set an empty dictionary
6014 * as key's value. */
6015 objPtr
= Jim_NewDictObj(interp
, NULL
, 0);
6016 DictAddElement(interp
, dictObjPtr
, keyv
[i
], objPtr
);
6019 if (Jim_DictAddElement(interp
, objPtr
, keyv
[keyc
-1], newObjPtr
)
6022 Jim_InvalidateStringRep(objPtr
);
6023 Jim_InvalidateStringRep(varObjPtr
);
6024 if (Jim_SetVariable(interp
, varNamePtr
, varObjPtr
) != JIM_OK
)
6026 Jim_SetResult(interp
, varObjPtr
);
6030 Jim_FreeNewObj(interp
, varObjPtr
);
6035 /* -----------------------------------------------------------------------------
6037 * ---------------------------------------------------------------------------*/
6038 static void UpdateStringOfIndex(struct Jim_Obj
*objPtr
);
6039 static int SetIndexFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
);
6041 static Jim_ObjType indexObjType
= {
6045 UpdateStringOfIndex
,
6049 void UpdateStringOfIndex(struct Jim_Obj
*objPtr
)
6052 char buf
[JIM_INTEGER_SPACE
+ 1];
6054 if (objPtr
->internalRep
.indexValue
>= 0)
6055 len
= sprintf(buf
, "%d", objPtr
->internalRep
.indexValue
);
6056 else if (objPtr
->internalRep
.indexValue
== -1)
6057 len
= sprintf(buf
, "end");
6059 len
= sprintf(buf
, "end%d", objPtr
->internalRep
.indexValue
+ 1);
6061 objPtr
->bytes
= Jim_Alloc(len
+ 1);
6062 memcpy(objPtr
->bytes
, buf
, len
+ 1);
6063 objPtr
->length
= len
;
6066 int SetIndexFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
6071 /* Get the string representation */
6072 str
= Jim_GetString(objPtr
, NULL
);
6073 /* Try to convert into an index */
6074 if (!strcmp(str
, "end")) {
6078 if (!strncmp(str
, "end-", 4)) {
6082 if (Jim_StringToIndex(str
, &index
) != JIM_OK
) {
6083 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
6084 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
6085 "bad index \"", Jim_GetString(objPtr
, NULL
), "\": "
6086 "must be integer or end?-integer?", NULL
);
6094 index
= -(index
+ 1);
6095 } else if (!end
&& index
< 0)
6097 /* Free the old internal repr and set the new one. */
6098 Jim_FreeIntRep(interp
, objPtr
);
6099 objPtr
->typePtr
= &indexObjType
;
6100 objPtr
->internalRep
.indexValue
= index
;
6104 int Jim_GetIndex(Jim_Interp
*interp
, Jim_Obj
*objPtr
, int *indexPtr
)
6106 /* Avoid shimmering if the object is an integer. */
6107 if (objPtr
->typePtr
== &intObjType
) {
6108 jim_wide val
= objPtr
->internalRep
.wideValue
;
6109 if (!(val
< LONG_MIN
) && !(val
> LONG_MAX
)) {
6110 *indexPtr
= (val
< 0) ? -INT_MAX
: (long)val
;;
6114 if (objPtr
->typePtr
!= &indexObjType
&&
6115 SetIndexFromAny(interp
, objPtr
) == JIM_ERR
)
6117 *indexPtr
= objPtr
->internalRep
.indexValue
;
6121 /* -----------------------------------------------------------------------------
6122 * Return Code Object.
6123 * ---------------------------------------------------------------------------*/
6125 static int SetReturnCodeFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
6127 static Jim_ObjType returnCodeObjType
= {
6135 int SetReturnCodeFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
6138 int strLen
, returnCode
;
6141 /* Get the string representation */
6142 str
= Jim_GetString(objPtr
, &strLen
);
6143 /* Try to convert into an integer */
6144 if (JimGetWideNoErr(interp
, objPtr
, &wideValue
) != JIM_ERR
)
6145 returnCode
= (int) wideValue
;
6146 else if (!JimStringCompare(str
, strLen
, "ok", 2, JIM_NOCASE
))
6147 returnCode
= JIM_OK
;
6148 else if (!JimStringCompare(str
, strLen
, "error", 5, JIM_NOCASE
))
6149 returnCode
= JIM_ERR
;
6150 else if (!JimStringCompare(str
, strLen
, "return", 6, JIM_NOCASE
))
6151 returnCode
= JIM_RETURN
;
6152 else if (!JimStringCompare(str
, strLen
, "break", 5, JIM_NOCASE
))
6153 returnCode
= JIM_BREAK
;
6154 else if (!JimStringCompare(str
, strLen
, "continue", 8, JIM_NOCASE
))
6155 returnCode
= JIM_CONTINUE
;
6156 else if (!JimStringCompare(str
, strLen
, "eval", 4, JIM_NOCASE
))
6157 returnCode
= JIM_EVAL
;
6158 else if (!JimStringCompare(str
, strLen
, "exit", 4, JIM_NOCASE
))
6159 returnCode
= JIM_EXIT
;
6161 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
6162 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
6163 "expected return code but got '", str
, "'",
6167 /* Free the old internal repr and set the new one. */
6168 Jim_FreeIntRep(interp
, objPtr
);
6169 objPtr
->typePtr
= &returnCodeObjType
;
6170 objPtr
->internalRep
.returnCode
= returnCode
;
6174 int Jim_GetReturnCode(Jim_Interp
*interp
, Jim_Obj
*objPtr
, int *intPtr
)
6176 if (objPtr
->typePtr
!= &returnCodeObjType
&&
6177 SetReturnCodeFromAny(interp
, objPtr
) == JIM_ERR
)
6179 *intPtr
= objPtr
->internalRep
.returnCode
;
6183 /* -----------------------------------------------------------------------------
6184 * Expression Parsing
6185 * ---------------------------------------------------------------------------*/
6186 static int JimParseExprOperator(struct JimParserCtx
*pc
);
6187 static int JimParseExprNumber(struct JimParserCtx
*pc
);
6188 static int JimParseExprIrrational(struct JimParserCtx
*pc
);
6190 /* Exrp's Stack machine operators opcodes. */
6192 /* Binary operators (numbers) */
6193 #define JIM_EXPROP_BINARY_NUM_FIRST 0 /* first */
6194 #define JIM_EXPROP_MUL 0
6195 #define JIM_EXPROP_DIV 1
6196 #define JIM_EXPROP_MOD 2
6197 #define JIM_EXPROP_SUB 3
6198 #define JIM_EXPROP_ADD 4
6199 #define JIM_EXPROP_LSHIFT 5
6200 #define JIM_EXPROP_RSHIFT 6
6201 #define JIM_EXPROP_ROTL 7
6202 #define JIM_EXPROP_ROTR 8
6203 #define JIM_EXPROP_LT 9
6204 #define JIM_EXPROP_GT 10
6205 #define JIM_EXPROP_LTE 11
6206 #define JIM_EXPROP_GTE 12
6207 #define JIM_EXPROP_NUMEQ 13
6208 #define JIM_EXPROP_NUMNE 14
6209 #define JIM_EXPROP_BITAND 15
6210 #define JIM_EXPROP_BITXOR 16
6211 #define JIM_EXPROP_BITOR 17
6212 #define JIM_EXPROP_LOGICAND 18
6213 #define JIM_EXPROP_LOGICOR 19
6214 #define JIM_EXPROP_LOGICAND_LEFT 20
6215 #define JIM_EXPROP_LOGICOR_LEFT 21
6216 #define JIM_EXPROP_POW 22
6217 #define JIM_EXPROP_BINARY_NUM_LAST 22 /* last */
6219 /* Binary operators (strings) */
6220 #define JIM_EXPROP_STREQ 23
6221 #define JIM_EXPROP_STRNE 24
6223 /* Unary operators (numbers) */
6224 #define JIM_EXPROP_NOT 25
6225 #define JIM_EXPROP_BITNOT 26
6226 #define JIM_EXPROP_UNARYMINUS 27
6227 #define JIM_EXPROP_UNARYPLUS 28
6228 #define JIM_EXPROP_LOGICAND_RIGHT 29
6229 #define JIM_EXPROP_LOGICOR_RIGHT 30
6231 /* Ternary operators */
6232 #define JIM_EXPROP_TERNARY 31
6235 #define JIM_EXPROP_NUMBER 32
6236 #define JIM_EXPROP_COMMAND 33
6237 #define JIM_EXPROP_VARIABLE 34
6238 #define JIM_EXPROP_DICTSUGAR 35
6239 #define JIM_EXPROP_SUBST 36
6240 #define JIM_EXPROP_STRING 37
6242 /* Operators table */
6243 typedef struct Jim_ExprOperator
{
6250 /* name - precedence - arity - opcode */
6251 static struct Jim_ExprOperator Jim_ExprOperators
[] = {
6252 {"!", 300, 1, JIM_EXPROP_NOT
},
6253 {"~", 300, 1, JIM_EXPROP_BITNOT
},
6254 {"unarymin", 300, 1, JIM_EXPROP_UNARYMINUS
},
6255 {"unaryplus", 300, 1, JIM_EXPROP_UNARYPLUS
},
6257 {"**", 250, 2, JIM_EXPROP_POW
},
6259 {"*", 200, 2, JIM_EXPROP_MUL
},
6260 {"/", 200, 2, JIM_EXPROP_DIV
},
6261 {"%", 200, 2, JIM_EXPROP_MOD
},
6263 {"-", 100, 2, JIM_EXPROP_SUB
},
6264 {"+", 100, 2, JIM_EXPROP_ADD
},
6266 {"<<<", 90, 3, JIM_EXPROP_ROTL
},
6267 {">>>", 90, 3, JIM_EXPROP_ROTR
},
6268 {"<<", 90, 2, JIM_EXPROP_LSHIFT
},
6269 {">>", 90, 2, JIM_EXPROP_RSHIFT
},
6271 {"<", 80, 2, JIM_EXPROP_LT
},
6272 {">", 80, 2, JIM_EXPROP_GT
},
6273 {"<=", 80, 2, JIM_EXPROP_LTE
},
6274 {">=", 80, 2, JIM_EXPROP_GTE
},
6276 {"==", 70, 2, JIM_EXPROP_NUMEQ
},
6277 {"!=", 70, 2, JIM_EXPROP_NUMNE
},
6279 {"eq", 60, 2, JIM_EXPROP_STREQ
},
6280 {"ne", 60, 2, JIM_EXPROP_STRNE
},
6282 {"&", 50, 2, JIM_EXPROP_BITAND
},
6283 {"^", 49, 2, JIM_EXPROP_BITXOR
},
6284 {"|", 48, 2, JIM_EXPROP_BITOR
},
6286 {"&&", 10, 2, JIM_EXPROP_LOGICAND
},
6287 {"||", 10, 2, JIM_EXPROP_LOGICOR
},
6289 {"?", 5, 3, JIM_EXPROP_TERNARY
},
6290 /* private operators */
6291 {NULL
, 10, 2, JIM_EXPROP_LOGICAND_LEFT
},
6292 {NULL
, 10, 1, JIM_EXPROP_LOGICAND_RIGHT
},
6293 {NULL
, 10, 2, JIM_EXPROP_LOGICOR_LEFT
},
6294 {NULL
, 10, 1, JIM_EXPROP_LOGICOR_RIGHT
},
6297 #define JIM_EXPR_OPERATORS_NUM \
6298 (sizeof(Jim_ExprOperators)/sizeof(struct Jim_ExprOperator))
6300 int JimParseExpression(struct JimParserCtx
*pc
)
6302 /* Discard spaces and quoted newline */
6303 while (*(pc
->p
) == ' ' ||
6307 (*(pc
->p
) == '\\' && *(pc
->p
+ 1) == '\n')) {
6312 pc
->tstart
= pc
->tend
= pc
->p
;
6313 pc
->tline
= pc
->linenr
;
6314 pc
->tt
= JIM_TT_EOL
;
6320 pc
->tstart
= pc
->tend
= pc
->p
;
6321 pc
->tline
= pc
->linenr
;
6322 pc
->tt
= JIM_TT_SUBEXPR_START
;
6326 pc
->tstart
= pc
->tend
= pc
->p
;
6327 pc
->tline
= pc
->linenr
;
6328 pc
->tt
= JIM_TT_SUBEXPR_END
;
6332 return JimParseCmd(pc
);
6335 if (JimParseVar(pc
) == JIM_ERR
)
6336 return JimParseExprOperator(pc
);
6341 if ((pc
->tt
== JIM_TT_NONE
|| pc
->tt
== JIM_TT_EXPR_OPERATOR
) &&
6342 isdigit((int)*(pc
->p
+ 1)))
6343 return JimParseExprNumber(pc
);
6345 return JimParseExprOperator(pc
);
6347 case '0': case '1': case '2': case '3': case '4':
6348 case '5': case '6': case '7': case '8': case '9': case '.':
6349 return JimParseExprNumber(pc
);
6353 /* Here it's possible to reuse the List String parsing. */
6354 pc
->tt
= JIM_TT_NONE
; /* Make sure it's sensed as a new word. */
6355 return JimParseListStr(pc
);
6359 if (JimParseExprIrrational(pc
) == JIM_ERR
)
6360 return JimParseExprOperator(pc
);
6363 return JimParseExprOperator(pc
);
6369 int JimParseExprNumber(struct JimParserCtx
*pc
)
6375 pc
->tline
= pc
->linenr
;
6376 if (*pc
->p
== '-') {
6379 while (isdigit((int)*pc
->p
)
6380 || (allowhex
&& isxdigit((int)*pc
->p
))
6381 || (allowdot
&& *pc
->p
== '.')
6382 || (pc
->p
-pc
->tstart
== 1 && *pc
->tstart
== '0' &&
6383 (*pc
->p
== 'x' || *pc
->p
== 'X'))
6386 if ((*pc
->p
== 'x') || (*pc
->p
== 'X')) {
6393 if (!allowdot
&& *pc
->p
== 'e' && *(pc
->p
+ 1) == '-') {
6394 pc
->p
+= 2; pc
->len
-= 2;
6398 pc
->tt
= JIM_TT_EXPR_NUMBER
;
6402 int JimParseExprIrrational(struct JimParserCtx
*pc
)
6404 const char *Tokens
[] = {"NaN", "nan", "NAN", "Inf", "inf", "INF", NULL
};
6406 for (token
= Tokens
; *token
!= NULL
; token
++) {
6407 int len
= strlen(*token
);
6408 if (strncmp(*token
, pc
->p
, len
) == 0) {
6410 pc
->tend
= pc
->p
+ len
- 1;
6411 pc
->p
+= len
; pc
->len
-= len
;
6412 pc
->tline
= pc
->linenr
;
6413 pc
->tt
= JIM_TT_EXPR_NUMBER
;
6420 int JimParseExprOperator(struct JimParserCtx
*pc
)
6423 int bestIdx
= -1, bestLen
= 0;
6425 /* Try to get the longest match. */
6426 for (i
= 0; i
< (signed)JIM_EXPR_OPERATORS_NUM
; i
++) {
6430 opname
= Jim_ExprOperators
[i
].name
;
6431 if (opname
== NULL
) continue;
6432 oplen
= strlen(opname
);
6434 if (strncmp(opname
, pc
->p
, oplen
) == 0 && oplen
> bestLen
) {
6439 if (bestIdx
== -1) return JIM_ERR
;
6441 pc
->tend
= pc
->p
+ bestLen
- 1;
6442 pc
->p
+= bestLen
; pc
->len
-= bestLen
;
6443 pc
->tline
= pc
->linenr
;
6444 pc
->tt
= JIM_TT_EXPR_OPERATOR
;
6448 struct Jim_ExprOperator
*JimExprOperatorInfo(const char *opname
)
6451 for (i
= 0; i
< (signed)JIM_EXPR_OPERATORS_NUM
; i
++)
6452 if (Jim_ExprOperators
[i
].name
&&
6453 strcmp(opname
, Jim_ExprOperators
[i
].name
) == 0)
6454 return &Jim_ExprOperators
[i
];
6458 struct Jim_ExprOperator
*JimExprOperatorInfoByOpcode(int opcode
)
6461 for (i
= 0; i
< (signed)JIM_EXPR_OPERATORS_NUM
; i
++)
6462 if (Jim_ExprOperators
[i
].opcode
== opcode
)
6463 return &Jim_ExprOperators
[i
];
6467 /* -----------------------------------------------------------------------------
6469 * ---------------------------------------------------------------------------*/
6470 static void FreeExprInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
6471 static void DupExprInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
);
6472 static int SetExprFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
);
6474 static Jim_ObjType exprObjType
= {
6476 FreeExprInternalRep
,
6479 JIM_TYPE_REFERENCES
,
6482 /* Expr bytecode structure */
6483 typedef struct ExprByteCode
{
6484 int *opcode
; /* Integer array of opcodes. */
6485 Jim_Obj
**obj
; /* Array of associated Jim Objects. */
6486 int len
; /* Bytecode length */
6487 int inUse
; /* Used for sharing. */
6490 void FreeExprInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
6493 ExprByteCode
*expr
= (void*) objPtr
->internalRep
.ptr
;
6496 if (expr
->inUse
!= 0) return;
6497 for (i
= 0; i
< expr
->len
; i
++)
6498 Jim_DecrRefCount(interp
, expr
->obj
[i
]);
6499 Jim_Free(expr
->opcode
);
6500 Jim_Free(expr
->obj
);
6504 void DupExprInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
)
6506 JIM_NOTUSED(interp
);
6507 JIM_NOTUSED(srcPtr
);
6509 /* Just returns an simple string. */
6510 dupPtr
->typePtr
= NULL
;
6513 /* Add a new instruction to an expression bytecode structure. */
6514 static void ExprObjAddInstr(Jim_Interp
*interp
, ExprByteCode
*expr
,
6515 int opcode
, char *str
, int len
)
6517 expr
->opcode
= Jim_Realloc(expr
->opcode
, sizeof(int)*(expr
->len
+ 1));
6518 expr
->obj
= Jim_Realloc(expr
->obj
, sizeof(Jim_Obj
*)*(expr
->len
+ 1));
6519 expr
->opcode
[expr
->len
] = opcode
;
6520 expr
->obj
[expr
->len
] = Jim_NewStringObjNoAlloc(interp
, str
, len
);
6521 Jim_IncrRefCount(expr
->obj
[expr
->len
]);
6525 /* Check if an expr program looks correct. */
6526 static int ExprCheckCorrectness(ExprByteCode
*expr
)
6531 /* Try to check if there are stack underflows,
6532 * and make sure at the end of the program there is
6533 * a single result on the stack. */
6534 for (i
= 0; i
< expr
->len
; i
++) {
6535 switch (expr
->opcode
[i
]) {
6536 case JIM_EXPROP_NUMBER
:
6537 case JIM_EXPROP_STRING
:
6538 case JIM_EXPROP_SUBST
:
6539 case JIM_EXPROP_VARIABLE
:
6540 case JIM_EXPROP_DICTSUGAR
:
6541 case JIM_EXPROP_COMMAND
:
6544 case JIM_EXPROP_NOT
:
6545 case JIM_EXPROP_BITNOT
:
6546 case JIM_EXPROP_UNARYMINUS
:
6547 case JIM_EXPROP_UNARYPLUS
:
6548 /* Unary operations */
6549 if (stacklen
< 1) return JIM_ERR
;
6551 case JIM_EXPROP_ADD
:
6552 case JIM_EXPROP_SUB
:
6553 case JIM_EXPROP_MUL
:
6554 case JIM_EXPROP_DIV
:
6555 case JIM_EXPROP_MOD
:
6558 case JIM_EXPROP_LTE
:
6559 case JIM_EXPROP_GTE
:
6560 case JIM_EXPROP_ROTL
:
6561 case JIM_EXPROP_ROTR
:
6562 case JIM_EXPROP_LSHIFT
:
6563 case JIM_EXPROP_RSHIFT
:
6564 case JIM_EXPROP_NUMEQ
:
6565 case JIM_EXPROP_NUMNE
:
6566 case JIM_EXPROP_STREQ
:
6567 case JIM_EXPROP_STRNE
:
6568 case JIM_EXPROP_BITAND
:
6569 case JIM_EXPROP_BITXOR
:
6570 case JIM_EXPROP_BITOR
:
6571 case JIM_EXPROP_LOGICAND
:
6572 case JIM_EXPROP_LOGICOR
:
6573 case JIM_EXPROP_POW
:
6574 /* binary operations */
6575 if (stacklen
< 2) return JIM_ERR
;
6579 Jim_Panic(NULL
,"Default opcode reached ExprCheckCorrectness");
6583 if (stacklen
!= 1) return JIM_ERR
;
6587 static void ExprShareLiterals(Jim_Interp
*interp
, ExprByteCode
*expr
,
6588 ScriptObj
*topLevelScript
)
6593 for (i
= 0; i
< expr
->len
; i
++) {
6594 Jim_Obj
*foundObjPtr
;
6596 if (expr
->obj
[i
] == NULL
) continue;
6597 foundObjPtr
= ScriptSearchLiteral(interp
, topLevelScript
,
6598 NULL
, expr
->obj
[i
]);
6599 if (foundObjPtr
!= NULL
) {
6600 Jim_IncrRefCount(foundObjPtr
);
6601 Jim_DecrRefCount(interp
, expr
->obj
[i
]);
6602 expr
->obj
[i
] = foundObjPtr
;
6607 /* This procedure converts every occurrence of || and && opereators
6608 * in lazy unary versions.
6610 * a b || is converted into:
6612 * a <offset> |L b |R
6614 * a b && is converted into:
6616 * a <offset> &L b &R
6618 * "|L" checks if 'a' is true:
6619 * 1) if it is true pushes 1 and skips <offset> istructions to reach
6620 * the opcode just after |R.
6621 * 2) if it is false does nothing.
6622 * "|R" checks if 'b' is true:
6623 * 1) if it is true pushes 1, otherwise pushes 0.
6625 * "&L" checks if 'a' is true:
6626 * 1) if it is true does nothing.
6627 * 2) If it is false pushes 0 and skips <offset> istructions to reach
6628 * the opcode just after &R
6629 * "&R" checks if 'a' is true:
6630 * if it is true pushes 1, otherwise pushes 0.
6632 static void ExprMakeLazy(Jim_Interp
*interp
, ExprByteCode
*expr
)
6635 int index
= -1, leftindex
, arity
, i
, offset
;
6636 Jim_ExprOperator
*op
;
6638 /* Search for || or && */
6639 for (i
= 0; i
< expr
->len
; i
++) {
6640 if (expr
->opcode
[i
] == JIM_EXPROP_LOGICAND
||
6641 expr
->opcode
[i
] == JIM_EXPROP_LOGICOR
) {
6646 if (index
== -1) return;
6647 /* Search for the end of the first operator */
6648 leftindex
= index
-1;
6651 switch (expr
->opcode
[leftindex
]) {
6652 case JIM_EXPROP_NUMBER
:
6653 case JIM_EXPROP_COMMAND
:
6654 case JIM_EXPROP_VARIABLE
:
6655 case JIM_EXPROP_DICTSUGAR
:
6656 case JIM_EXPROP_SUBST
:
6657 case JIM_EXPROP_STRING
:
6660 op
= JimExprOperatorInfoByOpcode(expr
->opcode
[leftindex
]);
6662 Jim_Panic(interp
,"Default reached in ExprMakeLazy()");
6671 expr
->opcode
= Jim_Realloc(expr
->opcode
, sizeof(int)*(expr
->len
+ 2));
6672 expr
->obj
= Jim_Realloc(expr
->obj
, sizeof(Jim_Obj
*)*(expr
->len
+ 2));
6673 memmove(&expr
->opcode
[leftindex
+ 2], &expr
->opcode
[leftindex
],
6674 sizeof(int)*(expr
->len
-leftindex
));
6675 memmove(&expr
->obj
[leftindex
+ 2], &expr
->obj
[leftindex
],
6676 sizeof(Jim_Obj
*)*(expr
->len
-leftindex
));
6679 offset
= (index
-leftindex
)-1;
6680 Jim_DecrRefCount(interp
, expr
->obj
[index
]);
6681 if (expr
->opcode
[index
] == JIM_EXPROP_LOGICAND
) {
6682 expr
->opcode
[leftindex
+ 1] = JIM_EXPROP_LOGICAND_LEFT
;
6683 expr
->opcode
[index
] = JIM_EXPROP_LOGICAND_RIGHT
;
6684 expr
->obj
[leftindex
+ 1] = Jim_NewStringObj(interp
, "&L", -1);
6685 expr
->obj
[index
] = Jim_NewStringObj(interp
, "&R", -1);
6687 expr
->opcode
[leftindex
+ 1] = JIM_EXPROP_LOGICOR_LEFT
;
6688 expr
->opcode
[index
] = JIM_EXPROP_LOGICOR_RIGHT
;
6689 expr
->obj
[leftindex
+ 1] = Jim_NewStringObj(interp
, "|L", -1);
6690 expr
->obj
[index
] = Jim_NewStringObj(interp
, "|R", -1);
6692 expr
->opcode
[leftindex
] = JIM_EXPROP_NUMBER
;
6693 expr
->obj
[leftindex
] = Jim_NewIntObj(interp
, offset
);
6694 Jim_IncrRefCount(expr
->obj
[index
]);
6695 Jim_IncrRefCount(expr
->obj
[leftindex
]);
6696 Jim_IncrRefCount(expr
->obj
[leftindex
+ 1]);
6700 /* This method takes the string representation of an expression
6701 * and generates a program for the Expr's stack-based VM. */
6702 int SetExprFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
)
6705 const char *exprText
= Jim_GetString(objPtr
, &exprTextLen
);
6706 struct JimParserCtx parser
;
6707 int i
, shareLiterals
;
6708 ExprByteCode
*expr
= Jim_Alloc(sizeof(*expr
));
6710 Jim_ExprOperator
*op
;
6712 /* Perform literal sharing with the current procedure
6713 * running only if this expression appears to be not generated
6715 shareLiterals
= objPtr
->typePtr
== &sourceObjType
;
6717 expr
->opcode
= NULL
;
6722 Jim_InitStack(&stack
);
6723 JimParserInit(&parser
, exprText
, exprTextLen
, 1);
6724 while (!JimParserEof(&parser
)) {
6728 if (JimParseExpression(&parser
) != JIM_OK
) {
6729 Jim_SetResultString(interp
, "Syntax error in expression", -1);
6732 token
= JimParserGetToken(&parser
, &len
, &type
, NULL
);
6733 if (type
== JIM_TT_EOL
) {
6739 ExprObjAddInstr(interp
, expr
, JIM_EXPROP_STRING
, token
, len
);
6742 ExprObjAddInstr(interp
, expr
, JIM_EXPROP_SUBST
, token
, len
);
6745 ExprObjAddInstr(interp
, expr
, JIM_EXPROP_VARIABLE
, token
, len
);
6747 case JIM_TT_DICTSUGAR
:
6748 ExprObjAddInstr(interp
, expr
, JIM_EXPROP_DICTSUGAR
, token
, len
);
6751 ExprObjAddInstr(interp
, expr
, JIM_EXPROP_COMMAND
, token
, len
);
6753 case JIM_TT_EXPR_NUMBER
:
6754 ExprObjAddInstr(interp
, expr
, JIM_EXPROP_NUMBER
, token
, len
);
6756 case JIM_TT_EXPR_OPERATOR
:
6757 op
= JimExprOperatorInfo(token
);
6759 Jim_ExprOperator
*stackTopOp
;
6761 if (Jim_StackPeek(&stack
) != NULL
) {
6762 stackTopOp
= JimExprOperatorInfo(Jim_StackPeek(&stack
));
6766 if (Jim_StackLen(&stack
) && op
->arity
!= 1 &&
6767 stackTopOp
&& stackTopOp
->precedence
>= op
->precedence
)
6769 ExprObjAddInstr(interp
, expr
, stackTopOp
->opcode
,
6770 Jim_StackPeek(&stack
), -1);
6771 Jim_StackPop(&stack
);
6776 Jim_StackPush(&stack
, token
);
6778 case JIM_TT_SUBEXPR_START
:
6779 Jim_StackPush(&stack
, Jim_StrDup("("));
6782 case JIM_TT_SUBEXPR_END
:
6785 while (Jim_StackLen(&stack
)) {
6786 char *opstr
= Jim_StackPop(&stack
);
6787 if (!strcmp(opstr
, "(")) {
6792 op
= JimExprOperatorInfo(opstr
);
6793 ExprObjAddInstr(interp
, expr
, op
->opcode
, opstr
, -1);
6796 Jim_SetResultString(interp
,
6797 "Unexpected close parenthesis", -1);
6804 Jim_Panic(interp
,"Default reached in SetExprFromAny()");
6808 while (Jim_StackLen(&stack
)) {
6809 char *opstr
= Jim_StackPop(&stack
);
6810 op
= JimExprOperatorInfo(opstr
);
6811 if (op
== NULL
&& !strcmp(opstr
, "(")) {
6813 Jim_SetResultString(interp
, "Missing close parenthesis", -1);
6816 ExprObjAddInstr(interp
, expr
, op
->opcode
, opstr
, -1);
6818 /* Check program correctness. */
6819 if (ExprCheckCorrectness(expr
) != JIM_OK
) {
6820 Jim_SetResultString(interp
, "Invalid expression", -1);
6824 /* Free the stack used for the compilation. */
6825 Jim_FreeStackElements(&stack
, Jim_Free
);
6826 Jim_FreeStack(&stack
);
6828 /* Convert || and && operators in unary |L |R and &L &R for lazyness */
6829 ExprMakeLazy(interp
, expr
);
6831 /* Perform literal sharing */
6832 if (shareLiterals
&& interp
->framePtr
->procBodyObjPtr
) {
6833 Jim_Obj
*bodyObjPtr
= interp
->framePtr
->procBodyObjPtr
;
6834 if (bodyObjPtr
->typePtr
== &scriptObjType
) {
6835 ScriptObj
*bodyScript
= bodyObjPtr
->internalRep
.ptr
;
6836 ExprShareLiterals(interp
, expr
, bodyScript
);
6840 /* Free the old internal rep and set the new one. */
6841 Jim_FreeIntRep(interp
, objPtr
);
6842 Jim_SetIntRepPtr(objPtr
, expr
);
6843 objPtr
->typePtr
= &exprObjType
;
6846 err
: /* we jump here on syntax/compile errors. */
6847 Jim_FreeStackElements(&stack
, Jim_Free
);
6848 Jim_FreeStack(&stack
);
6849 Jim_Free(expr
->opcode
);
6850 for (i
= 0; i
< expr
->len
; i
++) {
6851 Jim_DecrRefCount(interp
,expr
->obj
[i
]);
6853 Jim_Free(expr
->obj
);
6858 ExprByteCode
*Jim_GetExpression(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
6860 if (objPtr
->typePtr
!= &exprObjType
) {
6861 if (SetExprFromAny(interp
, objPtr
) != JIM_OK
)
6864 return (ExprByteCode
*) Jim_GetIntRepPtr(objPtr
);
6867 /* -----------------------------------------------------------------------------
6868 * Expressions evaluation.
6869 * Jim uses a specialized stack-based virtual machine for expressions,
6870 * that takes advantage of the fact that expr's operators
6871 * can't be redefined.
6873 * Jim_EvalExpression() uses the bytecode compiled by
6874 * SetExprFromAny() method of the "expression" object.
6876 * On success a Tcl Object containing the result of the evaluation
6877 * is stored into expResultPtrPtr (having refcount of 1), and JIM_OK is
6879 * On error the function returns a retcode != to JIM_OK and set a suitable
6880 * error on the interp.
6881 * ---------------------------------------------------------------------------*/
6882 #define JIM_EE_STATICSTACK_LEN 10
6884 int Jim_EvalExpression(Jim_Interp
*interp
, Jim_Obj
*exprObjPtr
,
6885 Jim_Obj
**exprResultPtrPtr
)
6888 Jim_Obj
**stack
, *staticStack
[JIM_EE_STATICSTACK_LEN
];
6889 int stacklen
= 0, i
, error
= 0, errRetCode
= JIM_ERR
;
6891 Jim_IncrRefCount(exprObjPtr
);
6892 expr
= Jim_GetExpression(interp
, exprObjPtr
);
6894 Jim_DecrRefCount(interp
, exprObjPtr
);
6895 return JIM_ERR
; /* error in expression. */
6897 /* In order to avoid that the internal repr gets freed due to
6898 * shimmering of the exprObjPtr's object, we make the internal rep
6902 /* The stack-based expr VM itself */
6904 /* Stack allocation. Expr programs have the feature that
6905 * a program of length N can't require a stack longer than
6907 if (expr
->len
> JIM_EE_STATICSTACK_LEN
)
6908 stack
= Jim_Alloc(sizeof(Jim_Obj
*)*expr
->len
);
6910 stack
= staticStack
;
6912 /* Execute every istruction */
6913 for (i
= 0; i
< expr
->len
; i
++) {
6914 Jim_Obj
*A
, *B
, *objPtr
;
6915 jim_wide wA
, wB
, wC
;
6917 const char *sA
, *sB
;
6918 int Alen
, Blen
, retcode
;
6919 int opcode
= expr
->opcode
[i
];
6921 if (opcode
== JIM_EXPROP_NUMBER
|| opcode
== JIM_EXPROP_STRING
) {
6922 stack
[stacklen
++] = expr
->obj
[i
];
6923 Jim_IncrRefCount(expr
->obj
[i
]);
6924 } else if (opcode
== JIM_EXPROP_VARIABLE
) {
6925 objPtr
= Jim_GetVariable(interp
, expr
->obj
[i
], JIM_ERRMSG
);
6926 if (objPtr
== NULL
) {
6930 stack
[stacklen
++] = objPtr
;
6931 Jim_IncrRefCount(objPtr
);
6932 } else if (opcode
== JIM_EXPROP_SUBST
) {
6933 if ((retcode
= Jim_SubstObj(interp
, expr
->obj
[i
],
6934 &objPtr
, JIM_NONE
)) != JIM_OK
)
6937 errRetCode
= retcode
;
6940 stack
[stacklen
++] = objPtr
;
6941 Jim_IncrRefCount(objPtr
);
6942 } else if (opcode
== JIM_EXPROP_DICTSUGAR
) {
6943 objPtr
= Jim_ExpandDictSugar(interp
, expr
->obj
[i
]);
6944 if (objPtr
== NULL
) {
6948 stack
[stacklen
++] = objPtr
;
6949 Jim_IncrRefCount(objPtr
);
6950 } else if (opcode
== JIM_EXPROP_COMMAND
) {
6951 if ((retcode
= Jim_EvalObj(interp
, expr
->obj
[i
])) != JIM_OK
) {
6953 errRetCode
= retcode
;
6956 stack
[stacklen
++] = interp
->result
;
6957 Jim_IncrRefCount(interp
->result
);
6958 } else if (opcode
>= JIM_EXPROP_BINARY_NUM_FIRST
&&
6959 opcode
<= JIM_EXPROP_BINARY_NUM_LAST
)
6961 /* Note that there isn't to increment the
6962 * refcount of objects. the references are moved
6963 * from stack to A and B. */
6964 B
= stack
[--stacklen
];
6965 A
= stack
[--stacklen
];
6967 /* --- Integer --- */
6968 if ((A
->typePtr
== &doubleObjType
&& !A
->bytes
) ||
6969 (B
->typePtr
== &doubleObjType
&& !B
->bytes
) ||
6970 JimGetWideNoErr(interp
, A
, &wA
) != JIM_OK
||
6971 JimGetWideNoErr(interp
, B
, &wB
) != JIM_OK
) {
6974 Jim_DecrRefCount(interp
, A
);
6975 Jim_DecrRefCount(interp
, B
);
6976 switch (expr
->opcode
[i
]) {
6977 case JIM_EXPROP_ADD
: wC
= wA
+ wB
; break;
6978 case JIM_EXPROP_SUB
: wC
= wA
-wB
; break;
6979 case JIM_EXPROP_MUL
: wC
= wA
*wB
; break;
6980 case JIM_EXPROP_LT
: wC
= wA
< wB
; break;
6981 case JIM_EXPROP_GT
: wC
= wA
> wB
; break;
6982 case JIM_EXPROP_LTE
: wC
= wA
<= wB
; break;
6983 case JIM_EXPROP_GTE
: wC
= wA
>= wB
; break;
6984 case JIM_EXPROP_LSHIFT
: wC
= wA
<< wB
; break;
6985 case JIM_EXPROP_RSHIFT
: wC
= wA
>> wB
; break;
6986 case JIM_EXPROP_NUMEQ
: wC
= wA
== wB
; break;
6987 case JIM_EXPROP_NUMNE
: wC
= wA
!= wB
; break;
6988 case JIM_EXPROP_BITAND
: wC
= wA
&wB
; break;
6989 case JIM_EXPROP_BITXOR
: wC
= wA
^wB
; break;
6990 case JIM_EXPROP_BITOR
: wC
= wA
| wB
; break;
6991 case JIM_EXPROP_POW
: wC
= JimPowWide(wA
,wB
); break;
6992 case JIM_EXPROP_LOGICAND_LEFT
:
7000 case JIM_EXPROP_LOGICOR_LEFT
:
7008 case JIM_EXPROP_DIV
:
7009 if (wB
== 0) goto divbyzero
;
7012 case JIM_EXPROP_MOD
:
7013 if (wB
== 0) goto divbyzero
;
7016 case JIM_EXPROP_ROTL
: {
7017 /* uint32_t would be better. But not everyone has inttypes.h?*/
7018 unsigned long uA
= (unsigned long)wA
;
7020 wC
= _rotl(uA
,(unsigned long)wB
);
7022 const unsigned int S
= sizeof(unsigned long) * 8;
7023 wC
= (unsigned long)((uA
<< wB
) | (uA
>> (S
-wB
)));
7027 case JIM_EXPROP_ROTR
: {
7028 unsigned long uA
= (unsigned long)wA
;
7030 wC
= _rotr(uA
,(unsigned long)wB
);
7032 const unsigned int S
= sizeof(unsigned long) * 8;
7033 wC
= (unsigned long)((uA
>> wB
) | (uA
<< (S
-wB
)));
7039 wC
= 0; /* avoid gcc warning */
7042 stack
[stacklen
] = Jim_NewIntObj(interp
, wC
);
7043 Jim_IncrRefCount(stack
[stacklen
]);
7047 /* --- Double --- */
7048 if (Jim_GetDouble(interp
, A
, &dA
) != JIM_OK
||
7049 Jim_GetDouble(interp
, B
, &dB
) != JIM_OK
) {
7051 /* Hmmm! For compatibility, maybe convert != and == into ne and eq */
7052 if (expr
->opcode
[i
] == JIM_EXPROP_NUMNE
) {
7053 opcode
= JIM_EXPROP_STRNE
;
7054 goto retry_as_string
;
7056 else if (expr
->opcode
[i
] == JIM_EXPROP_NUMEQ
) {
7057 opcode
= JIM_EXPROP_STREQ
;
7058 goto retry_as_string
;
7060 Jim_DecrRefCount(interp
, A
);
7061 Jim_DecrRefCount(interp
, B
);
7065 Jim_DecrRefCount(interp
, A
);
7066 Jim_DecrRefCount(interp
, B
);
7067 switch (expr
->opcode
[i
]) {
7068 case JIM_EXPROP_ROTL
:
7069 case JIM_EXPROP_ROTR
:
7070 case JIM_EXPROP_LSHIFT
:
7071 case JIM_EXPROP_RSHIFT
:
7072 case JIM_EXPROP_BITAND
:
7073 case JIM_EXPROP_BITXOR
:
7074 case JIM_EXPROP_BITOR
:
7075 case JIM_EXPROP_MOD
:
7076 case JIM_EXPROP_POW
:
7077 Jim_SetResultString(interp
,
7078 "Got floating-point value where integer was expected", -1);
7082 case JIM_EXPROP_ADD
: dC
= dA
+ dB
; break;
7083 case JIM_EXPROP_SUB
: dC
= dA
-dB
; break;
7084 case JIM_EXPROP_MUL
: dC
= dA
*dB
; break;
7085 case JIM_EXPROP_LT
: dC
= dA
< dB
; break;
7086 case JIM_EXPROP_GT
: dC
= dA
> dB
; break;
7087 case JIM_EXPROP_LTE
: dC
= dA
<= dB
; break;
7088 case JIM_EXPROP_GTE
: dC
= dA
>= dB
; break;
7089 case JIM_EXPROP_NUMEQ
: dC
= dA
== dB
; break;
7090 case JIM_EXPROP_NUMNE
: dC
= dA
!= dB
; break;
7091 case JIM_EXPROP_LOGICAND_LEFT
:
7099 case JIM_EXPROP_LOGICOR_LEFT
:
7107 case JIM_EXPROP_DIV
:
7108 if (dB
== 0) goto divbyzero
;
7112 dC
= 0; /* avoid gcc warning */
7115 stack
[stacklen
] = Jim_NewDoubleObj(interp
, dC
);
7116 Jim_IncrRefCount(stack
[stacklen
]);
7118 } else if (opcode
== JIM_EXPROP_STREQ
|| opcode
== JIM_EXPROP_STRNE
) {
7119 B
= stack
[--stacklen
];
7120 A
= stack
[--stacklen
];
7122 sA
= Jim_GetString(A
, &Alen
);
7123 sB
= Jim_GetString(B
, &Blen
);
7125 case JIM_EXPROP_STREQ
:
7126 if (Alen
== Blen
&& memcmp(sA
, sB
, Alen
) ==0)
7131 case JIM_EXPROP_STRNE
:
7132 if (Alen
!= Blen
|| memcmp(sA
, sB
, Alen
) != 0)
7138 wC
= 0; /* avoid gcc warning */
7141 Jim_DecrRefCount(interp
, A
);
7142 Jim_DecrRefCount(interp
, B
);
7143 stack
[stacklen
] = Jim_NewIntObj(interp
, wC
);
7144 Jim_IncrRefCount(stack
[stacklen
]);
7146 } else if (opcode
== JIM_EXPROP_NOT
||
7147 opcode
== JIM_EXPROP_BITNOT
||
7148 opcode
== JIM_EXPROP_LOGICAND_RIGHT
||
7149 opcode
== JIM_EXPROP_LOGICOR_RIGHT
) {
7150 /* Note that there isn't to increment the
7151 * refcount of objects. the references are moved
7152 * from stack to A and B. */
7153 A
= stack
[--stacklen
];
7155 /* --- Integer --- */
7156 if ((A
->typePtr
== &doubleObjType
&& !A
->bytes
) ||
7157 JimGetWideNoErr(interp
, A
, &wA
) != JIM_OK
) {
7158 goto trydouble_unary
;
7160 Jim_DecrRefCount(interp
, A
);
7161 switch (expr
->opcode
[i
]) {
7162 case JIM_EXPROP_NOT
: wC
= !wA
; break;
7163 case JIM_EXPROP_BITNOT
: wC
= ~wA
; break;
7164 case JIM_EXPROP_LOGICAND_RIGHT
:
7165 case JIM_EXPROP_LOGICOR_RIGHT
: wC
= (wA
!= 0); break;
7167 wC
= 0; /* avoid gcc warning */
7170 stack
[stacklen
] = Jim_NewIntObj(interp
, wC
);
7171 Jim_IncrRefCount(stack
[stacklen
]);
7175 /* --- Double --- */
7176 if (Jim_GetDouble(interp
, A
, &dA
) != JIM_OK
) {
7177 Jim_DecrRefCount(interp
, A
);
7181 Jim_DecrRefCount(interp
, A
);
7182 switch (expr
->opcode
[i
]) {
7183 case JIM_EXPROP_NOT
: dC
= !dA
; break;
7184 case JIM_EXPROP_LOGICAND_RIGHT
:
7185 case JIM_EXPROP_LOGICOR_RIGHT
: dC
= (dA
!= 0); break;
7186 case JIM_EXPROP_BITNOT
:
7187 Jim_SetResultString(interp
,
7188 "Got floating-point value where integer was expected", -1);
7193 dC
= 0; /* avoid gcc warning */
7196 stack
[stacklen
] = Jim_NewDoubleObj(interp
, dC
);
7197 Jim_IncrRefCount(stack
[stacklen
]);
7200 Jim_Panic(interp
,"Unknown opcode in Jim_EvalExpression");
7204 /* There is no need to decerement the inUse field because
7205 * this reference is transfered back into the exprObjPtr. */
7206 Jim_FreeIntRep(interp
, exprObjPtr
);
7207 exprObjPtr
->typePtr
= &exprObjType
;
7208 Jim_SetIntRepPtr(exprObjPtr
, expr
);
7209 Jim_DecrRefCount(interp
, exprObjPtr
);
7211 *exprResultPtrPtr
= stack
[0];
7212 Jim_IncrRefCount(stack
[0]);
7213 errRetCode
= JIM_OK
;
7215 for (i
= 0; i
< stacklen
; i
++) {
7216 Jim_DecrRefCount(interp
, stack
[i
]);
7218 if (stack
!= staticStack
)
7223 Jim_SetResultString(interp
, "Division by zero", -1);
7227 int Jim_GetBoolFromExpr(Jim_Interp
*interp
, Jim_Obj
*exprObjPtr
, int *boolPtr
)
7232 Jim_Obj
*exprResultPtr
;
7234 retcode
= Jim_EvalExpression(interp
, exprObjPtr
, &exprResultPtr
);
7235 if (retcode
!= JIM_OK
)
7237 if (JimGetWideNoErr(interp
, exprResultPtr
, &wideValue
) != JIM_OK
) {
7238 if (Jim_GetDouble(interp
, exprResultPtr
, &doubleValue
) != JIM_OK
)
7240 Jim_DecrRefCount(interp
, exprResultPtr
);
7243 Jim_DecrRefCount(interp
, exprResultPtr
);
7244 *boolPtr
= doubleValue
!= 0;
7248 Jim_DecrRefCount(interp
, exprResultPtr
);
7249 *boolPtr
= wideValue
!= 0;
7253 /* -----------------------------------------------------------------------------
7254 * ScanFormat String Object
7255 * ---------------------------------------------------------------------------*/
7257 /* This Jim_Obj will held a parsed representation of a format string passed to
7258 * the Jim_ScanString command. For error diagnostics, the scanformat string has
7259 * to be parsed in its entirely first and then, if correct, can be used for
7260 * scanning. To avoid endless re-parsing, the parsed representation will be
7261 * stored in an internal representation and re-used for performance reason. */
7263 /* A ScanFmtPartDescr will held the information of /one/ part of the whole
7264 * scanformat string. This part will later be used to extract information
7265 * out from the string to be parsed by Jim_ScanString */
7267 typedef struct ScanFmtPartDescr
{
7268 char type
; /* Type of conversion (e.g. c, d, f) */
7269 char modifier
; /* Modify type (e.g. l - long, h - short */
7270 size_t width
; /* Maximal width of input to be converted */
7271 int pos
; /* -1 - no assign, 0 - natural pos, >0 - XPG3 pos */
7272 char *arg
; /* Specification of a CHARSET conversion */
7273 char *prefix
; /* Prefix to be scanned literally before conversion */
7276 /* The ScanFmtStringObj will held the internal representation of a scanformat
7277 * string parsed and separated in part descriptions. Furthermore it contains
7278 * the original string representation of the scanformat string to allow for
7279 * fast update of the Jim_Obj's string representation part.
7281 * As add-on the internal object representation add some scratch pad area
7282 * for usage by Jim_ScanString to avoid endless allocating and freeing of
7283 * memory for purpose of string scanning.
7285 * The error member points to a static allocated string in case of a mal-
7286 * formed scanformat string or it contains '0' (NULL) in case of a valid
7287 * parse representation.
7289 * The whole memory of the internal representation is allocated as a single
7290 * area of memory that will be internally separated. So freeing and duplicating
7291 * of such an object is cheap */
7293 typedef struct ScanFmtStringObj
{
7294 jim_wide size
; /* Size of internal repr in bytes */
7295 char *stringRep
; /* Original string representation */
7296 size_t count
; /* Number of ScanFmtPartDescr contained */
7297 size_t convCount
; /* Number of conversions that will assign */
7298 size_t maxPos
; /* Max position index if XPG3 is used */
7299 const char *error
; /* Ptr to error text (NULL if no error */
7300 char *scratch
; /* Some scratch pad used by Jim_ScanString */
7301 ScanFmtPartDescr descr
[1]; /* The vector of partial descriptions */
7305 static void FreeScanFmtInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
7306 static void DupScanFmtInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
);
7307 static void UpdateStringOfScanFmt(Jim_Obj
*objPtr
);
7309 static Jim_ObjType scanFmtStringObjType
= {
7311 FreeScanFmtInternalRep
,
7312 DupScanFmtInternalRep
,
7313 UpdateStringOfScanFmt
,
7317 void FreeScanFmtInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
7319 JIM_NOTUSED(interp
);
7320 Jim_Free((char*)objPtr
->internalRep
.ptr
);
7321 objPtr
->internalRep
.ptr
= 0;
7324 void DupScanFmtInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
)
7326 size_t size
= (size_t)((ScanFmtStringObj
*)srcPtr
->internalRep
.ptr
)->size
;
7327 ScanFmtStringObj
*newVec
= (ScanFmtStringObj
*)Jim_Alloc(size
);
7329 JIM_NOTUSED(interp
);
7330 memcpy(newVec
, srcPtr
->internalRep
.ptr
, size
);
7331 dupPtr
->internalRep
.ptr
= newVec
;
7332 dupPtr
->typePtr
= &scanFmtStringObjType
;
7335 void UpdateStringOfScanFmt(Jim_Obj
*objPtr
)
7337 char *bytes
= ((ScanFmtStringObj
*)objPtr
->internalRep
.ptr
)->stringRep
;
7339 objPtr
->bytes
= Jim_StrDup(bytes
);
7340 objPtr
->length
= strlen(bytes
);
7343 /* SetScanFmtFromAny will parse a given string and create the internal
7344 * representation of the format specification. In case of an error
7345 * the error data member of the internal representation will be set
7346 * to an descriptive error text and the function will be left with
7347 * JIM_ERR to indicate unsucessful parsing (aka. malformed scanformat
7350 static int SetScanFmtFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
7352 ScanFmtStringObj
*fmtObj
;
7354 int maxCount
, i
, approxSize
, lastPos
= -1;
7355 const char *fmt
= objPtr
->bytes
;
7356 int maxFmtLen
= objPtr
->length
;
7357 const char *fmtEnd
= fmt
+ maxFmtLen
;
7360 Jim_FreeIntRep(interp
, objPtr
);
7361 /* Count how many conversions could take place maximally */
7362 for (i
= 0, maxCount
= 0; i
< maxFmtLen
; ++i
)
7365 /* Calculate an approximation of the memory necessary */
7366 approxSize
= sizeof(ScanFmtStringObj
) /* Size of the container */
7367 + (maxCount
+ 1) * sizeof(ScanFmtPartDescr
) /* Size of all partials */
7368 + maxFmtLen
* sizeof(char) + 3 + 1 /* Scratch + "%n" + '\0' */
7369 + maxFmtLen
* sizeof(char) + 1 /* Original stringrep */
7370 + maxFmtLen
* sizeof(char) /* Arg for CHARSETs */
7371 + (maxCount
+1) * sizeof(char) /* '\0' for every partial */
7372 + 1; /* safety byte */
7373 fmtObj
= (ScanFmtStringObj
*)Jim_Alloc(approxSize
);
7374 memset(fmtObj
, 0, approxSize
);
7375 fmtObj
->size
= approxSize
;
7377 fmtObj
->scratch
= (char*)&fmtObj
->descr
[maxCount
+ 1];
7378 fmtObj
->stringRep
= fmtObj
->scratch
+ maxFmtLen
+ 3 + 1;
7379 memcpy(fmtObj
->stringRep
, fmt
, maxFmtLen
);
7380 buffer
= fmtObj
->stringRep
+ maxFmtLen
+ 1;
7381 objPtr
->internalRep
.ptr
= fmtObj
;
7382 objPtr
->typePtr
= &scanFmtStringObjType
;
7383 for (i
= 0, curr
= 0; fmt
< fmtEnd
; ++fmt
) {
7384 int width
= 0, skip
;
7385 ScanFmtPartDescr
*descr
= &fmtObj
->descr
[curr
];
7387 descr
->width
= 0; /* Assume width unspecified */
7388 /* Overread and store any "literal" prefix */
7389 if (*fmt
!= '%' || fmt
[1] == '%') {
7391 descr
->prefix
= &buffer
[i
];
7392 for (; fmt
< fmtEnd
; ++fmt
) {
7394 if (fmt
[1] != '%') break;
7401 /* Skip the conversion introducing '%' sign */
7403 /* End reached due to non-conversion literal only? */
7406 descr
->pos
= 0; /* Assume "natural" positioning */
7408 descr
->pos
= -1; /* Okay, conversion will not be assigned */
7411 fmtObj
->convCount
++; /* Otherwise count as assign-conversion */
7412 /* Check if next token is a number (could be width or pos */
7413 if (sscanf(fmt
, "%d%n", &width
, &skip
) == 1) {
7415 /* Was the number a XPG3 position specifier? */
7416 if (descr
->pos
!= -1 && *fmt
== '$') {
7421 /* Look if "natural" postioning and XPG3 one was mixed */
7422 if ((lastPos
== 0 && descr
->pos
> 0)
7423 || (lastPos
> 0 && descr
->pos
== 0)) {
7424 fmtObj
->error
= "cannot mix \"%\" and \"%n$\" conversion specifiers";
7427 /* Look if this position was already used */
7428 for (prev
= 0; prev
< curr
; ++prev
) {
7429 if (fmtObj
->descr
[prev
].pos
== -1) continue;
7430 if (fmtObj
->descr
[prev
].pos
== descr
->pos
) {
7431 fmtObj
->error
= "same \"%n$\" conversion specifier "
7432 "used more than once";
7436 /* Try to find a width after the XPG3 specifier */
7437 if (sscanf(fmt
, "%d%n", &width
, &skip
) == 1) {
7438 descr
->width
= width
;
7441 if (descr
->pos
> 0 && (size_t)descr
->pos
> fmtObj
->maxPos
)
7442 fmtObj
->maxPos
= descr
->pos
;
7444 /* Number was not a XPG3, so it has to be a width */
7445 descr
->width
= width
;
7448 /* If positioning mode was undetermined yet, fix this */
7450 lastPos
= descr
->pos
;
7451 /* Handle CHARSET conversion type ... */
7453 int swapped
= 1, beg
= i
, end
, j
;
7455 descr
->arg
= &buffer
[i
];
7457 if (*fmt
== '^') buffer
[i
++] = *fmt
++;
7458 if (*fmt
== ']') buffer
[i
++] = *fmt
++;
7459 while (*fmt
&& *fmt
!= ']') buffer
[i
++] = *fmt
++;
7461 fmtObj
->error
= "unmatched [ in format string";
7466 /* In case a range fence was given "backwards", swap it */
7469 for (j
= beg
+ 1; j
< end
-1; ++j
) {
7470 if (buffer
[j
] == '-' && buffer
[j
-1] > buffer
[j
+ 1]) {
7471 char tmp
= buffer
[j
-1];
7472 buffer
[j
-1] = buffer
[j
+ 1];
7473 buffer
[j
+ 1] = tmp
;
7479 /* Remember any valid modifier if given */
7480 if (strchr("hlL", *fmt
) != 0)
7481 descr
->modifier
= tolower((int)*fmt
++);
7484 if (strchr("efgcsndoxui", *fmt
) == 0) {
7485 fmtObj
->error
= "bad scan conversion character";
7487 } else if (*fmt
== 'c' && descr
->width
!= 0) {
7488 fmtObj
->error
= "field width may not be specified in %c "
7491 } else if (*fmt
== 'u' && descr
->modifier
== 'l') {
7492 fmtObj
->error
= "unsigned wide not supported";
7499 if (fmtObj
->convCount
== 0) {
7500 fmtObj
->error
= "no any conversion specifier given";
7506 /* Some accessor macros to allow lowlevel access to fields of internal repr */
7508 #define FormatGetCnvCount(_fo_) \
7509 ((ScanFmtStringObj*)((_fo_)->internalRep.ptr))->convCount
7510 #define FormatGetMaxPos(_fo_) \
7511 ((ScanFmtStringObj*)((_fo_)->internalRep.ptr))->maxPos
7512 #define FormatGetError(_fo_) \
7513 ((ScanFmtStringObj*)((_fo_)->internalRep.ptr))->error
7515 /* Some Bit testing/setting/cleaning routines. For now only used in handling
7516 * charsets ([a-z123]) within scanning. Later on perhaps a base for a
7517 * bitvector implementation in Jim? */
7519 static int JimTestBit(const char *bitvec
, char ch
)
7521 div_t pos
= div(ch
-1, 8);
7522 return bitvec
[pos
.quot
] & (1 << pos
.rem
);
7525 static void JimSetBit(char *bitvec
, char ch
)
7527 div_t pos
= div(ch
-1, 8);
7528 bitvec
[pos
.quot
] |= (1 << pos
.rem
);
7531 #if 0 /* currently not used */
7532 static void JimClearBit(char *bitvec
, char ch
)
7534 div_t pos
= div(ch
-1, 8);
7535 bitvec
[pos
.quot
] &= ~(1 << pos
.rem
);
7539 /* JimScanAString is used to scan an unspecified string that ends with
7540 * next WS, or a string that is specified via a charset. The charset
7541 * is currently implemented in a way to only allow for usage with
7542 * ASCII. Whenever we will switch to UNICODE, another idea has to
7545 * FIXME: Works only with ASCII */
7548 JimScanAString(Jim_Interp
*interp
, const char *sdescr
, const char *str
)
7552 char charset
[256/8 + 1]; /* A Charset may contain max 256 chars */
7553 char *buffer
= Jim_Alloc(strlen(str
) + 1), *anchor
= buffer
;
7555 /* First init charset to nothing or all, depending if a specified
7556 * or an unspecified string has to be parsed */
7557 memset(charset
, (sdescr
? 0 : 255), sizeof(charset
));
7559 /* There was a set description given, that means we are parsing
7560 * a specified string. So we have to build a corresponding
7561 * charset reflecting the description */
7563 /* Should the set be negated at the end? */
7564 if (*sdescr
== '^') {
7568 /* Here '-' is meant literally and not to define a range */
7569 if (*sdescr
== '-') {
7570 JimSetBit(charset
, '-');
7574 if (sdescr
[1] == '-' && sdescr
[2] != 0) {
7575 /* Handle range definitions */
7577 for (i
= sdescr
[0]; i
<= sdescr
[2]; ++i
)
7578 JimSetBit(charset
, (char)i
);
7581 /* Handle verbatim character definitions */
7582 JimSetBit(charset
, *sdescr
++);
7585 /* Negate the charset if there was a NOT given */
7586 for (i
= 0; notFlag
&& i
< sizeof(charset
); ++i
)
7587 charset
[i
] = ~charset
[i
];
7589 /* And after all the mess above, the real work begin ... */
7590 while (str
&& *str
) {
7591 if (!sdescr
&& isspace((int)*str
))
7592 break; /* EOS via WS if unspecified */
7593 if (JimTestBit(charset
, *str
)) *buffer
++ = *str
++;
7594 else break; /* EOS via mismatch if specified scanning */
7596 *buffer
= 0; /* Close the string properly ... */
7597 result
= Jim_NewStringObj(interp
, anchor
, -1);
7598 Jim_Free(anchor
); /* ... and free it afer usage */
7602 /* ScanOneEntry will scan one entry out of the string passed as argument.
7603 * It use the sscanf() function for this task. After extracting and
7604 * converting of the value, the count of scanned characters will be
7605 * returned of -1 in case of no conversion tool place and string was
7606 * already scanned thru */
7608 static int ScanOneEntry(Jim_Interp
*interp
, const char *str
, long pos
,
7609 ScanFmtStringObj
*fmtObj
, long index
, Jim_Obj
**valObjPtr
)
7611 # define MAX_SIZE (sizeof(jim_wide) > sizeof(double) \
7612 ? sizeof(jim_wide) \
7614 char buffer
[MAX_SIZE
];
7615 char *value
= buffer
;
7617 const ScanFmtPartDescr
*descr
= &fmtObj
->descr
[index
];
7618 size_t sLen
= strlen(&str
[pos
]), scanned
= 0;
7619 size_t anchor
= pos
;
7622 /* First pessimiticly assume, we will not scan anything :-) */
7624 if (descr
->prefix
) {
7625 /* There was a prefix given before the conversion, skip it and adjust
7626 * the string-to-be-parsed accordingly */
7627 for (i
= 0; str
[pos
] && descr
->prefix
[i
]; ++i
) {
7628 /* If prefix require, skip WS */
7629 if (isspace((int)descr
->prefix
[i
]))
7630 while (str
[pos
] && isspace((int)str
[pos
])) ++pos
;
7631 else if (descr
->prefix
[i
] != str
[pos
])
7632 break; /* Prefix do not match here, leave the loop */
7634 ++pos
; /* Prefix matched so far, next round */
7637 return -1; /* All of str consumed: EOF condition */
7638 else if (descr
->prefix
[i
] != 0)
7639 return 0; /* Not whole prefix consumed, no conversion possible */
7641 /* For all but following conversion, skip leading WS */
7642 if (descr
->type
!= 'c' && descr
->type
!= '[' && descr
->type
!= 'n')
7643 while (isspace((int)str
[pos
])) ++pos
;
7644 /* Determine how much skipped/scanned so far */
7645 scanned
= pos
- anchor
;
7646 if (descr
->type
== 'n') {
7647 /* Return pseudo conversion means: how much scanned so far? */
7648 *valObjPtr
= Jim_NewIntObj(interp
, anchor
+ scanned
);
7649 } else if (str
[pos
] == 0) {
7650 /* Cannot scan anything, as str is totally consumed */
7653 /* Processing of conversions follows ... */
7654 if (descr
->width
> 0) {
7655 /* Do not try to scan as fas as possible but only the given width.
7656 * To ensure this, we copy the part that should be scanned. */
7657 size_t tLen
= descr
->width
> sLen
? sLen
: descr
->width
;
7658 tok
= Jim_StrDupLen(&str
[pos
], tLen
);
7660 /* As no width was given, simply refer to the original string */
7663 switch (descr
->type
) {
7665 *valObjPtr
= Jim_NewIntObj(interp
, *tok
);
7668 case 'd': case 'o': case 'x': case 'u': case 'i': {
7669 jim_wide jwvalue
= 0;
7671 char *endp
; /* Position where the number finished */
7672 int base
= descr
->type
== 'o' ? 8
7673 : descr
->type
== 'x' ? 16
7674 : descr
->type
== 'i' ? 0
7678 /* Try to scan a number with the given base */
7679 if (descr
->modifier
== 'l')
7681 #ifdef HAVE_LONG_LONG_INT
7682 jwvalue
= JimStrtoll(tok
, &endp
, base
),
7684 jwvalue
= strtol(tok
, &endp
, base
),
7686 memcpy(value
, &jwvalue
, sizeof(jim_wide
));
7690 if (descr
->type
== 'u')
7691 lvalue
= strtoul(tok
, &endp
, base
);
7693 lvalue
= strtol(tok
, &endp
, base
);
7694 memcpy(value
, &lvalue
, sizeof(lvalue
));
7696 /* If scanning failed, and base was undetermined, simply
7697 * put it to 10 and try once more. This should catch the
7698 * case where %i begin to parse a number prefix (e.g.
7699 * '0x' but no further digits follows. This will be
7700 * handled as a ZERO followed by a char 'x' by Tcl */
7701 if (endp
== tok
&& base
== 0) base
= 10;
7705 /* There was some number sucessfully scanned! */
7706 if (descr
->modifier
== 'l')
7707 *valObjPtr
= Jim_NewIntObj(interp
, jwvalue
);
7709 *valObjPtr
= Jim_NewIntObj(interp
, lvalue
);
7710 /* Adjust the number-of-chars scanned so far */
7711 scanned
+= endp
- tok
;
7713 /* Nothing was scanned. We have to determine if this
7714 * happened due to e.g. prefix mismatch or input str
7716 scanned
= *tok
? 0 : -1;
7720 case 's': case '[': {
7721 *valObjPtr
= JimScanAString(interp
, descr
->arg
, tok
);
7722 scanned
+= Jim_Length(*valObjPtr
);
7725 case 'e': case 'f': case 'g': {
7728 double dvalue
= strtod(tok
, &endp
);
7729 memcpy(value
, &dvalue
, sizeof(double));
7731 /* There was some number sucessfully scanned! */
7732 *valObjPtr
= Jim_NewDoubleObj(interp
, dvalue
);
7733 /* Adjust the number-of-chars scanned so far */
7734 scanned
+= endp
- tok
;
7736 /* Nothing was scanned. We have to determine if this
7737 * happened due to e.g. prefix mismatch or input str
7739 scanned
= *tok
? 0 : -1;
7744 /* If a substring was allocated (due to pre-defined width) do not
7745 * forget to free it */
7746 if (tok
!= &str
[pos
])
7747 Jim_Free((char*)tok
);
7752 /* Jim_ScanString is the workhorse of string scanning. It will scan a given
7753 * string and returns all converted (and not ignored) values in a list back
7754 * to the caller. If an error occured, a NULL pointer will be returned */
7756 Jim_Obj
*Jim_ScanString(Jim_Interp
*interp
, Jim_Obj
*strObjPtr
,
7757 Jim_Obj
*fmtObjPtr
, int flags
)
7761 const char *str
= Jim_GetString(strObjPtr
, 0);
7762 Jim_Obj
*resultList
= 0;
7763 Jim_Obj
**resultVec
=NULL
;
7765 Jim_Obj
*emptyStr
= 0;
7766 ScanFmtStringObj
*fmtObj
;
7768 /* If format specification is not an object, convert it! */
7769 if (fmtObjPtr
->typePtr
!= &scanFmtStringObjType
)
7770 SetScanFmtFromAny(interp
, fmtObjPtr
);
7771 fmtObj
= (ScanFmtStringObj
*)fmtObjPtr
->internalRep
.ptr
;
7772 /* Check if format specification was valid */
7773 if (fmtObj
->error
!= 0) {
7774 if (flags
& JIM_ERRMSG
)
7775 Jim_SetResultString(interp
, fmtObj
->error
, -1);
7778 /* Allocate a new "shared" empty string for all unassigned conversions */
7779 emptyStr
= Jim_NewEmptyStringObj(interp
);
7780 Jim_IncrRefCount(emptyStr
);
7781 /* Create a list and fill it with empty strings up to max specified XPG3 */
7782 resultList
= Jim_NewListObj(interp
, 0, 0);
7783 if (fmtObj
->maxPos
> 0) {
7784 for (i
= 0; i
< fmtObj
->maxPos
; ++i
)
7785 Jim_ListAppendElement(interp
, resultList
, emptyStr
);
7786 JimListGetElements(interp
, resultList
, &resultc
, &resultVec
);
7788 /* Now handle every partial format description */
7789 for (i
= 0, pos
= 0; i
< fmtObj
->count
; ++i
) {
7790 ScanFmtPartDescr
*descr
= &(fmtObj
->descr
[i
]);
7792 /* Only last type may be "literal" w/o conversion - skip it! */
7793 if (descr
->type
== 0) continue;
7794 /* As long as any conversion could be done, we will proceed */
7796 scanned
= ScanOneEntry(interp
, str
, pos
, fmtObj
, i
, &value
);
7797 /* In case our first try results in EOF, we will leave */
7798 if (scanned
== -1 && i
== 0)
7800 /* Advance next pos-to-be-scanned for the amount scanned already */
7802 /* value == 0 means no conversion took place so take empty string */
7804 value
= Jim_NewEmptyStringObj(interp
);
7805 /* If value is a non-assignable one, skip it */
7806 if (descr
->pos
== -1) {
7807 Jim_FreeNewObj(interp
, value
);
7808 } else if (descr
->pos
== 0)
7809 /* Otherwise append it to the result list if no XPG3 was given */
7810 Jim_ListAppendElement(interp
, resultList
, value
);
7811 else if (resultVec
[descr
->pos
-1] == emptyStr
) {
7812 /* But due to given XPG3, put the value into the corr. slot */
7813 Jim_DecrRefCount(interp
, resultVec
[descr
->pos
-1]);
7814 Jim_IncrRefCount(value
);
7815 resultVec
[descr
->pos
-1] = value
;
7817 /* Otherwise, the slot was already used - free obj and ERROR */
7818 Jim_FreeNewObj(interp
, value
);
7822 Jim_DecrRefCount(interp
, emptyStr
);
7825 Jim_DecrRefCount(interp
, emptyStr
);
7826 Jim_FreeNewObj(interp
, resultList
);
7827 return (Jim_Obj
*)EOF
;
7829 Jim_DecrRefCount(interp
, emptyStr
);
7830 Jim_FreeNewObj(interp
, resultList
);
7834 /* -----------------------------------------------------------------------------
7835 * Pseudo Random Number Generation
7836 * ---------------------------------------------------------------------------*/
7837 static void JimPrngSeed(Jim_Interp
*interp
, const unsigned char *seed
,
7840 /* Initialize the sbox with the numbers from 0 to 255 */
7841 static void JimPrngInit(Jim_Interp
*interp
)
7844 unsigned int seed
[256];
7846 interp
->prngState
= Jim_Alloc(sizeof(Jim_PrngState
));
7847 for (i
= 0; i
< 256; i
++)
7848 seed
[i
] = (rand() ^ time(NULL
) ^ clock());
7849 JimPrngSeed(interp
, (unsigned char*) seed
, sizeof(int)*256);
7852 /* Generates N bytes of random data */
7853 static void JimRandomBytes(Jim_Interp
*interp
, void *dest
, unsigned int len
)
7855 Jim_PrngState
*prng
;
7856 unsigned char *destByte
= (unsigned char*) dest
;
7857 unsigned int si
, sj
, x
;
7859 /* initialization, only needed the first time */
7860 if (interp
->prngState
== NULL
)
7861 JimPrngInit(interp
);
7862 prng
= interp
->prngState
;
7863 /* generates 'len' bytes of pseudo-random numbers */
7864 for (x
= 0; x
< len
; x
++) {
7865 prng
->i
= (prng
->i
+ 1) & 0xff;
7866 si
= prng
->sbox
[prng
->i
];
7867 prng
->j
= (prng
->j
+ si
) & 0xff;
7868 sj
= prng
->sbox
[prng
->j
];
7869 prng
->sbox
[prng
->i
] = sj
;
7870 prng
->sbox
[prng
->j
] = si
;
7871 *destByte
++ = prng
->sbox
[(si
+ sj
)&0xff];
7875 /* Re-seed the generator with user-provided bytes */
7876 static void JimPrngSeed(Jim_Interp
*interp
, const unsigned char *seed
,
7880 unsigned char buf
[256];
7881 Jim_PrngState
*prng
;
7883 /* initialization, only needed the first time */
7884 if (interp
->prngState
== NULL
)
7885 JimPrngInit(interp
);
7886 prng
= interp
->prngState
;
7888 /* Set the sbox[i] with i */
7889 for (i
= 0; i
< 256; i
++)
7891 /* Now use the seed to perform a random permutation of the sbox */
7892 for (i
= 0; i
< seedLen
; i
++) {
7895 t
= prng
->sbox
[i
&0xFF];
7896 prng
->sbox
[i
&0xFF] = prng
->sbox
[seed
[i
]];
7897 prng
->sbox
[seed
[i
]] = t
;
7899 prng
->i
= prng
->j
= 0;
7900 /* discard the first 256 bytes of stream. */
7901 JimRandomBytes(interp
, buf
, 256);
7904 /* -----------------------------------------------------------------------------
7905 * Dynamic libraries support (WIN32 not supported)
7906 * ---------------------------------------------------------------------------*/
7911 void * dlopen(const char *path
, int mode
)
7915 return (void *)LoadLibraryA(path
);
7917 int dlclose(void *handle
)
7919 FreeLibrary((HANDLE
)handle
);
7922 void *dlsym(void *handle
, const char *symbol
)
7924 return GetProcAddress((HMODULE
)handle
, symbol
);
7926 static char win32_dlerror_string
[121];
7927 const char *dlerror(void)
7929 FormatMessageA(FORMAT_MESSAGE_FROM_SYSTEM
, NULL
, GetLastError(),
7930 LANG_NEUTRAL
, win32_dlerror_string
, 120, NULL
);
7931 return win32_dlerror_string
;
7935 int Jim_LoadLibrary(Jim_Interp
*interp
, const char *pathName
)
7937 Jim_Obj
*libPathObjPtr
;
7940 int (*onload
)(Jim_Interp
*interp
);
7942 libPathObjPtr
= Jim_GetGlobalVariableStr(interp
, "jim_libpath", JIM_NONE
);
7943 if (libPathObjPtr
== NULL
) {
7945 libPathObjPtr
= NULL
;
7947 Jim_IncrRefCount(libPathObjPtr
);
7948 Jim_ListLength(interp
, libPathObjPtr
, &prefixc
);
7951 for (i
= -1; i
< prefixc
; i
++) {
7953 handle
= dlopen(pathName
, RTLD_LAZY
);
7956 char buf
[JIM_PATH_LEN
];
7959 Jim_Obj
*prefixObjPtr
;
7962 if (Jim_ListIndex(interp
, libPathObjPtr
, i
,
7963 &prefixObjPtr
, JIM_NONE
) != JIM_OK
)
7965 prefix
= Jim_GetString(prefixObjPtr
, &prefixlen
);
7966 if (prefixlen
+ strlen(pathName
) + 1 >= JIM_PATH_LEN
)
7968 if (*pathName
== '/') {
7969 strcpy(buf
, pathName
);
7971 else if (prefixlen
&& prefix
[prefixlen
-1] == '/')
7972 sprintf(buf
, "%s%s", prefix
, pathName
);
7974 sprintf(buf
, "%s/%s", prefix
, pathName
);
7975 fp
= fopen(buf
, "r");
7979 handle
= dlopen(buf
, RTLD_LAZY
);
7981 if (handle
== NULL
) {
7982 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
7983 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
7984 "error loading extension \"", pathName
,
7985 "\": ", dlerror(), NULL
);
7990 onload
= (int(*)(Jim_Interp
*))(uintptr_t)dlsym(handle
, "Jim_OnLoad");
7991 if (onload
== NULL
) {
7992 Jim_SetResultString(interp
,
7993 "No Jim_OnLoad symbol found on extension", -1);
7996 if (onload(interp
) == JIM_ERR
) {
8000 Jim_SetEmptyResult(interp
);
8001 if (libPathObjPtr
!= NULL
)
8002 Jim_DecrRefCount(interp
, libPathObjPtr
);
8006 if (libPathObjPtr
!= NULL
)
8007 Jim_DecrRefCount(interp
, libPathObjPtr
);
8010 #else /* JIM_DYNLIB */
8011 int Jim_LoadLibrary(Jim_Interp
*interp
, const char *pathName
)
8013 JIM_NOTUSED(interp
);
8014 JIM_NOTUSED(pathName
);
8016 Jim_SetResultString(interp
, "the Jim binary has no support for [load]", -1);
8019 #endif/* JIM_DYNLIB */
8021 /* -----------------------------------------------------------------------------
8023 * ---------------------------------------------------------------------------*/
8025 #define JIM_PKG_ANY_VERSION -1
8027 /* Convert a string of the type "1.2" into an integer.
8028 * MAJOR.MINOR is converted as MAJOR*100 + MINOR, so "1.2" is converted
8029 * to the integer with value 102 */
8030 static int JimPackageVersionToInt(Jim_Interp
*interp
, const char *v
,
8031 int *intPtr
, int flags
)
8034 jim_wide major
, minor
;
8035 char *majorStr
, *minorStr
, *p
;
8038 *intPtr
= JIM_PKG_ANY_VERSION
;
8042 copy
= Jim_StrDup(v
);
8043 p
= strchr(copy
, '.');
8044 if (p
== NULL
) goto badfmt
;
8049 if (Jim_StringToWide(majorStr
, &major
, 10) != JIM_OK
||
8050 Jim_StringToWide(minorStr
, &minor
, 10) != JIM_OK
)
8052 *intPtr
= (int)(major
*100 + minor
);
8058 if (flags
& JIM_ERRMSG
) {
8059 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
8060 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
8061 "invalid package version '", v
, "'", NULL
);
8066 #define JIM_MATCHVER_EXACT (1 << JIM_PRIV_FLAG_SHIFT)
8067 static int JimPackageMatchVersion(int needed
, int actual
, int flags
)
8069 if (needed
== JIM_PKG_ANY_VERSION
) return 1;
8070 if (flags
& JIM_MATCHVER_EXACT
) {
8071 return needed
== actual
;
8073 return needed
/100 == actual
/100 && (needed
<= actual
);
8077 int Jim_PackageProvide(Jim_Interp
*interp
, const char *name
, const char *ver
,
8081 /* Check if the version format is ok */
8082 if (JimPackageVersionToInt(interp
, ver
, &intVersion
, JIM_ERRMSG
) != JIM_OK
)
8084 /* If the package was already provided returns an error. */
8085 if (Jim_FindHashEntry(&interp
->packages
, name
) != NULL
) {
8086 if (flags
& JIM_ERRMSG
) {
8087 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
8088 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
8089 "package '", name
, "' was already provided", NULL
);
8093 Jim_AddHashEntry(&interp
->packages
, name
, (char*) ver
);
8100 # include <sys/types.h>
8101 # include <dirent.h>
8104 /* Posix dirent.h compatiblity layer for WIN32.
8105 * Copyright Kevlin Henney, 1997, 2003. All rights reserved.
8106 * Copyright Salvatore Sanfilippo ,2005.
8108 * Permission to use, copy, modify, and distribute this software and its
8109 * documentation for any purpose is hereby granted without fee, provided
8110 * that this copyright and permissions notice appear in all copies and
8113 * This software is supplied "as is" without express or implied warranty.
8114 * This software was modified by Salvatore Sanfilippo for the Jim Interpreter.
8121 typedef struct DIR {
8122 long handle
; /* -1 for failed rewind */
8123 struct _finddata_t info
;
8124 struct dirent result
; /* d_name null iff first time */
8125 char *name
; /* null-terminated char string */
8128 DIR *opendir(const char *name
)
8132 if (name
&& name
[0]) {
8133 size_t base_length
= strlen(name
);
8134 const char *all
= /* search pattern must end with suitable wildcard */
8135 strchr("/\\", name
[base_length
- 1]) ? "*" : "/*";
8137 if ((dir
= (DIR *) Jim_Alloc(sizeof *dir
)) != 0 &&
8138 (dir
->name
= (char *) Jim_Alloc(base_length
+ strlen(all
) + 1)) != 0)
8140 strcat(strcpy(dir
->name
, name
), all
);
8142 if ((dir
->handle
= (long) _findfirst(dir
->name
, &dir
->info
)) != -1)
8143 dir
->result
.d_name
= 0;
8144 else { /* rollback */
8145 Jim_Free(dir
->name
);
8149 } else { /* rollback */
8160 int closedir(DIR *dir
)
8165 if (dir
->handle
!= -1)
8166 result
= _findclose(dir
->handle
);
8167 Jim_Free(dir
->name
);
8170 if (result
== -1) /* map all errors to EBADF */
8175 struct dirent
*readdir(DIR *dir
)
8177 struct dirent
*result
= 0;
8179 if (dir
&& dir
->handle
!= -1) {
8180 if (!dir
->result
.d_name
|| _findnext(dir
->handle
, &dir
->info
) != -1) {
8181 result
= &dir
->result
;
8182 result
->d_name
= dir
->info
.name
;
8192 static char *JimFindBestPackage(Jim_Interp
*interp
, char **prefixes
,
8193 int prefixc
, const char *pkgName
, int pkgVer
, int flags
)
8195 int bestVer
= -1, i
;
8196 int pkgNameLen
= strlen(pkgName
);
8197 char *bestPackage
= NULL
;
8200 for (i
= 0; i
< prefixc
; i
++) {
8202 char buf
[JIM_PATH_LEN
];
8205 if (prefixes
[i
] == NULL
) continue;
8206 strncpy(buf
, prefixes
[i
], JIM_PATH_LEN
);
8207 buf
[JIM_PATH_LEN
-1] = '\0';
8208 prefixLen
= strlen(buf
);
8209 if (prefixLen
&& buf
[prefixLen
-1] == '/')
8210 buf
[prefixLen
-1] = '\0';
8212 if ((dir
= opendir(buf
)) == NULL
) continue;
8213 while ((de
= readdir(dir
)) != NULL
) {
8214 char *fileName
= de
->d_name
;
8215 int fileNameLen
= strlen(fileName
);
8217 if (strncmp(fileName
, "jim-", 4) == 0 &&
8218 strncmp(fileName
+ 4, pkgName
, pkgNameLen
) == 0 &&
8219 *(fileName
+ 4+pkgNameLen
) == '-' &&
8220 fileNameLen
> 4 && /* note that this is not really useful */
8221 (strncmp(fileName
+ fileNameLen
-4, ".tcl", 4) == 0 ||
8222 strncmp(fileName
+ fileNameLen
-4, ".dll", 4) == 0 ||
8223 strncmp(fileName
+ fileNameLen
-3, ".so", 3) == 0))
8225 char ver
[6]; /* xx.yy < nulterm> */
8226 char *p
= strrchr(fileName
, '.');
8227 int verLen
, fileVer
;
8229 verLen
= p
- (fileName
+ 4+pkgNameLen
+ 1);
8230 if (verLen
< 3 || verLen
> 5) continue;
8231 memcpy(ver
, fileName
+ 4+pkgNameLen
+ 1, verLen
);
8233 if (JimPackageVersionToInt(interp
, ver
, &fileVer
, JIM_NONE
)
8234 != JIM_OK
) continue;
8235 if (JimPackageMatchVersion(pkgVer
, fileVer
, flags
) &&
8236 (bestVer
== -1 || bestVer
< fileVer
))
8239 Jim_Free(bestPackage
);
8240 bestPackage
= Jim_Alloc(strlen(buf
) + strlen(fileName
) + 2);
8241 sprintf(bestPackage
, "%s/%s", buf
, fileName
);
8250 #else /* JIM_ANSIC */
8252 static char *JimFindBestPackage(Jim_Interp
*interp
, char **prefixes
,
8253 int prefixc
, const char *pkgName
, int pkgVer
, int flags
)
8255 JIM_NOTUSED(interp
);
8256 JIM_NOTUSED(prefixes
);
8257 JIM_NOTUSED(prefixc
);
8258 JIM_NOTUSED(pkgName
);
8259 JIM_NOTUSED(pkgVer
);
8264 #endif /* JIM_ANSIC */
8266 /* Search for a suitable package under every dir specified by jim_libpath
8267 * and load it if possible. If a suitable package was loaded with success
8268 * JIM_OK is returned, otherwise JIM_ERR is returned. */
8269 static int JimLoadPackage(Jim_Interp
*interp
, const char *name
, int ver
,
8272 Jim_Obj
*libPathObjPtr
;
8273 char **prefixes
, *best
;
8274 int prefixc
, i
, retCode
= JIM_OK
;
8276 libPathObjPtr
= Jim_GetGlobalVariableStr(interp
, "jim_libpath", JIM_NONE
);
8277 if (libPathObjPtr
== NULL
) {
8279 libPathObjPtr
= NULL
;
8281 Jim_IncrRefCount(libPathObjPtr
);
8282 Jim_ListLength(interp
, libPathObjPtr
, &prefixc
);
8285 prefixes
= Jim_Alloc(sizeof(char*)*prefixc
);
8286 for (i
= 0; i
< prefixc
; i
++) {
8287 Jim_Obj
*prefixObjPtr
;
8288 if (Jim_ListIndex(interp
, libPathObjPtr
, i
,
8289 &prefixObjPtr
, JIM_NONE
) != JIM_OK
)
8294 prefixes
[i
] = Jim_StrDup(Jim_GetString(prefixObjPtr
, NULL
));
8296 /* Scan every directory to find the "best" package. */
8297 best
= JimFindBestPackage(interp
, prefixes
, prefixc
, name
, ver
, flags
);
8299 char *p
= strrchr(best
, '.');
8300 /* Try to load/source it */
8301 if (p
&& strcmp(p
, ".tcl") == 0) {
8302 retCode
= Jim_EvalFile(interp
, best
);
8304 retCode
= Jim_LoadLibrary(interp
, best
);
8310 for (i
= 0; i
< prefixc
; i
++)
8311 Jim_Free(prefixes
[i
]);
8314 Jim_DecrRefCount(interp
, libPathObjPtr
);
8318 const char *Jim_PackageRequire(Jim_Interp
*interp
, const char *name
,
8319 const char *ver
, int flags
)
8324 /* Start with an empty error string */
8325 Jim_SetResultString(interp
, "", 0);
8327 if (JimPackageVersionToInt(interp
, ver
, &requiredVer
, JIM_ERRMSG
) != JIM_OK
)
8329 he
= Jim_FindHashEntry(&interp
->packages
, name
);
8331 /* Try to load the package. */
8332 if (JimLoadPackage(interp
, name
, requiredVer
, flags
) == JIM_OK
) {
8333 he
= Jim_FindHashEntry(&interp
->packages
, name
);
8339 /* No way... return an error. */
8340 if (flags
& JIM_ERRMSG
) {
8342 Jim_GetString(Jim_GetResult(interp
), &len
);
8343 Jim_AppendStrings(interp
, Jim_GetResult(interp
), len
? "\n" : "",
8344 "Can't find package '", name
, "'", NULL
);
8349 if (JimPackageVersionToInt(interp
, he
->val
, &actualVer
, JIM_ERRMSG
)
8354 /* Check if version matches. */
8355 if (JimPackageMatchVersion(requiredVer
, actualVer
, flags
) == 0) {
8356 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
8357 "Package '", name
, "' already loaded, but with version ",
8365 /* -----------------------------------------------------------------------------
8367 * ---------------------------------------------------------------------------*/
8368 #define JIM_EVAL_SARGV_LEN 8 /* static arguments vector length */
8369 #define JIM_EVAL_SINTV_LEN 8 /* static interpolation vector length */
8371 static int JimCallProcedure(Jim_Interp
*interp
, Jim_Cmd
*cmd
, int argc
,
8372 Jim_Obj
*const *argv
);
8374 /* Handle calls to the [unknown] command */
8375 static int JimUnknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
8377 Jim_Obj
**v
, *sv
[JIM_EVAL_SARGV_LEN
];
8380 /* If JimUnknown() is recursively called (e.g. error in the unknown proc,
8383 if (interp
->unknown_called
) {
8387 /* If the [unknown] command does not exists returns
8389 if (Jim_GetCommand(interp
, interp
->unknown
, JIM_NONE
) == NULL
)
8392 /* The object interp->unknown just contains
8393 * the "unknown" string, it is used in order to
8394 * avoid to lookup the unknown command every time
8395 * but instread to cache the result. */
8396 if (argc
+ 1 <= JIM_EVAL_SARGV_LEN
)
8399 v
= Jim_Alloc(sizeof(Jim_Obj
*)*(argc
+ 1));
8400 /* Make a copy of the arguments vector, but shifted on
8401 * the right of one position. The command name of the
8402 * command will be instead the first argument of the
8403 * [unknonw] call. */
8404 memcpy(v
+ 1, argv
, sizeof(Jim_Obj
*)*argc
);
8405 v
[0] = interp
->unknown
;
8407 interp
->unknown_called
++;
8408 retCode
= Jim_EvalObjVector(interp
, argc
+ 1, v
);
8409 interp
->unknown_called
--;
8417 /* Eval the object vector 'objv' composed of 'objc' elements.
8418 * Every element is used as single argument.
8419 * Jim_EvalObj() will call this function every time its object
8420 * argument is of "list" type, with no string representation.
8422 * This is possible because the string representation of a
8423 * list object generated by the UpdateStringOfList is made
8424 * in a way that ensures that every list element is a different
8425 * command argument. */
8426 int Jim_EvalObjVector(Jim_Interp
*interp
, int objc
, Jim_Obj
*const *objv
)
8431 /* Incr refcount of arguments. */
8432 for (i
= 0; i
< objc
; i
++)
8433 Jim_IncrRefCount(objv
[i
]);
8434 /* Command lookup */
8435 cmdPtr
= Jim_GetCommand(interp
, objv
[0], JIM_ERRMSG
);
8436 if (cmdPtr
== NULL
) {
8437 retcode
= JimUnknown(interp
, objc
, objv
);
8439 /* Call it -- Make sure result is an empty object. */
8440 Jim_SetEmptyResult(interp
);
8441 if (cmdPtr
->cmdProc
) {
8442 interp
->cmdPrivData
= cmdPtr
->privData
;
8443 retcode
= cmdPtr
->cmdProc(interp
, objc
, objv
);
8444 if (retcode
== JIM_ERR_ADDSTACK
) {
8445 //JimAppendStackTrace(interp, "", script->fileName, token[i-argc*2].linenr);
8449 retcode
= JimCallProcedure(interp
, cmdPtr
, objc
, objv
);
8450 if (retcode
== JIM_ERR
) {
8451 JimAppendStackTrace(interp
,
8452 Jim_GetString(objv
[0], NULL
), "", 1);
8456 /* Decr refcount of arguments and return the retcode */
8457 for (i
= 0; i
< objc
; i
++)
8458 Jim_DecrRefCount(interp
, objv
[i
]);
8462 /* Interpolate the given tokens into a unique Jim_Obj returned by reference
8463 * via *objPtrPtr. This function is only called by Jim_EvalObj().
8464 * The returned object has refcount = 0. */
8465 int Jim_InterpolateTokens(Jim_Interp
*interp
, ScriptToken
*token
,
8466 int tokens
, Jim_Obj
**objPtrPtr
)
8468 int totlen
= 0, i
, retcode
;
8470 Jim_Obj
*sintv
[JIM_EVAL_SINTV_LEN
];
8474 if (tokens
<= JIM_EVAL_SINTV_LEN
)
8477 intv
= Jim_Alloc(sizeof(Jim_Obj
*)*
8479 /* Compute every token forming the argument
8480 * in the intv objects vector. */
8481 for (i
= 0; i
< tokens
; i
++) {
8482 switch (token
[i
].type
) {
8485 intv
[i
] = token
[i
].objPtr
;
8488 intv
[i
] = Jim_GetVariable(interp
, token
[i
].objPtr
, JIM_ERRMSG
);
8494 case JIM_TT_DICTSUGAR
:
8495 intv
[i
] = Jim_ExpandDictSugar(interp
, token
[i
].objPtr
);
8502 retcode
= Jim_EvalObj(interp
, token
[i
].objPtr
);
8503 if (retcode
!= JIM_OK
)
8505 intv
[i
] = Jim_GetResult(interp
);
8509 "default token type reached "
8510 "in Jim_InterpolateTokens().");
8513 Jim_IncrRefCount(intv
[i
]);
8514 /* Make sure there is a valid
8515 * string rep, and add the string
8516 * length to the total legnth. */
8517 Jim_GetString(intv
[i
], NULL
);
8518 totlen
+= intv
[i
]->length
;
8520 /* Concatenate every token in an unique
8522 objPtr
= Jim_NewStringObjNoAlloc(interp
,
8524 s
= objPtr
->bytes
= Jim_Alloc(totlen
+ 1);
8525 objPtr
->length
= totlen
;
8526 for (i
= 0; i
< tokens
; i
++) {
8527 memcpy(s
, intv
[i
]->bytes
, intv
[i
]->length
);
8528 s
+= intv
[i
]->length
;
8529 Jim_DecrRefCount(interp
, intv
[i
]);
8531 objPtr
->bytes
[totlen
] = '\0';
8532 /* Free the intv vector if not static. */
8533 if (tokens
> JIM_EVAL_SINTV_LEN
)
8535 *objPtrPtr
= objPtr
;
8540 Jim_DecrRefCount(interp
, intv
[i
]);
8541 if (tokens
> JIM_EVAL_SINTV_LEN
)
8546 /* Helper of Jim_EvalObj() to perform argument expansion.
8547 * Basically this function append an argument to 'argv'
8548 * (and increments argc by reference accordingly), performing
8549 * expansion of the list object if 'expand' is non-zero, or
8550 * just adding objPtr to argv if 'expand' is zero. */
8551 void Jim_ExpandArgument(Jim_Interp
*interp
, Jim_Obj
***argv
,
8552 int *argcPtr
, int expand
, Jim_Obj
*objPtr
)
8555 (*argv
) = Jim_Realloc(*argv
, sizeof(Jim_Obj
*)*((*argcPtr
) + 1));
8556 /* refcount of objPtr not incremented because
8557 * we are actually transfering a reference from
8558 * the old 'argv' to the expanded one. */
8559 (*argv
)[*argcPtr
] = objPtr
;
8564 Jim_ListLength(interp
, objPtr
, &len
);
8565 (*argv
) = Jim_Realloc(*argv
, sizeof(Jim_Obj
*)*((*argcPtr
) + len
));
8566 for (i
= 0; i
< len
; i
++) {
8567 (*argv
)[*argcPtr
] = objPtr
->internalRep
.listValue
.ele
[i
];
8568 Jim_IncrRefCount(objPtr
->internalRep
.listValue
.ele
[i
]);
8571 /* The original object reference is no longer needed,
8572 * after the expansion it is no longer present on
8573 * the argument vector, but the single elements are
8575 Jim_DecrRefCount(interp
, objPtr
);
8579 int Jim_EvalObj(Jim_Interp
*interp
, Jim_Obj
*scriptObjPtr
)
8584 int *cs
; /* command structure array */
8585 int retcode
= JIM_OK
;
8586 Jim_Obj
*sargv
[JIM_EVAL_SARGV_LEN
], **argv
= NULL
, *tmpObjPtr
;
8587 Jim_Obj
*errorProc
= NULL
;
8589 interp
->errorFlag
= 0;
8591 /* If the object is of type "list" and there is no
8592 * string representation for this object, we can call
8593 * a specialized version of Jim_EvalObj() */
8594 if (scriptObjPtr
->typePtr
== &listObjType
&&
8595 scriptObjPtr
->internalRep
.listValue
.len
&&
8596 scriptObjPtr
->bytes
== NULL
) {
8597 Jim_IncrRefCount(scriptObjPtr
);
8598 retcode
= Jim_EvalObjVector(interp
,
8599 scriptObjPtr
->internalRep
.listValue
.len
,
8600 scriptObjPtr
->internalRep
.listValue
.ele
);
8601 Jim_DecrRefCount(interp
, scriptObjPtr
);
8605 Jim_IncrRefCount(scriptObjPtr
); /* Make sure it's shared. */
8606 script
= Jim_GetScript(interp
, scriptObjPtr
);
8607 /* Now we have to make sure the internal repr will not be
8608 * freed on shimmering.
8610 * Think for example to this:
8612 * set x {llength $x; ... some more code ...}; eval $x
8614 * In order to preserve the internal rep, we increment the
8615 * inUse field of the script internal rep structure. */
8618 token
= script
->token
;
8620 cs
= script
->cmdStruct
;
8621 i
= 0; /* 'i' is the current token index. */
8623 /* Reset the interpreter result. This is useful to
8624 * return the emtpy result in the case of empty program. */
8625 Jim_SetEmptyResult(interp
);
8627 /* Execute every command sequentially, returns on
8628 * error (i.e. if a command does not return JIM_OK) */
8631 int argc
= *cs
++; /* Get the number of arguments */
8634 /* Set the expand flag if needed. */
8639 /* Allocate the arguments vector */
8640 if (argc
<= JIM_EVAL_SARGV_LEN
)
8643 argv
= Jim_Alloc(sizeof(Jim_Obj
*)*argc
);
8644 /* Populate the arguments objects. */
8645 for (j
= 0; j
< argc
; j
++) {
8648 /* tokens is negative if expansion is needed.
8649 * for this argument. */
8651 tokens
= (-tokens
)-1;
8655 /* Fast path if the token does not
8656 * need interpolation */
8657 switch (token
[i
].type
) {
8660 argv
[j
] = token
[i
].objPtr
;
8663 tmpObjPtr
= Jim_GetVariable(interp
, token
[i
].objPtr
,
8669 argv
[j
] = tmpObjPtr
;
8671 case JIM_TT_DICTSUGAR
:
8672 tmpObjPtr
= Jim_ExpandDictSugar(interp
, token
[i
].objPtr
);
8677 argv
[j
] = tmpObjPtr
;
8680 retcode
= Jim_EvalObj(interp
, token
[i
].objPtr
);
8681 if (retcode
!= JIM_OK
)
8683 argv
[j
] = Jim_GetResult(interp
);
8687 "default token type reached "
8688 "in Jim_EvalObj().");
8691 Jim_IncrRefCount(argv
[j
]);
8694 /* For interpolation we call an helper
8695 * function doing the work for us. */
8696 if ((retcode
= Jim_InterpolateTokens(interp
,
8697 token
+ i
, tokens
, &tmpObjPtr
)) != JIM_OK
)
8701 argv
[j
] = tmpObjPtr
;
8702 Jim_IncrRefCount(argv
[j
]);
8706 /* Handle {expand} expansion */
8708 int *ecs
= cs
- argc
;
8710 Jim_Obj
**eargv
= NULL
;
8712 for (j
= 0; j
< argc
; j
++) {
8713 Jim_ExpandArgument(interp
, &eargv
, &eargc
,
8714 ecs
[j
] < 0, argv
[j
]);
8722 /* Nothing to do with zero args. */
8727 /* Lookup the command to call */
8728 cmd
= Jim_GetCommand(interp
, argv
[0], JIM_ERRMSG
);
8730 /* Call it -- Make sure result is an empty object. */
8731 Jim_SetEmptyResult(interp
);
8733 interp
->cmdPrivData
= cmd
->privData
;
8734 retcode
= cmd
->cmdProc(interp
, argc
, argv
);
8736 retcode
= JimCallProcedure(interp
, cmd
, argc
, argv
);
8737 if (retcode
== JIM_ERR
) {
8738 errorProc
= argv
[0];
8739 Jim_IncrRefCount(errorProc
);
8743 /* Call [unknown] */
8744 retcode
= JimUnknown(interp
, argc
, argv
);
8746 if (retcode
!= JIM_OK
) {
8747 i
-= argc
*2; /* point to the command name. */
8750 /* Decrement the arguments count */
8751 for (j
= 0; j
< argc
; j
++) {
8752 Jim_DecrRefCount(interp
, argv
[j
]);
8755 if (argv
!= sargv
) {
8760 /* Note that we don't have to decrement inUse, because the
8761 * following code transfers our use of the reference again to
8762 * the script object. */
8763 j
= 0; /* on normal termination, the argv array is already
8764 Jim_DecrRefCount-ed. */
8766 /* Handle errors. */
8767 if ((retcode
== JIM_ERR
)||(retcode
== JIM_ERR_ADDSTACK
)||
8768 (retcode
== JIM_RETURN
&&
8769 (interp
->returnCode
== JIM_ERR
||interp
->returnCode
== JIM_ERR_ADDSTACK
))) {
8770 if (!interp
->errorFlag
) {
8771 interp
->errorFlag
= 1;
8772 JimSetErrorFileName(interp
, script
->fileName
);
8773 JimSetErrorLineNumber(interp
, token
[i
].linenr
);
8774 JimResetStackTrace(interp
);
8776 JimAppendStackTrace(interp
, errorProc
? Jim_GetString(errorProc
, NULL
) : "", script
->fileName
, token
[i
].linenr
);
8778 Jim_DecrRefCount(interp
, errorProc
);
8780 if (retcode
== JIM_ERR_ADDSTACK
) {
8784 Jim_FreeIntRep(interp
, scriptObjPtr
);
8785 scriptObjPtr
->typePtr
= &scriptObjType
;
8786 Jim_SetIntRepPtr(scriptObjPtr
, script
);
8787 Jim_DecrRefCount(interp
, scriptObjPtr
);
8788 for (i
= 0; i
< j
; i
++) {
8789 Jim_DecrRefCount(interp
, argv
[i
]);
8796 /* Call a procedure implemented in Tcl.
8797 * It's possible to speed-up a lot this function, currently
8798 * the callframes are not cached, but allocated and
8799 * destroied every time. What is expecially costly is
8800 * to create/destroy the local vars hash table every time.
8802 * This can be fixed just implementing callframes caching
8803 * in JimCreateCallFrame() and JimFreeCallFrame(). */
8804 int JimCallProcedure(Jim_Interp
*interp
, Jim_Cmd
*cmd
, int argc
,
8805 Jim_Obj
*const *argv
)
8808 Jim_CallFrame
*callFramePtr
;
8812 if (argc
< cmd
->arityMin
|| (cmd
->arityMax
!= -1 &&
8813 argc
> cmd
->arityMax
)) {
8814 Jim_Obj
*objPtr
= Jim_NewEmptyStringObj(interp
);
8815 Jim_AppendStrings(interp
, objPtr
,
8816 "wrong # args: should be \"", Jim_GetString(argv
[0], NULL
),
8817 (cmd
->arityMin
> 1) ? " " : "",
8818 Jim_GetString(cmd
->argListObjPtr
, NULL
), "\"", NULL
);
8819 Jim_SetResult(interp
, objPtr
);
8822 /* Check if there are too nested calls */
8823 if (interp
->numLevels
== interp
->maxNestingDepth
) {
8824 Jim_SetResultString(interp
,
8825 "Too many nested calls. Infinite recursion?", -1);
8828 /* Create a new callframe */
8829 callFramePtr
= JimCreateCallFrame(interp
);
8830 callFramePtr
->parentCallFrame
= interp
->framePtr
;
8831 callFramePtr
->argv
= argv
;
8832 callFramePtr
->argc
= argc
;
8833 callFramePtr
->procArgsObjPtr
= cmd
->argListObjPtr
;
8834 callFramePtr
->procBodyObjPtr
= cmd
->bodyObjPtr
;
8835 callFramePtr
->staticVars
= cmd
->staticVars
;
8836 Jim_IncrRefCount(cmd
->argListObjPtr
);
8837 Jim_IncrRefCount(cmd
->bodyObjPtr
);
8838 interp
->framePtr
= callFramePtr
;
8839 interp
->numLevels
++;
8842 Jim_ListLength(interp
, cmd
->argListObjPtr
, &num_args
);
8844 /* If last argument is 'args', don't set it here */
8845 if (cmd
->arityMax
== -1) {
8849 for (i
= 0; i
< num_args
; i
++) {
8850 Jim_Obj
*argObjPtr
=NULL
;
8851 Jim_Obj
*nameObjPtr
=NULL
;
8852 Jim_Obj
*valueObjPtr
=NULL
;
8854 Jim_ListIndex(interp
, cmd
->argListObjPtr
, i
, &argObjPtr
, JIM_NONE
);
8855 if (i
+ 1 >= cmd
->arityMin
) {
8856 /* The name is the first element of the list */
8857 Jim_ListIndex(interp
, argObjPtr
, 0, &nameObjPtr
, JIM_NONE
);
8860 /* The element arg is the name */
8861 nameObjPtr
= argObjPtr
;
8864 if (i
+ 1 >= argc
) {
8865 /* No more values, so use default */
8866 /* The value is the second element of the list */
8867 Jim_ListIndex(interp
, argObjPtr
, 1, &valueObjPtr
, JIM_NONE
);
8870 valueObjPtr
= argv
[i
+ 1];
8872 Jim_SetVariable(interp
, nameObjPtr
, valueObjPtr
);
8874 /* Set optional arguments */
8875 if (cmd
->arityMax
== -1) {
8876 Jim_Obj
*listObjPtr
=NULL
, *objPtr
=NULL
;
8879 listObjPtr
= Jim_NewListObj(interp
, argv
+ i
, argc
-i
);
8880 Jim_ListIndex(interp
, cmd
->argListObjPtr
, num_args
, &objPtr
, JIM_NONE
);
8881 Jim_SetVariable(interp
, objPtr
, listObjPtr
);
8884 retcode
= Jim_EvalObj(interp
, cmd
->bodyObjPtr
);
8886 /* Destroy the callframe */
8887 interp
->numLevels
--;
8888 interp
->framePtr
= interp
->framePtr
->parentCallFrame
;
8889 if (callFramePtr
->vars
.size
!= JIM_HT_INITIAL_SIZE
) {
8890 JimFreeCallFrame(interp
, callFramePtr
, JIM_FCF_NONE
);
8892 JimFreeCallFrame(interp
, callFramePtr
, JIM_FCF_NOHT
);
8894 /* Handle the JIM_EVAL return code */
8895 if (retcode
== JIM_EVAL
&& interp
->evalRetcodeLevel
!= interp
->numLevels
) {
8896 int savedLevel
= interp
->evalRetcodeLevel
;
8898 interp
->evalRetcodeLevel
= interp
->numLevels
;
8899 while (retcode
== JIM_EVAL
) {
8900 Jim_Obj
*resultScriptObjPtr
= Jim_GetResult(interp
);
8901 Jim_IncrRefCount(resultScriptObjPtr
);
8902 retcode
= Jim_EvalObj(interp
, resultScriptObjPtr
);
8903 Jim_DecrRefCount(interp
, resultScriptObjPtr
);
8905 interp
->evalRetcodeLevel
= savedLevel
;
8907 /* Handle the JIM_RETURN return code */
8908 if (retcode
== JIM_RETURN
) {
8909 retcode
= interp
->returnCode
;
8910 interp
->returnCode
= JIM_OK
;
8915 int Jim_Eval_Named(Jim_Interp
*interp
, const char *script
, const char *filename
, int lineno
)
8918 Jim_Obj
*scriptObjPtr
;
8920 scriptObjPtr
= Jim_NewStringObj(interp
, script
, -1);
8921 Jim_IncrRefCount(scriptObjPtr
);
8925 JimSetSourceInfo(interp
, scriptObjPtr
, filename
, lineno
);
8928 retval
= Jim_EvalObj(interp
, scriptObjPtr
);
8929 Jim_DecrRefCount(interp
, scriptObjPtr
);
8933 int Jim_Eval(Jim_Interp
*interp
, const char *script
)
8935 return Jim_Eval_Named(interp
, script
, NULL
, 0);
8940 /* Execute script in the scope of the global level */
8941 int Jim_EvalGlobal(Jim_Interp
*interp
, const char *script
)
8943 Jim_CallFrame
*savedFramePtr
;
8946 savedFramePtr
= interp
->framePtr
;
8947 interp
->framePtr
= interp
->topFramePtr
;
8948 retval
= Jim_Eval(interp
, script
);
8949 interp
->framePtr
= savedFramePtr
;
8953 int Jim_EvalObjBackground(Jim_Interp
*interp
, Jim_Obj
*scriptObjPtr
)
8955 Jim_CallFrame
*savedFramePtr
;
8958 savedFramePtr
= interp
->framePtr
;
8959 interp
->framePtr
= interp
->topFramePtr
;
8960 retval
= Jim_EvalObj(interp
, scriptObjPtr
);
8961 interp
->framePtr
= savedFramePtr
;
8962 /* Try to report the error (if any) via the bgerror proc */
8963 if (retval
!= JIM_OK
) {
8966 objv
[0] = Jim_NewStringObj(interp
, "bgerror", -1);
8967 objv
[1] = Jim_GetResult(interp
);
8968 Jim_IncrRefCount(objv
[0]);
8969 Jim_IncrRefCount(objv
[1]);
8970 if (Jim_EvalObjVector(interp
, 2, objv
) != JIM_OK
) {
8971 /* Report the error to stderr. */
8972 Jim_fprintf(interp
, interp
->cookie_stderr
, "Background error:" JIM_NL
);
8973 Jim_PrintErrorMessage(interp
);
8975 Jim_DecrRefCount(interp
, objv
[0]);
8976 Jim_DecrRefCount(interp
, objv
[1]);
8981 int Jim_EvalFile(Jim_Interp
*interp
, const char *filename
)
8985 int nread
, totread
, maxlen
, buflen
;
8987 Jim_Obj
*scriptObjPtr
;
8989 if ((fp
= fopen(filename
, "r")) == NULL
) {
8990 const int cwd_len
= 2048;
8991 char *cwd
= malloc(cwd_len
);
8992 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
8993 if (!getcwd(cwd
, cwd_len
)) strcpy(cwd
, "unknown");
8994 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
8995 "Error loading script \"", filename
, "\"",
8997 " err: ", strerror(errno
), NULL
);
9002 maxlen
= totread
= 0;
9004 if (maxlen
< totread
+ buflen
+ 1) {
9005 maxlen
= totread
+ buflen
+ 1;
9006 prg
= Jim_Realloc(prg
, maxlen
);
9008 /* do not use Jim_fread() - this is really a file */
9009 if ((nread
= fread(prg
+ totread
, 1, buflen
, fp
)) == 0) break;
9012 prg
[totread
] = '\0';
9013 /* do not use Jim_fclose() - this is really a file */
9016 scriptObjPtr
= Jim_NewStringObjNoAlloc(interp
, prg
, totread
);
9017 JimSetSourceInfo(interp
, scriptObjPtr
, filename
, 1);
9018 Jim_IncrRefCount(scriptObjPtr
);
9019 retval
= Jim_EvalObj(interp
, scriptObjPtr
);
9020 Jim_DecrRefCount(interp
, scriptObjPtr
);
9024 /* -----------------------------------------------------------------------------
9026 * ---------------------------------------------------------------------------*/
9027 static int JimParseSubstStr(struct JimParserCtx
*pc
)
9030 pc
->tline
= pc
->linenr
;
9031 while (*pc
->p
&& *pc
->p
!= '$' && *pc
->p
!= '[') {
9035 pc
->tt
= JIM_TT_ESC
;
9039 static int JimParseSubst(struct JimParserCtx
*pc
, int flags
)
9044 pc
->tstart
= pc
->tend
= pc
->p
;
9045 pc
->tline
= pc
->linenr
;
9046 pc
->tt
= JIM_TT_EOL
;
9052 retval
= JimParseCmd(pc
);
9053 if (flags
& JIM_SUBST_NOCMD
) {
9056 pc
->tt
= (flags
& JIM_SUBST_NOESC
) ?
9057 JIM_TT_STR
: JIM_TT_ESC
;
9062 if (JimParseVar(pc
) == JIM_ERR
) {
9063 pc
->tstart
= pc
->tend
= pc
->p
++; pc
->len
--;
9064 pc
->tline
= pc
->linenr
;
9065 pc
->tt
= JIM_TT_STR
;
9067 if (flags
& JIM_SUBST_NOVAR
) {
9069 if (flags
& JIM_SUBST_NOESC
)
9070 pc
->tt
= JIM_TT_STR
;
9072 pc
->tt
= JIM_TT_ESC
;
9073 if (*pc
->tstart
== '{') {
9075 if (*(pc
->tend
+ 1))
9082 retval
= JimParseSubstStr(pc
);
9083 if (flags
& JIM_SUBST_NOESC
)
9084 pc
->tt
= JIM_TT_STR
;
9091 /* The subst object type reuses most of the data structures and functions
9092 * of the script object. Script's data structures are a bit more complex
9093 * for what is needed for [subst]itution tasks, but the reuse helps to
9094 * deal with a single data structure at the cost of some more memory
9095 * usage for substitutions. */
9096 static Jim_ObjType substObjType
= {
9098 FreeScriptInternalRep
,
9099 DupScriptInternalRep
,
9101 JIM_TYPE_REFERENCES
,
9104 /* This method takes the string representation of an object
9105 * as a Tcl string where to perform [subst]itution, and generates
9106 * the pre-parsed internal representation. */
9107 int SetSubstFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
, int flags
)
9110 const char *scriptText
= Jim_GetString(objPtr
, &scriptTextLen
);
9111 struct JimParserCtx parser
;
9112 struct ScriptObj
*script
= Jim_Alloc(sizeof(*script
));
9116 script
->commands
= 0;
9117 script
->token
= NULL
;
9118 script
->cmdStruct
= NULL
;
9120 script
->substFlags
= flags
;
9121 script
->fileName
= NULL
;
9123 JimParserInit(&parser
, scriptText
, scriptTextLen
, 1);
9126 int len
, type
, linenr
;
9128 JimParseSubst(&parser
, flags
);
9129 if (JimParserEof(&parser
)) break;
9130 token
= JimParserGetToken(&parser
, &len
, &type
, &linenr
);
9131 ScriptObjAddToken(interp
, script
, token
, len
, type
,
9134 /* Free the old internal rep and set the new one. */
9135 Jim_FreeIntRep(interp
, objPtr
);
9136 Jim_SetIntRepPtr(objPtr
, script
);
9137 objPtr
->typePtr
= &scriptObjType
;
9141 ScriptObj
*Jim_GetSubst(Jim_Interp
*interp
, Jim_Obj
*objPtr
, int flags
)
9143 struct ScriptObj
*script
= Jim_GetIntRepPtr(objPtr
);
9145 if (objPtr
->typePtr
!= &substObjType
|| script
->substFlags
!= flags
)
9146 SetSubstFromAny(interp
, objPtr
, flags
);
9147 return (ScriptObj
*) Jim_GetIntRepPtr(objPtr
);
9150 /* Performs commands,variables,blackslashes substitution,
9151 * storing the result object (with refcount 0) into
9153 int Jim_SubstObj(Jim_Interp
*interp
, Jim_Obj
*substObjPtr
,
9154 Jim_Obj
**resObjPtrPtr
, int flags
)
9158 int i
, len
, retcode
= JIM_OK
;
9159 Jim_Obj
*resObjPtr
, *savedResultObjPtr
;
9161 script
= Jim_GetSubst(interp
, substObjPtr
, flags
);
9162 #ifdef JIM_OPTIMIZATION
9163 /* Fast path for a very common case with array-alike syntax,
9164 * that's: $foo($bar) */
9165 if (script
->len
== 1 && script
->token
[0].type
== JIM_TT_VAR
) {
9166 Jim_Obj
*varObjPtr
= script
->token
[0].objPtr
;
9168 Jim_IncrRefCount(varObjPtr
);
9169 resObjPtr
= Jim_GetVariable(interp
, varObjPtr
, JIM_ERRMSG
);
9170 if (resObjPtr
== NULL
) {
9171 Jim_DecrRefCount(interp
, varObjPtr
);
9174 Jim_DecrRefCount(interp
, varObjPtr
);
9175 *resObjPtrPtr
= resObjPtr
;
9180 Jim_IncrRefCount(substObjPtr
); /* Make sure it's shared. */
9181 /* In order to preserve the internal rep, we increment the
9182 * inUse field of the script internal rep structure. */
9185 token
= script
->token
;
9188 /* Save the interp old result, to set it again before
9190 savedResultObjPtr
= interp
->result
;
9191 Jim_IncrRefCount(savedResultObjPtr
);
9193 /* Perform the substitution. Starts with an empty object
9194 * and adds every token (performing the appropriate
9195 * var/command/escape substitution). */
9196 resObjPtr
= Jim_NewStringObj(interp
, "", 0);
9197 for (i
= 0; i
< len
; i
++) {
9200 switch (token
[i
].type
) {
9203 Jim_AppendObj(interp
, resObjPtr
, token
[i
].objPtr
);
9206 objPtr
= Jim_GetVariable(interp
, token
[i
].objPtr
, JIM_ERRMSG
);
9207 if (objPtr
== NULL
) goto err
;
9208 Jim_IncrRefCount(objPtr
);
9209 Jim_AppendObj(interp
, resObjPtr
, objPtr
);
9210 Jim_DecrRefCount(interp
, objPtr
);
9212 case JIM_TT_DICTSUGAR
:
9213 objPtr
= Jim_ExpandDictSugar(interp
, token
[i
].objPtr
);
9220 if (Jim_EvalObj(interp
, token
[i
].objPtr
) != JIM_OK
)
9222 Jim_AppendObj(interp
, resObjPtr
, interp
->result
);
9226 "default token type (%d) reached "
9227 "in Jim_SubstObj().", token
[i
].type
);
9232 if (retcode
== JIM_OK
)
9233 Jim_SetResult(interp
, savedResultObjPtr
);
9234 Jim_DecrRefCount(interp
, savedResultObjPtr
);
9235 /* Note that we don't have to decrement inUse, because the
9236 * following code transfers our use of the reference again to
9237 * the script object. */
9238 Jim_FreeIntRep(interp
, substObjPtr
);
9239 substObjPtr
->typePtr
= &scriptObjType
;
9240 Jim_SetIntRepPtr(substObjPtr
, script
);
9241 Jim_DecrRefCount(interp
, substObjPtr
);
9242 *resObjPtrPtr
= resObjPtr
;
9245 Jim_FreeNewObj(interp
, resObjPtr
);
9250 /* -----------------------------------------------------------------------------
9251 * API Input/Export functions
9252 * ---------------------------------------------------------------------------*/
9254 int Jim_GetApi(Jim_Interp
*interp
, const char *funcname
, void *targetPtrPtr
)
9258 he
= Jim_FindHashEntry(&interp
->stub
, funcname
);
9261 memcpy(targetPtrPtr
, &he
->val
, sizeof(void*));
9265 int Jim_RegisterApi(Jim_Interp
*interp
, const char *funcname
, JimApiFunc
*funcptr
)
9267 return Jim_AddHashEntry(&interp
->stub
, funcname
, (void *)(uintptr_t)funcptr
);
9270 #define JIM_REGISTER_API(name) \
9271 Jim_RegisterApi(interp, "Jim_" #name, (JimApiFunc *)(Jim_ ## name))
9273 void JimRegisterCoreApi(Jim_Interp
*interp
)
9275 interp
->getApiFuncPtr
= Jim_GetApi
;
9276 JIM_REGISTER_API(Alloc
);
9277 JIM_REGISTER_API(Free
);
9278 JIM_REGISTER_API(Eval
);
9279 JIM_REGISTER_API(Eval_Named
);
9280 JIM_REGISTER_API(EvalGlobal
);
9281 JIM_REGISTER_API(EvalFile
);
9282 JIM_REGISTER_API(EvalObj
);
9283 JIM_REGISTER_API(EvalObjBackground
);
9284 JIM_REGISTER_API(EvalObjVector
);
9285 JIM_REGISTER_API(InitHashTable
);
9286 JIM_REGISTER_API(ExpandHashTable
);
9287 JIM_REGISTER_API(AddHashEntry
);
9288 JIM_REGISTER_API(ReplaceHashEntry
);
9289 JIM_REGISTER_API(DeleteHashEntry
);
9290 JIM_REGISTER_API(FreeHashTable
);
9291 JIM_REGISTER_API(FindHashEntry
);
9292 JIM_REGISTER_API(ResizeHashTable
);
9293 JIM_REGISTER_API(GetHashTableIterator
);
9294 JIM_REGISTER_API(NextHashEntry
);
9295 JIM_REGISTER_API(NewObj
);
9296 JIM_REGISTER_API(FreeObj
);
9297 JIM_REGISTER_API(InvalidateStringRep
);
9298 JIM_REGISTER_API(InitStringRep
);
9299 JIM_REGISTER_API(DuplicateObj
);
9300 JIM_REGISTER_API(GetString
);
9301 JIM_REGISTER_API(Length
);
9302 JIM_REGISTER_API(InvalidateStringRep
);
9303 JIM_REGISTER_API(NewStringObj
);
9304 JIM_REGISTER_API(NewStringObjNoAlloc
);
9305 JIM_REGISTER_API(AppendString
);
9306 JIM_REGISTER_API(AppendString_sprintf
);
9307 JIM_REGISTER_API(AppendObj
);
9308 JIM_REGISTER_API(AppendStrings
);
9309 JIM_REGISTER_API(StringEqObj
);
9310 JIM_REGISTER_API(StringMatchObj
);
9311 JIM_REGISTER_API(StringRangeObj
);
9312 JIM_REGISTER_API(FormatString
);
9313 JIM_REGISTER_API(CompareStringImmediate
);
9314 JIM_REGISTER_API(NewReference
);
9315 JIM_REGISTER_API(GetReference
);
9316 JIM_REGISTER_API(SetFinalizer
);
9317 JIM_REGISTER_API(GetFinalizer
);
9318 JIM_REGISTER_API(CreateInterp
);
9319 JIM_REGISTER_API(FreeInterp
);
9320 JIM_REGISTER_API(GetExitCode
);
9321 JIM_REGISTER_API(SetStdin
);
9322 JIM_REGISTER_API(SetStdout
);
9323 JIM_REGISTER_API(SetStderr
);
9324 JIM_REGISTER_API(CreateCommand
);
9325 JIM_REGISTER_API(CreateProcedure
);
9326 JIM_REGISTER_API(DeleteCommand
);
9327 JIM_REGISTER_API(RenameCommand
);
9328 JIM_REGISTER_API(GetCommand
);
9329 JIM_REGISTER_API(SetVariable
);
9330 JIM_REGISTER_API(SetVariableStr
);
9331 JIM_REGISTER_API(SetGlobalVariableStr
);
9332 JIM_REGISTER_API(SetVariableStrWithStr
);
9333 JIM_REGISTER_API(SetVariableLink
);
9334 JIM_REGISTER_API(GetVariable
);
9335 JIM_REGISTER_API(GetCallFrameByLevel
);
9336 JIM_REGISTER_API(Collect
);
9337 JIM_REGISTER_API(CollectIfNeeded
);
9338 JIM_REGISTER_API(GetIndex
);
9339 JIM_REGISTER_API(NewListObj
);
9340 JIM_REGISTER_API(ListInsertElements
);
9341 JIM_REGISTER_API(ListAppendElement
);
9342 JIM_REGISTER_API(ListAppendList
);
9343 JIM_REGISTER_API(ListLength
);
9344 JIM_REGISTER_API(ListIndex
);
9345 JIM_REGISTER_API(SetListIndex
);
9346 JIM_REGISTER_API(ConcatObj
);
9347 JIM_REGISTER_API(NewDictObj
);
9348 JIM_REGISTER_API(DictKey
);
9349 JIM_REGISTER_API(DictKeysVector
);
9350 JIM_REGISTER_API(GetIndex
);
9351 JIM_REGISTER_API(GetReturnCode
);
9352 JIM_REGISTER_API(EvalExpression
);
9353 JIM_REGISTER_API(GetBoolFromExpr
);
9354 JIM_REGISTER_API(GetWide
);
9355 JIM_REGISTER_API(GetLong
);
9356 JIM_REGISTER_API(SetWide
);
9357 JIM_REGISTER_API(NewIntObj
);
9358 JIM_REGISTER_API(GetDouble
);
9359 JIM_REGISTER_API(SetDouble
);
9360 JIM_REGISTER_API(NewDoubleObj
);
9361 JIM_REGISTER_API(WrongNumArgs
);
9362 JIM_REGISTER_API(SetDictKeysVector
);
9363 JIM_REGISTER_API(SubstObj
);
9364 JIM_REGISTER_API(RegisterApi
);
9365 JIM_REGISTER_API(PrintErrorMessage
);
9366 JIM_REGISTER_API(InteractivePrompt
);
9367 JIM_REGISTER_API(RegisterCoreCommands
);
9368 JIM_REGISTER_API(GetSharedString
);
9369 JIM_REGISTER_API(ReleaseSharedString
);
9370 JIM_REGISTER_API(Panic
);
9371 JIM_REGISTER_API(StrDup
);
9372 JIM_REGISTER_API(UnsetVariable
);
9373 JIM_REGISTER_API(GetVariableStr
);
9374 JIM_REGISTER_API(GetGlobalVariable
);
9375 JIM_REGISTER_API(GetGlobalVariableStr
);
9376 JIM_REGISTER_API(GetAssocData
);
9377 JIM_REGISTER_API(SetAssocData
);
9378 JIM_REGISTER_API(DeleteAssocData
);
9379 JIM_REGISTER_API(GetEnum
);
9380 JIM_REGISTER_API(ScriptIsComplete
);
9381 JIM_REGISTER_API(PackageRequire
);
9382 JIM_REGISTER_API(PackageProvide
);
9383 JIM_REGISTER_API(InitStack
);
9384 JIM_REGISTER_API(FreeStack
);
9385 JIM_REGISTER_API(StackLen
);
9386 JIM_REGISTER_API(StackPush
);
9387 JIM_REGISTER_API(StackPop
);
9388 JIM_REGISTER_API(StackPeek
);
9389 JIM_REGISTER_API(FreeStackElements
);
9390 JIM_REGISTER_API(fprintf
);
9391 JIM_REGISTER_API(vfprintf
);
9392 JIM_REGISTER_API(fwrite
);
9393 JIM_REGISTER_API(fread
);
9394 JIM_REGISTER_API(fflush
);
9395 JIM_REGISTER_API(fgets
);
9396 JIM_REGISTER_API(GetNvp
);
9397 JIM_REGISTER_API(Nvp_name2value
);
9398 JIM_REGISTER_API(Nvp_name2value_simple
);
9399 JIM_REGISTER_API(Nvp_name2value_obj
);
9400 JIM_REGISTER_API(Nvp_name2value_nocase
);
9401 JIM_REGISTER_API(Nvp_name2value_obj_nocase
);
9403 JIM_REGISTER_API(Nvp_value2name
);
9404 JIM_REGISTER_API(Nvp_value2name_simple
);
9405 JIM_REGISTER_API(Nvp_value2name_obj
);
9407 JIM_REGISTER_API(GetOpt_Setup
);
9408 JIM_REGISTER_API(GetOpt_Debug
);
9409 JIM_REGISTER_API(GetOpt_Obj
);
9410 JIM_REGISTER_API(GetOpt_String
);
9411 JIM_REGISTER_API(GetOpt_Double
);
9412 JIM_REGISTER_API(GetOpt_Wide
);
9413 JIM_REGISTER_API(GetOpt_Nvp
);
9414 JIM_REGISTER_API(GetOpt_NvpUnknown
);
9415 JIM_REGISTER_API(GetOpt_Enum
);
9417 JIM_REGISTER_API(Debug_ArgvString
);
9418 JIM_REGISTER_API(SetResult_sprintf
);
9419 JIM_REGISTER_API(SetResult_NvpUnknown
);
9423 /* -----------------------------------------------------------------------------
9424 * Core commands utility functions
9425 * ---------------------------------------------------------------------------*/
9426 void Jim_WrongNumArgs(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
,
9430 Jim_Obj
*objPtr
= Jim_NewEmptyStringObj(interp
);
9432 Jim_AppendString(interp
, objPtr
, "wrong # args: should be \"", -1);
9433 for (i
= 0; i
< argc
; i
++) {
9434 Jim_AppendObj(interp
, objPtr
, argv
[i
]);
9435 if (!(i
+ 1 == argc
&& msg
[0] == '\0'))
9436 Jim_AppendString(interp
, objPtr
, " ", 1);
9438 Jim_AppendString(interp
, objPtr
, msg
, -1);
9439 Jim_AppendString(interp
, objPtr
, "\"", 1);
9440 Jim_SetResult(interp
, objPtr
);
9443 static Jim_Obj
*JimCommandsList(Jim_Interp
*interp
, Jim_Obj
*patternObjPtr
)
9445 Jim_HashTableIterator
*htiter
;
9447 Jim_Obj
*listObjPtr
= Jim_NewListObj(interp
, NULL
, 0);
9448 const char *pattern
;
9451 pattern
= patternObjPtr
? Jim_GetString(patternObjPtr
, &patternLen
) : NULL
;
9452 htiter
= Jim_GetHashTableIterator(&interp
->commands
);
9453 while ((he
= Jim_NextHashEntry(htiter
)) != NULL
) {
9454 if (pattern
&& !JimStringMatch(pattern
, patternLen
, he
->key
,
9455 strlen((const char*)he
->key
), 0))
9457 Jim_ListAppendElement(interp
, listObjPtr
,
9458 Jim_NewStringObj(interp
, he
->key
, -1));
9460 Jim_FreeHashTableIterator(htiter
);
9464 #define JIM_VARLIST_GLOBALS 0
9465 #define JIM_VARLIST_LOCALS 1
9466 #define JIM_VARLIST_VARS 2
9468 static Jim_Obj
*JimVariablesList(Jim_Interp
*interp
, Jim_Obj
*patternObjPtr
,
9471 Jim_HashTableIterator
*htiter
;
9473 Jim_Obj
*listObjPtr
= Jim_NewListObj(interp
, NULL
, 0);
9474 const char *pattern
;
9477 pattern
= patternObjPtr
? Jim_GetString(patternObjPtr
, &patternLen
) : NULL
;
9478 if (mode
== JIM_VARLIST_GLOBALS
) {
9479 htiter
= Jim_GetHashTableIterator(&interp
->topFramePtr
->vars
);
9481 /* For [info locals], if we are at top level an emtpy list
9482 * is returned. I don't agree, but we aim at compatibility (SS) */
9483 if (mode
== JIM_VARLIST_LOCALS
&&
9484 interp
->framePtr
== interp
->topFramePtr
)
9486 htiter
= Jim_GetHashTableIterator(&interp
->framePtr
->vars
);
9488 while ((he
= Jim_NextHashEntry(htiter
)) != NULL
) {
9489 Jim_Var
*varPtr
= (Jim_Var
*) he
->val
;
9490 if (mode
== JIM_VARLIST_LOCALS
) {
9491 if (varPtr
->linkFramePtr
!= NULL
)
9494 if (pattern
&& !JimStringMatch(pattern
, patternLen
, he
->key
,
9495 strlen((const char*)he
->key
), 0))
9497 Jim_ListAppendElement(interp
, listObjPtr
,
9498 Jim_NewStringObj(interp
, he
->key
, -1));
9500 Jim_FreeHashTableIterator(htiter
);
9504 static int JimInfoLevel(Jim_Interp
*interp
, Jim_Obj
*levelObjPtr
,
9505 Jim_Obj
**objPtrPtr
)
9507 Jim_CallFrame
*targetCallFrame
;
9509 if (JimGetCallFrameByInteger(interp
, levelObjPtr
, &targetCallFrame
)
9512 /* No proc call at toplevel callframe */
9513 if (targetCallFrame
== interp
->topFramePtr
) {
9514 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
9515 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
9517 Jim_GetString(levelObjPtr
, NULL
), "\"", NULL
);
9520 *objPtrPtr
= Jim_NewListObj(interp
,
9521 targetCallFrame
->argv
,
9522 targetCallFrame
->argc
);
9526 /* -----------------------------------------------------------------------------
9528 * ---------------------------------------------------------------------------*/
9530 /* fake [puts] -- not the real puts, just for debugging. */
9531 static int Jim_PutsCoreCommand(Jim_Interp
*interp
, int argc
,
9532 Jim_Obj
*const *argv
)
9535 int len
, nonewline
= 0;
9537 if (argc
!= 2 && argc
!= 3) {
9538 Jim_WrongNumArgs(interp
, 1, argv
, "-nonewline string");
9542 if (!Jim_CompareStringImmediate(interp
, argv
[1], "-nonewline"))
9544 Jim_SetResultString(interp
, "The second argument must "
9545 "be -nonewline", -1);
9552 str
= Jim_GetString(argv
[1], &len
);
9553 Jim_fwrite(interp
, str
, 1, len
, interp
->cookie_stdout
);
9554 if (!nonewline
) Jim_fprintf(interp
, interp
->cookie_stdout
, JIM_NL
);
9558 /* Helper for [+] and [*] */
9559 static int Jim_AddMulHelper(Jim_Interp
*interp
, int argc
,
9560 Jim_Obj
*const *argv
, int op
)
9562 jim_wide wideValue
, res
;
9563 double doubleValue
, doubleRes
;
9566 res
= (op
== JIM_EXPROP_ADD
) ? 0 : 1;
9568 for (i
= 1; i
< argc
; i
++) {
9569 if (Jim_GetWide(interp
, argv
[i
], &wideValue
) != JIM_OK
)
9571 if (op
== JIM_EXPROP_ADD
)
9576 Jim_SetResult(interp
, Jim_NewIntObj(interp
, res
));
9579 doubleRes
= (double) res
;
9580 for (;i
< argc
; i
++) {
9581 if (Jim_GetDouble(interp
, argv
[i
], &doubleValue
) != JIM_OK
)
9583 if (op
== JIM_EXPROP_ADD
)
9584 doubleRes
+= doubleValue
;
9586 doubleRes
*= doubleValue
;
9588 Jim_SetResult(interp
, Jim_NewDoubleObj(interp
, doubleRes
));
9592 /* Helper for [-] and [/] */
9593 static int Jim_SubDivHelper(Jim_Interp
*interp
, int argc
,
9594 Jim_Obj
*const *argv
, int op
)
9596 jim_wide wideValue
, res
= 0;
9597 double doubleValue
, doubleRes
= 0;
9601 Jim_WrongNumArgs(interp
, 1, argv
, "number ?number ... number?");
9603 } else if (argc
== 2) {
9604 /* The arity = 2 case is different. For [- x] returns -x,
9605 * while [/ x] returns 1/x. */
9606 if (Jim_GetWide(interp
, argv
[1], &wideValue
) != JIM_OK
) {
9607 if (Jim_GetDouble(interp
, argv
[1], &doubleValue
) !=
9612 if (op
== JIM_EXPROP_SUB
)
9613 doubleRes
= -doubleValue
;
9615 doubleRes
= 1.0/doubleValue
;
9616 Jim_SetResult(interp
, Jim_NewDoubleObj(interp
,
9621 if (op
== JIM_EXPROP_SUB
) {
9623 Jim_SetResult(interp
, Jim_NewIntObj(interp
, res
));
9625 doubleRes
= 1.0/wideValue
;
9626 Jim_SetResult(interp
, Jim_NewDoubleObj(interp
,
9631 if (Jim_GetWide(interp
, argv
[1], &res
) != JIM_OK
) {
9632 if (Jim_GetDouble(interp
, argv
[1], &doubleRes
)
9640 for (i
= 2; i
< argc
; i
++) {
9641 if (Jim_GetWide(interp
, argv
[i
], &wideValue
) != JIM_OK
) {
9642 doubleRes
= (double) res
;
9645 if (op
== JIM_EXPROP_SUB
)
9650 Jim_SetResult(interp
, Jim_NewIntObj(interp
, res
));
9653 for (;i
< argc
; i
++) {
9654 if (Jim_GetDouble(interp
, argv
[i
], &doubleValue
) != JIM_OK
)
9656 if (op
== JIM_EXPROP_SUB
)
9657 doubleRes
-= doubleValue
;
9659 doubleRes
/= doubleValue
;
9661 Jim_SetResult(interp
, Jim_NewDoubleObj(interp
, doubleRes
));
9667 static int Jim_AddCoreCommand(Jim_Interp
*interp
, int argc
,
9668 Jim_Obj
*const *argv
)
9670 return Jim_AddMulHelper(interp
, argc
, argv
, JIM_EXPROP_ADD
);
9674 static int Jim_MulCoreCommand(Jim_Interp
*interp
, int argc
,
9675 Jim_Obj
*const *argv
)
9677 return Jim_AddMulHelper(interp
, argc
, argv
, JIM_EXPROP_MUL
);
9681 static int Jim_SubCoreCommand(Jim_Interp
*interp
, int argc
,
9682 Jim_Obj
*const *argv
)
9684 return Jim_SubDivHelper(interp
, argc
, argv
, JIM_EXPROP_SUB
);
9688 static int Jim_DivCoreCommand(Jim_Interp
*interp
, int argc
,
9689 Jim_Obj
*const *argv
)
9691 return Jim_SubDivHelper(interp
, argc
, argv
, JIM_EXPROP_DIV
);
9695 static int Jim_SetCoreCommand(Jim_Interp
*interp
, int argc
,
9696 Jim_Obj
*const *argv
)
9698 if (argc
!= 2 && argc
!= 3) {
9699 Jim_WrongNumArgs(interp
, 1, argv
, "varName ?newValue?");
9704 objPtr
= Jim_GetVariable(interp
, argv
[1], JIM_ERRMSG
);
9707 Jim_SetResult(interp
, objPtr
);
9710 /* argc == 3 case. */
9711 if (Jim_SetVariable(interp
, argv
[1], argv
[2]) != JIM_OK
)
9713 Jim_SetResult(interp
, argv
[2]);
9718 static int Jim_UnsetCoreCommand(Jim_Interp
*interp
, int argc
,
9719 Jim_Obj
*const *argv
)
9724 Jim_WrongNumArgs(interp
, 1, argv
, "varName ?varName ...?");
9727 for (i
= 1; i
< argc
; i
++) {
9728 if (Jim_UnsetVariable(interp
, argv
[i
], JIM_ERRMSG
) != JIM_OK
)
9735 static int Jim_IncrCoreCommand(Jim_Interp
*interp
, int argc
,
9736 Jim_Obj
*const *argv
)
9738 jim_wide wideValue
, increment
= 1;
9741 if (argc
!= 2 && argc
!= 3) {
9742 Jim_WrongNumArgs(interp
, 1, argv
, "varName ?increment?");
9746 if (Jim_GetWide(interp
, argv
[2], &increment
) != JIM_OK
)
9749 intObjPtr
= Jim_GetVariable(interp
, argv
[1], JIM_ERRMSG
);
9750 if (!intObjPtr
) return JIM_ERR
;
9751 if (Jim_GetWide(interp
, intObjPtr
, &wideValue
) != JIM_OK
)
9753 if (Jim_IsShared(intObjPtr
)) {
9754 intObjPtr
= Jim_NewIntObj(interp
, wideValue
+ increment
);
9755 if (Jim_SetVariable(interp
, argv
[1], intObjPtr
) != JIM_OK
) {
9756 Jim_FreeNewObj(interp
, intObjPtr
);
9760 Jim_SetWide(interp
, intObjPtr
, wideValue
+ increment
);
9761 /* The following step is required in order to invalidate the
9762 * string repr of "FOO" if the var name is on the form of "FOO(IDX)" */
9763 if (Jim_SetVariable(interp
, argv
[1], intObjPtr
) != JIM_OK
) {
9767 Jim_SetResult(interp
, intObjPtr
);
9772 static int Jim_WhileCoreCommand(Jim_Interp
*interp
, int argc
,
9773 Jim_Obj
*const *argv
)
9776 Jim_WrongNumArgs(interp
, 1, argv
, "condition body");
9779 /* Try to run a specialized version of while if the expression
9780 * is in one of the following forms:
9782 * $a < CONST, $a < $b
9783 * $a <= CONST, $a <= $b
9784 * $a > CONST, $a > $b
9785 * $a >= CONST, $a >= $b
9786 * $a != CONST, $a != $b
9787 * $a == CONST, $a == $b
9793 #ifdef JIM_OPTIMIZATION
9796 Jim_Obj
*varAObjPtr
= NULL
, *varBObjPtr
= NULL
, *objPtr
;
9797 int exprLen
, retval
;
9799 /* STEP 1 -- Check if there are the conditions to run the specialized
9800 * version of while */
9802 if ((expr
= Jim_GetExpression(interp
, argv
[1])) == NULL
) goto noopt
;
9803 if (expr
->len
<= 0 || expr
->len
> 3) goto noopt
;
9804 switch (expr
->len
) {
9806 if (expr
->opcode
[0] != JIM_EXPROP_VARIABLE
&&
9807 expr
->opcode
[0] != JIM_EXPROP_NUMBER
)
9811 if (expr
->opcode
[1] != JIM_EXPROP_NOT
||
9812 expr
->opcode
[0] != JIM_EXPROP_VARIABLE
)
9816 if (expr
->opcode
[0] != JIM_EXPROP_VARIABLE
||
9817 (expr
->opcode
[1] != JIM_EXPROP_NUMBER
&&
9818 expr
->opcode
[1] != JIM_EXPROP_VARIABLE
))
9820 switch (expr
->opcode
[2]) {
9822 case JIM_EXPROP_LTE
:
9824 case JIM_EXPROP_GTE
:
9825 case JIM_EXPROP_NUMEQ
:
9826 case JIM_EXPROP_NUMNE
:
9835 "Unexpected default reached in Jim_WhileCoreCommand()");
9839 /* STEP 2 -- conditions meet. Initialization. Take different
9840 * branches for different expression lengths. */
9841 exprLen
= expr
->len
;
9844 jim_wide wideValue
=0;
9846 if (expr
->opcode
[0] == JIM_EXPROP_VARIABLE
) {
9847 varAObjPtr
= expr
->obj
[0];
9848 Jim_IncrRefCount(varAObjPtr
);
9850 if (Jim_GetWide(interp
, expr
->obj
[0], &wideValue
) != JIM_OK
)
9856 Jim_GetVariable(interp
, varAObjPtr
, JIM_NONE
)) ||
9857 Jim_GetWide(interp
, objPtr
, &wideValue
) != JIM_OK
)
9859 Jim_DecrRefCount(interp
, varAObjPtr
);
9863 if (!wideValue
) break;
9864 if ((retval
= Jim_EvalObj(interp
, argv
[2])) != JIM_OK
) {
9868 Jim_DecrRefCount(interp
, varAObjPtr
);
9876 Jim_DecrRefCount(interp
, varAObjPtr
);
9882 Jim_DecrRefCount(interp
, varAObjPtr
);
9883 } else if (exprLen
== 3) {
9884 jim_wide wideValueA
, wideValueB
=0, cmpRes
= 0;
9885 int cmpType
= expr
->opcode
[2];
9887 varAObjPtr
= expr
->obj
[0];
9888 Jim_IncrRefCount(varAObjPtr
);
9889 if (expr
->opcode
[1] == JIM_EXPROP_VARIABLE
) {
9890 varBObjPtr
= expr
->obj
[1];
9891 Jim_IncrRefCount(varBObjPtr
);
9893 if (Jim_GetWide(interp
, expr
->obj
[1], &wideValueB
) != JIM_OK
)
9897 if (!(objPtr
= Jim_GetVariable(interp
, varAObjPtr
, JIM_NONE
)) ||
9898 Jim_GetWide(interp
, objPtr
, &wideValueA
) != JIM_OK
)
9900 Jim_DecrRefCount(interp
, varAObjPtr
);
9902 Jim_DecrRefCount(interp
, varBObjPtr
);
9907 Jim_GetVariable(interp
, varBObjPtr
, JIM_NONE
)) ||
9908 Jim_GetWide(interp
, objPtr
, &wideValueB
) != JIM_OK
)
9910 Jim_DecrRefCount(interp
, varAObjPtr
);
9912 Jim_DecrRefCount(interp
, varBObjPtr
);
9918 cmpRes
= wideValueA
< wideValueB
; break;
9919 case JIM_EXPROP_LTE
:
9920 cmpRes
= wideValueA
<= wideValueB
; break;
9922 cmpRes
= wideValueA
> wideValueB
; break;
9923 case JIM_EXPROP_GTE
:
9924 cmpRes
= wideValueA
>= wideValueB
; break;
9925 case JIM_EXPROP_NUMEQ
:
9926 cmpRes
= wideValueA
== wideValueB
; break;
9927 case JIM_EXPROP_NUMNE
:
9928 cmpRes
= wideValueA
!= wideValueB
; break;
9931 if ((retval
= Jim_EvalObj(interp
, argv
[2])) != JIM_OK
) {
9934 Jim_DecrRefCount(interp
, varAObjPtr
);
9936 Jim_DecrRefCount(interp
, varBObjPtr
);
9943 Jim_DecrRefCount(interp
, varAObjPtr
);
9945 Jim_DecrRefCount(interp
, varBObjPtr
);
9950 Jim_DecrRefCount(interp
, varAObjPtr
);
9952 Jim_DecrRefCount(interp
, varBObjPtr
);
9954 /* TODO: case for len == 2 */
9957 Jim_SetEmptyResult(interp
);
9963 /* The general purpose implementation of while starts here */
9965 int boolean
, retval
;
9967 if ((retval
= Jim_GetBoolFromExpr(interp
, argv
[1],
9968 &boolean
)) != JIM_OK
)
9970 if (!boolean
) break;
9971 if ((retval
= Jim_EvalObj(interp
, argv
[2])) != JIM_OK
) {
9985 Jim_SetEmptyResult(interp
);
9990 static int Jim_ForCoreCommand(Jim_Interp
*interp
, int argc
,
9991 Jim_Obj
*const *argv
)
9996 Jim_WrongNumArgs(interp
, 1, argv
, "start test next body");
9999 /* Check if the for is on the form:
10000 * for {set i CONST} {$i < CONST} {incr i}
10001 * for {set i CONST} {$i < $j} {incr i}
10002 * for {set i CONST} {$i <= CONST} {incr i}
10003 * for {set i CONST} {$i <= $j} {incr i}
10004 * XXX: NOTE: if variable traces are implemented, this optimization
10005 * need to be modified to check for the proc epoch at every variable
10007 #ifdef JIM_OPTIMIZATION
10009 ScriptObj
*initScript
, *incrScript
;
10010 ExprByteCode
*expr
;
10011 jim_wide start
, stop
=0, currentVal
;
10012 unsigned jim_wide procEpoch
= interp
->procEpoch
;
10013 Jim_Obj
*varNamePtr
, *stopVarNamePtr
= NULL
, *objPtr
;
10015 struct Jim_Cmd
*cmdPtr
;
10017 /* Do it only if there aren't shared arguments */
10018 if (argv
[1] == argv
[2] || argv
[2] == argv
[3] || argv
[1] == argv
[3])
10020 initScript
= Jim_GetScript(interp
, argv
[1]);
10021 expr
= Jim_GetExpression(interp
, argv
[2]);
10022 incrScript
= Jim_GetScript(interp
, argv
[3]);
10024 /* Ensure proper lengths to start */
10025 if (initScript
->len
!= 6) goto evalstart
;
10026 if (incrScript
->len
!= 4) goto evalstart
;
10027 if (expr
->len
!= 3) goto evalstart
;
10028 /* Ensure proper token types. */
10029 if (initScript
->token
[2].type
!= JIM_TT_ESC
||
10030 initScript
->token
[4].type
!= JIM_TT_ESC
||
10031 incrScript
->token
[2].type
!= JIM_TT_ESC
||
10032 expr
->opcode
[0] != JIM_EXPROP_VARIABLE
||
10033 (expr
->opcode
[1] != JIM_EXPROP_NUMBER
&&
10034 expr
->opcode
[1] != JIM_EXPROP_VARIABLE
) ||
10035 (expr
->opcode
[2] != JIM_EXPROP_LT
&&
10036 expr
->opcode
[2] != JIM_EXPROP_LTE
))
10038 cmpType
= expr
->opcode
[2];
10039 /* Initialization command must be [set] */
10040 cmdPtr
= Jim_GetCommand(interp
, initScript
->token
[0].objPtr
, JIM_NONE
);
10041 if (cmdPtr
== NULL
|| cmdPtr
->cmdProc
!= Jim_SetCoreCommand
)
10043 /* Update command must be incr */
10044 cmdPtr
= Jim_GetCommand(interp
, incrScript
->token
[0].objPtr
, JIM_NONE
);
10045 if (cmdPtr
== NULL
|| cmdPtr
->cmdProc
!= Jim_IncrCoreCommand
)
10047 /* set, incr, expression must be about the same variable */
10048 if (!Jim_StringEqObj(initScript
->token
[2].objPtr
,
10049 incrScript
->token
[2].objPtr
, 0))
10051 if (!Jim_StringEqObj(initScript
->token
[2].objPtr
,
10054 /* Check that the initialization and comparison are valid integers */
10055 if (Jim_GetWide(interp
, initScript
->token
[4].objPtr
, &start
) == JIM_ERR
)
10057 if (expr
->opcode
[1] == JIM_EXPROP_NUMBER
&&
10058 Jim_GetWide(interp
, expr
->obj
[1], &stop
) == JIM_ERR
)
10063 /* Initialization */
10064 varNamePtr
= expr
->obj
[0];
10065 if (expr
->opcode
[1] == JIM_EXPROP_VARIABLE
) {
10066 stopVarNamePtr
= expr
->obj
[1];
10067 Jim_IncrRefCount(stopVarNamePtr
);
10069 Jim_IncrRefCount(varNamePtr
);
10071 /* --- OPTIMIZED FOR --- */
10072 /* Start to loop */
10073 objPtr
= Jim_NewIntObj(interp
, start
);
10074 if (Jim_SetVariable(interp
, varNamePtr
, objPtr
) != JIM_OK
) {
10075 Jim_DecrRefCount(interp
, varNamePtr
);
10076 if (stopVarNamePtr
) Jim_DecrRefCount(interp
, stopVarNamePtr
);
10077 Jim_FreeNewObj(interp
, objPtr
);
10081 /* === Check condition === */
10083 objPtr
= Jim_GetVariable(interp
, varNamePtr
, JIM_NONE
);
10084 if (objPtr
== NULL
||
10085 Jim_GetWide(interp
, objPtr
, ¤tVal
) != JIM_OK
)
10087 Jim_DecrRefCount(interp
, varNamePtr
);
10088 if (stopVarNamePtr
) Jim_DecrRefCount(interp
, stopVarNamePtr
);
10091 /* Immediate or Variable? get the 'stop' value if the latter. */
10092 if (stopVarNamePtr
) {
10093 objPtr
= Jim_GetVariable(interp
, stopVarNamePtr
, JIM_NONE
);
10094 if (objPtr
== NULL
||
10095 Jim_GetWide(interp
, objPtr
, &stop
) != JIM_OK
)
10097 Jim_DecrRefCount(interp
, varNamePtr
);
10098 Jim_DecrRefCount(interp
, stopVarNamePtr
);
10102 if (cmpType
== JIM_EXPROP_LT
) {
10103 if (currentVal
>= stop
) break;
10105 if (currentVal
> stop
) break;
10108 if ((retval
= Jim_EvalObj(interp
, argv
[4])) != JIM_OK
) {
10111 if (stopVarNamePtr
)
10112 Jim_DecrRefCount(interp
, stopVarNamePtr
);
10113 Jim_DecrRefCount(interp
, varNamePtr
);
10116 /* nothing to do */
10119 if (stopVarNamePtr
)
10120 Jim_DecrRefCount(interp
, stopVarNamePtr
);
10121 Jim_DecrRefCount(interp
, varNamePtr
);
10125 /* If there was a change in procedures/command continue
10126 * with the usual [for] command implementation */
10127 if (procEpoch
!= interp
->procEpoch
) {
10128 if (stopVarNamePtr
)
10129 Jim_DecrRefCount(interp
, stopVarNamePtr
);
10130 Jim_DecrRefCount(interp
, varNamePtr
);
10134 objPtr
= Jim_GetVariable(interp
, varNamePtr
, JIM_ERRMSG
);
10135 if (objPtr
->refCount
== 1 && objPtr
->typePtr
== &intObjType
) {
10136 objPtr
->internalRep
.wideValue
++;
10137 Jim_InvalidateStringRep(objPtr
);
10139 Jim_Obj
*auxObjPtr
;
10141 if (Jim_GetWide(interp
, objPtr
, ¤tVal
) == JIM_ERR
) {
10142 if (stopVarNamePtr
)
10143 Jim_DecrRefCount(interp
, stopVarNamePtr
);
10144 Jim_DecrRefCount(interp
, varNamePtr
);
10147 auxObjPtr
= Jim_NewIntObj(interp
, currentVal
+ 1);
10148 if (Jim_SetVariable(interp
, varNamePtr
, auxObjPtr
) == JIM_ERR
) {
10149 if (stopVarNamePtr
)
10150 Jim_DecrRefCount(interp
, stopVarNamePtr
);
10151 Jim_DecrRefCount(interp
, varNamePtr
);
10152 Jim_FreeNewObj(interp
, auxObjPtr
);
10157 if (stopVarNamePtr
)
10158 Jim_DecrRefCount(interp
, stopVarNamePtr
);
10159 Jim_DecrRefCount(interp
, varNamePtr
);
10160 Jim_SetEmptyResult(interp
);
10166 if ((retval
= Jim_EvalObj(interp
, argv
[1])) != JIM_OK
)
10171 /* Test the condition */
10172 if ((retval
= Jim_GetBoolFromExpr(interp
, argv
[2], &boolean
))
10175 if (!boolean
) break;
10177 if ((retval
= Jim_EvalObj(interp
, argv
[4])) != JIM_OK
) {
10183 /* Nothing to do */
10191 if ((retval
= Jim_EvalObj(interp
, argv
[3])) != JIM_OK
) {
10205 Jim_SetEmptyResult(interp
);
10209 /* foreach + lmap implementation. */
10210 static int JimForeachMapHelper(Jim_Interp
*interp
, int argc
,
10211 Jim_Obj
*const *argv
, int doMap
)
10213 int result
= JIM_ERR
, i
, nbrOfLists
, *listsIdx
, *listsEnd
;
10214 int nbrOfLoops
= 0;
10215 Jim_Obj
*emptyStr
, *script
, *mapRes
= NULL
;
10217 if (argc
< 4 || argc
% 2 != 0) {
10218 Jim_WrongNumArgs(interp
, 1, argv
, "varList list ?varList list ...? script");
10222 mapRes
= Jim_NewListObj(interp
, NULL
, 0);
10223 Jim_IncrRefCount(mapRes
);
10225 emptyStr
= Jim_NewEmptyStringObj(interp
);
10226 Jim_IncrRefCount(emptyStr
);
10227 script
= argv
[argc
-1]; /* Last argument is a script */
10228 nbrOfLists
= (argc
- 1 - 1) / 2; /* argc - 'foreach' - script */
10229 listsIdx
= (int*)Jim_Alloc(nbrOfLists
* sizeof(int));
10230 listsEnd
= (int*)Jim_Alloc(nbrOfLists
*2 * sizeof(int));
10231 /* Initialize iterators and remember max nbr elements each list */
10232 memset(listsIdx
, 0, nbrOfLists
* sizeof(int));
10233 /* Remember lengths of all lists and calculate how much rounds to loop */
10234 for (i
= 0; i
< nbrOfLists
*2; i
+= 2) {
10237 Jim_ListLength(interp
, argv
[i
+ 1], &listsEnd
[i
]);
10238 Jim_ListLength(interp
, argv
[i
+ 2], &listsEnd
[i
+ 1]);
10239 if (listsEnd
[i
] == 0) {
10240 Jim_SetResultString(interp
, "foreach varlist is empty", -1);
10243 cnt
= div(listsEnd
[i
+ 1], listsEnd
[i
]);
10244 count
= cnt
.quot
+ (cnt
.rem
? 1 : 0);
10245 if (count
> nbrOfLoops
)
10246 nbrOfLoops
= count
;
10248 for (; nbrOfLoops
-- > 0;) {
10249 for (i
= 0; i
< nbrOfLists
; ++i
) {
10250 int varIdx
= 0, var
= i
* 2;
10251 while (varIdx
< listsEnd
[var
]) {
10252 Jim_Obj
*varName
, *ele
;
10253 int lst
= i
* 2 + 1;
10254 if (Jim_ListIndex(interp
, argv
[var
+ 1], varIdx
, &varName
, JIM_ERRMSG
)
10257 if (listsIdx
[i
] < listsEnd
[lst
]) {
10258 if (Jim_ListIndex(interp
, argv
[lst
+ 1], listsIdx
[i
], &ele
, JIM_ERRMSG
)
10261 if (Jim_SetVariable(interp
, varName
, ele
) != JIM_OK
) {
10262 Jim_SetResultString(interp
, "couldn't set loop variable: ", -1);
10265 ++listsIdx
[i
]; /* Remember next iterator of current list */
10266 } else if (Jim_SetVariable(interp
, varName
, emptyStr
) != JIM_OK
) {
10267 Jim_SetResultString(interp
, "couldn't set loop variable: ", -1);
10270 ++varIdx
; /* Next variable */
10273 switch (result
= Jim_EvalObj(interp
, script
)) {
10276 Jim_ListAppendElement(interp
, mapRes
, interp
->result
);
10290 Jim_SetResult(interp
, mapRes
);
10292 Jim_SetEmptyResult(interp
);
10295 Jim_DecrRefCount(interp
, mapRes
);
10296 Jim_DecrRefCount(interp
, emptyStr
);
10297 Jim_Free(listsIdx
);
10298 Jim_Free(listsEnd
);
10303 static int Jim_ForeachCoreCommand(Jim_Interp
*interp
, int argc
,
10304 Jim_Obj
*const *argv
)
10306 return JimForeachMapHelper(interp
, argc
, argv
, 0);
10310 static int Jim_LmapCoreCommand(Jim_Interp
*interp
, int argc
,
10311 Jim_Obj
*const *argv
)
10313 return JimForeachMapHelper(interp
, argc
, argv
, 1);
10317 static int Jim_IfCoreCommand(Jim_Interp
*interp
, int argc
,
10318 Jim_Obj
*const *argv
)
10320 int boolean
, retval
, current
= 1, falsebody
= 0;
10323 /* Far not enough arguments given! */
10324 if (current
>= argc
) goto err
;
10325 if ((retval
= Jim_GetBoolFromExpr(interp
,
10326 argv
[current
++], &boolean
))
10329 /* There lacks something, isn't it? */
10330 if (current
>= argc
) goto err
;
10331 if (Jim_CompareStringImmediate(interp
, argv
[current
],
10332 "then")) current
++;
10333 /* Tsk tsk, no then-clause? */
10334 if (current
>= argc
) goto err
;
10336 return Jim_EvalObj(interp
, argv
[current
]);
10337 /* Ok: no else-clause follows */
10338 if (++current
>= argc
) {
10339 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
10342 falsebody
= current
++;
10343 if (Jim_CompareStringImmediate(interp
, argv
[falsebody
],
10345 /* IIICKS - else-clause isn't last cmd? */
10346 if (current
!= argc
-1) goto err
;
10347 return Jim_EvalObj(interp
, argv
[current
]);
10348 } else if (Jim_CompareStringImmediate(interp
,
10349 argv
[falsebody
], "elseif"))
10350 /* Ok: elseif follows meaning all the stuff
10351 * again (how boring...) */
10353 /* OOPS - else-clause is not last cmd?*/
10354 else if (falsebody
!= argc
-1)
10356 return Jim_EvalObj(interp
, argv
[falsebody
]);
10361 Jim_WrongNumArgs(interp
, 1, argv
, "condition ?then? trueBody ?elseif ...? ?else? falseBody");
10365 enum {SWITCH_EXACT
, SWITCH_GLOB
, SWITCH_RE
, SWITCH_CMD
, SWITCH_UNKNOWN
};
10368 static int Jim_SwitchCoreCommand(Jim_Interp
*interp
, int argc
,
10369 Jim_Obj
*const *argv
)
10371 int retcode
= JIM_ERR
, matchOpt
= SWITCH_EXACT
, opt
= 1, patCount
, i
;
10372 Jim_Obj
*command
= 0, *const *caseList
= 0, *strObj
;
10373 Jim_Obj
*script
= 0;
10374 if (argc
< 3) goto wrongnumargs
;
10375 for (opt
= 1; opt
< argc
; ++opt
) {
10376 const char *option
= Jim_GetString(argv
[opt
], 0);
10377 if (*option
!= '-') break;
10378 else if (strncmp(option
, "--", 2) == 0) { ++opt
; break; }
10379 else if (strncmp(option
, "-exact", 2) == 0) matchOpt
= SWITCH_EXACT
;
10380 else if (strncmp(option
, "-glob", 2) == 0) matchOpt
= SWITCH_GLOB
;
10381 else if (strncmp(option
, "-regexp", 2) == 0) matchOpt
= SWITCH_RE
;
10382 else if (strncmp(option
, "-command", 2) == 0) { matchOpt
= SWITCH_CMD
;
10383 if ((argc
- opt
) < 2) goto wrongnumargs
;
10384 command
= argv
[++opt
];
10386 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
10387 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
10388 "bad option \"", option
, "\": must be -exact, -glob, "
10389 "-regexp, -command procname or --", 0);
10392 if ((argc
- opt
) < 2) goto wrongnumargs
;
10394 strObj
= argv
[opt
++];
10395 patCount
= argc
- opt
;
10396 if (patCount
== 1) {
10398 JimListGetElements(interp
, argv
[opt
], &patCount
, &vector
);
10401 caseList
= &argv
[opt
];
10402 if (patCount
== 0 || patCount
% 2 != 0) goto wrongnumargs
;
10403 for (i
= 0; script
== 0 && i
< patCount
; i
+= 2) {
10404 Jim_Obj
*patObj
= caseList
[i
];
10405 if (!Jim_CompareStringImmediate(interp
, patObj
, "default")
10406 || i
< (patCount
-2)) {
10407 switch (matchOpt
) {
10409 if (Jim_StringEqObj(strObj
, patObj
, 0))
10410 script
= caseList
[i
+ 1];
10413 if (Jim_StringMatchObj(patObj
, strObj
, 0))
10414 script
= caseList
[i
+ 1];
10417 command
= Jim_NewStringObj(interp
, "regexp", -1);
10418 /* Fall thru intentionally */
10420 Jim_Obj
*parms
[] = {command
, patObj
, strObj
};
10421 int rc
= Jim_EvalObjVector(interp
, 3, parms
);
10423 /* After the execution of a command we need to
10424 * make sure to reconvert the object into a list
10425 * again. Only for the single-list style [switch]. */
10426 if (argc
-opt
== 1) {
10428 JimListGetElements(interp
, argv
[opt
], &patCount
,
10432 /* command is here already decref'd */
10433 if (rc
!= JIM_OK
) {
10437 rc
= Jim_GetLong(interp
, Jim_GetResult(interp
), &matching
);
10438 if (rc
!= JIM_OK
) {
10443 script
= caseList
[i
+ 1];
10447 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
10448 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
10449 "internal error: no such option implemented", 0);
10453 script
= caseList
[i
+ 1];
10456 for (; i
< patCount
&& Jim_CompareStringImmediate(interp
, script
, "-");
10458 script
= caseList
[i
+ 1];
10459 if (script
&& Jim_CompareStringImmediate(interp
, script
, "-")) {
10460 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
10461 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
10462 "no body specified for pattern \"",
10463 Jim_GetString(caseList
[i
-2], 0), "\"", 0);
10467 Jim_SetEmptyResult(interp
);
10469 retcode
= Jim_EvalObj(interp
, script
);
10472 Jim_WrongNumArgs(interp
, 1, argv
, "?options? string "
10473 "pattern body ... ?default body? or "
10474 "{pattern body ?pattern body ...?}");
10480 static int Jim_ListCoreCommand(Jim_Interp
*interp
, int argc
,
10481 Jim_Obj
*const *argv
)
10483 Jim_Obj
*listObjPtr
;
10485 listObjPtr
= Jim_NewListObj(interp
, argv
+ 1, argc
-1);
10486 Jim_SetResult(interp
, listObjPtr
);
10491 static int Jim_LindexCoreCommand(Jim_Interp
*interp
, int argc
,
10492 Jim_Obj
*const *argv
)
10494 Jim_Obj
*objPtr
, *listObjPtr
;
10499 Jim_WrongNumArgs(interp
, 1, argv
, "list index ?...?");
10503 Jim_IncrRefCount(objPtr
);
10504 for (i
= 2; i
< argc
; i
++) {
10505 listObjPtr
= objPtr
;
10506 if (Jim_GetIndex(interp
, argv
[i
], &index
) != JIM_OK
) {
10507 Jim_DecrRefCount(interp
, listObjPtr
);
10510 if (Jim_ListIndex(interp
, listObjPtr
, index
, &objPtr
,
10511 JIM_NONE
) != JIM_OK
) {
10512 /* Returns an empty object if the index
10513 * is out of range. */
10514 Jim_DecrRefCount(interp
, listObjPtr
);
10515 Jim_SetEmptyResult(interp
);
10518 Jim_IncrRefCount(objPtr
);
10519 Jim_DecrRefCount(interp
, listObjPtr
);
10521 Jim_SetResult(interp
, objPtr
);
10522 Jim_DecrRefCount(interp
, objPtr
);
10527 static int Jim_LlengthCoreCommand(Jim_Interp
*interp
, int argc
,
10528 Jim_Obj
*const *argv
)
10533 Jim_WrongNumArgs(interp
, 1, argv
, "list");
10536 Jim_ListLength(interp
, argv
[1], &len
);
10537 Jim_SetResult(interp
, Jim_NewIntObj(interp
, len
));
10542 static int Jim_LappendCoreCommand(Jim_Interp
*interp
, int argc
,
10543 Jim_Obj
*const *argv
)
10545 Jim_Obj
*listObjPtr
;
10549 Jim_WrongNumArgs(interp
, 1, argv
, "varName ?value value ...?");
10552 listObjPtr
= Jim_GetVariable(interp
, argv
[1], JIM_NONE
);
10554 /* Create the list if it does not exists */
10555 listObjPtr
= Jim_NewListObj(interp
, NULL
, 0);
10556 if (Jim_SetVariable(interp
, argv
[1], listObjPtr
) != JIM_OK
) {
10557 Jim_FreeNewObj(interp
, listObjPtr
);
10561 shared
= Jim_IsShared(listObjPtr
);
10563 listObjPtr
= Jim_DuplicateObj(interp
, listObjPtr
);
10564 for (i
= 2; i
< argc
; i
++)
10565 Jim_ListAppendElement(interp
, listObjPtr
, argv
[i
]);
10566 if (Jim_SetVariable(interp
, argv
[1], listObjPtr
) != JIM_OK
) {
10568 Jim_FreeNewObj(interp
, listObjPtr
);
10571 Jim_SetResult(interp
, listObjPtr
);
10576 static int Jim_LinsertCoreCommand(Jim_Interp
*interp
, int argc
,
10577 Jim_Obj
*const *argv
)
10583 Jim_WrongNumArgs(interp
, 1, argv
, "list index element "
10588 if (Jim_IsShared(listPtr
))
10589 listPtr
= Jim_DuplicateObj(interp
, listPtr
);
10590 if (Jim_GetIndex(interp
, argv
[2], &index
) != JIM_OK
)
10592 Jim_ListLength(interp
, listPtr
, &len
);
10595 else if (index
< 0)
10596 index
= len
+ index
+ 1;
10597 Jim_ListInsertElements(interp
, listPtr
, index
, argc
-3, &argv
[3]);
10598 Jim_SetResult(interp
, listPtr
);
10601 if (listPtr
!= argv
[1]) {
10602 Jim_FreeNewObj(interp
, listPtr
);
10608 static int Jim_LsetCoreCommand(Jim_Interp
*interp
, int argc
,
10609 Jim_Obj
*const *argv
)
10612 Jim_WrongNumArgs(interp
, 1, argv
, "listVar ?index...? newVal");
10614 } else if (argc
== 3) {
10615 if (Jim_SetVariable(interp
, argv
[1], argv
[2]) != JIM_OK
)
10617 Jim_SetResult(interp
, argv
[2]);
10620 if (Jim_SetListIndex(interp
, argv
[1], argv
+ 2, argc
-3, argv
[argc
-1])
10621 == JIM_ERR
) return JIM_ERR
;
10626 static int Jim_LsortCoreCommand(Jim_Interp
*interp
, int argc
, Jim_Obj
*const argv
[])
10628 const char *options
[] = {
10629 "-ascii", "-nocase", "-increasing", "-decreasing", NULL
10631 enum {OPT_ASCII
, OPT_NOCASE
, OPT_INCREASING
, OPT_DECREASING
};
10633 int i
, lsortType
= JIM_LSORT_ASCII
; /* default sort type */
10634 int decreasing
= 0;
10637 Jim_WrongNumArgs(interp
, 1, argv
, "?options? list");
10640 for (i
= 1; i
< (argc
-1); i
++) {
10643 if (Jim_GetEnum(interp
, argv
[i
], options
, &option
, "option", JIM_ERRMSG
)
10647 case OPT_ASCII
: lsortType
= JIM_LSORT_ASCII
; break;
10648 case OPT_NOCASE
: lsortType
= JIM_LSORT_NOCASE
; break;
10649 case OPT_INCREASING
: decreasing
= 0; break;
10650 case OPT_DECREASING
: decreasing
= 1; break;
10654 switch (lsortType
) {
10655 case JIM_LSORT_ASCII
: lsortType
= JIM_LSORT_ASCII_DECR
; break;
10656 case JIM_LSORT_NOCASE
: lsortType
= JIM_LSORT_NOCASE_DECR
; break;
10659 resObj
= Jim_DuplicateObj(interp
, argv
[argc
-1]);
10660 ListSortElements(interp
, resObj
, lsortType
);
10661 Jim_SetResult(interp
, resObj
);
10666 static int Jim_AppendCoreCommand(Jim_Interp
*interp
, int argc
,
10667 Jim_Obj
*const *argv
)
10669 Jim_Obj
*stringObjPtr
;
10673 Jim_WrongNumArgs(interp
, 1, argv
, "varName ?value value ...?");
10677 stringObjPtr
= Jim_GetVariable(interp
, argv
[1], JIM_ERRMSG
);
10678 if (!stringObjPtr
) return JIM_ERR
;
10680 stringObjPtr
= Jim_GetVariable(interp
, argv
[1], JIM_NONE
);
10681 if (!stringObjPtr
) {
10682 /* Create the string if it does not exists */
10683 stringObjPtr
= Jim_NewEmptyStringObj(interp
);
10684 if (Jim_SetVariable(interp
, argv
[1], stringObjPtr
)
10686 Jim_FreeNewObj(interp
, stringObjPtr
);
10691 shared
= Jim_IsShared(stringObjPtr
);
10693 stringObjPtr
= Jim_DuplicateObj(interp
, stringObjPtr
);
10694 for (i
= 2; i
< argc
; i
++)
10695 Jim_AppendObj(interp
, stringObjPtr
, argv
[i
]);
10696 if (Jim_SetVariable(interp
, argv
[1], stringObjPtr
) != JIM_OK
) {
10698 Jim_FreeNewObj(interp
, stringObjPtr
);
10701 Jim_SetResult(interp
, stringObjPtr
);
10706 static int Jim_DebugCoreCommand(Jim_Interp
*interp
, int argc
,
10707 Jim_Obj
*const *argv
)
10709 const char *options
[] = {
10710 "refcount", "objcount", "objects", "invstr", "scriptlen", "exprlen",
10715 OPT_REFCOUNT
, OPT_OBJCOUNT
, OPT_OBJECTS
, OPT_INVSTR
, OPT_SCRIPTLEN
,
10716 OPT_EXPRLEN
, OPT_EXPRBC
10721 Jim_WrongNumArgs(interp
, 1, argv
, "option ?...?");
10724 if (Jim_GetEnum(interp
, argv
[1], options
, &option
, "option",
10725 JIM_ERRMSG
) != JIM_OK
)
10727 if (option
== OPT_REFCOUNT
) {
10729 Jim_WrongNumArgs(interp
, 2, argv
, "object");
10732 Jim_SetResult(interp
, Jim_NewIntObj(interp
, argv
[2]->refCount
));
10734 } else if (option
== OPT_OBJCOUNT
) {
10735 int freeobj
= 0, liveobj
= 0;
10740 Jim_WrongNumArgs(interp
, 2, argv
, "");
10743 /* Count the number of free objects. */
10744 objPtr
= interp
->freeList
;
10747 objPtr
= objPtr
->nextObjPtr
;
10749 /* Count the number of live objects. */
10750 objPtr
= interp
->liveList
;
10753 objPtr
= objPtr
->nextObjPtr
;
10755 /* Set the result string and return. */
10756 sprintf(buf
, "free %d used %d", freeobj
, liveobj
);
10757 Jim_SetResultString(interp
, buf
, -1);
10759 } else if (option
== OPT_OBJECTS
) {
10760 Jim_Obj
*objPtr
, *listObjPtr
, *subListObjPtr
;
10761 /* Count the number of live objects. */
10762 objPtr
= interp
->liveList
;
10763 listObjPtr
= Jim_NewListObj(interp
, NULL
, 0);
10766 const char *type
= objPtr
->typePtr
?
10767 objPtr
->typePtr
->name
: "";
10768 subListObjPtr
= Jim_NewListObj(interp
, NULL
, 0);
10769 sprintf(buf
, "%p", (void *)objPtr
);
10770 Jim_ListAppendElement(interp
, subListObjPtr
,
10771 Jim_NewStringObj(interp
, buf
, -1));
10772 Jim_ListAppendElement(interp
, subListObjPtr
,
10773 Jim_NewStringObj(interp
, type
, -1));
10774 Jim_ListAppendElement(interp
, subListObjPtr
,
10775 Jim_NewIntObj(interp
, objPtr
->refCount
));
10776 Jim_ListAppendElement(interp
, subListObjPtr
, objPtr
);
10777 Jim_ListAppendElement(interp
, listObjPtr
, subListObjPtr
);
10778 objPtr
= objPtr
->nextObjPtr
;
10780 Jim_SetResult(interp
, listObjPtr
);
10782 } else if (option
== OPT_INVSTR
) {
10786 Jim_WrongNumArgs(interp
, 2, argv
, "object");
10790 if (objPtr
->typePtr
!= NULL
)
10791 Jim_InvalidateStringRep(objPtr
);
10792 Jim_SetEmptyResult(interp
);
10794 } else if (option
== OPT_SCRIPTLEN
) {
10797 Jim_WrongNumArgs(interp
, 2, argv
, "script");
10800 script
= Jim_GetScript(interp
, argv
[2]);
10801 Jim_SetResult(interp
, Jim_NewIntObj(interp
, script
->len
));
10803 } else if (option
== OPT_EXPRLEN
) {
10804 ExprByteCode
*expr
;
10806 Jim_WrongNumArgs(interp
, 2, argv
, "expression");
10809 expr
= Jim_GetExpression(interp
, argv
[2]);
10812 Jim_SetResult(interp
, Jim_NewIntObj(interp
, expr
->len
));
10814 } else if (option
== OPT_EXPRBC
) {
10816 ExprByteCode
*expr
;
10820 Jim_WrongNumArgs(interp
, 2, argv
, "expression");
10823 expr
= Jim_GetExpression(interp
, argv
[2]);
10826 objPtr
= Jim_NewListObj(interp
, NULL
, 0);
10827 for (i
= 0; i
< expr
->len
; i
++) {
10829 Jim_ExprOperator
*op
;
10831 switch (expr
->opcode
[i
]) {
10832 case JIM_EXPROP_NUMBER
: type
= "number"; break;
10833 case JIM_EXPROP_COMMAND
: type
= "command"; break;
10834 case JIM_EXPROP_VARIABLE
: type
= "variable"; break;
10835 case JIM_EXPROP_DICTSUGAR
: type
= "dictsugar"; break;
10836 case JIM_EXPROP_SUBST
: type
= "subst"; break;
10837 case JIM_EXPROP_STRING
: type
= "string"; break;
10839 op
= JimExprOperatorInfo(Jim_GetString(expr
->obj
[i
], NULL
));
10847 Jim_ListAppendElement(interp
, objPtr
,
10848 Jim_NewStringObj(interp
, type
, -1));
10849 Jim_ListAppendElement(interp
, objPtr
, expr
->obj
[i
]);
10851 Jim_SetResult(interp
, objPtr
);
10854 Jim_SetResultString(interp
,
10855 "bad option. Valid options are refcount, "
10856 "objcount, objects, invstr", -1);
10859 return JIM_OK
; /* unreached */
10863 static int Jim_EvalCoreCommand(Jim_Interp
*interp
, int argc
,
10864 Jim_Obj
*const *argv
)
10867 return Jim_EvalObj(interp
, argv
[1]);
10868 } else if (argc
> 2) {
10872 objPtr
= Jim_ConcatObj(interp
, argc
-1, argv
+ 1);
10873 Jim_IncrRefCount(objPtr
);
10874 retcode
= Jim_EvalObj(interp
, objPtr
);
10875 Jim_DecrRefCount(interp
, objPtr
);
10878 Jim_WrongNumArgs(interp
, 1, argv
, "script ?...?");
10884 static int Jim_UplevelCoreCommand(Jim_Interp
*interp
, int argc
,
10885 Jim_Obj
*const *argv
)
10888 int retcode
, newLevel
, oldLevel
;
10889 Jim_CallFrame
*savedCallFrame
, *targetCallFrame
;
10893 /* Save the old callframe pointer */
10894 savedCallFrame
= interp
->framePtr
;
10896 /* Lookup the target frame pointer */
10897 str
= Jim_GetString(argv
[1], NULL
);
10898 if ((str
[0] >= '0' && str
[0] <= '9') || str
[0] == '#')
10900 if (Jim_GetCallFrameByLevel(interp
, argv
[1],
10902 &newLevel
) != JIM_OK
)
10907 if (Jim_GetCallFrameByLevel(interp
, NULL
,
10909 &newLevel
) != JIM_OK
)
10915 Jim_WrongNumArgs(interp
, 1, argv
,
10916 "?level? command ?arg ...?");
10919 /* Eval the code in the target callframe. */
10920 interp
->framePtr
= targetCallFrame
;
10921 oldLevel
= interp
->numLevels
;
10922 interp
->numLevels
= newLevel
;
10924 retcode
= Jim_EvalObj(interp
, argv
[1]);
10926 objPtr
= Jim_ConcatObj(interp
, argc
-1, argv
+ 1);
10927 Jim_IncrRefCount(objPtr
);
10928 retcode
= Jim_EvalObj(interp
, objPtr
);
10929 Jim_DecrRefCount(interp
, objPtr
);
10931 interp
->numLevels
= oldLevel
;
10932 interp
->framePtr
= savedCallFrame
;
10935 Jim_WrongNumArgs(interp
, 1, argv
, "?level? command ?arg ...?");
10941 static int Jim_ExprCoreCommand(Jim_Interp
*interp
, int argc
,
10942 Jim_Obj
*const *argv
)
10944 Jim_Obj
*exprResultPtr
;
10948 retcode
= Jim_EvalExpression(interp
, argv
[1], &exprResultPtr
);
10949 } else if (argc
> 2) {
10952 objPtr
= Jim_ConcatObj(interp
, argc
-1, argv
+ 1);
10953 Jim_IncrRefCount(objPtr
);
10954 retcode
= Jim_EvalExpression(interp
, objPtr
, &exprResultPtr
);
10955 Jim_DecrRefCount(interp
, objPtr
);
10957 Jim_WrongNumArgs(interp
, 1, argv
, "expression ?...?");
10960 if (retcode
!= JIM_OK
) return retcode
;
10961 Jim_SetResult(interp
, exprResultPtr
);
10962 Jim_DecrRefCount(interp
, exprResultPtr
);
10967 static int Jim_BreakCoreCommand(Jim_Interp
*interp
, int argc
,
10968 Jim_Obj
*const *argv
)
10971 Jim_WrongNumArgs(interp
, 1, argv
, "");
10978 static int Jim_ContinueCoreCommand(Jim_Interp
*interp
, int argc
,
10979 Jim_Obj
*const *argv
)
10982 Jim_WrongNumArgs(interp
, 1, argv
, "");
10985 return JIM_CONTINUE
;
10989 static int Jim_ReturnCoreCommand(Jim_Interp
*interp
, int argc
,
10990 Jim_Obj
*const *argv
)
10994 } else if (argc
== 2) {
10995 Jim_SetResult(interp
, argv
[1]);
10996 interp
->returnCode
= JIM_OK
;
10998 } else if (argc
== 3 || argc
== 4) {
11000 if (Jim_GetReturnCode(interp
, argv
[2], &returnCode
) == JIM_ERR
)
11002 interp
->returnCode
= returnCode
;
11004 Jim_SetResult(interp
, argv
[3]);
11007 Jim_WrongNumArgs(interp
, 1, argv
, "?-code code? ?result?");
11010 return JIM_RETURN
; /* unreached */
11014 static int Jim_TailcallCoreCommand(Jim_Interp
*interp
, int argc
,
11015 Jim_Obj
*const *argv
)
11019 objPtr
= Jim_NewListObj(interp
, argv
+ 1, argc
-1);
11020 Jim_SetResult(interp
, objPtr
);
11025 static int Jim_ProcCoreCommand(Jim_Interp
*interp
, int argc
,
11026 Jim_Obj
*const *argv
)
11029 int arityMin
, arityMax
;
11031 if (argc
!= 4 && argc
!= 5) {
11032 Jim_WrongNumArgs(interp
, 1, argv
, "name arglist ?statics? body");
11035 Jim_ListLength(interp
, argv
[2], &argListLen
);
11036 arityMin
= arityMax
= argListLen
+ 1;
11041 Jim_Obj
*argPtr
=NULL
;
11043 /* Check for 'args' and adjust arityMin and arityMax if necessary */
11044 Jim_ListIndex(interp
, argv
[2], argListLen
-1, &argPtr
, JIM_NONE
);
11045 str
= Jim_GetString(argPtr
, &len
);
11046 if (len
== 4 && memcmp(str
, "args", 4) == 0) {
11051 /* Check for default arguments and reduce arityMin if necessary */
11052 while (arityMin
> 1) {
11054 Jim_ListIndex(interp
, argv
[2], arityMin
- 2, &argPtr
, JIM_NONE
);
11055 Jim_ListLength(interp
, argPtr
, &len
);
11057 /* No default argument */
11064 return Jim_CreateProcedure(interp
, Jim_GetString(argv
[1], NULL
),
11065 argv
[2], NULL
, argv
[3], arityMin
, arityMax
);
11067 return Jim_CreateProcedure(interp
, Jim_GetString(argv
[1], NULL
),
11068 argv
[2], argv
[3], argv
[4], arityMin
, arityMax
);
11073 static int Jim_ConcatCoreCommand(Jim_Interp
*interp
, int argc
,
11074 Jim_Obj
*const *argv
)
11076 Jim_SetResult(interp
, Jim_ConcatObj(interp
, argc
-1, argv
+ 1));
11081 static int Jim_UpvarCoreCommand(Jim_Interp
*interp
, int argc
,
11082 Jim_Obj
*const *argv
)
11086 Jim_CallFrame
*targetCallFrame
;
11088 /* Lookup the target frame pointer */
11089 str
= Jim_GetString(argv
[1], NULL
);
11091 ((str
[0] >= '0' && str
[0] <= '9') || str
[0] == '#'))
11093 if (Jim_GetCallFrameByLevel(interp
, argv
[1],
11094 &targetCallFrame
, NULL
) != JIM_OK
)
11099 if (Jim_GetCallFrameByLevel(interp
, NULL
,
11100 &targetCallFrame
, NULL
) != JIM_OK
)
11103 /* Check for arity */
11104 if (argc
< 3 || ((argc
-1)%2) != 0) {
11105 Jim_WrongNumArgs(interp
, 1, argv
, "?level? otherVar localVar ?otherVar localVar ...?");
11108 /* Now... for every other/local couple: */
11109 for (i
= 1; i
< argc
; i
+= 2) {
11110 if (Jim_SetVariableLink(interp
, argv
[i
+ 1], argv
[i
],
11111 targetCallFrame
) != JIM_OK
) return JIM_ERR
;
11117 static int Jim_GlobalCoreCommand(Jim_Interp
*interp
, int argc
,
11118 Jim_Obj
*const *argv
)
11123 Jim_WrongNumArgs(interp
, 1, argv
, "varName ?varName ...?");
11126 /* Link every var to the toplevel having the same name */
11127 if (interp
->numLevels
== 0) return JIM_OK
; /* global at toplevel... */
11128 for (i
= 1; i
< argc
; i
++) {
11129 if (Jim_SetVariableLink(interp
, argv
[i
], argv
[i
],
11130 interp
->topFramePtr
) != JIM_OK
) return JIM_ERR
;
11135 /* does the [string map] operation. On error NULL is returned,
11136 * otherwise a new string object with the result, having refcount = 0,
11138 static Jim_Obj
*JimStringMap(Jim_Interp
*interp
, Jim_Obj
*mapListObjPtr
,
11139 Jim_Obj
*objPtr
, int nocase
)
11142 const char **key
, *str
, *noMatchStart
= NULL
;
11144 int *keyLen
, strLen
, i
;
11145 Jim_Obj
*resultObjPtr
;
11147 Jim_ListLength(interp
, mapListObjPtr
, &numMaps
);
11149 Jim_SetResultString(interp
,
11150 "list must contain an even number of elements", -1);
11153 /* Initialization */
11155 key
= Jim_Alloc(sizeof(char*)*numMaps
);
11156 keyLen
= Jim_Alloc(sizeof(int)*numMaps
);
11157 value
= Jim_Alloc(sizeof(Jim_Obj
*)*numMaps
);
11158 resultObjPtr
= Jim_NewStringObj(interp
, "", 0);
11159 for (i
= 0; i
< numMaps
; i
++) {
11160 Jim_Obj
*eleObjPtr
=NULL
;
11162 Jim_ListIndex(interp
, mapListObjPtr
, i
*2, &eleObjPtr
, JIM_NONE
);
11163 key
[i
] = Jim_GetString(eleObjPtr
, &keyLen
[i
]);
11164 Jim_ListIndex(interp
, mapListObjPtr
, i
*2 + 1, &eleObjPtr
, JIM_NONE
);
11165 value
[i
] = eleObjPtr
;
11167 str
= Jim_GetString(objPtr
, &strLen
);
11170 for (i
= 0; i
< numMaps
; i
++) {
11171 if (strLen
>= keyLen
[i
] && keyLen
[i
]) {
11172 if (!JimStringCompare(str
, keyLen
[i
], key
[i
], keyLen
[i
],
11175 if (noMatchStart
) {
11176 Jim_AppendString(interp
, resultObjPtr
,
11177 noMatchStart
, str
-noMatchStart
);
11178 noMatchStart
= NULL
;
11180 Jim_AppendObj(interp
, resultObjPtr
, value
[i
]);
11182 strLen
-= keyLen
[i
];
11187 if (i
== numMaps
) { /* no match */
11188 if (noMatchStart
== NULL
)
11189 noMatchStart
= str
;
11194 if (noMatchStart
) {
11195 Jim_AppendString(interp
, resultObjPtr
,
11196 noMatchStart
, str
-noMatchStart
);
11198 Jim_Free((void*)key
);
11201 return resultObjPtr
;
11205 static int Jim_StringCoreCommand(Jim_Interp
*interp
, int argc
,
11206 Jim_Obj
*const *argv
)
11209 const char *options
[] = {
11210 "length", "compare", "match", "equal", "range", "map", "repeat",
11211 "index", "first", "tolower", "toupper", NULL
11214 OPT_LENGTH
, OPT_COMPARE
, OPT_MATCH
, OPT_EQUAL
, OPT_RANGE
,
11215 OPT_MAP
, OPT_REPEAT
, OPT_INDEX
, OPT_FIRST
, OPT_TOLOWER
, OPT_TOUPPER
11219 Jim_WrongNumArgs(interp
, 1, argv
, "option ?arguments ...?");
11222 if (Jim_GetEnum(interp
, argv
[1], options
, &option
, "option",
11223 JIM_ERRMSG
) != JIM_OK
)
11226 if (option
== OPT_LENGTH
) {
11230 Jim_WrongNumArgs(interp
, 2, argv
, "string");
11233 Jim_GetString(argv
[2], &len
);
11234 Jim_SetResult(interp
, Jim_NewIntObj(interp
, len
));
11236 } else if (option
== OPT_COMPARE
) {
11238 if ((argc
!= 4 && argc
!= 5) ||
11239 (argc
== 5 && Jim_CompareStringImmediate(interp
,
11240 argv
[2], "-nocase") == 0)) {
11241 Jim_WrongNumArgs(interp
, 2, argv
, "string1 string2");
11248 Jim_SetResult(interp
, Jim_NewIntObj(interp
,
11249 Jim_StringCompareObj(argv
[2],
11250 argv
[3], nocase
)));
11252 } else if (option
== OPT_MATCH
) {
11254 if ((argc
!= 4 && argc
!= 5) ||
11255 (argc
== 5 && Jim_CompareStringImmediate(interp
,
11256 argv
[2], "-nocase") == 0)) {
11257 Jim_WrongNumArgs(interp
, 2, argv
, "?-nocase? pattern "
11265 Jim_SetResult(interp
,
11266 Jim_NewIntObj(interp
, Jim_StringMatchObj(argv
[2],
11267 argv
[3], nocase
)));
11269 } else if (option
== OPT_EQUAL
) {
11271 Jim_WrongNumArgs(interp
, 2, argv
, "string1 string2");
11274 Jim_SetResult(interp
,
11275 Jim_NewIntObj(interp
, Jim_StringEqObj(argv
[2],
11278 } else if (option
== OPT_RANGE
) {
11282 Jim_WrongNumArgs(interp
, 2, argv
, "string first last");
11285 objPtr
= Jim_StringRangeObj(interp
, argv
[2], argv
[3], argv
[4]);
11286 if (objPtr
== NULL
)
11288 Jim_SetResult(interp
, objPtr
);
11290 } else if (option
== OPT_MAP
) {
11294 if ((argc
!= 4 && argc
!= 5) ||
11295 (argc
== 5 && Jim_CompareStringImmediate(interp
,
11296 argv
[2], "-nocase") == 0)) {
11297 Jim_WrongNumArgs(interp
, 2, argv
, "?-nocase? mapList "
11305 objPtr
= JimStringMap(interp
, argv
[2], argv
[3], nocase
);
11306 if (objPtr
== NULL
)
11308 Jim_SetResult(interp
, objPtr
);
11310 } else if (option
== OPT_REPEAT
) {
11315 Jim_WrongNumArgs(interp
, 2, argv
, "string count");
11318 if (Jim_GetWide(interp
, argv
[3], &count
) != JIM_OK
)
11320 objPtr
= Jim_NewStringObj(interp
, "", 0);
11322 Jim_AppendObj(interp
, objPtr
, argv
[2]);
11324 Jim_SetResult(interp
, objPtr
);
11326 } else if (option
== OPT_INDEX
) {
11331 Jim_WrongNumArgs(interp
, 2, argv
, "string index");
11334 if (Jim_GetIndex(interp
, argv
[3], &index
) != JIM_OK
)
11336 str
= Jim_GetString(argv
[2], &len
);
11337 if (index
!= INT_MIN
&& index
!= INT_MAX
)
11338 index
= JimRelToAbsIndex(len
, index
);
11339 if (index
< 0 || index
>= len
) {
11340 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
11343 Jim_SetResult(interp
, Jim_NewStringObj(interp
, str
+ index
, 1));
11346 } else if (option
== OPT_FIRST
) {
11347 int index
= 0, l1
, l2
;
11348 const char *s1
, *s2
;
11350 if (argc
!= 4 && argc
!= 5) {
11351 Jim_WrongNumArgs(interp
, 2, argv
, "subString string ?startIndex?");
11354 s1
= Jim_GetString(argv
[2], &l1
);
11355 s2
= Jim_GetString(argv
[3], &l2
);
11357 if (Jim_GetIndex(interp
, argv
[4], &index
) != JIM_OK
)
11359 index
= JimRelToAbsIndex(l2
, index
);
11361 Jim_SetResult(interp
, Jim_NewIntObj(interp
,
11362 JimStringFirst(s1
, l1
, s2
, l2
, index
)));
11364 } else if (option
== OPT_TOLOWER
) {
11366 Jim_WrongNumArgs(interp
, 2, argv
, "string");
11369 Jim_SetResult(interp
, JimStringToLower(interp
, argv
[2]));
11370 } else if (option
== OPT_TOUPPER
) {
11372 Jim_WrongNumArgs(interp
, 2, argv
, "string");
11375 Jim_SetResult(interp
, JimStringToUpper(interp
, argv
[2]));
11381 static int Jim_TimeCoreCommand(Jim_Interp
*interp
, int argc
,
11382 Jim_Obj
*const *argv
)
11385 jim_wide start
, elapsed
;
11387 const char *fmt
= "%" JIM_WIDE_MODIFIER
" microseconds per iteration";
11390 Jim_WrongNumArgs(interp
, 1, argv
, "script ?count?");
11394 if (Jim_GetLong(interp
, argv
[2], &count
) != JIM_OK
)
11400 start
= JimClock();
11404 if ((retval
= Jim_EvalObj(interp
, argv
[1])) != JIM_OK
)
11407 elapsed
= JimClock() - start
;
11408 sprintf(buf
, fmt
, elapsed
/count
);
11409 Jim_SetResultString(interp
, buf
, -1);
11414 static int Jim_ExitCoreCommand(Jim_Interp
*interp
, int argc
,
11415 Jim_Obj
*const *argv
)
11420 Jim_WrongNumArgs(interp
, 1, argv
, "?exitCode?");
11424 if (Jim_GetLong(interp
, argv
[1], &exitCode
) != JIM_OK
)
11427 interp
->exitCode
= exitCode
;
11432 static int Jim_CatchCoreCommand(Jim_Interp
*interp
, int argc
,
11433 Jim_Obj
*const *argv
)
11437 if (argc
!= 2 && argc
!= 3) {
11438 Jim_WrongNumArgs(interp
, 1, argv
, "script ?varName?");
11441 exitCode
= Jim_EvalObj(interp
, argv
[1]);
11443 if (Jim_SetVariable(interp
, argv
[2], Jim_GetResult(interp
))
11447 Jim_SetResult(interp
, Jim_NewIntObj(interp
, exitCode
));
11452 static int Jim_RefCoreCommand(Jim_Interp
*interp
, int argc
,
11453 Jim_Obj
*const *argv
)
11455 if (argc
!= 3 && argc
!= 4) {
11456 Jim_WrongNumArgs(interp
, 1, argv
, "string tag ?finalizer?");
11460 Jim_SetResult(interp
, Jim_NewReference(interp
, argv
[1], argv
[2], NULL
));
11462 Jim_SetResult(interp
, Jim_NewReference(interp
, argv
[1], argv
[2],
11469 static int Jim_GetrefCoreCommand(Jim_Interp
*interp
, int argc
,
11470 Jim_Obj
*const *argv
)
11472 Jim_Reference
*refPtr
;
11475 Jim_WrongNumArgs(interp
, 1, argv
, "reference");
11478 if ((refPtr
= Jim_GetReference(interp
, argv
[1])) == NULL
)
11480 Jim_SetResult(interp
, refPtr
->objPtr
);
11485 static int Jim_SetrefCoreCommand(Jim_Interp
*interp
, int argc
,
11486 Jim_Obj
*const *argv
)
11488 Jim_Reference
*refPtr
;
11491 Jim_WrongNumArgs(interp
, 1, argv
, "reference newValue");
11494 if ((refPtr
= Jim_GetReference(interp
, argv
[1])) == NULL
)
11496 Jim_IncrRefCount(argv
[2]);
11497 Jim_DecrRefCount(interp
, refPtr
->objPtr
);
11498 refPtr
->objPtr
= argv
[2];
11499 Jim_SetResult(interp
, argv
[2]);
11504 static int Jim_CollectCoreCommand(Jim_Interp
*interp
, int argc
,
11505 Jim_Obj
*const *argv
)
11508 Jim_WrongNumArgs(interp
, 1, argv
, "");
11511 Jim_SetResult(interp
, Jim_NewIntObj(interp
, Jim_Collect(interp
)));
11515 /* [finalize] reference ?newValue? */
11516 static int Jim_FinalizeCoreCommand(Jim_Interp
*interp
, int argc
,
11517 Jim_Obj
*const *argv
)
11519 if (argc
!= 2 && argc
!= 3) {
11520 Jim_WrongNumArgs(interp
, 1, argv
, "reference ?finalizerProc?");
11524 Jim_Obj
*cmdNamePtr
;
11526 if (Jim_GetFinalizer(interp
, argv
[1], &cmdNamePtr
) != JIM_OK
)
11528 if (cmdNamePtr
!= NULL
) /* otherwise the null string is returned. */
11529 Jim_SetResult(interp
, cmdNamePtr
);
11531 if (Jim_SetFinalizer(interp
, argv
[1], argv
[2]) != JIM_OK
)
11533 Jim_SetResult(interp
, argv
[2]);
11539 /* [info references] (list of all the references/finalizers) */
11542 static int Jim_RenameCoreCommand(Jim_Interp
*interp
, int argc
,
11543 Jim_Obj
*const *argv
)
11545 const char *oldName
, *newName
;
11548 Jim_WrongNumArgs(interp
, 1, argv
, "oldName newName");
11551 oldName
= Jim_GetString(argv
[1], NULL
);
11552 newName
= Jim_GetString(argv
[2], NULL
);
11553 if (Jim_RenameCommand(interp
, oldName
, newName
) != JIM_OK
) {
11554 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
11555 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
11556 "can't rename \"", oldName
, "\": ",
11557 "command doesn't exist", NULL
);
11564 static int Jim_DictCoreCommand(Jim_Interp
*interp
, int argc
,
11565 Jim_Obj
*const *argv
)
11568 const char *options
[] = {
11569 "create", "get", "set", "unset", "exists", NULL
11572 OPT_CREATE
, OPT_GET
, OPT_SET
, OPT_UNSET
, OPT_EXIST
11576 Jim_WrongNumArgs(interp
, 1, argv
, "option ?arguments ...?");
11580 if (Jim_GetEnum(interp
, argv
[1], options
, &option
, "option",
11581 JIM_ERRMSG
) != JIM_OK
)
11584 if (option
== OPT_CREATE
) {
11588 Jim_WrongNumArgs(interp
, 2, argv
, "?key value ...?");
11591 objPtr
= Jim_NewDictObj(interp
, argv
+ 2, argc
-2);
11592 Jim_SetResult(interp
, objPtr
);
11594 } else if (option
== OPT_GET
) {
11597 if (Jim_DictKeysVector(interp
, argv
[2], argv
+ 3, argc
-3, &objPtr
,
11598 JIM_ERRMSG
) != JIM_OK
)
11600 Jim_SetResult(interp
, objPtr
);
11602 } else if (option
== OPT_SET
) {
11604 Jim_WrongNumArgs(interp
, 2, argv
, "varName key ?key ...? value");
11607 return Jim_SetDictKeysVector(interp
, argv
[2], argv
+ 3, argc
-4,
11609 } else if (option
== OPT_UNSET
) {
11611 Jim_WrongNumArgs(interp
, 2, argv
, "varName key ?key ...?");
11614 return Jim_SetDictKeysVector(interp
, argv
[2], argv
+ 3, argc
-3,
11616 } else if (option
== OPT_EXIST
) {
11620 if (Jim_DictKeysVector(interp
, argv
[2], argv
+ 3, argc
-3, &objPtr
,
11621 JIM_ERRMSG
) == JIM_OK
)
11625 Jim_SetResult(interp
, Jim_NewIntObj(interp
, exists
));
11628 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
11629 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
11630 "bad option \"", Jim_GetString(argv
[1], NULL
), "\":",
11631 " must be create, get, set", NULL
);
11638 static int Jim_LoadCoreCommand(Jim_Interp
*interp
, int argc
,
11639 Jim_Obj
*const *argv
)
11642 Jim_WrongNumArgs(interp
, 1, argv
, "libaryFile");
11645 return Jim_LoadLibrary(interp
, Jim_GetString(argv
[1], NULL
));
11649 static int Jim_SubstCoreCommand(Jim_Interp
*interp
, int argc
,
11650 Jim_Obj
*const *argv
)
11656 Jim_WrongNumArgs(interp
, 1, argv
,
11657 "?-nobackslashes? ?-nocommands? ?-novariables? string");
11662 if (Jim_CompareStringImmediate(interp
, argv
[i
+ 1],
11664 flags
|= JIM_SUBST_NOESC
;
11665 else if (Jim_CompareStringImmediate(interp
, argv
[i
+ 1],
11667 flags
|= JIM_SUBST_NOVAR
;
11668 else if (Jim_CompareStringImmediate(interp
, argv
[i
+ 1],
11670 flags
|= JIM_SUBST_NOCMD
;
11672 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
11673 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
11674 "bad option \"", Jim_GetString(argv
[i
+ 1], NULL
),
11675 "\": must be -nobackslashes, -nocommands, or "
11676 "-novariables", NULL
);
11680 if (Jim_SubstObj(interp
, argv
[argc
-1], &objPtr
, flags
) != JIM_OK
)
11682 Jim_SetResult(interp
, objPtr
);
11687 static int Jim_InfoCoreCommand(Jim_Interp
*interp
, int argc
,
11688 Jim_Obj
*const *argv
)
11690 int cmd
, result
= JIM_OK
;
11691 static const char *commands
[] = {
11692 "body", "commands", "exists", "globals", "level", "locals",
11693 "vars", "version", "complete", "args", "hostname", NULL
11695 enum {INFO_BODY
, INFO_COMMANDS
, INFO_EXISTS
, INFO_GLOBALS
, INFO_LEVEL
,
11696 INFO_LOCALS
, INFO_VARS
, INFO_VERSION
, INFO_COMPLETE
, INFO_ARGS
, INFO_HOSTNAME
};
11699 Jim_WrongNumArgs(interp
, 1, argv
, "command ?args ...?");
11702 if (Jim_GetEnum(interp
, argv
[1], commands
, &cmd
, "command", JIM_ERRMSG
)
11707 if (cmd
== INFO_COMMANDS
) {
11708 if (argc
!= 2 && argc
!= 3) {
11709 Jim_WrongNumArgs(interp
, 2, argv
, "?pattern?");
11713 Jim_SetResult(interp
,JimCommandsList(interp
, argv
[2]));
11715 Jim_SetResult(interp
, JimCommandsList(interp
, NULL
));
11716 } else if (cmd
== INFO_EXISTS
) {
11719 Jim_WrongNumArgs(interp
, 2, argv
, "varName");
11722 exists
= Jim_GetVariable(interp
, argv
[2], 0);
11723 Jim_SetResult(interp
, Jim_NewIntObj(interp
, exists
!= 0));
11724 } else if (cmd
== INFO_GLOBALS
|| cmd
== INFO_LOCALS
|| cmd
== INFO_VARS
) {
11727 case INFO_GLOBALS
: mode
= JIM_VARLIST_GLOBALS
; break;
11728 case INFO_LOCALS
: mode
= JIM_VARLIST_LOCALS
; break;
11729 case INFO_VARS
: mode
= JIM_VARLIST_VARS
; break;
11730 default: mode
= 0; /* avoid warning */; break;
11732 if (argc
!= 2 && argc
!= 3) {
11733 Jim_WrongNumArgs(interp
, 2, argv
, "?pattern?");
11737 Jim_SetResult(interp
,JimVariablesList(interp
, argv
[2], mode
));
11739 Jim_SetResult(interp
, JimVariablesList(interp
, NULL
, mode
));
11740 } else if (cmd
== INFO_LEVEL
) {
11744 Jim_SetResult(interp
,
11745 Jim_NewIntObj(interp
, interp
->numLevels
));
11748 if (JimInfoLevel(interp
, argv
[2], &objPtr
) != JIM_OK
)
11750 Jim_SetResult(interp
, objPtr
);
11753 Jim_WrongNumArgs(interp
, 2, argv
, "?levelNum?");
11756 } else if (cmd
== INFO_BODY
|| cmd
== INFO_ARGS
) {
11760 Jim_WrongNumArgs(interp
, 2, argv
, "procname");
11763 if ((cmdPtr
= Jim_GetCommand(interp
, argv
[2], JIM_ERRMSG
)) == NULL
)
11765 if (cmdPtr
->cmdProc
!= NULL
) {
11766 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
11767 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
11768 "command \"", Jim_GetString(argv
[2], NULL
),
11769 "\" is not a procedure", NULL
);
11772 if (cmd
== INFO_BODY
)
11773 Jim_SetResult(interp
, cmdPtr
->bodyObjPtr
);
11775 Jim_SetResult(interp
, cmdPtr
->argListObjPtr
);
11776 } else if (cmd
== INFO_VERSION
) {
11777 char buf
[(JIM_INTEGER_SPACE
* 2) + 1];
11778 sprintf(buf
, "%d.%d",
11779 JIM_VERSION
/ 100, JIM_VERSION
% 100);
11780 Jim_SetResultString(interp
, buf
, -1);
11781 } else if (cmd
== INFO_COMPLETE
) {
11786 Jim_WrongNumArgs(interp
, 2, argv
, "script");
11789 s
= Jim_GetString(argv
[2], &len
);
11790 Jim_SetResult(interp
,
11791 Jim_NewIntObj(interp
, Jim_ScriptIsComplete(s
, len
, NULL
)));
11792 } else if (cmd
== INFO_HOSTNAME
) {
11793 /* Redirect to os.hostname if it exists */
11794 Jim_Obj
*command
= Jim_NewStringObj(interp
, "os.gethostname", -1);
11795 result
= Jim_EvalObjVector(interp
, 1, &command
);
11801 static int Jim_SplitCoreCommand(Jim_Interp
*interp
, int argc
,
11802 Jim_Obj
*const *argv
)
11804 const char *str
, *splitChars
, *noMatchStart
;
11805 int splitLen
, strLen
, i
;
11806 Jim_Obj
*resObjPtr
;
11808 if (argc
!= 2 && argc
!= 3) {
11809 Jim_WrongNumArgs(interp
, 1, argv
, "string ?splitChars?");
11814 splitChars
= " \n\t\r";
11817 splitChars
= Jim_GetString(argv
[2], &splitLen
);
11819 str
= Jim_GetString(argv
[1], &strLen
);
11820 if (!strLen
) return JIM_OK
;
11821 noMatchStart
= str
;
11822 resObjPtr
= Jim_NewListObj(interp
, NULL
, 0);
11826 for (i
= 0; i
< splitLen
; i
++) {
11827 if (*str
== splitChars
[i
]) {
11830 objPtr
= Jim_NewStringObj(interp
, noMatchStart
,
11831 (str
-noMatchStart
));
11832 Jim_ListAppendElement(interp
, resObjPtr
, objPtr
);
11833 noMatchStart
= str
+ 1;
11840 Jim_ListAppendElement(interp
, resObjPtr
,
11841 Jim_NewStringObj(interp
, noMatchStart
, (str
-noMatchStart
)));
11843 /* This handles the special case of splitchars eq {}. This
11844 * is trivial but we want to perform object sharing as Tcl does. */
11845 Jim_Obj
*objCache
[256];
11846 const unsigned char *u
= (unsigned char*) str
;
11847 memset(objCache
, 0, sizeof(objCache
));
11848 for (i
= 0; i
< strLen
; i
++) {
11851 if (objCache
[c
] == NULL
)
11852 objCache
[c
] = Jim_NewStringObj(interp
, (char*)u
+ i
, 1);
11853 Jim_ListAppendElement(interp
, resObjPtr
, objCache
[c
]);
11856 Jim_SetResult(interp
, resObjPtr
);
11861 static int Jim_JoinCoreCommand(Jim_Interp
*interp
, int argc
,
11862 Jim_Obj
*const *argv
)
11864 const char *joinStr
;
11865 int joinStrLen
, i
, listLen
;
11866 Jim_Obj
*resObjPtr
;
11868 if (argc
!= 2 && argc
!= 3) {
11869 Jim_WrongNumArgs(interp
, 1, argv
, "list ?joinString?");
11877 joinStr
= Jim_GetString(argv
[2], &joinStrLen
);
11879 Jim_ListLength(interp
, argv
[1], &listLen
);
11880 resObjPtr
= Jim_NewStringObj(interp
, NULL
, 0);
11882 for (i
= 0; i
< listLen
; i
++) {
11883 Jim_Obj
*objPtr
=NULL
;
11885 Jim_ListIndex(interp
, argv
[1], i
, &objPtr
, JIM_NONE
);
11886 Jim_AppendObj(interp
, resObjPtr
, objPtr
);
11887 if (i
+ 1 != listLen
) {
11888 Jim_AppendString(interp
, resObjPtr
, joinStr
, joinStrLen
);
11891 Jim_SetResult(interp
, resObjPtr
);
11896 static int Jim_FormatCoreCommand(Jim_Interp
*interp
, int argc
,
11897 Jim_Obj
*const *argv
)
11902 Jim_WrongNumArgs(interp
, 1, argv
, "formatString ?arg arg ...?");
11905 objPtr
= Jim_FormatString(interp
, argv
[1], argc
-2, argv
+ 2);
11906 if (objPtr
== NULL
)
11908 Jim_SetResult(interp
, objPtr
);
11913 static int Jim_ScanCoreCommand(Jim_Interp
*interp
, int argc
,
11914 Jim_Obj
*const *argv
)
11916 Jim_Obj
*listPtr
, **outVec
;
11917 int outc
, i
, count
= 0;
11920 Jim_WrongNumArgs(interp
, 1, argv
, "string formatString ?varName ...?");
11923 if (argv
[2]->typePtr
!= &scanFmtStringObjType
)
11924 SetScanFmtFromAny(interp
, argv
[2]);
11925 if (FormatGetError(argv
[2]) != 0) {
11926 Jim_SetResultString(interp
, FormatGetError(argv
[2]), -1);
11930 int maxPos
= FormatGetMaxPos(argv
[2]);
11931 int count
= FormatGetCnvCount(argv
[2]);
11932 if (maxPos
> argc
-3) {
11933 Jim_SetResultString(interp
, "\"%n$\" argument index out of range", -1);
11935 } else if (count
!= 0 && count
< argc
-3) {
11936 Jim_SetResultString(interp
, "variable is not assigned by any "
11937 "conversion specifiers", -1);
11939 } else if (count
> argc
-3) {
11940 Jim_SetResultString(interp
, "different numbers of variable names and "
11941 "field specifiers", -1);
11945 listPtr
= Jim_ScanString(interp
, argv
[1], argv
[2], JIM_ERRMSG
);
11950 if (listPtr
!= 0 && listPtr
!= (Jim_Obj
*)EOF
)
11951 Jim_ListLength(interp
, listPtr
, &len
);
11952 if (listPtr
== (Jim_Obj
*)EOF
|| len
== 0) { // XXX
11953 Jim_SetResult(interp
, Jim_NewIntObj(interp
, -1));
11956 JimListGetElements(interp
, listPtr
, &outc
, &outVec
);
11957 for (i
= 0; i
< outc
; ++i
) {
11958 if (Jim_Length(outVec
[i
]) > 0) {
11960 if (Jim_SetVariable(interp
, argv
[3 + i
], outVec
[i
]) != JIM_OK
)
11964 Jim_FreeNewObj(interp
, listPtr
);
11965 Jim_SetResult(interp
, Jim_NewIntObj(interp
, count
));
11967 if (listPtr
== (Jim_Obj
*)EOF
) {
11968 Jim_SetResult(interp
, Jim_NewListObj(interp
, 0, 0));
11971 Jim_SetResult(interp
, listPtr
);
11975 Jim_FreeNewObj(interp
, listPtr
);
11980 static int Jim_ErrorCoreCommand(Jim_Interp
*interp
, int argc
,
11981 Jim_Obj
*const *argv
)
11984 Jim_WrongNumArgs(interp
, 1, argv
, "message");
11987 Jim_SetResult(interp
, argv
[1]);
11992 static int Jim_LrangeCoreCommand(Jim_Interp
*interp
, int argc
,
11993 Jim_Obj
*const *argv
)
11998 Jim_WrongNumArgs(interp
, 1, argv
, "list first last");
12001 if ((objPtr
= Jim_ListRange(interp
, argv
[1], argv
[2], argv
[3])) == NULL
)
12003 Jim_SetResult(interp
, objPtr
);
12008 static int Jim_EnvCoreCommand(Jim_Interp
*interp
, int argc
,
12009 Jim_Obj
*const *argv
)
12016 #ifdef NEED_ENVIRON_EXTERN
12017 extern char **environ
;
12021 Jim_Obj
*listObjPtr
= Jim_NewListObj(interp
, NULL
, 0);
12023 for (i
= 0; environ
[i
]; i
++) {
12024 const char *equals
= strchr(environ
[i
], '=');
12026 Jim_ListAppendElement(interp
, listObjPtr
, Jim_NewStringObj(interp
, environ
[i
], equals
- environ
[i
]));
12027 Jim_ListAppendElement(interp
, listObjPtr
, Jim_NewStringObj(interp
, equals
+ 1, -1));
12031 Jim_SetResult(interp
, listObjPtr
);
12036 Jim_WrongNumArgs(interp
, 1, argv
, "varName");
12039 key
= Jim_GetString(argv
[1], NULL
);
12042 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
12043 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
12044 "environment variable \"",
12045 key
, "\" does not exist", NULL
);
12048 Jim_SetResult(interp
, Jim_NewStringObj(interp
, val
, -1));
12053 static int Jim_SourceCoreCommand(Jim_Interp
*interp
, int argc
,
12054 Jim_Obj
*const *argv
)
12059 Jim_WrongNumArgs(interp
, 1, argv
, "fileName");
12062 retval
= Jim_EvalFile(interp
, Jim_GetString(argv
[1], NULL
));
12063 if (retval
== JIM_ERR
) {
12064 return JIM_ERR_ADDSTACK
;
12066 if (retval
== JIM_RETURN
)
12072 static int Jim_LreverseCoreCommand(Jim_Interp
*interp
, int argc
,
12073 Jim_Obj
*const *argv
)
12075 Jim_Obj
*revObjPtr
, **ele
;
12079 Jim_WrongNumArgs(interp
, 1, argv
, "list");
12082 JimListGetElements(interp
, argv
[1], &len
, &ele
);
12084 revObjPtr
= Jim_NewListObj(interp
, NULL
, 0);
12086 ListAppendElement(revObjPtr
, ele
[len
--]);
12087 Jim_SetResult(interp
, revObjPtr
);
12091 static int JimRangeLen(jim_wide start
, jim_wide end
, jim_wide step
)
12095 if (step
== 0) return -1;
12096 if (start
== end
) return 0;
12097 else if (step
> 0 && start
> end
) return -1;
12098 else if (step
< 0 && end
> start
) return -1;
12100 if (len
< 0) len
= -len
; /* abs(len) */
12101 if (step
< 0) step
= -step
; /* abs(step) */
12102 len
= 1 + ((len
-1)/step
);
12103 /* We can truncate safely to INT_MAX, the range command
12104 * will always return an error for a such long range
12105 * because Tcl lists can't be so long. */
12106 if (len
> INT_MAX
) len
= INT_MAX
;
12107 return (int)((len
< 0) ? -1 : len
);
12111 static int Jim_RangeCoreCommand(Jim_Interp
*interp
, int argc
,
12112 Jim_Obj
*const *argv
)
12114 jim_wide start
= 0, end
, step
= 1;
12118 if (argc
< 2 || argc
> 4) {
12119 Jim_WrongNumArgs(interp
, 1, argv
, "?start? end ?step?");
12123 if (Jim_GetWide(interp
, argv
[1], &end
) != JIM_OK
)
12126 if (Jim_GetWide(interp
, argv
[1], &start
) != JIM_OK
||
12127 Jim_GetWide(interp
, argv
[2], &end
) != JIM_OK
)
12129 if (argc
== 4 && Jim_GetWide(interp
, argv
[3], &step
) != JIM_OK
)
12132 if ((len
= JimRangeLen(start
, end
, step
)) == -1) {
12133 Jim_SetResultString(interp
, "Invalid (infinite?) range specified", -1);
12136 objPtr
= Jim_NewListObj(interp
, NULL
, 0);
12137 for (i
= 0; i
< len
; i
++)
12138 ListAppendElement(objPtr
, Jim_NewIntObj(interp
, start
+ i
*step
));
12139 Jim_SetResult(interp
, objPtr
);
12144 static int Jim_RandCoreCommand(Jim_Interp
*interp
, int argc
,
12145 Jim_Obj
*const *argv
)
12147 jim_wide min
= 0, max
=0, len
, maxMul
;
12149 if (argc
< 1 || argc
> 3) {
12150 Jim_WrongNumArgs(interp
, 1, argv
, "?min? max");
12154 max
= JIM_WIDE_MAX
;
12155 } else if (argc
== 2) {
12156 if (Jim_GetWide(interp
, argv
[1], &max
) != JIM_OK
)
12158 } else if (argc
== 3) {
12159 if (Jim_GetWide(interp
, argv
[1], &min
) != JIM_OK
||
12160 Jim_GetWide(interp
, argv
[2], &max
) != JIM_OK
)
12165 Jim_SetResultString(interp
, "Invalid arguments (max < min)", -1);
12168 maxMul
= JIM_WIDE_MAX
- (len
? (JIM_WIDE_MAX
%len
) : 0);
12172 JimRandomBytes(interp
, &r
, sizeof(jim_wide
));
12173 if (r
< 0 || r
>= maxMul
) continue;
12174 r
= (len
== 0) ? 0 : r
%len
;
12175 Jim_SetResult(interp
, Jim_NewIntObj(interp
, min
+ r
));
12181 static int Jim_PackageCoreCommand(Jim_Interp
*interp
, int argc
,
12182 Jim_Obj
*const *argv
)
12185 const char *options
[] = {
12186 "require", "provide", NULL
12188 enum {OPT_REQUIRE
, OPT_PROVIDE
};
12191 Jim_WrongNumArgs(interp
, 1, argv
, "option ?arguments ...?");
12194 if (Jim_GetEnum(interp
, argv
[1], options
, &option
, "option",
12195 JIM_ERRMSG
) != JIM_OK
)
12198 if (option
== OPT_REQUIRE
) {
12202 if (Jim_CompareStringImmediate(interp
, argv
[2], "-exact")) {
12207 if (argc
!= 3 && argc
!= 4) {
12208 Jim_WrongNumArgs(interp
, 2, argv
, "?-exact? package ?version?");
12211 ver
= Jim_PackageRequire(interp
, Jim_GetString(argv
[2], NULL
),
12212 argc
== 4 ? Jim_GetString(argv
[3], NULL
) : "",
12215 return JIM_ERR_ADDSTACK
;
12216 Jim_SetResultString(interp
, ver
, -1);
12217 } else if (option
== OPT_PROVIDE
) {
12219 Jim_WrongNumArgs(interp
, 2, argv
, "package version");
12222 return Jim_PackageProvide(interp
, Jim_GetString(argv
[2], NULL
),
12223 Jim_GetString(argv
[3], NULL
), JIM_ERRMSG
);
12230 Jim_CmdProc cmdProc
;
12231 } Jim_CoreCommandsTable
[] = {
12232 {"set", Jim_SetCoreCommand
},
12233 {"unset", Jim_UnsetCoreCommand
},
12234 {"puts", Jim_PutsCoreCommand
},
12235 {"+", Jim_AddCoreCommand
},
12236 {"*", Jim_MulCoreCommand
},
12237 {"-", Jim_SubCoreCommand
},
12238 {"/", Jim_DivCoreCommand
},
12239 {"incr", Jim_IncrCoreCommand
},
12240 {"while", Jim_WhileCoreCommand
},
12241 {"for", Jim_ForCoreCommand
},
12242 {"foreach", Jim_ForeachCoreCommand
},
12243 {"lmap", Jim_LmapCoreCommand
},
12244 {"if", Jim_IfCoreCommand
},
12245 {"switch", Jim_SwitchCoreCommand
},
12246 {"list", Jim_ListCoreCommand
},
12247 {"lindex", Jim_LindexCoreCommand
},
12248 {"lset", Jim_LsetCoreCommand
},
12249 {"llength", Jim_LlengthCoreCommand
},
12250 {"lappend", Jim_LappendCoreCommand
},
12251 {"linsert", Jim_LinsertCoreCommand
},
12252 {"lsort", Jim_LsortCoreCommand
},
12253 {"append", Jim_AppendCoreCommand
},
12254 {"debug", Jim_DebugCoreCommand
},
12255 {"eval", Jim_EvalCoreCommand
},
12256 {"uplevel", Jim_UplevelCoreCommand
},
12257 {"expr", Jim_ExprCoreCommand
},
12258 {"break", Jim_BreakCoreCommand
},
12259 {"continue", Jim_ContinueCoreCommand
},
12260 {"proc", Jim_ProcCoreCommand
},
12261 {"concat", Jim_ConcatCoreCommand
},
12262 {"return", Jim_ReturnCoreCommand
},
12263 {"upvar", Jim_UpvarCoreCommand
},
12264 {"global", Jim_GlobalCoreCommand
},
12265 {"string", Jim_StringCoreCommand
},
12266 {"time", Jim_TimeCoreCommand
},
12267 {"exit", Jim_ExitCoreCommand
},
12268 {"catch", Jim_CatchCoreCommand
},
12269 {"ref", Jim_RefCoreCommand
},
12270 {"getref", Jim_GetrefCoreCommand
},
12271 {"setref", Jim_SetrefCoreCommand
},
12272 {"finalize", Jim_FinalizeCoreCommand
},
12273 {"collect", Jim_CollectCoreCommand
},
12274 {"rename", Jim_RenameCoreCommand
},
12275 {"dict", Jim_DictCoreCommand
},
12276 {"load", Jim_LoadCoreCommand
},
12277 {"subst", Jim_SubstCoreCommand
},
12278 {"info", Jim_InfoCoreCommand
},
12279 {"split", Jim_SplitCoreCommand
},
12280 {"join", Jim_JoinCoreCommand
},
12281 {"format", Jim_FormatCoreCommand
},
12282 {"scan", Jim_ScanCoreCommand
},
12283 {"error", Jim_ErrorCoreCommand
},
12284 {"lrange", Jim_LrangeCoreCommand
},
12285 {"env", Jim_EnvCoreCommand
},
12286 {"source", Jim_SourceCoreCommand
},
12287 {"lreverse", Jim_LreverseCoreCommand
},
12288 {"range", Jim_RangeCoreCommand
},
12289 {"rand", Jim_RandCoreCommand
},
12290 {"package", Jim_PackageCoreCommand
},
12291 {"tailcall", Jim_TailcallCoreCommand
},
12295 /* Some Jim core command is actually a procedure written in Jim itself. */
12296 static void Jim_RegisterCoreProcedures(Jim_Interp
*interp
)
12298 Jim_Eval(interp
, (char*)
12299 "proc lambda {arglist args} {\n"
12300 " set name [ref {} function lambdaFinalizer]\n"
12301 " uplevel 1 [list proc $name $arglist {expand}$args]\n"
12304 "proc lambdaFinalizer {name val} {\n"
12305 " rename $name {}\n"
12310 void Jim_RegisterCoreCommands(Jim_Interp
*interp
)
12314 while (Jim_CoreCommandsTable
[i
].name
!= NULL
) {
12315 Jim_CreateCommand(interp
,
12316 Jim_CoreCommandsTable
[i
].name
,
12317 Jim_CoreCommandsTable
[i
].cmdProc
,
12321 Jim_RegisterCoreProcedures(interp
);
12324 /* -----------------------------------------------------------------------------
12325 * Interactive prompt
12326 * ---------------------------------------------------------------------------*/
12327 void Jim_PrintErrorMessage(Jim_Interp
*interp
)
12331 if (*interp
->errorFileName
) {
12332 Jim_fprintf(interp
, interp
->cookie_stderr
, "Runtime error, file \"%s\", line %d:" JIM_NL
" ",
12333 interp
->errorFileName
, interp
->errorLine
);
12335 Jim_fprintf(interp
,interp
->cookie_stderr
, "%s" JIM_NL
,
12336 Jim_GetString(interp
->result
, NULL
));
12337 Jim_ListLength(interp
, interp
->stackTrace
, &len
);
12338 for (i
= len
-3; i
>= 0; i
-= 3) {
12339 Jim_Obj
*objPtr
=NULL
;
12340 const char *proc
, *file
, *line
;
12342 Jim_ListIndex(interp
, interp
->stackTrace
, i
, &objPtr
, JIM_NONE
);
12343 proc
= Jim_GetString(objPtr
, NULL
);
12344 Jim_ListIndex(interp
, interp
->stackTrace
, i
+ 1, &objPtr
,
12346 file
= Jim_GetString(objPtr
, NULL
);
12347 Jim_ListIndex(interp
, interp
->stackTrace
, i
+ 2, &objPtr
,
12349 line
= Jim_GetString(objPtr
, NULL
);
12351 Jim_fprintf(interp
, interp
->cookie_stderr
,
12352 "in procedure '%s' ", proc
);
12355 Jim_fprintf(interp
, interp
->cookie_stderr
,
12356 "called at file \"%s\", line %s",
12359 if (*file
|| *proc
) {
12360 Jim_fprintf(interp
, interp
->cookie_stderr
, JIM_NL
);
12365 int Jim_InteractivePrompt(Jim_Interp
*interp
)
12367 int retcode
= JIM_OK
;
12368 Jim_Obj
*scriptObjPtr
;
12370 Jim_fprintf(interp
,interp
->cookie_stdout
, "Welcome to Jim version %d.%d, "
12371 "Copyright (c) 2005-8 Salvatore Sanfilippo" JIM_NL
,
12372 JIM_VERSION
/ 100, JIM_VERSION
% 100);
12373 Jim_SetVariableStrWithStr(interp
, "jim_interactive", "1");
12376 const char *result
;
12377 const char *retcodestr
[] = {
12378 "ok", "error", "return", "break", "continue", "eval", "exit"
12382 if (retcode
!= 0) {
12383 if (retcode
>= 2 && retcode
<= 6)
12384 Jim_fprintf(interp
,interp
->cookie_stdout
, "[%s] . ", retcodestr
[retcode
]);
12386 Jim_fprintf(interp
,interp
->cookie_stdout
, "[%d] . ", retcode
);
12388 Jim_fprintf(interp
, interp
->cookie_stdout
, ". ");
12389 Jim_fflush(interp
, interp
->cookie_stdout
);
12390 scriptObjPtr
= Jim_NewStringObj(interp
, "", 0);
12391 Jim_IncrRefCount(scriptObjPtr
);
12397 if (Jim_fgets(interp
, buf
, 1024, interp
->cookie_stdin
) == NULL
) {
12398 Jim_DecrRefCount(interp
, scriptObjPtr
);
12401 Jim_AppendString(interp
, scriptObjPtr
, buf
, -1);
12402 str
= Jim_GetString(scriptObjPtr
, &len
);
12403 if (Jim_ScriptIsComplete(str
, len
, &state
))
12405 Jim_fprintf(interp
, interp
->cookie_stdout
, "%c> ", state
);
12406 Jim_fflush(interp
, interp
->cookie_stdout
);
12408 retcode
= Jim_EvalObj(interp
, scriptObjPtr
);
12409 Jim_DecrRefCount(interp
, scriptObjPtr
);
12410 result
= Jim_GetString(Jim_GetResult(interp
), &reslen
);
12411 if (retcode
== JIM_ERR
) {
12412 Jim_PrintErrorMessage(interp
);
12413 } else if (retcode
== JIM_EXIT
) {
12414 exit(Jim_GetExitCode(interp
));
12417 Jim_fwrite(interp
, result
, 1, reslen
, interp
->cookie_stdout
);
12418 Jim_fprintf(interp
,interp
->cookie_stdout
, JIM_NL
);
12426 /* -----------------------------------------------------------------------------
12427 * Jim's idea of STDIO..
12428 * ---------------------------------------------------------------------------*/
12430 int Jim_fprintf(Jim_Interp
*interp
, void *cookie
, const char *fmt
, ...)
12436 r
= Jim_vfprintf(interp
, cookie
, fmt
,ap
);
12441 int Jim_vfprintf(Jim_Interp
*interp
, void *cookie
, const char *fmt
, va_list ap
)
12443 if ((interp
== NULL
) || (interp
->cb_vfprintf
== NULL
)) {
12447 return (*(interp
->cb_vfprintf
))(cookie
, fmt
, ap
);
12450 size_t Jim_fwrite(Jim_Interp
*interp
, const void *ptr
, size_t size
, size_t n
, void *cookie
)
12452 if ((interp
== NULL
) || (interp
->cb_fwrite
== NULL
)) {
12456 return (*(interp
->cb_fwrite
))(ptr
, size
, n
, cookie
);
12459 size_t Jim_fread(Jim_Interp
*interp
, void *ptr
, size_t size
, size_t n
, void *cookie
)
12461 if ((interp
== NULL
) || (interp
->cb_fread
== NULL
)) {
12465 return (*(interp
->cb_fread
))(ptr
, size
, n
, cookie
);
12468 int Jim_fflush(Jim_Interp
*interp
, void *cookie
)
12470 if ((interp
== NULL
) || (interp
->cb_fflush
== NULL
)) {
12471 /* pretend all is well */
12474 return (*(interp
->cb_fflush
))(cookie
);
12477 char* Jim_fgets(Jim_Interp
*interp
, char *s
, int size
, void *cookie
)
12479 if ((interp
== NULL
) || (interp
->cb_fgets
== NULL
)) {
12483 return (*(interp
->cb_fgets
))(s
, size
, cookie
);
12486 Jim_Nvp_name2value_simple(const Jim_Nvp
*p
, const char *name
)
12489 if (0 == strcmp(name
, p
->name
)) {
12494 return ((Jim_Nvp
*)(p
));
12498 Jim_Nvp_name2value_nocase_simple(const Jim_Nvp
*p
, const char *name
)
12501 if (0 == strcasecmp(name
, p
->name
)) {
12506 return ((Jim_Nvp
*)(p
));
12510 Jim_Nvp_name2value_obj(Jim_Interp
*interp
,
12515 return Jim_Nvp_name2value(interp
, p
, Jim_GetString(o
, NULL
), result
);
12520 Jim_Nvp_name2value(Jim_Interp
*interp
,
12529 p
= Jim_Nvp_name2value_simple(_p
, name
);
12533 *result
= (Jim_Nvp
*)(p
);
12545 Jim_Nvp_name2value_obj_nocase(Jim_Interp
*interp
, const Jim_Nvp
*p
, Jim_Obj
*o
, Jim_Nvp
**puthere
)
12547 return Jim_Nvp_name2value_nocase(interp
, p
, Jim_GetString(o
, NULL
), puthere
);
12551 Jim_Nvp_name2value_nocase(Jim_Interp
*interp
, const Jim_Nvp
*_p
, const char *name
, Jim_Nvp
**puthere
)
12557 p
= Jim_Nvp_name2value_nocase_simple(_p
, name
);
12560 *puthere
= (Jim_Nvp
*)(p
);
12572 Jim_Nvp_value2name_obj(Jim_Interp
*interp
, const Jim_Nvp
*p
, Jim_Obj
*o
, Jim_Nvp
**result
)
12577 e
= Jim_GetWide(interp
, o
, &w
);
12582 return Jim_Nvp_value2name(interp
, p
, w
, result
);
12586 Jim_Nvp_value2name_simple(const Jim_Nvp
*p
, int value
)
12589 if (value
== p
->value
) {
12594 return ((Jim_Nvp
*)(p
));
12599 Jim_Nvp_value2name(Jim_Interp
*interp
, const Jim_Nvp
*_p
, int value
, Jim_Nvp
**result
)
12605 p
= Jim_Nvp_value2name_simple(_p
, value
);
12608 *result
= (Jim_Nvp
*)(p
);
12620 Jim_GetOpt_Setup(Jim_GetOptInfo
*p
, Jim_Interp
*interp
, int argc
, Jim_Obj
* const * argv
)
12622 memset(p
, 0, sizeof(*p
));
12623 p
->interp
= interp
;
12631 Jim_GetOpt_Debug(Jim_GetOptInfo
*p
)
12635 Jim_fprintf(p
->interp
, p
->interp
->cookie_stderr
, "---args---\n");
12636 for (x
= 0 ; x
< p
->argc
; x
++) {
12637 Jim_fprintf(p
->interp
, p
->interp
->cookie_stderr
,
12640 Jim_GetString(p
->argv
[x
], NULL
));
12642 Jim_fprintf(p
->interp
, p
->interp
->cookie_stderr
, "-------\n");
12647 Jim_GetOpt_Obj(Jim_GetOptInfo
*goi
, Jim_Obj
**puthere
)
12651 o
= NULL
; // failure
12669 Jim_GetOpt_String(Jim_GetOptInfo
*goi
, char **puthere
, int *len
)
12676 r
= Jim_GetOpt_Obj(goi
, &o
);
12678 cp
= Jim_GetString(o
, len
);
12681 *puthere
= (char *)(cp
);
12688 Jim_GetOpt_Double(Jim_GetOptInfo
*goi
, double *puthere
)
12694 if (puthere
== NULL
) {
12698 r
= Jim_GetOpt_Obj(goi
, &o
);
12700 r
= Jim_GetDouble(goi
->interp
, o
, puthere
);
12702 Jim_SetResult_sprintf(goi
->interp
,
12703 "not a number: %s",
12704 Jim_GetString(o
, NULL
));
12711 Jim_GetOpt_Wide(Jim_GetOptInfo
*goi
, jim_wide
*puthere
)
12717 if (puthere
== NULL
) {
12721 r
= Jim_GetOpt_Obj(goi
, &o
);
12723 r
= Jim_GetWide(goi
->interp
, o
, puthere
);
12728 int Jim_GetOpt_Nvp(Jim_GetOptInfo
*goi
,
12729 const Jim_Nvp
*nvp
,
12736 if (puthere
== NULL
) {
12740 e
= Jim_GetOpt_Obj(goi
, &o
);
12742 e
= Jim_Nvp_name2value_obj(goi
->interp
,
12752 Jim_GetOpt_NvpUnknown(Jim_GetOptInfo
*goi
,
12753 const Jim_Nvp
*nvptable
,
12757 Jim_SetResult_NvpUnknown(goi
->interp
,
12762 Jim_SetResult_NvpUnknown(goi
->interp
,
12771 Jim_GetOpt_Enum(Jim_GetOptInfo
*goi
,
12772 const char * const * lookup
,
12779 if (puthere
== NULL
) {
12782 e
= Jim_GetOpt_Obj(goi
, &o
);
12784 e
= Jim_GetEnum(goi
->interp
,
12797 Jim_SetResult_sprintf(Jim_Interp
*interp
, const char *fmt
,...)
12803 buf
= jim_vasprintf(fmt
, ap
);
12806 Jim_SetResultString(interp
, buf
, -1);
12807 jim_vasprintf_done(buf
);
12814 Jim_SetResult_NvpUnknown(Jim_Interp
*interp
,
12815 Jim_Obj
*param_name
,
12816 Jim_Obj
*param_value
,
12817 const Jim_Nvp
*nvp
)
12820 Jim_SetResult_sprintf(interp
,
12821 "%s: Unknown: %s, try one of: ",
12822 Jim_GetString(param_name
, NULL
),
12823 Jim_GetString(param_value
, NULL
));
12825 Jim_SetResult_sprintf(interp
,
12826 "Unknown param: %s, try one of: ",
12827 Jim_GetString(param_value
, NULL
));
12829 while (nvp
->name
) {
12833 if ((nvp
+ 1)->name
) {
12840 Jim_AppendStrings(interp
,
12841 Jim_GetResult(interp
),
12848 static Jim_Obj
*debug_string_obj
;
12851 Jim_Debug_ArgvString(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
12855 if (debug_string_obj
) {
12856 Jim_FreeObj(interp
, debug_string_obj
);
12859 debug_string_obj
= Jim_NewEmptyStringObj(interp
);
12860 for (x
= 0 ; x
< argc
; x
++) {
12861 Jim_AppendStrings(interp
,
12863 Jim_GetString(argv
[x
], NULL
),
12868 return Jim_GetString(debug_string_obj
, NULL
);