1 /* Jim - A small embeddable Tcl interpreter
3 * Copyright 2005 Salvatore Sanfilippo <antirez@invece.org>
4 * Copyright 2005 Clemens Hintze <c.hintze@gmx.net>
5 * Copyright 2005 patthoyts - Pat Thoyts <patthoyts@users.sf.net>
6 * Copyright 2008 oharboe - Øyvind Harboe - oyvind.harboe@zylin.com
7 * Copyright 2008 Andrew Lunn <andrew@lunn.ch>
8 * Copyright 2008 Duane Ellis <openocd@duaneellis.com>
9 * Copyright 2008 Uwe Klein <uklein@klein-messgeraete.de>
10 * Copyright 2008 Steve Bennett <steveb@workware.net.au>
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions
18 * 1. Redistributions of source code must retain the above copyright
19 * notice, this list of conditions and the following disclaimer.
20 * 2. Redistributions in binary form must reproduce the above
21 * copyright notice, this list of conditions and the following
22 * disclaimer in the documentation and/or other materials
23 * provided with the distribution.
25 * THIS SOFTWARE IS PROVIDED BY THE JIM TCL PROJECT ``AS IS'' AND ANY
26 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
27 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
28 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
29 * JIM TCL PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
30 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
31 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
34 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
36 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 * The views and conclusions contained in the software and documentation
39 * are those of the authors and should not be interpreted as representing
40 * official policies, either expressed or implied, of the Jim Tcl Project.
47 #define JIM_OPTIMIZATION /* comment to avoid optimizations and reduce size */
50 #include <pkgconf/jimtcl.h>
53 #define JIM_DYNLIB /* Dynamic library support for UNIX and WIN32 */
54 #endif /* JIM_ANSIC */
57 #define _GNU_SOURCE /* for vasprintf() */
69 /* sys/time - need is different */
71 #include <sys/time.h> // for gettimeofday()
74 #include "replacements.h"
76 /* Include the platform dependent libraries for
77 * dynamic loading of libraries. */
79 #if defined(_WIN32) || defined(WIN32)
86 #define WIN32_LEAN_AND_MEAN
89 #pragma warning(disable:4146)
94 #endif /* JIM_DYNLIB */
101 #include <cyg/jimtcl/jim.h>
106 #ifdef HAVE_BACKTRACE
107 #include <execinfo.h>
110 /* -----------------------------------------------------------------------------
112 * ---------------------------------------------------------------------------*/
114 /* A shared empty string for the objects string representation.
115 * Jim_InvalidateStringRep knows about it and don't try to free. */
116 static char *JimEmptyStringRep
= (char*) "";
118 /* -----------------------------------------------------------------------------
119 * Required prototypes of not exported functions
120 * ---------------------------------------------------------------------------*/
121 static void JimChangeCallFrameId(Jim_Interp
*interp
, Jim_CallFrame
*cf
);
122 static void JimFreeCallFrame(Jim_Interp
*interp
, Jim_CallFrame
*cf
, int flags
);
123 static void JimRegisterCoreApi(Jim_Interp
*interp
);
125 static Jim_HashTableType
*getJimVariablesHashTableType(void);
127 /* -----------------------------------------------------------------------------
129 * ---------------------------------------------------------------------------*/
132 jim_vasprintf( const char *fmt
, va_list ap
)
134 #ifndef HAVE_VASPRINTF
136 static char buf
[2048];
137 vsnprintf( buf
, sizeof(buf
), fmt
, ap
);
138 /* garentee termination */
139 buf
[sizeof(buf
)-1] = 0;
143 result
= vasprintf( &buf
, fmt
, ap
);
144 if (result
< 0) exit(-1);
150 jim_vasprintf_done( void *buf
)
152 #ifndef HAVE_VASPRINTF
161 * Convert a string to a jim_wide INTEGER.
162 * This function originates from BSD.
164 * Ignores `locale' stuff. Assumes that the upper and lower case
165 * alphabets and digits are each contiguous.
167 #ifdef HAVE_LONG_LONG_INT
168 #define JimIsAscii(c) (((c) & ~0x7f) == 0)
169 static jim_wide
JimStrtoll(const char *nptr
, char **endptr
, register int base
)
171 register const char *s
;
172 register unsigned jim_wide acc
;
173 register unsigned char c
;
174 register unsigned jim_wide qbase
, cutoff
;
175 register int neg
, any
, cutlim
;
178 * Skip white space and pick up leading +/- sign if any.
179 * If base is 0, allow 0x for hex and 0 for octal, else
180 * assume decimal; if base is already 16, allow 0x.
185 } while (isspace(c
));
194 if ((base
== 0 || base
== 16) &&
195 c
== '0' && (*s
== 'x' || *s
== 'X')) {
201 base
= c
== '0' ? 8 : 10;
204 * Compute the cutoff value between legal numbers and illegal
205 * numbers. That is the largest legal value, divided by the
206 * base. An input number that is greater than this value, if
207 * followed by a legal input character, is too big. One that
208 * is equal to this value may be valid or not; the limit
209 * between valid and invalid numbers is then based on the last
210 * digit. For instance, if the range for quads is
211 * [-9223372036854775808..9223372036854775807] and the input base
212 * is 10, cutoff will be set to 922337203685477580 and cutlim to
213 * either 7 (neg==0) or 8 (neg==1), meaning that if we have
214 * accumulated a value > 922337203685477580, or equal but the
215 * next digit is > 7 (or 8), the number is too big, and we will
216 * return a range error.
218 * Set any if any `digits' consumed; make it negative to indicate
221 qbase
= (unsigned)base
;
222 cutoff
= neg
? (unsigned jim_wide
)-(LLONG_MIN
+ LLONG_MAX
) + LLONG_MAX
224 cutlim
= (int)(cutoff
% qbase
);
226 for (acc
= 0, any
= 0;; c
= *s
++) {
232 c
-= isupper(c
) ? 'A' - 10 : 'a' - 10;
237 if (any
< 0 || acc
> cutoff
|| (acc
== cutoff
&& c
> cutlim
))
246 acc
= neg
? LLONG_MIN
: LLONG_MAX
;
251 *endptr
= (char *)(any
? s
- 1 : nptr
);
256 /* Glob-style pattern matching. */
257 static int JimStringMatch(const char *pattern
, int patternLen
,
258 const char *string
, int stringLen
, int nocase
)
263 while (pattern
[1] == '*') {
268 return 1; /* match */
270 if (JimStringMatch(pattern
+1, patternLen
-1,
271 string
, stringLen
, nocase
))
272 return 1; /* match */
276 return 0; /* no match */
280 return 0; /* no match */
290 not = pattern
[0] == '^';
297 if (pattern
[0] == '\\') {
300 if (pattern
[0] == string
[0])
302 } else if (pattern
[0] == ']') {
304 } else if (patternLen
== 0) {
308 } else if (pattern
[1] == '-' && patternLen
>= 3) {
309 int start
= pattern
[0];
310 int end
= pattern
[2];
318 start
= tolower(start
);
324 if (c
>= start
&& c
<= end
)
328 if (pattern
[0] == string
[0])
331 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
341 return 0; /* no match */
347 if (patternLen
>= 2) {
354 if (pattern
[0] != string
[0])
355 return 0; /* no match */
357 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
358 return 0; /* no match */
366 if (stringLen
== 0) {
367 while(*pattern
== '*') {
374 if (patternLen
== 0 && stringLen
== 0)
379 int JimStringCompare(const char *s1
, int l1
, const char *s2
, int l2
,
382 unsigned char *u1
= (unsigned char*) s1
, *u2
= (unsigned char*) s2
;
388 u1
++; u2
++; l1
--; l2
--;
390 if (!l1
&& !l2
) return 0;
394 if (tolower((int)*u1
) != tolower((int)*u2
))
395 return tolower((int)*u1
)-tolower((int)*u2
);
396 u1
++; u2
++; l1
--; l2
--;
398 if (!l1
&& !l2
) return 0;
403 /* Search 's1' inside 's2', starting to search from char 'index' of 's2'.
404 * The index of the first occurrence of s1 in s2 is returned.
405 * If s1 is not found inside s2, -1 is returned. */
406 int JimStringFirst(const char *s1
, int l1
, const char *s2
, int l2
, int index
)
410 if (!l1
|| !l2
|| l1
> l2
) return -1;
411 if (index
< 0) index
= 0;
413 for (i
= index
; i
<= l2
-l1
; i
++) {
414 if (memcmp(s2
, s1
, l1
) == 0)
421 int Jim_WideToString(char *buf
, jim_wide wideValue
)
423 const char *fmt
= "%" JIM_WIDE_MODIFIER
;
424 return sprintf(buf
, fmt
, wideValue
);
427 int Jim_StringToWide(const char *str
, jim_wide
*widePtr
, int base
)
431 #ifdef HAVE_LONG_LONG_INT
432 *widePtr
= JimStrtoll(str
, &endptr
, base
);
434 *widePtr
= strtol(str
, &endptr
, base
);
436 if ((str
[0] == '\0') || (str
== endptr
) )
438 if (endptr
[0] != '\0') {
440 if (!isspace((int)*endptr
))
448 int Jim_StringToIndex(const char *str
, int *intPtr
)
452 *intPtr
= strtol(str
, &endptr
, 10);
453 if ( (str
[0] == '\0') || (str
== endptr
) )
455 if (endptr
[0] != '\0') {
457 if (!isspace((int)*endptr
))
465 /* The string representation of references has two features in order
466 * to make the GC faster. The first is that every reference starts
467 * with a non common character '~', in order to make the string matching
468 * fater. The second is that the reference string rep his 32 characters
469 * in length, this allows to avoid to check every object with a string
470 * repr < 32, and usually there are many of this objects. */
472 #define JIM_REFERENCE_SPACE (35+JIM_REFERENCE_TAGLEN)
474 static int JimFormatReference(char *buf
, Jim_Reference
*refPtr
, jim_wide id
)
476 const char *fmt
= "<reference.<%s>.%020" JIM_WIDE_MODIFIER
">";
477 sprintf(buf
, fmt
, refPtr
->tag
, id
);
478 return JIM_REFERENCE_SPACE
;
481 int Jim_DoubleToString(char *buf
, double doubleValue
)
486 len
= sprintf(buf
, "%.17g", doubleValue
);
489 if (*s
== '.') return len
;
492 /* Add a final ".0" if it's a number. But not
494 if (isdigit((int)buf
[0])
495 || ((buf
[0] == '-' || buf
[0] == '+')
496 && isdigit((int)buf
[1]))) {
505 int Jim_StringToDouble(const char *str
, double *doublePtr
)
509 *doublePtr
= strtod(str
, &endptr
);
510 if (str
[0] == '\0' || endptr
[0] != '\0' || (str
== endptr
) )
515 static jim_wide
JimPowWide(jim_wide b
, jim_wide e
)
518 if ((b
==0 && e
!=0) || (e
<0)) return 0;
519 for(i
=0; i
<e
; i
++) {res
*= b
;}
523 /* -----------------------------------------------------------------------------
525 * ---------------------------------------------------------------------------*/
527 /* Note that 'interp' may be NULL if not available in the
528 * context of the panic. It's only useful to get the error
529 * file descriptor, it will default to stderr otherwise. */
530 void Jim_Panic(Jim_Interp
*interp
, const char *fmt
, ...)
536 * Send it here first.. Assuming STDIO still works
538 fprintf(stderr
, JIM_NL
"JIM INTERPRETER PANIC: ");
539 vfprintf(stderr
, fmt
, ap
);
540 fprintf(stderr
, JIM_NL JIM_NL
);
543 #ifdef HAVE_BACKTRACE
549 size
= backtrace(array
, 40);
550 strings
= backtrace_symbols(array
, size
);
551 for (i
= 0; i
< size
; i
++)
552 fprintf(fp
,"[backtrace] %s" JIM_NL
, strings
[i
]);
553 fprintf(fp
,"[backtrace] Include the above lines and the output" JIM_NL
);
554 fprintf(fp
,"[backtrace] of 'nm <executable>' in the bug report." JIM_NL
);
558 /* This may actually crash... we do it last */
559 if( interp
&& interp
->cookie_stderr
){
560 Jim_fprintf( interp
, interp
->cookie_stderr
, JIM_NL
"JIM INTERPRETER PANIC: ");
561 Jim_vfprintf( interp
, interp
->cookie_stderr
, fmt
, ap
);
562 Jim_fprintf( interp
, interp
->cookie_stderr
, JIM_NL JIM_NL
);
567 /* -----------------------------------------------------------------------------
569 * ---------------------------------------------------------------------------*/
571 /* Macro used for memory debugging.
572 * In order for they to work you have to rename Jim_Alloc into _Jim_Alloc
573 * and similary for Jim_Realloc and Jim_Free */
575 #define Jim_Alloc(s) (printf("%s %d: Jim_Alloc(%d)\n",__FILE__,__LINE__,s),_Jim_Alloc(s))
576 #define Jim_Free(p) (printf("%s %d: Jim_Free(%p)\n",__FILE__,__LINE__,p),_Jim_Free(p))
577 #define Jim_Realloc(p,s) (printf("%s %d: Jim_Realloc(%p,%d)\n",__FILE__,__LINE__,p,s),_Jim_Realloc(p,s))
580 void *Jim_Alloc(int size
)
582 /* We allocate zero length arrayes, etc. to use a single orthogonal codepath */
585 void *p
= malloc(size
);
587 Jim_Panic(NULL
,"malloc: Out of memory");
591 void Jim_Free(void *ptr
) {
595 void *Jim_Realloc(void *ptr
, int size
)
597 /* We allocate zero length arrayes, etc. to use a single orthogonal codepath */
600 void *p
= realloc(ptr
, size
);
602 Jim_Panic(NULL
,"realloc: Out of memory");
606 char *Jim_StrDup(const char *s
)
609 char *copy
= Jim_Alloc(l
+1);
611 memcpy(copy
, s
, l
+1);
615 char *Jim_StrDupLen(const char *s
, int l
)
617 char *copy
= Jim_Alloc(l
+1);
619 memcpy(copy
, s
, l
+1);
620 copy
[l
] = 0; /* Just to be sure, original could be substring */
624 /* -----------------------------------------------------------------------------
625 * Time related functions
626 * ---------------------------------------------------------------------------*/
627 /* Returns microseconds of CPU used since start. */
628 static jim_wide
JimClock(void)
630 #if (defined WIN32) && !(defined JIM_ANSIC)
632 QueryPerformanceFrequency(&f
);
633 QueryPerformanceCounter(&t
);
634 return (long)((t
.QuadPart
* 1000000) / f
.QuadPart
);
636 clock_t clocks
= clock();
638 return (long)(clocks
*(1000000/CLOCKS_PER_SEC
));
642 /* -----------------------------------------------------------------------------
644 * ---------------------------------------------------------------------------*/
646 /* -------------------------- private prototypes ---------------------------- */
647 static int JimExpandHashTableIfNeeded(Jim_HashTable
*ht
);
648 static unsigned int JimHashTableNextPower(unsigned int size
);
649 static int JimInsertHashEntry(Jim_HashTable
*ht
, const void *key
);
651 /* -------------------------- hash functions -------------------------------- */
653 /* Thomas Wang's 32 bit Mix Function */
654 unsigned int Jim_IntHashFunction(unsigned int key
)
665 /* Identity hash function for integer keys */
666 unsigned int Jim_IdentityHashFunction(unsigned int key
)
671 /* Generic hash function (we are using to multiply by 9 and add the byte
673 unsigned int Jim_GenHashFunction(const unsigned char *buf
, int len
)
681 /* ----------------------------- API implementation ------------------------- */
682 /* reset an hashtable already initialized with ht_init().
683 * NOTE: This function should only called by ht_destroy(). */
684 static void JimResetHashTable(Jim_HashTable
*ht
)
693 /* Initialize the hash table */
694 int Jim_InitHashTable(Jim_HashTable
*ht
, Jim_HashTableType
*type
,
697 JimResetHashTable(ht
);
699 ht
->privdata
= privDataPtr
;
703 /* Resize the table to the minimal size that contains all the elements,
704 * but with the invariant of a USER/BUCKETS ration near to <= 1 */
705 int Jim_ResizeHashTable(Jim_HashTable
*ht
)
707 int minimal
= ht
->used
;
709 if (minimal
< JIM_HT_INITIAL_SIZE
)
710 minimal
= JIM_HT_INITIAL_SIZE
;
711 return Jim_ExpandHashTable(ht
, minimal
);
714 /* Expand or create the hashtable */
715 int Jim_ExpandHashTable(Jim_HashTable
*ht
, unsigned int size
)
717 Jim_HashTable n
; /* the new hashtable */
718 unsigned int realsize
= JimHashTableNextPower(size
), i
;
720 /* the size is invalid if it is smaller than the number of
721 * elements already inside the hashtable */
722 if (ht
->used
>= size
)
725 Jim_InitHashTable(&n
, ht
->type
, ht
->privdata
);
727 n
.sizemask
= realsize
-1;
728 n
.table
= Jim_Alloc(realsize
*sizeof(Jim_HashEntry
*));
730 /* Initialize all the pointers to NULL */
731 memset(n
.table
, 0, realsize
*sizeof(Jim_HashEntry
*));
733 /* Copy all the elements from the old to the new table:
734 * note that if the old hash table is empty ht->size is zero,
735 * so Jim_ExpandHashTable just creates an hash table. */
737 for (i
= 0; i
< ht
->size
&& ht
->used
> 0; i
++) {
738 Jim_HashEntry
*he
, *nextHe
;
740 if (ht
->table
[i
] == NULL
) continue;
742 /* For each hash entry on this slot... */
748 /* Get the new element index */
749 h
= Jim_HashKey(ht
, he
->key
) & n
.sizemask
;
750 he
->next
= n
.table
[h
];
753 /* Pass to the next element */
757 assert(ht
->used
== 0);
760 /* Remap the new hashtable in the old */
765 /* Add an element to the target hash table */
766 int Jim_AddHashEntry(Jim_HashTable
*ht
, const void *key
, void *val
)
769 Jim_HashEntry
*entry
;
771 /* Get the index of the new element, or -1 if
772 * the element already exists. */
773 if ((index
= JimInsertHashEntry(ht
, key
)) == -1)
776 /* Allocates the memory and stores key */
777 entry
= Jim_Alloc(sizeof(*entry
));
778 entry
->next
= ht
->table
[index
];
779 ht
->table
[index
] = entry
;
781 /* Set the hash entry fields. */
782 Jim_SetHashKey(ht
, entry
, key
);
783 Jim_SetHashVal(ht
, entry
, val
);
788 /* Add an element, discarding the old if the key already exists */
789 int Jim_ReplaceHashEntry(Jim_HashTable
*ht
, const void *key
, void *val
)
791 Jim_HashEntry
*entry
;
793 /* Try to add the element. If the key
794 * does not exists Jim_AddHashEntry will suceed. */
795 if (Jim_AddHashEntry(ht
, key
, val
) == JIM_OK
)
797 /* It already exists, get the entry */
798 entry
= Jim_FindHashEntry(ht
, key
);
799 /* Free the old value and set the new one */
800 Jim_FreeEntryVal(ht
, entry
);
801 Jim_SetHashVal(ht
, entry
, val
);
805 /* Search and remove an element */
806 int Jim_DeleteHashEntry(Jim_HashTable
*ht
, const void *key
)
809 Jim_HashEntry
*he
, *prevHe
;
813 h
= Jim_HashKey(ht
, key
) & ht
->sizemask
;
818 if (Jim_CompareHashKeys(ht
, key
, he
->key
)) {
819 /* Unlink the element from the list */
821 prevHe
->next
= he
->next
;
823 ht
->table
[h
] = he
->next
;
824 Jim_FreeEntryKey(ht
, he
);
825 Jim_FreeEntryVal(ht
, he
);
833 return JIM_ERR
; /* not found */
836 /* Destroy an entire hash table */
837 int Jim_FreeHashTable(Jim_HashTable
*ht
)
841 /* Free all the elements */
842 for (i
= 0; i
< ht
->size
&& ht
->used
> 0; i
++) {
843 Jim_HashEntry
*he
, *nextHe
;
845 if ((he
= ht
->table
[i
]) == NULL
) continue;
848 Jim_FreeEntryKey(ht
, he
);
849 Jim_FreeEntryVal(ht
, he
);
855 /* Free the table and the allocated cache structure */
857 /* Re-initialize the table */
858 JimResetHashTable(ht
);
859 return JIM_OK
; /* never fails */
862 Jim_HashEntry
*Jim_FindHashEntry(Jim_HashTable
*ht
, const void *key
)
867 if (ht
->size
== 0) return NULL
;
868 h
= Jim_HashKey(ht
, key
) & ht
->sizemask
;
871 if (Jim_CompareHashKeys(ht
, key
, he
->key
))
878 Jim_HashTableIterator
*Jim_GetHashTableIterator(Jim_HashTable
*ht
)
880 Jim_HashTableIterator
*iter
= Jim_Alloc(sizeof(*iter
));
885 iter
->nextEntry
= NULL
;
889 Jim_HashEntry
*Jim_NextHashEntry(Jim_HashTableIterator
*iter
)
892 if (iter
->entry
== NULL
) {
895 (signed)iter
->ht
->size
) break;
896 iter
->entry
= iter
->ht
->table
[iter
->index
];
898 iter
->entry
= iter
->nextEntry
;
901 /* We need to save the 'next' here, the iterator user
902 * may delete the entry we are returning. */
903 iter
->nextEntry
= iter
->entry
->next
;
910 /* ------------------------- private functions ------------------------------ */
912 /* Expand the hash table if needed */
913 static int JimExpandHashTableIfNeeded(Jim_HashTable
*ht
)
915 /* If the hash table is empty expand it to the intial size,
916 * if the table is "full" dobule its size. */
918 return Jim_ExpandHashTable(ht
, JIM_HT_INITIAL_SIZE
);
919 if (ht
->size
== ht
->used
)
920 return Jim_ExpandHashTable(ht
, ht
->size
*2);
924 /* Our hash table capability is a power of two */
925 static unsigned int JimHashTableNextPower(unsigned int size
)
927 unsigned int i
= JIM_HT_INITIAL_SIZE
;
929 if (size
>= 2147483648U)
938 /* Returns the index of a free slot that can be populated with
939 * an hash entry for the given 'key'.
940 * If the key already exists, -1 is returned. */
941 static int JimInsertHashEntry(Jim_HashTable
*ht
, const void *key
)
946 /* Expand the hashtable if needed */
947 if (JimExpandHashTableIfNeeded(ht
) == JIM_ERR
)
949 /* Compute the key hash value */
950 h
= Jim_HashKey(ht
, key
) & ht
->sizemask
;
951 /* Search if this slot does not already contain the given key */
954 if (Jim_CompareHashKeys(ht
, key
, he
->key
))
961 /* ----------------------- StringCopy Hash Table Type ------------------------*/
963 static unsigned int JimStringCopyHTHashFunction(const void *key
)
965 return Jim_GenHashFunction(key
, strlen(key
));
968 static const void *JimStringCopyHTKeyDup(void *privdata
, const void *key
)
970 int len
= strlen(key
);
971 char *copy
= Jim_Alloc(len
+1);
972 JIM_NOTUSED(privdata
);
974 memcpy(copy
, key
, len
);
979 static void *JimStringKeyValCopyHTValDup(void *privdata
, const void *val
)
981 int len
= strlen(val
);
982 char *copy
= Jim_Alloc(len
+1);
983 JIM_NOTUSED(privdata
);
985 memcpy(copy
, val
, len
);
990 static int JimStringCopyHTKeyCompare(void *privdata
, const void *key1
,
993 JIM_NOTUSED(privdata
);
995 return strcmp(key1
, key2
) == 0;
998 static void JimStringCopyHTKeyDestructor(void *privdata
, const void *key
)
1000 JIM_NOTUSED(privdata
);
1002 Jim_Free((void*)key
); /* ATTENTION: const cast */
1005 static void JimStringKeyValCopyHTValDestructor(void *privdata
, void *val
)
1007 JIM_NOTUSED(privdata
);
1009 Jim_Free((void*)val
); /* ATTENTION: const cast */
1012 static Jim_HashTableType JimStringCopyHashTableType
= {
1013 JimStringCopyHTHashFunction
, /* hash function */
1014 JimStringCopyHTKeyDup
, /* key dup */
1016 JimStringCopyHTKeyCompare
, /* key compare */
1017 JimStringCopyHTKeyDestructor
, /* key destructor */
1018 NULL
/* val destructor */
1021 /* This is like StringCopy but does not auto-duplicate the key.
1022 * It's used for intepreter's shared strings. */
1023 static Jim_HashTableType JimSharedStringsHashTableType
= {
1024 JimStringCopyHTHashFunction
, /* hash function */
1027 JimStringCopyHTKeyCompare
, /* key compare */
1028 JimStringCopyHTKeyDestructor
, /* key destructor */
1029 NULL
/* val destructor */
1032 /* This is like StringCopy but also automatically handle dynamic
1033 * allocated C strings as values. */
1034 static Jim_HashTableType JimStringKeyValCopyHashTableType
= {
1035 JimStringCopyHTHashFunction
, /* hash function */
1036 JimStringCopyHTKeyDup
, /* key dup */
1037 JimStringKeyValCopyHTValDup
, /* val dup */
1038 JimStringCopyHTKeyCompare
, /* key compare */
1039 JimStringCopyHTKeyDestructor
, /* key destructor */
1040 JimStringKeyValCopyHTValDestructor
, /* val destructor */
1043 typedef struct AssocDataValue
{
1044 Jim_InterpDeleteProc
*delProc
;
1048 static void JimAssocDataHashTableValueDestructor(void *privdata
, void *data
)
1050 AssocDataValue
*assocPtr
= (AssocDataValue
*)data
;
1051 if (assocPtr
->delProc
!= NULL
)
1052 assocPtr
->delProc((Jim_Interp
*)privdata
, assocPtr
->data
);
1056 static Jim_HashTableType JimAssocDataHashTableType
= {
1057 JimStringCopyHTHashFunction
, /* hash function */
1058 JimStringCopyHTKeyDup
, /* key dup */
1060 JimStringCopyHTKeyCompare
, /* key compare */
1061 JimStringCopyHTKeyDestructor
, /* key destructor */
1062 JimAssocDataHashTableValueDestructor
/* val destructor */
1065 /* -----------------------------------------------------------------------------
1066 * Stack - This is a simple generic stack implementation. It is used for
1067 * example in the 'expr' expression compiler.
1068 * ---------------------------------------------------------------------------*/
1069 void Jim_InitStack(Jim_Stack
*stack
)
1073 stack
->vector
= NULL
;
1076 void Jim_FreeStack(Jim_Stack
*stack
)
1078 Jim_Free(stack
->vector
);
1081 int Jim_StackLen(Jim_Stack
*stack
)
1086 void Jim_StackPush(Jim_Stack
*stack
, void *element
) {
1087 int neededLen
= stack
->len
+1;
1088 if (neededLen
> stack
->maxlen
) {
1089 stack
->maxlen
= neededLen
*2;
1090 stack
->vector
= Jim_Realloc(stack
->vector
, sizeof(void*)*stack
->maxlen
);
1092 stack
->vector
[stack
->len
] = element
;
1096 void *Jim_StackPop(Jim_Stack
*stack
)
1098 if (stack
->len
== 0) return NULL
;
1100 return stack
->vector
[stack
->len
];
1103 void *Jim_StackPeek(Jim_Stack
*stack
)
1105 if (stack
->len
== 0) return NULL
;
1106 return stack
->vector
[stack
->len
-1];
1109 void Jim_FreeStackElements(Jim_Stack
*stack
, void (*freeFunc
)(void *ptr
))
1113 for (i
= 0; i
< stack
->len
; i
++)
1114 freeFunc(stack
->vector
[i
]);
1117 /* -----------------------------------------------------------------------------
1119 * ---------------------------------------------------------------------------*/
1122 #define JIM_TT_NONE -1 /* No token returned */
1123 #define JIM_TT_STR 0 /* simple string */
1124 #define JIM_TT_ESC 1 /* string that needs escape chars conversion */
1125 #define JIM_TT_VAR 2 /* var substitution */
1126 #define JIM_TT_DICTSUGAR 3 /* Syntax sugar for [dict get], $foo(bar) */
1127 #define JIM_TT_CMD 4 /* command substitution */
1128 #define JIM_TT_SEP 5 /* word separator */
1129 #define JIM_TT_EOL 6 /* line separator */
1131 /* Additional token types needed for expressions */
1132 #define JIM_TT_SUBEXPR_START 7
1133 #define JIM_TT_SUBEXPR_END 8
1134 #define JIM_TT_EXPR_NUMBER 9
1135 #define JIM_TT_EXPR_OPERATOR 10
1138 #define JIM_PS_DEF 0 /* Default state */
1139 #define JIM_PS_QUOTE 1 /* Inside "" */
1141 /* Parser context structure. The same context is used both to parse
1142 * Tcl scripts and lists. */
1143 struct JimParserCtx
{
1144 const char *prg
; /* Program text */
1145 const char *p
; /* Pointer to the point of the program we are parsing */
1146 int len
; /* Left length of 'prg' */
1147 int linenr
; /* Current line number */
1149 const char *tend
; /* Returned token is at tstart-tend in 'prg'. */
1150 int tline
; /* Line number of the returned token */
1151 int tt
; /* Token type */
1152 int eof
; /* Non zero if EOF condition is true. */
1153 int state
; /* Parser state */
1154 int comment
; /* Non zero if the next chars may be a comment. */
1157 #define JimParserEof(c) ((c)->eof)
1158 #define JimParserTstart(c) ((c)->tstart)
1159 #define JimParserTend(c) ((c)->tend)
1160 #define JimParserTtype(c) ((c)->tt)
1161 #define JimParserTline(c) ((c)->tline)
1163 static int JimParseScript(struct JimParserCtx
*pc
);
1164 static int JimParseSep(struct JimParserCtx
*pc
);
1165 static int JimParseEol(struct JimParserCtx
*pc
);
1166 static int JimParseCmd(struct JimParserCtx
*pc
);
1167 static int JimParseVar(struct JimParserCtx
*pc
);
1168 static int JimParseBrace(struct JimParserCtx
*pc
);
1169 static int JimParseStr(struct JimParserCtx
*pc
);
1170 static int JimParseComment(struct JimParserCtx
*pc
);
1171 static char *JimParserGetToken(struct JimParserCtx
*pc
,
1172 int *lenPtr
, int *typePtr
, int *linePtr
);
1174 /* Initialize a parser context.
1175 * 'prg' is a pointer to the program text, linenr is the line
1176 * number of the first line contained in the program. */
1177 void JimParserInit(struct JimParserCtx
*pc
, const char *prg
,
1178 int len
, int linenr
)
1186 pc
->tt
= JIM_TT_NONE
;
1188 pc
->state
= JIM_PS_DEF
;
1189 pc
->linenr
= linenr
;
1193 int JimParseScript(struct JimParserCtx
*pc
)
1195 while(1) { /* the while is used to reiterate with continue if needed */
1199 pc
->tline
= pc
->linenr
;
1200 pc
->tt
= JIM_TT_EOL
;
1206 if (*(pc
->p
+1) == '\n')
1207 return JimParseSep(pc
);
1210 return JimParseStr(pc
);
1216 if (pc
->state
== JIM_PS_DEF
)
1217 return JimParseSep(pc
);
1220 return JimParseStr(pc
);
1226 if (pc
->state
== JIM_PS_DEF
)
1227 return JimParseEol(pc
);
1229 return JimParseStr(pc
);
1233 return JimParseCmd(pc
);
1237 if (JimParseVar(pc
) == JIM_ERR
) {
1238 pc
->tstart
= pc
->tend
= pc
->p
++; pc
->len
--;
1239 pc
->tline
= pc
->linenr
;
1240 pc
->tt
= JIM_TT_STR
;
1247 JimParseComment(pc
);
1250 return JimParseStr(pc
);
1254 return JimParseStr(pc
);
1261 int JimParseSep(struct JimParserCtx
*pc
)
1264 pc
->tline
= pc
->linenr
;
1265 while (*pc
->p
== ' ' || *pc
->p
== '\t' || *pc
->p
== '\r' ||
1266 (*pc
->p
== '\\' && *(pc
->p
+1) == '\n')) {
1267 if (*pc
->p
== '\\') {
1274 pc
->tt
= JIM_TT_SEP
;
1278 int JimParseEol(struct JimParserCtx
*pc
)
1281 pc
->tline
= pc
->linenr
;
1282 while (*pc
->p
== ' ' || *pc
->p
== '\n' ||
1283 *pc
->p
== '\t' || *pc
->p
== '\r' || *pc
->p
== ';') {
1289 pc
->tt
= JIM_TT_EOL
;
1293 /* Todo. Don't stop if ']' appears inside {} or quoted.
1294 * Also should handle the case of puts [string length "]"] */
1295 int JimParseCmd(struct JimParserCtx
*pc
)
1300 pc
->tstart
= ++pc
->p
; pc
->len
--;
1301 pc
->tline
= pc
->linenr
;
1305 } else if (*pc
->p
== '[' && blevel
== 0) {
1307 } else if (*pc
->p
== ']' && blevel
== 0) {
1310 } else if (*pc
->p
== '\\') {
1312 } else if (*pc
->p
== '{') {
1314 } else if (*pc
->p
== '}') {
1317 } else if (*pc
->p
== '\n')
1322 pc
->tt
= JIM_TT_CMD
;
1323 if (*pc
->p
== ']') {
1329 int JimParseVar(struct JimParserCtx
*pc
)
1331 int brace
= 0, stop
= 0, ttype
= JIM_TT_VAR
;
1333 pc
->tstart
= ++pc
->p
; pc
->len
--; /* skip the $ */
1334 pc
->tline
= pc
->linenr
;
1335 if (*pc
->p
== '{') {
1336 pc
->tstart
= ++pc
->p
; pc
->len
--;
1341 if (*pc
->p
== '}' || pc
->len
== 0) {
1347 else if (*pc
->p
== '\n')
1352 /* Include leading colons */
1353 while (*pc
->p
== ':') {
1358 if (!((*pc
->p
>= 'a' && *pc
->p
<= 'z') ||
1359 (*pc
->p
>= 'A' && *pc
->p
<= 'Z') ||
1360 (*pc
->p
>= '0' && *pc
->p
<= '9') || *pc
->p
== '_'))
1366 /* Parse [dict get] syntax sugar. */
1367 if (*pc
->p
== '(') {
1368 while (*pc
->p
!= ')' && pc
->len
) {
1370 if (*pc
->p
== '\\' && pc
->len
>= 2) {
1371 pc
->p
+= 2; pc
->len
-= 2;
1374 if (*pc
->p
!= '\0') {
1377 ttype
= JIM_TT_DICTSUGAR
;
1381 /* Check if we parsed just the '$' character.
1382 * That's not a variable so an error is returned
1383 * to tell the state machine to consider this '$' just
1385 if (pc
->tstart
== pc
->p
) {
1393 int JimParseBrace(struct JimParserCtx
*pc
)
1397 pc
->tstart
= ++pc
->p
; pc
->len
--;
1398 pc
->tline
= pc
->linenr
;
1400 if (*pc
->p
== '\\' && pc
->len
>= 2) {
1404 } else if (*pc
->p
== '{') {
1406 } else if (pc
->len
== 0 || *pc
->p
== '}') {
1408 if (pc
->len
== 0 || level
== 0) {
1413 pc
->tt
= JIM_TT_STR
;
1416 } else if (*pc
->p
== '\n') {
1421 return JIM_OK
; /* unreached */
1424 int JimParseStr(struct JimParserCtx
*pc
)
1426 int newword
= (pc
->tt
== JIM_TT_SEP
|| pc
->tt
== JIM_TT_EOL
||
1427 pc
->tt
== JIM_TT_NONE
|| pc
->tt
== JIM_TT_STR
);
1428 if (newword
&& *pc
->p
== '{') {
1429 return JimParseBrace(pc
);
1430 } else if (newword
&& *pc
->p
== '"') {
1431 pc
->state
= JIM_PS_QUOTE
;
1435 pc
->tline
= pc
->linenr
;
1439 pc
->tt
= JIM_TT_ESC
;
1444 if (pc
->state
== JIM_PS_DEF
&&
1445 *(pc
->p
+1) == '\n') {
1447 pc
->tt
= JIM_TT_ESC
;
1457 pc
->tt
= JIM_TT_ESC
;
1464 if (pc
->state
== JIM_PS_DEF
) {
1466 pc
->tt
= JIM_TT_ESC
;
1468 } else if (*pc
->p
== '\n') {
1473 if (pc
->state
== JIM_PS_QUOTE
) {
1475 pc
->tt
= JIM_TT_ESC
;
1477 pc
->state
= JIM_PS_DEF
;
1484 return JIM_OK
; /* unreached */
1487 int JimParseComment(struct JimParserCtx
*pc
)
1490 if (*pc
->p
== '\n') {
1492 if (*(pc
->p
-1) != '\\') {
1502 /* xdigitval and odigitval are helper functions for JimParserGetToken() */
1503 static int xdigitval(int c
)
1505 if (c
>= '0' && c
<= '9') return c
-'0';
1506 if (c
>= 'a' && c
<= 'f') return c
-'a'+10;
1507 if (c
>= 'A' && c
<= 'F') return c
-'A'+10;
1511 static int odigitval(int c
)
1513 if (c
>= '0' && c
<= '7') return c
-'0';
1517 /* Perform Tcl escape substitution of 's', storing the result
1518 * string into 'dest'. The escaped string is guaranteed to
1519 * be the same length or shorted than the source string.
1520 * Slen is the length of the string at 's', if it's -1 the string
1521 * length will be calculated by the function.
1523 * The function returns the length of the resulting string. */
1524 static int JimEscape(char *dest
, const char *s
, int slen
)
1532 for (i
= 0; i
< slen
; i
++) {
1536 case 'a': *p
++ = 0x7; i
++; break;
1537 case 'b': *p
++ = 0x8; i
++; break;
1538 case 'f': *p
++ = 0xc; i
++; break;
1539 case 'n': *p
++ = 0xa; i
++; break;
1540 case 'r': *p
++ = 0xd; i
++; break;
1541 case 't': *p
++ = 0x9; i
++; break;
1542 case 'v': *p
++ = 0xb; i
++; break;
1543 case '\0': *p
++ = '\\'; i
++; break;
1544 case '\n': *p
++ = ' '; i
++; break;
1546 if (s
[i
+1] == 'x') {
1548 int c
= xdigitval(s
[i
+2]);
1555 c
= xdigitval(s
[i
+3]);
1565 } else if (s
[i
+1] >= '0' && s
[i
+1] <= '7')
1568 int c
= odigitval(s
[i
+1]);
1570 c
= odigitval(s
[i
+2]);
1577 c
= odigitval(s
[i
+3]);
1603 /* Returns a dynamically allocated copy of the current token in the
1604 * parser context. The function perform conversion of escapes if
1605 * the token is of type JIM_TT_ESC.
1607 * Note that after the conversion, tokens that are grouped with
1608 * braces in the source code, are always recognizable from the
1609 * identical string obtained in a different way from the type.
1611 * For exmple the string:
1615 * will return as first token "expand", of type JIM_TT_STR
1621 * will return as first token "expand", of type JIM_TT_ESC
1623 char *JimParserGetToken(struct JimParserCtx
*pc
,
1624 int *lenPtr
, int *typePtr
, int *linePtr
)
1626 const char *start
, *end
;
1630 start
= JimParserTstart(pc
);
1631 end
= JimParserTend(pc
);
1633 if (lenPtr
) *lenPtr
= 0;
1634 if (typePtr
) *typePtr
= JimParserTtype(pc
);
1635 if (linePtr
) *linePtr
= JimParserTline(pc
);
1636 token
= Jim_Alloc(1);
1640 len
= (end
-start
)+1;
1641 token
= Jim_Alloc(len
+1);
1642 if (JimParserTtype(pc
) != JIM_TT_ESC
) {
1643 /* No escape conversion needed? Just copy it. */
1644 memcpy(token
, start
, len
);
1647 /* Else convert the escape chars. */
1648 len
= JimEscape(token
, start
, len
);
1650 if (lenPtr
) *lenPtr
= len
;
1651 if (typePtr
) *typePtr
= JimParserTtype(pc
);
1652 if (linePtr
) *linePtr
= JimParserTline(pc
);
1656 /* The following functin is not really part of the parsing engine of Jim,
1657 * but it somewhat related. Given an string and its length, it tries
1658 * to guess if the script is complete or there are instead " " or { }
1659 * open and not completed. This is useful for interactive shells
1660 * implementation and for [info complete].
1662 * If 'stateCharPtr' != NULL, the function stores ' ' on complete script,
1663 * '{' on scripts incomplete missing one or more '}' to be balanced.
1664 * '"' on scripts incomplete missing a '"' char.
1666 * If the script is complete, 1 is returned, otherwise 0. */
1667 int Jim_ScriptIsComplete(const char *s
, int len
, char *stateCharPtr
)
1681 } else if (state
== '"') {
1688 } else if (state
== ' ') {
1705 *stateCharPtr
= state
;
1706 return state
== ' ';
1709 /* -----------------------------------------------------------------------------
1711 * ---------------------------------------------------------------------------*/
1712 static int JimParseListSep(struct JimParserCtx
*pc
);
1713 static int JimParseListStr(struct JimParserCtx
*pc
);
1715 int JimParseList(struct JimParserCtx
*pc
)
1718 pc
->tstart
= pc
->tend
= pc
->p
;
1719 pc
->tline
= pc
->linenr
;
1720 pc
->tt
= JIM_TT_EOL
;
1729 if (pc
->state
== JIM_PS_DEF
)
1730 return JimParseListSep(pc
);
1732 return JimParseListStr(pc
);
1735 return JimParseListStr(pc
);
1741 int JimParseListSep(struct JimParserCtx
*pc
)
1744 pc
->tline
= pc
->linenr
;
1745 while (*pc
->p
== ' ' || *pc
->p
== '\t' || *pc
->p
== '\r' || *pc
->p
== '\n')
1750 pc
->tt
= JIM_TT_SEP
;
1754 int JimParseListStr(struct JimParserCtx
*pc
)
1756 int newword
= (pc
->tt
== JIM_TT_SEP
|| pc
->tt
== JIM_TT_EOL
||
1757 pc
->tt
== JIM_TT_NONE
);
1758 if (newword
&& *pc
->p
== '{') {
1759 return JimParseBrace(pc
);
1760 } else if (newword
&& *pc
->p
== '"') {
1761 pc
->state
= JIM_PS_QUOTE
;
1765 pc
->tline
= pc
->linenr
;
1769 pc
->tt
= JIM_TT_ESC
;
1780 if (pc
->state
== JIM_PS_DEF
) {
1782 pc
->tt
= JIM_TT_ESC
;
1784 } else if (*pc
->p
== '\n') {
1789 if (pc
->state
== JIM_PS_QUOTE
) {
1791 pc
->tt
= JIM_TT_ESC
;
1793 pc
->state
= JIM_PS_DEF
;
1800 return JIM_OK
; /* unreached */
1803 /* -----------------------------------------------------------------------------
1804 * Jim_Obj related functions
1805 * ---------------------------------------------------------------------------*/
1807 /* Return a new initialized object. */
1808 Jim_Obj
*Jim_NewObj(Jim_Interp
*interp
)
1812 /* -- Check if there are objects in the free list -- */
1813 if (interp
->freeList
!= NULL
) {
1814 /* -- Unlink the object from the free list -- */
1815 objPtr
= interp
->freeList
;
1816 interp
->freeList
= objPtr
->nextObjPtr
;
1818 /* -- No ready to use objects: allocate a new one -- */
1819 objPtr
= Jim_Alloc(sizeof(*objPtr
));
1822 /* Object is returned with refCount of 0. Every
1823 * kind of GC implemented should take care to don't try
1824 * to scan objects with refCount == 0. */
1825 objPtr
->refCount
= 0;
1826 /* All the other fields are left not initialized to save time.
1827 * The caller will probably want set they to the right
1830 /* -- Put the object into the live list -- */
1831 objPtr
->prevObjPtr
= NULL
;
1832 objPtr
->nextObjPtr
= interp
->liveList
;
1833 if (interp
->liveList
)
1834 interp
->liveList
->prevObjPtr
= objPtr
;
1835 interp
->liveList
= objPtr
;
1840 /* Free an object. Actually objects are never freed, but
1841 * just moved to the free objects list, where they will be
1842 * reused by Jim_NewObj(). */
1843 void Jim_FreeObj(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
1845 /* Check if the object was already freed, panic. */
1846 if (objPtr
->refCount
!= 0) {
1847 Jim_Panic(interp
,"!!!Object %p freed with bad refcount %d", objPtr
,
1850 /* Free the internal representation */
1851 Jim_FreeIntRep(interp
, objPtr
);
1852 /* Free the string representation */
1853 if (objPtr
->bytes
!= NULL
) {
1854 if (objPtr
->bytes
!= JimEmptyStringRep
)
1855 Jim_Free(objPtr
->bytes
);
1857 /* Unlink the object from the live objects list */
1858 if (objPtr
->prevObjPtr
)
1859 objPtr
->prevObjPtr
->nextObjPtr
= objPtr
->nextObjPtr
;
1860 if (objPtr
->nextObjPtr
)
1861 objPtr
->nextObjPtr
->prevObjPtr
= objPtr
->prevObjPtr
;
1862 if (interp
->liveList
== objPtr
)
1863 interp
->liveList
= objPtr
->nextObjPtr
;
1864 /* Link the object into the free objects list */
1865 objPtr
->prevObjPtr
= NULL
;
1866 objPtr
->nextObjPtr
= interp
->freeList
;
1867 if (interp
->freeList
)
1868 interp
->freeList
->prevObjPtr
= objPtr
;
1869 interp
->freeList
= objPtr
;
1870 objPtr
->refCount
= -1;
1873 /* Invalidate the string representation of an object. */
1874 void Jim_InvalidateStringRep(Jim_Obj
*objPtr
)
1876 if (objPtr
->bytes
!= NULL
) {
1877 if (objPtr
->bytes
!= JimEmptyStringRep
)
1878 Jim_Free(objPtr
->bytes
);
1880 objPtr
->bytes
= NULL
;
1883 #define Jim_SetStringRep(o, b, l) \
1884 do { (o)->bytes = b; (o)->length = l; } while (0)
1886 /* Set the initial string representation for an object.
1887 * Does not try to free an old one. */
1888 void Jim_InitStringRep(Jim_Obj
*objPtr
, const char *bytes
, int length
)
1891 objPtr
->bytes
= JimEmptyStringRep
;
1894 objPtr
->bytes
= Jim_Alloc(length
+1);
1895 objPtr
->length
= length
;
1896 memcpy(objPtr
->bytes
, bytes
, length
);
1897 objPtr
->bytes
[length
] = '\0';
1901 /* Duplicate an object. The returned object has refcount = 0. */
1902 Jim_Obj
*Jim_DuplicateObj(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
1906 dupPtr
= Jim_NewObj(interp
);
1907 if (objPtr
->bytes
== NULL
) {
1908 /* Object does not have a valid string representation. */
1909 dupPtr
->bytes
= NULL
;
1911 Jim_InitStringRep(dupPtr
, objPtr
->bytes
, objPtr
->length
);
1913 if (objPtr
->typePtr
!= NULL
) {
1914 if (objPtr
->typePtr
->dupIntRepProc
== NULL
) {
1915 dupPtr
->internalRep
= objPtr
->internalRep
;
1917 objPtr
->typePtr
->dupIntRepProc(interp
, objPtr
, dupPtr
);
1919 dupPtr
->typePtr
= objPtr
->typePtr
;
1921 dupPtr
->typePtr
= NULL
;
1926 /* Return the string representation for objPtr. If the object
1927 * string representation is invalid, calls the method to create
1928 * a new one starting from the internal representation of the object. */
1929 const char *Jim_GetString(Jim_Obj
*objPtr
, int *lenPtr
)
1931 if (objPtr
->bytes
== NULL
) {
1932 /* Invalid string repr. Generate it. */
1933 if (objPtr
->typePtr
->updateStringProc
== NULL
) {
1934 Jim_Panic(NULL
,"UpdataStringProc called against '%s' type.",
1935 objPtr
->typePtr
->name
);
1937 objPtr
->typePtr
->updateStringProc(objPtr
);
1940 *lenPtr
= objPtr
->length
;
1941 return objPtr
->bytes
;
1944 /* Just returns the length of the object's string rep */
1945 int Jim_Length(Jim_Obj
*objPtr
)
1949 Jim_GetString(objPtr
, &len
);
1953 /* -----------------------------------------------------------------------------
1955 * ---------------------------------------------------------------------------*/
1956 static void DupStringInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
);
1957 static int SetStringFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
);
1959 static Jim_ObjType stringObjType
= {
1962 DupStringInternalRep
,
1964 JIM_TYPE_REFERENCES
,
1967 void DupStringInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
)
1969 JIM_NOTUSED(interp
);
1971 /* This is a bit subtle: the only caller of this function
1972 * should be Jim_DuplicateObj(), that will copy the
1973 * string representaion. After the copy, the duplicated
1974 * object will not have more room in teh buffer than
1975 * srcPtr->length bytes. So we just set it to length. */
1976 dupPtr
->internalRep
.strValue
.maxLength
= srcPtr
->length
;
1979 int SetStringFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
1981 /* Get a fresh string representation. */
1982 (void) Jim_GetString(objPtr
, NULL
);
1983 /* Free any other internal representation. */
1984 Jim_FreeIntRep(interp
, objPtr
);
1985 /* Set it as string, i.e. just set the maxLength field. */
1986 objPtr
->typePtr
= &stringObjType
;
1987 objPtr
->internalRep
.strValue
.maxLength
= objPtr
->length
;
1991 Jim_Obj
*Jim_NewStringObj(Jim_Interp
*interp
, const char *s
, int len
)
1993 Jim_Obj
*objPtr
= Jim_NewObj(interp
);
1997 /* Alloc/Set the string rep. */
1999 objPtr
->bytes
= JimEmptyStringRep
;
2002 objPtr
->bytes
= Jim_Alloc(len
+1);
2003 objPtr
->length
= len
;
2004 memcpy(objPtr
->bytes
, s
, len
);
2005 objPtr
->bytes
[len
] = '\0';
2008 /* No typePtr field for the vanilla string object. */
2009 objPtr
->typePtr
= NULL
;
2013 /* This version does not try to duplicate the 's' pointer, but
2014 * use it directly. */
2015 Jim_Obj
*Jim_NewStringObjNoAlloc(Jim_Interp
*interp
, char *s
, int len
)
2017 Jim_Obj
*objPtr
= Jim_NewObj(interp
);
2021 Jim_SetStringRep(objPtr
, s
, len
);
2022 objPtr
->typePtr
= NULL
;
2026 /* Low-level string append. Use it only against objects
2027 * of type "string". */
2028 void StringAppendString(Jim_Obj
*objPtr
, const char *str
, int len
)
2034 needlen
= objPtr
->length
+ len
;
2035 if (objPtr
->internalRep
.strValue
.maxLength
< needlen
||
2036 objPtr
->internalRep
.strValue
.maxLength
== 0) {
2037 if (objPtr
->bytes
== JimEmptyStringRep
) {
2038 objPtr
->bytes
= Jim_Alloc((needlen
*2)+1);
2040 objPtr
->bytes
= Jim_Realloc(objPtr
->bytes
, (needlen
*2)+1);
2042 objPtr
->internalRep
.strValue
.maxLength
= needlen
*2;
2044 memcpy(objPtr
->bytes
+ objPtr
->length
, str
, len
);
2045 objPtr
->bytes
[objPtr
->length
+len
] = '\0';
2046 objPtr
->length
+= len
;
2049 /* Low-level wrapper to append an object. */
2050 void StringAppendObj(Jim_Obj
*objPtr
, Jim_Obj
*appendObjPtr
)
2055 str
= Jim_GetString(appendObjPtr
, &len
);
2056 StringAppendString(objPtr
, str
, len
);
2059 /* Higher level API to append strings to objects. */
2060 void Jim_AppendString(Jim_Interp
*interp
, Jim_Obj
*objPtr
, const char *str
,
2063 if (Jim_IsShared(objPtr
))
2064 Jim_Panic(interp
,"Jim_AppendString called with shared object");
2065 if (objPtr
->typePtr
!= &stringObjType
)
2066 SetStringFromAny(interp
, objPtr
);
2067 StringAppendString(objPtr
, str
, len
);
2070 void Jim_AppendString_sprintf( Jim_Interp
*interp
, Jim_Obj
*objPtr
, const char *fmt
, ... )
2075 va_start( ap
, fmt
);
2076 buf
= jim_vasprintf( fmt
, ap
);
2080 Jim_AppendString( interp
, objPtr
, buf
, -1 );
2081 jim_vasprintf_done(buf
);
2086 void Jim_AppendObj(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
2087 Jim_Obj
*appendObjPtr
)
2092 str
= Jim_GetString(appendObjPtr
, &len
);
2093 Jim_AppendString(interp
, objPtr
, str
, len
);
2096 void Jim_AppendStrings(Jim_Interp
*interp
, Jim_Obj
*objPtr
, ...)
2100 if (objPtr
->typePtr
!= &stringObjType
)
2101 SetStringFromAny(interp
, objPtr
);
2102 va_start(ap
, objPtr
);
2104 char *s
= va_arg(ap
, char*);
2106 if (s
== NULL
) break;
2107 Jim_AppendString(interp
, objPtr
, s
, -1);
2112 int Jim_StringEqObj(Jim_Obj
*aObjPtr
, Jim_Obj
*bObjPtr
, int nocase
)
2114 const char *aStr
, *bStr
;
2117 if (aObjPtr
== bObjPtr
) return 1;
2118 aStr
= Jim_GetString(aObjPtr
, &aLen
);
2119 bStr
= Jim_GetString(bObjPtr
, &bLen
);
2120 if (aLen
!= bLen
) return 0;
2122 return memcmp(aStr
, bStr
, aLen
) == 0;
2123 for (i
= 0; i
< aLen
; i
++) {
2124 if (tolower((int)aStr
[i
]) != tolower((int)bStr
[i
]))
2130 int Jim_StringMatchObj(Jim_Obj
*patternObjPtr
, Jim_Obj
*objPtr
,
2133 const char *pattern
, *string
;
2134 int patternLen
, stringLen
;
2136 pattern
= Jim_GetString(patternObjPtr
, &patternLen
);
2137 string
= Jim_GetString(objPtr
, &stringLen
);
2138 return JimStringMatch(pattern
, patternLen
, string
, stringLen
, nocase
);
2141 int Jim_StringCompareObj(Jim_Obj
*firstObjPtr
,
2142 Jim_Obj
*secondObjPtr
, int nocase
)
2144 const char *s1
, *s2
;
2147 s1
= Jim_GetString(firstObjPtr
, &l1
);
2148 s2
= Jim_GetString(secondObjPtr
, &l2
);
2149 return JimStringCompare(s1
, l1
, s2
, l2
, nocase
);
2152 /* Convert a range, as returned by Jim_GetRange(), into
2153 * an absolute index into an object of the specified length.
2154 * This function may return negative values, or values
2155 * bigger or equal to the length of the list if the index
2156 * is out of range. */
2157 static int JimRelToAbsIndex(int len
, int index
)
2164 /* Convert a pair of index as normalize by JimRelToAbsIndex(),
2165 * into a range stored in *firstPtr, *lastPtr, *rangeLenPtr, suitable
2166 * for implementation of commands like [string range] and [lrange].
2168 * The resulting range is guaranteed to address valid elements of
2170 static void JimRelToAbsRange(int len
, int first
, int last
,
2171 int *firstPtr
, int *lastPtr
, int *rangeLenPtr
)
2178 rangeLen
= last
-first
+1;
2185 rangeLen
-= (last
-(len
-1));
2190 if (rangeLen
< 0) rangeLen
= 0;
2194 *rangeLenPtr
= rangeLen
;
2197 Jim_Obj
*Jim_StringRangeObj(Jim_Interp
*interp
,
2198 Jim_Obj
*strObjPtr
, Jim_Obj
*firstObjPtr
, Jim_Obj
*lastObjPtr
)
2204 if (Jim_GetIndex(interp
, firstObjPtr
, &first
) != JIM_OK
||
2205 Jim_GetIndex(interp
, lastObjPtr
, &last
) != JIM_OK
)
2207 str
= Jim_GetString(strObjPtr
, &len
);
2208 first
= JimRelToAbsIndex(len
, first
);
2209 last
= JimRelToAbsIndex(len
, last
);
2210 JimRelToAbsRange(len
, first
, last
, &first
, &last
, &rangeLen
);
2211 return Jim_NewStringObj(interp
, str
+first
, rangeLen
);
2214 static Jim_Obj
*JimStringToLower(Jim_Interp
*interp
, Jim_Obj
*strObjPtr
)
2218 if (strObjPtr
->typePtr
!= &stringObjType
) {
2219 SetStringFromAny(interp
, strObjPtr
);
2222 buf
= Jim_Alloc(strObjPtr
->length
+1);
2224 memcpy(buf
, strObjPtr
->bytes
, strObjPtr
->length
+1);
2225 for (i
= 0; i
< strObjPtr
->length
; i
++)
2226 buf
[i
] = tolower(buf
[i
]);
2227 return Jim_NewStringObjNoAlloc(interp
, buf
, strObjPtr
->length
);
2230 static Jim_Obj
*JimStringToUpper(Jim_Interp
*interp
, Jim_Obj
*strObjPtr
)
2234 if (strObjPtr
->typePtr
!= &stringObjType
) {
2235 SetStringFromAny(interp
, strObjPtr
);
2238 buf
= Jim_Alloc(strObjPtr
->length
+1);
2240 memcpy(buf
, strObjPtr
->bytes
, strObjPtr
->length
+1);
2241 for (i
= 0; i
< strObjPtr
->length
; i
++)
2242 buf
[i
] = toupper(buf
[i
]);
2243 return Jim_NewStringObjNoAlloc(interp
, buf
, strObjPtr
->length
);
2246 /* This is the core of the [format] command.
2247 * TODO: Lots of things work - via a hack
2248 * However, no format item can be >= JIM_MAX_FMT
2250 #define JIM_MAX_FMT 2048
2251 static Jim_Obj
*Jim_FormatString_Inner(Jim_Interp
*interp
, Jim_Obj
*fmtObjPtr
,
2252 int objc
, Jim_Obj
*const *objv
, char *sprintf_buf
)
2254 const char *fmt
, *_fmt
;
2259 fmt
= Jim_GetString(fmtObjPtr
, &fmtLen
);
2261 resObjPtr
= Jim_NewStringObj(interp
, "", 0);
2263 const char *p
= fmt
;
2267 /* we cheat and use Sprintf()! */
2281 while (*fmt
!= '%' && fmtLen
) {
2284 Jim_AppendString(interp
, resObjPtr
, p
, fmt
-p
);
2287 fmt
++; fmtLen
--; /* skip '%' */
2296 prec
= -1; /* not found yet */
2303 case 'b': /* binary - not all printfs() do this */
2304 case 's': /* string */
2305 case 'i': /* integer */
2306 case 'd': /* decimal */
2308 case 'X': /* CAP hex */
2309 case 'c': /* char */
2310 case 'o': /* octal */
2311 case 'u': /* unsigned */
2312 case 'f': /* float */
2316 case '0': /* zero pad */
2326 case ' ': /* sign space */
2356 while( isdigit(*fmt
) && (fmtLen
> 0) ){
2357 accum
= (accum
* 10) + (*fmt
- '0');
2368 /* suck up the next item as an integer */
2372 goto not_enough_args
;
2374 if( Jim_GetWide(interp
,objv
[0],&wideValue
)== JIM_ERR
){
2375 Jim_FreeNewObj(interp
, resObjPtr
);
2382 /* man 3 printf says */
2383 /* if prec is negative, it is zero */
2402 Jim_FreeNewObj(interp
, resObjPtr
);
2403 Jim_SetResultString(interp
,
2404 "not enough arguments for all format specifiers", -1);
2412 * Create the formatter
2413 * cause we cheat and use sprintf()
2423 /* PLUS overrides */
2433 sprintf( cp
, "%d", width
);
2437 /* did we find a period? */
2441 /* did something occur after the period? */
2443 sprintf( cp
, "%d", prec
);
2449 /* here we do the work */
2450 /* actually - we make sprintf() do it for us */
2455 /* BUG: we do not handled embeded NULLs */
2456 snprintf( sprintf_buf
, JIM_MAX_FMT
, fmt_str
, Jim_GetString( objv
[0], NULL
));
2461 if (Jim_GetWide(interp
, objv
[0], &wideValue
) == JIM_ERR
) {
2462 Jim_FreeNewObj(interp
, resObjPtr
);
2465 c
= (char) wideValue
;
2466 snprintf( sprintf_buf
, JIM_MAX_FMT
, fmt_str
, c
);
2476 if( Jim_GetDouble( interp
, objv
[0], &doubleValue
) == JIM_ERR
){
2477 Jim_FreeNewObj( interp
, resObjPtr
);
2480 snprintf( sprintf_buf
, JIM_MAX_FMT
, fmt_str
, doubleValue
);
2489 /* jim widevaluse are 64bit */
2490 if( sizeof(jim_wide
) == sizeof(long long) ){
2498 if (Jim_GetWide(interp
, objv
[0], &wideValue
) == JIM_ERR
) {
2499 Jim_FreeNewObj(interp
, resObjPtr
);
2502 snprintf(sprintf_buf
, JIM_MAX_FMT
, fmt_str
, wideValue
);
2505 sprintf_buf
[0] = '%';
2507 objv
--; /* undo the objv++ below */
2510 spec
[0] = *fmt
; spec
[1] = '\0';
2511 Jim_FreeNewObj(interp
, resObjPtr
);
2512 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
2513 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
2514 "bad field specifier \"", spec
, "\"", NULL
);
2517 /* force terminate */
2519 printf("FMT was: %s\n", fmt_str
);
2520 printf("RES was: |%s|\n", sprintf_buf
);
2523 sprintf_buf
[ JIM_MAX_FMT
- 1] = 0;
2524 Jim_AppendString( interp
, resObjPtr
, sprintf_buf
, strlen(sprintf_buf
) );
2533 Jim_Obj
*Jim_FormatString(Jim_Interp
*interp
, Jim_Obj
*fmtObjPtr
,
2534 int objc
, Jim_Obj
*const *objv
)
2536 char *sprintf_buf
=malloc(JIM_MAX_FMT
);
2537 Jim_Obj
*t
=Jim_FormatString_Inner(interp
, fmtObjPtr
, objc
, objv
, sprintf_buf
);
2542 /* -----------------------------------------------------------------------------
2543 * Compared String Object
2544 * ---------------------------------------------------------------------------*/
2546 /* This is strange object that allows to compare a C literal string
2547 * with a Jim object in very short time if the same comparison is done
2548 * multiple times. For example every time the [if] command is executed,
2549 * Jim has to check if a given argument is "else". This comparions if
2550 * the code has no errors are true most of the times, so we can cache
2551 * inside the object the pointer of the string of the last matching
2552 * comparison. Because most C compilers perform literal sharing,
2553 * so that: char *x = "foo", char *y = "foo", will lead to x == y,
2554 * this works pretty well even if comparisons are at different places
2555 * inside the C code. */
2557 static Jim_ObjType comparedStringObjType
= {
2562 JIM_TYPE_REFERENCES
,
2565 /* The only way this object is exposed to the API is via the following
2566 * function. Returns true if the string and the object string repr.
2567 * are the same, otherwise zero is returned.
2569 * Note: this isn't binary safe, but it hardly needs to be.*/
2570 int Jim_CompareStringImmediate(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
2573 if (objPtr
->typePtr
== &comparedStringObjType
&&
2574 objPtr
->internalRep
.ptr
== str
)
2577 const char *objStr
= Jim_GetString(objPtr
, NULL
);
2578 if (strcmp(str
, objStr
) != 0) return 0;
2579 if (objPtr
->typePtr
!= &comparedStringObjType
) {
2580 Jim_FreeIntRep(interp
, objPtr
);
2581 objPtr
->typePtr
= &comparedStringObjType
;
2583 objPtr
->internalRep
.ptr
= (char*)str
; /*ATTENTION: const cast */
2588 int qsortCompareStringPointers(const void *a
, const void *b
)
2590 char * const *sa
= (char * const *)a
;
2591 char * const *sb
= (char * const *)b
;
2592 return strcmp(*sa
, *sb
);
2595 int Jim_GetEnum(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
2596 const char * const *tablePtr
, int *indexPtr
, const char *name
, int flags
)
2598 const char * const *entryPtr
= NULL
;
2599 char **tablePtrSorted
;
2603 for (entryPtr
= tablePtr
, i
= 0; *entryPtr
!= NULL
; entryPtr
++, i
++) {
2604 if (Jim_CompareStringImmediate(interp
, objPtr
, *entryPtr
)) {
2608 count
++; /* If nothing matches, this will reach the len of tablePtr */
2610 if (flags
& JIM_ERRMSG
) {
2613 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
2614 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
2615 "bad ", name
, " \"", Jim_GetString(objPtr
, NULL
), "\": must be one of ",
2617 tablePtrSorted
= Jim_Alloc(sizeof(char*)*count
);
2618 memcpy(tablePtrSorted
, tablePtr
, sizeof(char*)*count
);
2619 qsort(tablePtrSorted
, count
, sizeof(char*), qsortCompareStringPointers
);
2620 for (i
= 0; i
< count
; i
++) {
2621 if (i
+1 == count
&& count
> 1)
2622 Jim_AppendString(interp
, Jim_GetResult(interp
), "or ", -1);
2623 Jim_AppendString(interp
, Jim_GetResult(interp
),
2624 tablePtrSorted
[i
], -1);
2626 Jim_AppendString(interp
, Jim_GetResult(interp
), ", ", -1);
2628 Jim_Free(tablePtrSorted
);
2633 int Jim_GetNvp(Jim_Interp
*interp
,
2635 const Jim_Nvp
*nvp_table
,
2636 const Jim_Nvp
** result
)
2641 e
= Jim_Nvp_name2value_obj( interp
, nvp_table
, objPtr
, &n
);
2646 /* Success? found? */
2649 *result
= (Jim_Nvp
*)n
;
2656 /* -----------------------------------------------------------------------------
2659 * This object is just a string from the language point of view, but
2660 * in the internal representation it contains the filename and line number
2661 * where this given token was read. This information is used by
2662 * Jim_EvalObj() if the object passed happens to be of type "source".
2664 * This allows to propagate the information about line numbers and file
2665 * names and give error messages with absolute line numbers.
2667 * Note that this object uses shared strings for filenames, and the
2668 * pointer to the filename together with the line number is taken into
2669 * the space for the "inline" internal represenation of the Jim_Object,
2670 * so there is almost memory zero-overhead.
2672 * Also the object will be converted to something else if the given
2673 * token it represents in the source file is not something to be
2674 * evaluated (not a script), and will be specialized in some other way,
2675 * so the time overhead is alzo null.
2676 * ---------------------------------------------------------------------------*/
2678 static void FreeSourceInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
2679 static void DupSourceInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
);
2681 static Jim_ObjType sourceObjType
= {
2683 FreeSourceInternalRep
,
2684 DupSourceInternalRep
,
2686 JIM_TYPE_REFERENCES
,
2689 void FreeSourceInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
2691 Jim_ReleaseSharedString(interp
,
2692 objPtr
->internalRep
.sourceValue
.fileName
);
2695 void DupSourceInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
)
2697 dupPtr
->internalRep
.sourceValue
.fileName
=
2698 Jim_GetSharedString(interp
,
2699 srcPtr
->internalRep
.sourceValue
.fileName
);
2700 dupPtr
->internalRep
.sourceValue
.lineNumber
=
2701 dupPtr
->internalRep
.sourceValue
.lineNumber
;
2702 dupPtr
->typePtr
= &sourceObjType
;
2705 static void JimSetSourceInfo(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
2706 const char *fileName
, int lineNumber
)
2708 if (Jim_IsShared(objPtr
))
2709 Jim_Panic(interp
,"JimSetSourceInfo called with shared object");
2710 if (objPtr
->typePtr
!= NULL
)
2711 Jim_Panic(interp
,"JimSetSourceInfo called with typePtr != NULL");
2712 objPtr
->internalRep
.sourceValue
.fileName
=
2713 Jim_GetSharedString(interp
, fileName
);
2714 objPtr
->internalRep
.sourceValue
.lineNumber
= lineNumber
;
2715 objPtr
->typePtr
= &sourceObjType
;
2718 /* -----------------------------------------------------------------------------
2720 * ---------------------------------------------------------------------------*/
2722 #define JIM_CMDSTRUCT_EXPAND -1
2724 static void FreeScriptInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
2725 static void DupScriptInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
);
2726 static int SetScriptFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
);
2728 static Jim_ObjType scriptObjType
= {
2730 FreeScriptInternalRep
,
2731 DupScriptInternalRep
,
2733 JIM_TYPE_REFERENCES
,
2736 /* The ScriptToken structure represents every token into a scriptObj.
2737 * Every token contains an associated Jim_Obj that can be specialized
2738 * by commands operating on it. */
2739 typedef struct ScriptToken
{
2745 /* This is the script object internal representation. An array of
2746 * ScriptToken structures, with an associated command structure array.
2747 * The command structure is a pre-computed representation of the
2748 * command length and arguments structure as a simple liner array
2751 * For example the script:
2754 * set $i $x$y [foo]BAR
2756 * will produce a ScriptObj with the following Tokens:
2773 * This is a description of the tokens, separators, and of lines.
2774 * The command structure instead represents the number of arguments
2775 * of every command, followed by the tokens of which every argument
2776 * is composed. So for the example script, the cmdstruct array will
2781 * Because "puts hello" has two args (2), composed of single tokens (1 1)
2782 * While "set $i $x$y [foo]BAR" has four (4) args, the first two
2783 * composed of single tokens (1 1) and the last two of double tokens
2786 * The precomputation of the command structure makes Jim_Eval() faster,
2787 * and simpler because there aren't dynamic lengths / allocations.
2789 * -- {expand} handling --
2791 * Expand is handled in a special way. When a command
2792 * contains at least an argument with the {expand} prefix,
2793 * the command structure presents a -1 before the integer
2794 * describing the number of arguments. This is used in order
2795 * to send the command exection to a different path in case
2796 * of {expand} and guarantee a fast path for the more common
2797 * case. Also, the integers describing the number of tokens
2798 * are expressed with negative sign, to allow for fast check
2799 * of what's an {expand}-prefixed argument and what not.
2801 * For example the command:
2803 * list {expand}{1 2}
2805 * Will produce the following cmdstruct array:
2809 * -- the substFlags field of the structure --
2811 * The scriptObj structure is used to represent both "script" objects
2812 * and "subst" objects. In the second case, the cmdStruct related
2813 * fields are not used at all, but there is an additional field used
2814 * that is 'substFlags': this represents the flags used to turn
2815 * the string into the intenral representation used to perform the
2816 * substitution. If this flags are not what the application requires
2817 * the scriptObj is created again. For example the script:
2819 * subst -nocommands $string
2820 * subst -novariables $string
2822 * Will recreate the internal representation of the $string object
2825 typedef struct ScriptObj
{
2826 int len
; /* Length as number of tokens. */
2827 int commands
; /* number of top-level commands in script. */
2828 ScriptToken
*token
; /* Tokens array. */
2829 int *cmdStruct
; /* commands structure */
2830 int csLen
; /* length of the cmdStruct array. */
2831 int substFlags
; /* flags used for the compilation of "subst" objects */
2832 int inUse
; /* Used to share a ScriptObj. Currently
2833 only used by Jim_EvalObj() as protection against
2834 shimmering of the currently evaluated object. */
2838 void FreeScriptInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
2841 struct ScriptObj
*script
= (void*) objPtr
->internalRep
.ptr
;
2844 if (script
->inUse
!= 0) return;
2845 for (i
= 0; i
< script
->len
; i
++) {
2846 if (script
->token
[i
].objPtr
!= NULL
)
2847 Jim_DecrRefCount(interp
, script
->token
[i
].objPtr
);
2849 Jim_Free(script
->token
);
2850 Jim_Free(script
->cmdStruct
);
2851 Jim_Free(script
->fileName
);
2855 void DupScriptInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
)
2857 JIM_NOTUSED(interp
);
2858 JIM_NOTUSED(srcPtr
);
2860 /* Just returns an simple string. */
2861 dupPtr
->typePtr
= NULL
;
2864 /* Add a new token to the internal repr of a script object */
2865 static void ScriptObjAddToken(Jim_Interp
*interp
, struct ScriptObj
*script
,
2866 char *strtoken
, int len
, int type
, char *filename
, int linenr
)
2869 struct ScriptToken
*token
;
2871 prevtype
= (script
->len
== 0) ? JIM_TT_EOL
: \
2872 script
->token
[script
->len
-1].type
;
2873 /* Skip tokens without meaning, like words separators
2874 * following a word separator or an end of command and
2876 if (prevtype
== JIM_TT_EOL
) {
2877 if (type
== JIM_TT_EOL
|| type
== JIM_TT_SEP
) {
2881 } else if (prevtype
== JIM_TT_SEP
) {
2882 if (type
== JIM_TT_SEP
) {
2885 } else if (type
== JIM_TT_EOL
) {
2886 /* If an EOL is following by a SEP, drop the previous
2889 Jim_DecrRefCount(interp
, script
->token
[script
->len
].objPtr
);
2891 } else if (prevtype
!= JIM_TT_EOL
&& prevtype
!= JIM_TT_SEP
&&
2892 type
== JIM_TT_ESC
&& len
== 0)
2894 /* Don't add empty tokens used in interpolation */
2898 /* Make space for a new istruction */
2900 script
->token
= Jim_Realloc(script
->token
,
2901 sizeof(ScriptToken
)*script
->len
);
2902 /* Initialize the new token */
2903 token
= script
->token
+(script
->len
-1);
2905 /* Every object is intially as a string, but the
2906 * internal type may be specialized during execution of the
2908 token
->objPtr
= Jim_NewStringObjNoAlloc(interp
, strtoken
, len
);
2909 /* To add source info to SEP and EOL tokens is useless because
2910 * they will never by called as arguments of Jim_EvalObj(). */
2911 if (filename
&& type
!= JIM_TT_SEP
&& type
!= JIM_TT_EOL
)
2912 JimSetSourceInfo(interp
, token
->objPtr
, filename
, linenr
);
2913 Jim_IncrRefCount(token
->objPtr
);
2914 token
->linenr
= linenr
;
2917 /* Add an integer into the command structure field of the script object. */
2918 static void ScriptObjAddInt(struct ScriptObj
*script
, int val
)
2921 script
->cmdStruct
= Jim_Realloc(script
->cmdStruct
,
2922 sizeof(int)*script
->csLen
);
2923 script
->cmdStruct
[script
->csLen
-1] = val
;
2926 /* Search a Jim_Obj contained in 'script' with the same stinrg repr.
2927 * of objPtr. Search nested script objects recursively. */
2928 static Jim_Obj
*ScriptSearchLiteral(Jim_Interp
*interp
, ScriptObj
*script
,
2929 ScriptObj
*scriptBarrier
, Jim_Obj
*objPtr
)
2933 for (i
= 0; i
< script
->len
; i
++) {
2934 if (script
->token
[i
].objPtr
!= objPtr
&&
2935 Jim_StringEqObj(script
->token
[i
].objPtr
, objPtr
, 0)) {
2936 return script
->token
[i
].objPtr
;
2938 /* Enter recursively on scripts only if the object
2939 * is not the same as the one we are searching for
2940 * shared occurrences. */
2941 if (script
->token
[i
].objPtr
->typePtr
== &scriptObjType
&&
2942 script
->token
[i
].objPtr
!= objPtr
) {
2943 Jim_Obj
*foundObjPtr
;
2945 ScriptObj
*subScript
=
2946 script
->token
[i
].objPtr
->internalRep
.ptr
;
2947 /* Don't recursively enter the script we are trying
2948 * to make shared to avoid circular references. */
2949 if (subScript
== scriptBarrier
) continue;
2950 if (subScript
!= script
) {
2952 ScriptSearchLiteral(interp
, subScript
,
2953 scriptBarrier
, objPtr
);
2954 if (foundObjPtr
!= NULL
)
2962 /* Share literals of a script recursively sharing sub-scripts literals. */
2963 static void ScriptShareLiterals(Jim_Interp
*interp
, ScriptObj
*script
,
2964 ScriptObj
*topLevelScript
)
2969 /* Try to share with toplevel object. */
2970 if (topLevelScript
!= NULL
) {
2971 for (i
= 0; i
< script
->len
; i
++) {
2972 Jim_Obj
*foundObjPtr
;
2973 char *str
= script
->token
[i
].objPtr
->bytes
;
2975 if (script
->token
[i
].objPtr
->refCount
!= 1) continue;
2976 if (script
->token
[i
].objPtr
->typePtr
== &scriptObjType
) continue;
2977 if (strchr(str
, ' ') || strchr(str
, '\n')) continue;
2978 foundObjPtr
= ScriptSearchLiteral(interp
,
2980 script
, /* barrier */
2981 script
->token
[i
].objPtr
);
2982 if (foundObjPtr
!= NULL
) {
2983 Jim_IncrRefCount(foundObjPtr
);
2984 Jim_DecrRefCount(interp
,
2985 script
->token
[i
].objPtr
);
2986 script
->token
[i
].objPtr
= foundObjPtr
;
2990 /* Try to share locally */
2991 for (i
= 0; i
< script
->len
; i
++) {
2992 char *str
= script
->token
[i
].objPtr
->bytes
;
2994 if (script
->token
[i
].objPtr
->refCount
!= 1) continue;
2995 if (strchr(str
, ' ') || strchr(str
, '\n')) continue;
2996 for (j
= 0; j
< script
->len
; j
++) {
2997 if (script
->token
[i
].objPtr
!=
2998 script
->token
[j
].objPtr
&&
2999 Jim_StringEqObj(script
->token
[i
].objPtr
,
3000 script
->token
[j
].objPtr
, 0))
3002 Jim_IncrRefCount(script
->token
[j
].objPtr
);
3003 Jim_DecrRefCount(interp
,
3004 script
->token
[i
].objPtr
);
3005 script
->token
[i
].objPtr
=
3006 script
->token
[j
].objPtr
;
3012 /* This method takes the string representation of an object
3013 * as a Tcl script, and generates the pre-parsed internal representation
3015 int SetScriptFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
)
3018 const char *scriptText
= Jim_GetString(objPtr
, &scriptTextLen
);
3019 struct JimParserCtx parser
;
3020 struct ScriptObj
*script
= Jim_Alloc(sizeof(*script
));
3022 int args
, tokens
, start
, end
, i
;
3023 int initialLineNumber
;
3024 int propagateSourceInfo
= 0;
3028 script
->commands
= 0;
3029 script
->token
= NULL
;
3030 script
->cmdStruct
= NULL
;
3032 /* Try to get information about filename / line number */
3033 if (objPtr
->typePtr
== &sourceObjType
) {
3035 Jim_StrDup(objPtr
->internalRep
.sourceValue
.fileName
);
3036 initialLineNumber
= objPtr
->internalRep
.sourceValue
.lineNumber
;
3037 propagateSourceInfo
= 1;
3039 script
->fileName
= Jim_StrDup("");
3040 initialLineNumber
= 1;
3043 JimParserInit(&parser
, scriptText
, scriptTextLen
, initialLineNumber
);
3044 while(!JimParserEof(&parser
)) {
3046 int len
, type
, linenr
;
3048 JimParseScript(&parser
);
3049 token
= JimParserGetToken(&parser
, &len
, &type
, &linenr
);
3050 ScriptObjAddToken(interp
, script
, token
, len
, type
,
3051 propagateSourceInfo
? script
->fileName
: NULL
,
3054 token
= script
->token
;
3056 /* Compute the command structure array
3057 * (see the ScriptObj struct definition for more info) */
3058 start
= 0; /* Current command start token index */
3059 end
= -1; /* Current command end token index */
3061 int expand
= 0; /* expand flag. set to 1 on {expand} form. */
3062 int interpolation
= 0; /* set to 1 if there is at least one
3063 argument of the command obtained via
3064 interpolation of more tokens. */
3065 /* Search for the end of command, while
3066 * count the number of args. */
3068 if (start
>= script
->len
) break;
3069 args
= 1; /* Number of args in current command */
3070 while (token
[end
].type
!= JIM_TT_EOL
) {
3071 if (end
== 0 || token
[end
-1].type
== JIM_TT_SEP
||
3072 token
[end
-1].type
== JIM_TT_EOL
)
3074 if (token
[end
].type
== JIM_TT_STR
&&
3075 token
[end
+1].type
!= JIM_TT_SEP
&&
3076 token
[end
+1].type
!= JIM_TT_EOL
&&
3077 (!strcmp(token
[end
].objPtr
->bytes
, "expand") ||
3078 !strcmp(token
[end
].objPtr
->bytes
, "*")))
3081 if (token
[end
].type
== JIM_TT_SEP
)
3085 interpolation
= !((end
-start
+1) == args
*2);
3086 /* Add the 'number of arguments' info into cmdstruct.
3087 * Negative value if there is list expansion involved. */
3089 ScriptObjAddInt(script
, -1);
3090 ScriptObjAddInt(script
, args
);
3091 /* Now add info about the number of tokens. */
3092 tokens
= 0; /* Number of tokens in current argument. */
3094 for (i
= start
; i
<= end
; i
++) {
3095 if (token
[i
].type
== JIM_TT_SEP
||
3096 token
[i
].type
== JIM_TT_EOL
)
3098 if (tokens
== 1 && expand
)
3100 ScriptObjAddInt(script
,
3101 expand
? -tokens
: tokens
);
3106 } else if (tokens
== 0 && token
[i
].type
== JIM_TT_STR
&&
3107 (!strcmp(token
[i
].objPtr
->bytes
, "expand") ||
3108 !strcmp(token
[i
].objPtr
->bytes
, "*")))
3115 /* Perform literal sharing, but only for objects that appear
3116 * to be scripts written as literals inside the source code,
3117 * and not computed at runtime. Literal sharing is a costly
3118 * operation that should be done only against objects that
3119 * are likely to require compilation only the first time, and
3120 * then are executed multiple times. */
3121 if (propagateSourceInfo
&& interp
->framePtr
->procBodyObjPtr
) {
3122 Jim_Obj
*bodyObjPtr
= interp
->framePtr
->procBodyObjPtr
;
3123 if (bodyObjPtr
->typePtr
== &scriptObjType
) {
3124 ScriptObj
*bodyScript
=
3125 bodyObjPtr
->internalRep
.ptr
;
3126 ScriptShareLiterals(interp
, script
, bodyScript
);
3128 } else if (propagateSourceInfo
) {
3129 ScriptShareLiterals(interp
, script
, NULL
);
3131 /* Free the old internal rep and set the new one. */
3132 Jim_FreeIntRep(interp
, objPtr
);
3133 Jim_SetIntRepPtr(objPtr
, script
);
3134 objPtr
->typePtr
= &scriptObjType
;
3138 ScriptObj
*Jim_GetScript(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
3140 if (objPtr
->typePtr
!= &scriptObjType
) {
3141 SetScriptFromAny(interp
, objPtr
);
3143 return (ScriptObj
*) Jim_GetIntRepPtr(objPtr
);
3146 /* -----------------------------------------------------------------------------
3148 * ---------------------------------------------------------------------------*/
3150 /* Commands HashTable Type.
3152 * Keys are dynamic allocated strings, Values are Jim_Cmd structures. */
3153 static void Jim_CommandsHT_ValDestructor(void *interp
, void *val
)
3155 Jim_Cmd
*cmdPtr
= (void*) val
;
3157 if (cmdPtr
->cmdProc
== NULL
) {
3158 Jim_DecrRefCount(interp
, cmdPtr
->argListObjPtr
);
3159 Jim_DecrRefCount(interp
, cmdPtr
->bodyObjPtr
);
3160 if (cmdPtr
->staticVars
) {
3161 Jim_FreeHashTable(cmdPtr
->staticVars
);
3162 Jim_Free(cmdPtr
->staticVars
);
3164 } else if (cmdPtr
->delProc
!= NULL
) {
3165 /* If it was a C coded command, call the delProc if any */
3166 cmdPtr
->delProc(interp
, cmdPtr
->privData
);
3171 static Jim_HashTableType JimCommandsHashTableType
= {
3172 JimStringCopyHTHashFunction
, /* hash function */
3173 JimStringCopyHTKeyDup
, /* key dup */
3175 JimStringCopyHTKeyCompare
, /* key compare */
3176 JimStringCopyHTKeyDestructor
, /* key destructor */
3177 Jim_CommandsHT_ValDestructor
/* val destructor */
3180 /* ------------------------- Commands related functions --------------------- */
3182 int Jim_CreateCommand(Jim_Interp
*interp
, const char *cmdName
,
3183 Jim_CmdProc cmdProc
, void *privData
, Jim_DelCmdProc delProc
)
3188 he
= Jim_FindHashEntry(&interp
->commands
, cmdName
);
3189 if (he
== NULL
) { /* New command to create */
3190 cmdPtr
= Jim_Alloc(sizeof(*cmdPtr
));
3191 Jim_AddHashEntry(&interp
->commands
, cmdName
, cmdPtr
);
3193 Jim_InterpIncrProcEpoch(interp
);
3194 /* Free the arglist/body objects if it was a Tcl procedure */
3196 if (cmdPtr
->cmdProc
== NULL
) {
3197 Jim_DecrRefCount(interp
, cmdPtr
->argListObjPtr
);
3198 Jim_DecrRefCount(interp
, cmdPtr
->bodyObjPtr
);
3199 if (cmdPtr
->staticVars
) {
3200 Jim_FreeHashTable(cmdPtr
->staticVars
);
3201 Jim_Free(cmdPtr
->staticVars
);
3203 cmdPtr
->staticVars
= NULL
;
3204 } else if (cmdPtr
->delProc
!= NULL
) {
3205 /* If it was a C coded command, call the delProc if any */
3206 cmdPtr
->delProc(interp
, cmdPtr
->privData
);
3210 /* Store the new details for this proc */
3211 cmdPtr
->delProc
= delProc
;
3212 cmdPtr
->cmdProc
= cmdProc
;
3213 cmdPtr
->privData
= privData
;
3215 /* There is no need to increment the 'proc epoch' because
3216 * creation of a new procedure can never affect existing
3217 * cached commands. We don't do negative caching. */
3221 int Jim_CreateProcedure(Jim_Interp
*interp
, const char *cmdName
,
3222 Jim_Obj
*argListObjPtr
, Jim_Obj
*staticsListObjPtr
, Jim_Obj
*bodyObjPtr
,
3223 int arityMin
, int arityMax
)
3227 cmdPtr
= Jim_Alloc(sizeof(*cmdPtr
));
3228 cmdPtr
->cmdProc
= NULL
; /* Not a C coded command */
3229 cmdPtr
->argListObjPtr
= argListObjPtr
;
3230 cmdPtr
->bodyObjPtr
= bodyObjPtr
;
3231 Jim_IncrRefCount(argListObjPtr
);
3232 Jim_IncrRefCount(bodyObjPtr
);
3233 cmdPtr
->arityMin
= arityMin
;
3234 cmdPtr
->arityMax
= arityMax
;
3235 cmdPtr
->staticVars
= NULL
;
3237 /* Create the statics hash table. */
3238 if (staticsListObjPtr
) {
3241 Jim_ListLength(interp
, staticsListObjPtr
, &len
);
3243 cmdPtr
->staticVars
= Jim_Alloc(sizeof(Jim_HashTable
));
3244 Jim_InitHashTable(cmdPtr
->staticVars
, getJimVariablesHashTableType(),
3246 for (i
= 0; i
< len
; i
++) {
3247 Jim_Obj
*objPtr
, *initObjPtr
, *nameObjPtr
;
3251 Jim_ListIndex(interp
, staticsListObjPtr
, i
, &objPtr
, JIM_NONE
);
3252 /* Check if it's composed of two elements. */
3253 Jim_ListLength(interp
, objPtr
, &subLen
);
3254 if (subLen
== 1 || subLen
== 2) {
3255 /* Try to get the variable value from the current
3257 Jim_ListIndex(interp
, objPtr
, 0, &nameObjPtr
, JIM_NONE
);
3259 initObjPtr
= Jim_GetVariable(interp
, nameObjPtr
,
3261 if (initObjPtr
== NULL
) {
3262 Jim_SetResult(interp
,
3263 Jim_NewEmptyStringObj(interp
));
3264 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
3265 "variable for initialization of static \"",
3266 Jim_GetString(nameObjPtr
, NULL
),
3267 "\" not found in the local context",
3272 Jim_ListIndex(interp
, objPtr
, 1, &initObjPtr
, JIM_NONE
);
3274 varPtr
= Jim_Alloc(sizeof(*varPtr
));
3275 varPtr
->objPtr
= initObjPtr
;
3276 Jim_IncrRefCount(initObjPtr
);
3277 varPtr
->linkFramePtr
= NULL
;
3278 if (Jim_AddHashEntry(cmdPtr
->staticVars
,
3279 Jim_GetString(nameObjPtr
, NULL
),
3282 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
3283 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
3284 "static variable name \"",
3285 Jim_GetString(objPtr
, NULL
), "\"",
3286 " duplicated in statics list", NULL
);
3287 Jim_DecrRefCount(interp
, initObjPtr
);
3292 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
3293 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
3294 "too many fields in static specifier \"",
3295 objPtr
, "\"", NULL
);
3302 /* Add the new command */
3304 /* it may already exist, so we try to delete the old one */
3305 if (Jim_DeleteHashEntry(&interp
->commands
, cmdName
) != JIM_ERR
) {
3306 /* There was an old procedure with the same name, this requires
3307 * a 'proc epoch' update. */
3308 Jim_InterpIncrProcEpoch(interp
);
3310 /* If a procedure with the same name didn't existed there is no need
3311 * to increment the 'proc epoch' because creation of a new procedure
3312 * can never affect existing cached commands. We don't do
3313 * negative caching. */
3314 Jim_AddHashEntry(&interp
->commands
, cmdName
, cmdPtr
);
3318 Jim_FreeHashTable(cmdPtr
->staticVars
);
3319 Jim_Free(cmdPtr
->staticVars
);
3320 Jim_DecrRefCount(interp
, argListObjPtr
);
3321 Jim_DecrRefCount(interp
, bodyObjPtr
);
3326 int Jim_DeleteCommand(Jim_Interp
*interp
, const char *cmdName
)
3328 if (Jim_DeleteHashEntry(&interp
->commands
, cmdName
) == JIM_ERR
)
3330 Jim_InterpIncrProcEpoch(interp
);
3334 int Jim_RenameCommand(Jim_Interp
*interp
, const char *oldName
,
3335 const char *newName
)
3339 Jim_Cmd
*copyCmdPtr
;
3341 if (newName
[0] == '\0') /* Delete! */
3342 return Jim_DeleteCommand(interp
, oldName
);
3344 he
= Jim_FindHashEntry(&interp
->commands
, oldName
);
3346 return JIM_ERR
; /* Invalid command name */
3348 copyCmdPtr
= Jim_Alloc(sizeof(Jim_Cmd
));
3349 *copyCmdPtr
= *cmdPtr
;
3350 /* In order to avoid that a procedure will get arglist/body/statics
3351 * freed by the hash table methods, fake a C-coded command
3352 * setting cmdPtr->cmdProc as not NULL */
3353 cmdPtr
->cmdProc
= (void*)1;
3354 /* Also make sure delProc is NULL. */
3355 cmdPtr
->delProc
= NULL
;
3356 /* Destroy the old command, and make sure the new is freed
3358 Jim_DeleteHashEntry(&interp
->commands
, oldName
);
3359 Jim_DeleteHashEntry(&interp
->commands
, newName
);
3360 /* Now the new command. We are sure it can't fail because
3361 * the target name was already freed. */
3362 Jim_AddHashEntry(&interp
->commands
, newName
, copyCmdPtr
);
3363 /* Increment the epoch */
3364 Jim_InterpIncrProcEpoch(interp
);
3368 /* -----------------------------------------------------------------------------
3370 * ---------------------------------------------------------------------------*/
3372 static int SetCommandFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
);
3374 static Jim_ObjType commandObjType
= {
3379 JIM_TYPE_REFERENCES
,
3382 int SetCommandFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
3385 const char *cmdName
;
3387 /* Get the string representation */
3388 cmdName
= Jim_GetString(objPtr
, NULL
);
3389 /* Lookup this name into the commands hash table */
3390 he
= Jim_FindHashEntry(&interp
->commands
, cmdName
);
3394 /* Free the old internal repr and set the new one. */
3395 Jim_FreeIntRep(interp
, objPtr
);
3396 objPtr
->typePtr
= &commandObjType
;
3397 objPtr
->internalRep
.cmdValue
.procEpoch
= interp
->procEpoch
;
3398 objPtr
->internalRep
.cmdValue
.cmdPtr
= (void*)he
->val
;
3402 /* This function returns the command structure for the command name
3403 * stored in objPtr. It tries to specialize the objPtr to contain
3404 * a cached info instead to perform the lookup into the hash table
3405 * every time. The information cached may not be uptodate, in such
3406 * a case the lookup is performed and the cache updated. */
3407 Jim_Cmd
*Jim_GetCommand(Jim_Interp
*interp
, Jim_Obj
*objPtr
, int flags
)
3409 if ((objPtr
->typePtr
!= &commandObjType
||
3410 objPtr
->internalRep
.cmdValue
.procEpoch
!= interp
->procEpoch
) &&
3411 SetCommandFromAny(interp
, objPtr
) == JIM_ERR
) {
3412 if (flags
& JIM_ERRMSG
) {
3413 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
3414 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
3415 "invalid command name \"", objPtr
->bytes
, "\"",
3420 return objPtr
->internalRep
.cmdValue
.cmdPtr
;
3423 /* -----------------------------------------------------------------------------
3425 * ---------------------------------------------------------------------------*/
3427 /* Variables HashTable Type.
3429 * Keys are dynamic allocated strings, Values are Jim_Var structures. */
3430 static void JimVariablesHTValDestructor(void *interp
, void *val
)
3432 Jim_Var
*varPtr
= (void*) val
;
3434 Jim_DecrRefCount(interp
, varPtr
->objPtr
);
3438 static Jim_HashTableType JimVariablesHashTableType
= {
3439 JimStringCopyHTHashFunction
, /* hash function */
3440 JimStringCopyHTKeyDup
, /* key dup */
3442 JimStringCopyHTKeyCompare
, /* key compare */
3443 JimStringCopyHTKeyDestructor
, /* key destructor */
3444 JimVariablesHTValDestructor
/* val destructor */
3447 static Jim_HashTableType
*getJimVariablesHashTableType(void)
3449 return &JimVariablesHashTableType
;
3452 /* -----------------------------------------------------------------------------
3454 * ---------------------------------------------------------------------------*/
3456 #define JIM_DICT_SUGAR 100 /* Only returned by SetVariableFromAny() */
3458 static int SetVariableFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
);
3460 static Jim_ObjType variableObjType
= {
3465 JIM_TYPE_REFERENCES
,
3468 /* Return true if the string "str" looks like syntax sugar for [dict]. I.e.
3469 * is in the form "varname(key)". */
3470 static int Jim_NameIsDictSugar(const char *str
, int len
)
3474 if (len
&& str
[len
-1] == ')' && strchr(str
, '(') != NULL
)
3479 /* This method should be called only by the variable API.
3480 * It returns JIM_OK on success (variable already exists),
3481 * JIM_ERR if it does not exists, JIM_DICT_GLUE if it's not
3482 * a variable name, but syntax glue for [dict] i.e. the last
3483 * character is ')' */
3484 int SetVariableFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
)
3487 const char *varName
;
3490 /* Check if the object is already an uptodate variable */
3491 if (objPtr
->typePtr
== &variableObjType
&&
3492 objPtr
->internalRep
.varValue
.callFrameId
== interp
->framePtr
->id
)
3493 return JIM_OK
; /* nothing to do */
3494 /* Get the string representation */
3495 varName
= Jim_GetString(objPtr
, &len
);
3496 /* Make sure it's not syntax glue to get/set dict. */
3497 if (Jim_NameIsDictSugar(varName
, len
))
3498 return JIM_DICT_SUGAR
;
3499 if (varName
[0] == ':' && varName
[1] == ':') {
3500 he
= Jim_FindHashEntry(&interp
->topFramePtr
->vars
, varName
+ 2);
3506 /* Lookup this name into the variables hash table */
3507 he
= Jim_FindHashEntry(&interp
->framePtr
->vars
, varName
);
3509 /* Try with static vars. */
3510 if (interp
->framePtr
->staticVars
== NULL
)
3512 if (!(he
= Jim_FindHashEntry(interp
->framePtr
->staticVars
, varName
)))
3516 /* Free the old internal repr and set the new one. */
3517 Jim_FreeIntRep(interp
, objPtr
);
3518 objPtr
->typePtr
= &variableObjType
;
3519 objPtr
->internalRep
.varValue
.callFrameId
= interp
->framePtr
->id
;
3520 objPtr
->internalRep
.varValue
.varPtr
= (void*)he
->val
;
3524 /* -------------------- Variables related functions ------------------------- */
3525 static int JimDictSugarSet(Jim_Interp
*interp
, Jim_Obj
*ObjPtr
,
3526 Jim_Obj
*valObjPtr
);
3527 static Jim_Obj
*JimDictSugarGet(Jim_Interp
*interp
, Jim_Obj
*ObjPtr
);
3529 /* For now that's dummy. Variables lookup should be optimized
3530 * in many ways, with caching of lookups, and possibly with
3531 * a table of pre-allocated vars in every CallFrame for local vars.
3532 * All the caching should also have an 'epoch' mechanism similar
3533 * to the one used by Tcl for procedures lookup caching. */
3535 int Jim_SetVariable(Jim_Interp
*interp
, Jim_Obj
*nameObjPtr
, Jim_Obj
*valObjPtr
)
3541 if ((err
= SetVariableFromAny(interp
, nameObjPtr
)) != JIM_OK
) {
3542 /* Check for [dict] syntax sugar. */
3543 if (err
== JIM_DICT_SUGAR
)
3544 return JimDictSugarSet(interp
, nameObjPtr
, valObjPtr
);
3545 /* New variable to create */
3546 name
= Jim_GetString(nameObjPtr
, NULL
);
3548 var
= Jim_Alloc(sizeof(*var
));
3549 var
->objPtr
= valObjPtr
;
3550 Jim_IncrRefCount(valObjPtr
);
3551 var
->linkFramePtr
= NULL
;
3552 /* Insert the new variable */
3553 if (name
[0] == ':' && name
[1] == ':') {
3554 /* Into to the top evel frame */
3555 Jim_AddHashEntry(&interp
->topFramePtr
->vars
, name
+ 2, var
);
3558 Jim_AddHashEntry(&interp
->framePtr
->vars
, name
, var
);
3560 /* Make the object int rep a variable */
3561 Jim_FreeIntRep(interp
, nameObjPtr
);
3562 nameObjPtr
->typePtr
= &variableObjType
;
3563 nameObjPtr
->internalRep
.varValue
.callFrameId
=
3564 interp
->framePtr
->id
;
3565 nameObjPtr
->internalRep
.varValue
.varPtr
= var
;
3567 var
= nameObjPtr
->internalRep
.varValue
.varPtr
;
3568 if (var
->linkFramePtr
== NULL
) {
3569 Jim_IncrRefCount(valObjPtr
);
3570 Jim_DecrRefCount(interp
, var
->objPtr
);
3571 var
->objPtr
= valObjPtr
;
3572 } else { /* Else handle the link */
3573 Jim_CallFrame
*savedCallFrame
;
3575 savedCallFrame
= interp
->framePtr
;
3576 interp
->framePtr
= var
->linkFramePtr
;
3577 err
= Jim_SetVariable(interp
, var
->objPtr
, valObjPtr
);
3578 interp
->framePtr
= savedCallFrame
;
3586 int Jim_SetVariableStr(Jim_Interp
*interp
, const char *name
, Jim_Obj
*objPtr
)
3588 Jim_Obj
*nameObjPtr
;
3591 nameObjPtr
= Jim_NewStringObj(interp
, name
, -1);
3592 Jim_IncrRefCount(nameObjPtr
);
3593 result
= Jim_SetVariable(interp
, nameObjPtr
, objPtr
);
3594 Jim_DecrRefCount(interp
, nameObjPtr
);
3598 int Jim_SetGlobalVariableStr(Jim_Interp
*interp
, const char *name
, Jim_Obj
*objPtr
)
3600 Jim_CallFrame
*savedFramePtr
;
3603 savedFramePtr
= interp
->framePtr
;
3604 interp
->framePtr
= interp
->topFramePtr
;
3605 result
= Jim_SetVariableStr(interp
, name
, objPtr
);
3606 interp
->framePtr
= savedFramePtr
;
3610 int Jim_SetVariableStrWithStr(Jim_Interp
*interp
, const char *name
, const char *val
)
3612 Jim_Obj
*nameObjPtr
, *valObjPtr
;
3615 nameObjPtr
= Jim_NewStringObj(interp
, name
, -1);
3616 valObjPtr
= Jim_NewStringObj(interp
, val
, -1);
3617 Jim_IncrRefCount(nameObjPtr
);
3618 Jim_IncrRefCount(valObjPtr
);
3619 result
= Jim_SetVariable(interp
, nameObjPtr
, valObjPtr
);
3620 Jim_DecrRefCount(interp
, nameObjPtr
);
3621 Jim_DecrRefCount(interp
, valObjPtr
);
3625 int Jim_SetVariableLink(Jim_Interp
*interp
, Jim_Obj
*nameObjPtr
,
3626 Jim_Obj
*targetNameObjPtr
, Jim_CallFrame
*targetCallFrame
)
3628 const char *varName
;
3631 /* Check for cycles. */
3632 if (interp
->framePtr
== targetCallFrame
) {
3633 Jim_Obj
*objPtr
= targetNameObjPtr
;
3635 /* Cycles are only possible with 'uplevel 0' */
3637 if (Jim_StringEqObj(objPtr
, nameObjPtr
, 0)) {
3638 Jim_SetResultString(interp
,
3639 "can't upvar from variable to itself", -1);
3642 if (SetVariableFromAny(interp
, objPtr
) != JIM_OK
)
3644 varPtr
= objPtr
->internalRep
.varValue
.varPtr
;
3645 if (varPtr
->linkFramePtr
!= targetCallFrame
) break;
3646 objPtr
= varPtr
->objPtr
;
3649 varName
= Jim_GetString(nameObjPtr
, &len
);
3650 if (Jim_NameIsDictSugar(varName
, len
)) {
3651 Jim_SetResultString(interp
,
3652 "Dict key syntax invalid as link source", -1);
3655 /* Perform the binding */
3656 Jim_SetVariable(interp
, nameObjPtr
, targetNameObjPtr
);
3657 /* We are now sure 'nameObjPtr' type is variableObjType */
3658 nameObjPtr
->internalRep
.varValue
.varPtr
->linkFramePtr
= targetCallFrame
;
3662 /* Return the Jim_Obj pointer associated with a variable name,
3663 * or NULL if the variable was not found in the current context.
3664 * The same optimization discussed in the comment to the
3665 * 'SetVariable' function should apply here. */
3666 Jim_Obj
*Jim_GetVariable(Jim_Interp
*interp
, Jim_Obj
*nameObjPtr
, int flags
)
3670 /* All the rest is handled here */
3671 if ((err
= SetVariableFromAny(interp
, nameObjPtr
)) != JIM_OK
) {
3672 /* Check for [dict] syntax sugar. */
3673 if (err
== JIM_DICT_SUGAR
)
3674 return JimDictSugarGet(interp
, nameObjPtr
);
3675 if (flags
& JIM_ERRMSG
) {
3676 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
3677 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
3678 "can't read \"", nameObjPtr
->bytes
,
3679 "\": no such variable", NULL
);
3685 Jim_CallFrame
*savedCallFrame
;
3687 varPtr
= nameObjPtr
->internalRep
.varValue
.varPtr
;
3688 if (varPtr
->linkFramePtr
== NULL
)
3689 return varPtr
->objPtr
;
3690 /* The variable is a link? Resolve it. */
3691 savedCallFrame
= interp
->framePtr
;
3692 interp
->framePtr
= varPtr
->linkFramePtr
;
3693 objPtr
= Jim_GetVariable(interp
, varPtr
->objPtr
, JIM_NONE
);
3694 if (objPtr
== NULL
&& flags
& JIM_ERRMSG
) {
3695 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
3696 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
3697 "can't read \"", nameObjPtr
->bytes
,
3698 "\": no such variable", NULL
);
3700 interp
->framePtr
= savedCallFrame
;
3705 Jim_Obj
*Jim_GetGlobalVariable(Jim_Interp
*interp
, Jim_Obj
*nameObjPtr
,
3708 Jim_CallFrame
*savedFramePtr
;
3711 savedFramePtr
= interp
->framePtr
;
3712 interp
->framePtr
= interp
->topFramePtr
;
3713 objPtr
= Jim_GetVariable(interp
, nameObjPtr
, flags
);
3714 interp
->framePtr
= savedFramePtr
;
3719 Jim_Obj
*Jim_GetVariableStr(Jim_Interp
*interp
, const char *name
, int flags
)
3721 Jim_Obj
*nameObjPtr
, *varObjPtr
;
3723 nameObjPtr
= Jim_NewStringObj(interp
, name
, -1);
3724 Jim_IncrRefCount(nameObjPtr
);
3725 varObjPtr
= Jim_GetVariable(interp
, nameObjPtr
, flags
);
3726 Jim_DecrRefCount(interp
, nameObjPtr
);
3730 Jim_Obj
*Jim_GetGlobalVariableStr(Jim_Interp
*interp
, const char *name
,
3733 Jim_CallFrame
*savedFramePtr
;
3736 savedFramePtr
= interp
->framePtr
;
3737 interp
->framePtr
= interp
->topFramePtr
;
3738 objPtr
= Jim_GetVariableStr(interp
, name
, flags
);
3739 interp
->framePtr
= savedFramePtr
;
3744 /* Unset a variable.
3745 * Note: On success unset invalidates all the variable objects created
3746 * in the current call frame incrementing. */
3747 int Jim_UnsetVariable(Jim_Interp
*interp
, Jim_Obj
*nameObjPtr
, int flags
)
3753 if ((err
= SetVariableFromAny(interp
, nameObjPtr
)) != JIM_OK
) {
3754 /* Check for [dict] syntax sugar. */
3755 if (err
== JIM_DICT_SUGAR
)
3756 return JimDictSugarSet(interp
, nameObjPtr
, NULL
);
3757 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
3758 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
3759 "can't unset \"", nameObjPtr
->bytes
,
3760 "\": no such variable", NULL
);
3761 return JIM_ERR
; /* var not found */
3763 varPtr
= nameObjPtr
->internalRep
.varValue
.varPtr
;
3764 /* If it's a link call UnsetVariable recursively */
3765 if (varPtr
->linkFramePtr
) {
3768 Jim_CallFrame
*savedCallFrame
;
3770 savedCallFrame
= interp
->framePtr
;
3771 interp
->framePtr
= varPtr
->linkFramePtr
;
3772 retval
= Jim_UnsetVariable(interp
, varPtr
->objPtr
, JIM_NONE
);
3773 interp
->framePtr
= savedCallFrame
;
3774 if (retval
!= JIM_OK
&& flags
& JIM_ERRMSG
) {
3775 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
3776 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
3777 "can't unset \"", nameObjPtr
->bytes
,
3778 "\": no such variable", NULL
);
3782 name
= Jim_GetString(nameObjPtr
, NULL
);
3783 if (Jim_DeleteHashEntry(&interp
->framePtr
->vars
, name
)
3784 != JIM_OK
) return JIM_ERR
;
3785 /* Change the callframe id, invalidating var lookup caching */
3786 JimChangeCallFrameId(interp
, interp
->framePtr
);
3791 /* ---------- Dict syntax sugar (similar to array Tcl syntax) -------------- */
3793 /* Given a variable name for [dict] operation syntax sugar,
3794 * this function returns two objects, the first with the name
3795 * of the variable to set, and the second with the rispective key.
3796 * For example "foo(bar)" will return objects with string repr. of
3799 * The returned objects have refcount = 1. The function can't fail. */
3800 static void JimDictSugarParseVarKey(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
3801 Jim_Obj
**varPtrPtr
, Jim_Obj
**keyPtrPtr
)
3803 const char *str
, *p
;
3805 int len
, keyLen
, nameLen
;
3806 Jim_Obj
*varObjPtr
, *keyObjPtr
;
3808 str
= Jim_GetString(objPtr
, &len
);
3809 p
= strchr(str
, '(');
3811 keyLen
= len
-((p
-str
)+1);
3812 nameLen
= (p
-str
)-1;
3813 /* Create the objects with the variable name and key. */
3814 t
= Jim_Alloc(nameLen
+1);
3815 memcpy(t
, str
, nameLen
);
3817 varObjPtr
= Jim_NewStringObjNoAlloc(interp
, t
, nameLen
);
3819 t
= Jim_Alloc(keyLen
+1);
3820 memcpy(t
, p
, keyLen
);
3822 keyObjPtr
= Jim_NewStringObjNoAlloc(interp
, t
, keyLen
);
3824 Jim_IncrRefCount(varObjPtr
);
3825 Jim_IncrRefCount(keyObjPtr
);
3826 *varPtrPtr
= varObjPtr
;
3827 *keyPtrPtr
= keyObjPtr
;
3830 /* Helper of Jim_SetVariable() to deal with dict-syntax variable names.
3831 * Also used by Jim_UnsetVariable() with valObjPtr = NULL. */
3832 static int JimDictSugarSet(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
3835 Jim_Obj
*varObjPtr
, *keyObjPtr
;
3838 JimDictSugarParseVarKey(interp
, objPtr
, &varObjPtr
, &keyObjPtr
);
3839 err
= Jim_SetDictKeysVector(interp
, varObjPtr
, &keyObjPtr
, 1,
3841 Jim_DecrRefCount(interp
, varObjPtr
);
3842 Jim_DecrRefCount(interp
, keyObjPtr
);
3846 /* Helper of Jim_GetVariable() to deal with dict-syntax variable names */
3847 static Jim_Obj
*JimDictSugarGet(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
3849 Jim_Obj
*varObjPtr
, *keyObjPtr
, *dictObjPtr
, *resObjPtr
;
3851 JimDictSugarParseVarKey(interp
, objPtr
, &varObjPtr
, &keyObjPtr
);
3852 dictObjPtr
= Jim_GetVariable(interp
, varObjPtr
, JIM_ERRMSG
);
3857 if (Jim_DictKey(interp
, dictObjPtr
, keyObjPtr
, &resObjPtr
, JIM_ERRMSG
)
3862 Jim_DecrRefCount(interp
, varObjPtr
);
3863 Jim_DecrRefCount(interp
, keyObjPtr
);
3867 /* --------- $var(INDEX) substitution, using a specialized object ----------- */
3869 static void FreeDictSubstInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
3870 static void DupDictSubstInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
,
3873 static Jim_ObjType dictSubstObjType
= {
3874 "dict-substitution",
3875 FreeDictSubstInternalRep
,
3876 DupDictSubstInternalRep
,
3881 void FreeDictSubstInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
3883 Jim_DecrRefCount(interp
, objPtr
->internalRep
.dictSubstValue
.varNameObjPtr
);
3884 Jim_DecrRefCount(interp
, objPtr
->internalRep
.dictSubstValue
.indexObjPtr
);
3887 void DupDictSubstInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
,
3890 JIM_NOTUSED(interp
);
3892 dupPtr
->internalRep
.dictSubstValue
.varNameObjPtr
=
3893 srcPtr
->internalRep
.dictSubstValue
.varNameObjPtr
;
3894 dupPtr
->internalRep
.dictSubstValue
.indexObjPtr
=
3895 srcPtr
->internalRep
.dictSubstValue
.indexObjPtr
;
3896 dupPtr
->typePtr
= &dictSubstObjType
;
3899 /* This function is used to expand [dict get] sugar in the form
3900 * of $var(INDEX). The function is mainly used by Jim_EvalObj()
3901 * to deal with tokens of type JIM_TT_DICTSUGAR. objPtr points to an
3902 * object that is *guaranteed* to be in the form VARNAME(INDEX).
3903 * The 'index' part is [subst]ituted, and is used to lookup a key inside
3904 * the [dict]ionary contained in variable VARNAME. */
3905 Jim_Obj
*Jim_ExpandDictSugar(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
3907 Jim_Obj
*varObjPtr
, *keyObjPtr
, *dictObjPtr
, *resObjPtr
;
3908 Jim_Obj
*substKeyObjPtr
= NULL
;
3910 if (objPtr
->typePtr
!= &dictSubstObjType
) {
3911 JimDictSugarParseVarKey(interp
, objPtr
, &varObjPtr
, &keyObjPtr
);
3912 Jim_FreeIntRep(interp
, objPtr
);
3913 objPtr
->typePtr
= &dictSubstObjType
;
3914 objPtr
->internalRep
.dictSubstValue
.varNameObjPtr
= varObjPtr
;
3915 objPtr
->internalRep
.dictSubstValue
.indexObjPtr
= keyObjPtr
;
3917 if (Jim_SubstObj(interp
, objPtr
->internalRep
.dictSubstValue
.indexObjPtr
,
3918 &substKeyObjPtr
, JIM_NONE
)
3920 substKeyObjPtr
= NULL
;
3923 Jim_IncrRefCount(substKeyObjPtr
);
3924 dictObjPtr
= Jim_GetVariable(interp
,
3925 objPtr
->internalRep
.dictSubstValue
.varNameObjPtr
, JIM_ERRMSG
);
3930 if (Jim_DictKey(interp
, dictObjPtr
, substKeyObjPtr
, &resObjPtr
, JIM_ERRMSG
)
3936 if (substKeyObjPtr
) Jim_DecrRefCount(interp
, substKeyObjPtr
);
3940 /* -----------------------------------------------------------------------------
3942 * ---------------------------------------------------------------------------*/
3944 static Jim_CallFrame
*JimCreateCallFrame(Jim_Interp
*interp
)
3947 if (interp
->freeFramesList
) {
3948 cf
= interp
->freeFramesList
;
3949 interp
->freeFramesList
= cf
->nextFramePtr
;
3951 cf
= Jim_Alloc(sizeof(*cf
));
3952 cf
->vars
.table
= NULL
;
3955 cf
->id
= interp
->callFrameEpoch
++;
3956 cf
->parentCallFrame
= NULL
;
3959 cf
->procArgsObjPtr
= NULL
;
3960 cf
->procBodyObjPtr
= NULL
;
3961 cf
->nextFramePtr
= NULL
;
3962 cf
->staticVars
= NULL
;
3963 if (cf
->vars
.table
== NULL
)
3964 Jim_InitHashTable(&cf
->vars
, &JimVariablesHashTableType
, interp
);
3968 /* Used to invalidate every caching related to callframe stability. */
3969 static void JimChangeCallFrameId(Jim_Interp
*interp
, Jim_CallFrame
*cf
)
3971 cf
->id
= interp
->callFrameEpoch
++;
3974 #define JIM_FCF_NONE 0 /* no flags */
3975 #define JIM_FCF_NOHT 1 /* don't free the hash table */
3976 static void JimFreeCallFrame(Jim_Interp
*interp
, Jim_CallFrame
*cf
,
3979 if (cf
->procArgsObjPtr
) Jim_DecrRefCount(interp
, cf
->procArgsObjPtr
);
3980 if (cf
->procBodyObjPtr
) Jim_DecrRefCount(interp
, cf
->procBodyObjPtr
);
3981 if (!(flags
& JIM_FCF_NOHT
))
3982 Jim_FreeHashTable(&cf
->vars
);
3985 Jim_HashEntry
**table
= cf
->vars
.table
, *he
;
3987 for (i
= 0; i
< JIM_HT_INITIAL_SIZE
; i
++) {
3989 while (he
!= NULL
) {
3990 Jim_HashEntry
*nextEntry
= he
->next
;
3991 Jim_Var
*varPtr
= (void*) he
->val
;
3993 Jim_DecrRefCount(interp
, varPtr
->objPtr
);
3995 Jim_Free((void*)he
->key
); /* ATTENTION: const cast */
4003 cf
->nextFramePtr
= interp
->freeFramesList
;
4004 interp
->freeFramesList
= cf
;
4007 /* -----------------------------------------------------------------------------
4009 * ---------------------------------------------------------------------------*/
4011 /* References HashTable Type.
4013 * Keys are jim_wide integers, dynamically allocated for now but in the
4014 * future it's worth to cache this 8 bytes objects. Values are poitners
4015 * to Jim_References. */
4016 static void JimReferencesHTValDestructor(void *interp
, void *val
)
4018 Jim_Reference
*refPtr
= (void*) val
;
4020 Jim_DecrRefCount(interp
, refPtr
->objPtr
);
4021 if (refPtr
->finalizerCmdNamePtr
!= NULL
) {
4022 Jim_DecrRefCount(interp
, refPtr
->finalizerCmdNamePtr
);
4027 unsigned int JimReferencesHTHashFunction(const void *key
)
4029 /* Only the least significant bits are used. */
4030 const jim_wide
*widePtr
= key
;
4031 unsigned int intValue
= (unsigned int) *widePtr
;
4032 return Jim_IntHashFunction(intValue
);
4035 unsigned int JimReferencesHTDoubleHashFunction(const void *key
)
4037 /* Only the least significant bits are used. */
4038 const jim_wide
*widePtr
= key
;
4039 unsigned int intValue
= (unsigned int) *widePtr
;
4040 return intValue
; /* identity function. */
4043 const void *JimReferencesHTKeyDup(void *privdata
, const void *key
)
4045 void *copy
= Jim_Alloc(sizeof(jim_wide
));
4046 JIM_NOTUSED(privdata
);
4048 memcpy(copy
, key
, sizeof(jim_wide
));
4052 int JimReferencesHTKeyCompare(void *privdata
, const void *key1
,
4055 JIM_NOTUSED(privdata
);
4057 return memcmp(key1
, key2
, sizeof(jim_wide
)) == 0;
4060 void JimReferencesHTKeyDestructor(void *privdata
, const void *key
)
4062 JIM_NOTUSED(privdata
);
4064 Jim_Free((void*)key
);
4067 static Jim_HashTableType JimReferencesHashTableType
= {
4068 JimReferencesHTHashFunction
, /* hash function */
4069 JimReferencesHTKeyDup
, /* key dup */
4071 JimReferencesHTKeyCompare
, /* key compare */
4072 JimReferencesHTKeyDestructor
, /* key destructor */
4073 JimReferencesHTValDestructor
/* val destructor */
4076 /* -----------------------------------------------------------------------------
4077 * Reference object type and References API
4078 * ---------------------------------------------------------------------------*/
4080 static void UpdateStringOfReference(struct Jim_Obj
*objPtr
);
4082 static Jim_ObjType referenceObjType
= {
4086 UpdateStringOfReference
,
4087 JIM_TYPE_REFERENCES
,
4090 void UpdateStringOfReference(struct Jim_Obj
*objPtr
)
4093 char buf
[JIM_REFERENCE_SPACE
+1];
4094 Jim_Reference
*refPtr
;
4096 refPtr
= objPtr
->internalRep
.refValue
.refPtr
;
4097 len
= JimFormatReference(buf
, refPtr
, objPtr
->internalRep
.refValue
.id
);
4098 objPtr
->bytes
= Jim_Alloc(len
+1);
4099 memcpy(objPtr
->bytes
, buf
, len
+1);
4100 objPtr
->length
= len
;
4103 /* returns true if 'c' is a valid reference tag character.
4104 * i.e. inside the range [_a-zA-Z0-9] */
4105 static int isrefchar(int c
)
4107 if (c
== '_' || (c
>= 'a' && c
<= 'z') || (c
>= 'A' && c
<= 'Z') ||
4108 (c
>= '0' && c
<= '9')) return 1;
4112 int SetReferenceFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
4116 const char *str
, *start
, *end
;
4118 Jim_Reference
*refPtr
;
4121 /* Get the string representation */
4122 str
= Jim_GetString(objPtr
, &len
);
4123 /* Check if it looks like a reference */
4124 if (len
< JIM_REFERENCE_SPACE
) goto badformat
;
4128 while (*start
== ' ') start
++;
4129 while (*end
== ' ' && end
> start
) end
--;
4130 if (end
-start
+1 != JIM_REFERENCE_SPACE
) goto badformat
;
4131 /* <reference.<1234567>.%020> */
4132 if (memcmp(start
, "<reference.<", 12) != 0) goto badformat
;
4133 if (start
[12+JIM_REFERENCE_TAGLEN
] != '>' || end
[0] != '>') goto badformat
;
4134 /* The tag can't contain chars other than a-zA-Z0-9 + '_'. */
4135 for (i
= 0; i
< JIM_REFERENCE_TAGLEN
; i
++) {
4136 if (!isrefchar(start
[12+i
])) goto badformat
;
4138 /* Extract info from the refernece. */
4139 memcpy(refId
, start
+14+JIM_REFERENCE_TAGLEN
, 20);
4141 /* Try to convert the ID into a jim_wide */
4142 if (Jim_StringToWide(refId
, &wideValue
, 10) != JIM_OK
) goto badformat
;
4143 /* Check if the reference really exists! */
4144 he
= Jim_FindHashEntry(&interp
->references
, &wideValue
);
4146 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4147 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4148 "Invalid reference ID \"", str
, "\"", NULL
);
4152 /* Free the old internal repr and set the new one. */
4153 Jim_FreeIntRep(interp
, objPtr
);
4154 objPtr
->typePtr
= &referenceObjType
;
4155 objPtr
->internalRep
.refValue
.id
= wideValue
;
4156 objPtr
->internalRep
.refValue
.refPtr
= refPtr
;
4160 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4161 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4162 "expected reference but got \"", str
, "\"", NULL
);
4166 /* Returns a new reference pointing to objPtr, having cmdNamePtr
4167 * as finalizer command (or NULL if there is no finalizer).
4168 * The returned reference object has refcount = 0. */
4169 Jim_Obj
*Jim_NewReference(Jim_Interp
*interp
, Jim_Obj
*objPtr
, Jim_Obj
*tagPtr
,
4170 Jim_Obj
*cmdNamePtr
)
4172 struct Jim_Reference
*refPtr
;
4173 jim_wide wideValue
= interp
->referenceNextId
;
4178 /* Perform the Garbage Collection if needed. */
4179 Jim_CollectIfNeeded(interp
);
4181 refPtr
= Jim_Alloc(sizeof(*refPtr
));
4182 refPtr
->objPtr
= objPtr
;
4183 Jim_IncrRefCount(objPtr
);
4184 refPtr
->finalizerCmdNamePtr
= cmdNamePtr
;
4186 Jim_IncrRefCount(cmdNamePtr
);
4187 Jim_AddHashEntry(&interp
->references
, &wideValue
, refPtr
);
4188 refObjPtr
= Jim_NewObj(interp
);
4189 refObjPtr
->typePtr
= &referenceObjType
;
4190 refObjPtr
->bytes
= NULL
;
4191 refObjPtr
->internalRep
.refValue
.id
= interp
->referenceNextId
;
4192 refObjPtr
->internalRep
.refValue
.refPtr
= refPtr
;
4193 interp
->referenceNextId
++;
4194 /* Set the tag. Trimmered at JIM_REFERENCE_TAGLEN. Everything
4195 * that does not pass the 'isrefchar' test is replaced with '_' */
4196 tag
= Jim_GetString(tagPtr
, &tagLen
);
4197 if (tagLen
> JIM_REFERENCE_TAGLEN
)
4198 tagLen
= JIM_REFERENCE_TAGLEN
;
4199 for (i
= 0; i
< JIM_REFERENCE_TAGLEN
; i
++) {
4201 refPtr
->tag
[i
] = tag
[i
];
4203 refPtr
->tag
[i
] = '_';
4205 refPtr
->tag
[JIM_REFERENCE_TAGLEN
] = '\0';
4209 Jim_Reference
*Jim_GetReference(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
4211 if (objPtr
->typePtr
!= &referenceObjType
&&
4212 SetReferenceFromAny(interp
, objPtr
) == JIM_ERR
)
4214 return objPtr
->internalRep
.refValue
.refPtr
;
4217 int Jim_SetFinalizer(Jim_Interp
*interp
, Jim_Obj
*objPtr
, Jim_Obj
*cmdNamePtr
)
4219 Jim_Reference
*refPtr
;
4221 if ((refPtr
= Jim_GetReference(interp
, objPtr
)) == NULL
)
4223 Jim_IncrRefCount(cmdNamePtr
);
4224 if (refPtr
->finalizerCmdNamePtr
)
4225 Jim_DecrRefCount(interp
, refPtr
->finalizerCmdNamePtr
);
4226 refPtr
->finalizerCmdNamePtr
= cmdNamePtr
;
4230 int Jim_GetFinalizer(Jim_Interp
*interp
, Jim_Obj
*objPtr
, Jim_Obj
**cmdNamePtrPtr
)
4232 Jim_Reference
*refPtr
;
4234 if ((refPtr
= Jim_GetReference(interp
, objPtr
)) == NULL
)
4236 *cmdNamePtrPtr
= refPtr
->finalizerCmdNamePtr
;
4240 /* -----------------------------------------------------------------------------
4241 * References Garbage Collection
4242 * ---------------------------------------------------------------------------*/
4244 /* This the hash table type for the "MARK" phase of the GC */
4245 static Jim_HashTableType JimRefMarkHashTableType
= {
4246 JimReferencesHTHashFunction
, /* hash function */
4247 JimReferencesHTKeyDup
, /* key dup */
4249 JimReferencesHTKeyCompare
, /* key compare */
4250 JimReferencesHTKeyDestructor
, /* key destructor */
4251 NULL
/* val destructor */
4254 /* #define JIM_DEBUG_GC 1 */
4256 /* Performs the garbage collection. */
4257 int Jim_Collect(Jim_Interp
*interp
)
4259 Jim_HashTable marks
;
4260 Jim_HashTableIterator
*htiter
;
4265 /* Avoid recursive calls */
4266 if (interp
->lastCollectId
== -1) {
4267 /* Jim_Collect() already running. Return just now. */
4270 interp
->lastCollectId
= -1;
4272 /* Mark all the references found into the 'mark' hash table.
4273 * The references are searched in every live object that
4274 * is of a type that can contain references. */
4275 Jim_InitHashTable(&marks
, &JimRefMarkHashTableType
, NULL
);
4276 objPtr
= interp
->liveList
;
4278 if (objPtr
->typePtr
== NULL
||
4279 objPtr
->typePtr
->flags
& JIM_TYPE_REFERENCES
) {
4280 const char *str
, *p
;
4283 /* If the object is of type reference, to get the
4284 * Id is simple... */
4285 if (objPtr
->typePtr
== &referenceObjType
) {
4286 Jim_AddHashEntry(&marks
,
4287 &objPtr
->internalRep
.refValue
.id
, NULL
);
4289 Jim_fprintf(interp
,interp
->cookie_stdout
,
4290 "MARK (reference): %d refcount: %d" JIM_NL
,
4291 (int) objPtr
->internalRep
.refValue
.id
,
4294 objPtr
= objPtr
->nextObjPtr
;
4297 /* Get the string repr of the object we want
4298 * to scan for references. */
4299 p
= str
= Jim_GetString(objPtr
, &len
);
4300 /* Skip objects too little to contain references. */
4301 if (len
< JIM_REFERENCE_SPACE
) {
4302 objPtr
= objPtr
->nextObjPtr
;
4305 /* Extract references from the object string repr. */
4311 if ((p
= strstr(p
, "<reference.<")) == NULL
)
4313 /* Check if it's a valid reference. */
4314 if (len
-(p
-str
) < JIM_REFERENCE_SPACE
) break;
4315 if (p
[41] != '>' || p
[19] != '>' || p
[20] != '.') break;
4316 for (i
= 21; i
<= 40; i
++)
4317 if (!isdigit((int)p
[i
]))
4320 memcpy(buf
, p
+21, 20);
4322 Jim_StringToWide(buf
, &id
, 10);
4324 /* Ok, a reference for the given ID
4325 * was found. Mark it. */
4326 Jim_AddHashEntry(&marks
, &id
, NULL
);
4328 Jim_fprintf(interp
,interp
->cookie_stdout
,"MARK: %d" JIM_NL
, (int)id
);
4330 p
+= JIM_REFERENCE_SPACE
;
4333 objPtr
= objPtr
->nextObjPtr
;
4336 /* Run the references hash table to destroy every reference that
4337 * is not referenced outside (not present in the mark HT). */
4338 htiter
= Jim_GetHashTableIterator(&interp
->references
);
4339 while ((he
= Jim_NextHashEntry(htiter
)) != NULL
) {
4340 const jim_wide
*refId
;
4341 Jim_Reference
*refPtr
;
4344 /* Check if in the mark phase we encountered
4345 * this reference. */
4346 if (Jim_FindHashEntry(&marks
, refId
) == NULL
) {
4348 Jim_fprintf(interp
,interp
->cookie_stdout
,"COLLECTING %d" JIM_NL
, (int)*refId
);
4351 /* Drop the reference, but call the
4352 * finalizer first if registered. */
4354 if (refPtr
->finalizerCmdNamePtr
) {
4355 char *refstr
= Jim_Alloc(JIM_REFERENCE_SPACE
+1);
4356 Jim_Obj
*objv
[3], *oldResult
;
4358 JimFormatReference(refstr
, refPtr
, *refId
);
4360 objv
[0] = refPtr
->finalizerCmdNamePtr
;
4361 objv
[1] = Jim_NewStringObjNoAlloc(interp
,
4363 objv
[2] = refPtr
->objPtr
;
4364 Jim_IncrRefCount(objv
[0]);
4365 Jim_IncrRefCount(objv
[1]);
4366 Jim_IncrRefCount(objv
[2]);
4368 /* Drop the reference itself */
4369 Jim_DeleteHashEntry(&interp
->references
, refId
);
4371 /* Call the finalizer. Errors ignored. */
4372 oldResult
= interp
->result
;
4373 Jim_IncrRefCount(oldResult
);
4374 Jim_EvalObjVector(interp
, 3, objv
);
4375 Jim_SetResult(interp
, oldResult
);
4376 Jim_DecrRefCount(interp
, oldResult
);
4378 Jim_DecrRefCount(interp
, objv
[0]);
4379 Jim_DecrRefCount(interp
, objv
[1]);
4380 Jim_DecrRefCount(interp
, objv
[2]);
4382 Jim_DeleteHashEntry(&interp
->references
, refId
);
4386 Jim_FreeHashTableIterator(htiter
);
4387 Jim_FreeHashTable(&marks
);
4388 interp
->lastCollectId
= interp
->referenceNextId
;
4389 interp
->lastCollectTime
= time(NULL
);
4393 #define JIM_COLLECT_ID_PERIOD 5000
4394 #define JIM_COLLECT_TIME_PERIOD 300
4396 void Jim_CollectIfNeeded(Jim_Interp
*interp
)
4401 elapsedId
= interp
->referenceNextId
- interp
->lastCollectId
;
4402 elapsedTime
= time(NULL
) - interp
->lastCollectTime
;
4405 if (elapsedId
> JIM_COLLECT_ID_PERIOD
||
4406 elapsedTime
> JIM_COLLECT_TIME_PERIOD
) {
4407 Jim_Collect(interp
);
4411 /* -----------------------------------------------------------------------------
4412 * Interpreter related functions
4413 * ---------------------------------------------------------------------------*/
4415 Jim_Interp
*Jim_CreateInterp(void)
4417 Jim_Interp
*i
= Jim_Alloc(sizeof(*i
));
4421 i
->errorFileName
= Jim_StrDup("");
4423 i
->maxNestingDepth
= JIM_MAX_NESTING_DEPTH
;
4424 i
->returnCode
= JIM_OK
;
4427 i
->callFrameEpoch
= 0;
4428 i
->liveList
= i
->freeList
= NULL
;
4429 i
->scriptFileName
= Jim_StrDup("");
4430 i
->referenceNextId
= 0;
4431 i
->lastCollectId
= 0;
4432 i
->lastCollectTime
= time(NULL
);
4433 i
->freeFramesList
= NULL
;
4434 i
->prngState
= NULL
;
4435 i
->evalRetcodeLevel
= -1;
4436 i
->cookie_stdin
= stdin
;
4437 i
->cookie_stdout
= stdout
;
4438 i
->cookie_stderr
= stderr
;
4439 i
->cb_fwrite
= ((size_t (*)( const void *, size_t, size_t, void *))(fwrite
));
4440 i
->cb_fread
= ((size_t (*)( void *, size_t, size_t, void *))(fread
));
4441 i
->cb_vfprintf
= ((int (*)( void *, const char *fmt
, va_list ))(vfprintf
));
4442 i
->cb_fflush
= ((int (*)( void *))(fflush
));
4443 i
->cb_fgets
= ((char * (*)( char *, int, void *))(fgets
));
4445 /* Note that we can create objects only after the
4446 * interpreter liveList and freeList pointers are
4447 * initialized to NULL. */
4448 Jim_InitHashTable(&i
->commands
, &JimCommandsHashTableType
, i
);
4449 Jim_InitHashTable(&i
->references
, &JimReferencesHashTableType
, i
);
4450 Jim_InitHashTable(&i
->sharedStrings
, &JimSharedStringsHashTableType
,
4452 Jim_InitHashTable(&i
->stub
, &JimStringCopyHashTableType
, NULL
);
4453 Jim_InitHashTable(&i
->assocData
, &JimAssocDataHashTableType
, i
);
4454 Jim_InitHashTable(&i
->packages
, &JimStringKeyValCopyHashTableType
, NULL
);
4455 i
->framePtr
= i
->topFramePtr
= JimCreateCallFrame(i
);
4456 i
->emptyObj
= Jim_NewEmptyStringObj(i
);
4457 i
->result
= i
->emptyObj
;
4458 i
->stackTrace
= Jim_NewListObj(i
, NULL
, 0);
4459 i
->unknown
= Jim_NewStringObj(i
, "unknown", -1);
4460 i
->unknown_called
= 0;
4461 Jim_IncrRefCount(i
->emptyObj
);
4462 Jim_IncrRefCount(i
->result
);
4463 Jim_IncrRefCount(i
->stackTrace
);
4464 Jim_IncrRefCount(i
->unknown
);
4466 /* Initialize key variables every interpreter should contain */
4467 pathPtr
= Jim_NewStringObj(i
, "./", -1);
4468 Jim_SetVariableStr(i
, "jim_libpath", pathPtr
);
4469 Jim_SetVariableStrWithStr(i
, "jim_interactive", "0");
4471 /* Export the core API to extensions */
4472 JimRegisterCoreApi(i
);
4476 /* This is the only function Jim exports directly without
4477 * to use the STUB system. It is only used by embedders
4478 * in order to get an interpreter with the Jim API pointers
4480 Jim_Interp
*ExportedJimCreateInterp(void)
4482 return Jim_CreateInterp();
4485 void Jim_FreeInterp(Jim_Interp
*i
)
4487 Jim_CallFrame
*cf
= i
->framePtr
, *prevcf
, *nextcf
;
4488 Jim_Obj
*objPtr
, *nextObjPtr
;
4490 Jim_DecrRefCount(i
, i
->emptyObj
);
4491 Jim_DecrRefCount(i
, i
->result
);
4492 Jim_DecrRefCount(i
, i
->stackTrace
);
4493 Jim_DecrRefCount(i
, i
->unknown
);
4494 Jim_Free((void*)i
->errorFileName
);
4495 Jim_Free((void*)i
->scriptFileName
);
4496 Jim_FreeHashTable(&i
->commands
);
4497 Jim_FreeHashTable(&i
->references
);
4498 Jim_FreeHashTable(&i
->stub
);
4499 Jim_FreeHashTable(&i
->assocData
);
4500 Jim_FreeHashTable(&i
->packages
);
4501 Jim_Free(i
->prngState
);
4502 /* Free the call frames list */
4504 prevcf
= cf
->parentCallFrame
;
4505 JimFreeCallFrame(i
, cf
, JIM_FCF_NONE
);
4508 /* Check that the live object list is empty, otherwise
4509 * there is a memory leak. */
4510 if (i
->liveList
!= NULL
) {
4511 Jim_Obj
*objPtr
= i
->liveList
;
4513 Jim_fprintf( i
, i
->cookie_stdout
,JIM_NL
"-------------------------------------" JIM_NL
);
4514 Jim_fprintf( i
, i
->cookie_stdout
,"Objects still in the free list:" JIM_NL
);
4516 const char *type
= objPtr
->typePtr
?
4517 objPtr
->typePtr
->name
: "";
4518 Jim_fprintf( i
, i
->cookie_stdout
,"%p \"%-10s\": '%.20s' (refCount: %d)" JIM_NL
,
4520 objPtr
->bytes
? objPtr
->bytes
4521 : "(null)", objPtr
->refCount
);
4522 if (objPtr
->typePtr
== &sourceObjType
) {
4523 Jim_fprintf( i
, i
->cookie_stdout
, "FILE %s LINE %d" JIM_NL
,
4524 objPtr
->internalRep
.sourceValue
.fileName
,
4525 objPtr
->internalRep
.sourceValue
.lineNumber
);
4527 objPtr
= objPtr
->nextObjPtr
;
4529 Jim_fprintf( i
, i
->cookie_stdout
, "-------------------------------------" JIM_NL JIM_NL
);
4530 Jim_Panic(i
,"Live list non empty freeing the interpreter! Leak?");
4532 /* Free all the freed objects. */
4533 objPtr
= i
->freeList
;
4535 nextObjPtr
= objPtr
->nextObjPtr
;
4537 objPtr
= nextObjPtr
;
4539 /* Free cached CallFrame structures */
4540 cf
= i
->freeFramesList
;
4542 nextcf
= cf
->nextFramePtr
;
4543 if (cf
->vars
.table
!= NULL
)
4544 Jim_Free(cf
->vars
.table
);
4548 /* Free the sharedString hash table. Make sure to free it
4549 * after every other Jim_Object was freed. */
4550 Jim_FreeHashTable(&i
->sharedStrings
);
4551 /* Free the interpreter structure. */
4555 /* Store the call frame relative to the level represented by
4556 * levelObjPtr into *framePtrPtr. If levelObjPtr == NULL, the
4557 * level is assumed to be '1'.
4559 * If a newLevelptr int pointer is specified, the function stores
4560 * the absolute level integer value of the new target callframe into
4561 * *newLevelPtr. (this is used to adjust interp->numLevels
4562 * in the implementation of [uplevel], so that [info level] will
4563 * return a correct information).
4565 * This function accepts the 'level' argument in the form
4566 * of the commands [uplevel] and [upvar].
4568 * For a function accepting a relative integer as level suitable
4569 * for implementation of [info level ?level?] check the
4570 * GetCallFrameByInteger() function. */
4571 int Jim_GetCallFrameByLevel(Jim_Interp
*interp
, Jim_Obj
*levelObjPtr
,
4572 Jim_CallFrame
**framePtrPtr
, int *newLevelPtr
)
4576 Jim_CallFrame
*framePtr
;
4578 if (newLevelPtr
) *newLevelPtr
= interp
->numLevels
;
4580 str
= Jim_GetString(levelObjPtr
, NULL
);
4581 if (str
[0] == '#') {
4583 /* speedup for the toplevel (level #0) */
4584 if (str
[1] == '0' && str
[2] == '\0') {
4585 if (newLevelPtr
) *newLevelPtr
= 0;
4586 *framePtrPtr
= interp
->topFramePtr
;
4590 level
= strtol(str
+1, &endptr
, 0);
4591 if (str
[1] == '\0' || endptr
[0] != '\0' || level
< 0)
4593 /* An 'absolute' level is converted into the
4594 * 'number of levels to go back' format. */
4595 level
= interp
->numLevels
- level
;
4596 if (level
< 0) goto badlevel
;
4598 if (Jim_GetLong(interp
, levelObjPtr
, &level
) != JIM_OK
|| level
< 0)
4602 str
= "1"; /* Needed to format the error message. */
4606 framePtr
= interp
->framePtr
;
4607 if (newLevelPtr
) *newLevelPtr
= (*newLevelPtr
)-level
;
4609 framePtr
= framePtr
->parentCallFrame
;
4610 if (framePtr
== NULL
) goto badlevel
;
4612 *framePtrPtr
= framePtr
;
4615 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4616 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4617 "bad level \"", str
, "\"", NULL
);
4621 /* Similar to Jim_GetCallFrameByLevel() but the level is specified
4622 * as a relative integer like in the [info level ?level?] command. */
4623 static int JimGetCallFrameByInteger(Jim_Interp
*interp
, Jim_Obj
*levelObjPtr
,
4624 Jim_CallFrame
**framePtrPtr
)
4627 jim_wide relLevel
; /* level relative to the current one. */
4628 Jim_CallFrame
*framePtr
;
4630 if (Jim_GetWide(interp
, levelObjPtr
, &level
) != JIM_OK
)
4633 /* An 'absolute' level is converted into the
4634 * 'number of levels to go back' format. */
4635 relLevel
= interp
->numLevels
- level
;
4640 framePtr
= interp
->framePtr
;
4641 while (relLevel
--) {
4642 framePtr
= framePtr
->parentCallFrame
;
4643 if (framePtr
== NULL
) goto badlevel
;
4645 *framePtrPtr
= framePtr
;
4648 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4649 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4650 "bad level \"", Jim_GetString(levelObjPtr
, NULL
), "\"", NULL
);
4654 static void JimSetErrorFileName(Jim_Interp
*interp
, char *filename
)
4656 Jim_Free((void*)interp
->errorFileName
);
4657 interp
->errorFileName
= Jim_StrDup(filename
);
4660 static void JimSetErrorLineNumber(Jim_Interp
*interp
, int linenr
)
4662 interp
->errorLine
= linenr
;
4665 static void JimResetStackTrace(Jim_Interp
*interp
)
4667 Jim_DecrRefCount(interp
, interp
->stackTrace
);
4668 interp
->stackTrace
= Jim_NewListObj(interp
, NULL
, 0);
4669 Jim_IncrRefCount(interp
->stackTrace
);
4672 static void JimAppendStackTrace(Jim_Interp
*interp
, const char *procname
,
4673 const char *filename
, int linenr
)
4675 /* No need to add this dummy entry to the stack trace */
4676 if (strcmp(procname
, "unknown") == 0) {
4680 if (Jim_IsShared(interp
->stackTrace
)) {
4681 interp
->stackTrace
=
4682 Jim_DuplicateObj(interp
, interp
->stackTrace
);
4683 Jim_IncrRefCount(interp
->stackTrace
);
4685 Jim_ListAppendElement(interp
, interp
->stackTrace
,
4686 Jim_NewStringObj(interp
, procname
, -1));
4687 Jim_ListAppendElement(interp
, interp
->stackTrace
,
4688 Jim_NewStringObj(interp
, filename
, -1));
4689 Jim_ListAppendElement(interp
, interp
->stackTrace
,
4690 Jim_NewIntObj(interp
, linenr
));
4693 int Jim_SetAssocData(Jim_Interp
*interp
, const char *key
, Jim_InterpDeleteProc
*delProc
, void *data
)
4695 AssocDataValue
*assocEntryPtr
= (AssocDataValue
*)Jim_Alloc(sizeof(AssocDataValue
));
4696 assocEntryPtr
->delProc
= delProc
;
4697 assocEntryPtr
->data
= data
;
4698 return Jim_AddHashEntry(&interp
->assocData
, key
, assocEntryPtr
);
4701 void *Jim_GetAssocData(Jim_Interp
*interp
, const char *key
)
4703 Jim_HashEntry
*entryPtr
= Jim_FindHashEntry(&interp
->assocData
, key
);
4704 if (entryPtr
!= NULL
) {
4705 AssocDataValue
*assocEntryPtr
= (AssocDataValue
*)entryPtr
->val
;
4706 return assocEntryPtr
->data
;
4711 int Jim_DeleteAssocData(Jim_Interp
*interp
, const char *key
)
4713 return Jim_DeleteHashEntry(&interp
->assocData
, key
);
4716 int Jim_GetExitCode(Jim_Interp
*interp
) {
4717 return interp
->exitCode
;
4720 void *Jim_SetStdin(Jim_Interp
*interp
, void *fp
)
4722 if (fp
!= NULL
) interp
->cookie_stdin
= fp
;
4723 return interp
->cookie_stdin
;
4726 void *Jim_SetStdout(Jim_Interp
*interp
, void *fp
)
4728 if (fp
!= NULL
) interp
->cookie_stdout
= fp
;
4729 return interp
->cookie_stdout
;
4732 void *Jim_SetStderr(Jim_Interp
*interp
, void *fp
)
4734 if (fp
!= NULL
) interp
->cookie_stderr
= fp
;
4735 return interp
->cookie_stderr
;
4738 /* -----------------------------------------------------------------------------
4740 * Every interpreter has an hash table where to put shared dynamically
4741 * allocate strings that are likely to be used a lot of times.
4742 * For example, in the 'source' object type, there is a pointer to
4743 * the filename associated with that object. Every script has a lot
4744 * of this objects with the identical file name, so it is wise to share
4747 * The API is trivial: Jim_GetSharedString(interp, "foobar")
4748 * returns the pointer to the shared string. Every time a reference
4749 * to the string is no longer used, the user should call
4750 * Jim_ReleaseSharedString(interp, stringPointer). Once no one is using
4751 * a given string, it is removed from the hash table.
4752 * ---------------------------------------------------------------------------*/
4753 const char *Jim_GetSharedString(Jim_Interp
*interp
, const char *str
)
4755 Jim_HashEntry
*he
= Jim_FindHashEntry(&interp
->sharedStrings
, str
);
4758 char *strCopy
= Jim_StrDup(str
);
4760 Jim_AddHashEntry(&interp
->sharedStrings
, strCopy
, (void*)1);
4763 long refCount
= (long) he
->val
;
4766 he
->val
= (void*) refCount
;
4771 void Jim_ReleaseSharedString(Jim_Interp
*interp
, const char *str
)
4774 Jim_HashEntry
*he
= Jim_FindHashEntry(&interp
->sharedStrings
, str
);
4777 Jim_Panic(interp
,"Jim_ReleaseSharedString called with "
4778 "unknown shared string '%s'", str
);
4779 refCount
= (long) he
->val
;
4781 if (refCount
== 0) {
4782 Jim_DeleteHashEntry(&interp
->sharedStrings
, str
);
4784 he
->val
= (void*) refCount
;
4788 /* -----------------------------------------------------------------------------
4790 * ---------------------------------------------------------------------------*/
4791 #define JIM_INTEGER_SPACE 24
4793 static void UpdateStringOfInt(struct Jim_Obj
*objPtr
);
4794 static int SetIntFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
, int flags
);
4796 static Jim_ObjType intObjType
= {
4804 void UpdateStringOfInt(struct Jim_Obj
*objPtr
)
4807 char buf
[JIM_INTEGER_SPACE
+1];
4809 len
= Jim_WideToString(buf
, objPtr
->internalRep
.wideValue
);
4810 objPtr
->bytes
= Jim_Alloc(len
+1);
4811 memcpy(objPtr
->bytes
, buf
, len
+1);
4812 objPtr
->length
= len
;
4815 int SetIntFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
, int flags
)
4820 /* Get the string representation */
4821 str
= Jim_GetString(objPtr
, NULL
);
4822 /* Try to convert into a jim_wide */
4823 if (Jim_StringToWide(str
, &wideValue
, 0) != JIM_OK
) {
4824 if (flags
& JIM_ERRMSG
) {
4825 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4826 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4827 "expected integer but got \"", str
, "\"", NULL
);
4831 if ((wideValue
== JIM_WIDE_MIN
|| wideValue
== JIM_WIDE_MAX
) &&
4833 Jim_SetResultString(interp
,
4834 "Integer value too big to be represented", -1);
4837 /* Free the old internal repr and set the new one. */
4838 Jim_FreeIntRep(interp
, objPtr
);
4839 objPtr
->typePtr
= &intObjType
;
4840 objPtr
->internalRep
.wideValue
= wideValue
;
4844 int Jim_GetWide(Jim_Interp
*interp
, Jim_Obj
*objPtr
, jim_wide
*widePtr
)
4846 if (objPtr
->typePtr
!= &intObjType
&&
4847 SetIntFromAny(interp
, objPtr
, JIM_ERRMSG
) == JIM_ERR
)
4849 *widePtr
= objPtr
->internalRep
.wideValue
;
4853 /* Get a wide but does not set an error if the format is bad. */
4854 static int JimGetWideNoErr(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
4857 if (objPtr
->typePtr
!= &intObjType
&&
4858 SetIntFromAny(interp
, objPtr
, JIM_NONE
) == JIM_ERR
)
4860 *widePtr
= objPtr
->internalRep
.wideValue
;
4864 int Jim_GetLong(Jim_Interp
*interp
, Jim_Obj
*objPtr
, long *longPtr
)
4869 retval
= Jim_GetWide(interp
, objPtr
, &wideValue
);
4870 if (retval
== JIM_OK
) {
4871 *longPtr
= (long) wideValue
;
4877 void Jim_SetWide(Jim_Interp
*interp
, Jim_Obj
*objPtr
, jim_wide wideValue
)
4879 if (Jim_IsShared(objPtr
))
4880 Jim_Panic(interp
,"Jim_SetWide called with shared object");
4881 if (objPtr
->typePtr
!= &intObjType
) {
4882 Jim_FreeIntRep(interp
, objPtr
);
4883 objPtr
->typePtr
= &intObjType
;
4885 Jim_InvalidateStringRep(objPtr
);
4886 objPtr
->internalRep
.wideValue
= wideValue
;
4889 Jim_Obj
*Jim_NewIntObj(Jim_Interp
*interp
, jim_wide wideValue
)
4893 objPtr
= Jim_NewObj(interp
);
4894 objPtr
->typePtr
= &intObjType
;
4895 objPtr
->bytes
= NULL
;
4896 objPtr
->internalRep
.wideValue
= wideValue
;
4900 /* -----------------------------------------------------------------------------
4902 * ---------------------------------------------------------------------------*/
4903 #define JIM_DOUBLE_SPACE 30
4905 static void UpdateStringOfDouble(struct Jim_Obj
*objPtr
);
4906 static int SetDoubleFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
4908 static Jim_ObjType doubleObjType
= {
4912 UpdateStringOfDouble
,
4916 void UpdateStringOfDouble(struct Jim_Obj
*objPtr
)
4919 char buf
[JIM_DOUBLE_SPACE
+1];
4921 len
= Jim_DoubleToString(buf
, objPtr
->internalRep
.doubleValue
);
4922 objPtr
->bytes
= Jim_Alloc(len
+1);
4923 memcpy(objPtr
->bytes
, buf
, len
+1);
4924 objPtr
->length
= len
;
4927 int SetDoubleFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
4932 /* Get the string representation */
4933 str
= Jim_GetString(objPtr
, NULL
);
4934 /* Try to convert into a double */
4935 if (Jim_StringToDouble(str
, &doubleValue
) != JIM_OK
) {
4936 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4937 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4938 "expected number but got '", str
, "'", NULL
);
4941 /* Free the old internal repr and set the new one. */
4942 Jim_FreeIntRep(interp
, objPtr
);
4943 objPtr
->typePtr
= &doubleObjType
;
4944 objPtr
->internalRep
.doubleValue
= doubleValue
;
4948 int Jim_GetDouble(Jim_Interp
*interp
, Jim_Obj
*objPtr
, double *doublePtr
)
4950 if (objPtr
->typePtr
!= &doubleObjType
&&
4951 SetDoubleFromAny(interp
, objPtr
) == JIM_ERR
)
4953 *doublePtr
= objPtr
->internalRep
.doubleValue
;
4957 void Jim_SetDouble(Jim_Interp
*interp
, Jim_Obj
*objPtr
, double doubleValue
)
4959 if (Jim_IsShared(objPtr
))
4960 Jim_Panic(interp
,"Jim_SetDouble called with shared object");
4961 if (objPtr
->typePtr
!= &doubleObjType
) {
4962 Jim_FreeIntRep(interp
, objPtr
);
4963 objPtr
->typePtr
= &doubleObjType
;
4965 Jim_InvalidateStringRep(objPtr
);
4966 objPtr
->internalRep
.doubleValue
= doubleValue
;
4969 Jim_Obj
*Jim_NewDoubleObj(Jim_Interp
*interp
, double doubleValue
)
4973 objPtr
= Jim_NewObj(interp
);
4974 objPtr
->typePtr
= &doubleObjType
;
4975 objPtr
->bytes
= NULL
;
4976 objPtr
->internalRep
.doubleValue
= doubleValue
;
4980 /* -----------------------------------------------------------------------------
4982 * ---------------------------------------------------------------------------*/
4983 static void ListAppendElement(Jim_Obj
*listPtr
, Jim_Obj
*objPtr
);
4984 static void FreeListInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
4985 static void DupListInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
);
4986 static void UpdateStringOfList(struct Jim_Obj
*objPtr
);
4987 static int SetListFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
);
4989 /* Note that while the elements of the list may contain references,
4990 * the list object itself can't. This basically means that the
4991 * list object string representation as a whole can't contain references
4992 * that are not presents in the single elements. */
4993 static Jim_ObjType listObjType
= {
4995 FreeListInternalRep
,
5001 void FreeListInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
5005 for (i
= 0; i
< objPtr
->internalRep
.listValue
.len
; i
++) {
5006 Jim_DecrRefCount(interp
, objPtr
->internalRep
.listValue
.ele
[i
]);
5008 Jim_Free(objPtr
->internalRep
.listValue
.ele
);
5011 void DupListInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
)
5014 JIM_NOTUSED(interp
);
5016 dupPtr
->internalRep
.listValue
.len
= srcPtr
->internalRep
.listValue
.len
;
5017 dupPtr
->internalRep
.listValue
.maxLen
= srcPtr
->internalRep
.listValue
.maxLen
;
5018 dupPtr
->internalRep
.listValue
.ele
=
5019 Jim_Alloc(sizeof(Jim_Obj
*)*srcPtr
->internalRep
.listValue
.maxLen
);
5020 memcpy(dupPtr
->internalRep
.listValue
.ele
, srcPtr
->internalRep
.listValue
.ele
,
5021 sizeof(Jim_Obj
*)*srcPtr
->internalRep
.listValue
.len
);
5022 for (i
= 0; i
< dupPtr
->internalRep
.listValue
.len
; i
++) {
5023 Jim_IncrRefCount(dupPtr
->internalRep
.listValue
.ele
[i
]);
5025 dupPtr
->typePtr
= &listObjType
;
5028 /* The following function checks if a given string can be encoded
5029 * into a list element without any kind of quoting, surrounded by braces,
5030 * or using escapes to quote. */
5031 #define JIM_ELESTR_SIMPLE 0
5032 #define JIM_ELESTR_BRACE 1
5033 #define JIM_ELESTR_QUOTE 2
5034 static int ListElementQuotingType(const char *s
, int len
)
5036 int i
, level
, trySimple
= 1;
5038 /* Try with the SIMPLE case */
5039 if (len
== 0) return JIM_ELESTR_BRACE
;
5040 if (s
[0] == '"' || s
[0] == '{') {
5044 for (i
= 0; i
< len
; i
++) {
5064 return JIM_ELESTR_SIMPLE
;
5067 /* Test if it's possible to do with braces */
5068 if (s
[len
-1] == '\\' ||
5069 s
[len
-1] == ']') return JIM_ELESTR_QUOTE
;
5071 for (i
= 0; i
< len
; i
++) {
5073 case '{': level
++; break;
5075 if (level
< 0) return JIM_ELESTR_QUOTE
;
5079 return JIM_ELESTR_QUOTE
;
5081 if (s
[i
+1] != '\0') i
++;
5086 if (!trySimple
) return JIM_ELESTR_BRACE
;
5087 for (i
= 0; i
< len
; i
++) {
5101 return JIM_ELESTR_BRACE
;
5105 return JIM_ELESTR_SIMPLE
;
5107 return JIM_ELESTR_QUOTE
;
5110 /* Returns the malloc-ed representation of a string
5111 * using backslash to quote special chars. */
5112 char *BackslashQuoteString(const char *s
, int len
, int *qlenPtr
)
5114 char *q
= Jim_Alloc(len
*2+1), *p
;
5131 case '\n': *p
++ = '\\'; *p
++ = 'n'; s
++; break;
5132 case '\r': *p
++ = '\\'; *p
++ = 'r'; s
++; break;
5133 case '\t': *p
++ = '\\'; *p
++ = 't'; s
++; break;
5134 case '\f': *p
++ = '\\'; *p
++ = 'f'; s
++; break;
5135 case '\v': *p
++ = '\\'; *p
++ = 'v'; s
++; break;
5146 void UpdateStringOfList(struct Jim_Obj
*objPtr
)
5148 int i
, bufLen
, realLength
;
5152 Jim_Obj
**ele
= objPtr
->internalRep
.listValue
.ele
;
5154 /* (Over) Estimate the space needed. */
5155 quotingType
= Jim_Alloc(sizeof(int)*objPtr
->internalRep
.listValue
.len
+1);
5157 for (i
= 0; i
< objPtr
->internalRep
.listValue
.len
; i
++) {
5160 strRep
= Jim_GetString(ele
[i
], &len
);
5161 quotingType
[i
] = ListElementQuotingType(strRep
, len
);
5162 switch (quotingType
[i
]) {
5163 case JIM_ELESTR_SIMPLE
: bufLen
+= len
; break;
5164 case JIM_ELESTR_BRACE
: bufLen
+= len
+2; break;
5165 case JIM_ELESTR_QUOTE
: bufLen
+= len
*2; break;
5167 bufLen
++; /* elements separator. */
5171 /* Generate the string rep. */
5172 p
= objPtr
->bytes
= Jim_Alloc(bufLen
+1);
5174 for (i
= 0; i
< objPtr
->internalRep
.listValue
.len
; i
++) {
5176 const char *strRep
= Jim_GetString(ele
[i
], &len
);
5179 switch(quotingType
[i
]) {
5180 case JIM_ELESTR_SIMPLE
:
5181 memcpy(p
, strRep
, len
);
5185 case JIM_ELESTR_BRACE
:
5187 memcpy(p
, strRep
, len
);
5190 realLength
+= len
+2;
5192 case JIM_ELESTR_QUOTE
:
5193 q
= BackslashQuoteString(strRep
, len
, &qlen
);
5200 /* Add a separating space */
5201 if (i
+1 != objPtr
->internalRep
.listValue
.len
) {
5206 *p
= '\0'; /* nul term. */
5207 objPtr
->length
= realLength
;
5208 Jim_Free(quotingType
);
5211 int SetListFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
)
5213 struct JimParserCtx parser
;
5217 /* Get the string representation */
5218 str
= Jim_GetString(objPtr
, &strLen
);
5220 /* Free the old internal repr just now and initialize the
5221 * new one just now. The string->list conversion can't fail. */
5222 Jim_FreeIntRep(interp
, objPtr
);
5223 objPtr
->typePtr
= &listObjType
;
5224 objPtr
->internalRep
.listValue
.len
= 0;
5225 objPtr
->internalRep
.listValue
.maxLen
= 0;
5226 objPtr
->internalRep
.listValue
.ele
= NULL
;
5228 /* Convert into a list */
5229 JimParserInit(&parser
, str
, strLen
, 1);
5230 while(!JimParserEof(&parser
)) {
5233 Jim_Obj
*elementPtr
;
5235 JimParseList(&parser
);
5236 if (JimParserTtype(&parser
) != JIM_TT_STR
&&
5237 JimParserTtype(&parser
) != JIM_TT_ESC
)
5239 token
= JimParserGetToken(&parser
, &tokenLen
, &type
, NULL
);
5240 elementPtr
= Jim_NewStringObjNoAlloc(interp
, token
, tokenLen
);
5241 ListAppendElement(objPtr
, elementPtr
);
5246 Jim_Obj
*Jim_NewListObj(Jim_Interp
*interp
, Jim_Obj
*const *elements
,
5252 objPtr
= Jim_NewObj(interp
);
5253 objPtr
->typePtr
= &listObjType
;
5254 objPtr
->bytes
= NULL
;
5255 objPtr
->internalRep
.listValue
.ele
= NULL
;
5256 objPtr
->internalRep
.listValue
.len
= 0;
5257 objPtr
->internalRep
.listValue
.maxLen
= 0;
5258 for (i
= 0; i
< len
; i
++) {
5259 ListAppendElement(objPtr
, elements
[i
]);
5264 /* Return a vector of Jim_Obj with the elements of a Jim list, and the
5265 * length of the vector. Note that the user of this function should make
5266 * sure that the list object can't shimmer while the vector returned
5267 * is in use, this vector is the one stored inside the internal representation
5268 * of the list object. This function is not exported, extensions should
5269 * always access to the List object elements using Jim_ListIndex(). */
5270 static void JimListGetElements(Jim_Interp
*interp
, Jim_Obj
*listObj
, int *argc
,
5273 Jim_ListLength(interp
, listObj
, argc
);
5274 assert(listObj
->typePtr
== &listObjType
);
5275 *listVec
= listObj
->internalRep
.listValue
.ele
;
5278 /* ListSortElements type values */
5279 enum {JIM_LSORT_ASCII
, JIM_LSORT_NOCASE
, JIM_LSORT_ASCII_DECR
,
5280 JIM_LSORT_NOCASE_DECR
};
5282 /* Sort the internal rep of a list. */
5283 static int ListSortString(Jim_Obj
**lhsObj
, Jim_Obj
**rhsObj
)
5285 return Jim_StringCompareObj(*lhsObj
, *rhsObj
, 0);
5288 static int ListSortStringDecr(Jim_Obj
**lhsObj
, Jim_Obj
**rhsObj
)
5290 return Jim_StringCompareObj(*lhsObj
, *rhsObj
, 0) * -1;
5293 static int ListSortStringNoCase(Jim_Obj
**lhsObj
, Jim_Obj
**rhsObj
)
5295 return Jim_StringCompareObj(*lhsObj
, *rhsObj
, 1);
5298 static int ListSortStringNoCaseDecr(Jim_Obj
**lhsObj
, Jim_Obj
**rhsObj
)
5300 return Jim_StringCompareObj(*lhsObj
, *rhsObj
, 1) * -1;
5303 /* Sort a list *in place*. MUST be called with non-shared objects. */
5304 static void ListSortElements(Jim_Interp
*interp
, Jim_Obj
*listObjPtr
, int type
)
5306 typedef int (qsort_comparator
)(const void *, const void *);
5307 int (*fn
)(Jim_Obj
**, Jim_Obj
**);
5311 if (Jim_IsShared(listObjPtr
))
5312 Jim_Panic(interp
,"Jim_ListSortElements called with shared object");
5313 if (listObjPtr
->typePtr
!= &listObjType
)
5314 SetListFromAny(interp
, listObjPtr
);
5316 vector
= listObjPtr
->internalRep
.listValue
.ele
;
5317 len
= listObjPtr
->internalRep
.listValue
.len
;
5319 case JIM_LSORT_ASCII
: fn
= ListSortString
; break;
5320 case JIM_LSORT_NOCASE
: fn
= ListSortStringNoCase
; break;
5321 case JIM_LSORT_ASCII_DECR
: fn
= ListSortStringDecr
; break;
5322 case JIM_LSORT_NOCASE_DECR
: fn
= ListSortStringNoCaseDecr
; break;
5324 fn
= NULL
; /* avoid warning */
5325 Jim_Panic(interp
,"ListSort called with invalid sort type");
5327 qsort(vector
, len
, sizeof(Jim_Obj
*), (qsort_comparator
*)fn
);
5328 Jim_InvalidateStringRep(listObjPtr
);
5331 /* This is the low-level function to append an element to a list.
5332 * The higher-level Jim_ListAppendElement() performs shared object
5333 * check and invalidate the string repr. This version is used
5334 * in the internals of the List Object and is not exported.
5336 * NOTE: this function can be called only against objects
5337 * with internal type of List. */
5338 void ListAppendElement(Jim_Obj
*listPtr
, Jim_Obj
*objPtr
)
5340 int requiredLen
= listPtr
->internalRep
.listValue
.len
+ 1;
5342 if (requiredLen
> listPtr
->internalRep
.listValue
.maxLen
) {
5343 int maxLen
= requiredLen
* 2;
5345 listPtr
->internalRep
.listValue
.ele
=
5346 Jim_Realloc(listPtr
->internalRep
.listValue
.ele
,
5347 sizeof(Jim_Obj
*)*maxLen
);
5348 listPtr
->internalRep
.listValue
.maxLen
= maxLen
;
5350 listPtr
->internalRep
.listValue
.ele
[listPtr
->internalRep
.listValue
.len
] =
5352 listPtr
->internalRep
.listValue
.len
++;
5353 Jim_IncrRefCount(objPtr
);
5356 /* This is the low-level function to insert elements into a list.
5357 * The higher-level Jim_ListInsertElements() performs shared object
5358 * check and invalidate the string repr. This version is used
5359 * in the internals of the List Object and is not exported.
5361 * NOTE: this function can be called only against objects
5362 * with internal type of List. */
5363 void ListInsertElements(Jim_Obj
*listPtr
, int index
, int elemc
,
5364 Jim_Obj
*const *elemVec
)
5366 int currentLen
= listPtr
->internalRep
.listValue
.len
;
5367 int requiredLen
= currentLen
+ elemc
;
5371 if (requiredLen
> listPtr
->internalRep
.listValue
.maxLen
) {
5372 int maxLen
= requiredLen
* 2;
5374 listPtr
->internalRep
.listValue
.ele
=
5375 Jim_Realloc(listPtr
->internalRep
.listValue
.ele
,
5376 sizeof(Jim_Obj
*)*maxLen
);
5377 listPtr
->internalRep
.listValue
.maxLen
= maxLen
;
5379 point
= listPtr
->internalRep
.listValue
.ele
+ index
;
5380 memmove(point
+elemc
, point
, (currentLen
-index
) * sizeof(Jim_Obj
*));
5381 for (i
=0; i
< elemc
; ++i
) {
5382 point
[i
] = elemVec
[i
];
5383 Jim_IncrRefCount(point
[i
]);
5385 listPtr
->internalRep
.listValue
.len
+= elemc
;
5388 /* Appends every element of appendListPtr into listPtr.
5389 * Both have to be of the list type. */
5390 void ListAppendList(Jim_Obj
*listPtr
, Jim_Obj
*appendListPtr
)
5392 int i
, oldLen
= listPtr
->internalRep
.listValue
.len
;
5393 int appendLen
= appendListPtr
->internalRep
.listValue
.len
;
5394 int requiredLen
= oldLen
+ appendLen
;
5396 if (requiredLen
> listPtr
->internalRep
.listValue
.maxLen
) {
5397 int maxLen
= requiredLen
* 2;
5399 listPtr
->internalRep
.listValue
.ele
=
5400 Jim_Realloc(listPtr
->internalRep
.listValue
.ele
,
5401 sizeof(Jim_Obj
*)*maxLen
);
5402 listPtr
->internalRep
.listValue
.maxLen
= maxLen
;
5404 for (i
= 0; i
< appendLen
; i
++) {
5405 Jim_Obj
*objPtr
= appendListPtr
->internalRep
.listValue
.ele
[i
];
5406 listPtr
->internalRep
.listValue
.ele
[oldLen
+i
] = objPtr
;
5407 Jim_IncrRefCount(objPtr
);
5409 listPtr
->internalRep
.listValue
.len
+= appendLen
;
5412 void Jim_ListAppendElement(Jim_Interp
*interp
, Jim_Obj
*listPtr
, Jim_Obj
*objPtr
)
5414 if (Jim_IsShared(listPtr
))
5415 Jim_Panic(interp
,"Jim_ListAppendElement called with shared object");
5416 if (listPtr
->typePtr
!= &listObjType
)
5417 SetListFromAny(interp
, listPtr
);
5418 Jim_InvalidateStringRep(listPtr
);
5419 ListAppendElement(listPtr
, objPtr
);
5422 void Jim_ListAppendList(Jim_Interp
*interp
, Jim_Obj
*listPtr
, Jim_Obj
*appendListPtr
)
5424 if (Jim_IsShared(listPtr
))
5425 Jim_Panic(interp
,"Jim_ListAppendList called with shared object");
5426 if (listPtr
->typePtr
!= &listObjType
)
5427 SetListFromAny(interp
, listPtr
);
5428 Jim_InvalidateStringRep(listPtr
);
5429 ListAppendList(listPtr
, appendListPtr
);
5432 void Jim_ListLength(Jim_Interp
*interp
, Jim_Obj
*listPtr
, int *intPtr
)
5434 if (listPtr
->typePtr
!= &listObjType
)
5435 SetListFromAny(interp
, listPtr
);
5436 *intPtr
= listPtr
->internalRep
.listValue
.len
;
5439 void Jim_ListInsertElements(Jim_Interp
*interp
, Jim_Obj
*listPtr
, int index
,
5440 int objc
, Jim_Obj
*const *objVec
)
5442 if (Jim_IsShared(listPtr
))
5443 Jim_Panic(interp
,"Jim_ListInsertElement called with shared object");
5444 if (listPtr
->typePtr
!= &listObjType
)
5445 SetListFromAny(interp
, listPtr
);
5446 if (index
>= 0 && index
> listPtr
->internalRep
.listValue
.len
)
5447 index
= listPtr
->internalRep
.listValue
.len
;
5448 else if (index
< 0 )
5450 Jim_InvalidateStringRep(listPtr
);
5451 ListInsertElements(listPtr
, index
, objc
, objVec
);
5454 int Jim_ListIndex(Jim_Interp
*interp
, Jim_Obj
*listPtr
, int index
,
5455 Jim_Obj
**objPtrPtr
, int flags
)
5457 if (listPtr
->typePtr
!= &listObjType
)
5458 SetListFromAny(interp
, listPtr
);
5459 if ((index
>= 0 && index
>= listPtr
->internalRep
.listValue
.len
) ||
5460 (index
< 0 && (-index
-1) >= listPtr
->internalRep
.listValue
.len
)) {
5461 if (flags
& JIM_ERRMSG
) {
5462 Jim_SetResultString(interp
,
5463 "list index out of range", -1);
5468 index
= listPtr
->internalRep
.listValue
.len
+index
;
5469 *objPtrPtr
= listPtr
->internalRep
.listValue
.ele
[index
];
5473 static int ListSetIndex(Jim_Interp
*interp
, Jim_Obj
*listPtr
, int index
,
5474 Jim_Obj
*newObjPtr
, int flags
)
5476 if (listPtr
->typePtr
!= &listObjType
)
5477 SetListFromAny(interp
, listPtr
);
5478 if ((index
>= 0 && index
>= listPtr
->internalRep
.listValue
.len
) ||
5479 (index
< 0 && (-index
-1) >= listPtr
->internalRep
.listValue
.len
)) {
5480 if (flags
& JIM_ERRMSG
) {
5481 Jim_SetResultString(interp
,
5482 "list index out of range", -1);
5487 index
= listPtr
->internalRep
.listValue
.len
+index
;
5488 Jim_DecrRefCount(interp
, listPtr
->internalRep
.listValue
.ele
[index
]);
5489 listPtr
->internalRep
.listValue
.ele
[index
] = newObjPtr
;
5490 Jim_IncrRefCount(newObjPtr
);
5494 /* Modify the list stored into the variable named 'varNamePtr'
5495 * setting the element specified by the 'indexc' indexes objects in 'indexv',
5496 * with the new element 'newObjptr'. */
5497 int Jim_SetListIndex(Jim_Interp
*interp
, Jim_Obj
*varNamePtr
,
5498 Jim_Obj
*const *indexv
, int indexc
, Jim_Obj
*newObjPtr
)
5500 Jim_Obj
*varObjPtr
, *objPtr
, *listObjPtr
;
5501 int shared
, i
, index
;
5503 varObjPtr
= objPtr
= Jim_GetVariable(interp
, varNamePtr
, JIM_ERRMSG
);
5506 if ((shared
= Jim_IsShared(objPtr
)))
5507 varObjPtr
= objPtr
= Jim_DuplicateObj(interp
, objPtr
);
5508 for (i
= 0; i
< indexc
-1; i
++) {
5509 listObjPtr
= objPtr
;
5510 if (Jim_GetIndex(interp
, indexv
[i
], &index
) != JIM_OK
)
5512 if (Jim_ListIndex(interp
, listObjPtr
, index
, &objPtr
,
5513 JIM_ERRMSG
) != JIM_OK
) {
5516 if (Jim_IsShared(objPtr
)) {
5517 objPtr
= Jim_DuplicateObj(interp
, objPtr
);
5518 ListSetIndex(interp
, listObjPtr
, index
, objPtr
, JIM_NONE
);
5520 Jim_InvalidateStringRep(listObjPtr
);
5522 if (Jim_GetIndex(interp
, indexv
[indexc
-1], &index
) != JIM_OK
)
5524 if (ListSetIndex(interp
, objPtr
, index
, newObjPtr
, JIM_ERRMSG
) == JIM_ERR
)
5526 Jim_InvalidateStringRep(objPtr
);
5527 Jim_InvalidateStringRep(varObjPtr
);
5528 if (Jim_SetVariable(interp
, varNamePtr
, varObjPtr
) != JIM_OK
)
5530 Jim_SetResult(interp
, varObjPtr
);
5534 Jim_FreeNewObj(interp
, varObjPtr
);
5539 Jim_Obj
*Jim_ConcatObj(Jim_Interp
*interp
, int objc
, Jim_Obj
*const *objv
)
5543 /* If all the objects in objv are lists without string rep.
5544 * it's possible to return a list as result, that's the
5545 * concatenation of all the lists. */
5546 for (i
= 0; i
< objc
; i
++) {
5547 if (objv
[i
]->typePtr
!= &listObjType
|| objv
[i
]->bytes
)
5551 Jim_Obj
*objPtr
= Jim_NewListObj(interp
, NULL
, 0);
5552 for (i
= 0; i
< objc
; i
++)
5553 Jim_ListAppendList(interp
, objPtr
, objv
[i
]);
5556 /* Else... we have to glue strings together */
5557 int len
= 0, objLen
;
5560 /* Compute the length */
5561 for (i
= 0; i
< objc
; i
++) {
5562 Jim_GetString(objv
[i
], &objLen
);
5565 if (objc
) len
+= objc
-1;
5566 /* Create the string rep, and a stinrg object holding it. */
5567 p
= bytes
= Jim_Alloc(len
+1);
5568 for (i
= 0; i
< objc
; i
++) {
5569 const char *s
= Jim_GetString(objv
[i
], &objLen
);
5570 while (objLen
&& (*s
== ' ' || *s
== '\t' || *s
== '\n'))
5572 s
++; objLen
--; len
--;
5574 while (objLen
&& (s
[objLen
-1] == ' ' ||
5575 s
[objLen
-1] == '\n' || s
[objLen
-1] == '\t')) {
5578 memcpy(p
, s
, objLen
);
5580 if (objLen
&& i
+1 != objc
) {
5582 } else if (i
+1 != objc
) {
5583 /* Drop the space calcuated for this
5584 * element that is instead null. */
5589 return Jim_NewStringObjNoAlloc(interp
, bytes
, len
);
5593 /* Returns a list composed of the elements in the specified range.
5594 * first and start are directly accepted as Jim_Objects and
5595 * processed for the end?-index? case. */
5596 Jim_Obj
*Jim_ListRange(Jim_Interp
*interp
, Jim_Obj
*listObjPtr
, Jim_Obj
*firstObjPtr
, Jim_Obj
*lastObjPtr
)
5601 if (Jim_GetIndex(interp
, firstObjPtr
, &first
) != JIM_OK
||
5602 Jim_GetIndex(interp
, lastObjPtr
, &last
) != JIM_OK
)
5604 Jim_ListLength(interp
, listObjPtr
, &len
); /* will convert into list */
5605 first
= JimRelToAbsIndex(len
, first
);
5606 last
= JimRelToAbsIndex(len
, last
);
5607 JimRelToAbsRange(len
, first
, last
, &first
, &last
, &rangeLen
);
5608 return Jim_NewListObj(interp
,
5609 listObjPtr
->internalRep
.listValue
.ele
+first
, rangeLen
);
5612 /* -----------------------------------------------------------------------------
5614 * ---------------------------------------------------------------------------*/
5615 static void FreeDictInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
5616 static void DupDictInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
);
5617 static void UpdateStringOfDict(struct Jim_Obj
*objPtr
);
5618 static int SetDictFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
);
5620 /* Dict HashTable Type.
5622 * Keys and Values are Jim objects. */
5624 unsigned int JimObjectHTHashFunction(const void *key
)
5627 Jim_Obj
*objPtr
= (Jim_Obj
*) key
;
5630 str
= Jim_GetString(objPtr
, &len
);
5631 h
= Jim_GenHashFunction((unsigned char*)str
, len
);
5635 int JimObjectHTKeyCompare(void *privdata
, const void *key1
, const void *key2
)
5637 JIM_NOTUSED(privdata
);
5639 return Jim_StringEqObj((Jim_Obj
*)key1
, (Jim_Obj
*)key2
, 0);
5642 static void JimObjectHTKeyValDestructor(void *interp
, void *val
)
5644 Jim_Obj
*objPtr
= val
;
5646 Jim_DecrRefCount(interp
, objPtr
);
5649 static Jim_HashTableType JimDictHashTableType
= {
5650 JimObjectHTHashFunction
, /* hash function */
5653 JimObjectHTKeyCompare
, /* key compare */
5654 (void(*)(void*, const void*)) /* ATTENTION: const cast */
5655 JimObjectHTKeyValDestructor
, /* key destructor */
5656 JimObjectHTKeyValDestructor
/* val destructor */
5659 /* Note that while the elements of the dict may contain references,
5660 * the list object itself can't. This basically means that the
5661 * dict object string representation as a whole can't contain references
5662 * that are not presents in the single elements. */
5663 static Jim_ObjType dictObjType
= {
5665 FreeDictInternalRep
,
5671 void FreeDictInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
5673 JIM_NOTUSED(interp
);
5675 Jim_FreeHashTable(objPtr
->internalRep
.ptr
);
5676 Jim_Free(objPtr
->internalRep
.ptr
);
5679 void DupDictInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
)
5681 Jim_HashTable
*ht
, *dupHt
;
5682 Jim_HashTableIterator
*htiter
;
5685 /* Create a new hash table */
5686 ht
= srcPtr
->internalRep
.ptr
;
5687 dupHt
= Jim_Alloc(sizeof(*dupHt
));
5688 Jim_InitHashTable(dupHt
, &JimDictHashTableType
, interp
);
5690 Jim_ExpandHashTable(dupHt
, ht
->size
);
5691 /* Copy every element from the source to the dup hash table */
5692 htiter
= Jim_GetHashTableIterator(ht
);
5693 while ((he
= Jim_NextHashEntry(htiter
)) != NULL
) {
5694 const Jim_Obj
*keyObjPtr
= he
->key
;
5695 Jim_Obj
*valObjPtr
= he
->val
;
5697 Jim_IncrRefCount((Jim_Obj
*)keyObjPtr
); /* ATTENTION: const cast */
5698 Jim_IncrRefCount(valObjPtr
);
5699 Jim_AddHashEntry(dupHt
, keyObjPtr
, valObjPtr
);
5701 Jim_FreeHashTableIterator(htiter
);
5703 dupPtr
->internalRep
.ptr
= dupHt
;
5704 dupPtr
->typePtr
= &dictObjType
;
5707 void UpdateStringOfDict(struct Jim_Obj
*objPtr
)
5709 int i
, bufLen
, realLength
;
5712 int *quotingType
, objc
;
5714 Jim_HashTableIterator
*htiter
;
5718 /* Trun the hash table into a flat vector of Jim_Objects. */
5719 ht
= objPtr
->internalRep
.ptr
;
5721 objv
= Jim_Alloc(objc
*sizeof(Jim_Obj
*));
5722 htiter
= Jim_GetHashTableIterator(ht
);
5724 while ((he
= Jim_NextHashEntry(htiter
)) != NULL
) {
5725 objv
[i
++] = (Jim_Obj
*)he
->key
; /* ATTENTION: const cast */
5726 objv
[i
++] = he
->val
;
5728 Jim_FreeHashTableIterator(htiter
);
5729 /* (Over) Estimate the space needed. */
5730 quotingType
= Jim_Alloc(sizeof(int)*objc
);
5732 for (i
= 0; i
< objc
; i
++) {
5735 strRep
= Jim_GetString(objv
[i
], &len
);
5736 quotingType
[i
] = ListElementQuotingType(strRep
, len
);
5737 switch (quotingType
[i
]) {
5738 case JIM_ELESTR_SIMPLE
: bufLen
+= len
; break;
5739 case JIM_ELESTR_BRACE
: bufLen
+= len
+2; break;
5740 case JIM_ELESTR_QUOTE
: bufLen
+= len
*2; break;
5742 bufLen
++; /* elements separator. */
5746 /* Generate the string rep. */
5747 p
= objPtr
->bytes
= Jim_Alloc(bufLen
+1);
5749 for (i
= 0; i
< objc
; i
++) {
5751 const char *strRep
= Jim_GetString(objv
[i
], &len
);
5754 switch(quotingType
[i
]) {
5755 case JIM_ELESTR_SIMPLE
:
5756 memcpy(p
, strRep
, len
);
5760 case JIM_ELESTR_BRACE
:
5762 memcpy(p
, strRep
, len
);
5765 realLength
+= len
+2;
5767 case JIM_ELESTR_QUOTE
:
5768 q
= BackslashQuoteString(strRep
, len
, &qlen
);
5775 /* Add a separating space */
5781 *p
= '\0'; /* nul term. */
5782 objPtr
->length
= realLength
;
5783 Jim_Free(quotingType
);
5787 int SetDictFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
)
5789 struct JimParserCtx parser
;
5795 /* Get the string representation */
5796 str
= Jim_GetString(objPtr
, &strLen
);
5798 /* Free the old internal repr just now and initialize the
5799 * new one just now. The string->list conversion can't fail. */
5800 Jim_FreeIntRep(interp
, objPtr
);
5801 ht
= Jim_Alloc(sizeof(*ht
));
5802 Jim_InitHashTable(ht
, &JimDictHashTableType
, interp
);
5803 objPtr
->typePtr
= &dictObjType
;
5804 objPtr
->internalRep
.ptr
= ht
;
5806 /* Convert into a dict */
5807 JimParserInit(&parser
, str
, strLen
, 1);
5809 while(!JimParserEof(&parser
)) {
5813 JimParseList(&parser
);
5814 if (JimParserTtype(&parser
) != JIM_TT_STR
&&
5815 JimParserTtype(&parser
) != JIM_TT_ESC
)
5817 token
= JimParserGetToken(&parser
, &tokenLen
, &type
, NULL
);
5818 objv
[i
++] = Jim_NewStringObjNoAlloc(interp
, token
, tokenLen
);
5821 Jim_IncrRefCount(objv
[0]);
5822 Jim_IncrRefCount(objv
[1]);
5823 if (Jim_AddHashEntry(ht
, objv
[0], objv
[1]) != JIM_OK
) {
5825 he
= Jim_FindHashEntry(ht
, objv
[0]);
5826 Jim_DecrRefCount(interp
, objv
[0]);
5827 /* ATTENTION: const cast */
5828 Jim_DecrRefCount(interp
, (Jim_Obj
*)he
->val
);
5834 Jim_FreeNewObj(interp
, objv
[0]);
5835 objPtr
->typePtr
= NULL
;
5836 Jim_FreeHashTable(ht
);
5837 Jim_SetResultString(interp
, "invalid dictionary value: must be a list with an even number of elements", -1);
5843 /* Dict object API */
5845 /* Add an element to a dict. objPtr must be of the "dict" type.
5846 * The higer-level exported function is Jim_DictAddElement().
5847 * If an element with the specified key already exists, the value
5848 * associated is replaced with the new one.
5850 * if valueObjPtr == NULL, the key is instead removed if it exists. */
5851 static void DictAddElement(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
5852 Jim_Obj
*keyObjPtr
, Jim_Obj
*valueObjPtr
)
5854 Jim_HashTable
*ht
= objPtr
->internalRep
.ptr
;
5856 if (valueObjPtr
== NULL
) { /* unset */
5857 Jim_DeleteHashEntry(ht
, keyObjPtr
);
5860 Jim_IncrRefCount(keyObjPtr
);
5861 Jim_IncrRefCount(valueObjPtr
);
5862 if (Jim_AddHashEntry(ht
, keyObjPtr
, valueObjPtr
) != JIM_OK
) {
5863 Jim_HashEntry
*he
= Jim_FindHashEntry(ht
, keyObjPtr
);
5864 Jim_DecrRefCount(interp
, keyObjPtr
);
5865 /* ATTENTION: const cast */
5866 Jim_DecrRefCount(interp
, (Jim_Obj
*)he
->val
);
5867 he
->val
= valueObjPtr
;
5871 /* Add an element, higher-level interface for DictAddElement().
5872 * If valueObjPtr == NULL, the key is removed if it exists. */
5873 int Jim_DictAddElement(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
5874 Jim_Obj
*keyObjPtr
, Jim_Obj
*valueObjPtr
)
5876 if (Jim_IsShared(objPtr
))
5877 Jim_Panic(interp
,"Jim_DictAddElement called with shared object");
5878 if (objPtr
->typePtr
!= &dictObjType
) {
5879 if (SetDictFromAny(interp
, objPtr
) != JIM_OK
)
5882 DictAddElement(interp
, objPtr
, keyObjPtr
, valueObjPtr
);
5883 Jim_InvalidateStringRep(objPtr
);
5887 Jim_Obj
*Jim_NewDictObj(Jim_Interp
*interp
, Jim_Obj
*const *elements
, int len
)
5893 Jim_Panic(interp
,"Jim_NewDicObj() 'len' argument must be even");
5895 objPtr
= Jim_NewObj(interp
);
5896 objPtr
->typePtr
= &dictObjType
;
5897 objPtr
->bytes
= NULL
;
5898 objPtr
->internalRep
.ptr
= Jim_Alloc(sizeof(Jim_HashTable
));
5899 Jim_InitHashTable(objPtr
->internalRep
.ptr
, &JimDictHashTableType
, interp
);
5900 for (i
= 0; i
< len
; i
+= 2)
5901 DictAddElement(interp
, objPtr
, elements
[i
], elements
[i
+1]);
5905 /* Return the value associated to the specified dict key */
5906 int Jim_DictKey(Jim_Interp
*interp
, Jim_Obj
*dictPtr
, Jim_Obj
*keyPtr
,
5907 Jim_Obj
**objPtrPtr
, int flags
)
5912 if (dictPtr
->typePtr
!= &dictObjType
) {
5913 if (SetDictFromAny(interp
, dictPtr
) != JIM_OK
)
5916 ht
= dictPtr
->internalRep
.ptr
;
5917 if ((he
= Jim_FindHashEntry(ht
, keyPtr
)) == NULL
) {
5918 if (flags
& JIM_ERRMSG
) {
5919 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
5920 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
5921 "key \"", Jim_GetString(keyPtr
, NULL
),
5922 "\" not found in dictionary", NULL
);
5926 *objPtrPtr
= he
->val
;
5930 /* Return the value associated to the specified dict keys */
5931 int Jim_DictKeysVector(Jim_Interp
*interp
, Jim_Obj
*dictPtr
,
5932 Jim_Obj
*const *keyv
, int keyc
, Jim_Obj
**objPtrPtr
, int flags
)
5938 *objPtrPtr
= dictPtr
;
5942 for (i
= 0; i
< keyc
; i
++) {
5943 if (Jim_DictKey(interp
, dictPtr
, keyv
[i
], &objPtr
, flags
)
5948 *objPtrPtr
= objPtr
;
5952 /* Modify the dict stored into the variable named 'varNamePtr'
5953 * setting the element specified by the 'keyc' keys objects in 'keyv',
5954 * with the new value of the element 'newObjPtr'.
5956 * If newObjPtr == NULL the operation is to remove the given key
5957 * from the dictionary. */
5958 int Jim_SetDictKeysVector(Jim_Interp
*interp
, Jim_Obj
*varNamePtr
,
5959 Jim_Obj
*const *keyv
, int keyc
, Jim_Obj
*newObjPtr
)
5961 Jim_Obj
*varObjPtr
, *objPtr
, *dictObjPtr
;
5964 varObjPtr
= objPtr
= Jim_GetVariable(interp
, varNamePtr
, JIM_ERRMSG
);
5965 if (objPtr
== NULL
) {
5966 if (newObjPtr
== NULL
) /* Cannot remove a key from non existing var */
5968 varObjPtr
= objPtr
= Jim_NewDictObj(interp
, NULL
, 0);
5969 if (Jim_SetVariable(interp
, varNamePtr
, objPtr
) != JIM_OK
) {
5970 Jim_FreeNewObj(interp
, varObjPtr
);
5974 if ((shared
= Jim_IsShared(objPtr
)))
5975 varObjPtr
= objPtr
= Jim_DuplicateObj(interp
, objPtr
);
5976 for (i
= 0; i
< keyc
-1; i
++) {
5977 dictObjPtr
= objPtr
;
5979 /* Check if it's a valid dictionary */
5980 if (dictObjPtr
->typePtr
!= &dictObjType
) {
5981 if (SetDictFromAny(interp
, dictObjPtr
) != JIM_OK
)
5984 /* Check if the given key exists. */
5985 Jim_InvalidateStringRep(dictObjPtr
);
5986 if (Jim_DictKey(interp
, dictObjPtr
, keyv
[i
], &objPtr
,
5987 newObjPtr
? JIM_NONE
: JIM_ERRMSG
) == JIM_OK
)
5989 /* This key exists at the current level.
5990 * Make sure it's not shared!. */
5991 if (Jim_IsShared(objPtr
)) {
5992 objPtr
= Jim_DuplicateObj(interp
, objPtr
);
5993 DictAddElement(interp
, dictObjPtr
, keyv
[i
], objPtr
);
5996 /* Key not found. If it's an [unset] operation
5997 * this is an error. Only the last key may not
5999 if (newObjPtr
== NULL
)
6001 /* Otherwise set an empty dictionary
6002 * as key's value. */
6003 objPtr
= Jim_NewDictObj(interp
, NULL
, 0);
6004 DictAddElement(interp
, dictObjPtr
, keyv
[i
], objPtr
);
6007 if (Jim_DictAddElement(interp
, objPtr
, keyv
[keyc
-1], newObjPtr
)
6010 Jim_InvalidateStringRep(objPtr
);
6011 Jim_InvalidateStringRep(varObjPtr
);
6012 if (Jim_SetVariable(interp
, varNamePtr
, varObjPtr
) != JIM_OK
)
6014 Jim_SetResult(interp
, varObjPtr
);
6018 Jim_FreeNewObj(interp
, varObjPtr
);
6023 /* -----------------------------------------------------------------------------
6025 * ---------------------------------------------------------------------------*/
6026 static void UpdateStringOfIndex(struct Jim_Obj
*objPtr
);
6027 static int SetIndexFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
);
6029 static Jim_ObjType indexObjType
= {
6033 UpdateStringOfIndex
,
6037 void UpdateStringOfIndex(struct Jim_Obj
*objPtr
)
6040 char buf
[JIM_INTEGER_SPACE
+1];
6042 if (objPtr
->internalRep
.indexValue
>= 0)
6043 len
= sprintf(buf
, "%d", objPtr
->internalRep
.indexValue
);
6044 else if (objPtr
->internalRep
.indexValue
== -1)
6045 len
= sprintf(buf
, "end");
6047 len
= sprintf(buf
, "end%d", objPtr
->internalRep
.indexValue
+1);
6049 objPtr
->bytes
= Jim_Alloc(len
+1);
6050 memcpy(objPtr
->bytes
, buf
, len
+1);
6051 objPtr
->length
= len
;
6054 int SetIndexFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
6059 /* Get the string representation */
6060 str
= Jim_GetString(objPtr
, NULL
);
6061 /* Try to convert into an index */
6062 if (!strcmp(str
, "end")) {
6066 if (!strncmp(str
, "end-", 4)) {
6070 if (Jim_StringToIndex(str
, &index
) != JIM_OK
) {
6071 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
6072 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
6073 "bad index \"", Jim_GetString(objPtr
, NULL
), "\": "
6074 "must be integer or end?-integer?", NULL
);
6083 } else if (!end
&& index
< 0)
6085 /* Free the old internal repr and set the new one. */
6086 Jim_FreeIntRep(interp
, objPtr
);
6087 objPtr
->typePtr
= &indexObjType
;
6088 objPtr
->internalRep
.indexValue
= index
;
6092 int Jim_GetIndex(Jim_Interp
*interp
, Jim_Obj
*objPtr
, int *indexPtr
)
6094 /* Avoid shimmering if the object is an integer. */
6095 if (objPtr
->typePtr
== &intObjType
) {
6096 jim_wide val
= objPtr
->internalRep
.wideValue
;
6097 if (!(val
< LONG_MIN
) && !(val
> LONG_MAX
)) {
6098 *indexPtr
= (val
< 0) ? -INT_MAX
: (long)val
;;
6102 if (objPtr
->typePtr
!= &indexObjType
&&
6103 SetIndexFromAny(interp
, objPtr
) == JIM_ERR
)
6105 *indexPtr
= objPtr
->internalRep
.indexValue
;
6109 /* -----------------------------------------------------------------------------
6110 * Return Code Object.
6111 * ---------------------------------------------------------------------------*/
6113 static int SetReturnCodeFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
6115 static Jim_ObjType returnCodeObjType
= {
6123 int SetReturnCodeFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
6126 int strLen
, returnCode
;
6129 /* Get the string representation */
6130 str
= Jim_GetString(objPtr
, &strLen
);
6131 /* Try to convert into an integer */
6132 if (JimGetWideNoErr(interp
, objPtr
, &wideValue
) != JIM_ERR
)
6133 returnCode
= (int) wideValue
;
6134 else if (!JimStringCompare(str
, strLen
, "ok", 2, JIM_NOCASE
))
6135 returnCode
= JIM_OK
;
6136 else if (!JimStringCompare(str
, strLen
, "error", 5, JIM_NOCASE
))
6137 returnCode
= JIM_ERR
;
6138 else if (!JimStringCompare(str
, strLen
, "return", 6, JIM_NOCASE
))
6139 returnCode
= JIM_RETURN
;
6140 else if (!JimStringCompare(str
, strLen
, "break", 5, JIM_NOCASE
))
6141 returnCode
= JIM_BREAK
;
6142 else if (!JimStringCompare(str
, strLen
, "continue", 8, JIM_NOCASE
))
6143 returnCode
= JIM_CONTINUE
;
6144 else if (!JimStringCompare(str
, strLen
, "eval", 4, JIM_NOCASE
))
6145 returnCode
= JIM_EVAL
;
6146 else if (!JimStringCompare(str
, strLen
, "exit", 4, JIM_NOCASE
))
6147 returnCode
= JIM_EXIT
;
6149 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
6150 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
6151 "expected return code but got '", str
, "'",
6155 /* Free the old internal repr and set the new one. */
6156 Jim_FreeIntRep(interp
, objPtr
);
6157 objPtr
->typePtr
= &returnCodeObjType
;
6158 objPtr
->internalRep
.returnCode
= returnCode
;
6162 int Jim_GetReturnCode(Jim_Interp
*interp
, Jim_Obj
*objPtr
, int *intPtr
)
6164 if (objPtr
->typePtr
!= &returnCodeObjType
&&
6165 SetReturnCodeFromAny(interp
, objPtr
) == JIM_ERR
)
6167 *intPtr
= objPtr
->internalRep
.returnCode
;
6171 /* -----------------------------------------------------------------------------
6172 * Expression Parsing
6173 * ---------------------------------------------------------------------------*/
6174 static int JimParseExprOperator(struct JimParserCtx
*pc
);
6175 static int JimParseExprNumber(struct JimParserCtx
*pc
);
6176 static int JimParseExprIrrational(struct JimParserCtx
*pc
);
6178 /* Exrp's Stack machine operators opcodes. */
6180 /* Binary operators (numbers) */
6181 #define JIM_EXPROP_BINARY_NUM_FIRST 0 /* first */
6182 #define JIM_EXPROP_MUL 0
6183 #define JIM_EXPROP_DIV 1
6184 #define JIM_EXPROP_MOD 2
6185 #define JIM_EXPROP_SUB 3
6186 #define JIM_EXPROP_ADD 4
6187 #define JIM_EXPROP_LSHIFT 5
6188 #define JIM_EXPROP_RSHIFT 6
6189 #define JIM_EXPROP_ROTL 7
6190 #define JIM_EXPROP_ROTR 8
6191 #define JIM_EXPROP_LT 9
6192 #define JIM_EXPROP_GT 10
6193 #define JIM_EXPROP_LTE 11
6194 #define JIM_EXPROP_GTE 12
6195 #define JIM_EXPROP_NUMEQ 13
6196 #define JIM_EXPROP_NUMNE 14
6197 #define JIM_EXPROP_BITAND 15
6198 #define JIM_EXPROP_BITXOR 16
6199 #define JIM_EXPROP_BITOR 17
6200 #define JIM_EXPROP_LOGICAND 18
6201 #define JIM_EXPROP_LOGICOR 19
6202 #define JIM_EXPROP_LOGICAND_LEFT 20
6203 #define JIM_EXPROP_LOGICOR_LEFT 21
6204 #define JIM_EXPROP_POW 22
6205 #define JIM_EXPROP_BINARY_NUM_LAST 22 /* last */
6207 /* Binary operators (strings) */
6208 #define JIM_EXPROP_STREQ 23
6209 #define JIM_EXPROP_STRNE 24
6211 /* Unary operators (numbers) */
6212 #define JIM_EXPROP_NOT 25
6213 #define JIM_EXPROP_BITNOT 26
6214 #define JIM_EXPROP_UNARYMINUS 27
6215 #define JIM_EXPROP_UNARYPLUS 28
6216 #define JIM_EXPROP_LOGICAND_RIGHT 29
6217 #define JIM_EXPROP_LOGICOR_RIGHT 30
6219 /* Ternary operators */
6220 #define JIM_EXPROP_TERNARY 31
6223 #define JIM_EXPROP_NUMBER 32
6224 #define JIM_EXPROP_COMMAND 33
6225 #define JIM_EXPROP_VARIABLE 34
6226 #define JIM_EXPROP_DICTSUGAR 35
6227 #define JIM_EXPROP_SUBST 36
6228 #define JIM_EXPROP_STRING 37
6230 /* Operators table */
6231 typedef struct Jim_ExprOperator
{
6238 /* name - precedence - arity - opcode */
6239 static struct Jim_ExprOperator Jim_ExprOperators
[] = {
6240 {"!", 300, 1, JIM_EXPROP_NOT
},
6241 {"~", 300, 1, JIM_EXPROP_BITNOT
},
6242 {"unarymin", 300, 1, JIM_EXPROP_UNARYMINUS
},
6243 {"unaryplus", 300, 1, JIM_EXPROP_UNARYPLUS
},
6245 {"**", 250, 2, JIM_EXPROP_POW
},
6247 {"*", 200, 2, JIM_EXPROP_MUL
},
6248 {"/", 200, 2, JIM_EXPROP_DIV
},
6249 {"%", 200, 2, JIM_EXPROP_MOD
},
6251 {"-", 100, 2, JIM_EXPROP_SUB
},
6252 {"+", 100, 2, JIM_EXPROP_ADD
},
6254 {"<<<", 90, 3, JIM_EXPROP_ROTL
},
6255 {">>>", 90, 3, JIM_EXPROP_ROTR
},
6256 {"<<", 90, 2, JIM_EXPROP_LSHIFT
},
6257 {">>", 90, 2, JIM_EXPROP_RSHIFT
},
6259 {"<", 80, 2, JIM_EXPROP_LT
},
6260 {">", 80, 2, JIM_EXPROP_GT
},
6261 {"<=", 80, 2, JIM_EXPROP_LTE
},
6262 {">=", 80, 2, JIM_EXPROP_GTE
},
6264 {"==", 70, 2, JIM_EXPROP_NUMEQ
},
6265 {"!=", 70, 2, JIM_EXPROP_NUMNE
},
6267 {"eq", 60, 2, JIM_EXPROP_STREQ
},
6268 {"ne", 60, 2, JIM_EXPROP_STRNE
},
6270 {"&", 50, 2, JIM_EXPROP_BITAND
},
6271 {"^", 49, 2, JIM_EXPROP_BITXOR
},
6272 {"|", 48, 2, JIM_EXPROP_BITOR
},
6274 {"&&", 10, 2, JIM_EXPROP_LOGICAND
},
6275 {"||", 10, 2, JIM_EXPROP_LOGICOR
},
6277 {"?", 5, 3, JIM_EXPROP_TERNARY
},
6278 /* private operators */
6279 {NULL
, 10, 2, JIM_EXPROP_LOGICAND_LEFT
},
6280 {NULL
, 10, 1, JIM_EXPROP_LOGICAND_RIGHT
},
6281 {NULL
, 10, 2, JIM_EXPROP_LOGICOR_LEFT
},
6282 {NULL
, 10, 1, JIM_EXPROP_LOGICOR_RIGHT
},
6285 #define JIM_EXPR_OPERATORS_NUM \
6286 (sizeof(Jim_ExprOperators)/sizeof(struct Jim_ExprOperator))
6288 int JimParseExpression(struct JimParserCtx
*pc
)
6290 /* Discard spaces and quoted newline */
6291 while(*(pc
->p
) == ' ' ||
6295 (*(pc
->p
) == '\\' && *(pc
->p
+1) == '\n')) {
6300 pc
->tstart
= pc
->tend
= pc
->p
;
6301 pc
->tline
= pc
->linenr
;
6302 pc
->tt
= JIM_TT_EOL
;
6308 pc
->tstart
= pc
->tend
= pc
->p
;
6309 pc
->tline
= pc
->linenr
;
6310 pc
->tt
= JIM_TT_SUBEXPR_START
;
6314 pc
->tstart
= pc
->tend
= pc
->p
;
6315 pc
->tline
= pc
->linenr
;
6316 pc
->tt
= JIM_TT_SUBEXPR_END
;
6320 return JimParseCmd(pc
);
6323 if (JimParseVar(pc
) == JIM_ERR
)
6324 return JimParseExprOperator(pc
);
6329 if ((pc
->tt
== JIM_TT_NONE
|| pc
->tt
== JIM_TT_EXPR_OPERATOR
) &&
6330 isdigit((int)*(pc
->p
+1)))
6331 return JimParseExprNumber(pc
);
6333 return JimParseExprOperator(pc
);
6335 case '0': case '1': case '2': case '3': case '4':
6336 case '5': case '6': case '7': case '8': case '9': case '.':
6337 return JimParseExprNumber(pc
);
6341 /* Here it's possible to reuse the List String parsing. */
6342 pc
->tt
= JIM_TT_NONE
; /* Make sure it's sensed as a new word. */
6343 return JimParseListStr(pc
);
6347 if (JimParseExprIrrational(pc
) == JIM_ERR
)
6348 return JimParseExprOperator(pc
);
6351 return JimParseExprOperator(pc
);
6357 int JimParseExprNumber(struct JimParserCtx
*pc
)
6363 pc
->tline
= pc
->linenr
;
6364 if (*pc
->p
== '-') {
6367 while ( isdigit((int)*pc
->p
)
6368 || (allowhex
&& isxdigit((int)*pc
->p
) )
6369 || (allowdot
&& *pc
->p
== '.')
6370 || (pc
->p
-pc
->tstart
== 1 && *pc
->tstart
== '0' &&
6371 (*pc
->p
== 'x' || *pc
->p
== 'X'))
6374 if ((*pc
->p
== 'x') || (*pc
->p
== 'X')) {
6381 if (!allowdot
&& *pc
->p
== 'e' && *(pc
->p
+1) == '-') {
6382 pc
->p
+= 2; pc
->len
-= 2;
6386 pc
->tt
= JIM_TT_EXPR_NUMBER
;
6390 int JimParseExprIrrational(struct JimParserCtx
*pc
)
6392 const char *Tokens
[] = {"NaN", "nan", "NAN", "Inf", "inf", "INF", NULL
};
6394 for (token
= Tokens
; *token
!= NULL
; token
++) {
6395 int len
= strlen(*token
);
6396 if (strncmp(*token
, pc
->p
, len
) == 0) {
6398 pc
->tend
= pc
->p
+ len
- 1;
6399 pc
->p
+= len
; pc
->len
-= len
;
6400 pc
->tline
= pc
->linenr
;
6401 pc
->tt
= JIM_TT_EXPR_NUMBER
;
6408 int JimParseExprOperator(struct JimParserCtx
*pc
)
6411 int bestIdx
= -1, bestLen
= 0;
6413 /* Try to get the longest match. */
6414 for (i
= 0; i
< (signed)JIM_EXPR_OPERATORS_NUM
; i
++) {
6418 opname
= Jim_ExprOperators
[i
].name
;
6419 if (opname
== NULL
) continue;
6420 oplen
= strlen(opname
);
6422 if (strncmp(opname
, pc
->p
, oplen
) == 0 && oplen
> bestLen
) {
6427 if (bestIdx
== -1) return JIM_ERR
;
6429 pc
->tend
= pc
->p
+ bestLen
- 1;
6430 pc
->p
+= bestLen
; pc
->len
-= bestLen
;
6431 pc
->tline
= pc
->linenr
;
6432 pc
->tt
= JIM_TT_EXPR_OPERATOR
;
6436 struct Jim_ExprOperator
*JimExprOperatorInfo(const char *opname
)
6439 for (i
= 0; i
< (signed)JIM_EXPR_OPERATORS_NUM
; i
++)
6440 if (Jim_ExprOperators
[i
].name
&&
6441 strcmp(opname
, Jim_ExprOperators
[i
].name
) == 0)
6442 return &Jim_ExprOperators
[i
];
6446 struct Jim_ExprOperator
*JimExprOperatorInfoByOpcode(int opcode
)
6449 for (i
= 0; i
< (signed)JIM_EXPR_OPERATORS_NUM
; i
++)
6450 if (Jim_ExprOperators
[i
].opcode
== opcode
)
6451 return &Jim_ExprOperators
[i
];
6455 /* -----------------------------------------------------------------------------
6457 * ---------------------------------------------------------------------------*/
6458 static void FreeExprInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
6459 static void DupExprInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
);
6460 static int SetExprFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
);
6462 static Jim_ObjType exprObjType
= {
6464 FreeExprInternalRep
,
6467 JIM_TYPE_REFERENCES
,
6470 /* Expr bytecode structure */
6471 typedef struct ExprByteCode
{
6472 int *opcode
; /* Integer array of opcodes. */
6473 Jim_Obj
**obj
; /* Array of associated Jim Objects. */
6474 int len
; /* Bytecode length */
6475 int inUse
; /* Used for sharing. */
6478 void FreeExprInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
6481 ExprByteCode
*expr
= (void*) objPtr
->internalRep
.ptr
;
6484 if (expr
->inUse
!= 0) return;
6485 for (i
= 0; i
< expr
->len
; i
++)
6486 Jim_DecrRefCount(interp
, expr
->obj
[i
]);
6487 Jim_Free(expr
->opcode
);
6488 Jim_Free(expr
->obj
);
6492 void DupExprInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
)
6494 JIM_NOTUSED(interp
);
6495 JIM_NOTUSED(srcPtr
);
6497 /* Just returns an simple string. */
6498 dupPtr
->typePtr
= NULL
;
6501 /* Add a new instruction to an expression bytecode structure. */
6502 static void ExprObjAddInstr(Jim_Interp
*interp
, ExprByteCode
*expr
,
6503 int opcode
, char *str
, int len
)
6505 expr
->opcode
= Jim_Realloc(expr
->opcode
, sizeof(int)*(expr
->len
+1));
6506 expr
->obj
= Jim_Realloc(expr
->obj
, sizeof(Jim_Obj
*)*(expr
->len
+1));
6507 expr
->opcode
[expr
->len
] = opcode
;
6508 expr
->obj
[expr
->len
] = Jim_NewStringObjNoAlloc(interp
, str
, len
);
6509 Jim_IncrRefCount(expr
->obj
[expr
->len
]);
6513 /* Check if an expr program looks correct. */
6514 static int ExprCheckCorrectness(ExprByteCode
*expr
)
6519 /* Try to check if there are stack underflows,
6520 * and make sure at the end of the program there is
6521 * a single result on the stack. */
6522 for (i
= 0; i
< expr
->len
; i
++) {
6523 switch(expr
->opcode
[i
]) {
6524 case JIM_EXPROP_NUMBER
:
6525 case JIM_EXPROP_STRING
:
6526 case JIM_EXPROP_SUBST
:
6527 case JIM_EXPROP_VARIABLE
:
6528 case JIM_EXPROP_DICTSUGAR
:
6529 case JIM_EXPROP_COMMAND
:
6532 case JIM_EXPROP_NOT
:
6533 case JIM_EXPROP_BITNOT
:
6534 case JIM_EXPROP_UNARYMINUS
:
6535 case JIM_EXPROP_UNARYPLUS
:
6536 /* Unary operations */
6537 if (stacklen
< 1) return JIM_ERR
;
6539 case JIM_EXPROP_ADD
:
6540 case JIM_EXPROP_SUB
:
6541 case JIM_EXPROP_MUL
:
6542 case JIM_EXPROP_DIV
:
6543 case JIM_EXPROP_MOD
:
6546 case JIM_EXPROP_LTE
:
6547 case JIM_EXPROP_GTE
:
6548 case JIM_EXPROP_ROTL
:
6549 case JIM_EXPROP_ROTR
:
6550 case JIM_EXPROP_LSHIFT
:
6551 case JIM_EXPROP_RSHIFT
:
6552 case JIM_EXPROP_NUMEQ
:
6553 case JIM_EXPROP_NUMNE
:
6554 case JIM_EXPROP_STREQ
:
6555 case JIM_EXPROP_STRNE
:
6556 case JIM_EXPROP_BITAND
:
6557 case JIM_EXPROP_BITXOR
:
6558 case JIM_EXPROP_BITOR
:
6559 case JIM_EXPROP_LOGICAND
:
6560 case JIM_EXPROP_LOGICOR
:
6561 case JIM_EXPROP_POW
:
6562 /* binary operations */
6563 if (stacklen
< 2) return JIM_ERR
;
6567 Jim_Panic(NULL
,"Default opcode reached ExprCheckCorrectness");
6571 if (stacklen
!= 1) return JIM_ERR
;
6575 static void ExprShareLiterals(Jim_Interp
*interp
, ExprByteCode
*expr
,
6576 ScriptObj
*topLevelScript
)
6581 for (i
= 0; i
< expr
->len
; i
++) {
6582 Jim_Obj
*foundObjPtr
;
6584 if (expr
->obj
[i
] == NULL
) continue;
6585 foundObjPtr
= ScriptSearchLiteral(interp
, topLevelScript
,
6586 NULL
, expr
->obj
[i
]);
6587 if (foundObjPtr
!= NULL
) {
6588 Jim_IncrRefCount(foundObjPtr
);
6589 Jim_DecrRefCount(interp
, expr
->obj
[i
]);
6590 expr
->obj
[i
] = foundObjPtr
;
6595 /* This procedure converts every occurrence of || and && opereators
6596 * in lazy unary versions.
6598 * a b || is converted into:
6600 * a <offset> |L b |R
6602 * a b && is converted into:
6604 * a <offset> &L b &R
6606 * "|L" checks if 'a' is true:
6607 * 1) if it is true pushes 1 and skips <offset> istructions to reach
6608 * the opcode just after |R.
6609 * 2) if it is false does nothing.
6610 * "|R" checks if 'b' is true:
6611 * 1) if it is true pushes 1, otherwise pushes 0.
6613 * "&L" checks if 'a' is true:
6614 * 1) if it is true does nothing.
6615 * 2) If it is false pushes 0 and skips <offset> istructions to reach
6616 * the opcode just after &R
6617 * "&R" checks if 'a' is true:
6618 * if it is true pushes 1, otherwise pushes 0.
6620 static void ExprMakeLazy(Jim_Interp
*interp
, ExprByteCode
*expr
)
6623 int index
= -1, leftindex
, arity
, i
, offset
;
6624 Jim_ExprOperator
*op
;
6626 /* Search for || or && */
6627 for (i
= 0; i
< expr
->len
; i
++) {
6628 if (expr
->opcode
[i
] == JIM_EXPROP_LOGICAND
||
6629 expr
->opcode
[i
] == JIM_EXPROP_LOGICOR
) {
6634 if (index
== -1) return;
6635 /* Search for the end of the first operator */
6636 leftindex
= index
-1;
6639 switch(expr
->opcode
[leftindex
]) {
6640 case JIM_EXPROP_NUMBER
:
6641 case JIM_EXPROP_COMMAND
:
6642 case JIM_EXPROP_VARIABLE
:
6643 case JIM_EXPROP_DICTSUGAR
:
6644 case JIM_EXPROP_SUBST
:
6645 case JIM_EXPROP_STRING
:
6648 op
= JimExprOperatorInfoByOpcode(expr
->opcode
[leftindex
]);
6650 Jim_Panic(interp
,"Default reached in ExprMakeLazy()");
6659 expr
->opcode
= Jim_Realloc(expr
->opcode
, sizeof(int)*(expr
->len
+2));
6660 expr
->obj
= Jim_Realloc(expr
->obj
, sizeof(Jim_Obj
*)*(expr
->len
+2));
6661 memmove(&expr
->opcode
[leftindex
+2], &expr
->opcode
[leftindex
],
6662 sizeof(int)*(expr
->len
-leftindex
));
6663 memmove(&expr
->obj
[leftindex
+2], &expr
->obj
[leftindex
],
6664 sizeof(Jim_Obj
*)*(expr
->len
-leftindex
));
6667 offset
= (index
-leftindex
)-1;
6668 Jim_DecrRefCount(interp
, expr
->obj
[index
]);
6669 if (expr
->opcode
[index
] == JIM_EXPROP_LOGICAND
) {
6670 expr
->opcode
[leftindex
+1] = JIM_EXPROP_LOGICAND_LEFT
;
6671 expr
->opcode
[index
] = JIM_EXPROP_LOGICAND_RIGHT
;
6672 expr
->obj
[leftindex
+1] = Jim_NewStringObj(interp
, "&L", -1);
6673 expr
->obj
[index
] = Jim_NewStringObj(interp
, "&R", -1);
6675 expr
->opcode
[leftindex
+1] = JIM_EXPROP_LOGICOR_LEFT
;
6676 expr
->opcode
[index
] = JIM_EXPROP_LOGICOR_RIGHT
;
6677 expr
->obj
[leftindex
+1] = Jim_NewStringObj(interp
, "|L", -1);
6678 expr
->obj
[index
] = Jim_NewStringObj(interp
, "|R", -1);
6680 expr
->opcode
[leftindex
] = JIM_EXPROP_NUMBER
;
6681 expr
->obj
[leftindex
] = Jim_NewIntObj(interp
, offset
);
6682 Jim_IncrRefCount(expr
->obj
[index
]);
6683 Jim_IncrRefCount(expr
->obj
[leftindex
]);
6684 Jim_IncrRefCount(expr
->obj
[leftindex
+1]);
6688 /* This method takes the string representation of an expression
6689 * and generates a program for the Expr's stack-based VM. */
6690 int SetExprFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
)
6693 const char *exprText
= Jim_GetString(objPtr
, &exprTextLen
);
6694 struct JimParserCtx parser
;
6695 int i
, shareLiterals
;
6696 ExprByteCode
*expr
= Jim_Alloc(sizeof(*expr
));
6698 Jim_ExprOperator
*op
;
6700 /* Perform literal sharing with the current procedure
6701 * running only if this expression appears to be not generated
6703 shareLiterals
= objPtr
->typePtr
== &sourceObjType
;
6705 expr
->opcode
= NULL
;
6710 Jim_InitStack(&stack
);
6711 JimParserInit(&parser
, exprText
, exprTextLen
, 1);
6712 while(!JimParserEof(&parser
)) {
6716 if (JimParseExpression(&parser
) != JIM_OK
) {
6717 Jim_SetResultString(interp
, "Syntax error in expression", -1);
6720 token
= JimParserGetToken(&parser
, &len
, &type
, NULL
);
6721 if (type
== JIM_TT_EOL
) {
6727 ExprObjAddInstr(interp
, expr
, JIM_EXPROP_STRING
, token
, len
);
6730 ExprObjAddInstr(interp
, expr
, JIM_EXPROP_SUBST
, token
, len
);
6733 ExprObjAddInstr(interp
, expr
, JIM_EXPROP_VARIABLE
, token
, len
);
6735 case JIM_TT_DICTSUGAR
:
6736 ExprObjAddInstr(interp
, expr
, JIM_EXPROP_DICTSUGAR
, token
, len
);
6739 ExprObjAddInstr(interp
, expr
, JIM_EXPROP_COMMAND
, token
, len
);
6741 case JIM_TT_EXPR_NUMBER
:
6742 ExprObjAddInstr(interp
, expr
, JIM_EXPROP_NUMBER
, token
, len
);
6744 case JIM_TT_EXPR_OPERATOR
:
6745 op
= JimExprOperatorInfo(token
);
6747 Jim_ExprOperator
*stackTopOp
;
6749 if (Jim_StackPeek(&stack
) != NULL
) {
6750 stackTopOp
= JimExprOperatorInfo(Jim_StackPeek(&stack
));
6754 if (Jim_StackLen(&stack
) && op
->arity
!= 1 &&
6755 stackTopOp
&& stackTopOp
->precedence
>= op
->precedence
)
6757 ExprObjAddInstr(interp
, expr
, stackTopOp
->opcode
,
6758 Jim_StackPeek(&stack
), -1);
6759 Jim_StackPop(&stack
);
6764 Jim_StackPush(&stack
, token
);
6766 case JIM_TT_SUBEXPR_START
:
6767 Jim_StackPush(&stack
, Jim_StrDup("("));
6770 case JIM_TT_SUBEXPR_END
:
6773 while(Jim_StackLen(&stack
)) {
6774 char *opstr
= Jim_StackPop(&stack
);
6775 if (!strcmp(opstr
, "(")) {
6780 op
= JimExprOperatorInfo(opstr
);
6781 ExprObjAddInstr(interp
, expr
, op
->opcode
, opstr
, -1);
6784 Jim_SetResultString(interp
,
6785 "Unexpected close parenthesis", -1);
6792 Jim_Panic(interp
,"Default reached in SetExprFromAny()");
6796 while (Jim_StackLen(&stack
)) {
6797 char *opstr
= Jim_StackPop(&stack
);
6798 op
= JimExprOperatorInfo(opstr
);
6799 if (op
== NULL
&& !strcmp(opstr
, "(")) {
6801 Jim_SetResultString(interp
, "Missing close parenthesis", -1);
6804 ExprObjAddInstr(interp
, expr
, op
->opcode
, opstr
, -1);
6806 /* Check program correctness. */
6807 if (ExprCheckCorrectness(expr
) != JIM_OK
) {
6808 Jim_SetResultString(interp
, "Invalid expression", -1);
6812 /* Free the stack used for the compilation. */
6813 Jim_FreeStackElements(&stack
, Jim_Free
);
6814 Jim_FreeStack(&stack
);
6816 /* Convert || and && operators in unary |L |R and &L &R for lazyness */
6817 ExprMakeLazy(interp
, expr
);
6819 /* Perform literal sharing */
6820 if (shareLiterals
&& interp
->framePtr
->procBodyObjPtr
) {
6821 Jim_Obj
*bodyObjPtr
= interp
->framePtr
->procBodyObjPtr
;
6822 if (bodyObjPtr
->typePtr
== &scriptObjType
) {
6823 ScriptObj
*bodyScript
= bodyObjPtr
->internalRep
.ptr
;
6824 ExprShareLiterals(interp
, expr
, bodyScript
);
6828 /* Free the old internal rep and set the new one. */
6829 Jim_FreeIntRep(interp
, objPtr
);
6830 Jim_SetIntRepPtr(objPtr
, expr
);
6831 objPtr
->typePtr
= &exprObjType
;
6834 err
: /* we jump here on syntax/compile errors. */
6835 Jim_FreeStackElements(&stack
, Jim_Free
);
6836 Jim_FreeStack(&stack
);
6837 Jim_Free(expr
->opcode
);
6838 for (i
= 0; i
< expr
->len
; i
++) {
6839 Jim_DecrRefCount(interp
,expr
->obj
[i
]);
6841 Jim_Free(expr
->obj
);
6846 ExprByteCode
*Jim_GetExpression(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
6848 if (objPtr
->typePtr
!= &exprObjType
) {
6849 if (SetExprFromAny(interp
, objPtr
) != JIM_OK
)
6852 return (ExprByteCode
*) Jim_GetIntRepPtr(objPtr
);
6855 /* -----------------------------------------------------------------------------
6856 * Expressions evaluation.
6857 * Jim uses a specialized stack-based virtual machine for expressions,
6858 * that takes advantage of the fact that expr's operators
6859 * can't be redefined.
6861 * Jim_EvalExpression() uses the bytecode compiled by
6862 * SetExprFromAny() method of the "expression" object.
6864 * On success a Tcl Object containing the result of the evaluation
6865 * is stored into expResultPtrPtr (having refcount of 1), and JIM_OK is
6867 * On error the function returns a retcode != to JIM_OK and set a suitable
6868 * error on the interp.
6869 * ---------------------------------------------------------------------------*/
6870 #define JIM_EE_STATICSTACK_LEN 10
6872 int Jim_EvalExpression(Jim_Interp
*interp
, Jim_Obj
*exprObjPtr
,
6873 Jim_Obj
**exprResultPtrPtr
)
6876 Jim_Obj
**stack
, *staticStack
[JIM_EE_STATICSTACK_LEN
];
6877 int stacklen
= 0, i
, error
= 0, errRetCode
= JIM_ERR
;
6879 Jim_IncrRefCount(exprObjPtr
);
6880 expr
= Jim_GetExpression(interp
, exprObjPtr
);
6882 Jim_DecrRefCount(interp
, exprObjPtr
);
6883 return JIM_ERR
; /* error in expression. */
6885 /* In order to avoid that the internal repr gets freed due to
6886 * shimmering of the exprObjPtr's object, we make the internal rep
6890 /* The stack-based expr VM itself */
6892 /* Stack allocation. Expr programs have the feature that
6893 * a program of length N can't require a stack longer than
6895 if (expr
->len
> JIM_EE_STATICSTACK_LEN
)
6896 stack
= Jim_Alloc(sizeof(Jim_Obj
*)*expr
->len
);
6898 stack
= staticStack
;
6900 /* Execute every istruction */
6901 for (i
= 0; i
< expr
->len
; i
++) {
6902 Jim_Obj
*A
, *B
, *objPtr
;
6903 jim_wide wA
, wB
, wC
;
6905 const char *sA
, *sB
;
6906 int Alen
, Blen
, retcode
;
6907 int opcode
= expr
->opcode
[i
];
6909 if (opcode
== JIM_EXPROP_NUMBER
|| opcode
== JIM_EXPROP_STRING
) {
6910 stack
[stacklen
++] = expr
->obj
[i
];
6911 Jim_IncrRefCount(expr
->obj
[i
]);
6912 } else if (opcode
== JIM_EXPROP_VARIABLE
) {
6913 objPtr
= Jim_GetVariable(interp
, expr
->obj
[i
], JIM_ERRMSG
);
6914 if (objPtr
== NULL
) {
6918 stack
[stacklen
++] = objPtr
;
6919 Jim_IncrRefCount(objPtr
);
6920 } else if (opcode
== JIM_EXPROP_SUBST
) {
6921 if ((retcode
= Jim_SubstObj(interp
, expr
->obj
[i
],
6922 &objPtr
, JIM_NONE
)) != JIM_OK
)
6925 errRetCode
= retcode
;
6928 stack
[stacklen
++] = objPtr
;
6929 Jim_IncrRefCount(objPtr
);
6930 } else if (opcode
== JIM_EXPROP_DICTSUGAR
) {
6931 objPtr
= Jim_ExpandDictSugar(interp
, expr
->obj
[i
]);
6932 if (objPtr
== NULL
) {
6936 stack
[stacklen
++] = objPtr
;
6937 Jim_IncrRefCount(objPtr
);
6938 } else if (opcode
== JIM_EXPROP_COMMAND
) {
6939 if ((retcode
= Jim_EvalObj(interp
, expr
->obj
[i
])) != JIM_OK
) {
6941 errRetCode
= retcode
;
6944 stack
[stacklen
++] = interp
->result
;
6945 Jim_IncrRefCount(interp
->result
);
6946 } else if (opcode
>= JIM_EXPROP_BINARY_NUM_FIRST
&&
6947 opcode
<= JIM_EXPROP_BINARY_NUM_LAST
)
6949 /* Note that there isn't to increment the
6950 * refcount of objects. the references are moved
6951 * from stack to A and B. */
6952 B
= stack
[--stacklen
];
6953 A
= stack
[--stacklen
];
6955 /* --- Integer --- */
6956 if ((A
->typePtr
== &doubleObjType
&& !A
->bytes
) ||
6957 (B
->typePtr
== &doubleObjType
&& !B
->bytes
) ||
6958 JimGetWideNoErr(interp
, A
, &wA
) != JIM_OK
||
6959 JimGetWideNoErr(interp
, B
, &wB
) != JIM_OK
) {
6962 Jim_DecrRefCount(interp
, A
);
6963 Jim_DecrRefCount(interp
, B
);
6964 switch(expr
->opcode
[i
]) {
6965 case JIM_EXPROP_ADD
: wC
= wA
+wB
; break;
6966 case JIM_EXPROP_SUB
: wC
= wA
-wB
; break;
6967 case JIM_EXPROP_MUL
: wC
= wA
*wB
; break;
6968 case JIM_EXPROP_LT
: wC
= wA
<wB
; break;
6969 case JIM_EXPROP_GT
: wC
= wA
>wB
; break;
6970 case JIM_EXPROP_LTE
: wC
= wA
<=wB
; break;
6971 case JIM_EXPROP_GTE
: wC
= wA
>=wB
; break;
6972 case JIM_EXPROP_LSHIFT
: wC
= wA
<<wB
; break;
6973 case JIM_EXPROP_RSHIFT
: wC
= wA
>>wB
; break;
6974 case JIM_EXPROP_NUMEQ
: wC
= wA
==wB
; break;
6975 case JIM_EXPROP_NUMNE
: wC
= wA
!=wB
; break;
6976 case JIM_EXPROP_BITAND
: wC
= wA
&wB
; break;
6977 case JIM_EXPROP_BITXOR
: wC
= wA
^wB
; break;
6978 case JIM_EXPROP_BITOR
: wC
= wA
|wB
; break;
6979 case JIM_EXPROP_POW
: wC
= JimPowWide(wA
,wB
); break;
6980 case JIM_EXPROP_LOGICAND_LEFT
:
6988 case JIM_EXPROP_LOGICOR_LEFT
:
6996 case JIM_EXPROP_DIV
:
6997 if (wB
== 0) goto divbyzero
;
7000 case JIM_EXPROP_MOD
:
7001 if (wB
== 0) goto divbyzero
;
7004 case JIM_EXPROP_ROTL
: {
7005 /* uint32_t would be better. But not everyone has inttypes.h?*/
7006 unsigned long uA
= (unsigned long)wA
;
7008 wC
= _rotl(uA
,(unsigned long)wB
);
7010 const unsigned int S
= sizeof(unsigned long) * 8;
7011 wC
= (unsigned long)((uA
<<wB
)|(uA
>>(S
-wB
)));
7015 case JIM_EXPROP_ROTR
: {
7016 unsigned long uA
= (unsigned long)wA
;
7018 wC
= _rotr(uA
,(unsigned long)wB
);
7020 const unsigned int S
= sizeof(unsigned long) * 8;
7021 wC
= (unsigned long)((uA
>>wB
)|(uA
<<(S
-wB
)));
7027 wC
= 0; /* avoid gcc warning */
7030 stack
[stacklen
] = Jim_NewIntObj(interp
, wC
);
7031 Jim_IncrRefCount(stack
[stacklen
]);
7035 /* --- Double --- */
7036 if (Jim_GetDouble(interp
, A
, &dA
) != JIM_OK
||
7037 Jim_GetDouble(interp
, B
, &dB
) != JIM_OK
) {
7039 /* Hmmm! For compatibility, maybe convert != and == into ne and eq */
7040 if (expr
->opcode
[i
] == JIM_EXPROP_NUMNE
) {
7041 opcode
= JIM_EXPROP_STRNE
;
7042 goto retry_as_string
;
7044 else if (expr
->opcode
[i
] == JIM_EXPROP_NUMEQ
) {
7045 opcode
= JIM_EXPROP_STREQ
;
7046 goto retry_as_string
;
7048 Jim_DecrRefCount(interp
, A
);
7049 Jim_DecrRefCount(interp
, B
);
7053 Jim_DecrRefCount(interp
, A
);
7054 Jim_DecrRefCount(interp
, B
);
7055 switch(expr
->opcode
[i
]) {
7056 case JIM_EXPROP_ROTL
:
7057 case JIM_EXPROP_ROTR
:
7058 case JIM_EXPROP_LSHIFT
:
7059 case JIM_EXPROP_RSHIFT
:
7060 case JIM_EXPROP_BITAND
:
7061 case JIM_EXPROP_BITXOR
:
7062 case JIM_EXPROP_BITOR
:
7063 case JIM_EXPROP_MOD
:
7064 case JIM_EXPROP_POW
:
7065 Jim_SetResultString(interp
,
7066 "Got floating-point value where integer was expected", -1);
7070 case JIM_EXPROP_ADD
: dC
= dA
+dB
; break;
7071 case JIM_EXPROP_SUB
: dC
= dA
-dB
; break;
7072 case JIM_EXPROP_MUL
: dC
= dA
*dB
; break;
7073 case JIM_EXPROP_LT
: dC
= dA
<dB
; break;
7074 case JIM_EXPROP_GT
: dC
= dA
>dB
; break;
7075 case JIM_EXPROP_LTE
: dC
= dA
<=dB
; break;
7076 case JIM_EXPROP_GTE
: dC
= dA
>=dB
; break;
7077 case JIM_EXPROP_NUMEQ
: dC
= dA
==dB
; break;
7078 case JIM_EXPROP_NUMNE
: dC
= dA
!=dB
; break;
7079 case JIM_EXPROP_LOGICAND_LEFT
:
7087 case JIM_EXPROP_LOGICOR_LEFT
:
7095 case JIM_EXPROP_DIV
:
7096 if (dB
== 0) goto divbyzero
;
7100 dC
= 0; /* avoid gcc warning */
7103 stack
[stacklen
] = Jim_NewDoubleObj(interp
, dC
);
7104 Jim_IncrRefCount(stack
[stacklen
]);
7106 } else if (opcode
== JIM_EXPROP_STREQ
|| opcode
== JIM_EXPROP_STRNE
) {
7107 B
= stack
[--stacklen
];
7108 A
= stack
[--stacklen
];
7110 sA
= Jim_GetString(A
, &Alen
);
7111 sB
= Jim_GetString(B
, &Blen
);
7113 case JIM_EXPROP_STREQ
:
7114 if (Alen
== Blen
&& memcmp(sA
, sB
, Alen
) ==0)
7119 case JIM_EXPROP_STRNE
:
7120 if (Alen
!= Blen
|| memcmp(sA
, sB
, Alen
) != 0)
7126 wC
= 0; /* avoid gcc warning */
7129 Jim_DecrRefCount(interp
, A
);
7130 Jim_DecrRefCount(interp
, B
);
7131 stack
[stacklen
] = Jim_NewIntObj(interp
, wC
);
7132 Jim_IncrRefCount(stack
[stacklen
]);
7134 } else if (opcode
== JIM_EXPROP_NOT
||
7135 opcode
== JIM_EXPROP_BITNOT
||
7136 opcode
== JIM_EXPROP_LOGICAND_RIGHT
||
7137 opcode
== JIM_EXPROP_LOGICOR_RIGHT
) {
7138 /* Note that there isn't to increment the
7139 * refcount of objects. the references are moved
7140 * from stack to A and B. */
7141 A
= stack
[--stacklen
];
7143 /* --- Integer --- */
7144 if ((A
->typePtr
== &doubleObjType
&& !A
->bytes
) ||
7145 JimGetWideNoErr(interp
, A
, &wA
) != JIM_OK
) {
7146 goto trydouble_unary
;
7148 Jim_DecrRefCount(interp
, A
);
7149 switch(expr
->opcode
[i
]) {
7150 case JIM_EXPROP_NOT
: wC
= !wA
; break;
7151 case JIM_EXPROP_BITNOT
: wC
= ~wA
; break;
7152 case JIM_EXPROP_LOGICAND_RIGHT
:
7153 case JIM_EXPROP_LOGICOR_RIGHT
: wC
= (wA
!= 0); break;
7155 wC
= 0; /* avoid gcc warning */
7158 stack
[stacklen
] = Jim_NewIntObj(interp
, wC
);
7159 Jim_IncrRefCount(stack
[stacklen
]);
7163 /* --- Double --- */
7164 if (Jim_GetDouble(interp
, A
, &dA
) != JIM_OK
) {
7165 Jim_DecrRefCount(interp
, A
);
7169 Jim_DecrRefCount(interp
, A
);
7170 switch(expr
->opcode
[i
]) {
7171 case JIM_EXPROP_NOT
: dC
= !dA
; break;
7172 case JIM_EXPROP_LOGICAND_RIGHT
:
7173 case JIM_EXPROP_LOGICOR_RIGHT
: dC
= (dA
!= 0); break;
7174 case JIM_EXPROP_BITNOT
:
7175 Jim_SetResultString(interp
,
7176 "Got floating-point value where integer was expected", -1);
7181 dC
= 0; /* avoid gcc warning */
7184 stack
[stacklen
] = Jim_NewDoubleObj(interp
, dC
);
7185 Jim_IncrRefCount(stack
[stacklen
]);
7188 Jim_Panic(interp
,"Unknown opcode in Jim_EvalExpression");
7192 /* There is no need to decerement the inUse field because
7193 * this reference is transfered back into the exprObjPtr. */
7194 Jim_FreeIntRep(interp
, exprObjPtr
);
7195 exprObjPtr
->typePtr
= &exprObjType
;
7196 Jim_SetIntRepPtr(exprObjPtr
, expr
);
7197 Jim_DecrRefCount(interp
, exprObjPtr
);
7199 *exprResultPtrPtr
= stack
[0];
7200 Jim_IncrRefCount(stack
[0]);
7201 errRetCode
= JIM_OK
;
7203 for (i
= 0; i
< stacklen
; i
++) {
7204 Jim_DecrRefCount(interp
, stack
[i
]);
7206 if (stack
!= staticStack
)
7211 Jim_SetResultString(interp
, "Division by zero", -1);
7215 int Jim_GetBoolFromExpr(Jim_Interp
*interp
, Jim_Obj
*exprObjPtr
, int *boolPtr
)
7220 Jim_Obj
*exprResultPtr
;
7222 retcode
= Jim_EvalExpression(interp
, exprObjPtr
, &exprResultPtr
);
7223 if (retcode
!= JIM_OK
)
7225 if (JimGetWideNoErr(interp
, exprResultPtr
, &wideValue
) != JIM_OK
) {
7226 if (Jim_GetDouble(interp
, exprResultPtr
, &doubleValue
) != JIM_OK
)
7228 Jim_DecrRefCount(interp
, exprResultPtr
);
7231 Jim_DecrRefCount(interp
, exprResultPtr
);
7232 *boolPtr
= doubleValue
!= 0;
7236 Jim_DecrRefCount(interp
, exprResultPtr
);
7237 *boolPtr
= wideValue
!= 0;
7241 /* -----------------------------------------------------------------------------
7242 * ScanFormat String Object
7243 * ---------------------------------------------------------------------------*/
7245 /* This Jim_Obj will held a parsed representation of a format string passed to
7246 * the Jim_ScanString command. For error diagnostics, the scanformat string has
7247 * to be parsed in its entirely first and then, if correct, can be used for
7248 * scanning. To avoid endless re-parsing, the parsed representation will be
7249 * stored in an internal representation and re-used for performance reason. */
7251 /* A ScanFmtPartDescr will held the information of /one/ part of the whole
7252 * scanformat string. This part will later be used to extract information
7253 * out from the string to be parsed by Jim_ScanString */
7255 typedef struct ScanFmtPartDescr
{
7256 char type
; /* Type of conversion (e.g. c, d, f) */
7257 char modifier
; /* Modify type (e.g. l - long, h - short */
7258 size_t width
; /* Maximal width of input to be converted */
7259 int pos
; /* -1 - no assign, 0 - natural pos, >0 - XPG3 pos */
7260 char *arg
; /* Specification of a CHARSET conversion */
7261 char *prefix
; /* Prefix to be scanned literally before conversion */
7264 /* The ScanFmtStringObj will held the internal representation of a scanformat
7265 * string parsed and separated in part descriptions. Furthermore it contains
7266 * the original string representation of the scanformat string to allow for
7267 * fast update of the Jim_Obj's string representation part.
7269 * As add-on the internal object representation add some scratch pad area
7270 * for usage by Jim_ScanString to avoid endless allocating and freeing of
7271 * memory for purpose of string scanning.
7273 * The error member points to a static allocated string in case of a mal-
7274 * formed scanformat string or it contains '0' (NULL) in case of a valid
7275 * parse representation.
7277 * The whole memory of the internal representation is allocated as a single
7278 * area of memory that will be internally separated. So freeing and duplicating
7279 * of such an object is cheap */
7281 typedef struct ScanFmtStringObj
{
7282 jim_wide size
; /* Size of internal repr in bytes */
7283 char *stringRep
; /* Original string representation */
7284 size_t count
; /* Number of ScanFmtPartDescr contained */
7285 size_t convCount
; /* Number of conversions that will assign */
7286 size_t maxPos
; /* Max position index if XPG3 is used */
7287 const char *error
; /* Ptr to error text (NULL if no error */
7288 char *scratch
; /* Some scratch pad used by Jim_ScanString */
7289 ScanFmtPartDescr descr
[1]; /* The vector of partial descriptions */
7293 static void FreeScanFmtInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
7294 static void DupScanFmtInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
);
7295 static void UpdateStringOfScanFmt(Jim_Obj
*objPtr
);
7297 static Jim_ObjType scanFmtStringObjType
= {
7299 FreeScanFmtInternalRep
,
7300 DupScanFmtInternalRep
,
7301 UpdateStringOfScanFmt
,
7305 void FreeScanFmtInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
7307 JIM_NOTUSED(interp
);
7308 Jim_Free((char*)objPtr
->internalRep
.ptr
);
7309 objPtr
->internalRep
.ptr
= 0;
7312 void DupScanFmtInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
)
7314 size_t size
= (size_t)((ScanFmtStringObj
*)srcPtr
->internalRep
.ptr
)->size
;
7315 ScanFmtStringObj
*newVec
= (ScanFmtStringObj
*)Jim_Alloc(size
);
7317 JIM_NOTUSED(interp
);
7318 memcpy(newVec
, srcPtr
->internalRep
.ptr
, size
);
7319 dupPtr
->internalRep
.ptr
= newVec
;
7320 dupPtr
->typePtr
= &scanFmtStringObjType
;
7323 void UpdateStringOfScanFmt(Jim_Obj
*objPtr
)
7325 char *bytes
= ((ScanFmtStringObj
*)objPtr
->internalRep
.ptr
)->stringRep
;
7327 objPtr
->bytes
= Jim_StrDup(bytes
);
7328 objPtr
->length
= strlen(bytes
);
7331 /* SetScanFmtFromAny will parse a given string and create the internal
7332 * representation of the format specification. In case of an error
7333 * the error data member of the internal representation will be set
7334 * to an descriptive error text and the function will be left with
7335 * JIM_ERR to indicate unsucessful parsing (aka. malformed scanformat
7338 static int SetScanFmtFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
7340 ScanFmtStringObj
*fmtObj
;
7342 int maxCount
, i
, approxSize
, lastPos
= -1;
7343 const char *fmt
= objPtr
->bytes
;
7344 int maxFmtLen
= objPtr
->length
;
7345 const char *fmtEnd
= fmt
+ maxFmtLen
;
7348 Jim_FreeIntRep(interp
, objPtr
);
7349 /* Count how many conversions could take place maximally */
7350 for (i
=0, maxCount
=0; i
< maxFmtLen
; ++i
)
7353 /* Calculate an approximation of the memory necessary */
7354 approxSize
= sizeof(ScanFmtStringObj
) /* Size of the container */
7355 + (maxCount
+ 1) * sizeof(ScanFmtPartDescr
) /* Size of all partials */
7356 + maxFmtLen
* sizeof(char) + 3 + 1 /* Scratch + "%n" + '\0' */
7357 + maxFmtLen
* sizeof(char) + 1 /* Original stringrep */
7358 + maxFmtLen
* sizeof(char) /* Arg for CHARSETs */
7359 + (maxCount
+1) * sizeof(char) /* '\0' for every partial */
7360 + 1; /* safety byte */
7361 fmtObj
= (ScanFmtStringObj
*)Jim_Alloc(approxSize
);
7362 memset(fmtObj
, 0, approxSize
);
7363 fmtObj
->size
= approxSize
;
7365 fmtObj
->scratch
= (char*)&fmtObj
->descr
[maxCount
+1];
7366 fmtObj
->stringRep
= fmtObj
->scratch
+ maxFmtLen
+ 3 + 1;
7367 memcpy(fmtObj
->stringRep
, fmt
, maxFmtLen
);
7368 buffer
= fmtObj
->stringRep
+ maxFmtLen
+ 1;
7369 objPtr
->internalRep
.ptr
= fmtObj
;
7370 objPtr
->typePtr
= &scanFmtStringObjType
;
7371 for (i
=0, curr
=0; fmt
< fmtEnd
; ++fmt
) {
7373 ScanFmtPartDescr
*descr
= &fmtObj
->descr
[curr
];
7375 descr
->width
= 0; /* Assume width unspecified */
7376 /* Overread and store any "literal" prefix */
7377 if (*fmt
!= '%' || fmt
[1] == '%') {
7379 descr
->prefix
= &buffer
[i
];
7380 for (; fmt
< fmtEnd
; ++fmt
) {
7382 if (fmt
[1] != '%') break;
7389 /* Skip the conversion introducing '%' sign */
7391 /* End reached due to non-conversion literal only? */
7394 descr
->pos
= 0; /* Assume "natural" positioning */
7396 descr
->pos
= -1; /* Okay, conversion will not be assigned */
7399 fmtObj
->convCount
++; /* Otherwise count as assign-conversion */
7400 /* Check if next token is a number (could be width or pos */
7401 if (sscanf(fmt
, "%d%n", &width
, &skip
) == 1) {
7403 /* Was the number a XPG3 position specifier? */
7404 if (descr
->pos
!= -1 && *fmt
== '$') {
7409 /* Look if "natural" postioning and XPG3 one was mixed */
7410 if ((lastPos
== 0 && descr
->pos
> 0)
7411 || (lastPos
> 0 && descr
->pos
== 0)) {
7412 fmtObj
->error
= "cannot mix \"%\" and \"%n$\" conversion specifiers";
7415 /* Look if this position was already used */
7416 for (prev
=0; prev
< curr
; ++prev
) {
7417 if (fmtObj
->descr
[prev
].pos
== -1) continue;
7418 if (fmtObj
->descr
[prev
].pos
== descr
->pos
) {
7419 fmtObj
->error
= "same \"%n$\" conversion specifier "
7420 "used more than once";
7424 /* Try to find a width after the XPG3 specifier */
7425 if (sscanf(fmt
, "%d%n", &width
, &skip
) == 1) {
7426 descr
->width
= width
;
7429 if (descr
->pos
> 0 && (size_t)descr
->pos
> fmtObj
->maxPos
)
7430 fmtObj
->maxPos
= descr
->pos
;
7432 /* Number was not a XPG3, so it has to be a width */
7433 descr
->width
= width
;
7436 /* If positioning mode was undetermined yet, fix this */
7438 lastPos
= descr
->pos
;
7439 /* Handle CHARSET conversion type ... */
7441 int swapped
= 1, beg
= i
, end
, j
;
7443 descr
->arg
= &buffer
[i
];
7445 if (*fmt
== '^') buffer
[i
++] = *fmt
++;
7446 if (*fmt
== ']') buffer
[i
++] = *fmt
++;
7447 while (*fmt
&& *fmt
!= ']') buffer
[i
++] = *fmt
++;
7449 fmtObj
->error
= "unmatched [ in format string";
7454 /* In case a range fence was given "backwards", swap it */
7457 for (j
=beg
+1; j
< end
-1; ++j
) {
7458 if (buffer
[j
] == '-' && buffer
[j
-1] > buffer
[j
+1]) {
7459 char tmp
= buffer
[j
-1];
7460 buffer
[j
-1] = buffer
[j
+1];
7467 /* Remember any valid modifier if given */
7468 if (strchr("hlL", *fmt
) != 0)
7469 descr
->modifier
= tolower((int)*fmt
++);
7472 if (strchr("efgcsndoxui", *fmt
) == 0) {
7473 fmtObj
->error
= "bad scan conversion character";
7475 } else if (*fmt
== 'c' && descr
->width
!= 0) {
7476 fmtObj
->error
= "field width may not be specified in %c "
7479 } else if (*fmt
== 'u' && descr
->modifier
== 'l') {
7480 fmtObj
->error
= "unsigned wide not supported";
7487 if (fmtObj
->convCount
== 0) {
7488 fmtObj
->error
= "no any conversion specifier given";
7494 /* Some accessor macros to allow lowlevel access to fields of internal repr */
7496 #define FormatGetCnvCount(_fo_) \
7497 ((ScanFmtStringObj*)((_fo_)->internalRep.ptr))->convCount
7498 #define FormatGetMaxPos(_fo_) \
7499 ((ScanFmtStringObj*)((_fo_)->internalRep.ptr))->maxPos
7500 #define FormatGetError(_fo_) \
7501 ((ScanFmtStringObj*)((_fo_)->internalRep.ptr))->error
7503 /* Some Bit testing/setting/cleaning routines. For now only used in handling
7504 * charsets ([a-z123]) within scanning. Later on perhaps a base for a
7505 * bitvector implementation in Jim? */
7507 static int JimTestBit(const char *bitvec
, char ch
)
7509 div_t pos
= div(ch
-1, 8);
7510 return bitvec
[pos
.quot
] & (1 << pos
.rem
);
7513 static void JimSetBit(char *bitvec
, char ch
)
7515 div_t pos
= div(ch
-1, 8);
7516 bitvec
[pos
.quot
] |= (1 << pos
.rem
);
7519 #if 0 /* currently not used */
7520 static void JimClearBit(char *bitvec
, char ch
)
7522 div_t pos
= div(ch
-1, 8);
7523 bitvec
[pos
.quot
] &= ~(1 << pos
.rem
);
7527 /* JimScanAString is used to scan an unspecified string that ends with
7528 * next WS, or a string that is specified via a charset. The charset
7529 * is currently implemented in a way to only allow for usage with
7530 * ASCII. Whenever we will switch to UNICODE, another idea has to
7533 * FIXME: Works only with ASCII */
7536 JimScanAString(Jim_Interp
*interp
, const char *sdescr
, const char *str
)
7540 char charset
[256/8+1]; /* A Charset may contain max 256 chars */
7541 char *buffer
= Jim_Alloc(strlen(str
)+1), *anchor
= buffer
;
7543 /* First init charset to nothing or all, depending if a specified
7544 * or an unspecified string has to be parsed */
7545 memset(charset
, (sdescr
? 0 : 255), sizeof(charset
));
7547 /* There was a set description given, that means we are parsing
7548 * a specified string. So we have to build a corresponding
7549 * charset reflecting the description */
7551 /* Should the set be negated at the end? */
7552 if (*sdescr
== '^') {
7556 /* Here '-' is meant literally and not to define a range */
7557 if (*sdescr
== '-') {
7558 JimSetBit(charset
, '-');
7562 if (sdescr
[1] == '-' && sdescr
[2] != 0) {
7563 /* Handle range definitions */
7565 for (i
=sdescr
[0]; i
<= sdescr
[2]; ++i
)
7566 JimSetBit(charset
, (char)i
);
7569 /* Handle verbatim character definitions */
7570 JimSetBit(charset
, *sdescr
++);
7573 /* Negate the charset if there was a NOT given */
7574 for (i
=0; notFlag
&& i
< sizeof(charset
); ++i
)
7575 charset
[i
] = ~charset
[i
];
7577 /* And after all the mess above, the real work begin ... */
7578 while (str
&& *str
) {
7579 if (!sdescr
&& isspace((int)*str
))
7580 break; /* EOS via WS if unspecified */
7581 if (JimTestBit(charset
, *str
)) *buffer
++ = *str
++;
7582 else break; /* EOS via mismatch if specified scanning */
7584 *buffer
= 0; /* Close the string properly ... */
7585 result
= Jim_NewStringObj(interp
, anchor
, -1);
7586 Jim_Free(anchor
); /* ... and free it afer usage */
7590 /* ScanOneEntry will scan one entry out of the string passed as argument.
7591 * It use the sscanf() function for this task. After extracting and
7592 * converting of the value, the count of scanned characters will be
7593 * returned of -1 in case of no conversion tool place and string was
7594 * already scanned thru */
7596 static int ScanOneEntry(Jim_Interp
*interp
, const char *str
, long pos
,
7597 ScanFmtStringObj
*fmtObj
, long index
, Jim_Obj
**valObjPtr
)
7599 # define MAX_SIZE (sizeof(jim_wide) > sizeof(double) \
7600 ? sizeof(jim_wide) \
7602 char buffer
[MAX_SIZE
];
7603 char *value
= buffer
;
7605 const ScanFmtPartDescr
*descr
= &fmtObj
->descr
[index
];
7606 size_t sLen
= strlen(&str
[pos
]), scanned
= 0;
7607 size_t anchor
= pos
;
7610 /* First pessimiticly assume, we will not scan anything :-) */
7612 if (descr
->prefix
) {
7613 /* There was a prefix given before the conversion, skip it and adjust
7614 * the string-to-be-parsed accordingly */
7615 for (i
=0; str
[pos
] && descr
->prefix
[i
]; ++i
) {
7616 /* If prefix require, skip WS */
7617 if (isspace((int)descr
->prefix
[i
]))
7618 while (str
[pos
] && isspace((int)str
[pos
])) ++pos
;
7619 else if (descr
->prefix
[i
] != str
[pos
])
7620 break; /* Prefix do not match here, leave the loop */
7622 ++pos
; /* Prefix matched so far, next round */
7625 return -1; /* All of str consumed: EOF condition */
7626 else if (descr
->prefix
[i
] != 0)
7627 return 0; /* Not whole prefix consumed, no conversion possible */
7629 /* For all but following conversion, skip leading WS */
7630 if (descr
->type
!= 'c' && descr
->type
!= '[' && descr
->type
!= 'n')
7631 while (isspace((int)str
[pos
])) ++pos
;
7632 /* Determine how much skipped/scanned so far */
7633 scanned
= pos
- anchor
;
7634 if (descr
->type
== 'n') {
7635 /* Return pseudo conversion means: how much scanned so far? */
7636 *valObjPtr
= Jim_NewIntObj(interp
, anchor
+ scanned
);
7637 } else if (str
[pos
] == 0) {
7638 /* Cannot scan anything, as str is totally consumed */
7641 /* Processing of conversions follows ... */
7642 if (descr
->width
> 0) {
7643 /* Do not try to scan as fas as possible but only the given width.
7644 * To ensure this, we copy the part that should be scanned. */
7645 size_t tLen
= descr
->width
> sLen
? sLen
: descr
->width
;
7646 tok
= Jim_StrDupLen(&str
[pos
], tLen
);
7648 /* As no width was given, simply refer to the original string */
7651 switch (descr
->type
) {
7653 *valObjPtr
= Jim_NewIntObj(interp
, *tok
);
7656 case 'd': case 'o': case 'x': case 'u': case 'i': {
7659 char *endp
; /* Position where the number finished */
7660 int base
= descr
->type
== 'o' ? 8
7661 : descr
->type
== 'x' ? 16
7662 : descr
->type
== 'i' ? 0
7666 /* Try to scan a number with the given base */
7667 if (descr
->modifier
== 'l')
7669 #ifdef HAVE_LONG_LONG_INT
7670 jwvalue
= JimStrtoll(tok
, &endp
, base
),
7672 jwvalue
= strtol(tok
, &endp
, base
),
7674 memcpy(value
, &jwvalue
, sizeof(jim_wide
));
7678 if (descr
->type
== 'u')
7679 lvalue
= strtoul(tok
, &endp
, base
);
7681 lvalue
= strtol(tok
, &endp
, base
);
7682 memcpy(value
, &lvalue
, sizeof(lvalue
));
7684 /* If scanning failed, and base was undetermined, simply
7685 * put it to 10 and try once more. This should catch the
7686 * case where %i begin to parse a number prefix (e.g.
7687 * '0x' but no further digits follows. This will be
7688 * handled as a ZERO followed by a char 'x' by Tcl */
7689 if (endp
== tok
&& base
== 0) base
= 10;
7693 /* There was some number sucessfully scanned! */
7694 if (descr
->modifier
== 'l')
7695 *valObjPtr
= Jim_NewIntObj(interp
, jwvalue
);
7697 *valObjPtr
= Jim_NewIntObj(interp
, lvalue
);
7698 /* Adjust the number-of-chars scanned so far */
7699 scanned
+= endp
- tok
;
7701 /* Nothing was scanned. We have to determine if this
7702 * happened due to e.g. prefix mismatch or input str
7704 scanned
= *tok
? 0 : -1;
7708 case 's': case '[': {
7709 *valObjPtr
= JimScanAString(interp
, descr
->arg
, tok
);
7710 scanned
+= Jim_Length(*valObjPtr
);
7713 case 'e': case 'f': case 'g': {
7716 double dvalue
= strtod(tok
, &endp
);
7717 memcpy(value
, &dvalue
, sizeof(double));
7719 /* There was some number sucessfully scanned! */
7720 *valObjPtr
= Jim_NewDoubleObj(interp
, dvalue
);
7721 /* Adjust the number-of-chars scanned so far */
7722 scanned
+= endp
- tok
;
7724 /* Nothing was scanned. We have to determine if this
7725 * happened due to e.g. prefix mismatch or input str
7727 scanned
= *tok
? 0 : -1;
7732 /* If a substring was allocated (due to pre-defined width) do not
7733 * forget to free it */
7734 if (tok
!= &str
[pos
])
7735 Jim_Free((char*)tok
);
7740 /* Jim_ScanString is the workhorse of string scanning. It will scan a given
7741 * string and returns all converted (and not ignored) values in a list back
7742 * to the caller. If an error occured, a NULL pointer will be returned */
7744 Jim_Obj
*Jim_ScanString(Jim_Interp
*interp
, Jim_Obj
*strObjPtr
,
7745 Jim_Obj
*fmtObjPtr
, int flags
)
7749 const char *str
= Jim_GetString(strObjPtr
, 0);
7750 Jim_Obj
*resultList
= 0;
7751 Jim_Obj
**resultVec
;
7753 Jim_Obj
*emptyStr
= 0;
7754 ScanFmtStringObj
*fmtObj
;
7756 /* If format specification is not an object, convert it! */
7757 if (fmtObjPtr
->typePtr
!= &scanFmtStringObjType
)
7758 SetScanFmtFromAny(interp
, fmtObjPtr
);
7759 fmtObj
= (ScanFmtStringObj
*)fmtObjPtr
->internalRep
.ptr
;
7760 /* Check if format specification was valid */
7761 if (fmtObj
->error
!= 0) {
7762 if (flags
& JIM_ERRMSG
)
7763 Jim_SetResultString(interp
, fmtObj
->error
, -1);
7766 /* Allocate a new "shared" empty string for all unassigned conversions */
7767 emptyStr
= Jim_NewEmptyStringObj(interp
);
7768 Jim_IncrRefCount(emptyStr
);
7769 /* Create a list and fill it with empty strings up to max specified XPG3 */
7770 resultList
= Jim_NewListObj(interp
, 0, 0);
7771 if (fmtObj
->maxPos
> 0) {
7772 for (i
=0; i
< fmtObj
->maxPos
; ++i
)
7773 Jim_ListAppendElement(interp
, resultList
, emptyStr
);
7774 JimListGetElements(interp
, resultList
, &resultc
, &resultVec
);
7776 /* Now handle every partial format description */
7777 for (i
=0, pos
=0; i
< fmtObj
->count
; ++i
) {
7778 ScanFmtPartDescr
*descr
= &(fmtObj
->descr
[i
]);
7780 /* Only last type may be "literal" w/o conversion - skip it! */
7781 if (descr
->type
== 0) continue;
7782 /* As long as any conversion could be done, we will proceed */
7784 scanned
= ScanOneEntry(interp
, str
, pos
, fmtObj
, i
, &value
);
7785 /* In case our first try results in EOF, we will leave */
7786 if (scanned
== -1 && i
== 0)
7788 /* Advance next pos-to-be-scanned for the amount scanned already */
7790 /* value == 0 means no conversion took place so take empty string */
7792 value
= Jim_NewEmptyStringObj(interp
);
7793 /* If value is a non-assignable one, skip it */
7794 if (descr
->pos
== -1) {
7795 Jim_FreeNewObj(interp
, value
);
7796 } else if (descr
->pos
== 0)
7797 /* Otherwise append it to the result list if no XPG3 was given */
7798 Jim_ListAppendElement(interp
, resultList
, value
);
7799 else if (resultVec
[descr
->pos
-1] == emptyStr
) {
7800 /* But due to given XPG3, put the value into the corr. slot */
7801 Jim_DecrRefCount(interp
, resultVec
[descr
->pos
-1]);
7802 Jim_IncrRefCount(value
);
7803 resultVec
[descr
->pos
-1] = value
;
7805 /* Otherwise, the slot was already used - free obj and ERROR */
7806 Jim_FreeNewObj(interp
, value
);
7810 Jim_DecrRefCount(interp
, emptyStr
);
7813 Jim_DecrRefCount(interp
, emptyStr
);
7814 Jim_FreeNewObj(interp
, resultList
);
7815 return (Jim_Obj
*)EOF
;
7817 Jim_DecrRefCount(interp
, emptyStr
);
7818 Jim_FreeNewObj(interp
, resultList
);
7822 /* -----------------------------------------------------------------------------
7823 * Pseudo Random Number Generation
7824 * ---------------------------------------------------------------------------*/
7825 static void JimPrngSeed(Jim_Interp
*interp
, const unsigned char *seed
,
7828 /* Initialize the sbox with the numbers from 0 to 255 */
7829 static void JimPrngInit(Jim_Interp
*interp
)
7832 unsigned int seed
[256];
7834 interp
->prngState
= Jim_Alloc(sizeof(Jim_PrngState
));
7835 for (i
= 0; i
< 256; i
++)
7836 seed
[i
] = (rand() ^ time(NULL
) ^ clock());
7837 JimPrngSeed(interp
, (unsigned char*) seed
, sizeof(int)*256);
7840 /* Generates N bytes of random data */
7841 static void JimRandomBytes(Jim_Interp
*interp
, void *dest
, unsigned int len
)
7843 Jim_PrngState
*prng
;
7844 unsigned char *destByte
= (unsigned char*) dest
;
7845 unsigned int si
, sj
, x
;
7847 /* initialization, only needed the first time */
7848 if (interp
->prngState
== NULL
)
7849 JimPrngInit(interp
);
7850 prng
= interp
->prngState
;
7851 /* generates 'len' bytes of pseudo-random numbers */
7852 for (x
= 0; x
< len
; x
++) {
7853 prng
->i
= (prng
->i
+1) & 0xff;
7854 si
= prng
->sbox
[prng
->i
];
7855 prng
->j
= (prng
->j
+ si
) & 0xff;
7856 sj
= prng
->sbox
[prng
->j
];
7857 prng
->sbox
[prng
->i
] = sj
;
7858 prng
->sbox
[prng
->j
] = si
;
7859 *destByte
++ = prng
->sbox
[(si
+sj
)&0xff];
7863 /* Re-seed the generator with user-provided bytes */
7864 static void JimPrngSeed(Jim_Interp
*interp
, const unsigned char *seed
,
7868 unsigned char buf
[256];
7869 Jim_PrngState
*prng
;
7871 /* initialization, only needed the first time */
7872 if (interp
->prngState
== NULL
)
7873 JimPrngInit(interp
);
7874 prng
= interp
->prngState
;
7876 /* Set the sbox[i] with i */
7877 for (i
= 0; i
< 256; i
++)
7879 /* Now use the seed to perform a random permutation of the sbox */
7880 for (i
= 0; i
< seedLen
; i
++) {
7883 t
= prng
->sbox
[i
&0xFF];
7884 prng
->sbox
[i
&0xFF] = prng
->sbox
[seed
[i
]];
7885 prng
->sbox
[seed
[i
]] = t
;
7887 prng
->i
= prng
->j
= 0;
7888 /* discard the first 256 bytes of stream. */
7889 JimRandomBytes(interp
, buf
, 256);
7892 /* -----------------------------------------------------------------------------
7893 * Dynamic libraries support (WIN32 not supported)
7894 * ---------------------------------------------------------------------------*/
7899 void * dlopen(const char *path
, int mode
)
7903 return (void *)LoadLibraryA(path
);
7905 int dlclose(void *handle
)
7907 FreeLibrary((HANDLE
)handle
);
7910 void *dlsym(void *handle
, const char *symbol
)
7912 return GetProcAddress((HMODULE
)handle
, symbol
);
7914 static char win32_dlerror_string
[121];
7915 const char *dlerror(void)
7917 FormatMessageA(FORMAT_MESSAGE_FROM_SYSTEM
, NULL
, GetLastError(),
7918 LANG_NEUTRAL
, win32_dlerror_string
, 120, NULL
);
7919 return win32_dlerror_string
;
7923 int Jim_LoadLibrary(Jim_Interp
*interp
, const char *pathName
)
7925 Jim_Obj
*libPathObjPtr
;
7928 int (*onload
)(Jim_Interp
*interp
);
7930 libPathObjPtr
= Jim_GetGlobalVariableStr(interp
, "jim_libpath", JIM_NONE
);
7931 if (libPathObjPtr
== NULL
) {
7933 libPathObjPtr
= NULL
;
7935 Jim_IncrRefCount(libPathObjPtr
);
7936 Jim_ListLength(interp
, libPathObjPtr
, &prefixc
);
7939 for (i
= -1; i
< prefixc
; i
++) {
7941 handle
= dlopen(pathName
, RTLD_LAZY
);
7944 char buf
[JIM_PATH_LEN
];
7947 Jim_Obj
*prefixObjPtr
;
7950 if (Jim_ListIndex(interp
, libPathObjPtr
, i
,
7951 &prefixObjPtr
, JIM_NONE
) != JIM_OK
)
7953 prefix
= Jim_GetString(prefixObjPtr
, &prefixlen
);
7954 if (prefixlen
+strlen(pathName
)+1 >= JIM_PATH_LEN
)
7956 if (*pathName
== '/') {
7957 strcpy(buf
, pathName
);
7959 else if (prefixlen
&& prefix
[prefixlen
-1] == '/')
7960 sprintf(buf
, "%s%s", prefix
, pathName
);
7962 sprintf(buf
, "%s/%s", prefix
, pathName
);
7963 fp
= fopen(buf
, "r");
7967 handle
= dlopen(buf
, RTLD_LAZY
);
7969 if (handle
== NULL
) {
7970 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
7971 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
7972 "error loading extension \"", pathName
,
7973 "\": ", dlerror(), NULL
);
7978 if ((onload
= dlsym(handle
, "Jim_OnLoad")) == NULL
) {
7979 Jim_SetResultString(interp
,
7980 "No Jim_OnLoad symbol found on extension", -1);
7983 if (onload(interp
) == JIM_ERR
) {
7987 Jim_SetEmptyResult(interp
);
7988 if (libPathObjPtr
!= NULL
)
7989 Jim_DecrRefCount(interp
, libPathObjPtr
);
7993 if (libPathObjPtr
!= NULL
)
7994 Jim_DecrRefCount(interp
, libPathObjPtr
);
7997 #else /* JIM_DYNLIB */
7998 int Jim_LoadLibrary(Jim_Interp
*interp
, const char *pathName
)
8000 JIM_NOTUSED(interp
);
8001 JIM_NOTUSED(pathName
);
8003 Jim_SetResultString(interp
, "the Jim binary has no support for [load]", -1);
8006 #endif/* JIM_DYNLIB */
8008 /* -----------------------------------------------------------------------------
8010 * ---------------------------------------------------------------------------*/
8012 #define JIM_PKG_ANY_VERSION -1
8014 /* Convert a string of the type "1.2" into an integer.
8015 * MAJOR.MINOR is converted as MAJOR*100+MINOR, so "1.2" is converted
8016 * to the integer with value 102 */
8017 static int JimPackageVersionToInt(Jim_Interp
*interp
, const char *v
,
8018 int *intPtr
, int flags
)
8021 jim_wide major
, minor
;
8022 char *majorStr
, *minorStr
, *p
;
8025 *intPtr
= JIM_PKG_ANY_VERSION
;
8029 copy
= Jim_StrDup(v
);
8030 p
= strchr(copy
, '.');
8031 if (p
== NULL
) goto badfmt
;
8036 if (Jim_StringToWide(majorStr
, &major
, 10) != JIM_OK
||
8037 Jim_StringToWide(minorStr
, &minor
, 10) != JIM_OK
)
8039 *intPtr
= (int)(major
*100+minor
);
8045 if (flags
& JIM_ERRMSG
) {
8046 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
8047 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
8048 "invalid package version '", v
, "'", NULL
);
8053 #define JIM_MATCHVER_EXACT (1<<JIM_PRIV_FLAG_SHIFT)
8054 static int JimPackageMatchVersion(int needed
, int actual
, int flags
)
8056 if (needed
== JIM_PKG_ANY_VERSION
) return 1;
8057 if (flags
& JIM_MATCHVER_EXACT
) {
8058 return needed
== actual
;
8060 return needed
/100 == actual
/100 && (needed
<= actual
);
8064 int Jim_PackageProvide(Jim_Interp
*interp
, const char *name
, const char *ver
,
8068 /* Check if the version format is ok */
8069 if (JimPackageVersionToInt(interp
, ver
, &intVersion
, JIM_ERRMSG
) != JIM_OK
)
8071 /* If the package was already provided returns an error. */
8072 if (Jim_FindHashEntry(&interp
->packages
, name
) != NULL
) {
8073 if (flags
& JIM_ERRMSG
) {
8074 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
8075 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
8076 "package '", name
, "' was already provided", NULL
);
8080 Jim_AddHashEntry(&interp
->packages
, name
, (char*) ver
);
8087 # include <sys/types.h>
8088 # include <dirent.h>
8091 /* Posix dirent.h compatiblity layer for WIN32.
8092 * Copyright Kevlin Henney, 1997, 2003. All rights reserved.
8093 * Copyright Salvatore Sanfilippo ,2005.
8095 * Permission to use, copy, modify, and distribute this software and its
8096 * documentation for any purpose is hereby granted without fee, provided
8097 * that this copyright and permissions notice appear in all copies and
8100 * This software is supplied "as is" without express or implied warranty.
8101 * This software was modified by Salvatore Sanfilippo for the Jim Interpreter.
8108 typedef struct DIR {
8109 long handle
; /* -1 for failed rewind */
8110 struct _finddata_t info
;
8111 struct dirent result
; /* d_name null iff first time */
8112 char *name
; /* null-terminated char string */
8115 DIR *opendir(const char *name
)
8119 if(name
&& name
[0]) {
8120 size_t base_length
= strlen(name
);
8121 const char *all
= /* search pattern must end with suitable wildcard */
8122 strchr("/\\", name
[base_length
- 1]) ? "*" : "/*";
8124 if((dir
= (DIR *) Jim_Alloc(sizeof *dir
)) != 0 &&
8125 (dir
->name
= (char *) Jim_Alloc(base_length
+ strlen(all
) + 1)) != 0)
8127 strcat(strcpy(dir
->name
, name
), all
);
8129 if((dir
->handle
= (long) _findfirst(dir
->name
, &dir
->info
)) != -1)
8130 dir
->result
.d_name
= 0;
8131 else { /* rollback */
8132 Jim_Free(dir
->name
);
8136 } else { /* rollback */
8147 int closedir(DIR *dir
)
8152 if(dir
->handle
!= -1)
8153 result
= _findclose(dir
->handle
);
8154 Jim_Free(dir
->name
);
8157 if(result
== -1) /* map all errors to EBADF */
8162 struct dirent
*readdir(DIR *dir
)
8164 struct dirent
*result
= 0;
8166 if(dir
&& dir
->handle
!= -1) {
8167 if(!dir
->result
.d_name
|| _findnext(dir
->handle
, &dir
->info
) != -1) {
8168 result
= &dir
->result
;
8169 result
->d_name
= dir
->info
.name
;
8179 static char *JimFindBestPackage(Jim_Interp
*interp
, char **prefixes
,
8180 int prefixc
, const char *pkgName
, int pkgVer
, int flags
)
8182 int bestVer
= -1, i
;
8183 int pkgNameLen
= strlen(pkgName
);
8184 char *bestPackage
= NULL
;
8187 for (i
= 0; i
< prefixc
; i
++) {
8189 char buf
[JIM_PATH_LEN
];
8192 if (prefixes
[i
] == NULL
) continue;
8193 strncpy(buf
, prefixes
[i
], JIM_PATH_LEN
);
8194 buf
[JIM_PATH_LEN
-1] = '\0';
8195 prefixLen
= strlen(buf
);
8196 if (prefixLen
&& buf
[prefixLen
-1] == '/')
8197 buf
[prefixLen
-1] = '\0';
8199 if ((dir
= opendir(buf
)) == NULL
) continue;
8200 while ((de
= readdir(dir
)) != NULL
) {
8201 char *fileName
= de
->d_name
;
8202 int fileNameLen
= strlen(fileName
);
8204 if (strncmp(fileName
, "jim-", 4) == 0 &&
8205 strncmp(fileName
+4, pkgName
, pkgNameLen
) == 0 &&
8206 *(fileName
+4+pkgNameLen
) == '-' &&
8207 fileNameLen
> 4 && /* note that this is not really useful */
8208 (strncmp(fileName
+fileNameLen
-4, ".tcl", 4) == 0 ||
8209 strncmp(fileName
+fileNameLen
-4, ".dll", 4) == 0 ||
8210 strncmp(fileName
+fileNameLen
-3, ".so", 3) == 0))
8212 char ver
[6]; /* xx.yy<nulterm> */
8213 char *p
= strrchr(fileName
, '.');
8214 int verLen
, fileVer
;
8216 verLen
= p
- (fileName
+4+pkgNameLen
+1);
8217 if (verLen
< 3 || verLen
> 5) continue;
8218 memcpy(ver
, fileName
+4+pkgNameLen
+1, verLen
);
8220 if (JimPackageVersionToInt(interp
, ver
, &fileVer
, JIM_NONE
)
8221 != JIM_OK
) continue;
8222 if (JimPackageMatchVersion(pkgVer
, fileVer
, flags
) &&
8223 (bestVer
== -1 || bestVer
< fileVer
))
8226 Jim_Free(bestPackage
);
8227 bestPackage
= Jim_Alloc(strlen(buf
)+strlen(fileName
)+2);
8228 sprintf(bestPackage
, "%s/%s", buf
, fileName
);
8237 #else /* JIM_ANSIC */
8239 static char *JimFindBestPackage(Jim_Interp
*interp
, char **prefixes
,
8240 int prefixc
, const char *pkgName
, int pkgVer
, int flags
)
8242 JIM_NOTUSED(interp
);
8243 JIM_NOTUSED(prefixes
);
8244 JIM_NOTUSED(prefixc
);
8245 JIM_NOTUSED(pkgName
);
8246 JIM_NOTUSED(pkgVer
);
8251 #endif /* JIM_ANSIC */
8253 /* Search for a suitable package under every dir specified by jim_libpath
8254 * and load it if possible. If a suitable package was loaded with success
8255 * JIM_OK is returned, otherwise JIM_ERR is returned. */
8256 static int JimLoadPackage(Jim_Interp
*interp
, const char *name
, int ver
,
8259 Jim_Obj
*libPathObjPtr
;
8260 char **prefixes
, *best
;
8261 int prefixc
, i
, retCode
= JIM_OK
;
8263 libPathObjPtr
= Jim_GetGlobalVariableStr(interp
, "jim_libpath", JIM_NONE
);
8264 if (libPathObjPtr
== NULL
) {
8266 libPathObjPtr
= NULL
;
8268 Jim_IncrRefCount(libPathObjPtr
);
8269 Jim_ListLength(interp
, libPathObjPtr
, &prefixc
);
8272 prefixes
= Jim_Alloc(sizeof(char*)*prefixc
);
8273 for (i
= 0; i
< prefixc
; i
++) {
8274 Jim_Obj
*prefixObjPtr
;
8275 if (Jim_ListIndex(interp
, libPathObjPtr
, i
,
8276 &prefixObjPtr
, JIM_NONE
) != JIM_OK
)
8281 prefixes
[i
] = Jim_StrDup(Jim_GetString(prefixObjPtr
, NULL
));
8283 /* Scan every directory to find the "best" package. */
8284 best
= JimFindBestPackage(interp
, prefixes
, prefixc
, name
, ver
, flags
);
8286 char *p
= strrchr(best
, '.');
8287 /* Try to load/source it */
8288 if (p
&& strcmp(p
, ".tcl") == 0) {
8289 retCode
= Jim_EvalFile(interp
, best
);
8291 retCode
= Jim_LoadLibrary(interp
, best
);
8297 for (i
= 0; i
< prefixc
; i
++)
8298 Jim_Free(prefixes
[i
]);
8301 Jim_DecrRefCount(interp
, libPathObjPtr
);
8305 const char *Jim_PackageRequire(Jim_Interp
*interp
, const char *name
,
8306 const char *ver
, int flags
)
8311 /* Start with an empty error string */
8312 Jim_SetResultString(interp
, "", 0);
8314 if (JimPackageVersionToInt(interp
, ver
, &requiredVer
, JIM_ERRMSG
) != JIM_OK
)
8316 he
= Jim_FindHashEntry(&interp
->packages
, name
);
8318 /* Try to load the package. */
8319 if (JimLoadPackage(interp
, name
, requiredVer
, flags
) == JIM_OK
) {
8320 he
= Jim_FindHashEntry(&interp
->packages
, name
);
8326 /* No way... return an error. */
8327 if (flags
& JIM_ERRMSG
) {
8329 Jim_GetString(Jim_GetResult(interp
), &len
);
8330 Jim_AppendStrings(interp
, Jim_GetResult(interp
), len
? "\n" : "",
8331 "Can't find package '", name
, "'", NULL
);
8336 if (JimPackageVersionToInt(interp
, he
->val
, &actualVer
, JIM_ERRMSG
)
8341 /* Check if version matches. */
8342 if (JimPackageMatchVersion(requiredVer
, actualVer
, flags
) == 0) {
8343 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
8344 "Package '", name
, "' already loaded, but with version ",
8352 /* -----------------------------------------------------------------------------
8354 * ---------------------------------------------------------------------------*/
8355 #define JIM_EVAL_SARGV_LEN 8 /* static arguments vector length */
8356 #define JIM_EVAL_SINTV_LEN 8 /* static interpolation vector length */
8358 static int JimCallProcedure(Jim_Interp
*interp
, Jim_Cmd
*cmd
, int argc
,
8359 Jim_Obj
*const *argv
);
8361 /* Handle calls to the [unknown] command */
8362 static int JimUnknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
8364 Jim_Obj
**v
, *sv
[JIM_EVAL_SARGV_LEN
];
8367 /* If JimUnknown() is recursively called (e.g. error in the unknown proc,
8370 if (interp
->unknown_called
) {
8374 /* If the [unknown] command does not exists returns
8376 if (Jim_GetCommand(interp
, interp
->unknown
, JIM_NONE
) == NULL
)
8379 /* The object interp->unknown just contains
8380 * the "unknown" string, it is used in order to
8381 * avoid to lookup the unknown command every time
8382 * but instread to cache the result. */
8383 if (argc
+1 <= JIM_EVAL_SARGV_LEN
)
8386 v
= Jim_Alloc(sizeof(Jim_Obj
*)*(argc
+1));
8387 /* Make a copy of the arguments vector, but shifted on
8388 * the right of one position. The command name of the
8389 * command will be instead the first argument of the
8390 * [unknonw] call. */
8391 memcpy(v
+1, argv
, sizeof(Jim_Obj
*)*argc
);
8392 v
[0] = interp
->unknown
;
8394 interp
->unknown_called
++;
8395 retCode
= Jim_EvalObjVector(interp
, argc
+1, v
);
8396 interp
->unknown_called
--;
8404 /* Eval the object vector 'objv' composed of 'objc' elements.
8405 * Every element is used as single argument.
8406 * Jim_EvalObj() will call this function every time its object
8407 * argument is of "list" type, with no string representation.
8409 * This is possible because the string representation of a
8410 * list object generated by the UpdateStringOfList is made
8411 * in a way that ensures that every list element is a different
8412 * command argument. */
8413 int Jim_EvalObjVector(Jim_Interp
*interp
, int objc
, Jim_Obj
*const *objv
)
8418 /* Incr refcount of arguments. */
8419 for (i
= 0; i
< objc
; i
++)
8420 Jim_IncrRefCount(objv
[i
]);
8421 /* Command lookup */
8422 cmdPtr
= Jim_GetCommand(interp
, objv
[0], JIM_ERRMSG
);
8423 if (cmdPtr
== NULL
) {
8424 retcode
= JimUnknown(interp
, objc
, objv
);
8426 /* Call it -- Make sure result is an empty object. */
8427 Jim_SetEmptyResult(interp
);
8428 if (cmdPtr
->cmdProc
) {
8429 interp
->cmdPrivData
= cmdPtr
->privData
;
8430 retcode
= cmdPtr
->cmdProc(interp
, objc
, objv
);
8431 if (retcode
== JIM_ERR_ADDSTACK
) {
8432 //JimAppendStackTrace(interp, "", script->fileName, token[i-argc*2].linenr);
8436 retcode
= JimCallProcedure(interp
, cmdPtr
, objc
, objv
);
8437 if (retcode
== JIM_ERR
) {
8438 JimAppendStackTrace(interp
,
8439 Jim_GetString(objv
[0], NULL
), "", 1);
8443 /* Decr refcount of arguments and return the retcode */
8444 for (i
= 0; i
< objc
; i
++)
8445 Jim_DecrRefCount(interp
, objv
[i
]);
8449 /* Interpolate the given tokens into a unique Jim_Obj returned by reference
8450 * via *objPtrPtr. This function is only called by Jim_EvalObj().
8451 * The returned object has refcount = 0. */
8452 int Jim_InterpolateTokens(Jim_Interp
*interp
, ScriptToken
*token
,
8453 int tokens
, Jim_Obj
**objPtrPtr
)
8455 int totlen
= 0, i
, retcode
;
8457 Jim_Obj
*sintv
[JIM_EVAL_SINTV_LEN
];
8461 if (tokens
<= JIM_EVAL_SINTV_LEN
)
8464 intv
= Jim_Alloc(sizeof(Jim_Obj
*)*
8466 /* Compute every token forming the argument
8467 * in the intv objects vector. */
8468 for (i
= 0; i
< tokens
; i
++) {
8469 switch(token
[i
].type
) {
8472 intv
[i
] = token
[i
].objPtr
;
8475 intv
[i
] = Jim_GetVariable(interp
, token
[i
].objPtr
, JIM_ERRMSG
);
8481 case JIM_TT_DICTSUGAR
:
8482 intv
[i
] = Jim_ExpandDictSugar(interp
, token
[i
].objPtr
);
8489 retcode
= Jim_EvalObj(interp
, token
[i
].objPtr
);
8490 if (retcode
!= JIM_OK
)
8492 intv
[i
] = Jim_GetResult(interp
);
8496 "default token type reached "
8497 "in Jim_InterpolateTokens().");
8500 Jim_IncrRefCount(intv
[i
]);
8501 /* Make sure there is a valid
8502 * string rep, and add the string
8503 * length to the total legnth. */
8504 Jim_GetString(intv
[i
], NULL
);
8505 totlen
+= intv
[i
]->length
;
8507 /* Concatenate every token in an unique
8509 objPtr
= Jim_NewStringObjNoAlloc(interp
,
8511 s
= objPtr
->bytes
= Jim_Alloc(totlen
+1);
8512 objPtr
->length
= totlen
;
8513 for (i
= 0; i
< tokens
; i
++) {
8514 memcpy(s
, intv
[i
]->bytes
, intv
[i
]->length
);
8515 s
+= intv
[i
]->length
;
8516 Jim_DecrRefCount(interp
, intv
[i
]);
8518 objPtr
->bytes
[totlen
] = '\0';
8519 /* Free the intv vector if not static. */
8520 if (tokens
> JIM_EVAL_SINTV_LEN
)
8522 *objPtrPtr
= objPtr
;
8527 Jim_DecrRefCount(interp
, intv
[i
]);
8528 if (tokens
> JIM_EVAL_SINTV_LEN
)
8533 /* Helper of Jim_EvalObj() to perform argument expansion.
8534 * Basically this function append an argument to 'argv'
8535 * (and increments argc by reference accordingly), performing
8536 * expansion of the list object if 'expand' is non-zero, or
8537 * just adding objPtr to argv if 'expand' is zero. */
8538 void Jim_ExpandArgument(Jim_Interp
*interp
, Jim_Obj
***argv
,
8539 int *argcPtr
, int expand
, Jim_Obj
*objPtr
)
8542 (*argv
) = Jim_Realloc(*argv
, sizeof(Jim_Obj
*)*((*argcPtr
)+1));
8543 /* refcount of objPtr not incremented because
8544 * we are actually transfering a reference from
8545 * the old 'argv' to the expanded one. */
8546 (*argv
)[*argcPtr
] = objPtr
;
8551 Jim_ListLength(interp
, objPtr
, &len
);
8552 (*argv
) = Jim_Realloc(*argv
, sizeof(Jim_Obj
*)*((*argcPtr
)+len
));
8553 for (i
= 0; i
< len
; i
++) {
8554 (*argv
)[*argcPtr
] = objPtr
->internalRep
.listValue
.ele
[i
];
8555 Jim_IncrRefCount(objPtr
->internalRep
.listValue
.ele
[i
]);
8558 /* The original object reference is no longer needed,
8559 * after the expansion it is no longer present on
8560 * the argument vector, but the single elements are
8562 Jim_DecrRefCount(interp
, objPtr
);
8566 int Jim_EvalObj(Jim_Interp
*interp
, Jim_Obj
*scriptObjPtr
)
8571 int *cs
; /* command structure array */
8572 int retcode
= JIM_OK
;
8573 Jim_Obj
*sargv
[JIM_EVAL_SARGV_LEN
], **argv
= NULL
, *tmpObjPtr
;
8575 interp
->errorFlag
= 0;
8577 /* If the object is of type "list" and there is no
8578 * string representation for this object, we can call
8579 * a specialized version of Jim_EvalObj() */
8580 if (scriptObjPtr
->typePtr
== &listObjType
&&
8581 scriptObjPtr
->internalRep
.listValue
.len
&&
8582 scriptObjPtr
->bytes
== NULL
) {
8583 Jim_IncrRefCount(scriptObjPtr
);
8584 retcode
= Jim_EvalObjVector(interp
,
8585 scriptObjPtr
->internalRep
.listValue
.len
,
8586 scriptObjPtr
->internalRep
.listValue
.ele
);
8587 Jim_DecrRefCount(interp
, scriptObjPtr
);
8591 Jim_IncrRefCount(scriptObjPtr
); /* Make sure it's shared. */
8592 script
= Jim_GetScript(interp
, scriptObjPtr
);
8593 /* Now we have to make sure the internal repr will not be
8594 * freed on shimmering.
8596 * Think for example to this:
8598 * set x {llength $x; ... some more code ...}; eval $x
8600 * In order to preserve the internal rep, we increment the
8601 * inUse field of the script internal rep structure. */
8604 token
= script
->token
;
8606 cs
= script
->cmdStruct
;
8607 i
= 0; /* 'i' is the current token index. */
8609 /* Reset the interpreter result. This is useful to
8610 * return the emtpy result in the case of empty program. */
8611 Jim_SetEmptyResult(interp
);
8613 /* Execute every command sequentially, returns on
8614 * error (i.e. if a command does not return JIM_OK) */
8617 int argc
= *cs
++; /* Get the number of arguments */
8620 /* Set the expand flag if needed. */
8625 /* Allocate the arguments vector */
8626 if (argc
<= JIM_EVAL_SARGV_LEN
)
8629 argv
= Jim_Alloc(sizeof(Jim_Obj
*)*argc
);
8630 /* Populate the arguments objects. */
8631 for (j
= 0; j
< argc
; j
++) {
8634 /* tokens is negative if expansion is needed.
8635 * for this argument. */
8637 tokens
= (-tokens
)-1;
8641 /* Fast path if the token does not
8642 * need interpolation */
8643 switch(token
[i
].type
) {
8646 argv
[j
] = token
[i
].objPtr
;
8649 tmpObjPtr
= Jim_GetVariable(interp
, token
[i
].objPtr
,
8655 argv
[j
] = tmpObjPtr
;
8657 case JIM_TT_DICTSUGAR
:
8658 tmpObjPtr
= Jim_ExpandDictSugar(interp
, token
[i
].objPtr
);
8663 argv
[j
] = tmpObjPtr
;
8666 retcode
= Jim_EvalObj(interp
, token
[i
].objPtr
);
8667 if (retcode
!= JIM_OK
)
8669 argv
[j
] = Jim_GetResult(interp
);
8673 "default token type reached "
8674 "in Jim_EvalObj().");
8677 Jim_IncrRefCount(argv
[j
]);
8680 /* For interpolation we call an helper
8681 * function doing the work for us. */
8682 if ((retcode
= Jim_InterpolateTokens(interp
,
8683 token
+i
, tokens
, &tmpObjPtr
)) != JIM_OK
)
8687 argv
[j
] = tmpObjPtr
;
8688 Jim_IncrRefCount(argv
[j
]);
8692 /* Handle {expand} expansion */
8694 int *ecs
= cs
- argc
;
8696 Jim_Obj
**eargv
= NULL
;
8698 for (j
= 0; j
< argc
; j
++) {
8699 Jim_ExpandArgument( interp
, &eargv
, &eargc
,
8700 ecs
[j
] < 0, argv
[j
]);
8708 /* Nothing to do with zero args. */
8713 /* Lookup the command to call */
8714 cmd
= Jim_GetCommand(interp
, argv
[0], JIM_ERRMSG
);
8716 /* Call it -- Make sure result is an empty object. */
8717 Jim_SetEmptyResult(interp
);
8719 interp
->cmdPrivData
= cmd
->privData
;
8720 retcode
= cmd
->cmdProc(interp
, argc
, argv
);
8721 if ((retcode
== JIM_ERR
)||(retcode
== JIM_ERR_ADDSTACK
)) {
8722 JimAppendStackTrace(interp
, "", script
->fileName
, token
[i
-argc
*2].linenr
);
8726 retcode
= JimCallProcedure(interp
, cmd
, argc
, argv
);
8727 if (retcode
== JIM_ERR
) {
8728 JimAppendStackTrace(interp
,
8729 Jim_GetString(argv
[0], NULL
), script
->fileName
,
8730 token
[i
-argc
*2].linenr
);
8734 /* Call [unknown] */
8735 retcode
= JimUnknown(interp
, argc
, argv
);
8736 if (retcode
== JIM_ERR
) {
8737 JimAppendStackTrace(interp
,
8738 "", script
->fileName
,
8739 token
[i
-argc
*2].linenr
);
8742 if (retcode
!= JIM_OK
) {
8743 i
-= argc
*2; /* point to the command name. */
8746 /* Decrement the arguments count */
8747 for (j
= 0; j
< argc
; j
++) {
8748 Jim_DecrRefCount(interp
, argv
[j
]);
8751 if (argv
!= sargv
) {
8756 /* Note that we don't have to decrement inUse, because the
8757 * following code transfers our use of the reference again to
8758 * the script object. */
8759 j
= 0; /* on normal termination, the argv array is already
8760 Jim_DecrRefCount-ed. */
8762 /* Handle errors. */
8763 if (retcode
== JIM_ERR
&& !interp
->errorFlag
) {
8764 interp
->errorFlag
= 1;
8765 JimSetErrorFileName(interp
, script
->fileName
);
8766 JimSetErrorLineNumber(interp
, token
[i
].linenr
);
8767 JimResetStackTrace(interp
);
8769 Jim_FreeIntRep(interp
, scriptObjPtr
);
8770 scriptObjPtr
->typePtr
= &scriptObjType
;
8771 Jim_SetIntRepPtr(scriptObjPtr
, script
);
8772 Jim_DecrRefCount(interp
, scriptObjPtr
);
8773 for (i
= 0; i
< j
; i
++) {
8774 Jim_DecrRefCount(interp
, argv
[i
]);
8781 /* Call a procedure implemented in Tcl.
8782 * It's possible to speed-up a lot this function, currently
8783 * the callframes are not cached, but allocated and
8784 * destroied every time. What is expecially costly is
8785 * to create/destroy the local vars hash table every time.
8787 * This can be fixed just implementing callframes caching
8788 * in JimCreateCallFrame() and JimFreeCallFrame(). */
8789 int JimCallProcedure(Jim_Interp
*interp
, Jim_Cmd
*cmd
, int argc
,
8790 Jim_Obj
*const *argv
)
8793 Jim_CallFrame
*callFramePtr
;
8797 if (argc
< cmd
->arityMin
|| (cmd
->arityMax
!= -1 &&
8798 argc
> cmd
->arityMax
)) {
8799 Jim_Obj
*objPtr
= Jim_NewEmptyStringObj(interp
);
8800 Jim_AppendStrings(interp
, objPtr
,
8801 "wrong # args: should be \"", Jim_GetString(argv
[0], NULL
),
8802 (cmd
->arityMin
> 1) ? " " : "",
8803 Jim_GetString(cmd
->argListObjPtr
, NULL
), "\"", NULL
);
8804 Jim_SetResult(interp
, objPtr
);
8807 /* Check if there are too nested calls */
8808 if (interp
->numLevels
== interp
->maxNestingDepth
) {
8809 Jim_SetResultString(interp
,
8810 "Too many nested calls. Infinite recursion?", -1);
8813 /* Create a new callframe */
8814 callFramePtr
= JimCreateCallFrame(interp
);
8815 callFramePtr
->parentCallFrame
= interp
->framePtr
;
8816 callFramePtr
->argv
= argv
;
8817 callFramePtr
->argc
= argc
;
8818 callFramePtr
->procArgsObjPtr
= cmd
->argListObjPtr
;
8819 callFramePtr
->procBodyObjPtr
= cmd
->bodyObjPtr
;
8820 callFramePtr
->staticVars
= cmd
->staticVars
;
8821 Jim_IncrRefCount(cmd
->argListObjPtr
);
8822 Jim_IncrRefCount(cmd
->bodyObjPtr
);
8823 interp
->framePtr
= callFramePtr
;
8824 interp
->numLevels
++;
8827 Jim_ListLength(interp
, cmd
->argListObjPtr
, &num_args
);
8829 /* If last argument is 'args', don't set it here */
8830 if (cmd
->arityMax
== -1) {
8834 for (i
= 0; i
< num_args
; i
++) {
8836 Jim_Obj
*nameObjPtr
;
8837 Jim_Obj
*valueObjPtr
;
8839 Jim_ListIndex(interp
, cmd
->argListObjPtr
, i
, &argObjPtr
, JIM_NONE
);
8840 if (i
+ 1 >= cmd
->arityMin
) {
8841 /* The name is the first element of the list */
8842 Jim_ListIndex(interp
, argObjPtr
, 0, &nameObjPtr
, JIM_NONE
);
8845 /* The element arg is the name */
8846 nameObjPtr
= argObjPtr
;
8849 if (i
+ 1 >= argc
) {
8850 /* No more values, so use default */
8851 /* The value is the second element of the list */
8852 Jim_ListIndex(interp
, argObjPtr
, 1, &valueObjPtr
, JIM_NONE
);
8855 valueObjPtr
= argv
[i
+1];
8857 Jim_SetVariable(interp
, nameObjPtr
, valueObjPtr
);
8859 /* Set optional arguments */
8860 if (cmd
->arityMax
== -1) {
8861 Jim_Obj
*listObjPtr
, *objPtr
;
8864 listObjPtr
= Jim_NewListObj(interp
, argv
+i
, argc
-i
);
8865 Jim_ListIndex(interp
, cmd
->argListObjPtr
, num_args
, &objPtr
, JIM_NONE
);
8866 Jim_SetVariable(interp
, objPtr
, listObjPtr
);
8869 retcode
= Jim_EvalObj(interp
, cmd
->bodyObjPtr
);
8871 /* Destroy the callframe */
8872 interp
->numLevels
--;
8873 interp
->framePtr
= interp
->framePtr
->parentCallFrame
;
8874 if (callFramePtr
->vars
.size
!= JIM_HT_INITIAL_SIZE
) {
8875 JimFreeCallFrame(interp
, callFramePtr
, JIM_FCF_NONE
);
8877 JimFreeCallFrame(interp
, callFramePtr
, JIM_FCF_NOHT
);
8879 /* Handle the JIM_EVAL return code */
8880 if (retcode
== JIM_EVAL
&& interp
->evalRetcodeLevel
!= interp
->numLevels
) {
8881 int savedLevel
= interp
->evalRetcodeLevel
;
8883 interp
->evalRetcodeLevel
= interp
->numLevels
;
8884 while (retcode
== JIM_EVAL
) {
8885 Jim_Obj
*resultScriptObjPtr
= Jim_GetResult(interp
);
8886 Jim_IncrRefCount(resultScriptObjPtr
);
8887 retcode
= Jim_EvalObj(interp
, resultScriptObjPtr
);
8888 Jim_DecrRefCount(interp
, resultScriptObjPtr
);
8890 interp
->evalRetcodeLevel
= savedLevel
;
8892 /* Handle the JIM_RETURN return code */
8893 if (retcode
== JIM_RETURN
) {
8894 retcode
= interp
->returnCode
;
8895 interp
->returnCode
= JIM_OK
;
8900 int Jim_Eval_Named(Jim_Interp
*interp
, const char *script
, const char *filename
, int lineno
)
8903 Jim_Obj
*scriptObjPtr
;
8905 scriptObjPtr
= Jim_NewStringObj(interp
, script
, -1);
8906 Jim_IncrRefCount(scriptObjPtr
);
8910 JimSetSourceInfo( interp
, scriptObjPtr
, filename
, lineno
);
8913 retval
= Jim_EvalObj(interp
, scriptObjPtr
);
8914 Jim_DecrRefCount(interp
, scriptObjPtr
);
8918 int Jim_Eval(Jim_Interp
*interp
, const char *script
)
8920 return Jim_Eval_Named( interp
, script
, NULL
, 0 );
8925 /* Execute script in the scope of the global level */
8926 int Jim_EvalGlobal(Jim_Interp
*interp
, const char *script
)
8928 Jim_CallFrame
*savedFramePtr
;
8931 savedFramePtr
= interp
->framePtr
;
8932 interp
->framePtr
= interp
->topFramePtr
;
8933 retval
= Jim_Eval(interp
, script
);
8934 interp
->framePtr
= savedFramePtr
;
8938 int Jim_EvalObjBackground(Jim_Interp
*interp
, Jim_Obj
*scriptObjPtr
)
8940 Jim_CallFrame
*savedFramePtr
;
8943 savedFramePtr
= interp
->framePtr
;
8944 interp
->framePtr
= interp
->topFramePtr
;
8945 retval
= Jim_EvalObj(interp
, scriptObjPtr
);
8946 interp
->framePtr
= savedFramePtr
;
8947 /* Try to report the error (if any) via the bgerror proc */
8948 if (retval
!= JIM_OK
) {
8951 objv
[0] = Jim_NewStringObj(interp
, "bgerror", -1);
8952 objv
[1] = Jim_GetResult(interp
);
8953 Jim_IncrRefCount(objv
[0]);
8954 Jim_IncrRefCount(objv
[1]);
8955 if (Jim_EvalObjVector(interp
, 2, objv
) != JIM_OK
) {
8956 /* Report the error to stderr. */
8957 Jim_fprintf( interp
, interp
->cookie_stderr
, "Background error:" JIM_NL
);
8958 Jim_PrintErrorMessage(interp
);
8960 Jim_DecrRefCount(interp
, objv
[0]);
8961 Jim_DecrRefCount(interp
, objv
[1]);
8966 int Jim_EvalFile(Jim_Interp
*interp
, const char *filename
)
8970 int nread
, totread
, maxlen
, buflen
;
8972 Jim_Obj
*scriptObjPtr
;
8974 if ((fp
= fopen(filename
, "r")) == NULL
) {
8975 const int cwd_len
=2048;
8976 char *cwd
=malloc(cwd_len
);
8977 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
8978 if (!getcwd( cwd
, cwd_len
)) strcpy(cwd
, "unknown");
8979 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
8980 "Error loading script \"", filename
, "\"",
8982 " err: ", strerror(errno
), NULL
);
8987 maxlen
= totread
= 0;
8989 if (maxlen
< totread
+buflen
+1) {
8990 maxlen
= totread
+buflen
+1;
8991 prg
= Jim_Realloc(prg
, maxlen
);
8993 /* do not use Jim_fread() - this is really a file */
8994 if ((nread
= fread(prg
+totread
, 1, buflen
, fp
)) == 0) break;
8997 prg
[totread
] = '\0';
8998 /* do not use Jim_fclose() - this is really a file */
9001 scriptObjPtr
= Jim_NewStringObjNoAlloc(interp
, prg
, totread
);
9002 JimSetSourceInfo(interp
, scriptObjPtr
, filename
, 1);
9003 Jim_IncrRefCount(scriptObjPtr
);
9004 retval
= Jim_EvalObj(interp
, scriptObjPtr
);
9005 Jim_DecrRefCount(interp
, scriptObjPtr
);
9009 /* -----------------------------------------------------------------------------
9011 * ---------------------------------------------------------------------------*/
9012 static int JimParseSubstStr(struct JimParserCtx
*pc
)
9015 pc
->tline
= pc
->linenr
;
9016 while (*pc
->p
&& *pc
->p
!= '$' && *pc
->p
!= '[') {
9020 pc
->tt
= JIM_TT_ESC
;
9024 static int JimParseSubst(struct JimParserCtx
*pc
, int flags
)
9029 pc
->tstart
= pc
->tend
= pc
->p
;
9030 pc
->tline
= pc
->linenr
;
9031 pc
->tt
= JIM_TT_EOL
;
9037 retval
= JimParseCmd(pc
);
9038 if (flags
& JIM_SUBST_NOCMD
) {
9041 pc
->tt
= (flags
& JIM_SUBST_NOESC
) ?
9042 JIM_TT_STR
: JIM_TT_ESC
;
9047 if (JimParseVar(pc
) == JIM_ERR
) {
9048 pc
->tstart
= pc
->tend
= pc
->p
++; pc
->len
--;
9049 pc
->tline
= pc
->linenr
;
9050 pc
->tt
= JIM_TT_STR
;
9052 if (flags
& JIM_SUBST_NOVAR
) {
9054 if (flags
& JIM_SUBST_NOESC
)
9055 pc
->tt
= JIM_TT_STR
;
9057 pc
->tt
= JIM_TT_ESC
;
9058 if (*pc
->tstart
== '{') {
9067 retval
= JimParseSubstStr(pc
);
9068 if (flags
& JIM_SUBST_NOESC
)
9069 pc
->tt
= JIM_TT_STR
;
9076 /* The subst object type reuses most of the data structures and functions
9077 * of the script object. Script's data structures are a bit more complex
9078 * for what is needed for [subst]itution tasks, but the reuse helps to
9079 * deal with a single data structure at the cost of some more memory
9080 * usage for substitutions. */
9081 static Jim_ObjType substObjType
= {
9083 FreeScriptInternalRep
,
9084 DupScriptInternalRep
,
9086 JIM_TYPE_REFERENCES
,
9089 /* This method takes the string representation of an object
9090 * as a Tcl string where to perform [subst]itution, and generates
9091 * the pre-parsed internal representation. */
9092 int SetSubstFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
, int flags
)
9095 const char *scriptText
= Jim_GetString(objPtr
, &scriptTextLen
);
9096 struct JimParserCtx parser
;
9097 struct ScriptObj
*script
= Jim_Alloc(sizeof(*script
));
9101 script
->commands
= 0;
9102 script
->token
= NULL
;
9103 script
->cmdStruct
= NULL
;
9105 script
->substFlags
= flags
;
9106 script
->fileName
= NULL
;
9108 JimParserInit(&parser
, scriptText
, scriptTextLen
, 1);
9111 int len
, type
, linenr
;
9113 JimParseSubst(&parser
, flags
);
9114 if (JimParserEof(&parser
)) break;
9115 token
= JimParserGetToken(&parser
, &len
, &type
, &linenr
);
9116 ScriptObjAddToken(interp
, script
, token
, len
, type
,
9119 /* Free the old internal rep and set the new one. */
9120 Jim_FreeIntRep(interp
, objPtr
);
9121 Jim_SetIntRepPtr(objPtr
, script
);
9122 objPtr
->typePtr
= &scriptObjType
;
9126 ScriptObj
*Jim_GetSubst(Jim_Interp
*interp
, Jim_Obj
*objPtr
, int flags
)
9128 struct ScriptObj
*script
= Jim_GetIntRepPtr(objPtr
);
9130 if (objPtr
->typePtr
!= &substObjType
|| script
->substFlags
!= flags
)
9131 SetSubstFromAny(interp
, objPtr
, flags
);
9132 return (ScriptObj
*) Jim_GetIntRepPtr(objPtr
);
9135 /* Performs commands,variables,blackslashes substitution,
9136 * storing the result object (with refcount 0) into
9138 int Jim_SubstObj(Jim_Interp
*interp
, Jim_Obj
*substObjPtr
,
9139 Jim_Obj
**resObjPtrPtr
, int flags
)
9143 int i
, len
, retcode
= JIM_OK
;
9144 Jim_Obj
*resObjPtr
, *savedResultObjPtr
;
9146 script
= Jim_GetSubst(interp
, substObjPtr
, flags
);
9147 #ifdef JIM_OPTIMIZATION
9148 /* Fast path for a very common case with array-alike syntax,
9149 * that's: $foo($bar) */
9150 if (script
->len
== 1 && script
->token
[0].type
== JIM_TT_VAR
) {
9151 Jim_Obj
*varObjPtr
= script
->token
[0].objPtr
;
9153 Jim_IncrRefCount(varObjPtr
);
9154 resObjPtr
= Jim_GetVariable(interp
, varObjPtr
, JIM_ERRMSG
);
9155 if (resObjPtr
== NULL
) {
9156 Jim_DecrRefCount(interp
, varObjPtr
);
9159 Jim_DecrRefCount(interp
, varObjPtr
);
9160 *resObjPtrPtr
= resObjPtr
;
9165 Jim_IncrRefCount(substObjPtr
); /* Make sure it's shared. */
9166 /* In order to preserve the internal rep, we increment the
9167 * inUse field of the script internal rep structure. */
9170 token
= script
->token
;
9173 /* Save the interp old result, to set it again before
9175 savedResultObjPtr
= interp
->result
;
9176 Jim_IncrRefCount(savedResultObjPtr
);
9178 /* Perform the substitution. Starts with an empty object
9179 * and adds every token (performing the appropriate
9180 * var/command/escape substitution). */
9181 resObjPtr
= Jim_NewStringObj(interp
, "", 0);
9182 for (i
= 0; i
< len
; i
++) {
9185 switch(token
[i
].type
) {
9188 Jim_AppendObj(interp
, resObjPtr
, token
[i
].objPtr
);
9191 objPtr
= Jim_GetVariable(interp
, token
[i
].objPtr
, JIM_ERRMSG
);
9192 if (objPtr
== NULL
) goto err
;
9193 Jim_IncrRefCount(objPtr
);
9194 Jim_AppendObj(interp
, resObjPtr
, objPtr
);
9195 Jim_DecrRefCount(interp
, objPtr
);
9197 case JIM_TT_DICTSUGAR
:
9198 objPtr
= Jim_ExpandDictSugar(interp
, token
[i
].objPtr
);
9205 if (Jim_EvalObj(interp
, token
[i
].objPtr
) != JIM_OK
)
9207 Jim_AppendObj(interp
, resObjPtr
, interp
->result
);
9211 "default token type (%d) reached "
9212 "in Jim_SubstObj().", token
[i
].type
);
9217 if (retcode
== JIM_OK
)
9218 Jim_SetResult(interp
, savedResultObjPtr
);
9219 Jim_DecrRefCount(interp
, savedResultObjPtr
);
9220 /* Note that we don't have to decrement inUse, because the
9221 * following code transfers our use of the reference again to
9222 * the script object. */
9223 Jim_FreeIntRep(interp
, substObjPtr
);
9224 substObjPtr
->typePtr
= &scriptObjType
;
9225 Jim_SetIntRepPtr(substObjPtr
, script
);
9226 Jim_DecrRefCount(interp
, substObjPtr
);
9227 *resObjPtrPtr
= resObjPtr
;
9230 Jim_FreeNewObj(interp
, resObjPtr
);
9235 /* -----------------------------------------------------------------------------
9236 * API Input/Export functions
9237 * ---------------------------------------------------------------------------*/
9239 int Jim_GetApi(Jim_Interp
*interp
, const char *funcname
, void *targetPtrPtr
)
9243 he
= Jim_FindHashEntry(&interp
->stub
, funcname
);
9246 memcpy(targetPtrPtr
, &he
->val
, sizeof(void*));
9250 int Jim_RegisterApi(Jim_Interp
*interp
, const char *funcname
, void *funcptr
)
9252 return Jim_AddHashEntry(&interp
->stub
, funcname
, funcptr
);
9255 #define JIM_REGISTER_API(name) \
9256 Jim_RegisterApi(interp, "Jim_" #name, (void *)Jim_ ## name)
9258 void JimRegisterCoreApi(Jim_Interp
*interp
)
9260 interp
->getApiFuncPtr
= Jim_GetApi
;
9261 JIM_REGISTER_API(Alloc
);
9262 JIM_REGISTER_API(Free
);
9263 JIM_REGISTER_API(Eval
);
9264 JIM_REGISTER_API(Eval_Named
);
9265 JIM_REGISTER_API(EvalGlobal
);
9266 JIM_REGISTER_API(EvalFile
);
9267 JIM_REGISTER_API(EvalObj
);
9268 JIM_REGISTER_API(EvalObjBackground
);
9269 JIM_REGISTER_API(EvalObjVector
);
9270 JIM_REGISTER_API(InitHashTable
);
9271 JIM_REGISTER_API(ExpandHashTable
);
9272 JIM_REGISTER_API(AddHashEntry
);
9273 JIM_REGISTER_API(ReplaceHashEntry
);
9274 JIM_REGISTER_API(DeleteHashEntry
);
9275 JIM_REGISTER_API(FreeHashTable
);
9276 JIM_REGISTER_API(FindHashEntry
);
9277 JIM_REGISTER_API(ResizeHashTable
);
9278 JIM_REGISTER_API(GetHashTableIterator
);
9279 JIM_REGISTER_API(NextHashEntry
);
9280 JIM_REGISTER_API(NewObj
);
9281 JIM_REGISTER_API(FreeObj
);
9282 JIM_REGISTER_API(InvalidateStringRep
);
9283 JIM_REGISTER_API(InitStringRep
);
9284 JIM_REGISTER_API(DuplicateObj
);
9285 JIM_REGISTER_API(GetString
);
9286 JIM_REGISTER_API(Length
);
9287 JIM_REGISTER_API(InvalidateStringRep
);
9288 JIM_REGISTER_API(NewStringObj
);
9289 JIM_REGISTER_API(NewStringObjNoAlloc
);
9290 JIM_REGISTER_API(AppendString
);
9291 JIM_REGISTER_API(AppendString_sprintf
);
9292 JIM_REGISTER_API(AppendObj
);
9293 JIM_REGISTER_API(AppendStrings
);
9294 JIM_REGISTER_API(StringEqObj
);
9295 JIM_REGISTER_API(StringMatchObj
);
9296 JIM_REGISTER_API(StringRangeObj
);
9297 JIM_REGISTER_API(FormatString
);
9298 JIM_REGISTER_API(CompareStringImmediate
);
9299 JIM_REGISTER_API(NewReference
);
9300 JIM_REGISTER_API(GetReference
);
9301 JIM_REGISTER_API(SetFinalizer
);
9302 JIM_REGISTER_API(GetFinalizer
);
9303 JIM_REGISTER_API(CreateInterp
);
9304 JIM_REGISTER_API(FreeInterp
);
9305 JIM_REGISTER_API(GetExitCode
);
9306 JIM_REGISTER_API(SetStdin
);
9307 JIM_REGISTER_API(SetStdout
);
9308 JIM_REGISTER_API(SetStderr
);
9309 JIM_REGISTER_API(CreateCommand
);
9310 JIM_REGISTER_API(CreateProcedure
);
9311 JIM_REGISTER_API(DeleteCommand
);
9312 JIM_REGISTER_API(RenameCommand
);
9313 JIM_REGISTER_API(GetCommand
);
9314 JIM_REGISTER_API(SetVariable
);
9315 JIM_REGISTER_API(SetVariableStr
);
9316 JIM_REGISTER_API(SetGlobalVariableStr
);
9317 JIM_REGISTER_API(SetVariableStrWithStr
);
9318 JIM_REGISTER_API(SetVariableLink
);
9319 JIM_REGISTER_API(GetVariable
);
9320 JIM_REGISTER_API(GetCallFrameByLevel
);
9321 JIM_REGISTER_API(Collect
);
9322 JIM_REGISTER_API(CollectIfNeeded
);
9323 JIM_REGISTER_API(GetIndex
);
9324 JIM_REGISTER_API(NewListObj
);
9325 JIM_REGISTER_API(ListAppendElement
);
9326 JIM_REGISTER_API(ListAppendList
);
9327 JIM_REGISTER_API(ListLength
);
9328 JIM_REGISTER_API(ListIndex
);
9329 JIM_REGISTER_API(SetListIndex
);
9330 JIM_REGISTER_API(ConcatObj
);
9331 JIM_REGISTER_API(NewDictObj
);
9332 JIM_REGISTER_API(DictKey
);
9333 JIM_REGISTER_API(DictKeysVector
);
9334 JIM_REGISTER_API(GetIndex
);
9335 JIM_REGISTER_API(GetReturnCode
);
9336 JIM_REGISTER_API(EvalExpression
);
9337 JIM_REGISTER_API(GetBoolFromExpr
);
9338 JIM_REGISTER_API(GetWide
);
9339 JIM_REGISTER_API(GetLong
);
9340 JIM_REGISTER_API(SetWide
);
9341 JIM_REGISTER_API(NewIntObj
);
9342 JIM_REGISTER_API(GetDouble
);
9343 JIM_REGISTER_API(SetDouble
);
9344 JIM_REGISTER_API(NewDoubleObj
);
9345 JIM_REGISTER_API(WrongNumArgs
);
9346 JIM_REGISTER_API(SetDictKeysVector
);
9347 JIM_REGISTER_API(SubstObj
);
9348 JIM_REGISTER_API(RegisterApi
);
9349 JIM_REGISTER_API(PrintErrorMessage
);
9350 JIM_REGISTER_API(InteractivePrompt
);
9351 JIM_REGISTER_API(RegisterCoreCommands
);
9352 JIM_REGISTER_API(GetSharedString
);
9353 JIM_REGISTER_API(ReleaseSharedString
);
9354 JIM_REGISTER_API(Panic
);
9355 JIM_REGISTER_API(StrDup
);
9356 JIM_REGISTER_API(UnsetVariable
);
9357 JIM_REGISTER_API(GetVariableStr
);
9358 JIM_REGISTER_API(GetGlobalVariable
);
9359 JIM_REGISTER_API(GetGlobalVariableStr
);
9360 JIM_REGISTER_API(GetAssocData
);
9361 JIM_REGISTER_API(SetAssocData
);
9362 JIM_REGISTER_API(DeleteAssocData
);
9363 JIM_REGISTER_API(GetEnum
);
9364 JIM_REGISTER_API(ScriptIsComplete
);
9365 JIM_REGISTER_API(PackageRequire
);
9366 JIM_REGISTER_API(PackageProvide
);
9367 JIM_REGISTER_API(InitStack
);
9368 JIM_REGISTER_API(FreeStack
);
9369 JIM_REGISTER_API(StackLen
);
9370 JIM_REGISTER_API(StackPush
);
9371 JIM_REGISTER_API(StackPop
);
9372 JIM_REGISTER_API(StackPeek
);
9373 JIM_REGISTER_API(FreeStackElements
);
9374 JIM_REGISTER_API(fprintf
);
9375 JIM_REGISTER_API(vfprintf
);
9376 JIM_REGISTER_API(fwrite
);
9377 JIM_REGISTER_API(fread
);
9378 JIM_REGISTER_API(fflush
);
9379 JIM_REGISTER_API(fgets
);
9380 JIM_REGISTER_API(GetNvp
);
9381 JIM_REGISTER_API(Nvp_name2value
);
9382 JIM_REGISTER_API(Nvp_name2value_simple
);
9383 JIM_REGISTER_API(Nvp_name2value_obj
);
9384 JIM_REGISTER_API(Nvp_name2value_nocase
);
9385 JIM_REGISTER_API(Nvp_name2value_obj_nocase
);
9387 JIM_REGISTER_API(Nvp_value2name
);
9388 JIM_REGISTER_API(Nvp_value2name_simple
);
9389 JIM_REGISTER_API(Nvp_value2name_obj
);
9391 JIM_REGISTER_API(GetOpt_Setup
);
9392 JIM_REGISTER_API(GetOpt_Debug
);
9393 JIM_REGISTER_API(GetOpt_Obj
);
9394 JIM_REGISTER_API(GetOpt_String
);
9395 JIM_REGISTER_API(GetOpt_Double
);
9396 JIM_REGISTER_API(GetOpt_Wide
);
9397 JIM_REGISTER_API(GetOpt_Nvp
);
9398 JIM_REGISTER_API(GetOpt_NvpUnknown
);
9399 JIM_REGISTER_API(GetOpt_Enum
);
9401 JIM_REGISTER_API(Debug_ArgvString
);
9402 JIM_REGISTER_API(SetResult_sprintf
);
9403 JIM_REGISTER_API(SetResult_NvpUnknown
);
9407 /* -----------------------------------------------------------------------------
9408 * Core commands utility functions
9409 * ---------------------------------------------------------------------------*/
9410 void Jim_WrongNumArgs(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
,
9414 Jim_Obj
*objPtr
= Jim_NewEmptyStringObj(interp
);
9416 Jim_AppendString(interp
, objPtr
, "wrong # args: should be \"", -1);
9417 for (i
= 0; i
< argc
; i
++) {
9418 Jim_AppendObj(interp
, objPtr
, argv
[i
]);
9419 if (!(i
+1 == argc
&& msg
[0] == '\0'))
9420 Jim_AppendString(interp
, objPtr
, " ", 1);
9422 Jim_AppendString(interp
, objPtr
, msg
, -1);
9423 Jim_AppendString(interp
, objPtr
, "\"", 1);
9424 Jim_SetResult(interp
, objPtr
);
9427 static Jim_Obj
*JimCommandsList(Jim_Interp
*interp
, Jim_Obj
*patternObjPtr
)
9429 Jim_HashTableIterator
*htiter
;
9431 Jim_Obj
*listObjPtr
= Jim_NewListObj(interp
, NULL
, 0);
9432 const char *pattern
;
9435 pattern
= patternObjPtr
? Jim_GetString(patternObjPtr
, &patternLen
) : NULL
;
9436 htiter
= Jim_GetHashTableIterator(&interp
->commands
);
9437 while ((he
= Jim_NextHashEntry(htiter
)) != NULL
) {
9438 if (pattern
&& !JimStringMatch(pattern
, patternLen
, he
->key
,
9439 strlen((const char*)he
->key
), 0))
9441 Jim_ListAppendElement(interp
, listObjPtr
,
9442 Jim_NewStringObj(interp
, he
->key
, -1));
9444 Jim_FreeHashTableIterator(htiter
);
9448 #define JIM_VARLIST_GLOBALS 0
9449 #define JIM_VARLIST_LOCALS 1
9450 #define JIM_VARLIST_VARS 2
9452 static Jim_Obj
*JimVariablesList(Jim_Interp
*interp
, Jim_Obj
*patternObjPtr
,
9455 Jim_HashTableIterator
*htiter
;
9457 Jim_Obj
*listObjPtr
= Jim_NewListObj(interp
, NULL
, 0);
9458 const char *pattern
;
9461 pattern
= patternObjPtr
? Jim_GetString(patternObjPtr
, &patternLen
) : NULL
;
9462 if (mode
== JIM_VARLIST_GLOBALS
) {
9463 htiter
= Jim_GetHashTableIterator(&interp
->topFramePtr
->vars
);
9465 /* For [info locals], if we are at top level an emtpy list
9466 * is returned. I don't agree, but we aim at compatibility (SS) */
9467 if (mode
== JIM_VARLIST_LOCALS
&&
9468 interp
->framePtr
== interp
->topFramePtr
)
9470 htiter
= Jim_GetHashTableIterator(&interp
->framePtr
->vars
);
9472 while ((he
= Jim_NextHashEntry(htiter
)) != NULL
) {
9473 Jim_Var
*varPtr
= (Jim_Var
*) he
->val
;
9474 if (mode
== JIM_VARLIST_LOCALS
) {
9475 if (varPtr
->linkFramePtr
!= NULL
)
9478 if (pattern
&& !JimStringMatch(pattern
, patternLen
, he
->key
,
9479 strlen((const char*)he
->key
), 0))
9481 Jim_ListAppendElement(interp
, listObjPtr
,
9482 Jim_NewStringObj(interp
, he
->key
, -1));
9484 Jim_FreeHashTableIterator(htiter
);
9488 static int JimInfoLevel(Jim_Interp
*interp
, Jim_Obj
*levelObjPtr
,
9489 Jim_Obj
**objPtrPtr
)
9491 Jim_CallFrame
*targetCallFrame
;
9493 if (JimGetCallFrameByInteger(interp
, levelObjPtr
, &targetCallFrame
)
9496 /* No proc call at toplevel callframe */
9497 if (targetCallFrame
== interp
->topFramePtr
) {
9498 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
9499 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
9501 Jim_GetString(levelObjPtr
, NULL
), "\"", NULL
);
9504 *objPtrPtr
= Jim_NewListObj(interp
,
9505 targetCallFrame
->argv
,
9506 targetCallFrame
->argc
);
9510 /* -----------------------------------------------------------------------------
9512 * ---------------------------------------------------------------------------*/
9514 /* fake [puts] -- not the real puts, just for debugging. */
9515 static int Jim_PutsCoreCommand(Jim_Interp
*interp
, int argc
,
9516 Jim_Obj
*const *argv
)
9519 int len
, nonewline
= 0;
9521 if (argc
!= 2 && argc
!= 3) {
9522 Jim_WrongNumArgs(interp
, 1, argv
, "-nonewline string");
9526 if (!Jim_CompareStringImmediate(interp
, argv
[1], "-nonewline"))
9528 Jim_SetResultString(interp
, "The second argument must "
9529 "be -nonewline", -1);
9536 str
= Jim_GetString(argv
[1], &len
);
9537 Jim_fwrite(interp
, str
, 1, len
, interp
->cookie_stdout
);
9538 if (!nonewline
) Jim_fprintf( interp
, interp
->cookie_stdout
, JIM_NL
);
9542 /* Helper for [+] and [*] */
9543 static int Jim_AddMulHelper(Jim_Interp
*interp
, int argc
,
9544 Jim_Obj
*const *argv
, int op
)
9546 jim_wide wideValue
, res
;
9547 double doubleValue
, doubleRes
;
9550 res
= (op
== JIM_EXPROP_ADD
) ? 0 : 1;
9552 for (i
= 1; i
< argc
; i
++) {
9553 if (Jim_GetWide(interp
, argv
[i
], &wideValue
) != JIM_OK
)
9555 if (op
== JIM_EXPROP_ADD
)
9560 Jim_SetResult(interp
, Jim_NewIntObj(interp
, res
));
9563 doubleRes
= (double) res
;
9564 for (;i
< argc
; i
++) {
9565 if (Jim_GetDouble(interp
, argv
[i
], &doubleValue
) != JIM_OK
)
9567 if (op
== JIM_EXPROP_ADD
)
9568 doubleRes
+= doubleValue
;
9570 doubleRes
*= doubleValue
;
9572 Jim_SetResult(interp
, Jim_NewDoubleObj(interp
, doubleRes
));
9576 /* Helper for [-] and [/] */
9577 static int Jim_SubDivHelper(Jim_Interp
*interp
, int argc
,
9578 Jim_Obj
*const *argv
, int op
)
9580 jim_wide wideValue
, res
= 0;
9581 double doubleValue
, doubleRes
= 0;
9585 Jim_WrongNumArgs(interp
, 1, argv
, "number ?number ... number?");
9587 } else if (argc
== 2) {
9588 /* The arity = 2 case is different. For [- x] returns -x,
9589 * while [/ x] returns 1/x. */
9590 if (Jim_GetWide(interp
, argv
[1], &wideValue
) != JIM_OK
) {
9591 if (Jim_GetDouble(interp
, argv
[1], &doubleValue
) !=
9596 if (op
== JIM_EXPROP_SUB
)
9597 doubleRes
= -doubleValue
;
9599 doubleRes
= 1.0/doubleValue
;
9600 Jim_SetResult(interp
, Jim_NewDoubleObj(interp
,
9605 if (op
== JIM_EXPROP_SUB
) {
9607 Jim_SetResult(interp
, Jim_NewIntObj(interp
, res
));
9609 doubleRes
= 1.0/wideValue
;
9610 Jim_SetResult(interp
, Jim_NewDoubleObj(interp
,
9615 if (Jim_GetWide(interp
, argv
[1], &res
) != JIM_OK
) {
9616 if (Jim_GetDouble(interp
, argv
[1], &doubleRes
)
9624 for (i
= 2; i
< argc
; i
++) {
9625 if (Jim_GetWide(interp
, argv
[i
], &wideValue
) != JIM_OK
) {
9626 doubleRes
= (double) res
;
9629 if (op
== JIM_EXPROP_SUB
)
9634 Jim_SetResult(interp
, Jim_NewIntObj(interp
, res
));
9637 for (;i
< argc
; i
++) {
9638 if (Jim_GetDouble(interp
, argv
[i
], &doubleValue
) != JIM_OK
)
9640 if (op
== JIM_EXPROP_SUB
)
9641 doubleRes
-= doubleValue
;
9643 doubleRes
/= doubleValue
;
9645 Jim_SetResult(interp
, Jim_NewDoubleObj(interp
, doubleRes
));
9651 static int Jim_AddCoreCommand(Jim_Interp
*interp
, int argc
,
9652 Jim_Obj
*const *argv
)
9654 return Jim_AddMulHelper(interp
, argc
, argv
, JIM_EXPROP_ADD
);
9658 static int Jim_MulCoreCommand(Jim_Interp
*interp
, int argc
,
9659 Jim_Obj
*const *argv
)
9661 return Jim_AddMulHelper(interp
, argc
, argv
, JIM_EXPROP_MUL
);
9665 static int Jim_SubCoreCommand(Jim_Interp
*interp
, int argc
,
9666 Jim_Obj
*const *argv
)
9668 return Jim_SubDivHelper(interp
, argc
, argv
, JIM_EXPROP_SUB
);
9672 static int Jim_DivCoreCommand(Jim_Interp
*interp
, int argc
,
9673 Jim_Obj
*const *argv
)
9675 return Jim_SubDivHelper(interp
, argc
, argv
, JIM_EXPROP_DIV
);
9679 static int Jim_SetCoreCommand(Jim_Interp
*interp
, int argc
,
9680 Jim_Obj
*const *argv
)
9682 if (argc
!= 2 && argc
!= 3) {
9683 Jim_WrongNumArgs(interp
, 1, argv
, "varName ?newValue?");
9688 objPtr
= Jim_GetVariable(interp
, argv
[1], JIM_ERRMSG
);
9691 Jim_SetResult(interp
, objPtr
);
9694 /* argc == 3 case. */
9695 if (Jim_SetVariable(interp
, argv
[1], argv
[2]) != JIM_OK
)
9697 Jim_SetResult(interp
, argv
[2]);
9702 static int Jim_UnsetCoreCommand(Jim_Interp
*interp
, int argc
,
9703 Jim_Obj
*const *argv
)
9708 Jim_WrongNumArgs(interp
, 1, argv
, "varName ?varName ...?");
9711 for (i
= 1; i
< argc
; i
++) {
9712 if (Jim_UnsetVariable(interp
, argv
[i
], JIM_ERRMSG
) != JIM_OK
)
9719 static int Jim_IncrCoreCommand(Jim_Interp
*interp
, int argc
,
9720 Jim_Obj
*const *argv
)
9722 jim_wide wideValue
, increment
= 1;
9725 if (argc
!= 2 && argc
!= 3) {
9726 Jim_WrongNumArgs(interp
, 1, argv
, "varName ?increment?");
9730 if (Jim_GetWide(interp
, argv
[2], &increment
) != JIM_OK
)
9733 intObjPtr
= Jim_GetVariable(interp
, argv
[1], JIM_ERRMSG
);
9734 if (!intObjPtr
) return JIM_ERR
;
9735 if (Jim_GetWide(interp
, intObjPtr
, &wideValue
) != JIM_OK
)
9737 if (Jim_IsShared(intObjPtr
)) {
9738 intObjPtr
= Jim_NewIntObj(interp
, wideValue
+increment
);
9739 if (Jim_SetVariable(interp
, argv
[1], intObjPtr
) != JIM_OK
) {
9740 Jim_FreeNewObj(interp
, intObjPtr
);
9744 Jim_SetWide(interp
, intObjPtr
, wideValue
+increment
);
9745 /* The following step is required in order to invalidate the
9746 * string repr of "FOO" if the var name is on the form of "FOO(IDX)" */
9747 if (Jim_SetVariable(interp
, argv
[1], intObjPtr
) != JIM_OK
) {
9751 Jim_SetResult(interp
, intObjPtr
);
9756 static int Jim_WhileCoreCommand(Jim_Interp
*interp
, int argc
,
9757 Jim_Obj
*const *argv
)
9760 Jim_WrongNumArgs(interp
, 1, argv
, "condition body");
9763 /* Try to run a specialized version of while if the expression
9764 * is in one of the following forms:
9766 * $a < CONST, $a < $b
9767 * $a <= CONST, $a <= $b
9768 * $a > CONST, $a > $b
9769 * $a >= CONST, $a >= $b
9770 * $a != CONST, $a != $b
9771 * $a == CONST, $a == $b
9777 #ifdef JIM_OPTIMIZATION
9780 Jim_Obj
*varAObjPtr
= NULL
, *varBObjPtr
= NULL
, *objPtr
;
9781 int exprLen
, retval
;
9783 /* STEP 1 -- Check if there are the conditions to run the specialized
9784 * version of while */
9786 if ((expr
= Jim_GetExpression(interp
, argv
[1])) == NULL
) goto noopt
;
9787 if (expr
->len
<= 0 || expr
->len
> 3) goto noopt
;
9790 if (expr
->opcode
[0] != JIM_EXPROP_VARIABLE
&&
9791 expr
->opcode
[0] != JIM_EXPROP_NUMBER
)
9795 if (expr
->opcode
[1] != JIM_EXPROP_NOT
||
9796 expr
->opcode
[0] != JIM_EXPROP_VARIABLE
)
9800 if (expr
->opcode
[0] != JIM_EXPROP_VARIABLE
||
9801 (expr
->opcode
[1] != JIM_EXPROP_NUMBER
&&
9802 expr
->opcode
[1] != JIM_EXPROP_VARIABLE
))
9804 switch(expr
->opcode
[2]) {
9806 case JIM_EXPROP_LTE
:
9808 case JIM_EXPROP_GTE
:
9809 case JIM_EXPROP_NUMEQ
:
9810 case JIM_EXPROP_NUMNE
:
9819 "Unexpected default reached in Jim_WhileCoreCommand()");
9823 /* STEP 2 -- conditions meet. Initialization. Take different
9824 * branches for different expression lengths. */
9825 exprLen
= expr
->len
;
9830 if (expr
->opcode
[0] == JIM_EXPROP_VARIABLE
) {
9831 varAObjPtr
= expr
->obj
[0];
9832 Jim_IncrRefCount(varAObjPtr
);
9834 if (Jim_GetWide(interp
, expr
->obj
[0], &wideValue
) != JIM_OK
)
9840 Jim_GetVariable(interp
, varAObjPtr
, JIM_NONE
)) ||
9841 Jim_GetWide(interp
, objPtr
, &wideValue
) != JIM_OK
)
9843 Jim_DecrRefCount(interp
, varAObjPtr
);
9847 if (!wideValue
) break;
9848 if ((retval
= Jim_EvalObj(interp
, argv
[2])) != JIM_OK
) {
9852 Jim_DecrRefCount(interp
, varAObjPtr
);
9860 Jim_DecrRefCount(interp
, varAObjPtr
);
9866 Jim_DecrRefCount(interp
, varAObjPtr
);
9867 } else if (exprLen
== 3) {
9868 jim_wide wideValueA
, wideValueB
, cmpRes
= 0;
9869 int cmpType
= expr
->opcode
[2];
9871 varAObjPtr
= expr
->obj
[0];
9872 Jim_IncrRefCount(varAObjPtr
);
9873 if (expr
->opcode
[1] == JIM_EXPROP_VARIABLE
) {
9874 varBObjPtr
= expr
->obj
[1];
9875 Jim_IncrRefCount(varBObjPtr
);
9877 if (Jim_GetWide(interp
, expr
->obj
[1], &wideValueB
) != JIM_OK
)
9881 if (!(objPtr
= Jim_GetVariable(interp
, varAObjPtr
, JIM_NONE
)) ||
9882 Jim_GetWide(interp
, objPtr
, &wideValueA
) != JIM_OK
)
9884 Jim_DecrRefCount(interp
, varAObjPtr
);
9886 Jim_DecrRefCount(interp
, varBObjPtr
);
9891 Jim_GetVariable(interp
, varBObjPtr
, JIM_NONE
)) ||
9892 Jim_GetWide(interp
, objPtr
, &wideValueB
) != JIM_OK
)
9894 Jim_DecrRefCount(interp
, varAObjPtr
);
9896 Jim_DecrRefCount(interp
, varBObjPtr
);
9902 cmpRes
= wideValueA
< wideValueB
; break;
9903 case JIM_EXPROP_LTE
:
9904 cmpRes
= wideValueA
<= wideValueB
; break;
9906 cmpRes
= wideValueA
> wideValueB
; break;
9907 case JIM_EXPROP_GTE
:
9908 cmpRes
= wideValueA
>= wideValueB
; break;
9909 case JIM_EXPROP_NUMEQ
:
9910 cmpRes
= wideValueA
== wideValueB
; break;
9911 case JIM_EXPROP_NUMNE
:
9912 cmpRes
= wideValueA
!= wideValueB
; break;
9915 if ((retval
= Jim_EvalObj(interp
, argv
[2])) != JIM_OK
) {
9918 Jim_DecrRefCount(interp
, varAObjPtr
);
9920 Jim_DecrRefCount(interp
, varBObjPtr
);
9927 Jim_DecrRefCount(interp
, varAObjPtr
);
9929 Jim_DecrRefCount(interp
, varBObjPtr
);
9934 Jim_DecrRefCount(interp
, varAObjPtr
);
9936 Jim_DecrRefCount(interp
, varBObjPtr
);
9938 /* TODO: case for len == 2 */
9941 Jim_SetEmptyResult(interp
);
9947 /* The general purpose implementation of while starts here */
9949 int boolean
, retval
;
9951 if ((retval
= Jim_GetBoolFromExpr(interp
, argv
[1],
9952 &boolean
)) != JIM_OK
)
9954 if (!boolean
) break;
9955 if ((retval
= Jim_EvalObj(interp
, argv
[2])) != JIM_OK
) {
9969 Jim_SetEmptyResult(interp
);
9974 static int Jim_ForCoreCommand(Jim_Interp
*interp
, int argc
,
9975 Jim_Obj
*const *argv
)
9980 Jim_WrongNumArgs(interp
, 1, argv
, "start test next body");
9983 /* Check if the for is on the form:
9984 * for {set i CONST} {$i < CONST} {incr i}
9985 * for {set i CONST} {$i < $j} {incr i}
9986 * for {set i CONST} {$i <= CONST} {incr i}
9987 * for {set i CONST} {$i <= $j} {incr i}
9988 * XXX: NOTE: if variable traces are implemented, this optimization
9989 * need to be modified to check for the proc epoch at every variable
9991 #ifdef JIM_OPTIMIZATION
9993 ScriptObj
*initScript
, *incrScript
;
9995 jim_wide start
, stop
, currentVal
;
9996 unsigned jim_wide procEpoch
= interp
->procEpoch
;
9997 Jim_Obj
*varNamePtr
, *stopVarNamePtr
= NULL
, *objPtr
;
9999 struct Jim_Cmd
*cmdPtr
;
10001 /* Do it only if there aren't shared arguments */
10002 if (argv
[1] == argv
[2] || argv
[2] == argv
[3] || argv
[1] == argv
[3])
10004 initScript
= Jim_GetScript(interp
, argv
[1]);
10005 expr
= Jim_GetExpression(interp
, argv
[2]);
10006 incrScript
= Jim_GetScript(interp
, argv
[3]);
10008 /* Ensure proper lengths to start */
10009 if (initScript
->len
!= 6) goto evalstart
;
10010 if (incrScript
->len
!= 4) goto evalstart
;
10011 if (expr
->len
!= 3) goto evalstart
;
10012 /* Ensure proper token types. */
10013 if (initScript
->token
[2].type
!= JIM_TT_ESC
||
10014 initScript
->token
[4].type
!= JIM_TT_ESC
||
10015 incrScript
->token
[2].type
!= JIM_TT_ESC
||
10016 expr
->opcode
[0] != JIM_EXPROP_VARIABLE
||
10017 (expr
->opcode
[1] != JIM_EXPROP_NUMBER
&&
10018 expr
->opcode
[1] != JIM_EXPROP_VARIABLE
) ||
10019 (expr
->opcode
[2] != JIM_EXPROP_LT
&&
10020 expr
->opcode
[2] != JIM_EXPROP_LTE
))
10022 cmpType
= expr
->opcode
[2];
10023 /* Initialization command must be [set] */
10024 cmdPtr
= Jim_GetCommand(interp
, initScript
->token
[0].objPtr
, JIM_NONE
);
10025 if (cmdPtr
== NULL
|| cmdPtr
->cmdProc
!= Jim_SetCoreCommand
)
10027 /* Update command must be incr */
10028 cmdPtr
= Jim_GetCommand(interp
, incrScript
->token
[0].objPtr
, JIM_NONE
);
10029 if (cmdPtr
== NULL
|| cmdPtr
->cmdProc
!= Jim_IncrCoreCommand
)
10031 /* set, incr, expression must be about the same variable */
10032 if (!Jim_StringEqObj(initScript
->token
[2].objPtr
,
10033 incrScript
->token
[2].objPtr
, 0))
10035 if (!Jim_StringEqObj(initScript
->token
[2].objPtr
,
10038 /* Check that the initialization and comparison are valid integers */
10039 if (Jim_GetWide(interp
, initScript
->token
[4].objPtr
, &start
) == JIM_ERR
)
10041 if (expr
->opcode
[1] == JIM_EXPROP_NUMBER
&&
10042 Jim_GetWide(interp
, expr
->obj
[1], &stop
) == JIM_ERR
)
10047 /* Initialization */
10048 varNamePtr
= expr
->obj
[0];
10049 if (expr
->opcode
[1] == JIM_EXPROP_VARIABLE
) {
10050 stopVarNamePtr
= expr
->obj
[1];
10051 Jim_IncrRefCount(stopVarNamePtr
);
10053 Jim_IncrRefCount(varNamePtr
);
10055 /* --- OPTIMIZED FOR --- */
10056 /* Start to loop */
10057 objPtr
= Jim_NewIntObj(interp
, start
);
10058 if (Jim_SetVariable(interp
, varNamePtr
, objPtr
) != JIM_OK
) {
10059 Jim_DecrRefCount(interp
, varNamePtr
);
10060 if (stopVarNamePtr
) Jim_DecrRefCount(interp
, stopVarNamePtr
);
10061 Jim_FreeNewObj(interp
, objPtr
);
10065 /* === Check condition === */
10067 objPtr
= Jim_GetVariable(interp
, varNamePtr
, JIM_NONE
);
10068 if (objPtr
== NULL
||
10069 Jim_GetWide(interp
, objPtr
, ¤tVal
) != JIM_OK
)
10071 Jim_DecrRefCount(interp
, varNamePtr
);
10072 if (stopVarNamePtr
) Jim_DecrRefCount(interp
, stopVarNamePtr
);
10075 /* Immediate or Variable? get the 'stop' value if the latter. */
10076 if (stopVarNamePtr
) {
10077 objPtr
= Jim_GetVariable(interp
, stopVarNamePtr
, JIM_NONE
);
10078 if (objPtr
== NULL
||
10079 Jim_GetWide(interp
, objPtr
, &stop
) != JIM_OK
)
10081 Jim_DecrRefCount(interp
, varNamePtr
);
10082 Jim_DecrRefCount(interp
, stopVarNamePtr
);
10086 if (cmpType
== JIM_EXPROP_LT
) {
10087 if (currentVal
>= stop
) break;
10089 if (currentVal
> stop
) break;
10092 if ((retval
= Jim_EvalObj(interp
, argv
[4])) != JIM_OK
) {
10095 if (stopVarNamePtr
)
10096 Jim_DecrRefCount(interp
, stopVarNamePtr
);
10097 Jim_DecrRefCount(interp
, varNamePtr
);
10100 /* nothing to do */
10103 if (stopVarNamePtr
)
10104 Jim_DecrRefCount(interp
, stopVarNamePtr
);
10105 Jim_DecrRefCount(interp
, varNamePtr
);
10109 /* If there was a change in procedures/command continue
10110 * with the usual [for] command implementation */
10111 if (procEpoch
!= interp
->procEpoch
) {
10112 if (stopVarNamePtr
)
10113 Jim_DecrRefCount(interp
, stopVarNamePtr
);
10114 Jim_DecrRefCount(interp
, varNamePtr
);
10118 objPtr
= Jim_GetVariable(interp
, varNamePtr
, JIM_ERRMSG
);
10119 if (objPtr
->refCount
== 1 && objPtr
->typePtr
== &intObjType
) {
10120 objPtr
->internalRep
.wideValue
++;
10121 Jim_InvalidateStringRep(objPtr
);
10123 Jim_Obj
*auxObjPtr
;
10125 if (Jim_GetWide(interp
, objPtr
, ¤tVal
) == JIM_ERR
) {
10126 if (stopVarNamePtr
)
10127 Jim_DecrRefCount(interp
, stopVarNamePtr
);
10128 Jim_DecrRefCount(interp
, varNamePtr
);
10131 auxObjPtr
= Jim_NewIntObj(interp
, currentVal
+1);
10132 if (Jim_SetVariable(interp
, varNamePtr
, auxObjPtr
) == JIM_ERR
) {
10133 if (stopVarNamePtr
)
10134 Jim_DecrRefCount(interp
, stopVarNamePtr
);
10135 Jim_DecrRefCount(interp
, varNamePtr
);
10136 Jim_FreeNewObj(interp
, auxObjPtr
);
10141 if (stopVarNamePtr
)
10142 Jim_DecrRefCount(interp
, stopVarNamePtr
);
10143 Jim_DecrRefCount(interp
, varNamePtr
);
10144 Jim_SetEmptyResult(interp
);
10150 if ((retval
= Jim_EvalObj(interp
, argv
[1])) != JIM_OK
)
10155 /* Test the condition */
10156 if ((retval
= Jim_GetBoolFromExpr(interp
, argv
[2], &boolean
))
10159 if (!boolean
) break;
10161 if ((retval
= Jim_EvalObj(interp
, argv
[4])) != JIM_OK
) {
10167 /* Nothing to do */
10175 if ((retval
= Jim_EvalObj(interp
, argv
[3])) != JIM_OK
) {
10189 Jim_SetEmptyResult(interp
);
10193 /* foreach + lmap implementation. */
10194 static int JimForeachMapHelper(Jim_Interp
*interp
, int argc
,
10195 Jim_Obj
*const *argv
, int doMap
)
10197 int result
= JIM_ERR
, i
, nbrOfLists
, *listsIdx
, *listsEnd
;
10198 int nbrOfLoops
= 0;
10199 Jim_Obj
*emptyStr
, *script
, *mapRes
= NULL
;
10201 if (argc
< 4 || argc
% 2 != 0) {
10202 Jim_WrongNumArgs(interp
, 1, argv
, "varList list ?varList list ...? script");
10206 mapRes
= Jim_NewListObj(interp
, NULL
, 0);
10207 Jim_IncrRefCount(mapRes
);
10209 emptyStr
= Jim_NewEmptyStringObj(interp
);
10210 Jim_IncrRefCount(emptyStr
);
10211 script
= argv
[argc
-1]; /* Last argument is a script */
10212 nbrOfLists
= (argc
- 1 - 1) / 2; /* argc - 'foreach' - script */
10213 listsIdx
= (int*)Jim_Alloc(nbrOfLists
* sizeof(int));
10214 listsEnd
= (int*)Jim_Alloc(nbrOfLists
*2 * sizeof(int));
10215 /* Initialize iterators and remember max nbr elements each list */
10216 memset(listsIdx
, 0, nbrOfLists
* sizeof(int));
10217 /* Remember lengths of all lists and calculate how much rounds to loop */
10218 for (i
=0; i
< nbrOfLists
*2; i
+= 2) {
10221 Jim_ListLength(interp
, argv
[i
+1], &listsEnd
[i
]);
10222 Jim_ListLength(interp
, argv
[i
+2], &listsEnd
[i
+1]);
10223 if (listsEnd
[i
] == 0) {
10224 Jim_SetResultString(interp
, "foreach varlist is empty", -1);
10227 cnt
= div(listsEnd
[i
+1], listsEnd
[i
]);
10228 count
= cnt
.quot
+ (cnt
.rem
? 1 : 0);
10229 if (count
> nbrOfLoops
)
10230 nbrOfLoops
= count
;
10232 for (; nbrOfLoops
-- > 0; ) {
10233 for (i
=0; i
< nbrOfLists
; ++i
) {
10234 int varIdx
= 0, var
= i
* 2;
10235 while (varIdx
< listsEnd
[var
]) {
10236 Jim_Obj
*varName
, *ele
;
10237 int lst
= i
* 2 + 1;
10238 if (Jim_ListIndex(interp
, argv
[var
+1], varIdx
, &varName
, JIM_ERRMSG
)
10241 if (listsIdx
[i
] < listsEnd
[lst
]) {
10242 if (Jim_ListIndex(interp
, argv
[lst
+1], listsIdx
[i
], &ele
, JIM_ERRMSG
)
10245 if (Jim_SetVariable(interp
, varName
, ele
) != JIM_OK
) {
10246 Jim_SetResultString(interp
, "couldn't set loop variable: ", -1);
10249 ++listsIdx
[i
]; /* Remember next iterator of current list */
10250 } else if (Jim_SetVariable(interp
, varName
, emptyStr
) != JIM_OK
) {
10251 Jim_SetResultString(interp
, "couldn't set loop variable: ", -1);
10254 ++varIdx
; /* Next variable */
10257 switch (result
= Jim_EvalObj(interp
, script
)) {
10260 Jim_ListAppendElement(interp
, mapRes
, interp
->result
);
10274 Jim_SetResult(interp
, mapRes
);
10276 Jim_SetEmptyResult(interp
);
10279 Jim_DecrRefCount(interp
, mapRes
);
10280 Jim_DecrRefCount(interp
, emptyStr
);
10281 Jim_Free(listsIdx
);
10282 Jim_Free(listsEnd
);
10287 static int Jim_ForeachCoreCommand(Jim_Interp
*interp
, int argc
,
10288 Jim_Obj
*const *argv
)
10290 return JimForeachMapHelper(interp
, argc
, argv
, 0);
10294 static int Jim_LmapCoreCommand(Jim_Interp
*interp
, int argc
,
10295 Jim_Obj
*const *argv
)
10297 return JimForeachMapHelper(interp
, argc
, argv
, 1);
10301 static int Jim_IfCoreCommand(Jim_Interp
*interp
, int argc
,
10302 Jim_Obj
*const *argv
)
10304 int boolean
, retval
, current
= 1, falsebody
= 0;
10307 /* Far not enough arguments given! */
10308 if (current
>= argc
) goto err
;
10309 if ((retval
= Jim_GetBoolFromExpr(interp
,
10310 argv
[current
++], &boolean
))
10313 /* There lacks something, isn't it? */
10314 if (current
>= argc
) goto err
;
10315 if (Jim_CompareStringImmediate(interp
, argv
[current
],
10316 "then")) current
++;
10317 /* Tsk tsk, no then-clause? */
10318 if (current
>= argc
) goto err
;
10320 return Jim_EvalObj(interp
, argv
[current
]);
10321 /* Ok: no else-clause follows */
10322 if (++current
>= argc
) {
10323 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
10326 falsebody
= current
++;
10327 if (Jim_CompareStringImmediate(interp
, argv
[falsebody
],
10329 /* IIICKS - else-clause isn't last cmd? */
10330 if (current
!= argc
-1) goto err
;
10331 return Jim_EvalObj(interp
, argv
[current
]);
10332 } else if (Jim_CompareStringImmediate(interp
,
10333 argv
[falsebody
], "elseif"))
10334 /* Ok: elseif follows meaning all the stuff
10335 * again (how boring...) */
10337 /* OOPS - else-clause is not last cmd?*/
10338 else if (falsebody
!= argc
-1)
10340 return Jim_EvalObj(interp
, argv
[falsebody
]);
10345 Jim_WrongNumArgs(interp
, 1, argv
, "condition ?then? trueBody ?elseif ...? ?else? falseBody");
10349 enum {SWITCH_EXACT
, SWITCH_GLOB
, SWITCH_RE
, SWITCH_CMD
, SWITCH_UNKNOWN
};
10352 static int Jim_SwitchCoreCommand(Jim_Interp
*interp
, int argc
,
10353 Jim_Obj
*const *argv
)
10355 int retcode
= JIM_ERR
, matchOpt
= SWITCH_EXACT
, opt
=1, patCount
, i
;
10356 Jim_Obj
*command
= 0, *const *caseList
= 0, *strObj
;
10357 Jim_Obj
*script
= 0;
10358 if (argc
< 3) goto wrongnumargs
;
10359 for (opt
=1; opt
< argc
; ++opt
) {
10360 const char *option
= Jim_GetString(argv
[opt
], 0);
10361 if (*option
!= '-') break;
10362 else if (strncmp(option
, "--", 2) == 0) { ++opt
; break; }
10363 else if (strncmp(option
, "-exact", 2) == 0) matchOpt
= SWITCH_EXACT
;
10364 else if (strncmp(option
, "-glob", 2) == 0) matchOpt
= SWITCH_GLOB
;
10365 else if (strncmp(option
, "-regexp", 2) == 0) matchOpt
= SWITCH_RE
;
10366 else if (strncmp(option
, "-command", 2) == 0) { matchOpt
= SWITCH_CMD
;
10367 if ((argc
- opt
) < 2) goto wrongnumargs
;
10368 command
= argv
[++opt
];
10370 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
10371 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
10372 "bad option \"", option
, "\": must be -exact, -glob, "
10373 "-regexp, -command procname or --", 0);
10376 if ((argc
- opt
) < 2) goto wrongnumargs
;
10378 strObj
= argv
[opt
++];
10379 patCount
= argc
- opt
;
10380 if (patCount
== 1) {
10382 JimListGetElements(interp
, argv
[opt
], &patCount
, &vector
);
10385 caseList
= &argv
[opt
];
10386 if (patCount
== 0 || patCount
% 2 != 0) goto wrongnumargs
;
10387 for (i
=0; script
== 0 && i
< patCount
; i
+= 2) {
10388 Jim_Obj
*patObj
= caseList
[i
];
10389 if (!Jim_CompareStringImmediate(interp
, patObj
, "default")
10390 || i
< (patCount
-2)) {
10391 switch (matchOpt
) {
10393 if (Jim_StringEqObj(strObj
, patObj
, 0))
10394 script
= caseList
[i
+1];
10397 if (Jim_StringMatchObj(patObj
, strObj
, 0))
10398 script
= caseList
[i
+1];
10401 command
= Jim_NewStringObj(interp
, "regexp", -1);
10402 /* Fall thru intentionally */
10404 Jim_Obj
*parms
[] = {command
, patObj
, strObj
};
10405 int rc
= Jim_EvalObjVector(interp
, 3, parms
);
10407 /* After the execution of a command we need to
10408 * make sure to reconvert the object into a list
10409 * again. Only for the single-list style [switch]. */
10410 if (argc
-opt
== 1) {
10412 JimListGetElements(interp
, argv
[opt
], &patCount
,
10416 /* command is here already decref'd */
10417 if (rc
!= JIM_OK
) {
10421 rc
= Jim_GetLong(interp
, Jim_GetResult(interp
), &matching
);
10422 if (rc
!= JIM_OK
) {
10427 script
= caseList
[i
+1];
10431 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
10432 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
10433 "internal error: no such option implemented", 0);
10437 script
= caseList
[i
+1];
10440 for(; i
< patCount
&& Jim_CompareStringImmediate(interp
, script
, "-");
10442 script
= caseList
[i
+1];
10443 if (script
&& Jim_CompareStringImmediate(interp
, script
, "-")) {
10444 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
10445 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
10446 "no body specified for pattern \"",
10447 Jim_GetString(caseList
[i
-2], 0), "\"", 0);
10451 Jim_SetEmptyResult(interp
);
10453 retcode
= Jim_EvalObj(interp
, script
);
10456 Jim_WrongNumArgs(interp
, 1, argv
, "?options? string "
10457 "pattern body ... ?default body? or "
10458 "{pattern body ?pattern body ...?}");
10464 static int Jim_ListCoreCommand(Jim_Interp
*interp
, int argc
,
10465 Jim_Obj
*const *argv
)
10467 Jim_Obj
*listObjPtr
;
10469 listObjPtr
= Jim_NewListObj(interp
, argv
+1, argc
-1);
10470 Jim_SetResult(interp
, listObjPtr
);
10475 static int Jim_LindexCoreCommand(Jim_Interp
*interp
, int argc
,
10476 Jim_Obj
*const *argv
)
10478 Jim_Obj
*objPtr
, *listObjPtr
;
10483 Jim_WrongNumArgs(interp
, 1, argv
, "list index ?...?");
10487 Jim_IncrRefCount(objPtr
);
10488 for (i
= 2; i
< argc
; i
++) {
10489 listObjPtr
= objPtr
;
10490 if (Jim_GetIndex(interp
, argv
[i
], &index
) != JIM_OK
) {
10491 Jim_DecrRefCount(interp
, listObjPtr
);
10494 if (Jim_ListIndex(interp
, listObjPtr
, index
, &objPtr
,
10495 JIM_NONE
) != JIM_OK
) {
10496 /* Returns an empty object if the index
10497 * is out of range. */
10498 Jim_DecrRefCount(interp
, listObjPtr
);
10499 Jim_SetEmptyResult(interp
);
10502 Jim_IncrRefCount(objPtr
);
10503 Jim_DecrRefCount(interp
, listObjPtr
);
10505 Jim_SetResult(interp
, objPtr
);
10506 Jim_DecrRefCount(interp
, objPtr
);
10511 static int Jim_LlengthCoreCommand(Jim_Interp
*interp
, int argc
,
10512 Jim_Obj
*const *argv
)
10517 Jim_WrongNumArgs(interp
, 1, argv
, "list");
10520 Jim_ListLength(interp
, argv
[1], &len
);
10521 Jim_SetResult(interp
, Jim_NewIntObj(interp
, len
));
10526 static int Jim_LappendCoreCommand(Jim_Interp
*interp
, int argc
,
10527 Jim_Obj
*const *argv
)
10529 Jim_Obj
*listObjPtr
;
10533 Jim_WrongNumArgs(interp
, 1, argv
, "varName ?value value ...?");
10536 listObjPtr
= Jim_GetVariable(interp
, argv
[1], JIM_NONE
);
10538 /* Create the list if it does not exists */
10539 listObjPtr
= Jim_NewListObj(interp
, NULL
, 0);
10540 if (Jim_SetVariable(interp
, argv
[1], listObjPtr
) != JIM_OK
) {
10541 Jim_FreeNewObj(interp
, listObjPtr
);
10545 shared
= Jim_IsShared(listObjPtr
);
10547 listObjPtr
= Jim_DuplicateObj(interp
, listObjPtr
);
10548 for (i
= 2; i
< argc
; i
++)
10549 Jim_ListAppendElement(interp
, listObjPtr
, argv
[i
]);
10550 if (Jim_SetVariable(interp
, argv
[1], listObjPtr
) != JIM_OK
) {
10552 Jim_FreeNewObj(interp
, listObjPtr
);
10555 Jim_SetResult(interp
, listObjPtr
);
10560 static int Jim_LinsertCoreCommand(Jim_Interp
*interp
, int argc
,
10561 Jim_Obj
*const *argv
)
10567 Jim_WrongNumArgs(interp
, 1, argv
, "list index element "
10572 if (Jim_IsShared(listPtr
))
10573 listPtr
= Jim_DuplicateObj(interp
, listPtr
);
10574 if (Jim_GetIndex(interp
, argv
[2], &index
) != JIM_OK
)
10576 Jim_ListLength(interp
, listPtr
, &len
);
10579 else if (index
< 0)
10580 index
= len
+ index
+ 1;
10581 Jim_ListInsertElements(interp
, listPtr
, index
, argc
-3, &argv
[3]);
10582 Jim_SetResult(interp
, listPtr
);
10585 if (listPtr
!= argv
[1]) {
10586 Jim_FreeNewObj(interp
, listPtr
);
10592 static int Jim_LsetCoreCommand(Jim_Interp
*interp
, int argc
,
10593 Jim_Obj
*const *argv
)
10596 Jim_WrongNumArgs(interp
, 1, argv
, "listVar ?index...? newVal");
10598 } else if (argc
== 3) {
10599 if (Jim_SetVariable(interp
, argv
[1], argv
[2]) != JIM_OK
)
10601 Jim_SetResult(interp
, argv
[2]);
10604 if (Jim_SetListIndex(interp
, argv
[1], argv
+2, argc
-3, argv
[argc
-1])
10605 == JIM_ERR
) return JIM_ERR
;
10610 static int Jim_LsortCoreCommand(Jim_Interp
*interp
, int argc
, Jim_Obj
*const argv
[])
10612 const char *options
[] = {
10613 "-ascii", "-nocase", "-increasing", "-decreasing", NULL
10615 enum {OPT_ASCII
, OPT_NOCASE
, OPT_INCREASING
, OPT_DECREASING
};
10617 int i
, lsortType
= JIM_LSORT_ASCII
; /* default sort type */
10618 int decreasing
= 0;
10621 Jim_WrongNumArgs(interp
, 1, argv
, "?options? list");
10624 for (i
= 1; i
< (argc
-1); i
++) {
10627 if (Jim_GetEnum(interp
, argv
[i
], options
, &option
, "option", JIM_ERRMSG
)
10631 case OPT_ASCII
: lsortType
= JIM_LSORT_ASCII
; break;
10632 case OPT_NOCASE
: lsortType
= JIM_LSORT_NOCASE
; break;
10633 case OPT_INCREASING
: decreasing
= 0; break;
10634 case OPT_DECREASING
: decreasing
= 1; break;
10638 switch(lsortType
) {
10639 case JIM_LSORT_ASCII
: lsortType
= JIM_LSORT_ASCII_DECR
; break;
10640 case JIM_LSORT_NOCASE
: lsortType
= JIM_LSORT_NOCASE_DECR
; break;
10643 resObj
= Jim_DuplicateObj(interp
, argv
[argc
-1]);
10644 ListSortElements(interp
, resObj
, lsortType
);
10645 Jim_SetResult(interp
, resObj
);
10650 static int Jim_AppendCoreCommand(Jim_Interp
*interp
, int argc
,
10651 Jim_Obj
*const *argv
)
10653 Jim_Obj
*stringObjPtr
;
10657 Jim_WrongNumArgs(interp
, 1, argv
, "varName ?value value ...?");
10661 stringObjPtr
= Jim_GetVariable(interp
, argv
[1], JIM_ERRMSG
);
10662 if (!stringObjPtr
) return JIM_ERR
;
10664 stringObjPtr
= Jim_GetVariable(interp
, argv
[1], JIM_NONE
);
10665 if (!stringObjPtr
) {
10666 /* Create the string if it does not exists */
10667 stringObjPtr
= Jim_NewEmptyStringObj(interp
);
10668 if (Jim_SetVariable(interp
, argv
[1], stringObjPtr
)
10670 Jim_FreeNewObj(interp
, stringObjPtr
);
10675 shared
= Jim_IsShared(stringObjPtr
);
10677 stringObjPtr
= Jim_DuplicateObj(interp
, stringObjPtr
);
10678 for (i
= 2; i
< argc
; i
++)
10679 Jim_AppendObj(interp
, stringObjPtr
, argv
[i
]);
10680 if (Jim_SetVariable(interp
, argv
[1], stringObjPtr
) != JIM_OK
) {
10682 Jim_FreeNewObj(interp
, stringObjPtr
);
10685 Jim_SetResult(interp
, stringObjPtr
);
10690 static int Jim_DebugCoreCommand(Jim_Interp
*interp
, int argc
,
10691 Jim_Obj
*const *argv
)
10693 const char *options
[] = {
10694 "refcount", "objcount", "objects", "invstr", "scriptlen", "exprlen",
10699 OPT_REFCOUNT
, OPT_OBJCOUNT
, OPT_OBJECTS
, OPT_INVSTR
, OPT_SCRIPTLEN
,
10700 OPT_EXPRLEN
, OPT_EXPRBC
10705 Jim_WrongNumArgs(interp
, 1, argv
, "option ?...?");
10708 if (Jim_GetEnum(interp
, argv
[1], options
, &option
, "option",
10709 JIM_ERRMSG
) != JIM_OK
)
10711 if (option
== OPT_REFCOUNT
) {
10713 Jim_WrongNumArgs(interp
, 2, argv
, "object");
10716 Jim_SetResult(interp
, Jim_NewIntObj(interp
, argv
[2]->refCount
));
10718 } else if (option
== OPT_OBJCOUNT
) {
10719 int freeobj
= 0, liveobj
= 0;
10724 Jim_WrongNumArgs(interp
, 2, argv
, "");
10727 /* Count the number of free objects. */
10728 objPtr
= interp
->freeList
;
10731 objPtr
= objPtr
->nextObjPtr
;
10733 /* Count the number of live objects. */
10734 objPtr
= interp
->liveList
;
10737 objPtr
= objPtr
->nextObjPtr
;
10739 /* Set the result string and return. */
10740 sprintf(buf
, "free %d used %d", freeobj
, liveobj
);
10741 Jim_SetResultString(interp
, buf
, -1);
10743 } else if (option
== OPT_OBJECTS
) {
10744 Jim_Obj
*objPtr
, *listObjPtr
, *subListObjPtr
;
10745 /* Count the number of live objects. */
10746 objPtr
= interp
->liveList
;
10747 listObjPtr
= Jim_NewListObj(interp
, NULL
, 0);
10750 const char *type
= objPtr
->typePtr
?
10751 objPtr
->typePtr
->name
: "";
10752 subListObjPtr
= Jim_NewListObj(interp
, NULL
, 0);
10753 sprintf(buf
, "%p", objPtr
);
10754 Jim_ListAppendElement(interp
, subListObjPtr
,
10755 Jim_NewStringObj(interp
, buf
, -1));
10756 Jim_ListAppendElement(interp
, subListObjPtr
,
10757 Jim_NewStringObj(interp
, type
, -1));
10758 Jim_ListAppendElement(interp
, subListObjPtr
,
10759 Jim_NewIntObj(interp
, objPtr
->refCount
));
10760 Jim_ListAppendElement(interp
, subListObjPtr
, objPtr
);
10761 Jim_ListAppendElement(interp
, listObjPtr
, subListObjPtr
);
10762 objPtr
= objPtr
->nextObjPtr
;
10764 Jim_SetResult(interp
, listObjPtr
);
10766 } else if (option
== OPT_INVSTR
) {
10770 Jim_WrongNumArgs(interp
, 2, argv
, "object");
10774 if (objPtr
->typePtr
!= NULL
)
10775 Jim_InvalidateStringRep(objPtr
);
10776 Jim_SetEmptyResult(interp
);
10778 } else if (option
== OPT_SCRIPTLEN
) {
10781 Jim_WrongNumArgs(interp
, 2, argv
, "script");
10784 script
= Jim_GetScript(interp
, argv
[2]);
10785 Jim_SetResult(interp
, Jim_NewIntObj(interp
, script
->len
));
10787 } else if (option
== OPT_EXPRLEN
) {
10788 ExprByteCode
*expr
;
10790 Jim_WrongNumArgs(interp
, 2, argv
, "expression");
10793 expr
= Jim_GetExpression(interp
, argv
[2]);
10796 Jim_SetResult(interp
, Jim_NewIntObj(interp
, expr
->len
));
10798 } else if (option
== OPT_EXPRBC
) {
10800 ExprByteCode
*expr
;
10804 Jim_WrongNumArgs(interp
, 2, argv
, "expression");
10807 expr
= Jim_GetExpression(interp
, argv
[2]);
10810 objPtr
= Jim_NewListObj(interp
, NULL
, 0);
10811 for (i
= 0; i
< expr
->len
; i
++) {
10813 Jim_ExprOperator
*op
;
10815 switch(expr
->opcode
[i
]) {
10816 case JIM_EXPROP_NUMBER
: type
= "number"; break;
10817 case JIM_EXPROP_COMMAND
: type
= "command"; break;
10818 case JIM_EXPROP_VARIABLE
: type
= "variable"; break;
10819 case JIM_EXPROP_DICTSUGAR
: type
= "dictsugar"; break;
10820 case JIM_EXPROP_SUBST
: type
= "subst"; break;
10821 case JIM_EXPROP_STRING
: type
= "string"; break;
10823 op
= JimExprOperatorInfo(Jim_GetString(expr
->obj
[i
], NULL
));
10831 Jim_ListAppendElement(interp
, objPtr
,
10832 Jim_NewStringObj(interp
, type
, -1));
10833 Jim_ListAppendElement(interp
, objPtr
, expr
->obj
[i
]);
10835 Jim_SetResult(interp
, objPtr
);
10838 Jim_SetResultString(interp
,
10839 "bad option. Valid options are refcount, "
10840 "objcount, objects, invstr", -1);
10843 return JIM_OK
; /* unreached */
10847 static int Jim_EvalCoreCommand(Jim_Interp
*interp
, int argc
,
10848 Jim_Obj
*const *argv
)
10851 return Jim_EvalObj(interp
, argv
[1]);
10852 } else if (argc
> 2) {
10856 objPtr
= Jim_ConcatObj(interp
, argc
-1, argv
+1);
10857 Jim_IncrRefCount(objPtr
);
10858 retcode
= Jim_EvalObj(interp
, objPtr
);
10859 Jim_DecrRefCount(interp
, objPtr
);
10862 Jim_WrongNumArgs(interp
, 1, argv
, "script ?...?");
10868 static int Jim_UplevelCoreCommand(Jim_Interp
*interp
, int argc
,
10869 Jim_Obj
*const *argv
)
10872 int retcode
, newLevel
, oldLevel
;
10873 Jim_CallFrame
*savedCallFrame
, *targetCallFrame
;
10877 /* Save the old callframe pointer */
10878 savedCallFrame
= interp
->framePtr
;
10880 /* Lookup the target frame pointer */
10881 str
= Jim_GetString(argv
[1], NULL
);
10882 if ((str
[0] >= '0' && str
[0] <= '9') || str
[0] == '#')
10884 if (Jim_GetCallFrameByLevel(interp
, argv
[1],
10886 &newLevel
) != JIM_OK
)
10891 if (Jim_GetCallFrameByLevel(interp
, NULL
,
10893 &newLevel
) != JIM_OK
)
10899 Jim_WrongNumArgs(interp
, 1, argv
,
10900 "?level? command ?arg ...?");
10903 /* Eval the code in the target callframe. */
10904 interp
->framePtr
= targetCallFrame
;
10905 oldLevel
= interp
->numLevels
;
10906 interp
->numLevels
= newLevel
;
10908 retcode
= Jim_EvalObj(interp
, argv
[1]);
10910 objPtr
= Jim_ConcatObj(interp
, argc
-1, argv
+1);
10911 Jim_IncrRefCount(objPtr
);
10912 retcode
= Jim_EvalObj(interp
, objPtr
);
10913 Jim_DecrRefCount(interp
, objPtr
);
10915 interp
->numLevels
= oldLevel
;
10916 interp
->framePtr
= savedCallFrame
;
10919 Jim_WrongNumArgs(interp
, 1, argv
, "?level? command ?arg ...?");
10925 static int Jim_ExprCoreCommand(Jim_Interp
*interp
, int argc
,
10926 Jim_Obj
*const *argv
)
10928 Jim_Obj
*exprResultPtr
;
10932 retcode
= Jim_EvalExpression(interp
, argv
[1], &exprResultPtr
);
10933 } else if (argc
> 2) {
10936 objPtr
= Jim_ConcatObj(interp
, argc
-1, argv
+1);
10937 Jim_IncrRefCount(objPtr
);
10938 retcode
= Jim_EvalExpression(interp
, objPtr
, &exprResultPtr
);
10939 Jim_DecrRefCount(interp
, objPtr
);
10941 Jim_WrongNumArgs(interp
, 1, argv
, "expression ?...?");
10944 if (retcode
!= JIM_OK
) return retcode
;
10945 Jim_SetResult(interp
, exprResultPtr
);
10946 Jim_DecrRefCount(interp
, exprResultPtr
);
10951 static int Jim_BreakCoreCommand(Jim_Interp
*interp
, int argc
,
10952 Jim_Obj
*const *argv
)
10955 Jim_WrongNumArgs(interp
, 1, argv
, "");
10962 static int Jim_ContinueCoreCommand(Jim_Interp
*interp
, int argc
,
10963 Jim_Obj
*const *argv
)
10966 Jim_WrongNumArgs(interp
, 1, argv
, "");
10969 return JIM_CONTINUE
;
10973 static int Jim_ReturnCoreCommand(Jim_Interp
*interp
, int argc
,
10974 Jim_Obj
*const *argv
)
10978 } else if (argc
== 2) {
10979 Jim_SetResult(interp
, argv
[1]);
10980 interp
->returnCode
= JIM_OK
;
10982 } else if (argc
== 3 || argc
== 4) {
10984 if (Jim_GetReturnCode(interp
, argv
[2], &returnCode
) == JIM_ERR
)
10986 interp
->returnCode
= returnCode
;
10988 Jim_SetResult(interp
, argv
[3]);
10991 Jim_WrongNumArgs(interp
, 1, argv
, "?-code code? ?result?");
10994 return JIM_RETURN
; /* unreached */
10998 static int Jim_TailcallCoreCommand(Jim_Interp
*interp
, int argc
,
10999 Jim_Obj
*const *argv
)
11003 objPtr
= Jim_NewListObj(interp
, argv
+1, argc
-1);
11004 Jim_SetResult(interp
, objPtr
);
11009 static int Jim_ProcCoreCommand(Jim_Interp
*interp
, int argc
,
11010 Jim_Obj
*const *argv
)
11013 int arityMin
, arityMax
;
11015 if (argc
!= 4 && argc
!= 5) {
11016 Jim_WrongNumArgs(interp
, 1, argv
, "name arglist ?statics? body");
11019 Jim_ListLength(interp
, argv
[2], &argListLen
);
11020 arityMin
= arityMax
= argListLen
+1;
11027 /* Check for 'args' and adjust arityMin and arityMax if necessary */
11028 Jim_ListIndex(interp
, argv
[2], argListLen
-1, &argPtr
, JIM_NONE
);
11029 str
= Jim_GetString(argPtr
, &len
);
11030 if (len
== 4 && memcmp(str
, "args", 4) == 0) {
11035 /* Check for default arguments and reduce arityMin if necessary */
11036 while (arityMin
> 1) {
11038 Jim_ListIndex(interp
, argv
[2], arityMin
- 2, &argPtr
, JIM_NONE
);
11039 Jim_ListLength(interp
, argPtr
, &len
);
11041 /* No default argument */
11048 return Jim_CreateProcedure(interp
, Jim_GetString(argv
[1], NULL
),
11049 argv
[2], NULL
, argv
[3], arityMin
, arityMax
);
11051 return Jim_CreateProcedure(interp
, Jim_GetString(argv
[1], NULL
),
11052 argv
[2], argv
[3], argv
[4], arityMin
, arityMax
);
11057 static int Jim_ConcatCoreCommand(Jim_Interp
*interp
, int argc
,
11058 Jim_Obj
*const *argv
)
11060 Jim_SetResult(interp
, Jim_ConcatObj(interp
, argc
-1, argv
+1));
11065 static int Jim_UpvarCoreCommand(Jim_Interp
*interp
, int argc
,
11066 Jim_Obj
*const *argv
)
11070 Jim_CallFrame
*targetCallFrame
;
11072 /* Lookup the target frame pointer */
11073 str
= Jim_GetString(argv
[1], NULL
);
11075 ((str
[0] >= '0' && str
[0] <= '9') || str
[0] == '#'))
11077 if (Jim_GetCallFrameByLevel(interp
, argv
[1],
11078 &targetCallFrame
, NULL
) != JIM_OK
)
11083 if (Jim_GetCallFrameByLevel(interp
, NULL
,
11084 &targetCallFrame
, NULL
) != JIM_OK
)
11087 /* Check for arity */
11088 if (argc
< 3 || ((argc
-1)%2) != 0) {
11089 Jim_WrongNumArgs(interp
, 1, argv
, "?level? otherVar localVar ?otherVar localVar ...?");
11092 /* Now... for every other/local couple: */
11093 for (i
= 1; i
< argc
; i
+= 2) {
11094 if (Jim_SetVariableLink(interp
, argv
[i
+1], argv
[i
],
11095 targetCallFrame
) != JIM_OK
) return JIM_ERR
;
11101 static int Jim_GlobalCoreCommand(Jim_Interp
*interp
, int argc
,
11102 Jim_Obj
*const *argv
)
11107 Jim_WrongNumArgs(interp
, 1, argv
, "varName ?varName ...?");
11110 /* Link every var to the toplevel having the same name */
11111 if (interp
->numLevels
== 0) return JIM_OK
; /* global at toplevel... */
11112 for (i
= 1; i
< argc
; i
++) {
11113 if (Jim_SetVariableLink(interp
, argv
[i
], argv
[i
],
11114 interp
->topFramePtr
) != JIM_OK
) return JIM_ERR
;
11119 /* does the [string map] operation. On error NULL is returned,
11120 * otherwise a new string object with the result, having refcount = 0,
11122 static Jim_Obj
*JimStringMap(Jim_Interp
*interp
, Jim_Obj
*mapListObjPtr
,
11123 Jim_Obj
*objPtr
, int nocase
)
11126 const char **key
, *str
, *noMatchStart
= NULL
;
11128 int *keyLen
, strLen
, i
;
11129 Jim_Obj
*resultObjPtr
;
11131 Jim_ListLength(interp
, mapListObjPtr
, &numMaps
);
11133 Jim_SetResultString(interp
,
11134 "list must contain an even number of elements", -1);
11137 /* Initialization */
11139 key
= Jim_Alloc(sizeof(char*)*numMaps
);
11140 keyLen
= Jim_Alloc(sizeof(int)*numMaps
);
11141 value
= Jim_Alloc(sizeof(Jim_Obj
*)*numMaps
);
11142 resultObjPtr
= Jim_NewStringObj(interp
, "", 0);
11143 for (i
= 0; i
< numMaps
; i
++) {
11144 Jim_Obj
*eleObjPtr
;
11146 Jim_ListIndex(interp
, mapListObjPtr
, i
*2, &eleObjPtr
, JIM_NONE
);
11147 key
[i
] = Jim_GetString(eleObjPtr
, &keyLen
[i
]);
11148 Jim_ListIndex(interp
, mapListObjPtr
, i
*2+1, &eleObjPtr
, JIM_NONE
);
11149 value
[i
] = eleObjPtr
;
11151 str
= Jim_GetString(objPtr
, &strLen
);
11154 for (i
= 0; i
< numMaps
; i
++) {
11155 if (strLen
>= keyLen
[i
] && keyLen
[i
]) {
11156 if (!JimStringCompare(str
, keyLen
[i
], key
[i
], keyLen
[i
],
11159 if (noMatchStart
) {
11160 Jim_AppendString(interp
, resultObjPtr
,
11161 noMatchStart
, str
-noMatchStart
);
11162 noMatchStart
= NULL
;
11164 Jim_AppendObj(interp
, resultObjPtr
, value
[i
]);
11166 strLen
-= keyLen
[i
];
11171 if (i
== numMaps
) { /* no match */
11172 if (noMatchStart
== NULL
)
11173 noMatchStart
= str
;
11178 if (noMatchStart
) {
11179 Jim_AppendString(interp
, resultObjPtr
,
11180 noMatchStart
, str
-noMatchStart
);
11182 Jim_Free((void*)key
);
11185 return resultObjPtr
;
11189 static int Jim_StringCoreCommand(Jim_Interp
*interp
, int argc
,
11190 Jim_Obj
*const *argv
)
11193 const char *options
[] = {
11194 "length", "compare", "match", "equal", "range", "map", "repeat",
11195 "index", "first", "tolower", "toupper", NULL
11198 OPT_LENGTH
, OPT_COMPARE
, OPT_MATCH
, OPT_EQUAL
, OPT_RANGE
,
11199 OPT_MAP
, OPT_REPEAT
, OPT_INDEX
, OPT_FIRST
, OPT_TOLOWER
, OPT_TOUPPER
11203 Jim_WrongNumArgs(interp
, 1, argv
, "option ?arguments ...?");
11206 if (Jim_GetEnum(interp
, argv
[1], options
, &option
, "option",
11207 JIM_ERRMSG
) != JIM_OK
)
11210 if (option
== OPT_LENGTH
) {
11214 Jim_WrongNumArgs(interp
, 2, argv
, "string");
11217 Jim_GetString(argv
[2], &len
);
11218 Jim_SetResult(interp
, Jim_NewIntObj(interp
, len
));
11220 } else if (option
== OPT_COMPARE
) {
11222 if ((argc
!= 4 && argc
!= 5) ||
11223 (argc
== 5 && Jim_CompareStringImmediate(interp
,
11224 argv
[2], "-nocase") == 0)) {
11225 Jim_WrongNumArgs(interp
, 2, argv
, "string1 string2");
11232 Jim_SetResult(interp
, Jim_NewIntObj(interp
,
11233 Jim_StringCompareObj(argv
[2],
11234 argv
[3], nocase
)));
11236 } else if (option
== OPT_MATCH
) {
11238 if ((argc
!= 4 && argc
!= 5) ||
11239 (argc
== 5 && Jim_CompareStringImmediate(interp
,
11240 argv
[2], "-nocase") == 0)) {
11241 Jim_WrongNumArgs(interp
, 2, argv
, "?-nocase? pattern "
11249 Jim_SetResult(interp
,
11250 Jim_NewIntObj(interp
, Jim_StringMatchObj(argv
[2],
11251 argv
[3], nocase
)));
11253 } else if (option
== OPT_EQUAL
) {
11255 Jim_WrongNumArgs(interp
, 2, argv
, "string1 string2");
11258 Jim_SetResult(interp
,
11259 Jim_NewIntObj(interp
, Jim_StringEqObj(argv
[2],
11262 } else if (option
== OPT_RANGE
) {
11266 Jim_WrongNumArgs(interp
, 2, argv
, "string first last");
11269 objPtr
= Jim_StringRangeObj(interp
, argv
[2], argv
[3], argv
[4]);
11270 if (objPtr
== NULL
)
11272 Jim_SetResult(interp
, objPtr
);
11274 } else if (option
== OPT_MAP
) {
11278 if ((argc
!= 4 && argc
!= 5) ||
11279 (argc
== 5 && Jim_CompareStringImmediate(interp
,
11280 argv
[2], "-nocase") == 0)) {
11281 Jim_WrongNumArgs(interp
, 2, argv
, "?-nocase? mapList "
11289 objPtr
= JimStringMap(interp
, argv
[2], argv
[3], nocase
);
11290 if (objPtr
== NULL
)
11292 Jim_SetResult(interp
, objPtr
);
11294 } else if (option
== OPT_REPEAT
) {
11299 Jim_WrongNumArgs(interp
, 2, argv
, "string count");
11302 if (Jim_GetWide(interp
, argv
[3], &count
) != JIM_OK
)
11304 objPtr
= Jim_NewStringObj(interp
, "", 0);
11306 Jim_AppendObj(interp
, objPtr
, argv
[2]);
11308 Jim_SetResult(interp
, objPtr
);
11310 } else if (option
== OPT_INDEX
) {
11315 Jim_WrongNumArgs(interp
, 2, argv
, "string index");
11318 if (Jim_GetIndex(interp
, argv
[3], &index
) != JIM_OK
)
11320 str
= Jim_GetString(argv
[2], &len
);
11321 if (index
!= INT_MIN
&& index
!= INT_MAX
)
11322 index
= JimRelToAbsIndex(len
, index
);
11323 if (index
< 0 || index
>= len
) {
11324 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
11327 Jim_SetResult(interp
, Jim_NewStringObj(interp
, str
+index
, 1));
11330 } else if (option
== OPT_FIRST
) {
11331 int index
= 0, l1
, l2
;
11332 const char *s1
, *s2
;
11334 if (argc
!= 4 && argc
!= 5) {
11335 Jim_WrongNumArgs(interp
, 2, argv
, "subString string ?startIndex?");
11338 s1
= Jim_GetString(argv
[2], &l1
);
11339 s2
= Jim_GetString(argv
[3], &l2
);
11341 if (Jim_GetIndex(interp
, argv
[4], &index
) != JIM_OK
)
11343 index
= JimRelToAbsIndex(l2
, index
);
11345 Jim_SetResult(interp
, Jim_NewIntObj(interp
,
11346 JimStringFirst(s1
, l1
, s2
, l2
, index
)));
11348 } else if (option
== OPT_TOLOWER
) {
11350 Jim_WrongNumArgs(interp
, 2, argv
, "string");
11353 Jim_SetResult(interp
, JimStringToLower(interp
, argv
[2]));
11354 } else if (option
== OPT_TOUPPER
) {
11356 Jim_WrongNumArgs(interp
, 2, argv
, "string");
11359 Jim_SetResult(interp
, JimStringToUpper(interp
, argv
[2]));
11365 static int Jim_TimeCoreCommand(Jim_Interp
*interp
, int argc
,
11366 Jim_Obj
*const *argv
)
11369 jim_wide start
, elapsed
;
11371 const char *fmt
= "%" JIM_WIDE_MODIFIER
" microseconds per iteration";
11374 Jim_WrongNumArgs(interp
, 1, argv
, "script ?count?");
11378 if (Jim_GetLong(interp
, argv
[2], &count
) != JIM_OK
)
11384 start
= JimClock();
11388 if ((retval
= Jim_EvalObj(interp
, argv
[1])) != JIM_OK
)
11391 elapsed
= JimClock() - start
;
11392 sprintf(buf
, fmt
, elapsed
/count
);
11393 Jim_SetResultString(interp
, buf
, -1);
11398 static int Jim_ExitCoreCommand(Jim_Interp
*interp
, int argc
,
11399 Jim_Obj
*const *argv
)
11404 Jim_WrongNumArgs(interp
, 1, argv
, "?exitCode?");
11408 if (Jim_GetLong(interp
, argv
[1], &exitCode
) != JIM_OK
)
11411 interp
->exitCode
= exitCode
;
11416 static int Jim_CatchCoreCommand(Jim_Interp
*interp
, int argc
,
11417 Jim_Obj
*const *argv
)
11421 if (argc
!= 2 && argc
!= 3) {
11422 Jim_WrongNumArgs(interp
, 1, argv
, "script ?varName?");
11425 exitCode
= Jim_EvalObj(interp
, argv
[1]);
11427 if (Jim_SetVariable(interp
, argv
[2], Jim_GetResult(interp
))
11431 Jim_SetResult(interp
, Jim_NewIntObj(interp
, exitCode
));
11436 static int Jim_RefCoreCommand(Jim_Interp
*interp
, int argc
,
11437 Jim_Obj
*const *argv
)
11439 if (argc
!= 3 && argc
!= 4) {
11440 Jim_WrongNumArgs(interp
, 1, argv
, "string tag ?finalizer?");
11444 Jim_SetResult(interp
, Jim_NewReference(interp
, argv
[1], argv
[2], NULL
));
11446 Jim_SetResult(interp
, Jim_NewReference(interp
, argv
[1], argv
[2],
11453 static int Jim_GetrefCoreCommand(Jim_Interp
*interp
, int argc
,
11454 Jim_Obj
*const *argv
)
11456 Jim_Reference
*refPtr
;
11459 Jim_WrongNumArgs(interp
, 1, argv
, "reference");
11462 if ((refPtr
= Jim_GetReference(interp
, argv
[1])) == NULL
)
11464 Jim_SetResult(interp
, refPtr
->objPtr
);
11469 static int Jim_SetrefCoreCommand(Jim_Interp
*interp
, int argc
,
11470 Jim_Obj
*const *argv
)
11472 Jim_Reference
*refPtr
;
11475 Jim_WrongNumArgs(interp
, 1, argv
, "reference newValue");
11478 if ((refPtr
= Jim_GetReference(interp
, argv
[1])) == NULL
)
11480 Jim_IncrRefCount(argv
[2]);
11481 Jim_DecrRefCount(interp
, refPtr
->objPtr
);
11482 refPtr
->objPtr
= argv
[2];
11483 Jim_SetResult(interp
, argv
[2]);
11488 static int Jim_CollectCoreCommand(Jim_Interp
*interp
, int argc
,
11489 Jim_Obj
*const *argv
)
11492 Jim_WrongNumArgs(interp
, 1, argv
, "");
11495 Jim_SetResult(interp
, Jim_NewIntObj(interp
, Jim_Collect(interp
)));
11499 /* [finalize] reference ?newValue? */
11500 static int Jim_FinalizeCoreCommand(Jim_Interp
*interp
, int argc
,
11501 Jim_Obj
*const *argv
)
11503 if (argc
!= 2 && argc
!= 3) {
11504 Jim_WrongNumArgs(interp
, 1, argv
, "reference ?finalizerProc?");
11508 Jim_Obj
*cmdNamePtr
;
11510 if (Jim_GetFinalizer(interp
, argv
[1], &cmdNamePtr
) != JIM_OK
)
11512 if (cmdNamePtr
!= NULL
) /* otherwise the null string is returned. */
11513 Jim_SetResult(interp
, cmdNamePtr
);
11515 if (Jim_SetFinalizer(interp
, argv
[1], argv
[2]) != JIM_OK
)
11517 Jim_SetResult(interp
, argv
[2]);
11523 /* [info references] (list of all the references/finalizers) */
11526 static int Jim_RenameCoreCommand(Jim_Interp
*interp
, int argc
,
11527 Jim_Obj
*const *argv
)
11529 const char *oldName
, *newName
;
11532 Jim_WrongNumArgs(interp
, 1, argv
, "oldName newName");
11535 oldName
= Jim_GetString(argv
[1], NULL
);
11536 newName
= Jim_GetString(argv
[2], NULL
);
11537 if (Jim_RenameCommand(interp
, oldName
, newName
) != JIM_OK
) {
11538 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
11539 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
11540 "can't rename \"", oldName
, "\": ",
11541 "command doesn't exist", NULL
);
11548 static int Jim_DictCoreCommand(Jim_Interp
*interp
, int argc
,
11549 Jim_Obj
*const *argv
)
11552 const char *options
[] = {
11553 "create", "get", "set", "unset", "exists", NULL
11556 OPT_CREATE
, OPT_GET
, OPT_SET
, OPT_UNSET
, OPT_EXIST
11560 Jim_WrongNumArgs(interp
, 1, argv
, "option ?arguments ...?");
11564 if (Jim_GetEnum(interp
, argv
[1], options
, &option
, "option",
11565 JIM_ERRMSG
) != JIM_OK
)
11568 if (option
== OPT_CREATE
) {
11572 Jim_WrongNumArgs(interp
, 2, argv
, "?key value ...?");
11575 objPtr
= Jim_NewDictObj(interp
, argv
+2, argc
-2);
11576 Jim_SetResult(interp
, objPtr
);
11578 } else if (option
== OPT_GET
) {
11581 if (Jim_DictKeysVector(interp
, argv
[2], argv
+3, argc
-3, &objPtr
,
11582 JIM_ERRMSG
) != JIM_OK
)
11584 Jim_SetResult(interp
, objPtr
);
11586 } else if (option
== OPT_SET
) {
11588 Jim_WrongNumArgs(interp
, 2, argv
, "varName key ?key ...? value");
11591 return Jim_SetDictKeysVector(interp
, argv
[2], argv
+3, argc
-4,
11593 } else if (option
== OPT_UNSET
) {
11595 Jim_WrongNumArgs(interp
, 2, argv
, "varName key ?key ...?");
11598 return Jim_SetDictKeysVector(interp
, argv
[2], argv
+3, argc
-3,
11600 } else if (option
== OPT_EXIST
) {
11604 if (Jim_DictKeysVector(interp
, argv
[2], argv
+3, argc
-3, &objPtr
,
11605 JIM_ERRMSG
) == JIM_OK
)
11609 Jim_SetResult(interp
, Jim_NewIntObj(interp
, exists
));
11612 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
11613 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
11614 "bad option \"", Jim_GetString(argv
[1], NULL
), "\":",
11615 " must be create, get, set", NULL
);
11622 static int Jim_LoadCoreCommand(Jim_Interp
*interp
, int argc
,
11623 Jim_Obj
*const *argv
)
11626 Jim_WrongNumArgs(interp
, 1, argv
, "libaryFile");
11629 return Jim_LoadLibrary(interp
, Jim_GetString(argv
[1], NULL
));
11633 static int Jim_SubstCoreCommand(Jim_Interp
*interp
, int argc
,
11634 Jim_Obj
*const *argv
)
11640 Jim_WrongNumArgs(interp
, 1, argv
,
11641 "?-nobackslashes? ?-nocommands? ?-novariables? string");
11646 if (Jim_CompareStringImmediate(interp
, argv
[i
+1],
11648 flags
|= JIM_SUBST_NOESC
;
11649 else if (Jim_CompareStringImmediate(interp
, argv
[i
+1],
11651 flags
|= JIM_SUBST_NOVAR
;
11652 else if (Jim_CompareStringImmediate(interp
, argv
[i
+1],
11654 flags
|= JIM_SUBST_NOCMD
;
11656 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
11657 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
11658 "bad option \"", Jim_GetString(argv
[i
+1], NULL
),
11659 "\": must be -nobackslashes, -nocommands, or "
11660 "-novariables", NULL
);
11664 if (Jim_SubstObj(interp
, argv
[argc
-1], &objPtr
, flags
) != JIM_OK
)
11666 Jim_SetResult(interp
, objPtr
);
11671 static int Jim_InfoCoreCommand(Jim_Interp
*interp
, int argc
,
11672 Jim_Obj
*const *argv
)
11674 int cmd
, result
= JIM_OK
;
11675 static const char *commands
[] = {
11676 "body", "commands", "exists", "globals", "level", "locals",
11677 "vars", "version", "complete", "args", "hostname", NULL
11679 enum {INFO_BODY
, INFO_COMMANDS
, INFO_EXISTS
, INFO_GLOBALS
, INFO_LEVEL
,
11680 INFO_LOCALS
, INFO_VARS
, INFO_VERSION
, INFO_COMPLETE
, INFO_ARGS
, INFO_HOSTNAME
};
11683 Jim_WrongNumArgs(interp
, 1, argv
, "command ?args ...?");
11686 if (Jim_GetEnum(interp
, argv
[1], commands
, &cmd
, "command", JIM_ERRMSG
)
11691 if (cmd
== INFO_COMMANDS
) {
11692 if (argc
!= 2 && argc
!= 3) {
11693 Jim_WrongNumArgs(interp
, 2, argv
, "?pattern?");
11697 Jim_SetResult(interp
,JimCommandsList(interp
, argv
[2]));
11699 Jim_SetResult(interp
, JimCommandsList(interp
, NULL
));
11700 } else if (cmd
== INFO_EXISTS
) {
11703 Jim_WrongNumArgs(interp
, 2, argv
, "varName");
11706 exists
= Jim_GetVariable(interp
, argv
[2], 0);
11707 Jim_SetResult(interp
, Jim_NewIntObj(interp
, exists
!= 0));
11708 } else if (cmd
== INFO_GLOBALS
|| cmd
== INFO_LOCALS
|| cmd
== INFO_VARS
) {
11711 case INFO_GLOBALS
: mode
= JIM_VARLIST_GLOBALS
; break;
11712 case INFO_LOCALS
: mode
= JIM_VARLIST_LOCALS
; break;
11713 case INFO_VARS
: mode
= JIM_VARLIST_VARS
; break;
11714 default: mode
= 0; /* avoid warning */; break;
11716 if (argc
!= 2 && argc
!= 3) {
11717 Jim_WrongNumArgs(interp
, 2, argv
, "?pattern?");
11721 Jim_SetResult(interp
,JimVariablesList(interp
, argv
[2], mode
));
11723 Jim_SetResult(interp
, JimVariablesList(interp
, NULL
, mode
));
11724 } else if (cmd
== INFO_LEVEL
) {
11728 Jim_SetResult(interp
,
11729 Jim_NewIntObj(interp
, interp
->numLevels
));
11732 if (JimInfoLevel(interp
, argv
[2], &objPtr
) != JIM_OK
)
11734 Jim_SetResult(interp
, objPtr
);
11737 Jim_WrongNumArgs(interp
, 2, argv
, "?levelNum?");
11740 } else if (cmd
== INFO_BODY
|| cmd
== INFO_ARGS
) {
11744 Jim_WrongNumArgs(interp
, 2, argv
, "procname");
11747 if ((cmdPtr
= Jim_GetCommand(interp
, argv
[2], JIM_ERRMSG
)) == NULL
)
11749 if (cmdPtr
->cmdProc
!= NULL
) {
11750 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
11751 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
11752 "command \"", Jim_GetString(argv
[2], NULL
),
11753 "\" is not a procedure", NULL
);
11756 if (cmd
== INFO_BODY
)
11757 Jim_SetResult(interp
, cmdPtr
->bodyObjPtr
);
11759 Jim_SetResult(interp
, cmdPtr
->argListObjPtr
);
11760 } else if (cmd
== INFO_VERSION
) {
11761 char buf
[(JIM_INTEGER_SPACE
* 2) + 1];
11762 sprintf(buf
, "%d.%d",
11763 JIM_VERSION
/ 100, JIM_VERSION
% 100);
11764 Jim_SetResultString(interp
, buf
, -1);
11765 } else if (cmd
== INFO_COMPLETE
) {
11770 Jim_WrongNumArgs(interp
, 2, argv
, "script");
11773 s
= Jim_GetString(argv
[2], &len
);
11774 Jim_SetResult(interp
,
11775 Jim_NewIntObj(interp
, Jim_ScriptIsComplete(s
, len
, NULL
)));
11776 } else if (cmd
== INFO_HOSTNAME
) {
11777 /* Redirect to os.hostname if it exists */
11778 Jim_Obj
*command
= Jim_NewStringObj(interp
, "os.gethostname", -1);
11779 result
= Jim_EvalObjVector(interp
, 1, &command
);
11785 static int Jim_SplitCoreCommand(Jim_Interp
*interp
, int argc
,
11786 Jim_Obj
*const *argv
)
11788 const char *str
, *splitChars
, *noMatchStart
;
11789 int splitLen
, strLen
, i
;
11790 Jim_Obj
*resObjPtr
;
11792 if (argc
!= 2 && argc
!= 3) {
11793 Jim_WrongNumArgs(interp
, 1, argv
, "string ?splitChars?");
11798 splitChars
= " \n\t\r";
11801 splitChars
= Jim_GetString(argv
[2], &splitLen
);
11803 str
= Jim_GetString(argv
[1], &strLen
);
11804 if (!strLen
) return JIM_OK
;
11805 noMatchStart
= str
;
11806 resObjPtr
= Jim_NewListObj(interp
, NULL
, 0);
11810 for (i
= 0; i
< splitLen
; i
++) {
11811 if (*str
== splitChars
[i
]) {
11814 objPtr
= Jim_NewStringObj(interp
, noMatchStart
,
11815 (str
-noMatchStart
));
11816 Jim_ListAppendElement(interp
, resObjPtr
, objPtr
);
11817 noMatchStart
= str
+1;
11824 Jim_ListAppendElement(interp
, resObjPtr
,
11825 Jim_NewStringObj(interp
, noMatchStart
, (str
-noMatchStart
)));
11827 /* This handles the special case of splitchars eq {}. This
11828 * is trivial but we want to perform object sharing as Tcl does. */
11829 Jim_Obj
*objCache
[256];
11830 const unsigned char *u
= (unsigned char*) str
;
11831 memset(objCache
, 0, sizeof(objCache
));
11832 for (i
= 0; i
< strLen
; i
++) {
11835 if (objCache
[c
] == NULL
)
11836 objCache
[c
] = Jim_NewStringObj(interp
, (char*)u
+i
, 1);
11837 Jim_ListAppendElement(interp
, resObjPtr
, objCache
[c
]);
11840 Jim_SetResult(interp
, resObjPtr
);
11845 static int Jim_JoinCoreCommand(Jim_Interp
*interp
, int argc
,
11846 Jim_Obj
*const *argv
)
11848 const char *joinStr
;
11849 int joinStrLen
, i
, listLen
;
11850 Jim_Obj
*resObjPtr
;
11852 if (argc
!= 2 && argc
!= 3) {
11853 Jim_WrongNumArgs(interp
, 1, argv
, "list ?joinString?");
11861 joinStr
= Jim_GetString(argv
[2], &joinStrLen
);
11863 Jim_ListLength(interp
, argv
[1], &listLen
);
11864 resObjPtr
= Jim_NewStringObj(interp
, NULL
, 0);
11866 for (i
= 0; i
< listLen
; i
++) {
11869 Jim_ListIndex(interp
, argv
[1], i
, &objPtr
, JIM_NONE
);
11870 Jim_AppendObj(interp
, resObjPtr
, objPtr
);
11871 if (i
+1 != listLen
) {
11872 Jim_AppendString(interp
, resObjPtr
, joinStr
, joinStrLen
);
11875 Jim_SetResult(interp
, resObjPtr
);
11880 static int Jim_FormatCoreCommand(Jim_Interp
*interp
, int argc
,
11881 Jim_Obj
*const *argv
)
11886 Jim_WrongNumArgs(interp
, 1, argv
, "formatString ?arg arg ...?");
11889 objPtr
= Jim_FormatString(interp
, argv
[1], argc
-2, argv
+2);
11890 if (objPtr
== NULL
)
11892 Jim_SetResult(interp
, objPtr
);
11897 static int Jim_ScanCoreCommand(Jim_Interp
*interp
, int argc
,
11898 Jim_Obj
*const *argv
)
11900 Jim_Obj
*listPtr
, **outVec
;
11901 int outc
, i
, count
= 0;
11904 Jim_WrongNumArgs(interp
, 1, argv
, "string formatString ?varName ...?");
11907 if (argv
[2]->typePtr
!= &scanFmtStringObjType
)
11908 SetScanFmtFromAny(interp
, argv
[2]);
11909 if (FormatGetError(argv
[2]) != 0) {
11910 Jim_SetResultString(interp
, FormatGetError(argv
[2]), -1);
11914 int maxPos
= FormatGetMaxPos(argv
[2]);
11915 int count
= FormatGetCnvCount(argv
[2]);
11916 if (maxPos
> argc
-3) {
11917 Jim_SetResultString(interp
, "\"%n$\" argument index out of range", -1);
11919 } else if (count
!= 0 && count
< argc
-3) {
11920 Jim_SetResultString(interp
, "variable is not assigned by any "
11921 "conversion specifiers", -1);
11923 } else if (count
> argc
-3) {
11924 Jim_SetResultString(interp
, "different numbers of variable names and "
11925 "field specifiers", -1);
11929 listPtr
= Jim_ScanString(interp
, argv
[1], argv
[2], JIM_ERRMSG
);
11934 if (listPtr
!= 0 && listPtr
!= (Jim_Obj
*)EOF
)
11935 Jim_ListLength(interp
, listPtr
, &len
);
11936 if (listPtr
== (Jim_Obj
*)EOF
|| len
== 0) { // XXX
11937 Jim_SetResult(interp
, Jim_NewIntObj(interp
, -1));
11940 JimListGetElements(interp
, listPtr
, &outc
, &outVec
);
11941 for (i
= 0; i
< outc
; ++i
) {
11942 if (Jim_Length(outVec
[i
]) > 0) {
11944 if (Jim_SetVariable(interp
, argv
[3+i
], outVec
[i
]) != JIM_OK
)
11948 Jim_FreeNewObj(interp
, listPtr
);
11949 Jim_SetResult(interp
, Jim_NewIntObj(interp
, count
));
11951 if (listPtr
== (Jim_Obj
*)EOF
) {
11952 Jim_SetResult(interp
, Jim_NewListObj(interp
, 0, 0));
11955 Jim_SetResult(interp
, listPtr
);
11959 Jim_FreeNewObj(interp
, listPtr
);
11964 static int Jim_ErrorCoreCommand(Jim_Interp
*interp
, int argc
,
11965 Jim_Obj
*const *argv
)
11968 Jim_WrongNumArgs(interp
, 1, argv
, "message");
11971 Jim_SetResult(interp
, argv
[1]);
11976 static int Jim_LrangeCoreCommand(Jim_Interp
*interp
, int argc
,
11977 Jim_Obj
*const *argv
)
11982 Jim_WrongNumArgs(interp
, 1, argv
, "list first last");
11985 if ((objPtr
= Jim_ListRange(interp
, argv
[1], argv
[2], argv
[3])) == NULL
)
11987 Jim_SetResult(interp
, objPtr
);
11992 static int Jim_EnvCoreCommand(Jim_Interp
*interp
, int argc
,
11993 Jim_Obj
*const *argv
)
12000 #ifdef NEED_ENVIRON_EXTERN
12001 extern char **environ
;
12005 Jim_Obj
*listObjPtr
= Jim_NewListObj(interp
, NULL
, 0);
12007 for (i
= 0; environ
[i
]; i
++) {
12008 const char *equals
= strchr(environ
[i
], '=');
12010 Jim_ListAppendElement(interp
, listObjPtr
, Jim_NewStringObj(interp
, environ
[i
], equals
- environ
[i
]));
12011 Jim_ListAppendElement(interp
, listObjPtr
, Jim_NewStringObj(interp
, equals
+ 1, -1));
12015 Jim_SetResult(interp
, listObjPtr
);
12020 Jim_WrongNumArgs(interp
, 1, argv
, "varName");
12023 key
= Jim_GetString(argv
[1], NULL
);
12026 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
12027 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
12028 "environment variable \"",
12029 key
, "\" does not exist", NULL
);
12032 Jim_SetResult(interp
, Jim_NewStringObj(interp
, val
, -1));
12037 static int Jim_SourceCoreCommand(Jim_Interp
*interp
, int argc
,
12038 Jim_Obj
*const *argv
)
12043 Jim_WrongNumArgs(interp
, 1, argv
, "fileName");
12046 retval
= Jim_EvalFile(interp
, Jim_GetString(argv
[1], NULL
));
12047 if (retval
== JIM_ERR
) {
12048 return JIM_ERR_ADDSTACK
;
12050 if (retval
== JIM_RETURN
)
12056 static int Jim_LreverseCoreCommand(Jim_Interp
*interp
, int argc
,
12057 Jim_Obj
*const *argv
)
12059 Jim_Obj
*revObjPtr
, **ele
;
12063 Jim_WrongNumArgs(interp
, 1, argv
, "list");
12066 JimListGetElements(interp
, argv
[1], &len
, &ele
);
12068 revObjPtr
= Jim_NewListObj(interp
, NULL
, 0);
12070 ListAppendElement(revObjPtr
, ele
[len
--]);
12071 Jim_SetResult(interp
, revObjPtr
);
12075 static int JimRangeLen(jim_wide start
, jim_wide end
, jim_wide step
)
12079 if (step
== 0) return -1;
12080 if (start
== end
) return 0;
12081 else if (step
> 0 && start
> end
) return -1;
12082 else if (step
< 0 && end
> start
) return -1;
12084 if (len
< 0) len
= -len
; /* abs(len) */
12085 if (step
< 0) step
= -step
; /* abs(step) */
12086 len
= 1 + ((len
-1)/step
);
12087 /* We can truncate safely to INT_MAX, the range command
12088 * will always return an error for a such long range
12089 * because Tcl lists can't be so long. */
12090 if (len
> INT_MAX
) len
= INT_MAX
;
12091 return (int)((len
< 0) ? -1 : len
);
12095 static int Jim_RangeCoreCommand(Jim_Interp
*interp
, int argc
,
12096 Jim_Obj
*const *argv
)
12098 jim_wide start
= 0, end
, step
= 1;
12102 if (argc
< 2 || argc
> 4) {
12103 Jim_WrongNumArgs(interp
, 1, argv
, "?start? end ?step?");
12107 if (Jim_GetWide(interp
, argv
[1], &end
) != JIM_OK
)
12110 if (Jim_GetWide(interp
, argv
[1], &start
) != JIM_OK
||
12111 Jim_GetWide(interp
, argv
[2], &end
) != JIM_OK
)
12113 if (argc
== 4 && Jim_GetWide(interp
, argv
[3], &step
) != JIM_OK
)
12116 if ((len
= JimRangeLen(start
, end
, step
)) == -1) {
12117 Jim_SetResultString(interp
, "Invalid (infinite?) range specified", -1);
12120 objPtr
= Jim_NewListObj(interp
, NULL
, 0);
12121 for (i
= 0; i
< len
; i
++)
12122 ListAppendElement(objPtr
, Jim_NewIntObj(interp
, start
+i
*step
));
12123 Jim_SetResult(interp
, objPtr
);
12128 static int Jim_RandCoreCommand(Jim_Interp
*interp
, int argc
,
12129 Jim_Obj
*const *argv
)
12131 jim_wide min
= 0, max
, len
, maxMul
;
12133 if (argc
< 1 || argc
> 3) {
12134 Jim_WrongNumArgs(interp
, 1, argv
, "?min? max");
12138 max
= JIM_WIDE_MAX
;
12139 } else if (argc
== 2) {
12140 if (Jim_GetWide(interp
, argv
[1], &max
) != JIM_OK
)
12142 } else if (argc
== 3) {
12143 if (Jim_GetWide(interp
, argv
[1], &min
) != JIM_OK
||
12144 Jim_GetWide(interp
, argv
[2], &max
) != JIM_OK
)
12149 Jim_SetResultString(interp
, "Invalid arguments (max < min)", -1);
12152 maxMul
= JIM_WIDE_MAX
- (len
? (JIM_WIDE_MAX
%len
) : 0);
12156 JimRandomBytes(interp
, &r
, sizeof(jim_wide
));
12157 if (r
< 0 || r
>= maxMul
) continue;
12158 r
= (len
== 0) ? 0 : r
%len
;
12159 Jim_SetResult(interp
, Jim_NewIntObj(interp
, min
+r
));
12165 static int Jim_PackageCoreCommand(Jim_Interp
*interp
, int argc
,
12166 Jim_Obj
*const *argv
)
12169 const char *options
[] = {
12170 "require", "provide", NULL
12172 enum {OPT_REQUIRE
, OPT_PROVIDE
};
12175 Jim_WrongNumArgs(interp
, 1, argv
, "option ?arguments ...?");
12178 if (Jim_GetEnum(interp
, argv
[1], options
, &option
, "option",
12179 JIM_ERRMSG
) != JIM_OK
)
12182 if (option
== OPT_REQUIRE
) {
12186 if (Jim_CompareStringImmediate(interp
, argv
[2], "-exact")) {
12191 if (argc
!= 3 && argc
!= 4) {
12192 Jim_WrongNumArgs(interp
, 2, argv
, "?-exact? package ?version?");
12195 ver
= Jim_PackageRequire(interp
, Jim_GetString(argv
[2], NULL
),
12196 argc
== 4 ? Jim_GetString(argv
[3], NULL
) : "",
12199 return JIM_ERR_ADDSTACK
;
12200 Jim_SetResultString(interp
, ver
, -1);
12201 } else if (option
== OPT_PROVIDE
) {
12203 Jim_WrongNumArgs(interp
, 2, argv
, "package version");
12206 return Jim_PackageProvide(interp
, Jim_GetString(argv
[2], NULL
),
12207 Jim_GetString(argv
[3], NULL
), JIM_ERRMSG
);
12214 Jim_CmdProc cmdProc
;
12215 } Jim_CoreCommandsTable
[] = {
12216 {"set", Jim_SetCoreCommand
},
12217 {"unset", Jim_UnsetCoreCommand
},
12218 {"puts", Jim_PutsCoreCommand
},
12219 {"+", Jim_AddCoreCommand
},
12220 {"*", Jim_MulCoreCommand
},
12221 {"-", Jim_SubCoreCommand
},
12222 {"/", Jim_DivCoreCommand
},
12223 {"incr", Jim_IncrCoreCommand
},
12224 {"while", Jim_WhileCoreCommand
},
12225 {"for", Jim_ForCoreCommand
},
12226 {"foreach", Jim_ForeachCoreCommand
},
12227 {"lmap", Jim_LmapCoreCommand
},
12228 {"if", Jim_IfCoreCommand
},
12229 {"switch", Jim_SwitchCoreCommand
},
12230 {"list", Jim_ListCoreCommand
},
12231 {"lindex", Jim_LindexCoreCommand
},
12232 {"lset", Jim_LsetCoreCommand
},
12233 {"llength", Jim_LlengthCoreCommand
},
12234 {"lappend", Jim_LappendCoreCommand
},
12235 {"linsert", Jim_LinsertCoreCommand
},
12236 {"lsort", Jim_LsortCoreCommand
},
12237 {"append", Jim_AppendCoreCommand
},
12238 {"debug", Jim_DebugCoreCommand
},
12239 {"eval", Jim_EvalCoreCommand
},
12240 {"uplevel", Jim_UplevelCoreCommand
},
12241 {"expr", Jim_ExprCoreCommand
},
12242 {"break", Jim_BreakCoreCommand
},
12243 {"continue", Jim_ContinueCoreCommand
},
12244 {"proc", Jim_ProcCoreCommand
},
12245 {"concat", Jim_ConcatCoreCommand
},
12246 {"return", Jim_ReturnCoreCommand
},
12247 {"upvar", Jim_UpvarCoreCommand
},
12248 {"global", Jim_GlobalCoreCommand
},
12249 {"string", Jim_StringCoreCommand
},
12250 {"time", Jim_TimeCoreCommand
},
12251 {"exit", Jim_ExitCoreCommand
},
12252 {"catch", Jim_CatchCoreCommand
},
12253 {"ref", Jim_RefCoreCommand
},
12254 {"getref", Jim_GetrefCoreCommand
},
12255 {"setref", Jim_SetrefCoreCommand
},
12256 {"finalize", Jim_FinalizeCoreCommand
},
12257 {"collect", Jim_CollectCoreCommand
},
12258 {"rename", Jim_RenameCoreCommand
},
12259 {"dict", Jim_DictCoreCommand
},
12260 {"load", Jim_LoadCoreCommand
},
12261 {"subst", Jim_SubstCoreCommand
},
12262 {"info", Jim_InfoCoreCommand
},
12263 {"split", Jim_SplitCoreCommand
},
12264 {"join", Jim_JoinCoreCommand
},
12265 {"format", Jim_FormatCoreCommand
},
12266 {"scan", Jim_ScanCoreCommand
},
12267 {"error", Jim_ErrorCoreCommand
},
12268 {"lrange", Jim_LrangeCoreCommand
},
12269 {"env", Jim_EnvCoreCommand
},
12270 {"source", Jim_SourceCoreCommand
},
12271 {"lreverse", Jim_LreverseCoreCommand
},
12272 {"range", Jim_RangeCoreCommand
},
12273 {"rand", Jim_RandCoreCommand
},
12274 {"package", Jim_PackageCoreCommand
},
12275 {"tailcall", Jim_TailcallCoreCommand
},
12279 /* Some Jim core command is actually a procedure written in Jim itself. */
12280 static void Jim_RegisterCoreProcedures(Jim_Interp
*interp
)
12282 Jim_Eval(interp
, (char*)
12283 "proc lambda {arglist args} {\n"
12284 " set name [ref {} function lambdaFinalizer]\n"
12285 " uplevel 1 [list proc $name $arglist {expand}$args]\n"
12288 "proc lambdaFinalizer {name val} {\n"
12289 " rename $name {}\n"
12294 void Jim_RegisterCoreCommands(Jim_Interp
*interp
)
12298 while(Jim_CoreCommandsTable
[i
].name
!= NULL
) {
12299 Jim_CreateCommand(interp
,
12300 Jim_CoreCommandsTable
[i
].name
,
12301 Jim_CoreCommandsTable
[i
].cmdProc
,
12305 Jim_RegisterCoreProcedures(interp
);
12308 /* -----------------------------------------------------------------------------
12309 * Interactive prompt
12310 * ---------------------------------------------------------------------------*/
12311 void Jim_PrintErrorMessage(Jim_Interp
*interp
)
12315 if (*interp
->errorFileName
) {
12316 Jim_fprintf(interp
, interp
->cookie_stderr
, "Runtime error, file \"%s\", line %d:" JIM_NL
" ",
12317 interp
->errorFileName
, interp
->errorLine
);
12319 Jim_fprintf(interp
,interp
->cookie_stderr
, "%s" JIM_NL
,
12320 Jim_GetString(interp
->result
, NULL
));
12321 Jim_ListLength(interp
, interp
->stackTrace
, &len
);
12322 for (i
= len
-3; i
>= 0; i
-= 3) {
12324 const char *proc
, *file
, *line
;
12326 Jim_ListIndex(interp
, interp
->stackTrace
, i
, &objPtr
, JIM_NONE
);
12327 proc
= Jim_GetString(objPtr
, NULL
);
12328 Jim_ListIndex(interp
, interp
->stackTrace
, i
+1, &objPtr
,
12330 file
= Jim_GetString(objPtr
, NULL
);
12331 Jim_ListIndex(interp
, interp
->stackTrace
, i
+2, &objPtr
,
12333 line
= Jim_GetString(objPtr
, NULL
);
12335 Jim_fprintf( interp
, interp
->cookie_stderr
,
12336 "in procedure '%s' ", proc
);
12339 Jim_fprintf( interp
, interp
->cookie_stderr
,
12340 "called at file \"%s\", line %s",
12343 if (*file
|| *proc
) {
12344 Jim_fprintf( interp
, interp
->cookie_stderr
, JIM_NL
);
12349 int Jim_InteractivePrompt(Jim_Interp
*interp
)
12351 int retcode
= JIM_OK
;
12352 Jim_Obj
*scriptObjPtr
;
12354 Jim_fprintf(interp
,interp
->cookie_stdout
, "Welcome to Jim version %d.%d, "
12355 "Copyright (c) 2005-8 Salvatore Sanfilippo" JIM_NL
,
12356 JIM_VERSION
/ 100, JIM_VERSION
% 100);
12357 Jim_SetVariableStrWithStr(interp
, "jim_interactive", "1");
12360 const char *result
;
12361 const char *retcodestr
[] = {
12362 "ok", "error", "return", "break", "continue", "eval", "exit"
12366 if (retcode
!= 0) {
12367 if (retcode
>= 2 && retcode
<= 6)
12368 Jim_fprintf(interp
,interp
->cookie_stdout
, "[%s] . ", retcodestr
[retcode
]);
12370 Jim_fprintf(interp
,interp
->cookie_stdout
, "[%d] . ", retcode
);
12372 Jim_fprintf( interp
, interp
->cookie_stdout
, ". ");
12373 Jim_fflush( interp
, interp
->cookie_stdout
);
12374 scriptObjPtr
= Jim_NewStringObj(interp
, "", 0);
12375 Jim_IncrRefCount(scriptObjPtr
);
12381 if ( Jim_fgets(interp
, buf
, 1024, interp
->cookie_stdin
) == NULL
) {
12382 Jim_DecrRefCount(interp
, scriptObjPtr
);
12385 Jim_AppendString(interp
, scriptObjPtr
, buf
, -1);
12386 str
= Jim_GetString(scriptObjPtr
, &len
);
12387 if (Jim_ScriptIsComplete(str
, len
, &state
))
12389 Jim_fprintf( interp
, interp
->cookie_stdout
, "%c> ", state
);
12390 Jim_fflush( interp
, interp
->cookie_stdout
);
12392 retcode
= Jim_EvalObj(interp
, scriptObjPtr
);
12393 Jim_DecrRefCount(interp
, scriptObjPtr
);
12394 result
= Jim_GetString(Jim_GetResult(interp
), &reslen
);
12395 if (retcode
== JIM_ERR
) {
12396 Jim_PrintErrorMessage(interp
);
12397 } else if (retcode
== JIM_EXIT
) {
12398 exit(Jim_GetExitCode(interp
));
12401 Jim_fwrite( interp
, result
, 1, reslen
, interp
->cookie_stdout
);
12402 Jim_fprintf( interp
,interp
->cookie_stdout
, JIM_NL
);
12410 /* -----------------------------------------------------------------------------
12411 * Jim's idea of STDIO..
12412 * ---------------------------------------------------------------------------*/
12414 int Jim_fprintf( Jim_Interp
*interp
, void *cookie
, const char *fmt
, ... )
12420 r
= Jim_vfprintf( interp
, cookie
, fmt
,ap
);
12425 int Jim_vfprintf( Jim_Interp
*interp
, void *cookie
, const char *fmt
, va_list ap
)
12427 if( (interp
== NULL
) || (interp
->cb_vfprintf
== NULL
) ){
12431 return (*(interp
->cb_vfprintf
))( cookie
, fmt
, ap
);
12434 size_t Jim_fwrite( Jim_Interp
*interp
, const void *ptr
, size_t size
, size_t n
, void *cookie
)
12436 if( (interp
== NULL
) || (interp
->cb_fwrite
== NULL
) ){
12440 return (*(interp
->cb_fwrite
))( ptr
, size
, n
, cookie
);
12443 size_t Jim_fread( Jim_Interp
*interp
, void *ptr
, size_t size
, size_t n
, void *cookie
)
12445 if( (interp
== NULL
) || (interp
->cb_fread
== NULL
) ){
12449 return (*(interp
->cb_fread
))( ptr
, size
, n
, cookie
);
12452 int Jim_fflush( Jim_Interp
*interp
, void *cookie
)
12454 if( (interp
== NULL
) || (interp
->cb_fflush
== NULL
) ){
12455 /* pretend all is well */
12458 return (*(interp
->cb_fflush
))( cookie
);
12461 char* Jim_fgets( Jim_Interp
*interp
, char *s
, int size
, void *cookie
)
12463 if( (interp
== NULL
) || (interp
->cb_fgets
== NULL
) ){
12467 return (*(interp
->cb_fgets
))( s
, size
, cookie
);
12470 Jim_Nvp_name2value_simple( const Jim_Nvp
*p
, const char *name
)
12473 if( 0 == strcmp( name
, p
->name
) ){
12478 return ((Jim_Nvp
*)(p
));
12482 Jim_Nvp_name2value_nocase_simple( const Jim_Nvp
*p
, const char *name
)
12485 if( 0 == strcasecmp( name
, p
->name
) ){
12490 return ((Jim_Nvp
*)(p
));
12494 Jim_Nvp_name2value_obj( Jim_Interp
*interp
,
12499 return Jim_Nvp_name2value( interp
, p
, Jim_GetString( o
, NULL
), result
);
12504 Jim_Nvp_name2value( Jim_Interp
*interp
,
12511 p
= Jim_Nvp_name2value_simple( _p
, name
);
12515 *result
= (Jim_Nvp
*)(p
);
12527 Jim_Nvp_name2value_obj_nocase( Jim_Interp
*interp
, const Jim_Nvp
*p
, Jim_Obj
*o
, Jim_Nvp
**puthere
)
12529 return Jim_Nvp_name2value_nocase( interp
, p
, Jim_GetString( o
, NULL
), puthere
);
12533 Jim_Nvp_name2value_nocase( Jim_Interp
*interp
, const Jim_Nvp
*_p
, const char *name
, Jim_Nvp
**puthere
)
12537 p
= Jim_Nvp_name2value_nocase_simple( _p
, name
);
12540 *puthere
= (Jim_Nvp
*)(p
);
12552 Jim_Nvp_value2name_obj( Jim_Interp
*interp
, const Jim_Nvp
*p
, Jim_Obj
*o
, Jim_Nvp
**result
)
12557 e
= Jim_GetWide( interp
, o
, &w
);
12562 return Jim_Nvp_value2name( interp
, p
, w
, result
);
12566 Jim_Nvp_value2name_simple( const Jim_Nvp
*p
, int value
)
12569 if( value
== p
->value
){
12574 return ((Jim_Nvp
*)(p
));
12579 Jim_Nvp_value2name( Jim_Interp
*interp
, const Jim_Nvp
*_p
, int value
, Jim_Nvp
**result
)
12583 p
= Jim_Nvp_value2name_simple( _p
, value
);
12586 *result
= (Jim_Nvp
*)(p
);
12598 Jim_GetOpt_Setup( Jim_GetOptInfo
*p
, Jim_Interp
*interp
, int argc
, Jim_Obj
* const * argv
)
12600 memset( p
, 0, sizeof(*p
) );
12601 p
->interp
= interp
;
12609 Jim_GetOpt_Debug( Jim_GetOptInfo
*p
)
12613 Jim_fprintf( p
->interp
, p
->interp
->cookie_stderr
, "---args---\n");
12614 for( x
= 0 ; x
< p
->argc
; x
++ ){
12615 Jim_fprintf( p
->interp
, p
->interp
->cookie_stderr
,
12618 Jim_GetString( p
->argv
[x
], NULL
) );
12620 Jim_fprintf( p
->interp
, p
->interp
->cookie_stderr
, "-------\n");
12625 Jim_GetOpt_Obj( Jim_GetOptInfo
*goi
, Jim_Obj
**puthere
)
12629 o
= NULL
; // failure
12647 Jim_GetOpt_String( Jim_GetOptInfo
*goi
, char **puthere
, int *len
)
12654 r
= Jim_GetOpt_Obj( goi
, &o
);
12656 cp
= Jim_GetString( o
, len
);
12659 *puthere
= (char *)(cp
);
12666 Jim_GetOpt_Double( Jim_GetOptInfo
*goi
, double *puthere
)
12672 if( puthere
== NULL
){
12676 r
= Jim_GetOpt_Obj( goi
, &o
);
12678 r
= Jim_GetDouble( goi
->interp
, o
, puthere
);
12680 Jim_SetResult_sprintf( goi
->interp
,
12681 "not a number: %s",
12682 Jim_GetString( o
, NULL
) );
12689 Jim_GetOpt_Wide( Jim_GetOptInfo
*goi
, jim_wide
*puthere
)
12695 if( puthere
== NULL
){
12699 r
= Jim_GetOpt_Obj( goi
, &o
);
12701 r
= Jim_GetWide( goi
->interp
, o
, puthere
);
12706 int Jim_GetOpt_Nvp( Jim_GetOptInfo
*goi
,
12707 const Jim_Nvp
*nvp
,
12714 if( puthere
== NULL
){
12718 e
= Jim_GetOpt_Obj( goi
, &o
);
12720 e
= Jim_Nvp_name2value_obj( goi
->interp
,
12730 Jim_GetOpt_NvpUnknown( Jim_GetOptInfo
*goi
,
12731 const Jim_Nvp
*nvptable
,
12735 Jim_SetResult_NvpUnknown( goi
->interp
,
12740 Jim_SetResult_NvpUnknown( goi
->interp
,
12749 Jim_GetOpt_Enum( Jim_GetOptInfo
*goi
,
12750 const char * const * lookup
,
12757 if( puthere
== NULL
){
12760 e
= Jim_GetOpt_Obj( goi
, &o
);
12762 e
= Jim_GetEnum( goi
->interp
,
12775 Jim_SetResult_sprintf( Jim_Interp
*interp
, const char *fmt
,... )
12781 buf
= jim_vasprintf( fmt
, ap
);
12784 Jim_SetResultString( interp
, buf
, -1 );
12785 jim_vasprintf_done(buf
);
12792 Jim_SetResult_NvpUnknown( Jim_Interp
*interp
,
12793 Jim_Obj
*param_name
,
12794 Jim_Obj
*param_value
,
12795 const Jim_Nvp
*nvp
)
12798 Jim_SetResult_sprintf( interp
,
12799 "%s: Unknown: %s, try one of: ",
12800 Jim_GetString( param_name
, NULL
),
12801 Jim_GetString( param_value
, NULL
) );
12803 Jim_SetResult_sprintf( interp
,
12804 "Unknown param: %s, try one of: ",
12805 Jim_GetString( param_value
, NULL
) );
12807 while( nvp
->name
){
12811 if( (nvp
+1)->name
){
12818 Jim_AppendStrings( interp
,
12819 Jim_GetResult(interp
),
12826 static Jim_Obj
*debug_string_obj
;
12829 Jim_Debug_ArgvString( Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
12833 if( debug_string_obj
){
12834 Jim_FreeObj( interp
, debug_string_obj
);
12837 debug_string_obj
= Jim_NewEmptyStringObj( interp
);
12838 for( x
= 0 ; x
< argc
; x
++ ){
12839 Jim_AppendStrings( interp
,
12841 Jim_GetString( argv
[x
], NULL
),
12846 return Jim_GetString( debug_string_obj
, NULL
);
12852 * Local Variables: ***
12853 * c-basic-offset: 4 ***