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.
43 #define JIM_OPTIMIZATION /* comment to avoid optimizations and reduce size */
46 #include <pkgconf/jimtcl.h>
49 #define JIM_DYNLIB /* Dynamic library support for UNIX and WIN32 */
50 #endif /* JIM_ANSIC */
53 #define _GNU_SOURCE /* for vasprintf() */
65 /* sys/time - need is different */
67 #include <sys/time.h> // for gettimeofday()
70 #include "replacements.h"
72 /* Include the platform dependent libraries for
73 * dynamic loading of libraries. */
75 #if defined(_WIN32) || defined(WIN32)
82 #define WIN32_LEAN_AND_MEAN
85 #pragma warning(disable:4146)
90 #endif /* JIM_DYNLIB */
97 #include <cyg/jimtcl/jim.h>
102 #ifdef HAVE_BACKTRACE
103 #include <execinfo.h>
106 /* -----------------------------------------------------------------------------
108 * ---------------------------------------------------------------------------*/
110 /* A shared empty string for the objects string representation.
111 * Jim_InvalidateStringRep knows about it and don't try to free. */
112 static char *JimEmptyStringRep
= (char*) "";
114 /* -----------------------------------------------------------------------------
115 * Required prototypes of not exported functions
116 * ---------------------------------------------------------------------------*/
117 static void JimChangeCallFrameId(Jim_Interp
*interp
, Jim_CallFrame
*cf
);
118 static void JimFreeCallFrame(Jim_Interp
*interp
, Jim_CallFrame
*cf
, int flags
);
119 static void JimRegisterCoreApi(Jim_Interp
*interp
);
121 static Jim_HashTableType JimVariablesHashTableType
;
123 /* -----------------------------------------------------------------------------
125 * ---------------------------------------------------------------------------*/
128 jim_vasprintf( const char *fmt
, va_list ap
)
130 #ifndef HAVE_VASPRINTF
132 static char buf
[2048];
133 vsnprintf( buf
, sizeof(buf
), fmt
, ap
);
134 /* garentee termination */
135 buf
[sizeof(buf
)-1] = 0;
139 result
= vasprintf( &buf
, fmt
, ap
);
140 if (result
< 0) exit(-1);
146 jim_vasprintf_done( void *buf
)
148 #ifndef HAVE_VASPRINTF
157 * Convert a string to a jim_wide INTEGER.
158 * This function originates from BSD.
160 * Ignores `locale' stuff. Assumes that the upper and lower case
161 * alphabets and digits are each contiguous.
163 #ifdef HAVE_LONG_LONG
164 #define JimIsAscii(c) (((c) & ~0x7f) == 0)
165 static jim_wide
JimStrtoll(const char *nptr
, char **endptr
, register int base
)
167 register const char *s
;
168 register unsigned jim_wide acc
;
169 register unsigned char c
;
170 register unsigned jim_wide qbase
, cutoff
;
171 register int neg
, any
, cutlim
;
174 * Skip white space and pick up leading +/- sign if any.
175 * If base is 0, allow 0x for hex and 0 for octal, else
176 * assume decimal; if base is already 16, allow 0x.
181 } while (isspace(c
));
190 if ((base
== 0 || base
== 16) &&
191 c
== '0' && (*s
== 'x' || *s
== 'X')) {
197 base
= c
== '0' ? 8 : 10;
200 * Compute the cutoff value between legal numbers and illegal
201 * numbers. That is the largest legal value, divided by the
202 * base. An input number that is greater than this value, if
203 * followed by a legal input character, is too big. One that
204 * is equal to this value may be valid or not; the limit
205 * between valid and invalid numbers is then based on the last
206 * digit. For instance, if the range for quads is
207 * [-9223372036854775808..9223372036854775807] and the input base
208 * is 10, cutoff will be set to 922337203685477580 and cutlim to
209 * either 7 (neg==0) or 8 (neg==1), meaning that if we have
210 * accumulated a value > 922337203685477580, or equal but the
211 * next digit is > 7 (or 8), the number is too big, and we will
212 * return a range error.
214 * Set any if any `digits' consumed; make it negative to indicate
217 qbase
= (unsigned)base
;
218 cutoff
= neg
? (unsigned jim_wide
)-(LLONG_MIN
+ LLONG_MAX
) + LLONG_MAX
220 cutlim
= (int)(cutoff
% qbase
);
222 for (acc
= 0, any
= 0;; c
= *s
++) {
228 c
-= isupper(c
) ? 'A' - 10 : 'a' - 10;
233 if (any
< 0 || acc
> cutoff
|| (acc
== cutoff
&& c
> cutlim
))
242 acc
= neg
? LLONG_MIN
: LLONG_MAX
;
247 *endptr
= (char *)(any
? s
- 1 : nptr
);
252 /* Glob-style pattern matching. */
253 static int JimStringMatch(const char *pattern
, int patternLen
,
254 const char *string
, int stringLen
, int nocase
)
259 while (pattern
[1] == '*') {
264 return 1; /* match */
266 if (JimStringMatch(pattern
+1, patternLen
-1,
267 string
, stringLen
, nocase
))
268 return 1; /* match */
272 return 0; /* no match */
276 return 0; /* no match */
286 not = pattern
[0] == '^';
293 if (pattern
[0] == '\\') {
296 if (pattern
[0] == string
[0])
298 } else if (pattern
[0] == ']') {
300 } else if (patternLen
== 0) {
304 } else if (pattern
[1] == '-' && patternLen
>= 3) {
305 int start
= pattern
[0];
306 int end
= pattern
[2];
314 start
= tolower(start
);
320 if (c
>= start
&& c
<= end
)
324 if (pattern
[0] == string
[0])
327 if (tolower((int)pattern
[0]) == tolower((int)string
[0]))
337 return 0; /* no match */
343 if (patternLen
>= 2) {
350 if (pattern
[0] != string
[0])
351 return 0; /* no match */
353 if (tolower((int)pattern
[0]) != tolower((int)string
[0]))
354 return 0; /* no match */
362 if (stringLen
== 0) {
363 while(*pattern
== '*') {
370 if (patternLen
== 0 && stringLen
== 0)
375 int JimStringCompare(const char *s1
, int l1
, const char *s2
, int l2
,
378 unsigned char *u1
= (unsigned char*) s1
, *u2
= (unsigned char*) s2
;
384 u1
++; u2
++; l1
--; l2
--;
386 if (!l1
&& !l2
) return 0;
390 if (tolower((int)*u1
) != tolower((int)*u2
))
391 return tolower((int)*u1
)-tolower((int)*u2
);
392 u1
++; u2
++; l1
--; l2
--;
394 if (!l1
&& !l2
) return 0;
399 /* Search 's1' inside 's2', starting to search from char 'index' of 's2'.
400 * The index of the first occurrence of s1 in s2 is returned.
401 * If s1 is not found inside s2, -1 is returned. */
402 int JimStringFirst(const char *s1
, int l1
, const char *s2
, int l2
, int index
)
406 if (!l1
|| !l2
|| l1
> l2
) return -1;
407 if (index
< 0) index
= 0;
409 for (i
= index
; i
<= l2
-l1
; i
++) {
410 if (memcmp(s2
, s1
, l1
) == 0)
417 int Jim_WideToString(char *buf
, jim_wide wideValue
)
419 const char *fmt
= "%" JIM_WIDE_MODIFIER
;
420 return sprintf(buf
, fmt
, wideValue
);
423 int Jim_StringToWide(const char *str
, jim_wide
*widePtr
, int base
)
427 #ifdef HAVE_LONG_LONG
428 *widePtr
= JimStrtoll(str
, &endptr
, base
);
430 *widePtr
= strtol(str
, &endptr
, base
);
432 if ((str
[0] == '\0') || (str
== endptr
) )
434 if (endptr
[0] != '\0') {
436 if (!isspace((int)*endptr
))
444 int Jim_StringToIndex(const char *str
, int *intPtr
)
448 *intPtr
= strtol(str
, &endptr
, 10);
449 if ( (str
[0] == '\0') || (str
== endptr
) )
451 if (endptr
[0] != '\0') {
453 if (!isspace((int)*endptr
))
461 /* The string representation of references has two features in order
462 * to make the GC faster. The first is that every reference starts
463 * with a non common character '~', in order to make the string matching
464 * fater. The second is that the reference string rep his 32 characters
465 * in length, this allows to avoid to check every object with a string
466 * repr < 32, and usually there are many of this objects. */
468 #define JIM_REFERENCE_SPACE (35+JIM_REFERENCE_TAGLEN)
470 static int JimFormatReference(char *buf
, Jim_Reference
*refPtr
, jim_wide id
)
472 const char *fmt
= "<reference.<%s>.%020" JIM_WIDE_MODIFIER
">";
473 sprintf(buf
, fmt
, refPtr
->tag
, id
);
474 return JIM_REFERENCE_SPACE
;
477 int Jim_DoubleToString(char *buf
, double doubleValue
)
482 len
= sprintf(buf
, "%.17g", doubleValue
);
485 if (*s
== '.') return len
;
488 /* Add a final ".0" if it's a number. But not
490 if (isdigit((int)buf
[0])
491 || ((buf
[0] == '-' || buf
[0] == '+')
492 && isdigit((int)buf
[1]))) {
501 int Jim_StringToDouble(const char *str
, double *doublePtr
)
505 *doublePtr
= strtod(str
, &endptr
);
506 if (str
[0] == '\0' || endptr
[0] != '\0' || (str
== endptr
) )
511 static jim_wide
JimPowWide(jim_wide b
, jim_wide e
)
514 if ((b
==0 && e
!=0) || (e
<0)) return 0;
515 for(i
=0; i
<e
; i
++) {res
*= b
;}
519 /* -----------------------------------------------------------------------------
521 * ---------------------------------------------------------------------------*/
523 /* Note that 'interp' may be NULL if not available in the
524 * context of the panic. It's only useful to get the error
525 * file descriptor, it will default to stderr otherwise. */
526 void Jim_Panic(Jim_Interp
*interp
, const char *fmt
, ...)
532 * Send it here first.. Assuming STDIO still works
534 fprintf(stderr
, JIM_NL
"JIM INTERPRETER PANIC: ");
535 vfprintf(stderr
, fmt
, ap
);
536 fprintf(stderr
, JIM_NL JIM_NL
);
539 #ifdef HAVE_BACKTRACE
545 size
= backtrace(array
, 40);
546 strings
= backtrace_symbols(array
, size
);
547 for (i
= 0; i
< size
; i
++)
548 fprintf(fp
,"[backtrace] %s" JIM_NL
, strings
[i
]);
549 fprintf(fp
,"[backtrace] Include the above lines and the output" JIM_NL
);
550 fprintf(fp
,"[backtrace] of 'nm <executable>' in the bug report." JIM_NL
);
554 /* This may actually crash... we do it last */
555 if( interp
&& interp
->cookie_stderr
){
556 Jim_fprintf( interp
, interp
->cookie_stderr
, JIM_NL
"JIM INTERPRETER PANIC: ");
557 Jim_vfprintf( interp
, interp
->cookie_stderr
, fmt
, ap
);
558 Jim_fprintf( interp
, interp
->cookie_stderr
, JIM_NL JIM_NL
);
563 /* -----------------------------------------------------------------------------
565 * ---------------------------------------------------------------------------*/
567 /* Macro used for memory debugging.
568 * In order for they to work you have to rename Jim_Alloc into _Jim_Alloc
569 * and similary for Jim_Realloc and Jim_Free */
571 #define Jim_Alloc(s) (printf("%s %d: Jim_Alloc(%d)\n",__FILE__,__LINE__,s),_Jim_Alloc(s))
572 #define Jim_Free(p) (printf("%s %d: Jim_Free(%p)\n",__FILE__,__LINE__,p),_Jim_Free(p))
573 #define Jim_Realloc(p,s) (printf("%s %d: Jim_Realloc(%p,%d)\n",__FILE__,__LINE__,p,s),_Jim_Realloc(p,s))
576 void *Jim_Alloc(int size
)
578 /* We allocate zero length arrayes, etc. to use a single orthogonal codepath */
581 void *p
= malloc(size
);
583 Jim_Panic(NULL
,"malloc: Out of memory");
587 void Jim_Free(void *ptr
) {
591 void *Jim_Realloc(void *ptr
, int size
)
593 /* We allocate zero length arrayes, etc. to use a single orthogonal codepath */
596 void *p
= realloc(ptr
, size
);
598 Jim_Panic(NULL
,"realloc: Out of memory");
602 char *Jim_StrDup(const char *s
)
605 char *copy
= Jim_Alloc(l
+1);
607 memcpy(copy
, s
, l
+1);
611 char *Jim_StrDupLen(const char *s
, int l
)
613 char *copy
= Jim_Alloc(l
+1);
615 memcpy(copy
, s
, l
+1);
616 copy
[l
] = 0; /* Just to be sure, original could be substring */
620 /* -----------------------------------------------------------------------------
621 * Time related functions
622 * ---------------------------------------------------------------------------*/
623 /* Returns microseconds of CPU used since start. */
624 static jim_wide
JimClock(void)
626 #if (defined WIN32) && !(defined JIM_ANSIC)
628 QueryPerformanceFrequency(&f
);
629 QueryPerformanceCounter(&t
);
630 return (long)((t
.QuadPart
* 1000000) / f
.QuadPart
);
632 clock_t clocks
= clock();
634 return (long)(clocks
*(1000000/CLOCKS_PER_SEC
));
638 /* -----------------------------------------------------------------------------
640 * ---------------------------------------------------------------------------*/
642 /* -------------------------- private prototypes ---------------------------- */
643 static int JimExpandHashTableIfNeeded(Jim_HashTable
*ht
);
644 static unsigned int JimHashTableNextPower(unsigned int size
);
645 static int JimInsertHashEntry(Jim_HashTable
*ht
, const void *key
);
647 /* -------------------------- hash functions -------------------------------- */
649 /* Thomas Wang's 32 bit Mix Function */
650 unsigned int Jim_IntHashFunction(unsigned int key
)
661 /* Identity hash function for integer keys */
662 unsigned int Jim_IdentityHashFunction(unsigned int key
)
667 /* Generic hash function (we are using to multiply by 9 and add the byte
669 unsigned int Jim_GenHashFunction(const unsigned char *buf
, int len
)
677 /* ----------------------------- API implementation ------------------------- */
678 /* reset an hashtable already initialized with ht_init().
679 * NOTE: This function should only called by ht_destroy(). */
680 static void JimResetHashTable(Jim_HashTable
*ht
)
689 /* Initialize the hash table */
690 int Jim_InitHashTable(Jim_HashTable
*ht
, Jim_HashTableType
*type
,
693 JimResetHashTable(ht
);
695 ht
->privdata
= privDataPtr
;
699 /* Resize the table to the minimal size that contains all the elements,
700 * but with the invariant of a USER/BUCKETS ration near to <= 1 */
701 int Jim_ResizeHashTable(Jim_HashTable
*ht
)
703 int minimal
= ht
->used
;
705 if (minimal
< JIM_HT_INITIAL_SIZE
)
706 minimal
= JIM_HT_INITIAL_SIZE
;
707 return Jim_ExpandHashTable(ht
, minimal
);
710 /* Expand or create the hashtable */
711 int Jim_ExpandHashTable(Jim_HashTable
*ht
, unsigned int size
)
713 Jim_HashTable n
; /* the new hashtable */
714 unsigned int realsize
= JimHashTableNextPower(size
), i
;
716 /* the size is invalid if it is smaller than the number of
717 * elements already inside the hashtable */
718 if (ht
->used
>= size
)
721 Jim_InitHashTable(&n
, ht
->type
, ht
->privdata
);
723 n
.sizemask
= realsize
-1;
724 n
.table
= Jim_Alloc(realsize
*sizeof(Jim_HashEntry
*));
726 /* Initialize all the pointers to NULL */
727 memset(n
.table
, 0, realsize
*sizeof(Jim_HashEntry
*));
729 /* Copy all the elements from the old to the new table:
730 * note that if the old hash table is empty ht->size is zero,
731 * so Jim_ExpandHashTable just creates an hash table. */
733 for (i
= 0; i
< ht
->size
&& ht
->used
> 0; i
++) {
734 Jim_HashEntry
*he
, *nextHe
;
736 if (ht
->table
[i
] == NULL
) continue;
738 /* For each hash entry on this slot... */
744 /* Get the new element index */
745 h
= Jim_HashKey(ht
, he
->key
) & n
.sizemask
;
746 he
->next
= n
.table
[h
];
749 /* Pass to the next element */
753 assert(ht
->used
== 0);
756 /* Remap the new hashtable in the old */
761 /* Add an element to the target hash table */
762 int Jim_AddHashEntry(Jim_HashTable
*ht
, const void *key
, void *val
)
765 Jim_HashEntry
*entry
;
767 /* Get the index of the new element, or -1 if
768 * the element already exists. */
769 if ((index
= JimInsertHashEntry(ht
, key
)) == -1)
772 /* Allocates the memory and stores key */
773 entry
= Jim_Alloc(sizeof(*entry
));
774 entry
->next
= ht
->table
[index
];
775 ht
->table
[index
] = entry
;
777 /* Set the hash entry fields. */
778 Jim_SetHashKey(ht
, entry
, key
);
779 Jim_SetHashVal(ht
, entry
, val
);
784 /* Add an element, discarding the old if the key already exists */
785 int Jim_ReplaceHashEntry(Jim_HashTable
*ht
, const void *key
, void *val
)
787 Jim_HashEntry
*entry
;
789 /* Try to add the element. If the key
790 * does not exists Jim_AddHashEntry will suceed. */
791 if (Jim_AddHashEntry(ht
, key
, val
) == JIM_OK
)
793 /* It already exists, get the entry */
794 entry
= Jim_FindHashEntry(ht
, key
);
795 /* Free the old value and set the new one */
796 Jim_FreeEntryVal(ht
, entry
);
797 Jim_SetHashVal(ht
, entry
, val
);
801 /* Search and remove an element */
802 int Jim_DeleteHashEntry(Jim_HashTable
*ht
, const void *key
)
805 Jim_HashEntry
*he
, *prevHe
;
809 h
= Jim_HashKey(ht
, key
) & ht
->sizemask
;
814 if (Jim_CompareHashKeys(ht
, key
, he
->key
)) {
815 /* Unlink the element from the list */
817 prevHe
->next
= he
->next
;
819 ht
->table
[h
] = he
->next
;
820 Jim_FreeEntryKey(ht
, he
);
821 Jim_FreeEntryVal(ht
, he
);
829 return JIM_ERR
; /* not found */
832 /* Destroy an entire hash table */
833 int Jim_FreeHashTable(Jim_HashTable
*ht
)
837 /* Free all the elements */
838 for (i
= 0; i
< ht
->size
&& ht
->used
> 0; i
++) {
839 Jim_HashEntry
*he
, *nextHe
;
841 if ((he
= ht
->table
[i
]) == NULL
) continue;
844 Jim_FreeEntryKey(ht
, he
);
845 Jim_FreeEntryVal(ht
, he
);
851 /* Free the table and the allocated cache structure */
853 /* Re-initialize the table */
854 JimResetHashTable(ht
);
855 return JIM_OK
; /* never fails */
858 Jim_HashEntry
*Jim_FindHashEntry(Jim_HashTable
*ht
, const void *key
)
863 if (ht
->size
== 0) return NULL
;
864 h
= Jim_HashKey(ht
, key
) & ht
->sizemask
;
867 if (Jim_CompareHashKeys(ht
, key
, he
->key
))
874 Jim_HashTableIterator
*Jim_GetHashTableIterator(Jim_HashTable
*ht
)
876 Jim_HashTableIterator
*iter
= Jim_Alloc(sizeof(*iter
));
881 iter
->nextEntry
= NULL
;
885 Jim_HashEntry
*Jim_NextHashEntry(Jim_HashTableIterator
*iter
)
888 if (iter
->entry
== NULL
) {
891 (signed)iter
->ht
->size
) break;
892 iter
->entry
= iter
->ht
->table
[iter
->index
];
894 iter
->entry
= iter
->nextEntry
;
897 /* We need to save the 'next' here, the iterator user
898 * may delete the entry we are returning. */
899 iter
->nextEntry
= iter
->entry
->next
;
906 /* ------------------------- private functions ------------------------------ */
908 /* Expand the hash table if needed */
909 static int JimExpandHashTableIfNeeded(Jim_HashTable
*ht
)
911 /* If the hash table is empty expand it to the intial size,
912 * if the table is "full" dobule its size. */
914 return Jim_ExpandHashTable(ht
, JIM_HT_INITIAL_SIZE
);
915 if (ht
->size
== ht
->used
)
916 return Jim_ExpandHashTable(ht
, ht
->size
*2);
920 /* Our hash table capability is a power of two */
921 static unsigned int JimHashTableNextPower(unsigned int size
)
923 unsigned int i
= JIM_HT_INITIAL_SIZE
;
925 if (size
>= 2147483648U)
934 /* Returns the index of a free slot that can be populated with
935 * an hash entry for the given 'key'.
936 * If the key already exists, -1 is returned. */
937 static int JimInsertHashEntry(Jim_HashTable
*ht
, const void *key
)
942 /* Expand the hashtable if needed */
943 if (JimExpandHashTableIfNeeded(ht
) == JIM_ERR
)
945 /* Compute the key hash value */
946 h
= Jim_HashKey(ht
, key
) & ht
->sizemask
;
947 /* Search if this slot does not already contain the given key */
950 if (Jim_CompareHashKeys(ht
, key
, he
->key
))
957 /* ----------------------- StringCopy Hash Table Type ------------------------*/
959 static unsigned int JimStringCopyHTHashFunction(const void *key
)
961 return Jim_GenHashFunction(key
, strlen(key
));
964 static const void *JimStringCopyHTKeyDup(void *privdata
, const void *key
)
966 int len
= strlen(key
);
967 char *copy
= Jim_Alloc(len
+1);
968 JIM_NOTUSED(privdata
);
970 memcpy(copy
, key
, len
);
975 static void *JimStringKeyValCopyHTValDup(void *privdata
, const void *val
)
977 int len
= strlen(val
);
978 char *copy
= Jim_Alloc(len
+1);
979 JIM_NOTUSED(privdata
);
981 memcpy(copy
, val
, len
);
986 static int JimStringCopyHTKeyCompare(void *privdata
, const void *key1
,
989 JIM_NOTUSED(privdata
);
991 return strcmp(key1
, key2
) == 0;
994 static void JimStringCopyHTKeyDestructor(void *privdata
, const void *key
)
996 JIM_NOTUSED(privdata
);
998 Jim_Free((void*)key
); /* ATTENTION: const cast */
1001 static void JimStringKeyValCopyHTValDestructor(void *privdata
, void *val
)
1003 JIM_NOTUSED(privdata
);
1005 Jim_Free((void*)val
); /* ATTENTION: const cast */
1008 static Jim_HashTableType JimStringCopyHashTableType
= {
1009 JimStringCopyHTHashFunction
, /* hash function */
1010 JimStringCopyHTKeyDup
, /* key dup */
1012 JimStringCopyHTKeyCompare
, /* key compare */
1013 JimStringCopyHTKeyDestructor
, /* key destructor */
1014 NULL
/* val destructor */
1017 /* This is like StringCopy but does not auto-duplicate the key.
1018 * It's used for intepreter's shared strings. */
1019 static Jim_HashTableType JimSharedStringsHashTableType
= {
1020 JimStringCopyHTHashFunction
, /* hash function */
1023 JimStringCopyHTKeyCompare
, /* key compare */
1024 JimStringCopyHTKeyDestructor
, /* key destructor */
1025 NULL
/* val destructor */
1028 /* This is like StringCopy but also automatically handle dynamic
1029 * allocated C strings as values. */
1030 static Jim_HashTableType JimStringKeyValCopyHashTableType
= {
1031 JimStringCopyHTHashFunction
, /* hash function */
1032 JimStringCopyHTKeyDup
, /* key dup */
1033 JimStringKeyValCopyHTValDup
, /* val dup */
1034 JimStringCopyHTKeyCompare
, /* key compare */
1035 JimStringCopyHTKeyDestructor
, /* key destructor */
1036 JimStringKeyValCopyHTValDestructor
, /* val destructor */
1039 typedef struct AssocDataValue
{
1040 Jim_InterpDeleteProc
*delProc
;
1044 static void JimAssocDataHashTableValueDestructor(void *privdata
, void *data
)
1046 AssocDataValue
*assocPtr
= (AssocDataValue
*)data
;
1047 if (assocPtr
->delProc
!= NULL
)
1048 assocPtr
->delProc((Jim_Interp
*)privdata
, assocPtr
->data
);
1052 static Jim_HashTableType JimAssocDataHashTableType
= {
1053 JimStringCopyHTHashFunction
, /* hash function */
1054 JimStringCopyHTKeyDup
, /* key dup */
1056 JimStringCopyHTKeyCompare
, /* key compare */
1057 JimStringCopyHTKeyDestructor
, /* key destructor */
1058 JimAssocDataHashTableValueDestructor
/* val destructor */
1061 /* -----------------------------------------------------------------------------
1062 * Stack - This is a simple generic stack implementation. It is used for
1063 * example in the 'expr' expression compiler.
1064 * ---------------------------------------------------------------------------*/
1065 void Jim_InitStack(Jim_Stack
*stack
)
1069 stack
->vector
= NULL
;
1072 void Jim_FreeStack(Jim_Stack
*stack
)
1074 Jim_Free(stack
->vector
);
1077 int Jim_StackLen(Jim_Stack
*stack
)
1082 void Jim_StackPush(Jim_Stack
*stack
, void *element
) {
1083 int neededLen
= stack
->len
+1;
1084 if (neededLen
> stack
->maxlen
) {
1085 stack
->maxlen
= neededLen
*2;
1086 stack
->vector
= Jim_Realloc(stack
->vector
, sizeof(void*)*stack
->maxlen
);
1088 stack
->vector
[stack
->len
] = element
;
1092 void *Jim_StackPop(Jim_Stack
*stack
)
1094 if (stack
->len
== 0) return NULL
;
1096 return stack
->vector
[stack
->len
];
1099 void *Jim_StackPeek(Jim_Stack
*stack
)
1101 if (stack
->len
== 0) return NULL
;
1102 return stack
->vector
[stack
->len
-1];
1105 void Jim_FreeStackElements(Jim_Stack
*stack
, void (*freeFunc
)(void *ptr
))
1109 for (i
= 0; i
< stack
->len
; i
++)
1110 freeFunc(stack
->vector
[i
]);
1113 /* -----------------------------------------------------------------------------
1115 * ---------------------------------------------------------------------------*/
1118 #define JIM_TT_NONE -1 /* No token returned */
1119 #define JIM_TT_STR 0 /* simple string */
1120 #define JIM_TT_ESC 1 /* string that needs escape chars conversion */
1121 #define JIM_TT_VAR 2 /* var substitution */
1122 #define JIM_TT_DICTSUGAR 3 /* Syntax sugar for [dict get], $foo(bar) */
1123 #define JIM_TT_CMD 4 /* command substitution */
1124 #define JIM_TT_SEP 5 /* word separator */
1125 #define JIM_TT_EOL 6 /* line separator */
1127 /* Additional token types needed for expressions */
1128 #define JIM_TT_SUBEXPR_START 7
1129 #define JIM_TT_SUBEXPR_END 8
1130 #define JIM_TT_EXPR_NUMBER 9
1131 #define JIM_TT_EXPR_OPERATOR 10
1134 #define JIM_PS_DEF 0 /* Default state */
1135 #define JIM_PS_QUOTE 1 /* Inside "" */
1137 /* Parser context structure. The same context is used both to parse
1138 * Tcl scripts and lists. */
1139 struct JimParserCtx
{
1140 const char *prg
; /* Program text */
1141 const char *p
; /* Pointer to the point of the program we are parsing */
1142 int len
; /* Left length of 'prg' */
1143 int linenr
; /* Current line number */
1145 const char *tend
; /* Returned token is at tstart-tend in 'prg'. */
1146 int tline
; /* Line number of the returned token */
1147 int tt
; /* Token type */
1148 int eof
; /* Non zero if EOF condition is true. */
1149 int state
; /* Parser state */
1150 int comment
; /* Non zero if the next chars may be a comment. */
1153 #define JimParserEof(c) ((c)->eof)
1154 #define JimParserTstart(c) ((c)->tstart)
1155 #define JimParserTend(c) ((c)->tend)
1156 #define JimParserTtype(c) ((c)->tt)
1157 #define JimParserTline(c) ((c)->tline)
1159 static int JimParseScript(struct JimParserCtx
*pc
);
1160 static int JimParseSep(struct JimParserCtx
*pc
);
1161 static int JimParseEol(struct JimParserCtx
*pc
);
1162 static int JimParseCmd(struct JimParserCtx
*pc
);
1163 static int JimParseVar(struct JimParserCtx
*pc
);
1164 static int JimParseBrace(struct JimParserCtx
*pc
);
1165 static int JimParseStr(struct JimParserCtx
*pc
);
1166 static int JimParseComment(struct JimParserCtx
*pc
);
1167 static char *JimParserGetToken(struct JimParserCtx
*pc
,
1168 int *lenPtr
, int *typePtr
, int *linePtr
);
1170 /* Initialize a parser context.
1171 * 'prg' is a pointer to the program text, linenr is the line
1172 * number of the first line contained in the program. */
1173 void JimParserInit(struct JimParserCtx
*pc
, const char *prg
,
1174 int len
, int linenr
)
1182 pc
->tt
= JIM_TT_NONE
;
1184 pc
->state
= JIM_PS_DEF
;
1185 pc
->linenr
= linenr
;
1189 int JimParseScript(struct JimParserCtx
*pc
)
1191 while(1) { /* the while is used to reiterate with continue if needed */
1195 pc
->tline
= pc
->linenr
;
1196 pc
->tt
= JIM_TT_EOL
;
1202 if (*(pc
->p
+1) == '\n')
1203 return JimParseSep(pc
);
1206 return JimParseStr(pc
);
1212 if (pc
->state
== JIM_PS_DEF
)
1213 return JimParseSep(pc
);
1216 return JimParseStr(pc
);
1222 if (pc
->state
== JIM_PS_DEF
)
1223 return JimParseEol(pc
);
1225 return JimParseStr(pc
);
1229 return JimParseCmd(pc
);
1233 if (JimParseVar(pc
) == JIM_ERR
) {
1234 pc
->tstart
= pc
->tend
= pc
->p
++; pc
->len
--;
1235 pc
->tline
= pc
->linenr
;
1236 pc
->tt
= JIM_TT_STR
;
1243 JimParseComment(pc
);
1246 return JimParseStr(pc
);
1250 return JimParseStr(pc
);
1257 int JimParseSep(struct JimParserCtx
*pc
)
1260 pc
->tline
= pc
->linenr
;
1261 while (*pc
->p
== ' ' || *pc
->p
== '\t' || *pc
->p
== '\r' ||
1262 (*pc
->p
== '\\' && *(pc
->p
+1) == '\n')) {
1263 if (*pc
->p
== '\\') {
1270 pc
->tt
= JIM_TT_SEP
;
1274 int JimParseEol(struct JimParserCtx
*pc
)
1277 pc
->tline
= pc
->linenr
;
1278 while (*pc
->p
== ' ' || *pc
->p
== '\n' ||
1279 *pc
->p
== '\t' || *pc
->p
== '\r' || *pc
->p
== ';') {
1285 pc
->tt
= JIM_TT_EOL
;
1289 /* Todo. Don't stop if ']' appears inside {} or quoted.
1290 * Also should handle the case of puts [string length "]"] */
1291 int JimParseCmd(struct JimParserCtx
*pc
)
1296 pc
->tstart
= ++pc
->p
; pc
->len
--;
1297 pc
->tline
= pc
->linenr
;
1301 } else if (*pc
->p
== '[' && blevel
== 0) {
1303 } else if (*pc
->p
== ']' && blevel
== 0) {
1306 } else if (*pc
->p
== '\\') {
1308 } else if (*pc
->p
== '{') {
1310 } else if (*pc
->p
== '}') {
1313 } else if (*pc
->p
== '\n')
1318 pc
->tt
= JIM_TT_CMD
;
1319 if (*pc
->p
== ']') {
1325 int JimParseVar(struct JimParserCtx
*pc
)
1327 int brace
= 0, stop
= 0, ttype
= JIM_TT_VAR
;
1329 pc
->tstart
= ++pc
->p
; pc
->len
--; /* skip the $ */
1330 pc
->tline
= pc
->linenr
;
1331 if (*pc
->p
== '{') {
1332 pc
->tstart
= ++pc
->p
; pc
->len
--;
1337 if (*pc
->p
== '}' || pc
->len
== 0) {
1343 else if (*pc
->p
== '\n')
1348 /* Include leading colons */
1349 while (*pc
->p
== ':') {
1354 if (!((*pc
->p
>= 'a' && *pc
->p
<= 'z') ||
1355 (*pc
->p
>= 'A' && *pc
->p
<= 'Z') ||
1356 (*pc
->p
>= '0' && *pc
->p
<= '9') || *pc
->p
== '_'))
1362 /* Parse [dict get] syntax sugar. */
1363 if (*pc
->p
== '(') {
1364 while (*pc
->p
!= ')' && pc
->len
) {
1366 if (*pc
->p
== '\\' && pc
->len
>= 2) {
1367 pc
->p
+= 2; pc
->len
-= 2;
1370 if (*pc
->p
!= '\0') {
1373 ttype
= JIM_TT_DICTSUGAR
;
1377 /* Check if we parsed just the '$' character.
1378 * That's not a variable so an error is returned
1379 * to tell the state machine to consider this '$' just
1381 if (pc
->tstart
== pc
->p
) {
1389 int JimParseBrace(struct JimParserCtx
*pc
)
1393 pc
->tstart
= ++pc
->p
; pc
->len
--;
1394 pc
->tline
= pc
->linenr
;
1396 if (*pc
->p
== '\\' && pc
->len
>= 2) {
1400 } else if (*pc
->p
== '{') {
1402 } else if (pc
->len
== 0 || *pc
->p
== '}') {
1404 if (pc
->len
== 0 || level
== 0) {
1409 pc
->tt
= JIM_TT_STR
;
1412 } else if (*pc
->p
== '\n') {
1417 return JIM_OK
; /* unreached */
1420 int JimParseStr(struct JimParserCtx
*pc
)
1422 int newword
= (pc
->tt
== JIM_TT_SEP
|| pc
->tt
== JIM_TT_EOL
||
1423 pc
->tt
== JIM_TT_NONE
|| pc
->tt
== JIM_TT_STR
);
1424 if (newword
&& *pc
->p
== '{') {
1425 return JimParseBrace(pc
);
1426 } else if (newword
&& *pc
->p
== '"') {
1427 pc
->state
= JIM_PS_QUOTE
;
1431 pc
->tline
= pc
->linenr
;
1435 pc
->tt
= JIM_TT_ESC
;
1440 if (pc
->state
== JIM_PS_DEF
&&
1441 *(pc
->p
+1) == '\n') {
1443 pc
->tt
= JIM_TT_ESC
;
1453 pc
->tt
= JIM_TT_ESC
;
1460 if (pc
->state
== JIM_PS_DEF
) {
1462 pc
->tt
= JIM_TT_ESC
;
1464 } else if (*pc
->p
== '\n') {
1469 if (pc
->state
== JIM_PS_QUOTE
) {
1471 pc
->tt
= JIM_TT_ESC
;
1473 pc
->state
= JIM_PS_DEF
;
1480 return JIM_OK
; /* unreached */
1483 int JimParseComment(struct JimParserCtx
*pc
)
1486 if (*pc
->p
== '\n') {
1488 if (*(pc
->p
-1) != '\\') {
1498 /* xdigitval and odigitval are helper functions for JimParserGetToken() */
1499 static int xdigitval(int c
)
1501 if (c
>= '0' && c
<= '9') return c
-'0';
1502 if (c
>= 'a' && c
<= 'f') return c
-'a'+10;
1503 if (c
>= 'A' && c
<= 'F') return c
-'A'+10;
1507 static int odigitval(int c
)
1509 if (c
>= '0' && c
<= '7') return c
-'0';
1513 /* Perform Tcl escape substitution of 's', storing the result
1514 * string into 'dest'. The escaped string is guaranteed to
1515 * be the same length or shorted than the source string.
1516 * Slen is the length of the string at 's', if it's -1 the string
1517 * length will be calculated by the function.
1519 * The function returns the length of the resulting string. */
1520 static int JimEscape(char *dest
, const char *s
, int slen
)
1528 for (i
= 0; i
< slen
; i
++) {
1532 case 'a': *p
++ = 0x7; i
++; break;
1533 case 'b': *p
++ = 0x8; i
++; break;
1534 case 'f': *p
++ = 0xc; i
++; break;
1535 case 'n': *p
++ = 0xa; i
++; break;
1536 case 'r': *p
++ = 0xd; i
++; break;
1537 case 't': *p
++ = 0x9; i
++; break;
1538 case 'v': *p
++ = 0xb; i
++; break;
1539 case '\0': *p
++ = '\\'; i
++; break;
1540 case '\n': *p
++ = ' '; i
++; break;
1542 if (s
[i
+1] == 'x') {
1544 int c
= xdigitval(s
[i
+2]);
1551 c
= xdigitval(s
[i
+3]);
1561 } else if (s
[i
+1] >= '0' && s
[i
+1] <= '7')
1564 int c
= odigitval(s
[i
+1]);
1566 c
= odigitval(s
[i
+2]);
1573 c
= odigitval(s
[i
+3]);
1599 /* Returns a dynamically allocated copy of the current token in the
1600 * parser context. The function perform conversion of escapes if
1601 * the token is of type JIM_TT_ESC.
1603 * Note that after the conversion, tokens that are grouped with
1604 * braces in the source code, are always recognizable from the
1605 * identical string obtained in a different way from the type.
1607 * For exmple the string:
1611 * will return as first token "expand", of type JIM_TT_STR
1617 * will return as first token "expand", of type JIM_TT_ESC
1619 char *JimParserGetToken(struct JimParserCtx
*pc
,
1620 int *lenPtr
, int *typePtr
, int *linePtr
)
1622 const char *start
, *end
;
1626 start
= JimParserTstart(pc
);
1627 end
= JimParserTend(pc
);
1629 if (lenPtr
) *lenPtr
= 0;
1630 if (typePtr
) *typePtr
= JimParserTtype(pc
);
1631 if (linePtr
) *linePtr
= JimParserTline(pc
);
1632 token
= Jim_Alloc(1);
1636 len
= (end
-start
)+1;
1637 token
= Jim_Alloc(len
+1);
1638 if (JimParserTtype(pc
) != JIM_TT_ESC
) {
1639 /* No escape conversion needed? Just copy it. */
1640 memcpy(token
, start
, len
);
1643 /* Else convert the escape chars. */
1644 len
= JimEscape(token
, start
, len
);
1646 if (lenPtr
) *lenPtr
= len
;
1647 if (typePtr
) *typePtr
= JimParserTtype(pc
);
1648 if (linePtr
) *linePtr
= JimParserTline(pc
);
1652 /* The following functin is not really part of the parsing engine of Jim,
1653 * but it somewhat related. Given an string and its length, it tries
1654 * to guess if the script is complete or there are instead " " or { }
1655 * open and not completed. This is useful for interactive shells
1656 * implementation and for [info complete].
1658 * If 'stateCharPtr' != NULL, the function stores ' ' on complete script,
1659 * '{' on scripts incomplete missing one or more '}' to be balanced.
1660 * '"' on scripts incomplete missing a '"' char.
1662 * If the script is complete, 1 is returned, otherwise 0. */
1663 int Jim_ScriptIsComplete(const char *s
, int len
, char *stateCharPtr
)
1677 } else if (state
== '"') {
1684 } else if (state
== ' ') {
1701 *stateCharPtr
= state
;
1702 return state
== ' ';
1705 /* -----------------------------------------------------------------------------
1707 * ---------------------------------------------------------------------------*/
1708 static int JimParseListSep(struct JimParserCtx
*pc
);
1709 static int JimParseListStr(struct JimParserCtx
*pc
);
1711 int JimParseList(struct JimParserCtx
*pc
)
1714 pc
->tstart
= pc
->tend
= pc
->p
;
1715 pc
->tline
= pc
->linenr
;
1716 pc
->tt
= JIM_TT_EOL
;
1725 if (pc
->state
== JIM_PS_DEF
)
1726 return JimParseListSep(pc
);
1728 return JimParseListStr(pc
);
1731 return JimParseListStr(pc
);
1737 int JimParseListSep(struct JimParserCtx
*pc
)
1740 pc
->tline
= pc
->linenr
;
1741 while (*pc
->p
== ' ' || *pc
->p
== '\t' || *pc
->p
== '\r' || *pc
->p
== '\n')
1746 pc
->tt
= JIM_TT_SEP
;
1750 int JimParseListStr(struct JimParserCtx
*pc
)
1752 int newword
= (pc
->tt
== JIM_TT_SEP
|| pc
->tt
== JIM_TT_EOL
||
1753 pc
->tt
== JIM_TT_NONE
);
1754 if (newword
&& *pc
->p
== '{') {
1755 return JimParseBrace(pc
);
1756 } else if (newword
&& *pc
->p
== '"') {
1757 pc
->state
= JIM_PS_QUOTE
;
1761 pc
->tline
= pc
->linenr
;
1765 pc
->tt
= JIM_TT_ESC
;
1776 if (pc
->state
== JIM_PS_DEF
) {
1778 pc
->tt
= JIM_TT_ESC
;
1780 } else if (*pc
->p
== '\n') {
1785 if (pc
->state
== JIM_PS_QUOTE
) {
1787 pc
->tt
= JIM_TT_ESC
;
1789 pc
->state
= JIM_PS_DEF
;
1796 return JIM_OK
; /* unreached */
1799 /* -----------------------------------------------------------------------------
1800 * Jim_Obj related functions
1801 * ---------------------------------------------------------------------------*/
1803 /* Return a new initialized object. */
1804 Jim_Obj
*Jim_NewObj(Jim_Interp
*interp
)
1808 /* -- Check if there are objects in the free list -- */
1809 if (interp
->freeList
!= NULL
) {
1810 /* -- Unlink the object from the free list -- */
1811 objPtr
= interp
->freeList
;
1812 interp
->freeList
= objPtr
->nextObjPtr
;
1814 /* -- No ready to use objects: allocate a new one -- */
1815 objPtr
= Jim_Alloc(sizeof(*objPtr
));
1818 /* Object is returned with refCount of 0. Every
1819 * kind of GC implemented should take care to don't try
1820 * to scan objects with refCount == 0. */
1821 objPtr
->refCount
= 0;
1822 /* All the other fields are left not initialized to save time.
1823 * The caller will probably want set they to the right
1826 /* -- Put the object into the live list -- */
1827 objPtr
->prevObjPtr
= NULL
;
1828 objPtr
->nextObjPtr
= interp
->liveList
;
1829 if (interp
->liveList
)
1830 interp
->liveList
->prevObjPtr
= objPtr
;
1831 interp
->liveList
= objPtr
;
1836 /* Free an object. Actually objects are never freed, but
1837 * just moved to the free objects list, where they will be
1838 * reused by Jim_NewObj(). */
1839 void Jim_FreeObj(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
1841 /* Check if the object was already freed, panic. */
1842 if (objPtr
->refCount
!= 0) {
1843 Jim_Panic(interp
,"!!!Object %p freed with bad refcount %d", objPtr
,
1846 /* Free the internal representation */
1847 Jim_FreeIntRep(interp
, objPtr
);
1848 /* Free the string representation */
1849 if (objPtr
->bytes
!= NULL
) {
1850 if (objPtr
->bytes
!= JimEmptyStringRep
)
1851 Jim_Free(objPtr
->bytes
);
1853 /* Unlink the object from the live objects list */
1854 if (objPtr
->prevObjPtr
)
1855 objPtr
->prevObjPtr
->nextObjPtr
= objPtr
->nextObjPtr
;
1856 if (objPtr
->nextObjPtr
)
1857 objPtr
->nextObjPtr
->prevObjPtr
= objPtr
->prevObjPtr
;
1858 if (interp
->liveList
== objPtr
)
1859 interp
->liveList
= objPtr
->nextObjPtr
;
1860 /* Link the object into the free objects list */
1861 objPtr
->prevObjPtr
= NULL
;
1862 objPtr
->nextObjPtr
= interp
->freeList
;
1863 if (interp
->freeList
)
1864 interp
->freeList
->prevObjPtr
= objPtr
;
1865 interp
->freeList
= objPtr
;
1866 objPtr
->refCount
= -1;
1869 /* Invalidate the string representation of an object. */
1870 void Jim_InvalidateStringRep(Jim_Obj
*objPtr
)
1872 if (objPtr
->bytes
!= NULL
) {
1873 if (objPtr
->bytes
!= JimEmptyStringRep
)
1874 Jim_Free(objPtr
->bytes
);
1876 objPtr
->bytes
= NULL
;
1879 #define Jim_SetStringRep(o, b, l) \
1880 do { (o)->bytes = b; (o)->length = l; } while (0)
1882 /* Set the initial string representation for an object.
1883 * Does not try to free an old one. */
1884 void Jim_InitStringRep(Jim_Obj
*objPtr
, const char *bytes
, int length
)
1887 objPtr
->bytes
= JimEmptyStringRep
;
1890 objPtr
->bytes
= Jim_Alloc(length
+1);
1891 objPtr
->length
= length
;
1892 memcpy(objPtr
->bytes
, bytes
, length
);
1893 objPtr
->bytes
[length
] = '\0';
1897 /* Duplicate an object. The returned object has refcount = 0. */
1898 Jim_Obj
*Jim_DuplicateObj(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
1902 dupPtr
= Jim_NewObj(interp
);
1903 if (objPtr
->bytes
== NULL
) {
1904 /* Object does not have a valid string representation. */
1905 dupPtr
->bytes
= NULL
;
1907 Jim_InitStringRep(dupPtr
, objPtr
->bytes
, objPtr
->length
);
1909 if (objPtr
->typePtr
!= NULL
) {
1910 if (objPtr
->typePtr
->dupIntRepProc
== NULL
) {
1911 dupPtr
->internalRep
= objPtr
->internalRep
;
1913 objPtr
->typePtr
->dupIntRepProc(interp
, objPtr
, dupPtr
);
1915 dupPtr
->typePtr
= objPtr
->typePtr
;
1917 dupPtr
->typePtr
= NULL
;
1922 /* Return the string representation for objPtr. If the object
1923 * string representation is invalid, calls the method to create
1924 * a new one starting from the internal representation of the object. */
1925 const char *Jim_GetString(Jim_Obj
*objPtr
, int *lenPtr
)
1927 if (objPtr
->bytes
== NULL
) {
1928 /* Invalid string repr. Generate it. */
1929 if (objPtr
->typePtr
->updateStringProc
== NULL
) {
1930 Jim_Panic(NULL
,"UpdataStringProc called against '%s' type.",
1931 objPtr
->typePtr
->name
);
1933 objPtr
->typePtr
->updateStringProc(objPtr
);
1936 *lenPtr
= objPtr
->length
;
1937 return objPtr
->bytes
;
1940 /* Just returns the length of the object's string rep */
1941 int Jim_Length(Jim_Obj
*objPtr
)
1945 Jim_GetString(objPtr
, &len
);
1949 /* -----------------------------------------------------------------------------
1951 * ---------------------------------------------------------------------------*/
1952 static void DupStringInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
);
1953 static int SetStringFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
);
1955 static Jim_ObjType stringObjType
= {
1958 DupStringInternalRep
,
1960 JIM_TYPE_REFERENCES
,
1963 void DupStringInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
)
1965 JIM_NOTUSED(interp
);
1967 /* This is a bit subtle: the only caller of this function
1968 * should be Jim_DuplicateObj(), that will copy the
1969 * string representaion. After the copy, the duplicated
1970 * object will not have more room in teh buffer than
1971 * srcPtr->length bytes. So we just set it to length. */
1972 dupPtr
->internalRep
.strValue
.maxLength
= srcPtr
->length
;
1975 int SetStringFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
1977 /* Get a fresh string representation. */
1978 (void) Jim_GetString(objPtr
, NULL
);
1979 /* Free any other internal representation. */
1980 Jim_FreeIntRep(interp
, objPtr
);
1981 /* Set it as string, i.e. just set the maxLength field. */
1982 objPtr
->typePtr
= &stringObjType
;
1983 objPtr
->internalRep
.strValue
.maxLength
= objPtr
->length
;
1987 Jim_Obj
*Jim_NewStringObj(Jim_Interp
*interp
, const char *s
, int len
)
1989 Jim_Obj
*objPtr
= Jim_NewObj(interp
);
1993 /* Alloc/Set the string rep. */
1995 objPtr
->bytes
= JimEmptyStringRep
;
1998 objPtr
->bytes
= Jim_Alloc(len
+1);
1999 objPtr
->length
= len
;
2000 memcpy(objPtr
->bytes
, s
, len
);
2001 objPtr
->bytes
[len
] = '\0';
2004 /* No typePtr field for the vanilla string object. */
2005 objPtr
->typePtr
= NULL
;
2009 /* This version does not try to duplicate the 's' pointer, but
2010 * use it directly. */
2011 Jim_Obj
*Jim_NewStringObjNoAlloc(Jim_Interp
*interp
, char *s
, int len
)
2013 Jim_Obj
*objPtr
= Jim_NewObj(interp
);
2017 Jim_SetStringRep(objPtr
, s
, len
);
2018 objPtr
->typePtr
= NULL
;
2022 /* Low-level string append. Use it only against objects
2023 * of type "string". */
2024 void StringAppendString(Jim_Obj
*objPtr
, const char *str
, int len
)
2030 needlen
= objPtr
->length
+ len
;
2031 if (objPtr
->internalRep
.strValue
.maxLength
< needlen
||
2032 objPtr
->internalRep
.strValue
.maxLength
== 0) {
2033 if (objPtr
->bytes
== JimEmptyStringRep
) {
2034 objPtr
->bytes
= Jim_Alloc((needlen
*2)+1);
2036 objPtr
->bytes
= Jim_Realloc(objPtr
->bytes
, (needlen
*2)+1);
2038 objPtr
->internalRep
.strValue
.maxLength
= needlen
*2;
2040 memcpy(objPtr
->bytes
+ objPtr
->length
, str
, len
);
2041 objPtr
->bytes
[objPtr
->length
+len
] = '\0';
2042 objPtr
->length
+= len
;
2045 /* Low-level wrapper to append an object. */
2046 void StringAppendObj(Jim_Obj
*objPtr
, Jim_Obj
*appendObjPtr
)
2051 str
= Jim_GetString(appendObjPtr
, &len
);
2052 StringAppendString(objPtr
, str
, len
);
2055 /* Higher level API to append strings to objects. */
2056 void Jim_AppendString(Jim_Interp
*interp
, Jim_Obj
*objPtr
, const char *str
,
2059 if (Jim_IsShared(objPtr
))
2060 Jim_Panic(interp
,"Jim_AppendString called with shared object");
2061 if (objPtr
->typePtr
!= &stringObjType
)
2062 SetStringFromAny(interp
, objPtr
);
2063 StringAppendString(objPtr
, str
, len
);
2066 void Jim_AppendString_sprintf( Jim_Interp
*interp
, Jim_Obj
*objPtr
, const char *fmt
, ... )
2071 va_start( ap
, fmt
);
2072 buf
= jim_vasprintf( fmt
, ap
);
2076 Jim_AppendString( interp
, objPtr
, buf
, -1 );
2077 jim_vasprintf_done(buf
);
2082 void Jim_AppendObj(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
2083 Jim_Obj
*appendObjPtr
)
2088 str
= Jim_GetString(appendObjPtr
, &len
);
2089 Jim_AppendString(interp
, objPtr
, str
, len
);
2092 void Jim_AppendStrings(Jim_Interp
*interp
, Jim_Obj
*objPtr
, ...)
2096 if (objPtr
->typePtr
!= &stringObjType
)
2097 SetStringFromAny(interp
, objPtr
);
2098 va_start(ap
, objPtr
);
2100 char *s
= va_arg(ap
, char*);
2102 if (s
== NULL
) break;
2103 Jim_AppendString(interp
, objPtr
, s
, -1);
2108 int Jim_StringEqObj(Jim_Obj
*aObjPtr
, Jim_Obj
*bObjPtr
, int nocase
)
2110 const char *aStr
, *bStr
;
2113 if (aObjPtr
== bObjPtr
) return 1;
2114 aStr
= Jim_GetString(aObjPtr
, &aLen
);
2115 bStr
= Jim_GetString(bObjPtr
, &bLen
);
2116 if (aLen
!= bLen
) return 0;
2118 return memcmp(aStr
, bStr
, aLen
) == 0;
2119 for (i
= 0; i
< aLen
; i
++) {
2120 if (tolower((int)aStr
[i
]) != tolower((int)bStr
[i
]))
2126 int Jim_StringMatchObj(Jim_Obj
*patternObjPtr
, Jim_Obj
*objPtr
,
2129 const char *pattern
, *string
;
2130 int patternLen
, stringLen
;
2132 pattern
= Jim_GetString(patternObjPtr
, &patternLen
);
2133 string
= Jim_GetString(objPtr
, &stringLen
);
2134 return JimStringMatch(pattern
, patternLen
, string
, stringLen
, nocase
);
2137 int Jim_StringCompareObj(Jim_Obj
*firstObjPtr
,
2138 Jim_Obj
*secondObjPtr
, int nocase
)
2140 const char *s1
, *s2
;
2143 s1
= Jim_GetString(firstObjPtr
, &l1
);
2144 s2
= Jim_GetString(secondObjPtr
, &l2
);
2145 return JimStringCompare(s1
, l1
, s2
, l2
, nocase
);
2148 /* Convert a range, as returned by Jim_GetRange(), into
2149 * an absolute index into an object of the specified length.
2150 * This function may return negative values, or values
2151 * bigger or equal to the length of the list if the index
2152 * is out of range. */
2153 static int JimRelToAbsIndex(int len
, int index
)
2160 /* Convert a pair of index as normalize by JimRelToAbsIndex(),
2161 * into a range stored in *firstPtr, *lastPtr, *rangeLenPtr, suitable
2162 * for implementation of commands like [string range] and [lrange].
2164 * The resulting range is guaranteed to address valid elements of
2166 static void JimRelToAbsRange(int len
, int first
, int last
,
2167 int *firstPtr
, int *lastPtr
, int *rangeLenPtr
)
2174 rangeLen
= last
-first
+1;
2181 rangeLen
-= (last
-(len
-1));
2186 if (rangeLen
< 0) rangeLen
= 0;
2190 *rangeLenPtr
= rangeLen
;
2193 Jim_Obj
*Jim_StringRangeObj(Jim_Interp
*interp
,
2194 Jim_Obj
*strObjPtr
, Jim_Obj
*firstObjPtr
, Jim_Obj
*lastObjPtr
)
2200 if (Jim_GetIndex(interp
, firstObjPtr
, &first
) != JIM_OK
||
2201 Jim_GetIndex(interp
, lastObjPtr
, &last
) != JIM_OK
)
2203 str
= Jim_GetString(strObjPtr
, &len
);
2204 first
= JimRelToAbsIndex(len
, first
);
2205 last
= JimRelToAbsIndex(len
, last
);
2206 JimRelToAbsRange(len
, first
, last
, &first
, &last
, &rangeLen
);
2207 return Jim_NewStringObj(interp
, str
+first
, rangeLen
);
2210 static Jim_Obj
*JimStringToLower(Jim_Interp
*interp
, Jim_Obj
*strObjPtr
)
2214 if (strObjPtr
->typePtr
!= &stringObjType
) {
2215 SetStringFromAny(interp
, strObjPtr
);
2218 buf
= Jim_Alloc(strObjPtr
->length
+1);
2220 memcpy(buf
, strObjPtr
->bytes
, strObjPtr
->length
+1);
2221 for (i
= 0; i
< strObjPtr
->length
; i
++)
2222 buf
[i
] = tolower(buf
[i
]);
2223 return Jim_NewStringObjNoAlloc(interp
, buf
, strObjPtr
->length
);
2226 static Jim_Obj
*JimStringToUpper(Jim_Interp
*interp
, Jim_Obj
*strObjPtr
)
2230 if (strObjPtr
->typePtr
!= &stringObjType
) {
2231 SetStringFromAny(interp
, strObjPtr
);
2234 buf
= Jim_Alloc(strObjPtr
->length
+1);
2236 memcpy(buf
, strObjPtr
->bytes
, strObjPtr
->length
+1);
2237 for (i
= 0; i
< strObjPtr
->length
; i
++)
2238 buf
[i
] = toupper(buf
[i
]);
2239 return Jim_NewStringObjNoAlloc(interp
, buf
, strObjPtr
->length
);
2242 /* This is the core of the [format] command.
2243 * TODO: Lots of things work - via a hack
2244 * However, no format item can be >= JIM_MAX_FMT
2246 #define JIM_MAX_FMT 2048
2247 static Jim_Obj
*Jim_FormatString_Inner(Jim_Interp
*interp
, Jim_Obj
*fmtObjPtr
,
2248 int objc
, Jim_Obj
*const *objv
, char *sprintf_buf
)
2250 const char *fmt
, *_fmt
;
2255 fmt
= Jim_GetString(fmtObjPtr
, &fmtLen
);
2257 resObjPtr
= Jim_NewStringObj(interp
, "", 0);
2259 const char *p
= fmt
;
2263 /* we cheat and use Sprintf()! */
2277 while (*fmt
!= '%' && fmtLen
) {
2280 Jim_AppendString(interp
, resObjPtr
, p
, fmt
-p
);
2283 fmt
++; fmtLen
--; /* skip '%' */
2292 prec
= -1; /* not found yet */
2299 case 'b': /* binary - not all printfs() do this */
2300 case 's': /* string */
2301 case 'i': /* integer */
2302 case 'd': /* decimal */
2304 case 'X': /* CAP hex */
2305 case 'c': /* char */
2306 case 'o': /* octal */
2307 case 'u': /* unsigned */
2308 case 'f': /* float */
2312 case '0': /* zero pad */
2322 case ' ': /* sign space */
2352 while( isdigit(*fmt
) && (fmtLen
> 0) ){
2353 accum
= (accum
* 10) + (*fmt
- '0');
2364 /* suck up the next item as an integer */
2368 goto not_enough_args
;
2370 if( Jim_GetWide(interp
,objv
[0],&wideValue
)== JIM_ERR
){
2371 Jim_FreeNewObj(interp
, resObjPtr
);
2378 /* man 3 printf says */
2379 /* if prec is negative, it is zero */
2398 Jim_FreeNewObj(interp
, resObjPtr
);
2399 Jim_SetResultString(interp
,
2400 "not enough arguments for all format specifiers", -1);
2408 * Create the formatter
2409 * cause we cheat and use sprintf()
2419 /* PLUS overrides */
2429 sprintf( cp
, "%d", width
);
2433 /* did we find a period? */
2437 /* did something occur after the period? */
2439 sprintf( cp
, "%d", prec
);
2445 /* here we do the work */
2446 /* actually - we make sprintf() do it for us */
2451 /* BUG: we do not handled embeded NULLs */
2452 snprintf( sprintf_buf
, JIM_MAX_FMT
, fmt_str
, Jim_GetString( objv
[0], NULL
));
2457 if (Jim_GetWide(interp
, objv
[0], &wideValue
) == JIM_ERR
) {
2458 Jim_FreeNewObj(interp
, resObjPtr
);
2461 c
= (char) wideValue
;
2462 snprintf( sprintf_buf
, JIM_MAX_FMT
, fmt_str
, c
);
2472 if( Jim_GetDouble( interp
, objv
[0], &doubleValue
) == JIM_ERR
){
2473 Jim_FreeNewObj( interp
, resObjPtr
);
2476 snprintf( sprintf_buf
, JIM_MAX_FMT
, fmt_str
, doubleValue
);
2485 /* jim widevaluse are 64bit */
2486 if( sizeof(jim_wide
) == sizeof(long long) ){
2494 if (Jim_GetWide(interp
, objv
[0], &wideValue
) == JIM_ERR
) {
2495 Jim_FreeNewObj(interp
, resObjPtr
);
2498 snprintf(sprintf_buf
, JIM_MAX_FMT
, fmt_str
, wideValue
);
2501 sprintf_buf
[0] = '%';
2503 objv
--; /* undo the objv++ below */
2506 spec
[0] = *fmt
; spec
[1] = '\0';
2507 Jim_FreeNewObj(interp
, resObjPtr
);
2508 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
2509 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
2510 "bad field specifier \"", spec
, "\"", NULL
);
2513 /* force terminate */
2515 printf("FMT was: %s\n", fmt_str
);
2516 printf("RES was: |%s|\n", sprintf_buf
);
2519 sprintf_buf
[ JIM_MAX_FMT
- 1] = 0;
2520 Jim_AppendString( interp
, resObjPtr
, sprintf_buf
, strlen(sprintf_buf
) );
2529 Jim_Obj
*Jim_FormatString(Jim_Interp
*interp
, Jim_Obj
*fmtObjPtr
,
2530 int objc
, Jim_Obj
*const *objv
)
2532 char *sprintf_buf
=malloc(JIM_MAX_FMT
);
2533 Jim_Obj
*t
=Jim_FormatString_Inner(interp
, fmtObjPtr
, objc
, objv
, sprintf_buf
);
2538 /* -----------------------------------------------------------------------------
2539 * Compared String Object
2540 * ---------------------------------------------------------------------------*/
2542 /* This is strange object that allows to compare a C literal string
2543 * with a Jim object in very short time if the same comparison is done
2544 * multiple times. For example every time the [if] command is executed,
2545 * Jim has to check if a given argument is "else". This comparions if
2546 * the code has no errors are true most of the times, so we can cache
2547 * inside the object the pointer of the string of the last matching
2548 * comparison. Because most C compilers perform literal sharing,
2549 * so that: char *x = "foo", char *y = "foo", will lead to x == y,
2550 * this works pretty well even if comparisons are at different places
2551 * inside the C code. */
2553 static Jim_ObjType comparedStringObjType
= {
2558 JIM_TYPE_REFERENCES
,
2561 /* The only way this object is exposed to the API is via the following
2562 * function. Returns true if the string and the object string repr.
2563 * are the same, otherwise zero is returned.
2565 * Note: this isn't binary safe, but it hardly needs to be.*/
2566 int Jim_CompareStringImmediate(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
2569 if (objPtr
->typePtr
== &comparedStringObjType
&&
2570 objPtr
->internalRep
.ptr
== str
)
2573 const char *objStr
= Jim_GetString(objPtr
, NULL
);
2574 if (strcmp(str
, objStr
) != 0) return 0;
2575 if (objPtr
->typePtr
!= &comparedStringObjType
) {
2576 Jim_FreeIntRep(interp
, objPtr
);
2577 objPtr
->typePtr
= &comparedStringObjType
;
2579 objPtr
->internalRep
.ptr
= (char*)str
; /*ATTENTION: const cast */
2584 int qsortCompareStringPointers(const void *a
, const void *b
)
2586 char * const *sa
= (char * const *)a
;
2587 char * const *sb
= (char * const *)b
;
2588 return strcmp(*sa
, *sb
);
2591 int Jim_GetEnum(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
2592 const char * const *tablePtr
, int *indexPtr
, const char *name
, int flags
)
2594 const char * const *entryPtr
= NULL
;
2595 char **tablePtrSorted
;
2599 for (entryPtr
= tablePtr
, i
= 0; *entryPtr
!= NULL
; entryPtr
++, i
++) {
2600 if (Jim_CompareStringImmediate(interp
, objPtr
, *entryPtr
)) {
2604 count
++; /* If nothing matches, this will reach the len of tablePtr */
2606 if (flags
& JIM_ERRMSG
) {
2609 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
2610 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
2611 "bad ", name
, " \"", Jim_GetString(objPtr
, NULL
), "\": must be one of ",
2613 tablePtrSorted
= Jim_Alloc(sizeof(char*)*count
);
2614 memcpy(tablePtrSorted
, tablePtr
, sizeof(char*)*count
);
2615 qsort(tablePtrSorted
, count
, sizeof(char*), qsortCompareStringPointers
);
2616 for (i
= 0; i
< count
; i
++) {
2617 if (i
+1 == count
&& count
> 1)
2618 Jim_AppendString(interp
, Jim_GetResult(interp
), "or ", -1);
2619 Jim_AppendString(interp
, Jim_GetResult(interp
),
2620 tablePtrSorted
[i
], -1);
2622 Jim_AppendString(interp
, Jim_GetResult(interp
), ", ", -1);
2624 Jim_Free(tablePtrSorted
);
2629 int Jim_GetNvp(Jim_Interp
*interp
,
2631 const Jim_Nvp
*nvp_table
,
2632 const Jim_Nvp
** result
)
2637 e
= Jim_Nvp_name2value_obj( interp
, nvp_table
, objPtr
, &n
);
2642 /* Success? found? */
2645 *result
= (Jim_Nvp
*)n
;
2652 /* -----------------------------------------------------------------------------
2655 * This object is just a string from the language point of view, but
2656 * in the internal representation it contains the filename and line number
2657 * where this given token was read. This information is used by
2658 * Jim_EvalObj() if the object passed happens to be of type "source".
2660 * This allows to propagate the information about line numbers and file
2661 * names and give error messages with absolute line numbers.
2663 * Note that this object uses shared strings for filenames, and the
2664 * pointer to the filename together with the line number is taken into
2665 * the space for the "inline" internal represenation of the Jim_Object,
2666 * so there is almost memory zero-overhead.
2668 * Also the object will be converted to something else if the given
2669 * token it represents in the source file is not something to be
2670 * evaluated (not a script), and will be specialized in some other way,
2671 * so the time overhead is alzo null.
2672 * ---------------------------------------------------------------------------*/
2674 static void FreeSourceInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
2675 static void DupSourceInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
);
2677 static Jim_ObjType sourceObjType
= {
2679 FreeSourceInternalRep
,
2680 DupSourceInternalRep
,
2682 JIM_TYPE_REFERENCES
,
2685 void FreeSourceInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
2687 Jim_ReleaseSharedString(interp
,
2688 objPtr
->internalRep
.sourceValue
.fileName
);
2691 void DupSourceInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
)
2693 dupPtr
->internalRep
.sourceValue
.fileName
=
2694 Jim_GetSharedString(interp
,
2695 srcPtr
->internalRep
.sourceValue
.fileName
);
2696 dupPtr
->internalRep
.sourceValue
.lineNumber
=
2697 dupPtr
->internalRep
.sourceValue
.lineNumber
;
2698 dupPtr
->typePtr
= &sourceObjType
;
2701 static void JimSetSourceInfo(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
2702 const char *fileName
, int lineNumber
)
2704 if (Jim_IsShared(objPtr
))
2705 Jim_Panic(interp
,"JimSetSourceInfo called with shared object");
2706 if (objPtr
->typePtr
!= NULL
)
2707 Jim_Panic(interp
,"JimSetSourceInfo called with typePtr != NULL");
2708 objPtr
->internalRep
.sourceValue
.fileName
=
2709 Jim_GetSharedString(interp
, fileName
);
2710 objPtr
->internalRep
.sourceValue
.lineNumber
= lineNumber
;
2711 objPtr
->typePtr
= &sourceObjType
;
2714 /* -----------------------------------------------------------------------------
2716 * ---------------------------------------------------------------------------*/
2718 #define JIM_CMDSTRUCT_EXPAND -1
2720 static void FreeScriptInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
2721 static void DupScriptInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
);
2722 static int SetScriptFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
);
2724 static Jim_ObjType scriptObjType
= {
2726 FreeScriptInternalRep
,
2727 DupScriptInternalRep
,
2729 JIM_TYPE_REFERENCES
,
2732 /* The ScriptToken structure represents every token into a scriptObj.
2733 * Every token contains an associated Jim_Obj that can be specialized
2734 * by commands operating on it. */
2735 typedef struct ScriptToken
{
2741 /* This is the script object internal representation. An array of
2742 * ScriptToken structures, with an associated command structure array.
2743 * The command structure is a pre-computed representation of the
2744 * command length and arguments structure as a simple liner array
2747 * For example the script:
2750 * set $i $x$y [foo]BAR
2752 * will produce a ScriptObj with the following Tokens:
2769 * This is a description of the tokens, separators, and of lines.
2770 * The command structure instead represents the number of arguments
2771 * of every command, followed by the tokens of which every argument
2772 * is composed. So for the example script, the cmdstruct array will
2777 * Because "puts hello" has two args (2), composed of single tokens (1 1)
2778 * While "set $i $x$y [foo]BAR" has four (4) args, the first two
2779 * composed of single tokens (1 1) and the last two of double tokens
2782 * The precomputation of the command structure makes Jim_Eval() faster,
2783 * and simpler because there aren't dynamic lengths / allocations.
2785 * -- {expand} handling --
2787 * Expand is handled in a special way. When a command
2788 * contains at least an argument with the {expand} prefix,
2789 * the command structure presents a -1 before the integer
2790 * describing the number of arguments. This is used in order
2791 * to send the command exection to a different path in case
2792 * of {expand} and guarantee a fast path for the more common
2793 * case. Also, the integers describing the number of tokens
2794 * are expressed with negative sign, to allow for fast check
2795 * of what's an {expand}-prefixed argument and what not.
2797 * For example the command:
2799 * list {expand}{1 2}
2801 * Will produce the following cmdstruct array:
2805 * -- the substFlags field of the structure --
2807 * The scriptObj structure is used to represent both "script" objects
2808 * and "subst" objects. In the second case, the cmdStruct related
2809 * fields are not used at all, but there is an additional field used
2810 * that is 'substFlags': this represents the flags used to turn
2811 * the string into the intenral representation used to perform the
2812 * substitution. If this flags are not what the application requires
2813 * the scriptObj is created again. For example the script:
2815 * subst -nocommands $string
2816 * subst -novariables $string
2818 * Will recreate the internal representation of the $string object
2821 typedef struct ScriptObj
{
2822 int len
; /* Length as number of tokens. */
2823 int commands
; /* number of top-level commands in script. */
2824 ScriptToken
*token
; /* Tokens array. */
2825 int *cmdStruct
; /* commands structure */
2826 int csLen
; /* length of the cmdStruct array. */
2827 int substFlags
; /* flags used for the compilation of "subst" objects */
2828 int inUse
; /* Used to share a ScriptObj. Currently
2829 only used by Jim_EvalObj() as protection against
2830 shimmering of the currently evaluated object. */
2834 void FreeScriptInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
2837 struct ScriptObj
*script
= (void*) objPtr
->internalRep
.ptr
;
2840 if (script
->inUse
!= 0) return;
2841 for (i
= 0; i
< script
->len
; i
++) {
2842 if (script
->token
[i
].objPtr
!= NULL
)
2843 Jim_DecrRefCount(interp
, script
->token
[i
].objPtr
);
2845 Jim_Free(script
->token
);
2846 Jim_Free(script
->cmdStruct
);
2847 Jim_Free(script
->fileName
);
2851 void DupScriptInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
)
2853 JIM_NOTUSED(interp
);
2854 JIM_NOTUSED(srcPtr
);
2856 /* Just returns an simple string. */
2857 dupPtr
->typePtr
= NULL
;
2860 /* Add a new token to the internal repr of a script object */
2861 static void ScriptObjAddToken(Jim_Interp
*interp
, struct ScriptObj
*script
,
2862 char *strtoken
, int len
, int type
, char *filename
, int linenr
)
2865 struct ScriptToken
*token
;
2867 prevtype
= (script
->len
== 0) ? JIM_TT_EOL
: \
2868 script
->token
[script
->len
-1].type
;
2869 /* Skip tokens without meaning, like words separators
2870 * following a word separator or an end of command and
2872 if (prevtype
== JIM_TT_EOL
) {
2873 if (type
== JIM_TT_EOL
|| type
== JIM_TT_SEP
) {
2877 } else if (prevtype
== JIM_TT_SEP
) {
2878 if (type
== JIM_TT_SEP
) {
2881 } else if (type
== JIM_TT_EOL
) {
2882 /* If an EOL is following by a SEP, drop the previous
2885 Jim_DecrRefCount(interp
, script
->token
[script
->len
].objPtr
);
2887 } else if (prevtype
!= JIM_TT_EOL
&& prevtype
!= JIM_TT_SEP
&&
2888 type
== JIM_TT_ESC
&& len
== 0)
2890 /* Don't add empty tokens used in interpolation */
2894 /* Make space for a new istruction */
2896 script
->token
= Jim_Realloc(script
->token
,
2897 sizeof(ScriptToken
)*script
->len
);
2898 /* Initialize the new token */
2899 token
= script
->token
+(script
->len
-1);
2901 /* Every object is intially as a string, but the
2902 * internal type may be specialized during execution of the
2904 token
->objPtr
= Jim_NewStringObjNoAlloc(interp
, strtoken
, len
);
2905 /* To add source info to SEP and EOL tokens is useless because
2906 * they will never by called as arguments of Jim_EvalObj(). */
2907 if (filename
&& type
!= JIM_TT_SEP
&& type
!= JIM_TT_EOL
)
2908 JimSetSourceInfo(interp
, token
->objPtr
, filename
, linenr
);
2909 Jim_IncrRefCount(token
->objPtr
);
2910 token
->linenr
= linenr
;
2913 /* Add an integer into the command structure field of the script object. */
2914 static void ScriptObjAddInt(struct ScriptObj
*script
, int val
)
2917 script
->cmdStruct
= Jim_Realloc(script
->cmdStruct
,
2918 sizeof(int)*script
->csLen
);
2919 script
->cmdStruct
[script
->csLen
-1] = val
;
2922 /* Search a Jim_Obj contained in 'script' with the same stinrg repr.
2923 * of objPtr. Search nested script objects recursively. */
2924 static Jim_Obj
*ScriptSearchLiteral(Jim_Interp
*interp
, ScriptObj
*script
,
2925 ScriptObj
*scriptBarrier
, Jim_Obj
*objPtr
)
2929 for (i
= 0; i
< script
->len
; i
++) {
2930 if (script
->token
[i
].objPtr
!= objPtr
&&
2931 Jim_StringEqObj(script
->token
[i
].objPtr
, objPtr
, 0)) {
2932 return script
->token
[i
].objPtr
;
2934 /* Enter recursively on scripts only if the object
2935 * is not the same as the one we are searching for
2936 * shared occurrences. */
2937 if (script
->token
[i
].objPtr
->typePtr
== &scriptObjType
&&
2938 script
->token
[i
].objPtr
!= objPtr
) {
2939 Jim_Obj
*foundObjPtr
;
2941 ScriptObj
*subScript
=
2942 script
->token
[i
].objPtr
->internalRep
.ptr
;
2943 /* Don't recursively enter the script we are trying
2944 * to make shared to avoid circular references. */
2945 if (subScript
== scriptBarrier
) continue;
2946 if (subScript
!= script
) {
2948 ScriptSearchLiteral(interp
, subScript
,
2949 scriptBarrier
, objPtr
);
2950 if (foundObjPtr
!= NULL
)
2958 /* Share literals of a script recursively sharing sub-scripts literals. */
2959 static void ScriptShareLiterals(Jim_Interp
*interp
, ScriptObj
*script
,
2960 ScriptObj
*topLevelScript
)
2965 /* Try to share with toplevel object. */
2966 if (topLevelScript
!= NULL
) {
2967 for (i
= 0; i
< script
->len
; i
++) {
2968 Jim_Obj
*foundObjPtr
;
2969 char *str
= script
->token
[i
].objPtr
->bytes
;
2971 if (script
->token
[i
].objPtr
->refCount
!= 1) continue;
2972 if (script
->token
[i
].objPtr
->typePtr
== &scriptObjType
) continue;
2973 if (strchr(str
, ' ') || strchr(str
, '\n')) continue;
2974 foundObjPtr
= ScriptSearchLiteral(interp
,
2976 script
, /* barrier */
2977 script
->token
[i
].objPtr
);
2978 if (foundObjPtr
!= NULL
) {
2979 Jim_IncrRefCount(foundObjPtr
);
2980 Jim_DecrRefCount(interp
,
2981 script
->token
[i
].objPtr
);
2982 script
->token
[i
].objPtr
= foundObjPtr
;
2986 /* Try to share locally */
2987 for (i
= 0; i
< script
->len
; i
++) {
2988 char *str
= script
->token
[i
].objPtr
->bytes
;
2990 if (script
->token
[i
].objPtr
->refCount
!= 1) continue;
2991 if (strchr(str
, ' ') || strchr(str
, '\n')) continue;
2992 for (j
= 0; j
< script
->len
; j
++) {
2993 if (script
->token
[i
].objPtr
!=
2994 script
->token
[j
].objPtr
&&
2995 Jim_StringEqObj(script
->token
[i
].objPtr
,
2996 script
->token
[j
].objPtr
, 0))
2998 Jim_IncrRefCount(script
->token
[j
].objPtr
);
2999 Jim_DecrRefCount(interp
,
3000 script
->token
[i
].objPtr
);
3001 script
->token
[i
].objPtr
=
3002 script
->token
[j
].objPtr
;
3008 /* This method takes the string representation of an object
3009 * as a Tcl script, and generates the pre-parsed internal representation
3011 int SetScriptFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
)
3014 const char *scriptText
= Jim_GetString(objPtr
, &scriptTextLen
);
3015 struct JimParserCtx parser
;
3016 struct ScriptObj
*script
= Jim_Alloc(sizeof(*script
));
3018 int args
, tokens
, start
, end
, i
;
3019 int initialLineNumber
;
3020 int propagateSourceInfo
= 0;
3024 script
->commands
= 0;
3025 script
->token
= NULL
;
3026 script
->cmdStruct
= NULL
;
3028 /* Try to get information about filename / line number */
3029 if (objPtr
->typePtr
== &sourceObjType
) {
3031 Jim_StrDup(objPtr
->internalRep
.sourceValue
.fileName
);
3032 initialLineNumber
= objPtr
->internalRep
.sourceValue
.lineNumber
;
3033 propagateSourceInfo
= 1;
3035 script
->fileName
= Jim_StrDup("");
3036 initialLineNumber
= 1;
3039 JimParserInit(&parser
, scriptText
, scriptTextLen
, initialLineNumber
);
3040 while(!JimParserEof(&parser
)) {
3042 int len
, type
, linenr
;
3044 JimParseScript(&parser
);
3045 token
= JimParserGetToken(&parser
, &len
, &type
, &linenr
);
3046 ScriptObjAddToken(interp
, script
, token
, len
, type
,
3047 propagateSourceInfo
? script
->fileName
: NULL
,
3050 token
= script
->token
;
3052 /* Compute the command structure array
3053 * (see the ScriptObj struct definition for more info) */
3054 start
= 0; /* Current command start token index */
3055 end
= -1; /* Current command end token index */
3057 int expand
= 0; /* expand flag. set to 1 on {expand} form. */
3058 int interpolation
= 0; /* set to 1 if there is at least one
3059 argument of the command obtained via
3060 interpolation of more tokens. */
3061 /* Search for the end of command, while
3062 * count the number of args. */
3064 if (start
>= script
->len
) break;
3065 args
= 1; /* Number of args in current command */
3066 while (token
[end
].type
!= JIM_TT_EOL
) {
3067 if (end
== 0 || token
[end
-1].type
== JIM_TT_SEP
||
3068 token
[end
-1].type
== JIM_TT_EOL
)
3070 if (token
[end
].type
== JIM_TT_STR
&&
3071 token
[end
+1].type
!= JIM_TT_SEP
&&
3072 token
[end
+1].type
!= JIM_TT_EOL
&&
3073 (!strcmp(token
[end
].objPtr
->bytes
, "expand") ||
3074 !strcmp(token
[end
].objPtr
->bytes
, "*")))
3077 if (token
[end
].type
== JIM_TT_SEP
)
3081 interpolation
= !((end
-start
+1) == args
*2);
3082 /* Add the 'number of arguments' info into cmdstruct.
3083 * Negative value if there is list expansion involved. */
3085 ScriptObjAddInt(script
, -1);
3086 ScriptObjAddInt(script
, args
);
3087 /* Now add info about the number of tokens. */
3088 tokens
= 0; /* Number of tokens in current argument. */
3090 for (i
= start
; i
<= end
; i
++) {
3091 if (token
[i
].type
== JIM_TT_SEP
||
3092 token
[i
].type
== JIM_TT_EOL
)
3094 if (tokens
== 1 && expand
)
3096 ScriptObjAddInt(script
,
3097 expand
? -tokens
: tokens
);
3102 } else if (tokens
== 0 && token
[i
].type
== JIM_TT_STR
&&
3103 (!strcmp(token
[i
].objPtr
->bytes
, "expand") ||
3104 !strcmp(token
[i
].objPtr
->bytes
, "*")))
3111 /* Perform literal sharing, but only for objects that appear
3112 * to be scripts written as literals inside the source code,
3113 * and not computed at runtime. Literal sharing is a costly
3114 * operation that should be done only against objects that
3115 * are likely to require compilation only the first time, and
3116 * then are executed multiple times. */
3117 if (propagateSourceInfo
&& interp
->framePtr
->procBodyObjPtr
) {
3118 Jim_Obj
*bodyObjPtr
= interp
->framePtr
->procBodyObjPtr
;
3119 if (bodyObjPtr
->typePtr
== &scriptObjType
) {
3120 ScriptObj
*bodyScript
=
3121 bodyObjPtr
->internalRep
.ptr
;
3122 ScriptShareLiterals(interp
, script
, bodyScript
);
3124 } else if (propagateSourceInfo
) {
3125 ScriptShareLiterals(interp
, script
, NULL
);
3127 /* Free the old internal rep and set the new one. */
3128 Jim_FreeIntRep(interp
, objPtr
);
3129 Jim_SetIntRepPtr(objPtr
, script
);
3130 objPtr
->typePtr
= &scriptObjType
;
3134 ScriptObj
*Jim_GetScript(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
3136 if (objPtr
->typePtr
!= &scriptObjType
) {
3137 SetScriptFromAny(interp
, objPtr
);
3139 return (ScriptObj
*) Jim_GetIntRepPtr(objPtr
);
3142 /* -----------------------------------------------------------------------------
3144 * ---------------------------------------------------------------------------*/
3146 /* Commands HashTable Type.
3148 * Keys are dynamic allocated strings, Values are Jim_Cmd structures. */
3149 static void Jim_CommandsHT_ValDestructor(void *interp
, void *val
)
3151 Jim_Cmd
*cmdPtr
= (void*) val
;
3153 if (cmdPtr
->cmdProc
== NULL
) {
3154 Jim_DecrRefCount(interp
, cmdPtr
->argListObjPtr
);
3155 Jim_DecrRefCount(interp
, cmdPtr
->bodyObjPtr
);
3156 if (cmdPtr
->staticVars
) {
3157 Jim_FreeHashTable(cmdPtr
->staticVars
);
3158 Jim_Free(cmdPtr
->staticVars
);
3160 } else if (cmdPtr
->delProc
!= NULL
) {
3161 /* If it was a C coded command, call the delProc if any */
3162 cmdPtr
->delProc(interp
, cmdPtr
->privData
);
3167 static Jim_HashTableType JimCommandsHashTableType
= {
3168 JimStringCopyHTHashFunction
, /* hash function */
3169 JimStringCopyHTKeyDup
, /* key dup */
3171 JimStringCopyHTKeyCompare
, /* key compare */
3172 JimStringCopyHTKeyDestructor
, /* key destructor */
3173 Jim_CommandsHT_ValDestructor
/* val destructor */
3176 /* ------------------------- Commands related functions --------------------- */
3178 int Jim_CreateCommand(Jim_Interp
*interp
, const char *cmdName
,
3179 Jim_CmdProc cmdProc
, void *privData
, Jim_DelCmdProc delProc
)
3184 he
= Jim_FindHashEntry(&interp
->commands
, cmdName
);
3185 if (he
== NULL
) { /* New command to create */
3186 cmdPtr
= Jim_Alloc(sizeof(*cmdPtr
));
3187 Jim_AddHashEntry(&interp
->commands
, cmdName
, cmdPtr
);
3189 Jim_InterpIncrProcEpoch(interp
);
3190 /* Free the arglist/body objects if it was a Tcl procedure */
3192 if (cmdPtr
->cmdProc
== NULL
) {
3193 Jim_DecrRefCount(interp
, cmdPtr
->argListObjPtr
);
3194 Jim_DecrRefCount(interp
, cmdPtr
->bodyObjPtr
);
3195 if (cmdPtr
->staticVars
) {
3196 Jim_FreeHashTable(cmdPtr
->staticVars
);
3197 Jim_Free(cmdPtr
->staticVars
);
3199 cmdPtr
->staticVars
= NULL
;
3200 } else if (cmdPtr
->delProc
!= NULL
) {
3201 /* If it was a C coded command, call the delProc if any */
3202 cmdPtr
->delProc(interp
, cmdPtr
->privData
);
3206 /* Store the new details for this proc */
3207 cmdPtr
->delProc
= delProc
;
3208 cmdPtr
->cmdProc
= cmdProc
;
3209 cmdPtr
->privData
= privData
;
3211 /* There is no need to increment the 'proc epoch' because
3212 * creation of a new procedure can never affect existing
3213 * cached commands. We don't do negative caching. */
3217 int Jim_CreateProcedure(Jim_Interp
*interp
, const char *cmdName
,
3218 Jim_Obj
*argListObjPtr
, Jim_Obj
*staticsListObjPtr
, Jim_Obj
*bodyObjPtr
,
3219 int arityMin
, int arityMax
)
3223 cmdPtr
= Jim_Alloc(sizeof(*cmdPtr
));
3224 cmdPtr
->cmdProc
= NULL
; /* Not a C coded command */
3225 cmdPtr
->argListObjPtr
= argListObjPtr
;
3226 cmdPtr
->bodyObjPtr
= bodyObjPtr
;
3227 Jim_IncrRefCount(argListObjPtr
);
3228 Jim_IncrRefCount(bodyObjPtr
);
3229 cmdPtr
->arityMin
= arityMin
;
3230 cmdPtr
->arityMax
= arityMax
;
3231 cmdPtr
->staticVars
= NULL
;
3233 /* Create the statics hash table. */
3234 if (staticsListObjPtr
) {
3237 Jim_ListLength(interp
, staticsListObjPtr
, &len
);
3239 cmdPtr
->staticVars
= Jim_Alloc(sizeof(Jim_HashTable
));
3240 Jim_InitHashTable(cmdPtr
->staticVars
, &JimVariablesHashTableType
,
3242 for (i
= 0; i
< len
; i
++) {
3243 Jim_Obj
*objPtr
, *initObjPtr
, *nameObjPtr
;
3247 Jim_ListIndex(interp
, staticsListObjPtr
, i
, &objPtr
, JIM_NONE
);
3248 /* Check if it's composed of two elements. */
3249 Jim_ListLength(interp
, objPtr
, &subLen
);
3250 if (subLen
== 1 || subLen
== 2) {
3251 /* Try to get the variable value from the current
3253 Jim_ListIndex(interp
, objPtr
, 0, &nameObjPtr
, JIM_NONE
);
3255 initObjPtr
= Jim_GetVariable(interp
, nameObjPtr
,
3257 if (initObjPtr
== NULL
) {
3258 Jim_SetResult(interp
,
3259 Jim_NewEmptyStringObj(interp
));
3260 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
3261 "variable for initialization of static \"",
3262 Jim_GetString(nameObjPtr
, NULL
),
3263 "\" not found in the local context",
3268 Jim_ListIndex(interp
, objPtr
, 1, &initObjPtr
, JIM_NONE
);
3270 varPtr
= Jim_Alloc(sizeof(*varPtr
));
3271 varPtr
->objPtr
= initObjPtr
;
3272 Jim_IncrRefCount(initObjPtr
);
3273 varPtr
->linkFramePtr
= NULL
;
3274 if (Jim_AddHashEntry(cmdPtr
->staticVars
,
3275 Jim_GetString(nameObjPtr
, NULL
),
3278 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
3279 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
3280 "static variable name \"",
3281 Jim_GetString(objPtr
, NULL
), "\"",
3282 " duplicated in statics list", NULL
);
3283 Jim_DecrRefCount(interp
, initObjPtr
);
3288 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
3289 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
3290 "too many fields in static specifier \"",
3291 objPtr
, "\"", NULL
);
3298 /* Add the new command */
3300 /* it may already exist, so we try to delete the old one */
3301 if (Jim_DeleteHashEntry(&interp
->commands
, cmdName
) != JIM_ERR
) {
3302 /* There was an old procedure with the same name, this requires
3303 * a 'proc epoch' update. */
3304 Jim_InterpIncrProcEpoch(interp
);
3306 /* If a procedure with the same name didn't existed there is no need
3307 * to increment the 'proc epoch' because creation of a new procedure
3308 * can never affect existing cached commands. We don't do
3309 * negative caching. */
3310 Jim_AddHashEntry(&interp
->commands
, cmdName
, cmdPtr
);
3314 Jim_FreeHashTable(cmdPtr
->staticVars
);
3315 Jim_Free(cmdPtr
->staticVars
);
3316 Jim_DecrRefCount(interp
, argListObjPtr
);
3317 Jim_DecrRefCount(interp
, bodyObjPtr
);
3322 int Jim_DeleteCommand(Jim_Interp
*interp
, const char *cmdName
)
3324 if (Jim_DeleteHashEntry(&interp
->commands
, cmdName
) == JIM_ERR
)
3326 Jim_InterpIncrProcEpoch(interp
);
3330 int Jim_RenameCommand(Jim_Interp
*interp
, const char *oldName
,
3331 const char *newName
)
3335 Jim_Cmd
*copyCmdPtr
;
3337 if (newName
[0] == '\0') /* Delete! */
3338 return Jim_DeleteCommand(interp
, oldName
);
3340 he
= Jim_FindHashEntry(&interp
->commands
, oldName
);
3342 return JIM_ERR
; /* Invalid command name */
3344 copyCmdPtr
= Jim_Alloc(sizeof(Jim_Cmd
));
3345 *copyCmdPtr
= *cmdPtr
;
3346 /* In order to avoid that a procedure will get arglist/body/statics
3347 * freed by the hash table methods, fake a C-coded command
3348 * setting cmdPtr->cmdProc as not NULL */
3349 cmdPtr
->cmdProc
= (void*)1;
3350 /* Also make sure delProc is NULL. */
3351 cmdPtr
->delProc
= NULL
;
3352 /* Destroy the old command, and make sure the new is freed
3354 Jim_DeleteHashEntry(&interp
->commands
, oldName
);
3355 Jim_DeleteHashEntry(&interp
->commands
, newName
);
3356 /* Now the new command. We are sure it can't fail because
3357 * the target name was already freed. */
3358 Jim_AddHashEntry(&interp
->commands
, newName
, copyCmdPtr
);
3359 /* Increment the epoch */
3360 Jim_InterpIncrProcEpoch(interp
);
3364 /* -----------------------------------------------------------------------------
3366 * ---------------------------------------------------------------------------*/
3368 static int SetCommandFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
);
3370 static Jim_ObjType commandObjType
= {
3375 JIM_TYPE_REFERENCES
,
3378 int SetCommandFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
3381 const char *cmdName
;
3383 /* Get the string representation */
3384 cmdName
= Jim_GetString(objPtr
, NULL
);
3385 /* Lookup this name into the commands hash table */
3386 he
= Jim_FindHashEntry(&interp
->commands
, cmdName
);
3390 /* Free the old internal repr and set the new one. */
3391 Jim_FreeIntRep(interp
, objPtr
);
3392 objPtr
->typePtr
= &commandObjType
;
3393 objPtr
->internalRep
.cmdValue
.procEpoch
= interp
->procEpoch
;
3394 objPtr
->internalRep
.cmdValue
.cmdPtr
= (void*)he
->val
;
3398 /* This function returns the command structure for the command name
3399 * stored in objPtr. It tries to specialize the objPtr to contain
3400 * a cached info instead to perform the lookup into the hash table
3401 * every time. The information cached may not be uptodate, in such
3402 * a case the lookup is performed and the cache updated. */
3403 Jim_Cmd
*Jim_GetCommand(Jim_Interp
*interp
, Jim_Obj
*objPtr
, int flags
)
3405 if ((objPtr
->typePtr
!= &commandObjType
||
3406 objPtr
->internalRep
.cmdValue
.procEpoch
!= interp
->procEpoch
) &&
3407 SetCommandFromAny(interp
, objPtr
) == JIM_ERR
) {
3408 if (flags
& JIM_ERRMSG
) {
3409 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
3410 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
3411 "invalid command name \"", objPtr
->bytes
, "\"",
3416 return objPtr
->internalRep
.cmdValue
.cmdPtr
;
3419 /* -----------------------------------------------------------------------------
3421 * ---------------------------------------------------------------------------*/
3423 /* Variables HashTable Type.
3425 * Keys are dynamic allocated strings, Values are Jim_Var structures. */
3426 static void JimVariablesHTValDestructor(void *interp
, void *val
)
3428 Jim_Var
*varPtr
= (void*) val
;
3430 Jim_DecrRefCount(interp
, varPtr
->objPtr
);
3434 static Jim_HashTableType JimVariablesHashTableType
= {
3435 JimStringCopyHTHashFunction
, /* hash function */
3436 JimStringCopyHTKeyDup
, /* key dup */
3438 JimStringCopyHTKeyCompare
, /* key compare */
3439 JimStringCopyHTKeyDestructor
, /* key destructor */
3440 JimVariablesHTValDestructor
/* val destructor */
3443 /* -----------------------------------------------------------------------------
3445 * ---------------------------------------------------------------------------*/
3447 #define JIM_DICT_SUGAR 100 /* Only returned by SetVariableFromAny() */
3449 static int SetVariableFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
);
3451 static Jim_ObjType variableObjType
= {
3456 JIM_TYPE_REFERENCES
,
3459 /* Return true if the string "str" looks like syntax sugar for [dict]. I.e.
3460 * is in the form "varname(key)". */
3461 static int Jim_NameIsDictSugar(const char *str
, int len
)
3465 if (len
&& str
[len
-1] == ')' && strchr(str
, '(') != NULL
)
3470 /* This method should be called only by the variable API.
3471 * It returns JIM_OK on success (variable already exists),
3472 * JIM_ERR if it does not exists, JIM_DICT_GLUE if it's not
3473 * a variable name, but syntax glue for [dict] i.e. the last
3474 * character is ')' */
3475 int SetVariableFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
)
3478 const char *varName
;
3481 /* Check if the object is already an uptodate variable */
3482 if (objPtr
->typePtr
== &variableObjType
&&
3483 objPtr
->internalRep
.varValue
.callFrameId
== interp
->framePtr
->id
)
3484 return JIM_OK
; /* nothing to do */
3485 /* Get the string representation */
3486 varName
= Jim_GetString(objPtr
, &len
);
3487 /* Make sure it's not syntax glue to get/set dict. */
3488 if (Jim_NameIsDictSugar(varName
, len
))
3489 return JIM_DICT_SUGAR
;
3490 if (varName
[0] == ':' && varName
[1] == ':') {
3491 he
= Jim_FindHashEntry(&interp
->topFramePtr
->vars
, varName
+ 2);
3497 /* Lookup this name into the variables hash table */
3498 he
= Jim_FindHashEntry(&interp
->framePtr
->vars
, varName
);
3500 /* Try with static vars. */
3501 if (interp
->framePtr
->staticVars
== NULL
)
3503 if (!(he
= Jim_FindHashEntry(interp
->framePtr
->staticVars
, varName
)))
3507 /* Free the old internal repr and set the new one. */
3508 Jim_FreeIntRep(interp
, objPtr
);
3509 objPtr
->typePtr
= &variableObjType
;
3510 objPtr
->internalRep
.varValue
.callFrameId
= interp
->framePtr
->id
;
3511 objPtr
->internalRep
.varValue
.varPtr
= (void*)he
->val
;
3515 /* -------------------- Variables related functions ------------------------- */
3516 static int JimDictSugarSet(Jim_Interp
*interp
, Jim_Obj
*ObjPtr
,
3517 Jim_Obj
*valObjPtr
);
3518 static Jim_Obj
*JimDictSugarGet(Jim_Interp
*interp
, Jim_Obj
*ObjPtr
);
3520 /* For now that's dummy. Variables lookup should be optimized
3521 * in many ways, with caching of lookups, and possibly with
3522 * a table of pre-allocated vars in every CallFrame for local vars.
3523 * All the caching should also have an 'epoch' mechanism similar
3524 * to the one used by Tcl for procedures lookup caching. */
3526 int Jim_SetVariable(Jim_Interp
*interp
, Jim_Obj
*nameObjPtr
, Jim_Obj
*valObjPtr
)
3532 if ((err
= SetVariableFromAny(interp
, nameObjPtr
)) != JIM_OK
) {
3533 /* Check for [dict] syntax sugar. */
3534 if (err
== JIM_DICT_SUGAR
)
3535 return JimDictSugarSet(interp
, nameObjPtr
, valObjPtr
);
3536 /* New variable to create */
3537 name
= Jim_GetString(nameObjPtr
, NULL
);
3539 var
= Jim_Alloc(sizeof(*var
));
3540 var
->objPtr
= valObjPtr
;
3541 Jim_IncrRefCount(valObjPtr
);
3542 var
->linkFramePtr
= NULL
;
3543 /* Insert the new variable */
3544 if (name
[0] == ':' && name
[1] == ':') {
3545 /* Into to the top evel frame */
3546 Jim_AddHashEntry(&interp
->topFramePtr
->vars
, name
+ 2, var
);
3549 Jim_AddHashEntry(&interp
->framePtr
->vars
, name
, var
);
3551 /* Make the object int rep a variable */
3552 Jim_FreeIntRep(interp
, nameObjPtr
);
3553 nameObjPtr
->typePtr
= &variableObjType
;
3554 nameObjPtr
->internalRep
.varValue
.callFrameId
=
3555 interp
->framePtr
->id
;
3556 nameObjPtr
->internalRep
.varValue
.varPtr
= var
;
3558 var
= nameObjPtr
->internalRep
.varValue
.varPtr
;
3559 if (var
->linkFramePtr
== NULL
) {
3560 Jim_IncrRefCount(valObjPtr
);
3561 Jim_DecrRefCount(interp
, var
->objPtr
);
3562 var
->objPtr
= valObjPtr
;
3563 } else { /* Else handle the link */
3564 Jim_CallFrame
*savedCallFrame
;
3566 savedCallFrame
= interp
->framePtr
;
3567 interp
->framePtr
= var
->linkFramePtr
;
3568 err
= Jim_SetVariable(interp
, var
->objPtr
, valObjPtr
);
3569 interp
->framePtr
= savedCallFrame
;
3577 int Jim_SetVariableStr(Jim_Interp
*interp
, const char *name
, Jim_Obj
*objPtr
)
3579 Jim_Obj
*nameObjPtr
;
3582 nameObjPtr
= Jim_NewStringObj(interp
, name
, -1);
3583 Jim_IncrRefCount(nameObjPtr
);
3584 result
= Jim_SetVariable(interp
, nameObjPtr
, objPtr
);
3585 Jim_DecrRefCount(interp
, nameObjPtr
);
3589 int Jim_SetGlobalVariableStr(Jim_Interp
*interp
, const char *name
, Jim_Obj
*objPtr
)
3591 Jim_CallFrame
*savedFramePtr
;
3594 savedFramePtr
= interp
->framePtr
;
3595 interp
->framePtr
= interp
->topFramePtr
;
3596 result
= Jim_SetVariableStr(interp
, name
, objPtr
);
3597 interp
->framePtr
= savedFramePtr
;
3601 int Jim_SetVariableStrWithStr(Jim_Interp
*interp
, const char *name
, const char *val
)
3603 Jim_Obj
*nameObjPtr
, *valObjPtr
;
3606 nameObjPtr
= Jim_NewStringObj(interp
, name
, -1);
3607 valObjPtr
= Jim_NewStringObj(interp
, val
, -1);
3608 Jim_IncrRefCount(nameObjPtr
);
3609 Jim_IncrRefCount(valObjPtr
);
3610 result
= Jim_SetVariable(interp
, nameObjPtr
, valObjPtr
);
3611 Jim_DecrRefCount(interp
, nameObjPtr
);
3612 Jim_DecrRefCount(interp
, valObjPtr
);
3616 int Jim_SetVariableLink(Jim_Interp
*interp
, Jim_Obj
*nameObjPtr
,
3617 Jim_Obj
*targetNameObjPtr
, Jim_CallFrame
*targetCallFrame
)
3619 const char *varName
;
3622 /* Check for cycles. */
3623 if (interp
->framePtr
== targetCallFrame
) {
3624 Jim_Obj
*objPtr
= targetNameObjPtr
;
3626 /* Cycles are only possible with 'uplevel 0' */
3628 if (Jim_StringEqObj(objPtr
, nameObjPtr
, 0)) {
3629 Jim_SetResultString(interp
,
3630 "can't upvar from variable to itself", -1);
3633 if (SetVariableFromAny(interp
, objPtr
) != JIM_OK
)
3635 varPtr
= objPtr
->internalRep
.varValue
.varPtr
;
3636 if (varPtr
->linkFramePtr
!= targetCallFrame
) break;
3637 objPtr
= varPtr
->objPtr
;
3640 varName
= Jim_GetString(nameObjPtr
, &len
);
3641 if (Jim_NameIsDictSugar(varName
, len
)) {
3642 Jim_SetResultString(interp
,
3643 "Dict key syntax invalid as link source", -1);
3646 /* Perform the binding */
3647 Jim_SetVariable(interp
, nameObjPtr
, targetNameObjPtr
);
3648 /* We are now sure 'nameObjPtr' type is variableObjType */
3649 nameObjPtr
->internalRep
.varValue
.varPtr
->linkFramePtr
= targetCallFrame
;
3653 /* Return the Jim_Obj pointer associated with a variable name,
3654 * or NULL if the variable was not found in the current context.
3655 * The same optimization discussed in the comment to the
3656 * 'SetVariable' function should apply here. */
3657 Jim_Obj
*Jim_GetVariable(Jim_Interp
*interp
, Jim_Obj
*nameObjPtr
, int flags
)
3661 /* All the rest is handled here */
3662 if ((err
= SetVariableFromAny(interp
, nameObjPtr
)) != JIM_OK
) {
3663 /* Check for [dict] syntax sugar. */
3664 if (err
== JIM_DICT_SUGAR
)
3665 return JimDictSugarGet(interp
, nameObjPtr
);
3666 if (flags
& JIM_ERRMSG
) {
3667 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
3668 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
3669 "can't read \"", nameObjPtr
->bytes
,
3670 "\": no such variable", NULL
);
3676 Jim_CallFrame
*savedCallFrame
;
3678 varPtr
= nameObjPtr
->internalRep
.varValue
.varPtr
;
3679 if (varPtr
->linkFramePtr
== NULL
)
3680 return varPtr
->objPtr
;
3681 /* The variable is a link? Resolve it. */
3682 savedCallFrame
= interp
->framePtr
;
3683 interp
->framePtr
= varPtr
->linkFramePtr
;
3684 objPtr
= Jim_GetVariable(interp
, varPtr
->objPtr
, JIM_NONE
);
3685 if (objPtr
== NULL
&& flags
& JIM_ERRMSG
) {
3686 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
3687 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
3688 "can't read \"", nameObjPtr
->bytes
,
3689 "\": no such variable", NULL
);
3691 interp
->framePtr
= savedCallFrame
;
3696 Jim_Obj
*Jim_GetGlobalVariable(Jim_Interp
*interp
, Jim_Obj
*nameObjPtr
,
3699 Jim_CallFrame
*savedFramePtr
;
3702 savedFramePtr
= interp
->framePtr
;
3703 interp
->framePtr
= interp
->topFramePtr
;
3704 objPtr
= Jim_GetVariable(interp
, nameObjPtr
, flags
);
3705 interp
->framePtr
= savedFramePtr
;
3710 Jim_Obj
*Jim_GetVariableStr(Jim_Interp
*interp
, const char *name
, int flags
)
3712 Jim_Obj
*nameObjPtr
, *varObjPtr
;
3714 nameObjPtr
= Jim_NewStringObj(interp
, name
, -1);
3715 Jim_IncrRefCount(nameObjPtr
);
3716 varObjPtr
= Jim_GetVariable(interp
, nameObjPtr
, flags
);
3717 Jim_DecrRefCount(interp
, nameObjPtr
);
3721 Jim_Obj
*Jim_GetGlobalVariableStr(Jim_Interp
*interp
, const char *name
,
3724 Jim_CallFrame
*savedFramePtr
;
3727 savedFramePtr
= interp
->framePtr
;
3728 interp
->framePtr
= interp
->topFramePtr
;
3729 objPtr
= Jim_GetVariableStr(interp
, name
, flags
);
3730 interp
->framePtr
= savedFramePtr
;
3735 /* Unset a variable.
3736 * Note: On success unset invalidates all the variable objects created
3737 * in the current call frame incrementing. */
3738 int Jim_UnsetVariable(Jim_Interp
*interp
, Jim_Obj
*nameObjPtr
, int flags
)
3744 if ((err
= SetVariableFromAny(interp
, nameObjPtr
)) != JIM_OK
) {
3745 /* Check for [dict] syntax sugar. */
3746 if (err
== JIM_DICT_SUGAR
)
3747 return JimDictSugarSet(interp
, nameObjPtr
, NULL
);
3748 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
3749 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
3750 "can't unset \"", nameObjPtr
->bytes
,
3751 "\": no such variable", NULL
);
3752 return JIM_ERR
; /* var not found */
3754 varPtr
= nameObjPtr
->internalRep
.varValue
.varPtr
;
3755 /* If it's a link call UnsetVariable recursively */
3756 if (varPtr
->linkFramePtr
) {
3759 Jim_CallFrame
*savedCallFrame
;
3761 savedCallFrame
= interp
->framePtr
;
3762 interp
->framePtr
= varPtr
->linkFramePtr
;
3763 retval
= Jim_UnsetVariable(interp
, varPtr
->objPtr
, JIM_NONE
);
3764 interp
->framePtr
= savedCallFrame
;
3765 if (retval
!= JIM_OK
&& flags
& JIM_ERRMSG
) {
3766 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
3767 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
3768 "can't unset \"", nameObjPtr
->bytes
,
3769 "\": no such variable", NULL
);
3773 name
= Jim_GetString(nameObjPtr
, NULL
);
3774 if (Jim_DeleteHashEntry(&interp
->framePtr
->vars
, name
)
3775 != JIM_OK
) return JIM_ERR
;
3776 /* Change the callframe id, invalidating var lookup caching */
3777 JimChangeCallFrameId(interp
, interp
->framePtr
);
3782 /* ---------- Dict syntax sugar (similar to array Tcl syntax) -------------- */
3784 /* Given a variable name for [dict] operation syntax sugar,
3785 * this function returns two objects, the first with the name
3786 * of the variable to set, and the second with the rispective key.
3787 * For example "foo(bar)" will return objects with string repr. of
3790 * The returned objects have refcount = 1. The function can't fail. */
3791 static void JimDictSugarParseVarKey(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
3792 Jim_Obj
**varPtrPtr
, Jim_Obj
**keyPtrPtr
)
3794 const char *str
, *p
;
3796 int len
, keyLen
, nameLen
;
3797 Jim_Obj
*varObjPtr
, *keyObjPtr
;
3799 str
= Jim_GetString(objPtr
, &len
);
3800 p
= strchr(str
, '(');
3802 keyLen
= len
-((p
-str
)+1);
3803 nameLen
= (p
-str
)-1;
3804 /* Create the objects with the variable name and key. */
3805 t
= Jim_Alloc(nameLen
+1);
3806 memcpy(t
, str
, nameLen
);
3808 varObjPtr
= Jim_NewStringObjNoAlloc(interp
, t
, nameLen
);
3810 t
= Jim_Alloc(keyLen
+1);
3811 memcpy(t
, p
, keyLen
);
3813 keyObjPtr
= Jim_NewStringObjNoAlloc(interp
, t
, keyLen
);
3815 Jim_IncrRefCount(varObjPtr
);
3816 Jim_IncrRefCount(keyObjPtr
);
3817 *varPtrPtr
= varObjPtr
;
3818 *keyPtrPtr
= keyObjPtr
;
3821 /* Helper of Jim_SetVariable() to deal with dict-syntax variable names.
3822 * Also used by Jim_UnsetVariable() with valObjPtr = NULL. */
3823 static int JimDictSugarSet(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
3826 Jim_Obj
*varObjPtr
, *keyObjPtr
;
3829 JimDictSugarParseVarKey(interp
, objPtr
, &varObjPtr
, &keyObjPtr
);
3830 err
= Jim_SetDictKeysVector(interp
, varObjPtr
, &keyObjPtr
, 1,
3832 Jim_DecrRefCount(interp
, varObjPtr
);
3833 Jim_DecrRefCount(interp
, keyObjPtr
);
3837 /* Helper of Jim_GetVariable() to deal with dict-syntax variable names */
3838 static Jim_Obj
*JimDictSugarGet(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
3840 Jim_Obj
*varObjPtr
, *keyObjPtr
, *dictObjPtr
, *resObjPtr
;
3842 JimDictSugarParseVarKey(interp
, objPtr
, &varObjPtr
, &keyObjPtr
);
3843 dictObjPtr
= Jim_GetVariable(interp
, varObjPtr
, JIM_ERRMSG
);
3848 if (Jim_DictKey(interp
, dictObjPtr
, keyObjPtr
, &resObjPtr
, JIM_ERRMSG
)
3853 Jim_DecrRefCount(interp
, varObjPtr
);
3854 Jim_DecrRefCount(interp
, keyObjPtr
);
3858 /* --------- $var(INDEX) substitution, using a specialized object ----------- */
3860 static void FreeDictSubstInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
3861 static void DupDictSubstInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
,
3864 static Jim_ObjType dictSubstObjType
= {
3865 "dict-substitution",
3866 FreeDictSubstInternalRep
,
3867 DupDictSubstInternalRep
,
3872 void FreeDictSubstInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
3874 Jim_DecrRefCount(interp
, objPtr
->internalRep
.dictSubstValue
.varNameObjPtr
);
3875 Jim_DecrRefCount(interp
, objPtr
->internalRep
.dictSubstValue
.indexObjPtr
);
3878 void DupDictSubstInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
,
3881 JIM_NOTUSED(interp
);
3883 dupPtr
->internalRep
.dictSubstValue
.varNameObjPtr
=
3884 srcPtr
->internalRep
.dictSubstValue
.varNameObjPtr
;
3885 dupPtr
->internalRep
.dictSubstValue
.indexObjPtr
=
3886 srcPtr
->internalRep
.dictSubstValue
.indexObjPtr
;
3887 dupPtr
->typePtr
= &dictSubstObjType
;
3890 /* This function is used to expand [dict get] sugar in the form
3891 * of $var(INDEX). The function is mainly used by Jim_EvalObj()
3892 * to deal with tokens of type JIM_TT_DICTSUGAR. objPtr points to an
3893 * object that is *guaranteed* to be in the form VARNAME(INDEX).
3894 * The 'index' part is [subst]ituted, and is used to lookup a key inside
3895 * the [dict]ionary contained in variable VARNAME. */
3896 Jim_Obj
*Jim_ExpandDictSugar(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
3898 Jim_Obj
*varObjPtr
, *keyObjPtr
, *dictObjPtr
, *resObjPtr
;
3899 Jim_Obj
*substKeyObjPtr
= NULL
;
3901 if (objPtr
->typePtr
!= &dictSubstObjType
) {
3902 JimDictSugarParseVarKey(interp
, objPtr
, &varObjPtr
, &keyObjPtr
);
3903 Jim_FreeIntRep(interp
, objPtr
);
3904 objPtr
->typePtr
= &dictSubstObjType
;
3905 objPtr
->internalRep
.dictSubstValue
.varNameObjPtr
= varObjPtr
;
3906 objPtr
->internalRep
.dictSubstValue
.indexObjPtr
= keyObjPtr
;
3908 if (Jim_SubstObj(interp
, objPtr
->internalRep
.dictSubstValue
.indexObjPtr
,
3909 &substKeyObjPtr
, JIM_NONE
)
3911 substKeyObjPtr
= NULL
;
3914 Jim_IncrRefCount(substKeyObjPtr
);
3915 dictObjPtr
= Jim_GetVariable(interp
,
3916 objPtr
->internalRep
.dictSubstValue
.varNameObjPtr
, JIM_ERRMSG
);
3921 if (Jim_DictKey(interp
, dictObjPtr
, substKeyObjPtr
, &resObjPtr
, JIM_ERRMSG
)
3927 if (substKeyObjPtr
) Jim_DecrRefCount(interp
, substKeyObjPtr
);
3931 /* -----------------------------------------------------------------------------
3933 * ---------------------------------------------------------------------------*/
3935 static Jim_CallFrame
*JimCreateCallFrame(Jim_Interp
*interp
)
3938 if (interp
->freeFramesList
) {
3939 cf
= interp
->freeFramesList
;
3940 interp
->freeFramesList
= cf
->nextFramePtr
;
3942 cf
= Jim_Alloc(sizeof(*cf
));
3943 cf
->vars
.table
= NULL
;
3946 cf
->id
= interp
->callFrameEpoch
++;
3947 cf
->parentCallFrame
= NULL
;
3950 cf
->procArgsObjPtr
= NULL
;
3951 cf
->procBodyObjPtr
= NULL
;
3952 cf
->nextFramePtr
= NULL
;
3953 cf
->staticVars
= NULL
;
3954 if (cf
->vars
.table
== NULL
)
3955 Jim_InitHashTable(&cf
->vars
, &JimVariablesHashTableType
, interp
);
3959 /* Used to invalidate every caching related to callframe stability. */
3960 static void JimChangeCallFrameId(Jim_Interp
*interp
, Jim_CallFrame
*cf
)
3962 cf
->id
= interp
->callFrameEpoch
++;
3965 #define JIM_FCF_NONE 0 /* no flags */
3966 #define JIM_FCF_NOHT 1 /* don't free the hash table */
3967 static void JimFreeCallFrame(Jim_Interp
*interp
, Jim_CallFrame
*cf
,
3970 if (cf
->procArgsObjPtr
) Jim_DecrRefCount(interp
, cf
->procArgsObjPtr
);
3971 if (cf
->procBodyObjPtr
) Jim_DecrRefCount(interp
, cf
->procBodyObjPtr
);
3972 if (!(flags
& JIM_FCF_NOHT
))
3973 Jim_FreeHashTable(&cf
->vars
);
3976 Jim_HashEntry
**table
= cf
->vars
.table
, *he
;
3978 for (i
= 0; i
< JIM_HT_INITIAL_SIZE
; i
++) {
3980 while (he
!= NULL
) {
3981 Jim_HashEntry
*nextEntry
= he
->next
;
3982 Jim_Var
*varPtr
= (void*) he
->val
;
3984 Jim_DecrRefCount(interp
, varPtr
->objPtr
);
3986 Jim_Free((void*)he
->key
); /* ATTENTION: const cast */
3994 cf
->nextFramePtr
= interp
->freeFramesList
;
3995 interp
->freeFramesList
= cf
;
3998 /* -----------------------------------------------------------------------------
4000 * ---------------------------------------------------------------------------*/
4002 /* References HashTable Type.
4004 * Keys are jim_wide integers, dynamically allocated for now but in the
4005 * future it's worth to cache this 8 bytes objects. Values are poitners
4006 * to Jim_References. */
4007 static void JimReferencesHTValDestructor(void *interp
, void *val
)
4009 Jim_Reference
*refPtr
= (void*) val
;
4011 Jim_DecrRefCount(interp
, refPtr
->objPtr
);
4012 if (refPtr
->finalizerCmdNamePtr
!= NULL
) {
4013 Jim_DecrRefCount(interp
, refPtr
->finalizerCmdNamePtr
);
4018 unsigned int JimReferencesHTHashFunction(const void *key
)
4020 /* Only the least significant bits are used. */
4021 const jim_wide
*widePtr
= key
;
4022 unsigned int intValue
= (unsigned int) *widePtr
;
4023 return Jim_IntHashFunction(intValue
);
4026 unsigned int JimReferencesHTDoubleHashFunction(const void *key
)
4028 /* Only the least significant bits are used. */
4029 const jim_wide
*widePtr
= key
;
4030 unsigned int intValue
= (unsigned int) *widePtr
;
4031 return intValue
; /* identity function. */
4034 const void *JimReferencesHTKeyDup(void *privdata
, const void *key
)
4036 void *copy
= Jim_Alloc(sizeof(jim_wide
));
4037 JIM_NOTUSED(privdata
);
4039 memcpy(copy
, key
, sizeof(jim_wide
));
4043 int JimReferencesHTKeyCompare(void *privdata
, const void *key1
,
4046 JIM_NOTUSED(privdata
);
4048 return memcmp(key1
, key2
, sizeof(jim_wide
)) == 0;
4051 void JimReferencesHTKeyDestructor(void *privdata
, const void *key
)
4053 JIM_NOTUSED(privdata
);
4055 Jim_Free((void*)key
);
4058 static Jim_HashTableType JimReferencesHashTableType
= {
4059 JimReferencesHTHashFunction
, /* hash function */
4060 JimReferencesHTKeyDup
, /* key dup */
4062 JimReferencesHTKeyCompare
, /* key compare */
4063 JimReferencesHTKeyDestructor
, /* key destructor */
4064 JimReferencesHTValDestructor
/* val destructor */
4067 /* -----------------------------------------------------------------------------
4068 * Reference object type and References API
4069 * ---------------------------------------------------------------------------*/
4071 static void UpdateStringOfReference(struct Jim_Obj
*objPtr
);
4073 static Jim_ObjType referenceObjType
= {
4077 UpdateStringOfReference
,
4078 JIM_TYPE_REFERENCES
,
4081 void UpdateStringOfReference(struct Jim_Obj
*objPtr
)
4084 char buf
[JIM_REFERENCE_SPACE
+1];
4085 Jim_Reference
*refPtr
;
4087 refPtr
= objPtr
->internalRep
.refValue
.refPtr
;
4088 len
= JimFormatReference(buf
, refPtr
, objPtr
->internalRep
.refValue
.id
);
4089 objPtr
->bytes
= Jim_Alloc(len
+1);
4090 memcpy(objPtr
->bytes
, buf
, len
+1);
4091 objPtr
->length
= len
;
4094 /* returns true if 'c' is a valid reference tag character.
4095 * i.e. inside the range [_a-zA-Z0-9] */
4096 static int isrefchar(int c
)
4098 if (c
== '_' || (c
>= 'a' && c
<= 'z') || (c
>= 'A' && c
<= 'Z') ||
4099 (c
>= '0' && c
<= '9')) return 1;
4103 int SetReferenceFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
4107 const char *str
, *start
, *end
;
4109 Jim_Reference
*refPtr
;
4112 /* Get the string representation */
4113 str
= Jim_GetString(objPtr
, &len
);
4114 /* Check if it looks like a reference */
4115 if (len
< JIM_REFERENCE_SPACE
) goto badformat
;
4119 while (*start
== ' ') start
++;
4120 while (*end
== ' ' && end
> start
) end
--;
4121 if (end
-start
+1 != JIM_REFERENCE_SPACE
) goto badformat
;
4122 /* <reference.<1234567>.%020> */
4123 if (memcmp(start
, "<reference.<", 12) != 0) goto badformat
;
4124 if (start
[12+JIM_REFERENCE_TAGLEN
] != '>' || end
[0] != '>') goto badformat
;
4125 /* The tag can't contain chars other than a-zA-Z0-9 + '_'. */
4126 for (i
= 0; i
< JIM_REFERENCE_TAGLEN
; i
++) {
4127 if (!isrefchar(start
[12+i
])) goto badformat
;
4129 /* Extract info from the refernece. */
4130 memcpy(refId
, start
+14+JIM_REFERENCE_TAGLEN
, 20);
4132 /* Try to convert the ID into a jim_wide */
4133 if (Jim_StringToWide(refId
, &wideValue
, 10) != JIM_OK
) goto badformat
;
4134 /* Check if the reference really exists! */
4135 he
= Jim_FindHashEntry(&interp
->references
, &wideValue
);
4137 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4138 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4139 "Invalid reference ID \"", str
, "\"", NULL
);
4143 /* Free the old internal repr and set the new one. */
4144 Jim_FreeIntRep(interp
, objPtr
);
4145 objPtr
->typePtr
= &referenceObjType
;
4146 objPtr
->internalRep
.refValue
.id
= wideValue
;
4147 objPtr
->internalRep
.refValue
.refPtr
= refPtr
;
4151 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4152 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4153 "expected reference but got \"", str
, "\"", NULL
);
4157 /* Returns a new reference pointing to objPtr, having cmdNamePtr
4158 * as finalizer command (or NULL if there is no finalizer).
4159 * The returned reference object has refcount = 0. */
4160 Jim_Obj
*Jim_NewReference(Jim_Interp
*interp
, Jim_Obj
*objPtr
, Jim_Obj
*tagPtr
,
4161 Jim_Obj
*cmdNamePtr
)
4163 struct Jim_Reference
*refPtr
;
4164 jim_wide wideValue
= interp
->referenceNextId
;
4169 /* Perform the Garbage Collection if needed. */
4170 Jim_CollectIfNeeded(interp
);
4172 refPtr
= Jim_Alloc(sizeof(*refPtr
));
4173 refPtr
->objPtr
= objPtr
;
4174 Jim_IncrRefCount(objPtr
);
4175 refPtr
->finalizerCmdNamePtr
= cmdNamePtr
;
4177 Jim_IncrRefCount(cmdNamePtr
);
4178 Jim_AddHashEntry(&interp
->references
, &wideValue
, refPtr
);
4179 refObjPtr
= Jim_NewObj(interp
);
4180 refObjPtr
->typePtr
= &referenceObjType
;
4181 refObjPtr
->bytes
= NULL
;
4182 refObjPtr
->internalRep
.refValue
.id
= interp
->referenceNextId
;
4183 refObjPtr
->internalRep
.refValue
.refPtr
= refPtr
;
4184 interp
->referenceNextId
++;
4185 /* Set the tag. Trimmered at JIM_REFERENCE_TAGLEN. Everything
4186 * that does not pass the 'isrefchar' test is replaced with '_' */
4187 tag
= Jim_GetString(tagPtr
, &tagLen
);
4188 if (tagLen
> JIM_REFERENCE_TAGLEN
)
4189 tagLen
= JIM_REFERENCE_TAGLEN
;
4190 for (i
= 0; i
< JIM_REFERENCE_TAGLEN
; i
++) {
4192 refPtr
->tag
[i
] = tag
[i
];
4194 refPtr
->tag
[i
] = '_';
4196 refPtr
->tag
[JIM_REFERENCE_TAGLEN
] = '\0';
4200 Jim_Reference
*Jim_GetReference(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
4202 if (objPtr
->typePtr
!= &referenceObjType
&&
4203 SetReferenceFromAny(interp
, objPtr
) == JIM_ERR
)
4205 return objPtr
->internalRep
.refValue
.refPtr
;
4208 int Jim_SetFinalizer(Jim_Interp
*interp
, Jim_Obj
*objPtr
, Jim_Obj
*cmdNamePtr
)
4210 Jim_Reference
*refPtr
;
4212 if ((refPtr
= Jim_GetReference(interp
, objPtr
)) == NULL
)
4214 Jim_IncrRefCount(cmdNamePtr
);
4215 if (refPtr
->finalizerCmdNamePtr
)
4216 Jim_DecrRefCount(interp
, refPtr
->finalizerCmdNamePtr
);
4217 refPtr
->finalizerCmdNamePtr
= cmdNamePtr
;
4221 int Jim_GetFinalizer(Jim_Interp
*interp
, Jim_Obj
*objPtr
, Jim_Obj
**cmdNamePtrPtr
)
4223 Jim_Reference
*refPtr
;
4225 if ((refPtr
= Jim_GetReference(interp
, objPtr
)) == NULL
)
4227 *cmdNamePtrPtr
= refPtr
->finalizerCmdNamePtr
;
4231 /* -----------------------------------------------------------------------------
4232 * References Garbage Collection
4233 * ---------------------------------------------------------------------------*/
4235 /* This the hash table type for the "MARK" phase of the GC */
4236 static Jim_HashTableType JimRefMarkHashTableType
= {
4237 JimReferencesHTHashFunction
, /* hash function */
4238 JimReferencesHTKeyDup
, /* key dup */
4240 JimReferencesHTKeyCompare
, /* key compare */
4241 JimReferencesHTKeyDestructor
, /* key destructor */
4242 NULL
/* val destructor */
4245 /* #define JIM_DEBUG_GC 1 */
4247 /* Performs the garbage collection. */
4248 int Jim_Collect(Jim_Interp
*interp
)
4250 Jim_HashTable marks
;
4251 Jim_HashTableIterator
*htiter
;
4256 /* Avoid recursive calls */
4257 if (interp
->lastCollectId
== -1) {
4258 /* Jim_Collect() already running. Return just now. */
4261 interp
->lastCollectId
= -1;
4263 /* Mark all the references found into the 'mark' hash table.
4264 * The references are searched in every live object that
4265 * is of a type that can contain references. */
4266 Jim_InitHashTable(&marks
, &JimRefMarkHashTableType
, NULL
);
4267 objPtr
= interp
->liveList
;
4269 if (objPtr
->typePtr
== NULL
||
4270 objPtr
->typePtr
->flags
& JIM_TYPE_REFERENCES
) {
4271 const char *str
, *p
;
4274 /* If the object is of type reference, to get the
4275 * Id is simple... */
4276 if (objPtr
->typePtr
== &referenceObjType
) {
4277 Jim_AddHashEntry(&marks
,
4278 &objPtr
->internalRep
.refValue
.id
, NULL
);
4280 Jim_fprintf(interp
,interp
->cookie_stdout
,
4281 "MARK (reference): %d refcount: %d" JIM_NL
,
4282 (int) objPtr
->internalRep
.refValue
.id
,
4285 objPtr
= objPtr
->nextObjPtr
;
4288 /* Get the string repr of the object we want
4289 * to scan for references. */
4290 p
= str
= Jim_GetString(objPtr
, &len
);
4291 /* Skip objects too little to contain references. */
4292 if (len
< JIM_REFERENCE_SPACE
) {
4293 objPtr
= objPtr
->nextObjPtr
;
4296 /* Extract references from the object string repr. */
4302 if ((p
= strstr(p
, "<reference.<")) == NULL
)
4304 /* Check if it's a valid reference. */
4305 if (len
-(p
-str
) < JIM_REFERENCE_SPACE
) break;
4306 if (p
[41] != '>' || p
[19] != '>' || p
[20] != '.') break;
4307 for (i
= 21; i
<= 40; i
++)
4308 if (!isdigit((int)p
[i
]))
4311 memcpy(buf
, p
+21, 20);
4313 Jim_StringToWide(buf
, &id
, 10);
4315 /* Ok, a reference for the given ID
4316 * was found. Mark it. */
4317 Jim_AddHashEntry(&marks
, &id
, NULL
);
4319 Jim_fprintf(interp
,interp
->cookie_stdout
,"MARK: %d" JIM_NL
, (int)id
);
4321 p
+= JIM_REFERENCE_SPACE
;
4324 objPtr
= objPtr
->nextObjPtr
;
4327 /* Run the references hash table to destroy every reference that
4328 * is not referenced outside (not present in the mark HT). */
4329 htiter
= Jim_GetHashTableIterator(&interp
->references
);
4330 while ((he
= Jim_NextHashEntry(htiter
)) != NULL
) {
4331 const jim_wide
*refId
;
4332 Jim_Reference
*refPtr
;
4335 /* Check if in the mark phase we encountered
4336 * this reference. */
4337 if (Jim_FindHashEntry(&marks
, refId
) == NULL
) {
4339 Jim_fprintf(interp
,interp
->cookie_stdout
,"COLLECTING %d" JIM_NL
, (int)*refId
);
4342 /* Drop the reference, but call the
4343 * finalizer first if registered. */
4345 if (refPtr
->finalizerCmdNamePtr
) {
4346 char *refstr
= Jim_Alloc(JIM_REFERENCE_SPACE
+1);
4347 Jim_Obj
*objv
[3], *oldResult
;
4349 JimFormatReference(refstr
, refPtr
, *refId
);
4351 objv
[0] = refPtr
->finalizerCmdNamePtr
;
4352 objv
[1] = Jim_NewStringObjNoAlloc(interp
,
4354 objv
[2] = refPtr
->objPtr
;
4355 Jim_IncrRefCount(objv
[0]);
4356 Jim_IncrRefCount(objv
[1]);
4357 Jim_IncrRefCount(objv
[2]);
4359 /* Drop the reference itself */
4360 Jim_DeleteHashEntry(&interp
->references
, refId
);
4362 /* Call the finalizer. Errors ignored. */
4363 oldResult
= interp
->result
;
4364 Jim_IncrRefCount(oldResult
);
4365 Jim_EvalObjVector(interp
, 3, objv
);
4366 Jim_SetResult(interp
, oldResult
);
4367 Jim_DecrRefCount(interp
, oldResult
);
4369 Jim_DecrRefCount(interp
, objv
[0]);
4370 Jim_DecrRefCount(interp
, objv
[1]);
4371 Jim_DecrRefCount(interp
, objv
[2]);
4373 Jim_DeleteHashEntry(&interp
->references
, refId
);
4377 Jim_FreeHashTableIterator(htiter
);
4378 Jim_FreeHashTable(&marks
);
4379 interp
->lastCollectId
= interp
->referenceNextId
;
4380 interp
->lastCollectTime
= time(NULL
);
4384 #define JIM_COLLECT_ID_PERIOD 5000
4385 #define JIM_COLLECT_TIME_PERIOD 300
4387 void Jim_CollectIfNeeded(Jim_Interp
*interp
)
4392 elapsedId
= interp
->referenceNextId
- interp
->lastCollectId
;
4393 elapsedTime
= time(NULL
) - interp
->lastCollectTime
;
4396 if (elapsedId
> JIM_COLLECT_ID_PERIOD
||
4397 elapsedTime
> JIM_COLLECT_TIME_PERIOD
) {
4398 Jim_Collect(interp
);
4402 /* -----------------------------------------------------------------------------
4403 * Interpreter related functions
4404 * ---------------------------------------------------------------------------*/
4406 Jim_Interp
*Jim_CreateInterp(void)
4408 Jim_Interp
*i
= Jim_Alloc(sizeof(*i
));
4412 i
->errorFileName
= Jim_StrDup("");
4414 i
->maxNestingDepth
= JIM_MAX_NESTING_DEPTH
;
4415 i
->returnCode
= JIM_OK
;
4418 i
->callFrameEpoch
= 0;
4419 i
->liveList
= i
->freeList
= NULL
;
4420 i
->scriptFileName
= Jim_StrDup("");
4421 i
->referenceNextId
= 0;
4422 i
->lastCollectId
= 0;
4423 i
->lastCollectTime
= time(NULL
);
4424 i
->freeFramesList
= NULL
;
4425 i
->prngState
= NULL
;
4426 i
->evalRetcodeLevel
= -1;
4427 i
->cookie_stdin
= stdin
;
4428 i
->cookie_stdout
= stdout
;
4429 i
->cookie_stderr
= stderr
;
4430 i
->cb_fwrite
= ((size_t (*)( const void *, size_t, size_t, void *))(fwrite
));
4431 i
->cb_fread
= ((size_t (*)( void *, size_t, size_t, void *))(fread
));
4432 i
->cb_vfprintf
= ((int (*)( void *, const char *fmt
, va_list ))(vfprintf
));
4433 i
->cb_fflush
= ((int (*)( void *))(fflush
));
4434 i
->cb_fgets
= ((char * (*)( char *, int, void *))(fgets
));
4436 /* Note that we can create objects only after the
4437 * interpreter liveList and freeList pointers are
4438 * initialized to NULL. */
4439 Jim_InitHashTable(&i
->commands
, &JimCommandsHashTableType
, i
);
4440 Jim_InitHashTable(&i
->references
, &JimReferencesHashTableType
, i
);
4441 Jim_InitHashTable(&i
->sharedStrings
, &JimSharedStringsHashTableType
,
4443 Jim_InitHashTable(&i
->stub
, &JimStringCopyHashTableType
, NULL
);
4444 Jim_InitHashTable(&i
->assocData
, &JimAssocDataHashTableType
, i
);
4445 Jim_InitHashTable(&i
->packages
, &JimStringKeyValCopyHashTableType
, NULL
);
4446 i
->framePtr
= i
->topFramePtr
= JimCreateCallFrame(i
);
4447 i
->emptyObj
= Jim_NewEmptyStringObj(i
);
4448 i
->result
= i
->emptyObj
;
4449 i
->stackTrace
= Jim_NewListObj(i
, NULL
, 0);
4450 i
->unknown
= Jim_NewStringObj(i
, "unknown", -1);
4451 i
->unknown_called
= 0;
4452 Jim_IncrRefCount(i
->emptyObj
);
4453 Jim_IncrRefCount(i
->result
);
4454 Jim_IncrRefCount(i
->stackTrace
);
4455 Jim_IncrRefCount(i
->unknown
);
4457 /* Initialize key variables every interpreter should contain */
4458 pathPtr
= Jim_NewStringObj(i
, "./", -1);
4459 Jim_SetVariableStr(i
, "jim_libpath", pathPtr
);
4460 Jim_SetVariableStrWithStr(i
, "jim_interactive", "0");
4462 /* Export the core API to extensions */
4463 JimRegisterCoreApi(i
);
4467 /* This is the only function Jim exports directly without
4468 * to use the STUB system. It is only used by embedders
4469 * in order to get an interpreter with the Jim API pointers
4471 Jim_Interp
*ExportedJimCreateInterp(void)
4473 return Jim_CreateInterp();
4476 void Jim_FreeInterp(Jim_Interp
*i
)
4478 Jim_CallFrame
*cf
= i
->framePtr
, *prevcf
, *nextcf
;
4479 Jim_Obj
*objPtr
, *nextObjPtr
;
4481 Jim_DecrRefCount(i
, i
->emptyObj
);
4482 Jim_DecrRefCount(i
, i
->result
);
4483 Jim_DecrRefCount(i
, i
->stackTrace
);
4484 Jim_DecrRefCount(i
, i
->unknown
);
4485 Jim_Free((void*)i
->errorFileName
);
4486 Jim_Free((void*)i
->scriptFileName
);
4487 Jim_FreeHashTable(&i
->commands
);
4488 Jim_FreeHashTable(&i
->references
);
4489 Jim_FreeHashTable(&i
->stub
);
4490 Jim_FreeHashTable(&i
->assocData
);
4491 Jim_FreeHashTable(&i
->packages
);
4492 Jim_Free(i
->prngState
);
4493 /* Free the call frames list */
4495 prevcf
= cf
->parentCallFrame
;
4496 JimFreeCallFrame(i
, cf
, JIM_FCF_NONE
);
4499 /* Check that the live object list is empty, otherwise
4500 * there is a memory leak. */
4501 if (i
->liveList
!= NULL
) {
4502 Jim_Obj
*objPtr
= i
->liveList
;
4504 Jim_fprintf( i
, i
->cookie_stdout
,JIM_NL
"-------------------------------------" JIM_NL
);
4505 Jim_fprintf( i
, i
->cookie_stdout
,"Objects still in the free list:" JIM_NL
);
4507 const char *type
= objPtr
->typePtr
?
4508 objPtr
->typePtr
->name
: "";
4509 Jim_fprintf( i
, i
->cookie_stdout
,"%p \"%-10s\": '%.20s' (refCount: %d)" JIM_NL
,
4511 objPtr
->bytes
? objPtr
->bytes
4512 : "(null)", objPtr
->refCount
);
4513 if (objPtr
->typePtr
== &sourceObjType
) {
4514 Jim_fprintf( i
, i
->cookie_stdout
, "FILE %s LINE %d" JIM_NL
,
4515 objPtr
->internalRep
.sourceValue
.fileName
,
4516 objPtr
->internalRep
.sourceValue
.lineNumber
);
4518 objPtr
= objPtr
->nextObjPtr
;
4520 Jim_fprintf( i
, i
->cookie_stdout
, "-------------------------------------" JIM_NL JIM_NL
);
4521 Jim_Panic(i
,"Live list non empty freeing the interpreter! Leak?");
4523 /* Free all the freed objects. */
4524 objPtr
= i
->freeList
;
4526 nextObjPtr
= objPtr
->nextObjPtr
;
4528 objPtr
= nextObjPtr
;
4530 /* Free cached CallFrame structures */
4531 cf
= i
->freeFramesList
;
4533 nextcf
= cf
->nextFramePtr
;
4534 if (cf
->vars
.table
!= NULL
)
4535 Jim_Free(cf
->vars
.table
);
4539 /* Free the sharedString hash table. Make sure to free it
4540 * after every other Jim_Object was freed. */
4541 Jim_FreeHashTable(&i
->sharedStrings
);
4542 /* Free the interpreter structure. */
4546 /* Store the call frame relative to the level represented by
4547 * levelObjPtr into *framePtrPtr. If levelObjPtr == NULL, the
4548 * level is assumed to be '1'.
4550 * If a newLevelptr int pointer is specified, the function stores
4551 * the absolute level integer value of the new target callframe into
4552 * *newLevelPtr. (this is used to adjust interp->numLevels
4553 * in the implementation of [uplevel], so that [info level] will
4554 * return a correct information).
4556 * This function accepts the 'level' argument in the form
4557 * of the commands [uplevel] and [upvar].
4559 * For a function accepting a relative integer as level suitable
4560 * for implementation of [info level ?level?] check the
4561 * GetCallFrameByInteger() function. */
4562 int Jim_GetCallFrameByLevel(Jim_Interp
*interp
, Jim_Obj
*levelObjPtr
,
4563 Jim_CallFrame
**framePtrPtr
, int *newLevelPtr
)
4567 Jim_CallFrame
*framePtr
;
4569 if (newLevelPtr
) *newLevelPtr
= interp
->numLevels
;
4571 str
= Jim_GetString(levelObjPtr
, NULL
);
4572 if (str
[0] == '#') {
4574 /* speedup for the toplevel (level #0) */
4575 if (str
[1] == '0' && str
[2] == '\0') {
4576 if (newLevelPtr
) *newLevelPtr
= 0;
4577 *framePtrPtr
= interp
->topFramePtr
;
4581 level
= strtol(str
+1, &endptr
, 0);
4582 if (str
[1] == '\0' || endptr
[0] != '\0' || level
< 0)
4584 /* An 'absolute' level is converted into the
4585 * 'number of levels to go back' format. */
4586 level
= interp
->numLevels
- level
;
4587 if (level
< 0) goto badlevel
;
4589 if (Jim_GetLong(interp
, levelObjPtr
, &level
) != JIM_OK
|| level
< 0)
4593 str
= "1"; /* Needed to format the error message. */
4597 framePtr
= interp
->framePtr
;
4598 if (newLevelPtr
) *newLevelPtr
= (*newLevelPtr
)-level
;
4600 framePtr
= framePtr
->parentCallFrame
;
4601 if (framePtr
== NULL
) goto badlevel
;
4603 *framePtrPtr
= framePtr
;
4606 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4607 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4608 "bad level \"", str
, "\"", NULL
);
4612 /* Similar to Jim_GetCallFrameByLevel() but the level is specified
4613 * as a relative integer like in the [info level ?level?] command. */
4614 static int JimGetCallFrameByInteger(Jim_Interp
*interp
, Jim_Obj
*levelObjPtr
,
4615 Jim_CallFrame
**framePtrPtr
)
4618 jim_wide relLevel
; /* level relative to the current one. */
4619 Jim_CallFrame
*framePtr
;
4621 if (Jim_GetWide(interp
, levelObjPtr
, &level
) != JIM_OK
)
4624 /* An 'absolute' level is converted into the
4625 * 'number of levels to go back' format. */
4626 relLevel
= interp
->numLevels
- level
;
4631 framePtr
= interp
->framePtr
;
4632 while (relLevel
--) {
4633 framePtr
= framePtr
->parentCallFrame
;
4634 if (framePtr
== NULL
) goto badlevel
;
4636 *framePtrPtr
= framePtr
;
4639 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4640 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4641 "bad level \"", Jim_GetString(levelObjPtr
, NULL
), "\"", NULL
);
4645 static void JimSetErrorFileName(Jim_Interp
*interp
, char *filename
)
4647 Jim_Free((void*)interp
->errorFileName
);
4648 interp
->errorFileName
= Jim_StrDup(filename
);
4651 static void JimSetErrorLineNumber(Jim_Interp
*interp
, int linenr
)
4653 interp
->errorLine
= linenr
;
4656 static void JimResetStackTrace(Jim_Interp
*interp
)
4658 Jim_DecrRefCount(interp
, interp
->stackTrace
);
4659 interp
->stackTrace
= Jim_NewListObj(interp
, NULL
, 0);
4660 Jim_IncrRefCount(interp
->stackTrace
);
4663 static void JimAppendStackTrace(Jim_Interp
*interp
, const char *procname
,
4664 const char *filename
, int linenr
)
4666 /* No need to add this dummy entry to the stack trace */
4667 if (strcmp(procname
, "unknown") == 0) {
4671 if (Jim_IsShared(interp
->stackTrace
)) {
4672 interp
->stackTrace
=
4673 Jim_DuplicateObj(interp
, interp
->stackTrace
);
4674 Jim_IncrRefCount(interp
->stackTrace
);
4676 Jim_ListAppendElement(interp
, interp
->stackTrace
,
4677 Jim_NewStringObj(interp
, procname
, -1));
4678 Jim_ListAppendElement(interp
, interp
->stackTrace
,
4679 Jim_NewStringObj(interp
, filename
, -1));
4680 Jim_ListAppendElement(interp
, interp
->stackTrace
,
4681 Jim_NewIntObj(interp
, linenr
));
4684 int Jim_SetAssocData(Jim_Interp
*interp
, const char *key
, Jim_InterpDeleteProc
*delProc
, void *data
)
4686 AssocDataValue
*assocEntryPtr
= (AssocDataValue
*)Jim_Alloc(sizeof(AssocDataValue
));
4687 assocEntryPtr
->delProc
= delProc
;
4688 assocEntryPtr
->data
= data
;
4689 return Jim_AddHashEntry(&interp
->assocData
, key
, assocEntryPtr
);
4692 void *Jim_GetAssocData(Jim_Interp
*interp
, const char *key
)
4694 Jim_HashEntry
*entryPtr
= Jim_FindHashEntry(&interp
->assocData
, key
);
4695 if (entryPtr
!= NULL
) {
4696 AssocDataValue
*assocEntryPtr
= (AssocDataValue
*)entryPtr
->val
;
4697 return assocEntryPtr
->data
;
4702 int Jim_DeleteAssocData(Jim_Interp
*interp
, const char *key
)
4704 return Jim_DeleteHashEntry(&interp
->assocData
, key
);
4707 int Jim_GetExitCode(Jim_Interp
*interp
) {
4708 return interp
->exitCode
;
4711 void *Jim_SetStdin(Jim_Interp
*interp
, void *fp
)
4713 if (fp
!= NULL
) interp
->cookie_stdin
= fp
;
4714 return interp
->cookie_stdin
;
4717 void *Jim_SetStdout(Jim_Interp
*interp
, void *fp
)
4719 if (fp
!= NULL
) interp
->cookie_stdout
= fp
;
4720 return interp
->cookie_stdout
;
4723 void *Jim_SetStderr(Jim_Interp
*interp
, void *fp
)
4725 if (fp
!= NULL
) interp
->cookie_stderr
= fp
;
4726 return interp
->cookie_stderr
;
4729 /* -----------------------------------------------------------------------------
4731 * Every interpreter has an hash table where to put shared dynamically
4732 * allocate strings that are likely to be used a lot of times.
4733 * For example, in the 'source' object type, there is a pointer to
4734 * the filename associated with that object. Every script has a lot
4735 * of this objects with the identical file name, so it is wise to share
4738 * The API is trivial: Jim_GetSharedString(interp, "foobar")
4739 * returns the pointer to the shared string. Every time a reference
4740 * to the string is no longer used, the user should call
4741 * Jim_ReleaseSharedString(interp, stringPointer). Once no one is using
4742 * a given string, it is removed from the hash table.
4743 * ---------------------------------------------------------------------------*/
4744 const char *Jim_GetSharedString(Jim_Interp
*interp
, const char *str
)
4746 Jim_HashEntry
*he
= Jim_FindHashEntry(&interp
->sharedStrings
, str
);
4749 char *strCopy
= Jim_StrDup(str
);
4751 Jim_AddHashEntry(&interp
->sharedStrings
, strCopy
, (void*)1);
4754 long refCount
= (long) he
->val
;
4757 he
->val
= (void*) refCount
;
4762 void Jim_ReleaseSharedString(Jim_Interp
*interp
, const char *str
)
4765 Jim_HashEntry
*he
= Jim_FindHashEntry(&interp
->sharedStrings
, str
);
4768 Jim_Panic(interp
,"Jim_ReleaseSharedString called with "
4769 "unknown shared string '%s'", str
);
4770 refCount
= (long) he
->val
;
4772 if (refCount
== 0) {
4773 Jim_DeleteHashEntry(&interp
->sharedStrings
, str
);
4775 he
->val
= (void*) refCount
;
4779 /* -----------------------------------------------------------------------------
4781 * ---------------------------------------------------------------------------*/
4782 #define JIM_INTEGER_SPACE 24
4784 static void UpdateStringOfInt(struct Jim_Obj
*objPtr
);
4785 static int SetIntFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
, int flags
);
4787 static Jim_ObjType intObjType
= {
4795 void UpdateStringOfInt(struct Jim_Obj
*objPtr
)
4798 char buf
[JIM_INTEGER_SPACE
+1];
4800 len
= Jim_WideToString(buf
, objPtr
->internalRep
.wideValue
);
4801 objPtr
->bytes
= Jim_Alloc(len
+1);
4802 memcpy(objPtr
->bytes
, buf
, len
+1);
4803 objPtr
->length
= len
;
4806 int SetIntFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
, int flags
)
4811 /* Get the string representation */
4812 str
= Jim_GetString(objPtr
, NULL
);
4813 /* Try to convert into a jim_wide */
4814 if (Jim_StringToWide(str
, &wideValue
, 0) != JIM_OK
) {
4815 if (flags
& JIM_ERRMSG
) {
4816 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4817 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4818 "expected integer but got \"", str
, "\"", NULL
);
4822 if ((wideValue
== JIM_WIDE_MIN
|| wideValue
== JIM_WIDE_MAX
) &&
4824 Jim_SetResultString(interp
,
4825 "Integer value too big to be represented", -1);
4828 /* Free the old internal repr and set the new one. */
4829 Jim_FreeIntRep(interp
, objPtr
);
4830 objPtr
->typePtr
= &intObjType
;
4831 objPtr
->internalRep
.wideValue
= wideValue
;
4835 int Jim_GetWide(Jim_Interp
*interp
, Jim_Obj
*objPtr
, jim_wide
*widePtr
)
4837 if (objPtr
->typePtr
!= &intObjType
&&
4838 SetIntFromAny(interp
, objPtr
, JIM_ERRMSG
) == JIM_ERR
)
4840 *widePtr
= objPtr
->internalRep
.wideValue
;
4844 /* Get a wide but does not set an error if the format is bad. */
4845 static int JimGetWideNoErr(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
4848 if (objPtr
->typePtr
!= &intObjType
&&
4849 SetIntFromAny(interp
, objPtr
, JIM_NONE
) == JIM_ERR
)
4851 *widePtr
= objPtr
->internalRep
.wideValue
;
4855 int Jim_GetLong(Jim_Interp
*interp
, Jim_Obj
*objPtr
, long *longPtr
)
4860 retval
= Jim_GetWide(interp
, objPtr
, &wideValue
);
4861 if (retval
== JIM_OK
) {
4862 *longPtr
= (long) wideValue
;
4868 void Jim_SetWide(Jim_Interp
*interp
, Jim_Obj
*objPtr
, jim_wide wideValue
)
4870 if (Jim_IsShared(objPtr
))
4871 Jim_Panic(interp
,"Jim_SetWide called with shared object");
4872 if (objPtr
->typePtr
!= &intObjType
) {
4873 Jim_FreeIntRep(interp
, objPtr
);
4874 objPtr
->typePtr
= &intObjType
;
4876 Jim_InvalidateStringRep(objPtr
);
4877 objPtr
->internalRep
.wideValue
= wideValue
;
4880 Jim_Obj
*Jim_NewIntObj(Jim_Interp
*interp
, jim_wide wideValue
)
4884 objPtr
= Jim_NewObj(interp
);
4885 objPtr
->typePtr
= &intObjType
;
4886 objPtr
->bytes
= NULL
;
4887 objPtr
->internalRep
.wideValue
= wideValue
;
4891 /* -----------------------------------------------------------------------------
4893 * ---------------------------------------------------------------------------*/
4894 #define JIM_DOUBLE_SPACE 30
4896 static void UpdateStringOfDouble(struct Jim_Obj
*objPtr
);
4897 static int SetDoubleFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
4899 static Jim_ObjType doubleObjType
= {
4903 UpdateStringOfDouble
,
4907 void UpdateStringOfDouble(struct Jim_Obj
*objPtr
)
4910 char buf
[JIM_DOUBLE_SPACE
+1];
4912 len
= Jim_DoubleToString(buf
, objPtr
->internalRep
.doubleValue
);
4913 objPtr
->bytes
= Jim_Alloc(len
+1);
4914 memcpy(objPtr
->bytes
, buf
, len
+1);
4915 objPtr
->length
= len
;
4918 int SetDoubleFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
4923 /* Get the string representation */
4924 str
= Jim_GetString(objPtr
, NULL
);
4925 /* Try to convert into a double */
4926 if (Jim_StringToDouble(str
, &doubleValue
) != JIM_OK
) {
4927 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
4928 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
4929 "expected number but got '", str
, "'", NULL
);
4932 /* Free the old internal repr and set the new one. */
4933 Jim_FreeIntRep(interp
, objPtr
);
4934 objPtr
->typePtr
= &doubleObjType
;
4935 objPtr
->internalRep
.doubleValue
= doubleValue
;
4939 int Jim_GetDouble(Jim_Interp
*interp
, Jim_Obj
*objPtr
, double *doublePtr
)
4941 if (objPtr
->typePtr
!= &doubleObjType
&&
4942 SetDoubleFromAny(interp
, objPtr
) == JIM_ERR
)
4944 *doublePtr
= objPtr
->internalRep
.doubleValue
;
4948 void Jim_SetDouble(Jim_Interp
*interp
, Jim_Obj
*objPtr
, double doubleValue
)
4950 if (Jim_IsShared(objPtr
))
4951 Jim_Panic(interp
,"Jim_SetDouble called with shared object");
4952 if (objPtr
->typePtr
!= &doubleObjType
) {
4953 Jim_FreeIntRep(interp
, objPtr
);
4954 objPtr
->typePtr
= &doubleObjType
;
4956 Jim_InvalidateStringRep(objPtr
);
4957 objPtr
->internalRep
.doubleValue
= doubleValue
;
4960 Jim_Obj
*Jim_NewDoubleObj(Jim_Interp
*interp
, double doubleValue
)
4964 objPtr
= Jim_NewObj(interp
);
4965 objPtr
->typePtr
= &doubleObjType
;
4966 objPtr
->bytes
= NULL
;
4967 objPtr
->internalRep
.doubleValue
= doubleValue
;
4971 /* -----------------------------------------------------------------------------
4973 * ---------------------------------------------------------------------------*/
4974 static void ListAppendElement(Jim_Obj
*listPtr
, Jim_Obj
*objPtr
);
4975 static void FreeListInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
4976 static void DupListInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
);
4977 static void UpdateStringOfList(struct Jim_Obj
*objPtr
);
4978 static int SetListFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
);
4980 /* Note that while the elements of the list may contain references,
4981 * the list object itself can't. This basically means that the
4982 * list object string representation as a whole can't contain references
4983 * that are not presents in the single elements. */
4984 static Jim_ObjType listObjType
= {
4986 FreeListInternalRep
,
4992 void FreeListInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
4996 for (i
= 0; i
< objPtr
->internalRep
.listValue
.len
; i
++) {
4997 Jim_DecrRefCount(interp
, objPtr
->internalRep
.listValue
.ele
[i
]);
4999 Jim_Free(objPtr
->internalRep
.listValue
.ele
);
5002 void DupListInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
)
5005 JIM_NOTUSED(interp
);
5007 dupPtr
->internalRep
.listValue
.len
= srcPtr
->internalRep
.listValue
.len
;
5008 dupPtr
->internalRep
.listValue
.maxLen
= srcPtr
->internalRep
.listValue
.maxLen
;
5009 dupPtr
->internalRep
.listValue
.ele
=
5010 Jim_Alloc(sizeof(Jim_Obj
*)*srcPtr
->internalRep
.listValue
.maxLen
);
5011 memcpy(dupPtr
->internalRep
.listValue
.ele
, srcPtr
->internalRep
.listValue
.ele
,
5012 sizeof(Jim_Obj
*)*srcPtr
->internalRep
.listValue
.len
);
5013 for (i
= 0; i
< dupPtr
->internalRep
.listValue
.len
; i
++) {
5014 Jim_IncrRefCount(dupPtr
->internalRep
.listValue
.ele
[i
]);
5016 dupPtr
->typePtr
= &listObjType
;
5019 /* The following function checks if a given string can be encoded
5020 * into a list element without any kind of quoting, surrounded by braces,
5021 * or using escapes to quote. */
5022 #define JIM_ELESTR_SIMPLE 0
5023 #define JIM_ELESTR_BRACE 1
5024 #define JIM_ELESTR_QUOTE 2
5025 static int ListElementQuotingType(const char *s
, int len
)
5027 int i
, level
, trySimple
= 1;
5029 /* Try with the SIMPLE case */
5030 if (len
== 0) return JIM_ELESTR_BRACE
;
5031 if (s
[0] == '"' || s
[0] == '{') {
5035 for (i
= 0; i
< len
; i
++) {
5055 return JIM_ELESTR_SIMPLE
;
5058 /* Test if it's possible to do with braces */
5059 if (s
[len
-1] == '\\' ||
5060 s
[len
-1] == ']') return JIM_ELESTR_QUOTE
;
5062 for (i
= 0; i
< len
; i
++) {
5064 case '{': level
++; break;
5066 if (level
< 0) return JIM_ELESTR_QUOTE
;
5070 return JIM_ELESTR_QUOTE
;
5072 if (s
[i
+1] != '\0') i
++;
5077 if (!trySimple
) return JIM_ELESTR_BRACE
;
5078 for (i
= 0; i
< len
; i
++) {
5092 return JIM_ELESTR_BRACE
;
5096 return JIM_ELESTR_SIMPLE
;
5098 return JIM_ELESTR_QUOTE
;
5101 /* Returns the malloc-ed representation of a string
5102 * using backslash to quote special chars. */
5103 char *BackslashQuoteString(const char *s
, int len
, int *qlenPtr
)
5105 char *q
= Jim_Alloc(len
*2+1), *p
;
5122 case '\n': *p
++ = '\\'; *p
++ = 'n'; s
++; break;
5123 case '\r': *p
++ = '\\'; *p
++ = 'r'; s
++; break;
5124 case '\t': *p
++ = '\\'; *p
++ = 't'; s
++; break;
5125 case '\f': *p
++ = '\\'; *p
++ = 'f'; s
++; break;
5126 case '\v': *p
++ = '\\'; *p
++ = 'v'; s
++; break;
5137 void UpdateStringOfList(struct Jim_Obj
*objPtr
)
5139 int i
, bufLen
, realLength
;
5143 Jim_Obj
**ele
= objPtr
->internalRep
.listValue
.ele
;
5145 /* (Over) Estimate the space needed. */
5146 quotingType
= Jim_Alloc(sizeof(int)*objPtr
->internalRep
.listValue
.len
+1);
5148 for (i
= 0; i
< objPtr
->internalRep
.listValue
.len
; i
++) {
5151 strRep
= Jim_GetString(ele
[i
], &len
);
5152 quotingType
[i
] = ListElementQuotingType(strRep
, len
);
5153 switch (quotingType
[i
]) {
5154 case JIM_ELESTR_SIMPLE
: bufLen
+= len
; break;
5155 case JIM_ELESTR_BRACE
: bufLen
+= len
+2; break;
5156 case JIM_ELESTR_QUOTE
: bufLen
+= len
*2; break;
5158 bufLen
++; /* elements separator. */
5162 /* Generate the string rep. */
5163 p
= objPtr
->bytes
= Jim_Alloc(bufLen
+1);
5165 for (i
= 0; i
< objPtr
->internalRep
.listValue
.len
; i
++) {
5167 const char *strRep
= Jim_GetString(ele
[i
], &len
);
5170 switch(quotingType
[i
]) {
5171 case JIM_ELESTR_SIMPLE
:
5172 memcpy(p
, strRep
, len
);
5176 case JIM_ELESTR_BRACE
:
5178 memcpy(p
, strRep
, len
);
5181 realLength
+= len
+2;
5183 case JIM_ELESTR_QUOTE
:
5184 q
= BackslashQuoteString(strRep
, len
, &qlen
);
5191 /* Add a separating space */
5192 if (i
+1 != objPtr
->internalRep
.listValue
.len
) {
5197 *p
= '\0'; /* nul term. */
5198 objPtr
->length
= realLength
;
5199 Jim_Free(quotingType
);
5202 int SetListFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
)
5204 struct JimParserCtx parser
;
5208 /* Get the string representation */
5209 str
= Jim_GetString(objPtr
, &strLen
);
5211 /* Free the old internal repr just now and initialize the
5212 * new one just now. The string->list conversion can't fail. */
5213 Jim_FreeIntRep(interp
, objPtr
);
5214 objPtr
->typePtr
= &listObjType
;
5215 objPtr
->internalRep
.listValue
.len
= 0;
5216 objPtr
->internalRep
.listValue
.maxLen
= 0;
5217 objPtr
->internalRep
.listValue
.ele
= NULL
;
5219 /* Convert into a list */
5220 JimParserInit(&parser
, str
, strLen
, 1);
5221 while(!JimParserEof(&parser
)) {
5224 Jim_Obj
*elementPtr
;
5226 JimParseList(&parser
);
5227 if (JimParserTtype(&parser
) != JIM_TT_STR
&&
5228 JimParserTtype(&parser
) != JIM_TT_ESC
)
5230 token
= JimParserGetToken(&parser
, &tokenLen
, &type
, NULL
);
5231 elementPtr
= Jim_NewStringObjNoAlloc(interp
, token
, tokenLen
);
5232 ListAppendElement(objPtr
, elementPtr
);
5237 Jim_Obj
*Jim_NewListObj(Jim_Interp
*interp
, Jim_Obj
*const *elements
,
5243 objPtr
= Jim_NewObj(interp
);
5244 objPtr
->typePtr
= &listObjType
;
5245 objPtr
->bytes
= NULL
;
5246 objPtr
->internalRep
.listValue
.ele
= NULL
;
5247 objPtr
->internalRep
.listValue
.len
= 0;
5248 objPtr
->internalRep
.listValue
.maxLen
= 0;
5249 for (i
= 0; i
< len
; i
++) {
5250 ListAppendElement(objPtr
, elements
[i
]);
5255 /* Return a vector of Jim_Obj with the elements of a Jim list, and the
5256 * length of the vector. Note that the user of this function should make
5257 * sure that the list object can't shimmer while the vector returned
5258 * is in use, this vector is the one stored inside the internal representation
5259 * of the list object. This function is not exported, extensions should
5260 * always access to the List object elements using Jim_ListIndex(). */
5261 static void JimListGetElements(Jim_Interp
*interp
, Jim_Obj
*listObj
, int *argc
,
5264 Jim_ListLength(interp
, listObj
, argc
);
5265 assert(listObj
->typePtr
== &listObjType
);
5266 *listVec
= listObj
->internalRep
.listValue
.ele
;
5269 /* ListSortElements type values */
5270 enum {JIM_LSORT_ASCII
, JIM_LSORT_NOCASE
, JIM_LSORT_ASCII_DECR
,
5271 JIM_LSORT_NOCASE_DECR
};
5273 /* Sort the internal rep of a list. */
5274 static int ListSortString(Jim_Obj
**lhsObj
, Jim_Obj
**rhsObj
)
5276 return Jim_StringCompareObj(*lhsObj
, *rhsObj
, 0);
5279 static int ListSortStringDecr(Jim_Obj
**lhsObj
, Jim_Obj
**rhsObj
)
5281 return Jim_StringCompareObj(*lhsObj
, *rhsObj
, 0) * -1;
5284 static int ListSortStringNoCase(Jim_Obj
**lhsObj
, Jim_Obj
**rhsObj
)
5286 return Jim_StringCompareObj(*lhsObj
, *rhsObj
, 1);
5289 static int ListSortStringNoCaseDecr(Jim_Obj
**lhsObj
, Jim_Obj
**rhsObj
)
5291 return Jim_StringCompareObj(*lhsObj
, *rhsObj
, 1) * -1;
5294 /* Sort a list *in place*. MUST be called with non-shared objects. */
5295 static void ListSortElements(Jim_Interp
*interp
, Jim_Obj
*listObjPtr
, int type
)
5297 typedef int (qsort_comparator
)(const void *, const void *);
5298 int (*fn
)(Jim_Obj
**, Jim_Obj
**);
5302 if (Jim_IsShared(listObjPtr
))
5303 Jim_Panic(interp
,"Jim_ListSortElements called with shared object");
5304 if (listObjPtr
->typePtr
!= &listObjType
)
5305 SetListFromAny(interp
, listObjPtr
);
5307 vector
= listObjPtr
->internalRep
.listValue
.ele
;
5308 len
= listObjPtr
->internalRep
.listValue
.len
;
5310 case JIM_LSORT_ASCII
: fn
= ListSortString
; break;
5311 case JIM_LSORT_NOCASE
: fn
= ListSortStringNoCase
; break;
5312 case JIM_LSORT_ASCII_DECR
: fn
= ListSortStringDecr
; break;
5313 case JIM_LSORT_NOCASE_DECR
: fn
= ListSortStringNoCaseDecr
; break;
5315 fn
= NULL
; /* avoid warning */
5316 Jim_Panic(interp
,"ListSort called with invalid sort type");
5318 qsort(vector
, len
, sizeof(Jim_Obj
*), (qsort_comparator
*)fn
);
5319 Jim_InvalidateStringRep(listObjPtr
);
5322 /* This is the low-level function to append an element to a list.
5323 * The higher-level Jim_ListAppendElement() performs shared object
5324 * check and invalidate the string repr. This version is used
5325 * in the internals of the List Object and is not exported.
5327 * NOTE: this function can be called only against objects
5328 * with internal type of List. */
5329 void ListAppendElement(Jim_Obj
*listPtr
, Jim_Obj
*objPtr
)
5331 int requiredLen
= listPtr
->internalRep
.listValue
.len
+ 1;
5333 if (requiredLen
> listPtr
->internalRep
.listValue
.maxLen
) {
5334 int maxLen
= requiredLen
* 2;
5336 listPtr
->internalRep
.listValue
.ele
=
5337 Jim_Realloc(listPtr
->internalRep
.listValue
.ele
,
5338 sizeof(Jim_Obj
*)*maxLen
);
5339 listPtr
->internalRep
.listValue
.maxLen
= maxLen
;
5341 listPtr
->internalRep
.listValue
.ele
[listPtr
->internalRep
.listValue
.len
] =
5343 listPtr
->internalRep
.listValue
.len
++;
5344 Jim_IncrRefCount(objPtr
);
5347 /* This is the low-level function to insert elements into a list.
5348 * The higher-level Jim_ListInsertElements() performs shared object
5349 * check and invalidate the string repr. This version is used
5350 * in the internals of the List Object and is not exported.
5352 * NOTE: this function can be called only against objects
5353 * with internal type of List. */
5354 void ListInsertElements(Jim_Obj
*listPtr
, int index
, int elemc
,
5355 Jim_Obj
*const *elemVec
)
5357 int currentLen
= listPtr
->internalRep
.listValue
.len
;
5358 int requiredLen
= currentLen
+ elemc
;
5362 if (requiredLen
> listPtr
->internalRep
.listValue
.maxLen
) {
5363 int maxLen
= requiredLen
* 2;
5365 listPtr
->internalRep
.listValue
.ele
=
5366 Jim_Realloc(listPtr
->internalRep
.listValue
.ele
,
5367 sizeof(Jim_Obj
*)*maxLen
);
5368 listPtr
->internalRep
.listValue
.maxLen
= maxLen
;
5370 point
= listPtr
->internalRep
.listValue
.ele
+ index
;
5371 memmove(point
+elemc
, point
, (currentLen
-index
) * sizeof(Jim_Obj
*));
5372 for (i
=0; i
< elemc
; ++i
) {
5373 point
[i
] = elemVec
[i
];
5374 Jim_IncrRefCount(point
[i
]);
5376 listPtr
->internalRep
.listValue
.len
+= elemc
;
5379 /* Appends every element of appendListPtr into listPtr.
5380 * Both have to be of the list type. */
5381 void ListAppendList(Jim_Obj
*listPtr
, Jim_Obj
*appendListPtr
)
5383 int i
, oldLen
= listPtr
->internalRep
.listValue
.len
;
5384 int appendLen
= appendListPtr
->internalRep
.listValue
.len
;
5385 int requiredLen
= oldLen
+ appendLen
;
5387 if (requiredLen
> listPtr
->internalRep
.listValue
.maxLen
) {
5388 int maxLen
= requiredLen
* 2;
5390 listPtr
->internalRep
.listValue
.ele
=
5391 Jim_Realloc(listPtr
->internalRep
.listValue
.ele
,
5392 sizeof(Jim_Obj
*)*maxLen
);
5393 listPtr
->internalRep
.listValue
.maxLen
= maxLen
;
5395 for (i
= 0; i
< appendLen
; i
++) {
5396 Jim_Obj
*objPtr
= appendListPtr
->internalRep
.listValue
.ele
[i
];
5397 listPtr
->internalRep
.listValue
.ele
[oldLen
+i
] = objPtr
;
5398 Jim_IncrRefCount(objPtr
);
5400 listPtr
->internalRep
.listValue
.len
+= appendLen
;
5403 void Jim_ListAppendElement(Jim_Interp
*interp
, Jim_Obj
*listPtr
, Jim_Obj
*objPtr
)
5405 if (Jim_IsShared(listPtr
))
5406 Jim_Panic(interp
,"Jim_ListAppendElement called with shared object");
5407 if (listPtr
->typePtr
!= &listObjType
)
5408 SetListFromAny(interp
, listPtr
);
5409 Jim_InvalidateStringRep(listPtr
);
5410 ListAppendElement(listPtr
, objPtr
);
5413 void Jim_ListAppendList(Jim_Interp
*interp
, Jim_Obj
*listPtr
, Jim_Obj
*appendListPtr
)
5415 if (Jim_IsShared(listPtr
))
5416 Jim_Panic(interp
,"Jim_ListAppendList called with shared object");
5417 if (listPtr
->typePtr
!= &listObjType
)
5418 SetListFromAny(interp
, listPtr
);
5419 Jim_InvalidateStringRep(listPtr
);
5420 ListAppendList(listPtr
, appendListPtr
);
5423 void Jim_ListLength(Jim_Interp
*interp
, Jim_Obj
*listPtr
, int *intPtr
)
5425 if (listPtr
->typePtr
!= &listObjType
)
5426 SetListFromAny(interp
, listPtr
);
5427 *intPtr
= listPtr
->internalRep
.listValue
.len
;
5430 void Jim_ListInsertElements(Jim_Interp
*interp
, Jim_Obj
*listPtr
, int index
,
5431 int objc
, Jim_Obj
*const *objVec
)
5433 if (Jim_IsShared(listPtr
))
5434 Jim_Panic(interp
,"Jim_ListInsertElement called with shared object");
5435 if (listPtr
->typePtr
!= &listObjType
)
5436 SetListFromAny(interp
, listPtr
);
5437 if (index
>= 0 && index
> listPtr
->internalRep
.listValue
.len
)
5438 index
= listPtr
->internalRep
.listValue
.len
;
5439 else if (index
< 0 )
5441 Jim_InvalidateStringRep(listPtr
);
5442 ListInsertElements(listPtr
, index
, objc
, objVec
);
5445 int Jim_ListIndex(Jim_Interp
*interp
, Jim_Obj
*listPtr
, int index
,
5446 Jim_Obj
**objPtrPtr
, int flags
)
5448 if (listPtr
->typePtr
!= &listObjType
)
5449 SetListFromAny(interp
, listPtr
);
5450 if ((index
>= 0 && index
>= listPtr
->internalRep
.listValue
.len
) ||
5451 (index
< 0 && (-index
-1) >= listPtr
->internalRep
.listValue
.len
)) {
5452 if (flags
& JIM_ERRMSG
) {
5453 Jim_SetResultString(interp
,
5454 "list index out of range", -1);
5459 index
= listPtr
->internalRep
.listValue
.len
+index
;
5460 *objPtrPtr
= listPtr
->internalRep
.listValue
.ele
[index
];
5464 static int ListSetIndex(Jim_Interp
*interp
, Jim_Obj
*listPtr
, int index
,
5465 Jim_Obj
*newObjPtr
, int flags
)
5467 if (listPtr
->typePtr
!= &listObjType
)
5468 SetListFromAny(interp
, listPtr
);
5469 if ((index
>= 0 && index
>= listPtr
->internalRep
.listValue
.len
) ||
5470 (index
< 0 && (-index
-1) >= listPtr
->internalRep
.listValue
.len
)) {
5471 if (flags
& JIM_ERRMSG
) {
5472 Jim_SetResultString(interp
,
5473 "list index out of range", -1);
5478 index
= listPtr
->internalRep
.listValue
.len
+index
;
5479 Jim_DecrRefCount(interp
, listPtr
->internalRep
.listValue
.ele
[index
]);
5480 listPtr
->internalRep
.listValue
.ele
[index
] = newObjPtr
;
5481 Jim_IncrRefCount(newObjPtr
);
5485 /* Modify the list stored into the variable named 'varNamePtr'
5486 * setting the element specified by the 'indexc' indexes objects in 'indexv',
5487 * with the new element 'newObjptr'. */
5488 int Jim_SetListIndex(Jim_Interp
*interp
, Jim_Obj
*varNamePtr
,
5489 Jim_Obj
*const *indexv
, int indexc
, Jim_Obj
*newObjPtr
)
5491 Jim_Obj
*varObjPtr
, *objPtr
, *listObjPtr
;
5492 int shared
, i
, index
;
5494 varObjPtr
= objPtr
= Jim_GetVariable(interp
, varNamePtr
, JIM_ERRMSG
);
5497 if ((shared
= Jim_IsShared(objPtr
)))
5498 varObjPtr
= objPtr
= Jim_DuplicateObj(interp
, objPtr
);
5499 for (i
= 0; i
< indexc
-1; i
++) {
5500 listObjPtr
= objPtr
;
5501 if (Jim_GetIndex(interp
, indexv
[i
], &index
) != JIM_OK
)
5503 if (Jim_ListIndex(interp
, listObjPtr
, index
, &objPtr
,
5504 JIM_ERRMSG
) != JIM_OK
) {
5507 if (Jim_IsShared(objPtr
)) {
5508 objPtr
= Jim_DuplicateObj(interp
, objPtr
);
5509 ListSetIndex(interp
, listObjPtr
, index
, objPtr
, JIM_NONE
);
5511 Jim_InvalidateStringRep(listObjPtr
);
5513 if (Jim_GetIndex(interp
, indexv
[indexc
-1], &index
) != JIM_OK
)
5515 if (ListSetIndex(interp
, objPtr
, index
, newObjPtr
, JIM_ERRMSG
) == JIM_ERR
)
5517 Jim_InvalidateStringRep(objPtr
);
5518 Jim_InvalidateStringRep(varObjPtr
);
5519 if (Jim_SetVariable(interp
, varNamePtr
, varObjPtr
) != JIM_OK
)
5521 Jim_SetResult(interp
, varObjPtr
);
5525 Jim_FreeNewObj(interp
, varObjPtr
);
5530 Jim_Obj
*Jim_ConcatObj(Jim_Interp
*interp
, int objc
, Jim_Obj
*const *objv
)
5534 /* If all the objects in objv are lists without string rep.
5535 * it's possible to return a list as result, that's the
5536 * concatenation of all the lists. */
5537 for (i
= 0; i
< objc
; i
++) {
5538 if (objv
[i
]->typePtr
!= &listObjType
|| objv
[i
]->bytes
)
5542 Jim_Obj
*objPtr
= Jim_NewListObj(interp
, NULL
, 0);
5543 for (i
= 0; i
< objc
; i
++)
5544 Jim_ListAppendList(interp
, objPtr
, objv
[i
]);
5547 /* Else... we have to glue strings together */
5548 int len
= 0, objLen
;
5551 /* Compute the length */
5552 for (i
= 0; i
< objc
; i
++) {
5553 Jim_GetString(objv
[i
], &objLen
);
5556 if (objc
) len
+= objc
-1;
5557 /* Create the string rep, and a stinrg object holding it. */
5558 p
= bytes
= Jim_Alloc(len
+1);
5559 for (i
= 0; i
< objc
; i
++) {
5560 const char *s
= Jim_GetString(objv
[i
], &objLen
);
5561 while (objLen
&& (*s
== ' ' || *s
== '\t' || *s
== '\n'))
5563 s
++; objLen
--; len
--;
5565 while (objLen
&& (s
[objLen
-1] == ' ' ||
5566 s
[objLen
-1] == '\n' || s
[objLen
-1] == '\t')) {
5569 memcpy(p
, s
, objLen
);
5571 if (objLen
&& i
+1 != objc
) {
5573 } else if (i
+1 != objc
) {
5574 /* Drop the space calcuated for this
5575 * element that is instead null. */
5580 return Jim_NewStringObjNoAlloc(interp
, bytes
, len
);
5584 /* Returns a list composed of the elements in the specified range.
5585 * first and start are directly accepted as Jim_Objects and
5586 * processed for the end?-index? case. */
5587 Jim_Obj
*Jim_ListRange(Jim_Interp
*interp
, Jim_Obj
*listObjPtr
, Jim_Obj
*firstObjPtr
, Jim_Obj
*lastObjPtr
)
5592 if (Jim_GetIndex(interp
, firstObjPtr
, &first
) != JIM_OK
||
5593 Jim_GetIndex(interp
, lastObjPtr
, &last
) != JIM_OK
)
5595 Jim_ListLength(interp
, listObjPtr
, &len
); /* will convert into list */
5596 first
= JimRelToAbsIndex(len
, first
);
5597 last
= JimRelToAbsIndex(len
, last
);
5598 JimRelToAbsRange(len
, first
, last
, &first
, &last
, &rangeLen
);
5599 return Jim_NewListObj(interp
,
5600 listObjPtr
->internalRep
.listValue
.ele
+first
, rangeLen
);
5603 /* -----------------------------------------------------------------------------
5605 * ---------------------------------------------------------------------------*/
5606 static void FreeDictInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
5607 static void DupDictInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
);
5608 static void UpdateStringOfDict(struct Jim_Obj
*objPtr
);
5609 static int SetDictFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
);
5611 /* Dict HashTable Type.
5613 * Keys and Values are Jim objects. */
5615 unsigned int JimObjectHTHashFunction(const void *key
)
5618 Jim_Obj
*objPtr
= (Jim_Obj
*) key
;
5621 str
= Jim_GetString(objPtr
, &len
);
5622 h
= Jim_GenHashFunction((unsigned char*)str
, len
);
5626 int JimObjectHTKeyCompare(void *privdata
, const void *key1
, const void *key2
)
5628 JIM_NOTUSED(privdata
);
5630 return Jim_StringEqObj((Jim_Obj
*)key1
, (Jim_Obj
*)key2
, 0);
5633 static void JimObjectHTKeyValDestructor(void *interp
, void *val
)
5635 Jim_Obj
*objPtr
= val
;
5637 Jim_DecrRefCount(interp
, objPtr
);
5640 static Jim_HashTableType JimDictHashTableType
= {
5641 JimObjectHTHashFunction
, /* hash function */
5644 JimObjectHTKeyCompare
, /* key compare */
5645 (void(*)(void*, const void*)) /* ATTENTION: const cast */
5646 JimObjectHTKeyValDestructor
, /* key destructor */
5647 JimObjectHTKeyValDestructor
/* val destructor */
5650 /* Note that while the elements of the dict may contain references,
5651 * the list object itself can't. This basically means that the
5652 * dict object string representation as a whole can't contain references
5653 * that are not presents in the single elements. */
5654 static Jim_ObjType dictObjType
= {
5656 FreeDictInternalRep
,
5662 void FreeDictInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
5664 JIM_NOTUSED(interp
);
5666 Jim_FreeHashTable(objPtr
->internalRep
.ptr
);
5667 Jim_Free(objPtr
->internalRep
.ptr
);
5670 void DupDictInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
)
5672 Jim_HashTable
*ht
, *dupHt
;
5673 Jim_HashTableIterator
*htiter
;
5676 /* Create a new hash table */
5677 ht
= srcPtr
->internalRep
.ptr
;
5678 dupHt
= Jim_Alloc(sizeof(*dupHt
));
5679 Jim_InitHashTable(dupHt
, &JimDictHashTableType
, interp
);
5681 Jim_ExpandHashTable(dupHt
, ht
->size
);
5682 /* Copy every element from the source to the dup hash table */
5683 htiter
= Jim_GetHashTableIterator(ht
);
5684 while ((he
= Jim_NextHashEntry(htiter
)) != NULL
) {
5685 const Jim_Obj
*keyObjPtr
= he
->key
;
5686 Jim_Obj
*valObjPtr
= he
->val
;
5688 Jim_IncrRefCount((Jim_Obj
*)keyObjPtr
); /* ATTENTION: const cast */
5689 Jim_IncrRefCount(valObjPtr
);
5690 Jim_AddHashEntry(dupHt
, keyObjPtr
, valObjPtr
);
5692 Jim_FreeHashTableIterator(htiter
);
5694 dupPtr
->internalRep
.ptr
= dupHt
;
5695 dupPtr
->typePtr
= &dictObjType
;
5698 void UpdateStringOfDict(struct Jim_Obj
*objPtr
)
5700 int i
, bufLen
, realLength
;
5703 int *quotingType
, objc
;
5705 Jim_HashTableIterator
*htiter
;
5709 /* Trun the hash table into a flat vector of Jim_Objects. */
5710 ht
= objPtr
->internalRep
.ptr
;
5712 objv
= Jim_Alloc(objc
*sizeof(Jim_Obj
*));
5713 htiter
= Jim_GetHashTableIterator(ht
);
5715 while ((he
= Jim_NextHashEntry(htiter
)) != NULL
) {
5716 objv
[i
++] = (Jim_Obj
*)he
->key
; /* ATTENTION: const cast */
5717 objv
[i
++] = he
->val
;
5719 Jim_FreeHashTableIterator(htiter
);
5720 /* (Over) Estimate the space needed. */
5721 quotingType
= Jim_Alloc(sizeof(int)*objc
);
5723 for (i
= 0; i
< objc
; i
++) {
5726 strRep
= Jim_GetString(objv
[i
], &len
);
5727 quotingType
[i
] = ListElementQuotingType(strRep
, len
);
5728 switch (quotingType
[i
]) {
5729 case JIM_ELESTR_SIMPLE
: bufLen
+= len
; break;
5730 case JIM_ELESTR_BRACE
: bufLen
+= len
+2; break;
5731 case JIM_ELESTR_QUOTE
: bufLen
+= len
*2; break;
5733 bufLen
++; /* elements separator. */
5737 /* Generate the string rep. */
5738 p
= objPtr
->bytes
= Jim_Alloc(bufLen
+1);
5740 for (i
= 0; i
< objc
; i
++) {
5742 const char *strRep
= Jim_GetString(objv
[i
], &len
);
5745 switch(quotingType
[i
]) {
5746 case JIM_ELESTR_SIMPLE
:
5747 memcpy(p
, strRep
, len
);
5751 case JIM_ELESTR_BRACE
:
5753 memcpy(p
, strRep
, len
);
5756 realLength
+= len
+2;
5758 case JIM_ELESTR_QUOTE
:
5759 q
= BackslashQuoteString(strRep
, len
, &qlen
);
5766 /* Add a separating space */
5772 *p
= '\0'; /* nul term. */
5773 objPtr
->length
= realLength
;
5774 Jim_Free(quotingType
);
5778 int SetDictFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
)
5780 struct JimParserCtx parser
;
5786 /* Get the string representation */
5787 str
= Jim_GetString(objPtr
, &strLen
);
5789 /* Free the old internal repr just now and initialize the
5790 * new one just now. The string->list conversion can't fail. */
5791 Jim_FreeIntRep(interp
, objPtr
);
5792 ht
= Jim_Alloc(sizeof(*ht
));
5793 Jim_InitHashTable(ht
, &JimDictHashTableType
, interp
);
5794 objPtr
->typePtr
= &dictObjType
;
5795 objPtr
->internalRep
.ptr
= ht
;
5797 /* Convert into a dict */
5798 JimParserInit(&parser
, str
, strLen
, 1);
5800 while(!JimParserEof(&parser
)) {
5804 JimParseList(&parser
);
5805 if (JimParserTtype(&parser
) != JIM_TT_STR
&&
5806 JimParserTtype(&parser
) != JIM_TT_ESC
)
5808 token
= JimParserGetToken(&parser
, &tokenLen
, &type
, NULL
);
5809 objv
[i
++] = Jim_NewStringObjNoAlloc(interp
, token
, tokenLen
);
5812 Jim_IncrRefCount(objv
[0]);
5813 Jim_IncrRefCount(objv
[1]);
5814 if (Jim_AddHashEntry(ht
, objv
[0], objv
[1]) != JIM_OK
) {
5816 he
= Jim_FindHashEntry(ht
, objv
[0]);
5817 Jim_DecrRefCount(interp
, objv
[0]);
5818 /* ATTENTION: const cast */
5819 Jim_DecrRefCount(interp
, (Jim_Obj
*)he
->val
);
5825 Jim_FreeNewObj(interp
, objv
[0]);
5826 objPtr
->typePtr
= NULL
;
5827 Jim_FreeHashTable(ht
);
5828 Jim_SetResultString(interp
, "invalid dictionary value: must be a list with an even number of elements", -1);
5834 /* Dict object API */
5836 /* Add an element to a dict. objPtr must be of the "dict" type.
5837 * The higer-level exported function is Jim_DictAddElement().
5838 * If an element with the specified key already exists, the value
5839 * associated is replaced with the new one.
5841 * if valueObjPtr == NULL, the key is instead removed if it exists. */
5842 static void DictAddElement(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
5843 Jim_Obj
*keyObjPtr
, Jim_Obj
*valueObjPtr
)
5845 Jim_HashTable
*ht
= objPtr
->internalRep
.ptr
;
5847 if (valueObjPtr
== NULL
) { /* unset */
5848 Jim_DeleteHashEntry(ht
, keyObjPtr
);
5851 Jim_IncrRefCount(keyObjPtr
);
5852 Jim_IncrRefCount(valueObjPtr
);
5853 if (Jim_AddHashEntry(ht
, keyObjPtr
, valueObjPtr
) != JIM_OK
) {
5854 Jim_HashEntry
*he
= Jim_FindHashEntry(ht
, keyObjPtr
);
5855 Jim_DecrRefCount(interp
, keyObjPtr
);
5856 /* ATTENTION: const cast */
5857 Jim_DecrRefCount(interp
, (Jim_Obj
*)he
->val
);
5858 he
->val
= valueObjPtr
;
5862 /* Add an element, higher-level interface for DictAddElement().
5863 * If valueObjPtr == NULL, the key is removed if it exists. */
5864 int Jim_DictAddElement(Jim_Interp
*interp
, Jim_Obj
*objPtr
,
5865 Jim_Obj
*keyObjPtr
, Jim_Obj
*valueObjPtr
)
5867 if (Jim_IsShared(objPtr
))
5868 Jim_Panic(interp
,"Jim_DictAddElement called with shared object");
5869 if (objPtr
->typePtr
!= &dictObjType
) {
5870 if (SetDictFromAny(interp
, objPtr
) != JIM_OK
)
5873 DictAddElement(interp
, objPtr
, keyObjPtr
, valueObjPtr
);
5874 Jim_InvalidateStringRep(objPtr
);
5878 Jim_Obj
*Jim_NewDictObj(Jim_Interp
*interp
, Jim_Obj
*const *elements
, int len
)
5884 Jim_Panic(interp
,"Jim_NewDicObj() 'len' argument must be even");
5886 objPtr
= Jim_NewObj(interp
);
5887 objPtr
->typePtr
= &dictObjType
;
5888 objPtr
->bytes
= NULL
;
5889 objPtr
->internalRep
.ptr
= Jim_Alloc(sizeof(Jim_HashTable
));
5890 Jim_InitHashTable(objPtr
->internalRep
.ptr
, &JimDictHashTableType
, interp
);
5891 for (i
= 0; i
< len
; i
+= 2)
5892 DictAddElement(interp
, objPtr
, elements
[i
], elements
[i
+1]);
5896 /* Return the value associated to the specified dict key */
5897 int Jim_DictKey(Jim_Interp
*interp
, Jim_Obj
*dictPtr
, Jim_Obj
*keyPtr
,
5898 Jim_Obj
**objPtrPtr
, int flags
)
5903 if (dictPtr
->typePtr
!= &dictObjType
) {
5904 if (SetDictFromAny(interp
, dictPtr
) != JIM_OK
)
5907 ht
= dictPtr
->internalRep
.ptr
;
5908 if ((he
= Jim_FindHashEntry(ht
, keyPtr
)) == NULL
) {
5909 if (flags
& JIM_ERRMSG
) {
5910 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
5911 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
5912 "key \"", Jim_GetString(keyPtr
, NULL
),
5913 "\" not found in dictionary", NULL
);
5917 *objPtrPtr
= he
->val
;
5921 /* Return the value associated to the specified dict keys */
5922 int Jim_DictKeysVector(Jim_Interp
*interp
, Jim_Obj
*dictPtr
,
5923 Jim_Obj
*const *keyv
, int keyc
, Jim_Obj
**objPtrPtr
, int flags
)
5929 *objPtrPtr
= dictPtr
;
5933 for (i
= 0; i
< keyc
; i
++) {
5934 if (Jim_DictKey(interp
, dictPtr
, keyv
[i
], &objPtr
, flags
)
5939 *objPtrPtr
= objPtr
;
5943 /* Modify the dict stored into the variable named 'varNamePtr'
5944 * setting the element specified by the 'keyc' keys objects in 'keyv',
5945 * with the new value of the element 'newObjPtr'.
5947 * If newObjPtr == NULL the operation is to remove the given key
5948 * from the dictionary. */
5949 int Jim_SetDictKeysVector(Jim_Interp
*interp
, Jim_Obj
*varNamePtr
,
5950 Jim_Obj
*const *keyv
, int keyc
, Jim_Obj
*newObjPtr
)
5952 Jim_Obj
*varObjPtr
, *objPtr
, *dictObjPtr
;
5955 varObjPtr
= objPtr
= Jim_GetVariable(interp
, varNamePtr
, JIM_ERRMSG
);
5956 if (objPtr
== NULL
) {
5957 if (newObjPtr
== NULL
) /* Cannot remove a key from non existing var */
5959 varObjPtr
= objPtr
= Jim_NewDictObj(interp
, NULL
, 0);
5960 if (Jim_SetVariable(interp
, varNamePtr
, objPtr
) != JIM_OK
) {
5961 Jim_FreeNewObj(interp
, varObjPtr
);
5965 if ((shared
= Jim_IsShared(objPtr
)))
5966 varObjPtr
= objPtr
= Jim_DuplicateObj(interp
, objPtr
);
5967 for (i
= 0; i
< keyc
-1; i
++) {
5968 dictObjPtr
= objPtr
;
5970 /* Check if it's a valid dictionary */
5971 if (dictObjPtr
->typePtr
!= &dictObjType
) {
5972 if (SetDictFromAny(interp
, dictObjPtr
) != JIM_OK
)
5975 /* Check if the given key exists. */
5976 Jim_InvalidateStringRep(dictObjPtr
);
5977 if (Jim_DictKey(interp
, dictObjPtr
, keyv
[i
], &objPtr
,
5978 newObjPtr
? JIM_NONE
: JIM_ERRMSG
) == JIM_OK
)
5980 /* This key exists at the current level.
5981 * Make sure it's not shared!. */
5982 if (Jim_IsShared(objPtr
)) {
5983 objPtr
= Jim_DuplicateObj(interp
, objPtr
);
5984 DictAddElement(interp
, dictObjPtr
, keyv
[i
], objPtr
);
5987 /* Key not found. If it's an [unset] operation
5988 * this is an error. Only the last key may not
5990 if (newObjPtr
== NULL
)
5992 /* Otherwise set an empty dictionary
5993 * as key's value. */
5994 objPtr
= Jim_NewDictObj(interp
, NULL
, 0);
5995 DictAddElement(interp
, dictObjPtr
, keyv
[i
], objPtr
);
5998 if (Jim_DictAddElement(interp
, objPtr
, keyv
[keyc
-1], newObjPtr
)
6001 Jim_InvalidateStringRep(objPtr
);
6002 Jim_InvalidateStringRep(varObjPtr
);
6003 if (Jim_SetVariable(interp
, varNamePtr
, varObjPtr
) != JIM_OK
)
6005 Jim_SetResult(interp
, varObjPtr
);
6009 Jim_FreeNewObj(interp
, varObjPtr
);
6014 /* -----------------------------------------------------------------------------
6016 * ---------------------------------------------------------------------------*/
6017 static void UpdateStringOfIndex(struct Jim_Obj
*objPtr
);
6018 static int SetIndexFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
);
6020 static Jim_ObjType indexObjType
= {
6024 UpdateStringOfIndex
,
6028 void UpdateStringOfIndex(struct Jim_Obj
*objPtr
)
6031 char buf
[JIM_INTEGER_SPACE
+1];
6033 if (objPtr
->internalRep
.indexValue
>= 0)
6034 len
= sprintf(buf
, "%d", objPtr
->internalRep
.indexValue
);
6035 else if (objPtr
->internalRep
.indexValue
== -1)
6036 len
= sprintf(buf
, "end");
6038 len
= sprintf(buf
, "end%d", objPtr
->internalRep
.indexValue
+1);
6040 objPtr
->bytes
= Jim_Alloc(len
+1);
6041 memcpy(objPtr
->bytes
, buf
, len
+1);
6042 objPtr
->length
= len
;
6045 int SetIndexFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
6050 /* Get the string representation */
6051 str
= Jim_GetString(objPtr
, NULL
);
6052 /* Try to convert into an index */
6053 if (!strcmp(str
, "end")) {
6057 if (!strncmp(str
, "end-", 4)) {
6061 if (Jim_StringToIndex(str
, &index
) != JIM_OK
) {
6062 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
6063 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
6064 "bad index \"", Jim_GetString(objPtr
, NULL
), "\": "
6065 "must be integer or end?-integer?", NULL
);
6074 } else if (!end
&& index
< 0)
6076 /* Free the old internal repr and set the new one. */
6077 Jim_FreeIntRep(interp
, objPtr
);
6078 objPtr
->typePtr
= &indexObjType
;
6079 objPtr
->internalRep
.indexValue
= index
;
6083 int Jim_GetIndex(Jim_Interp
*interp
, Jim_Obj
*objPtr
, int *indexPtr
)
6085 /* Avoid shimmering if the object is an integer. */
6086 if (objPtr
->typePtr
== &intObjType
) {
6087 jim_wide val
= objPtr
->internalRep
.wideValue
;
6088 if (!(val
< LONG_MIN
) && !(val
> LONG_MAX
)) {
6089 *indexPtr
= (val
< 0) ? -INT_MAX
: (long)val
;;
6093 if (objPtr
->typePtr
!= &indexObjType
&&
6094 SetIndexFromAny(interp
, objPtr
) == JIM_ERR
)
6096 *indexPtr
= objPtr
->internalRep
.indexValue
;
6100 /* -----------------------------------------------------------------------------
6101 * Return Code Object.
6102 * ---------------------------------------------------------------------------*/
6104 static int SetReturnCodeFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
6106 static Jim_ObjType returnCodeObjType
= {
6114 int SetReturnCodeFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
6117 int strLen
, returnCode
;
6120 /* Get the string representation */
6121 str
= Jim_GetString(objPtr
, &strLen
);
6122 /* Try to convert into an integer */
6123 if (JimGetWideNoErr(interp
, objPtr
, &wideValue
) != JIM_ERR
)
6124 returnCode
= (int) wideValue
;
6125 else if (!JimStringCompare(str
, strLen
, "ok", 2, JIM_NOCASE
))
6126 returnCode
= JIM_OK
;
6127 else if (!JimStringCompare(str
, strLen
, "error", 5, JIM_NOCASE
))
6128 returnCode
= JIM_ERR
;
6129 else if (!JimStringCompare(str
, strLen
, "return", 6, JIM_NOCASE
))
6130 returnCode
= JIM_RETURN
;
6131 else if (!JimStringCompare(str
, strLen
, "break", 5, JIM_NOCASE
))
6132 returnCode
= JIM_BREAK
;
6133 else if (!JimStringCompare(str
, strLen
, "continue", 8, JIM_NOCASE
))
6134 returnCode
= JIM_CONTINUE
;
6135 else if (!JimStringCompare(str
, strLen
, "eval", 4, JIM_NOCASE
))
6136 returnCode
= JIM_EVAL
;
6137 else if (!JimStringCompare(str
, strLen
, "exit", 4, JIM_NOCASE
))
6138 returnCode
= JIM_EXIT
;
6140 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
6141 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
6142 "expected return code but got '", str
, "'",
6146 /* Free the old internal repr and set the new one. */
6147 Jim_FreeIntRep(interp
, objPtr
);
6148 objPtr
->typePtr
= &returnCodeObjType
;
6149 objPtr
->internalRep
.returnCode
= returnCode
;
6153 int Jim_GetReturnCode(Jim_Interp
*interp
, Jim_Obj
*objPtr
, int *intPtr
)
6155 if (objPtr
->typePtr
!= &returnCodeObjType
&&
6156 SetReturnCodeFromAny(interp
, objPtr
) == JIM_ERR
)
6158 *intPtr
= objPtr
->internalRep
.returnCode
;
6162 /* -----------------------------------------------------------------------------
6163 * Expression Parsing
6164 * ---------------------------------------------------------------------------*/
6165 static int JimParseExprOperator(struct JimParserCtx
*pc
);
6166 static int JimParseExprNumber(struct JimParserCtx
*pc
);
6167 static int JimParseExprIrrational(struct JimParserCtx
*pc
);
6169 /* Exrp's Stack machine operators opcodes. */
6171 /* Binary operators (numbers) */
6172 #define JIM_EXPROP_BINARY_NUM_FIRST 0 /* first */
6173 #define JIM_EXPROP_MUL 0
6174 #define JIM_EXPROP_DIV 1
6175 #define JIM_EXPROP_MOD 2
6176 #define JIM_EXPROP_SUB 3
6177 #define JIM_EXPROP_ADD 4
6178 #define JIM_EXPROP_LSHIFT 5
6179 #define JIM_EXPROP_RSHIFT 6
6180 #define JIM_EXPROP_ROTL 7
6181 #define JIM_EXPROP_ROTR 8
6182 #define JIM_EXPROP_LT 9
6183 #define JIM_EXPROP_GT 10
6184 #define JIM_EXPROP_LTE 11
6185 #define JIM_EXPROP_GTE 12
6186 #define JIM_EXPROP_NUMEQ 13
6187 #define JIM_EXPROP_NUMNE 14
6188 #define JIM_EXPROP_BITAND 15
6189 #define JIM_EXPROP_BITXOR 16
6190 #define JIM_EXPROP_BITOR 17
6191 #define JIM_EXPROP_LOGICAND 18
6192 #define JIM_EXPROP_LOGICOR 19
6193 #define JIM_EXPROP_LOGICAND_LEFT 20
6194 #define JIM_EXPROP_LOGICOR_LEFT 21
6195 #define JIM_EXPROP_POW 22
6196 #define JIM_EXPROP_BINARY_NUM_LAST 22 /* last */
6198 /* Binary operators (strings) */
6199 #define JIM_EXPROP_STREQ 23
6200 #define JIM_EXPROP_STRNE 24
6202 /* Unary operators (numbers) */
6203 #define JIM_EXPROP_NOT 25
6204 #define JIM_EXPROP_BITNOT 26
6205 #define JIM_EXPROP_UNARYMINUS 27
6206 #define JIM_EXPROP_UNARYPLUS 28
6207 #define JIM_EXPROP_LOGICAND_RIGHT 29
6208 #define JIM_EXPROP_LOGICOR_RIGHT 30
6210 /* Ternary operators */
6211 #define JIM_EXPROP_TERNARY 31
6214 #define JIM_EXPROP_NUMBER 32
6215 #define JIM_EXPROP_COMMAND 33
6216 #define JIM_EXPROP_VARIABLE 34
6217 #define JIM_EXPROP_DICTSUGAR 35
6218 #define JIM_EXPROP_SUBST 36
6219 #define JIM_EXPROP_STRING 37
6221 /* Operators table */
6222 typedef struct Jim_ExprOperator
{
6229 /* name - precedence - arity - opcode */
6230 static struct Jim_ExprOperator Jim_ExprOperators
[] = {
6231 {"!", 300, 1, JIM_EXPROP_NOT
},
6232 {"~", 300, 1, JIM_EXPROP_BITNOT
},
6233 {"unarymin", 300, 1, JIM_EXPROP_UNARYMINUS
},
6234 {"unaryplus", 300, 1, JIM_EXPROP_UNARYPLUS
},
6236 {"**", 250, 2, JIM_EXPROP_POW
},
6238 {"*", 200, 2, JIM_EXPROP_MUL
},
6239 {"/", 200, 2, JIM_EXPROP_DIV
},
6240 {"%", 200, 2, JIM_EXPROP_MOD
},
6242 {"-", 100, 2, JIM_EXPROP_SUB
},
6243 {"+", 100, 2, JIM_EXPROP_ADD
},
6245 {"<<<", 90, 3, JIM_EXPROP_ROTL
},
6246 {">>>", 90, 3, JIM_EXPROP_ROTR
},
6247 {"<<", 90, 2, JIM_EXPROP_LSHIFT
},
6248 {">>", 90, 2, JIM_EXPROP_RSHIFT
},
6250 {"<", 80, 2, JIM_EXPROP_LT
},
6251 {">", 80, 2, JIM_EXPROP_GT
},
6252 {"<=", 80, 2, JIM_EXPROP_LTE
},
6253 {">=", 80, 2, JIM_EXPROP_GTE
},
6255 {"==", 70, 2, JIM_EXPROP_NUMEQ
},
6256 {"!=", 70, 2, JIM_EXPROP_NUMNE
},
6258 {"eq", 60, 2, JIM_EXPROP_STREQ
},
6259 {"ne", 60, 2, JIM_EXPROP_STRNE
},
6261 {"&", 50, 2, JIM_EXPROP_BITAND
},
6262 {"^", 49, 2, JIM_EXPROP_BITXOR
},
6263 {"|", 48, 2, JIM_EXPROP_BITOR
},
6265 {"&&", 10, 2, JIM_EXPROP_LOGICAND
},
6266 {"||", 10, 2, JIM_EXPROP_LOGICOR
},
6268 {"?", 5, 3, JIM_EXPROP_TERNARY
},
6269 /* private operators */
6270 {NULL
, 10, 2, JIM_EXPROP_LOGICAND_LEFT
},
6271 {NULL
, 10, 1, JIM_EXPROP_LOGICAND_RIGHT
},
6272 {NULL
, 10, 2, JIM_EXPROP_LOGICOR_LEFT
},
6273 {NULL
, 10, 1, JIM_EXPROP_LOGICOR_RIGHT
},
6276 #define JIM_EXPR_OPERATORS_NUM \
6277 (sizeof(Jim_ExprOperators)/sizeof(struct Jim_ExprOperator))
6279 int JimParseExpression(struct JimParserCtx
*pc
)
6281 /* Discard spaces and quoted newline */
6282 while(*(pc
->p
) == ' ' ||
6286 (*(pc
->p
) == '\\' && *(pc
->p
+1) == '\n')) {
6291 pc
->tstart
= pc
->tend
= pc
->p
;
6292 pc
->tline
= pc
->linenr
;
6293 pc
->tt
= JIM_TT_EOL
;
6299 pc
->tstart
= pc
->tend
= pc
->p
;
6300 pc
->tline
= pc
->linenr
;
6301 pc
->tt
= JIM_TT_SUBEXPR_START
;
6305 pc
->tstart
= pc
->tend
= pc
->p
;
6306 pc
->tline
= pc
->linenr
;
6307 pc
->tt
= JIM_TT_SUBEXPR_END
;
6311 return JimParseCmd(pc
);
6314 if (JimParseVar(pc
) == JIM_ERR
)
6315 return JimParseExprOperator(pc
);
6320 if ((pc
->tt
== JIM_TT_NONE
|| pc
->tt
== JIM_TT_EXPR_OPERATOR
) &&
6321 isdigit((int)*(pc
->p
+1)))
6322 return JimParseExprNumber(pc
);
6324 return JimParseExprOperator(pc
);
6326 case '0': case '1': case '2': case '3': case '4':
6327 case '5': case '6': case '7': case '8': case '9': case '.':
6328 return JimParseExprNumber(pc
);
6332 /* Here it's possible to reuse the List String parsing. */
6333 pc
->tt
= JIM_TT_NONE
; /* Make sure it's sensed as a new word. */
6334 return JimParseListStr(pc
);
6338 if (JimParseExprIrrational(pc
) == JIM_ERR
)
6339 return JimParseExprOperator(pc
);
6342 return JimParseExprOperator(pc
);
6348 int JimParseExprNumber(struct JimParserCtx
*pc
)
6354 pc
->tline
= pc
->linenr
;
6355 if (*pc
->p
== '-') {
6358 while ( isdigit((int)*pc
->p
)
6359 || (allowhex
&& isxdigit((int)*pc
->p
) )
6360 || (allowdot
&& *pc
->p
== '.')
6361 || (pc
->p
-pc
->tstart
== 1 && *pc
->tstart
== '0' &&
6362 (*pc
->p
== 'x' || *pc
->p
== 'X'))
6365 if ((*pc
->p
== 'x') || (*pc
->p
== 'X')) {
6372 if (!allowdot
&& *pc
->p
== 'e' && *(pc
->p
+1) == '-') {
6373 pc
->p
+= 2; pc
->len
-= 2;
6377 pc
->tt
= JIM_TT_EXPR_NUMBER
;
6381 int JimParseExprIrrational(struct JimParserCtx
*pc
)
6383 const char *Tokens
[] = {"NaN", "nan", "NAN", "Inf", "inf", "INF", NULL
};
6385 for (token
= Tokens
; *token
!= NULL
; token
++) {
6386 int len
= strlen(*token
);
6387 if (strncmp(*token
, pc
->p
, len
) == 0) {
6389 pc
->tend
= pc
->p
+ len
- 1;
6390 pc
->p
+= len
; pc
->len
-= len
;
6391 pc
->tline
= pc
->linenr
;
6392 pc
->tt
= JIM_TT_EXPR_NUMBER
;
6399 int JimParseExprOperator(struct JimParserCtx
*pc
)
6402 int bestIdx
= -1, bestLen
= 0;
6404 /* Try to get the longest match. */
6405 for (i
= 0; i
< (signed)JIM_EXPR_OPERATORS_NUM
; i
++) {
6409 opname
= Jim_ExprOperators
[i
].name
;
6410 if (opname
== NULL
) continue;
6411 oplen
= strlen(opname
);
6413 if (strncmp(opname
, pc
->p
, oplen
) == 0 && oplen
> bestLen
) {
6418 if (bestIdx
== -1) return JIM_ERR
;
6420 pc
->tend
= pc
->p
+ bestLen
- 1;
6421 pc
->p
+= bestLen
; pc
->len
-= bestLen
;
6422 pc
->tline
= pc
->linenr
;
6423 pc
->tt
= JIM_TT_EXPR_OPERATOR
;
6427 struct Jim_ExprOperator
*JimExprOperatorInfo(const char *opname
)
6430 for (i
= 0; i
< (signed)JIM_EXPR_OPERATORS_NUM
; i
++)
6431 if (Jim_ExprOperators
[i
].name
&&
6432 strcmp(opname
, Jim_ExprOperators
[i
].name
) == 0)
6433 return &Jim_ExprOperators
[i
];
6437 struct Jim_ExprOperator
*JimExprOperatorInfoByOpcode(int opcode
)
6440 for (i
= 0; i
< (signed)JIM_EXPR_OPERATORS_NUM
; i
++)
6441 if (Jim_ExprOperators
[i
].opcode
== opcode
)
6442 return &Jim_ExprOperators
[i
];
6446 /* -----------------------------------------------------------------------------
6448 * ---------------------------------------------------------------------------*/
6449 static void FreeExprInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
6450 static void DupExprInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
);
6451 static int SetExprFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
);
6453 static Jim_ObjType exprObjType
= {
6455 FreeExprInternalRep
,
6458 JIM_TYPE_REFERENCES
,
6461 /* Expr bytecode structure */
6462 typedef struct ExprByteCode
{
6463 int *opcode
; /* Integer array of opcodes. */
6464 Jim_Obj
**obj
; /* Array of associated Jim Objects. */
6465 int len
; /* Bytecode length */
6466 int inUse
; /* Used for sharing. */
6469 void FreeExprInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
6472 ExprByteCode
*expr
= (void*) objPtr
->internalRep
.ptr
;
6475 if (expr
->inUse
!= 0) return;
6476 for (i
= 0; i
< expr
->len
; i
++)
6477 Jim_DecrRefCount(interp
, expr
->obj
[i
]);
6478 Jim_Free(expr
->opcode
);
6479 Jim_Free(expr
->obj
);
6483 void DupExprInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
)
6485 JIM_NOTUSED(interp
);
6486 JIM_NOTUSED(srcPtr
);
6488 /* Just returns an simple string. */
6489 dupPtr
->typePtr
= NULL
;
6492 /* Add a new instruction to an expression bytecode structure. */
6493 static void ExprObjAddInstr(Jim_Interp
*interp
, ExprByteCode
*expr
,
6494 int opcode
, char *str
, int len
)
6496 expr
->opcode
= Jim_Realloc(expr
->opcode
, sizeof(int)*(expr
->len
+1));
6497 expr
->obj
= Jim_Realloc(expr
->obj
, sizeof(Jim_Obj
*)*(expr
->len
+1));
6498 expr
->opcode
[expr
->len
] = opcode
;
6499 expr
->obj
[expr
->len
] = Jim_NewStringObjNoAlloc(interp
, str
, len
);
6500 Jim_IncrRefCount(expr
->obj
[expr
->len
]);
6504 /* Check if an expr program looks correct. */
6505 static int ExprCheckCorrectness(ExprByteCode
*expr
)
6510 /* Try to check if there are stack underflows,
6511 * and make sure at the end of the program there is
6512 * a single result on the stack. */
6513 for (i
= 0; i
< expr
->len
; i
++) {
6514 switch(expr
->opcode
[i
]) {
6515 case JIM_EXPROP_NUMBER
:
6516 case JIM_EXPROP_STRING
:
6517 case JIM_EXPROP_SUBST
:
6518 case JIM_EXPROP_VARIABLE
:
6519 case JIM_EXPROP_DICTSUGAR
:
6520 case JIM_EXPROP_COMMAND
:
6523 case JIM_EXPROP_NOT
:
6524 case JIM_EXPROP_BITNOT
:
6525 case JIM_EXPROP_UNARYMINUS
:
6526 case JIM_EXPROP_UNARYPLUS
:
6527 /* Unary operations */
6528 if (stacklen
< 1) return JIM_ERR
;
6530 case JIM_EXPROP_ADD
:
6531 case JIM_EXPROP_SUB
:
6532 case JIM_EXPROP_MUL
:
6533 case JIM_EXPROP_DIV
:
6534 case JIM_EXPROP_MOD
:
6537 case JIM_EXPROP_LTE
:
6538 case JIM_EXPROP_GTE
:
6539 case JIM_EXPROP_ROTL
:
6540 case JIM_EXPROP_ROTR
:
6541 case JIM_EXPROP_LSHIFT
:
6542 case JIM_EXPROP_RSHIFT
:
6543 case JIM_EXPROP_NUMEQ
:
6544 case JIM_EXPROP_NUMNE
:
6545 case JIM_EXPROP_STREQ
:
6546 case JIM_EXPROP_STRNE
:
6547 case JIM_EXPROP_BITAND
:
6548 case JIM_EXPROP_BITXOR
:
6549 case JIM_EXPROP_BITOR
:
6550 case JIM_EXPROP_LOGICAND
:
6551 case JIM_EXPROP_LOGICOR
:
6552 case JIM_EXPROP_POW
:
6553 /* binary operations */
6554 if (stacklen
< 2) return JIM_ERR
;
6558 Jim_Panic(NULL
,"Default opcode reached ExprCheckCorrectness");
6562 if (stacklen
!= 1) return JIM_ERR
;
6566 static void ExprShareLiterals(Jim_Interp
*interp
, ExprByteCode
*expr
,
6567 ScriptObj
*topLevelScript
)
6572 for (i
= 0; i
< expr
->len
; i
++) {
6573 Jim_Obj
*foundObjPtr
;
6575 if (expr
->obj
[i
] == NULL
) continue;
6576 foundObjPtr
= ScriptSearchLiteral(interp
, topLevelScript
,
6577 NULL
, expr
->obj
[i
]);
6578 if (foundObjPtr
!= NULL
) {
6579 Jim_IncrRefCount(foundObjPtr
);
6580 Jim_DecrRefCount(interp
, expr
->obj
[i
]);
6581 expr
->obj
[i
] = foundObjPtr
;
6586 /* This procedure converts every occurrence of || and && opereators
6587 * in lazy unary versions.
6589 * a b || is converted into:
6591 * a <offset> |L b |R
6593 * a b && is converted into:
6595 * a <offset> &L b &R
6597 * "|L" checks if 'a' is true:
6598 * 1) if it is true pushes 1 and skips <offset> istructions to reach
6599 * the opcode just after |R.
6600 * 2) if it is false does nothing.
6601 * "|R" checks if 'b' is true:
6602 * 1) if it is true pushes 1, otherwise pushes 0.
6604 * "&L" checks if 'a' is true:
6605 * 1) if it is true does nothing.
6606 * 2) If it is false pushes 0 and skips <offset> istructions to reach
6607 * the opcode just after &R
6608 * "&R" checks if 'a' is true:
6609 * if it is true pushes 1, otherwise pushes 0.
6611 static void ExprMakeLazy(Jim_Interp
*interp
, ExprByteCode
*expr
)
6614 int index
= -1, leftindex
, arity
, i
, offset
;
6615 Jim_ExprOperator
*op
;
6617 /* Search for || or && */
6618 for (i
= 0; i
< expr
->len
; i
++) {
6619 if (expr
->opcode
[i
] == JIM_EXPROP_LOGICAND
||
6620 expr
->opcode
[i
] == JIM_EXPROP_LOGICOR
) {
6625 if (index
== -1) return;
6626 /* Search for the end of the first operator */
6627 leftindex
= index
-1;
6630 switch(expr
->opcode
[leftindex
]) {
6631 case JIM_EXPROP_NUMBER
:
6632 case JIM_EXPROP_COMMAND
:
6633 case JIM_EXPROP_VARIABLE
:
6634 case JIM_EXPROP_DICTSUGAR
:
6635 case JIM_EXPROP_SUBST
:
6636 case JIM_EXPROP_STRING
:
6639 op
= JimExprOperatorInfoByOpcode(expr
->opcode
[leftindex
]);
6641 Jim_Panic(interp
,"Default reached in ExprMakeLazy()");
6650 expr
->opcode
= Jim_Realloc(expr
->opcode
, sizeof(int)*(expr
->len
+2));
6651 expr
->obj
= Jim_Realloc(expr
->obj
, sizeof(Jim_Obj
*)*(expr
->len
+2));
6652 memmove(&expr
->opcode
[leftindex
+2], &expr
->opcode
[leftindex
],
6653 sizeof(int)*(expr
->len
-leftindex
));
6654 memmove(&expr
->obj
[leftindex
+2], &expr
->obj
[leftindex
],
6655 sizeof(Jim_Obj
*)*(expr
->len
-leftindex
));
6658 offset
= (index
-leftindex
)-1;
6659 Jim_DecrRefCount(interp
, expr
->obj
[index
]);
6660 if (expr
->opcode
[index
] == JIM_EXPROP_LOGICAND
) {
6661 expr
->opcode
[leftindex
+1] = JIM_EXPROP_LOGICAND_LEFT
;
6662 expr
->opcode
[index
] = JIM_EXPROP_LOGICAND_RIGHT
;
6663 expr
->obj
[leftindex
+1] = Jim_NewStringObj(interp
, "&L", -1);
6664 expr
->obj
[index
] = Jim_NewStringObj(interp
, "&R", -1);
6666 expr
->opcode
[leftindex
+1] = JIM_EXPROP_LOGICOR_LEFT
;
6667 expr
->opcode
[index
] = JIM_EXPROP_LOGICOR_RIGHT
;
6668 expr
->obj
[leftindex
+1] = Jim_NewStringObj(interp
, "|L", -1);
6669 expr
->obj
[index
] = Jim_NewStringObj(interp
, "|R", -1);
6671 expr
->opcode
[leftindex
] = JIM_EXPROP_NUMBER
;
6672 expr
->obj
[leftindex
] = Jim_NewIntObj(interp
, offset
);
6673 Jim_IncrRefCount(expr
->obj
[index
]);
6674 Jim_IncrRefCount(expr
->obj
[leftindex
]);
6675 Jim_IncrRefCount(expr
->obj
[leftindex
+1]);
6679 /* This method takes the string representation of an expression
6680 * and generates a program for the Expr's stack-based VM. */
6681 int SetExprFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
)
6684 const char *exprText
= Jim_GetString(objPtr
, &exprTextLen
);
6685 struct JimParserCtx parser
;
6686 int i
, shareLiterals
;
6687 ExprByteCode
*expr
= Jim_Alloc(sizeof(*expr
));
6689 Jim_ExprOperator
*op
;
6691 /* Perform literal sharing with the current procedure
6692 * running only if this expression appears to be not generated
6694 shareLiterals
= objPtr
->typePtr
== &sourceObjType
;
6696 expr
->opcode
= NULL
;
6701 Jim_InitStack(&stack
);
6702 JimParserInit(&parser
, exprText
, exprTextLen
, 1);
6703 while(!JimParserEof(&parser
)) {
6707 if (JimParseExpression(&parser
) != JIM_OK
) {
6708 Jim_SetResultString(interp
, "Syntax error in expression", -1);
6711 token
= JimParserGetToken(&parser
, &len
, &type
, NULL
);
6712 if (type
== JIM_TT_EOL
) {
6718 ExprObjAddInstr(interp
, expr
, JIM_EXPROP_STRING
, token
, len
);
6721 ExprObjAddInstr(interp
, expr
, JIM_EXPROP_SUBST
, token
, len
);
6724 ExprObjAddInstr(interp
, expr
, JIM_EXPROP_VARIABLE
, token
, len
);
6726 case JIM_TT_DICTSUGAR
:
6727 ExprObjAddInstr(interp
, expr
, JIM_EXPROP_DICTSUGAR
, token
, len
);
6730 ExprObjAddInstr(interp
, expr
, JIM_EXPROP_COMMAND
, token
, len
);
6732 case JIM_TT_EXPR_NUMBER
:
6733 ExprObjAddInstr(interp
, expr
, JIM_EXPROP_NUMBER
, token
, len
);
6735 case JIM_TT_EXPR_OPERATOR
:
6736 op
= JimExprOperatorInfo(token
);
6738 Jim_ExprOperator
*stackTopOp
;
6740 if (Jim_StackPeek(&stack
) != NULL
) {
6741 stackTopOp
= JimExprOperatorInfo(Jim_StackPeek(&stack
));
6745 if (Jim_StackLen(&stack
) && op
->arity
!= 1 &&
6746 stackTopOp
&& stackTopOp
->precedence
>= op
->precedence
)
6748 ExprObjAddInstr(interp
, expr
, stackTopOp
->opcode
,
6749 Jim_StackPeek(&stack
), -1);
6750 Jim_StackPop(&stack
);
6755 Jim_StackPush(&stack
, token
);
6757 case JIM_TT_SUBEXPR_START
:
6758 Jim_StackPush(&stack
, Jim_StrDup("("));
6761 case JIM_TT_SUBEXPR_END
:
6764 while(Jim_StackLen(&stack
)) {
6765 char *opstr
= Jim_StackPop(&stack
);
6766 if (!strcmp(opstr
, "(")) {
6771 op
= JimExprOperatorInfo(opstr
);
6772 ExprObjAddInstr(interp
, expr
, op
->opcode
, opstr
, -1);
6775 Jim_SetResultString(interp
,
6776 "Unexpected close parenthesis", -1);
6783 Jim_Panic(interp
,"Default reached in SetExprFromAny()");
6787 while (Jim_StackLen(&stack
)) {
6788 char *opstr
= Jim_StackPop(&stack
);
6789 op
= JimExprOperatorInfo(opstr
);
6790 if (op
== NULL
&& !strcmp(opstr
, "(")) {
6792 Jim_SetResultString(interp
, "Missing close parenthesis", -1);
6795 ExprObjAddInstr(interp
, expr
, op
->opcode
, opstr
, -1);
6797 /* Check program correctness. */
6798 if (ExprCheckCorrectness(expr
) != JIM_OK
) {
6799 Jim_SetResultString(interp
, "Invalid expression", -1);
6803 /* Free the stack used for the compilation. */
6804 Jim_FreeStackElements(&stack
, Jim_Free
);
6805 Jim_FreeStack(&stack
);
6807 /* Convert || and && operators in unary |L |R and &L &R for lazyness */
6808 ExprMakeLazy(interp
, expr
);
6810 /* Perform literal sharing */
6811 if (shareLiterals
&& interp
->framePtr
->procBodyObjPtr
) {
6812 Jim_Obj
*bodyObjPtr
= interp
->framePtr
->procBodyObjPtr
;
6813 if (bodyObjPtr
->typePtr
== &scriptObjType
) {
6814 ScriptObj
*bodyScript
= bodyObjPtr
->internalRep
.ptr
;
6815 ExprShareLiterals(interp
, expr
, bodyScript
);
6819 /* Free the old internal rep and set the new one. */
6820 Jim_FreeIntRep(interp
, objPtr
);
6821 Jim_SetIntRepPtr(objPtr
, expr
);
6822 objPtr
->typePtr
= &exprObjType
;
6825 err
: /* we jump here on syntax/compile errors. */
6826 Jim_FreeStackElements(&stack
, Jim_Free
);
6827 Jim_FreeStack(&stack
);
6828 Jim_Free(expr
->opcode
);
6829 for (i
= 0; i
< expr
->len
; i
++) {
6830 Jim_DecrRefCount(interp
,expr
->obj
[i
]);
6832 Jim_Free(expr
->obj
);
6837 ExprByteCode
*Jim_GetExpression(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
6839 if (objPtr
->typePtr
!= &exprObjType
) {
6840 if (SetExprFromAny(interp
, objPtr
) != JIM_OK
)
6843 return (ExprByteCode
*) Jim_GetIntRepPtr(objPtr
);
6846 /* -----------------------------------------------------------------------------
6847 * Expressions evaluation.
6848 * Jim uses a specialized stack-based virtual machine for expressions,
6849 * that takes advantage of the fact that expr's operators
6850 * can't be redefined.
6852 * Jim_EvalExpression() uses the bytecode compiled by
6853 * SetExprFromAny() method of the "expression" object.
6855 * On success a Tcl Object containing the result of the evaluation
6856 * is stored into expResultPtrPtr (having refcount of 1), and JIM_OK is
6858 * On error the function returns a retcode != to JIM_OK and set a suitable
6859 * error on the interp.
6860 * ---------------------------------------------------------------------------*/
6861 #define JIM_EE_STATICSTACK_LEN 10
6863 int Jim_EvalExpression(Jim_Interp
*interp
, Jim_Obj
*exprObjPtr
,
6864 Jim_Obj
**exprResultPtrPtr
)
6867 Jim_Obj
**stack
, *staticStack
[JIM_EE_STATICSTACK_LEN
];
6868 int stacklen
= 0, i
, error
= 0, errRetCode
= JIM_ERR
;
6870 Jim_IncrRefCount(exprObjPtr
);
6871 expr
= Jim_GetExpression(interp
, exprObjPtr
);
6873 Jim_DecrRefCount(interp
, exprObjPtr
);
6874 return JIM_ERR
; /* error in expression. */
6876 /* In order to avoid that the internal repr gets freed due to
6877 * shimmering of the exprObjPtr's object, we make the internal rep
6881 /* The stack-based expr VM itself */
6883 /* Stack allocation. Expr programs have the feature that
6884 * a program of length N can't require a stack longer than
6886 if (expr
->len
> JIM_EE_STATICSTACK_LEN
)
6887 stack
= Jim_Alloc(sizeof(Jim_Obj
*)*expr
->len
);
6889 stack
= staticStack
;
6891 /* Execute every istruction */
6892 for (i
= 0; i
< expr
->len
; i
++) {
6893 Jim_Obj
*A
, *B
, *objPtr
;
6894 jim_wide wA
, wB
, wC
;
6896 const char *sA
, *sB
;
6897 int Alen
, Blen
, retcode
;
6898 int opcode
= expr
->opcode
[i
];
6900 if (opcode
== JIM_EXPROP_NUMBER
|| opcode
== JIM_EXPROP_STRING
) {
6901 stack
[stacklen
++] = expr
->obj
[i
];
6902 Jim_IncrRefCount(expr
->obj
[i
]);
6903 } else if (opcode
== JIM_EXPROP_VARIABLE
) {
6904 objPtr
= Jim_GetVariable(interp
, expr
->obj
[i
], JIM_ERRMSG
);
6905 if (objPtr
== NULL
) {
6909 stack
[stacklen
++] = objPtr
;
6910 Jim_IncrRefCount(objPtr
);
6911 } else if (opcode
== JIM_EXPROP_SUBST
) {
6912 if ((retcode
= Jim_SubstObj(interp
, expr
->obj
[i
],
6913 &objPtr
, JIM_NONE
)) != JIM_OK
)
6916 errRetCode
= retcode
;
6919 stack
[stacklen
++] = objPtr
;
6920 Jim_IncrRefCount(objPtr
);
6921 } else if (opcode
== JIM_EXPROP_DICTSUGAR
) {
6922 objPtr
= Jim_ExpandDictSugar(interp
, expr
->obj
[i
]);
6923 if (objPtr
== NULL
) {
6927 stack
[stacklen
++] = objPtr
;
6928 Jim_IncrRefCount(objPtr
);
6929 } else if (opcode
== JIM_EXPROP_COMMAND
) {
6930 if ((retcode
= Jim_EvalObj(interp
, expr
->obj
[i
])) != JIM_OK
) {
6932 errRetCode
= retcode
;
6935 stack
[stacklen
++] = interp
->result
;
6936 Jim_IncrRefCount(interp
->result
);
6937 } else if (opcode
>= JIM_EXPROP_BINARY_NUM_FIRST
&&
6938 opcode
<= JIM_EXPROP_BINARY_NUM_LAST
)
6940 /* Note that there isn't to increment the
6941 * refcount of objects. the references are moved
6942 * from stack to A and B. */
6943 B
= stack
[--stacklen
];
6944 A
= stack
[--stacklen
];
6946 /* --- Integer --- */
6947 if ((A
->typePtr
== &doubleObjType
&& !A
->bytes
) ||
6948 (B
->typePtr
== &doubleObjType
&& !B
->bytes
) ||
6949 JimGetWideNoErr(interp
, A
, &wA
) != JIM_OK
||
6950 JimGetWideNoErr(interp
, B
, &wB
) != JIM_OK
) {
6953 Jim_DecrRefCount(interp
, A
);
6954 Jim_DecrRefCount(interp
, B
);
6955 switch(expr
->opcode
[i
]) {
6956 case JIM_EXPROP_ADD
: wC
= wA
+wB
; break;
6957 case JIM_EXPROP_SUB
: wC
= wA
-wB
; break;
6958 case JIM_EXPROP_MUL
: wC
= wA
*wB
; break;
6959 case JIM_EXPROP_LT
: wC
= wA
<wB
; break;
6960 case JIM_EXPROP_GT
: wC
= wA
>wB
; break;
6961 case JIM_EXPROP_LTE
: wC
= wA
<=wB
; break;
6962 case JIM_EXPROP_GTE
: wC
= wA
>=wB
; break;
6963 case JIM_EXPROP_LSHIFT
: wC
= wA
<<wB
; break;
6964 case JIM_EXPROP_RSHIFT
: wC
= wA
>>wB
; break;
6965 case JIM_EXPROP_NUMEQ
: wC
= wA
==wB
; break;
6966 case JIM_EXPROP_NUMNE
: wC
= wA
!=wB
; break;
6967 case JIM_EXPROP_BITAND
: wC
= wA
&wB
; break;
6968 case JIM_EXPROP_BITXOR
: wC
= wA
^wB
; break;
6969 case JIM_EXPROP_BITOR
: wC
= wA
|wB
; break;
6970 case JIM_EXPROP_POW
: wC
= JimPowWide(wA
,wB
); break;
6971 case JIM_EXPROP_LOGICAND_LEFT
:
6979 case JIM_EXPROP_LOGICOR_LEFT
:
6987 case JIM_EXPROP_DIV
:
6988 if (wB
== 0) goto divbyzero
;
6991 case JIM_EXPROP_MOD
:
6992 if (wB
== 0) goto divbyzero
;
6995 case JIM_EXPROP_ROTL
: {
6996 /* uint32_t would be better. But not everyone has inttypes.h?*/
6997 unsigned long uA
= (unsigned long)wA
;
6999 wC
= _rotl(uA
,(unsigned long)wB
);
7001 const unsigned int S
= sizeof(unsigned long) * 8;
7002 wC
= (unsigned long)((uA
<<wB
)|(uA
>>(S
-wB
)));
7006 case JIM_EXPROP_ROTR
: {
7007 unsigned long uA
= (unsigned long)wA
;
7009 wC
= _rotr(uA
,(unsigned long)wB
);
7011 const unsigned int S
= sizeof(unsigned long) * 8;
7012 wC
= (unsigned long)((uA
>>wB
)|(uA
<<(S
-wB
)));
7018 wC
= 0; /* avoid gcc warning */
7021 stack
[stacklen
] = Jim_NewIntObj(interp
, wC
);
7022 Jim_IncrRefCount(stack
[stacklen
]);
7026 /* --- Double --- */
7027 if (Jim_GetDouble(interp
, A
, &dA
) != JIM_OK
||
7028 Jim_GetDouble(interp
, B
, &dB
) != JIM_OK
) {
7030 /* Hmmm! For compatibility, maybe convert != and == into ne and eq */
7031 if (expr
->opcode
[i
] == JIM_EXPROP_NUMNE
) {
7032 opcode
= JIM_EXPROP_STRNE
;
7033 goto retry_as_string
;
7035 else if (expr
->opcode
[i
] == JIM_EXPROP_NUMEQ
) {
7036 opcode
= JIM_EXPROP_STREQ
;
7037 goto retry_as_string
;
7039 Jim_DecrRefCount(interp
, A
);
7040 Jim_DecrRefCount(interp
, B
);
7044 Jim_DecrRefCount(interp
, A
);
7045 Jim_DecrRefCount(interp
, B
);
7046 switch(expr
->opcode
[i
]) {
7047 case JIM_EXPROP_ROTL
:
7048 case JIM_EXPROP_ROTR
:
7049 case JIM_EXPROP_LSHIFT
:
7050 case JIM_EXPROP_RSHIFT
:
7051 case JIM_EXPROP_BITAND
:
7052 case JIM_EXPROP_BITXOR
:
7053 case JIM_EXPROP_BITOR
:
7054 case JIM_EXPROP_MOD
:
7055 case JIM_EXPROP_POW
:
7056 Jim_SetResultString(interp
,
7057 "Got floating-point value where integer was expected", -1);
7061 case JIM_EXPROP_ADD
: dC
= dA
+dB
; break;
7062 case JIM_EXPROP_SUB
: dC
= dA
-dB
; break;
7063 case JIM_EXPROP_MUL
: dC
= dA
*dB
; break;
7064 case JIM_EXPROP_LT
: dC
= dA
<dB
; break;
7065 case JIM_EXPROP_GT
: dC
= dA
>dB
; break;
7066 case JIM_EXPROP_LTE
: dC
= dA
<=dB
; break;
7067 case JIM_EXPROP_GTE
: dC
= dA
>=dB
; break;
7068 case JIM_EXPROP_NUMEQ
: dC
= dA
==dB
; break;
7069 case JIM_EXPROP_NUMNE
: dC
= dA
!=dB
; break;
7070 case JIM_EXPROP_LOGICAND_LEFT
:
7078 case JIM_EXPROP_LOGICOR_LEFT
:
7086 case JIM_EXPROP_DIV
:
7087 if (dB
== 0) goto divbyzero
;
7091 dC
= 0; /* avoid gcc warning */
7094 stack
[stacklen
] = Jim_NewDoubleObj(interp
, dC
);
7095 Jim_IncrRefCount(stack
[stacklen
]);
7097 } else if (opcode
== JIM_EXPROP_STREQ
|| opcode
== JIM_EXPROP_STRNE
) {
7098 B
= stack
[--stacklen
];
7099 A
= stack
[--stacklen
];
7101 sA
= Jim_GetString(A
, &Alen
);
7102 sB
= Jim_GetString(B
, &Blen
);
7104 case JIM_EXPROP_STREQ
:
7105 if (Alen
== Blen
&& memcmp(sA
, sB
, Alen
) ==0)
7110 case JIM_EXPROP_STRNE
:
7111 if (Alen
!= Blen
|| memcmp(sA
, sB
, Alen
) != 0)
7117 wC
= 0; /* avoid gcc warning */
7120 Jim_DecrRefCount(interp
, A
);
7121 Jim_DecrRefCount(interp
, B
);
7122 stack
[stacklen
] = Jim_NewIntObj(interp
, wC
);
7123 Jim_IncrRefCount(stack
[stacklen
]);
7125 } else if (opcode
== JIM_EXPROP_NOT
||
7126 opcode
== JIM_EXPROP_BITNOT
||
7127 opcode
== JIM_EXPROP_LOGICAND_RIGHT
||
7128 opcode
== JIM_EXPROP_LOGICOR_RIGHT
) {
7129 /* Note that there isn't to increment the
7130 * refcount of objects. the references are moved
7131 * from stack to A and B. */
7132 A
= stack
[--stacklen
];
7134 /* --- Integer --- */
7135 if ((A
->typePtr
== &doubleObjType
&& !A
->bytes
) ||
7136 JimGetWideNoErr(interp
, A
, &wA
) != JIM_OK
) {
7137 goto trydouble_unary
;
7139 Jim_DecrRefCount(interp
, A
);
7140 switch(expr
->opcode
[i
]) {
7141 case JIM_EXPROP_NOT
: wC
= !wA
; break;
7142 case JIM_EXPROP_BITNOT
: wC
= ~wA
; break;
7143 case JIM_EXPROP_LOGICAND_RIGHT
:
7144 case JIM_EXPROP_LOGICOR_RIGHT
: wC
= (wA
!= 0); break;
7146 wC
= 0; /* avoid gcc warning */
7149 stack
[stacklen
] = Jim_NewIntObj(interp
, wC
);
7150 Jim_IncrRefCount(stack
[stacklen
]);
7154 /* --- Double --- */
7155 if (Jim_GetDouble(interp
, A
, &dA
) != JIM_OK
) {
7156 Jim_DecrRefCount(interp
, A
);
7160 Jim_DecrRefCount(interp
, A
);
7161 switch(expr
->opcode
[i
]) {
7162 case JIM_EXPROP_NOT
: dC
= !dA
; break;
7163 case JIM_EXPROP_LOGICAND_RIGHT
:
7164 case JIM_EXPROP_LOGICOR_RIGHT
: dC
= (dA
!= 0); break;
7165 case JIM_EXPROP_BITNOT
:
7166 Jim_SetResultString(interp
,
7167 "Got floating-point value where integer was expected", -1);
7172 dC
= 0; /* avoid gcc warning */
7175 stack
[stacklen
] = Jim_NewDoubleObj(interp
, dC
);
7176 Jim_IncrRefCount(stack
[stacklen
]);
7179 Jim_Panic(interp
,"Unknown opcode in Jim_EvalExpression");
7183 /* There is no need to decerement the inUse field because
7184 * this reference is transfered back into the exprObjPtr. */
7185 Jim_FreeIntRep(interp
, exprObjPtr
);
7186 exprObjPtr
->typePtr
= &exprObjType
;
7187 Jim_SetIntRepPtr(exprObjPtr
, expr
);
7188 Jim_DecrRefCount(interp
, exprObjPtr
);
7190 *exprResultPtrPtr
= stack
[0];
7191 Jim_IncrRefCount(stack
[0]);
7192 errRetCode
= JIM_OK
;
7194 for (i
= 0; i
< stacklen
; i
++) {
7195 Jim_DecrRefCount(interp
, stack
[i
]);
7197 if (stack
!= staticStack
)
7202 Jim_SetResultString(interp
, "Division by zero", -1);
7206 int Jim_GetBoolFromExpr(Jim_Interp
*interp
, Jim_Obj
*exprObjPtr
, int *boolPtr
)
7211 Jim_Obj
*exprResultPtr
;
7213 retcode
= Jim_EvalExpression(interp
, exprObjPtr
, &exprResultPtr
);
7214 if (retcode
!= JIM_OK
)
7216 if (JimGetWideNoErr(interp
, exprResultPtr
, &wideValue
) != JIM_OK
) {
7217 if (Jim_GetDouble(interp
, exprResultPtr
, &doubleValue
) != JIM_OK
)
7219 Jim_DecrRefCount(interp
, exprResultPtr
);
7222 Jim_DecrRefCount(interp
, exprResultPtr
);
7223 *boolPtr
= doubleValue
!= 0;
7227 Jim_DecrRefCount(interp
, exprResultPtr
);
7228 *boolPtr
= wideValue
!= 0;
7232 /* -----------------------------------------------------------------------------
7233 * ScanFormat String Object
7234 * ---------------------------------------------------------------------------*/
7236 /* This Jim_Obj will held a parsed representation of a format string passed to
7237 * the Jim_ScanString command. For error diagnostics, the scanformat string has
7238 * to be parsed in its entirely first and then, if correct, can be used for
7239 * scanning. To avoid endless re-parsing, the parsed representation will be
7240 * stored in an internal representation and re-used for performance reason. */
7242 /* A ScanFmtPartDescr will held the information of /one/ part of the whole
7243 * scanformat string. This part will later be used to extract information
7244 * out from the string to be parsed by Jim_ScanString */
7246 typedef struct ScanFmtPartDescr
{
7247 char type
; /* Type of conversion (e.g. c, d, f) */
7248 char modifier
; /* Modify type (e.g. l - long, h - short */
7249 size_t width
; /* Maximal width of input to be converted */
7250 int pos
; /* -1 - no assign, 0 - natural pos, >0 - XPG3 pos */
7251 char *arg
; /* Specification of a CHARSET conversion */
7252 char *prefix
; /* Prefix to be scanned literally before conversion */
7255 /* The ScanFmtStringObj will held the internal representation of a scanformat
7256 * string parsed and separated in part descriptions. Furthermore it contains
7257 * the original string representation of the scanformat string to allow for
7258 * fast update of the Jim_Obj's string representation part.
7260 * As add-on the internal object representation add some scratch pad area
7261 * for usage by Jim_ScanString to avoid endless allocating and freeing of
7262 * memory for purpose of string scanning.
7264 * The error member points to a static allocated string in case of a mal-
7265 * formed scanformat string or it contains '0' (NULL) in case of a valid
7266 * parse representation.
7268 * The whole memory of the internal representation is allocated as a single
7269 * area of memory that will be internally separated. So freeing and duplicating
7270 * of such an object is cheap */
7272 typedef struct ScanFmtStringObj
{
7273 jim_wide size
; /* Size of internal repr in bytes */
7274 char *stringRep
; /* Original string representation */
7275 size_t count
; /* Number of ScanFmtPartDescr contained */
7276 size_t convCount
; /* Number of conversions that will assign */
7277 size_t maxPos
; /* Max position index if XPG3 is used */
7278 const char *error
; /* Ptr to error text (NULL if no error */
7279 char *scratch
; /* Some scratch pad used by Jim_ScanString */
7280 ScanFmtPartDescr descr
[1]; /* The vector of partial descriptions */
7284 static void FreeScanFmtInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
);
7285 static void DupScanFmtInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
);
7286 static void UpdateStringOfScanFmt(Jim_Obj
*objPtr
);
7288 static Jim_ObjType scanFmtStringObjType
= {
7290 FreeScanFmtInternalRep
,
7291 DupScanFmtInternalRep
,
7292 UpdateStringOfScanFmt
,
7296 void FreeScanFmtInternalRep(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
7298 JIM_NOTUSED(interp
);
7299 Jim_Free((char*)objPtr
->internalRep
.ptr
);
7300 objPtr
->internalRep
.ptr
= 0;
7303 void DupScanFmtInternalRep(Jim_Interp
*interp
, Jim_Obj
*srcPtr
, Jim_Obj
*dupPtr
)
7305 size_t size
= (size_t)((ScanFmtStringObj
*)srcPtr
->internalRep
.ptr
)->size
;
7306 ScanFmtStringObj
*newVec
= (ScanFmtStringObj
*)Jim_Alloc(size
);
7308 JIM_NOTUSED(interp
);
7309 memcpy(newVec
, srcPtr
->internalRep
.ptr
, size
);
7310 dupPtr
->internalRep
.ptr
= newVec
;
7311 dupPtr
->typePtr
= &scanFmtStringObjType
;
7314 void UpdateStringOfScanFmt(Jim_Obj
*objPtr
)
7316 char *bytes
= ((ScanFmtStringObj
*)objPtr
->internalRep
.ptr
)->stringRep
;
7318 objPtr
->bytes
= Jim_StrDup(bytes
);
7319 objPtr
->length
= strlen(bytes
);
7322 /* SetScanFmtFromAny will parse a given string and create the internal
7323 * representation of the format specification. In case of an error
7324 * the error data member of the internal representation will be set
7325 * to an descriptive error text and the function will be left with
7326 * JIM_ERR to indicate unsucessful parsing (aka. malformed scanformat
7329 static int SetScanFmtFromAny(Jim_Interp
*interp
, Jim_Obj
*objPtr
)
7331 ScanFmtStringObj
*fmtObj
;
7333 int maxCount
, i
, approxSize
, lastPos
= -1;
7334 const char *fmt
= objPtr
->bytes
;
7335 int maxFmtLen
= objPtr
->length
;
7336 const char *fmtEnd
= fmt
+ maxFmtLen
;
7339 Jim_FreeIntRep(interp
, objPtr
);
7340 /* Count how many conversions could take place maximally */
7341 for (i
=0, maxCount
=0; i
< maxFmtLen
; ++i
)
7344 /* Calculate an approximation of the memory necessary */
7345 approxSize
= sizeof(ScanFmtStringObj
) /* Size of the container */
7346 + (maxCount
+ 1) * sizeof(ScanFmtPartDescr
) /* Size of all partials */
7347 + maxFmtLen
* sizeof(char) + 3 + 1 /* Scratch + "%n" + '\0' */
7348 + maxFmtLen
* sizeof(char) + 1 /* Original stringrep */
7349 + maxFmtLen
* sizeof(char) /* Arg for CHARSETs */
7350 + (maxCount
+1) * sizeof(char) /* '\0' for every partial */
7351 + 1; /* safety byte */
7352 fmtObj
= (ScanFmtStringObj
*)Jim_Alloc(approxSize
);
7353 memset(fmtObj
, 0, approxSize
);
7354 fmtObj
->size
= approxSize
;
7356 fmtObj
->scratch
= (char*)&fmtObj
->descr
[maxCount
+1];
7357 fmtObj
->stringRep
= fmtObj
->scratch
+ maxFmtLen
+ 3 + 1;
7358 memcpy(fmtObj
->stringRep
, fmt
, maxFmtLen
);
7359 buffer
= fmtObj
->stringRep
+ maxFmtLen
+ 1;
7360 objPtr
->internalRep
.ptr
= fmtObj
;
7361 objPtr
->typePtr
= &scanFmtStringObjType
;
7362 for (i
=0, curr
=0; fmt
< fmtEnd
; ++fmt
) {
7364 ScanFmtPartDescr
*descr
= &fmtObj
->descr
[curr
];
7366 descr
->width
= 0; /* Assume width unspecified */
7367 /* Overread and store any "literal" prefix */
7368 if (*fmt
!= '%' || fmt
[1] == '%') {
7370 descr
->prefix
= &buffer
[i
];
7371 for (; fmt
< fmtEnd
; ++fmt
) {
7373 if (fmt
[1] != '%') break;
7380 /* Skip the conversion introducing '%' sign */
7382 /* End reached due to non-conversion literal only? */
7385 descr
->pos
= 0; /* Assume "natural" positioning */
7387 descr
->pos
= -1; /* Okay, conversion will not be assigned */
7390 fmtObj
->convCount
++; /* Otherwise count as assign-conversion */
7391 /* Check if next token is a number (could be width or pos */
7392 if (sscanf(fmt
, "%d%n", &width
, &skip
) == 1) {
7394 /* Was the number a XPG3 position specifier? */
7395 if (descr
->pos
!= -1 && *fmt
== '$') {
7400 /* Look if "natural" postioning and XPG3 one was mixed */
7401 if ((lastPos
== 0 && descr
->pos
> 0)
7402 || (lastPos
> 0 && descr
->pos
== 0)) {
7403 fmtObj
->error
= "cannot mix \"%\" and \"%n$\" conversion specifiers";
7406 /* Look if this position was already used */
7407 for (prev
=0; prev
< curr
; ++prev
) {
7408 if (fmtObj
->descr
[prev
].pos
== -1) continue;
7409 if (fmtObj
->descr
[prev
].pos
== descr
->pos
) {
7410 fmtObj
->error
= "same \"%n$\" conversion specifier "
7411 "used more than once";
7415 /* Try to find a width after the XPG3 specifier */
7416 if (sscanf(fmt
, "%d%n", &width
, &skip
) == 1) {
7417 descr
->width
= width
;
7420 if (descr
->pos
> 0 && (size_t)descr
->pos
> fmtObj
->maxPos
)
7421 fmtObj
->maxPos
= descr
->pos
;
7423 /* Number was not a XPG3, so it has to be a width */
7424 descr
->width
= width
;
7427 /* If positioning mode was undetermined yet, fix this */
7429 lastPos
= descr
->pos
;
7430 /* Handle CHARSET conversion type ... */
7432 int swapped
= 1, beg
= i
, end
, j
;
7434 descr
->arg
= &buffer
[i
];
7436 if (*fmt
== '^') buffer
[i
++] = *fmt
++;
7437 if (*fmt
== ']') buffer
[i
++] = *fmt
++;
7438 while (*fmt
&& *fmt
!= ']') buffer
[i
++] = *fmt
++;
7440 fmtObj
->error
= "unmatched [ in format string";
7445 /* In case a range fence was given "backwards", swap it */
7448 for (j
=beg
+1; j
< end
-1; ++j
) {
7449 if (buffer
[j
] == '-' && buffer
[j
-1] > buffer
[j
+1]) {
7450 char tmp
= buffer
[j
-1];
7451 buffer
[j
-1] = buffer
[j
+1];
7458 /* Remember any valid modifier if given */
7459 if (strchr("hlL", *fmt
) != 0)
7460 descr
->modifier
= tolower((int)*fmt
++);
7463 if (strchr("efgcsndoxui", *fmt
) == 0) {
7464 fmtObj
->error
= "bad scan conversion character";
7466 } else if (*fmt
== 'c' && descr
->width
!= 0) {
7467 fmtObj
->error
= "field width may not be specified in %c "
7470 } else if (*fmt
== 'u' && descr
->modifier
== 'l') {
7471 fmtObj
->error
= "unsigned wide not supported";
7478 if (fmtObj
->convCount
== 0) {
7479 fmtObj
->error
= "no any conversion specifier given";
7485 /* Some accessor macros to allow lowlevel access to fields of internal repr */
7487 #define FormatGetCnvCount(_fo_) \
7488 ((ScanFmtStringObj*)((_fo_)->internalRep.ptr))->convCount
7489 #define FormatGetMaxPos(_fo_) \
7490 ((ScanFmtStringObj*)((_fo_)->internalRep.ptr))->maxPos
7491 #define FormatGetError(_fo_) \
7492 ((ScanFmtStringObj*)((_fo_)->internalRep.ptr))->error
7494 /* Some Bit testing/setting/cleaning routines. For now only used in handling
7495 * charsets ([a-z123]) within scanning. Later on perhaps a base for a
7496 * bitvector implementation in Jim? */
7498 static int JimTestBit(const char *bitvec
, char ch
)
7500 div_t pos
= div(ch
-1, 8);
7501 return bitvec
[pos
.quot
] & (1 << pos
.rem
);
7504 static void JimSetBit(char *bitvec
, char ch
)
7506 div_t pos
= div(ch
-1, 8);
7507 bitvec
[pos
.quot
] |= (1 << pos
.rem
);
7510 #if 0 /* currently not used */
7511 static void JimClearBit(char *bitvec
, char ch
)
7513 div_t pos
= div(ch
-1, 8);
7514 bitvec
[pos
.quot
] &= ~(1 << pos
.rem
);
7518 /* JimScanAString is used to scan an unspecified string that ends with
7519 * next WS, or a string that is specified via a charset. The charset
7520 * is currently implemented in a way to only allow for usage with
7521 * ASCII. Whenever we will switch to UNICODE, another idea has to
7524 * FIXME: Works only with ASCII */
7527 JimScanAString(Jim_Interp
*interp
, const char *sdescr
, const char *str
)
7531 char charset
[256/8+1]; /* A Charset may contain max 256 chars */
7532 char *buffer
= Jim_Alloc(strlen(str
)+1), *anchor
= buffer
;
7534 /* First init charset to nothing or all, depending if a specified
7535 * or an unspecified string has to be parsed */
7536 memset(charset
, (sdescr
? 0 : 255), sizeof(charset
));
7538 /* There was a set description given, that means we are parsing
7539 * a specified string. So we have to build a corresponding
7540 * charset reflecting the description */
7542 /* Should the set be negated at the end? */
7543 if (*sdescr
== '^') {
7547 /* Here '-' is meant literally and not to define a range */
7548 if (*sdescr
== '-') {
7549 JimSetBit(charset
, '-');
7553 if (sdescr
[1] == '-' && sdescr
[2] != 0) {
7554 /* Handle range definitions */
7556 for (i
=sdescr
[0]; i
<= sdescr
[2]; ++i
)
7557 JimSetBit(charset
, (char)i
);
7560 /* Handle verbatim character definitions */
7561 JimSetBit(charset
, *sdescr
++);
7564 /* Negate the charset if there was a NOT given */
7565 for (i
=0; notFlag
&& i
< sizeof(charset
); ++i
)
7566 charset
[i
] = ~charset
[i
];
7568 /* And after all the mess above, the real work begin ... */
7569 while (str
&& *str
) {
7570 if (!sdescr
&& isspace((int)*str
))
7571 break; /* EOS via WS if unspecified */
7572 if (JimTestBit(charset
, *str
)) *buffer
++ = *str
++;
7573 else break; /* EOS via mismatch if specified scanning */
7575 *buffer
= 0; /* Close the string properly ... */
7576 result
= Jim_NewStringObj(interp
, anchor
, -1);
7577 Jim_Free(anchor
); /* ... and free it afer usage */
7581 /* ScanOneEntry will scan one entry out of the string passed as argument.
7582 * It use the sscanf() function for this task. After extracting and
7583 * converting of the value, the count of scanned characters will be
7584 * returned of -1 in case of no conversion tool place and string was
7585 * already scanned thru */
7587 static int ScanOneEntry(Jim_Interp
*interp
, const char *str
, long pos
,
7588 ScanFmtStringObj
*fmtObj
, long index
, Jim_Obj
**valObjPtr
)
7590 # define MAX_SIZE (sizeof(jim_wide) > sizeof(double) \
7591 ? sizeof(jim_wide) \
7593 char buffer
[MAX_SIZE
];
7594 char *value
= buffer
;
7596 const ScanFmtPartDescr
*descr
= &fmtObj
->descr
[index
];
7597 size_t sLen
= strlen(&str
[pos
]), scanned
= 0;
7598 size_t anchor
= pos
;
7601 /* First pessimiticly assume, we will not scan anything :-) */
7603 if (descr
->prefix
) {
7604 /* There was a prefix given before the conversion, skip it and adjust
7605 * the string-to-be-parsed accordingly */
7606 for (i
=0; str
[pos
] && descr
->prefix
[i
]; ++i
) {
7607 /* If prefix require, skip WS */
7608 if (isspace((int)descr
->prefix
[i
]))
7609 while (str
[pos
] && isspace((int)str
[pos
])) ++pos
;
7610 else if (descr
->prefix
[i
] != str
[pos
])
7611 break; /* Prefix do not match here, leave the loop */
7613 ++pos
; /* Prefix matched so far, next round */
7616 return -1; /* All of str consumed: EOF condition */
7617 else if (descr
->prefix
[i
] != 0)
7618 return 0; /* Not whole prefix consumed, no conversion possible */
7620 /* For all but following conversion, skip leading WS */
7621 if (descr
->type
!= 'c' && descr
->type
!= '[' && descr
->type
!= 'n')
7622 while (isspace((int)str
[pos
])) ++pos
;
7623 /* Determine how much skipped/scanned so far */
7624 scanned
= pos
- anchor
;
7625 if (descr
->type
== 'n') {
7626 /* Return pseudo conversion means: how much scanned so far? */
7627 *valObjPtr
= Jim_NewIntObj(interp
, anchor
+ scanned
);
7628 } else if (str
[pos
] == 0) {
7629 /* Cannot scan anything, as str is totally consumed */
7632 /* Processing of conversions follows ... */
7633 if (descr
->width
> 0) {
7634 /* Do not try to scan as fas as possible but only the given width.
7635 * To ensure this, we copy the part that should be scanned. */
7636 size_t tLen
= descr
->width
> sLen
? sLen
: descr
->width
;
7637 tok
= Jim_StrDupLen(&str
[pos
], tLen
);
7639 /* As no width was given, simply refer to the original string */
7642 switch (descr
->type
) {
7644 *valObjPtr
= Jim_NewIntObj(interp
, *tok
);
7647 case 'd': case 'o': case 'x': case 'u': case 'i': {
7648 char *endp
; /* Position where the number finished */
7649 int base
= descr
->type
== 'o' ? 8
7650 : descr
->type
== 'x' ? 16
7651 : descr
->type
== 'i' ? 0
7655 /* Try to scan a number with the given base */
7656 if (descr
->modifier
== 'l')
7657 #ifdef HAVE_LONG_LONG
7658 *(jim_wide
*)value
= JimStrtoll(tok
, &endp
, base
);
7660 *(jim_wide
*)value
= strtol(tok
, &endp
, base
);
7663 if (descr
->type
== 'u')
7664 *(long*)value
= strtoul(tok
, &endp
, base
);
7666 *(long*)value
= strtol(tok
, &endp
, base
);
7667 /* If scanning failed, and base was undetermined, simply
7668 * put it to 10 and try once more. This should catch the
7669 * case where %i begin to parse a number prefix (e.g.
7670 * '0x' but no further digits follows. This will be
7671 * handled as a ZERO followed by a char 'x' by Tcl */
7672 if (endp
== tok
&& base
== 0) base
= 10;
7676 /* There was some number sucessfully scanned! */
7677 if (descr
->modifier
== 'l')
7678 *valObjPtr
= Jim_NewIntObj(interp
, *(jim_wide
*)value
);
7680 *valObjPtr
= Jim_NewIntObj(interp
, *(long*)value
);
7681 /* Adjust the number-of-chars scanned so far */
7682 scanned
+= endp
- tok
;
7684 /* Nothing was scanned. We have to determine if this
7685 * happened due to e.g. prefix mismatch or input str
7687 scanned
= *tok
? 0 : -1;
7691 case 's': case '[': {
7692 *valObjPtr
= JimScanAString(interp
, descr
->arg
, tok
);
7693 scanned
+= Jim_Length(*valObjPtr
);
7696 case 'e': case 'f': case 'g': {
7699 *(double*)value
= strtod(tok
, &endp
);
7701 /* There was some number sucessfully scanned! */
7702 *valObjPtr
= Jim_NewDoubleObj(interp
, *(double*)value
);
7703 /* Adjust the number-of-chars scanned so far */
7704 scanned
+= endp
- tok
;
7706 /* Nothing was scanned. We have to determine if this
7707 * happened due to e.g. prefix mismatch or input str
7709 scanned
= *tok
? 0 : -1;
7714 /* If a substring was allocated (due to pre-defined width) do not
7715 * forget to free it */
7716 if (tok
!= &str
[pos
])
7717 Jim_Free((char*)tok
);
7722 /* Jim_ScanString is the workhorse of string scanning. It will scan a given
7723 * string and returns all converted (and not ignored) values in a list back
7724 * to the caller. If an error occured, a NULL pointer will be returned */
7726 Jim_Obj
*Jim_ScanString(Jim_Interp
*interp
, Jim_Obj
*strObjPtr
,
7727 Jim_Obj
*fmtObjPtr
, int flags
)
7731 const char *str
= Jim_GetString(strObjPtr
, 0);
7732 Jim_Obj
*resultList
= 0;
7733 Jim_Obj
**resultVec
;
7735 Jim_Obj
*emptyStr
= 0;
7736 ScanFmtStringObj
*fmtObj
;
7738 /* If format specification is not an object, convert it! */
7739 if (fmtObjPtr
->typePtr
!= &scanFmtStringObjType
)
7740 SetScanFmtFromAny(interp
, fmtObjPtr
);
7741 fmtObj
= (ScanFmtStringObj
*)fmtObjPtr
->internalRep
.ptr
;
7742 /* Check if format specification was valid */
7743 if (fmtObj
->error
!= 0) {
7744 if (flags
& JIM_ERRMSG
)
7745 Jim_SetResultString(interp
, fmtObj
->error
, -1);
7748 /* Allocate a new "shared" empty string for all unassigned conversions */
7749 emptyStr
= Jim_NewEmptyStringObj(interp
);
7750 Jim_IncrRefCount(emptyStr
);
7751 /* Create a list and fill it with empty strings up to max specified XPG3 */
7752 resultList
= Jim_NewListObj(interp
, 0, 0);
7753 if (fmtObj
->maxPos
> 0) {
7754 for (i
=0; i
< fmtObj
->maxPos
; ++i
)
7755 Jim_ListAppendElement(interp
, resultList
, emptyStr
);
7756 JimListGetElements(interp
, resultList
, &resultc
, &resultVec
);
7758 /* Now handle every partial format description */
7759 for (i
=0, pos
=0; i
< fmtObj
->count
; ++i
) {
7760 ScanFmtPartDescr
*descr
= &(fmtObj
->descr
[i
]);
7762 /* Only last type may be "literal" w/o conversion - skip it! */
7763 if (descr
->type
== 0) continue;
7764 /* As long as any conversion could be done, we will proceed */
7766 scanned
= ScanOneEntry(interp
, str
, pos
, fmtObj
, i
, &value
);
7767 /* In case our first try results in EOF, we will leave */
7768 if (scanned
== -1 && i
== 0)
7770 /* Advance next pos-to-be-scanned for the amount scanned already */
7772 /* value == 0 means no conversion took place so take empty string */
7774 value
= Jim_NewEmptyStringObj(interp
);
7775 /* If value is a non-assignable one, skip it */
7776 if (descr
->pos
== -1) {
7777 Jim_FreeNewObj(interp
, value
);
7778 } else if (descr
->pos
== 0)
7779 /* Otherwise append it to the result list if no XPG3 was given */
7780 Jim_ListAppendElement(interp
, resultList
, value
);
7781 else if (resultVec
[descr
->pos
-1] == emptyStr
) {
7782 /* But due to given XPG3, put the value into the corr. slot */
7783 Jim_DecrRefCount(interp
, resultVec
[descr
->pos
-1]);
7784 Jim_IncrRefCount(value
);
7785 resultVec
[descr
->pos
-1] = value
;
7787 /* Otherwise, the slot was already used - free obj and ERROR */
7788 Jim_FreeNewObj(interp
, value
);
7792 Jim_DecrRefCount(interp
, emptyStr
);
7795 Jim_DecrRefCount(interp
, emptyStr
);
7796 Jim_FreeNewObj(interp
, resultList
);
7797 return (Jim_Obj
*)EOF
;
7799 Jim_DecrRefCount(interp
, emptyStr
);
7800 Jim_FreeNewObj(interp
, resultList
);
7804 /* -----------------------------------------------------------------------------
7805 * Pseudo Random Number Generation
7806 * ---------------------------------------------------------------------------*/
7807 static void JimPrngSeed(Jim_Interp
*interp
, const unsigned char *seed
,
7810 /* Initialize the sbox with the numbers from 0 to 255 */
7811 static void JimPrngInit(Jim_Interp
*interp
)
7814 unsigned int seed
[256];
7816 interp
->prngState
= Jim_Alloc(sizeof(Jim_PrngState
));
7817 for (i
= 0; i
< 256; i
++)
7818 seed
[i
] = (rand() ^ time(NULL
) ^ clock());
7819 JimPrngSeed(interp
, (unsigned char*) seed
, sizeof(int)*256);
7822 /* Generates N bytes of random data */
7823 static void JimRandomBytes(Jim_Interp
*interp
, void *dest
, unsigned int len
)
7825 Jim_PrngState
*prng
;
7826 unsigned char *destByte
= (unsigned char*) dest
;
7827 unsigned int si
, sj
, x
;
7829 /* initialization, only needed the first time */
7830 if (interp
->prngState
== NULL
)
7831 JimPrngInit(interp
);
7832 prng
= interp
->prngState
;
7833 /* generates 'len' bytes of pseudo-random numbers */
7834 for (x
= 0; x
< len
; x
++) {
7835 prng
->i
= (prng
->i
+1) & 0xff;
7836 si
= prng
->sbox
[prng
->i
];
7837 prng
->j
= (prng
->j
+ si
) & 0xff;
7838 sj
= prng
->sbox
[prng
->j
];
7839 prng
->sbox
[prng
->i
] = sj
;
7840 prng
->sbox
[prng
->j
] = si
;
7841 *destByte
++ = prng
->sbox
[(si
+sj
)&0xff];
7845 /* Re-seed the generator with user-provided bytes */
7846 static void JimPrngSeed(Jim_Interp
*interp
, const unsigned char *seed
,
7850 unsigned char buf
[256];
7851 Jim_PrngState
*prng
;
7853 /* initialization, only needed the first time */
7854 if (interp
->prngState
== NULL
)
7855 JimPrngInit(interp
);
7856 prng
= interp
->prngState
;
7858 /* Set the sbox[i] with i */
7859 for (i
= 0; i
< 256; i
++)
7861 /* Now use the seed to perform a random permutation of the sbox */
7862 for (i
= 0; i
< seedLen
; i
++) {
7865 t
= prng
->sbox
[i
&0xFF];
7866 prng
->sbox
[i
&0xFF] = prng
->sbox
[seed
[i
]];
7867 prng
->sbox
[seed
[i
]] = t
;
7869 prng
->i
= prng
->j
= 0;
7870 /* discard the first 256 bytes of stream. */
7871 JimRandomBytes(interp
, buf
, 256);
7874 /* -----------------------------------------------------------------------------
7875 * Dynamic libraries support (WIN32 not supported)
7876 * ---------------------------------------------------------------------------*/
7881 void * dlopen(const char *path
, int mode
)
7885 return (void *)LoadLibraryA(path
);
7887 int dlclose(void *handle
)
7889 FreeLibrary((HANDLE
)handle
);
7892 void *dlsym(void *handle
, const char *symbol
)
7894 return GetProcAddress((HMODULE
)handle
, symbol
);
7896 static char win32_dlerror_string
[121];
7897 const char *dlerror(void)
7899 FormatMessageA(FORMAT_MESSAGE_FROM_SYSTEM
, NULL
, GetLastError(),
7900 LANG_NEUTRAL
, win32_dlerror_string
, 120, NULL
);
7901 return win32_dlerror_string
;
7905 int Jim_LoadLibrary(Jim_Interp
*interp
, const char *pathName
)
7907 Jim_Obj
*libPathObjPtr
;
7910 int (*onload
)(Jim_Interp
*interp
);
7912 libPathObjPtr
= Jim_GetGlobalVariableStr(interp
, "jim_libpath", JIM_NONE
);
7913 if (libPathObjPtr
== NULL
) {
7915 libPathObjPtr
= NULL
;
7917 Jim_IncrRefCount(libPathObjPtr
);
7918 Jim_ListLength(interp
, libPathObjPtr
, &prefixc
);
7921 for (i
= -1; i
< prefixc
; i
++) {
7923 handle
= dlopen(pathName
, RTLD_LAZY
);
7926 char buf
[JIM_PATH_LEN
];
7929 Jim_Obj
*prefixObjPtr
;
7932 if (Jim_ListIndex(interp
, libPathObjPtr
, i
,
7933 &prefixObjPtr
, JIM_NONE
) != JIM_OK
)
7935 prefix
= Jim_GetString(prefixObjPtr
, &prefixlen
);
7936 if (prefixlen
+strlen(pathName
)+1 >= JIM_PATH_LEN
)
7938 if (*pathName
== '/') {
7939 strcpy(buf
, pathName
);
7941 else if (prefixlen
&& prefix
[prefixlen
-1] == '/')
7942 sprintf(buf
, "%s%s", prefix
, pathName
);
7944 sprintf(buf
, "%s/%s", prefix
, pathName
);
7945 fp
= fopen(buf
, "r");
7949 handle
= dlopen(buf
, RTLD_LAZY
);
7951 if (handle
== NULL
) {
7952 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
7953 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
7954 "error loading extension \"", pathName
,
7955 "\": ", dlerror(), NULL
);
7960 if ((onload
= dlsym(handle
, "Jim_OnLoad")) == NULL
) {
7961 Jim_SetResultString(interp
,
7962 "No Jim_OnLoad symbol found on extension", -1);
7965 if (onload(interp
) == JIM_ERR
) {
7969 Jim_SetEmptyResult(interp
);
7970 if (libPathObjPtr
!= NULL
)
7971 Jim_DecrRefCount(interp
, libPathObjPtr
);
7975 if (libPathObjPtr
!= NULL
)
7976 Jim_DecrRefCount(interp
, libPathObjPtr
);
7979 #else /* JIM_DYNLIB */
7980 int Jim_LoadLibrary(Jim_Interp
*interp
, const char *pathName
)
7982 JIM_NOTUSED(interp
);
7983 JIM_NOTUSED(pathName
);
7985 Jim_SetResultString(interp
, "the Jim binary has no support for [load]", -1);
7988 #endif/* JIM_DYNLIB */
7990 /* -----------------------------------------------------------------------------
7992 * ---------------------------------------------------------------------------*/
7994 #define JIM_PKG_ANY_VERSION -1
7996 /* Convert a string of the type "1.2" into an integer.
7997 * MAJOR.MINOR is converted as MAJOR*100+MINOR, so "1.2" is converted
7998 * to the integer with value 102 */
7999 static int JimPackageVersionToInt(Jim_Interp
*interp
, const char *v
,
8000 int *intPtr
, int flags
)
8003 jim_wide major
, minor
;
8004 char *majorStr
, *minorStr
, *p
;
8007 *intPtr
= JIM_PKG_ANY_VERSION
;
8011 copy
= Jim_StrDup(v
);
8012 p
= strchr(copy
, '.');
8013 if (p
== NULL
) goto badfmt
;
8018 if (Jim_StringToWide(majorStr
, &major
, 10) != JIM_OK
||
8019 Jim_StringToWide(minorStr
, &minor
, 10) != JIM_OK
)
8021 *intPtr
= (int)(major
*100+minor
);
8027 if (flags
& JIM_ERRMSG
) {
8028 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
8029 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
8030 "invalid package version '", v
, "'", NULL
);
8035 #define JIM_MATCHVER_EXACT (1<<JIM_PRIV_FLAG_SHIFT)
8036 static int JimPackageMatchVersion(int needed
, int actual
, int flags
)
8038 if (needed
== JIM_PKG_ANY_VERSION
) return 1;
8039 if (flags
& JIM_MATCHVER_EXACT
) {
8040 return needed
== actual
;
8042 return needed
/100 == actual
/100 && (needed
<= actual
);
8046 int Jim_PackageProvide(Jim_Interp
*interp
, const char *name
, const char *ver
,
8050 /* Check if the version format is ok */
8051 if (JimPackageVersionToInt(interp
, ver
, &intVersion
, JIM_ERRMSG
) != JIM_OK
)
8053 /* If the package was already provided returns an error. */
8054 if (Jim_FindHashEntry(&interp
->packages
, name
) != NULL
) {
8055 if (flags
& JIM_ERRMSG
) {
8056 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
8057 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
8058 "package '", name
, "' was already provided", NULL
);
8062 Jim_AddHashEntry(&interp
->packages
, name
, (char*) ver
);
8069 # include <sys/types.h>
8070 # include <dirent.h>
8073 /* Posix dirent.h compatiblity layer for WIN32.
8074 * Copyright Kevlin Henney, 1997, 2003. All rights reserved.
8075 * Copyright Salvatore Sanfilippo ,2005.
8077 * Permission to use, copy, modify, and distribute this software and its
8078 * documentation for any purpose is hereby granted without fee, provided
8079 * that this copyright and permissions notice appear in all copies and
8082 * This software is supplied "as is" without express or implied warranty.
8083 * This software was modified by Salvatore Sanfilippo for the Jim Interpreter.
8090 typedef struct DIR {
8091 long handle
; /* -1 for failed rewind */
8092 struct _finddata_t info
;
8093 struct dirent result
; /* d_name null iff first time */
8094 char *name
; /* null-terminated char string */
8097 DIR *opendir(const char *name
)
8101 if(name
&& name
[0]) {
8102 size_t base_length
= strlen(name
);
8103 const char *all
= /* search pattern must end with suitable wildcard */
8104 strchr("/\\", name
[base_length
- 1]) ? "*" : "/*";
8106 if((dir
= (DIR *) Jim_Alloc(sizeof *dir
)) != 0 &&
8107 (dir
->name
= (char *) Jim_Alloc(base_length
+ strlen(all
) + 1)) != 0)
8109 strcat(strcpy(dir
->name
, name
), all
);
8111 if((dir
->handle
= (long) _findfirst(dir
->name
, &dir
->info
)) != -1)
8112 dir
->result
.d_name
= 0;
8113 else { /* rollback */
8114 Jim_Free(dir
->name
);
8118 } else { /* rollback */
8129 int closedir(DIR *dir
)
8134 if(dir
->handle
!= -1)
8135 result
= _findclose(dir
->handle
);
8136 Jim_Free(dir
->name
);
8139 if(result
== -1) /* map all errors to EBADF */
8144 struct dirent
*readdir(DIR *dir
)
8146 struct dirent
*result
= 0;
8148 if(dir
&& dir
->handle
!= -1) {
8149 if(!dir
->result
.d_name
|| _findnext(dir
->handle
, &dir
->info
) != -1) {
8150 result
= &dir
->result
;
8151 result
->d_name
= dir
->info
.name
;
8161 static char *JimFindBestPackage(Jim_Interp
*interp
, char **prefixes
,
8162 int prefixc
, const char *pkgName
, int pkgVer
, int flags
)
8164 int bestVer
= -1, i
;
8165 int pkgNameLen
= strlen(pkgName
);
8166 char *bestPackage
= NULL
;
8169 for (i
= 0; i
< prefixc
; i
++) {
8171 char buf
[JIM_PATH_LEN
];
8174 if (prefixes
[i
] == NULL
) continue;
8175 strncpy(buf
, prefixes
[i
], JIM_PATH_LEN
);
8176 buf
[JIM_PATH_LEN
-1] = '\0';
8177 prefixLen
= strlen(buf
);
8178 if (prefixLen
&& buf
[prefixLen
-1] == '/')
8179 buf
[prefixLen
-1] = '\0';
8181 if ((dir
= opendir(buf
)) == NULL
) continue;
8182 while ((de
= readdir(dir
)) != NULL
) {
8183 char *fileName
= de
->d_name
;
8184 int fileNameLen
= strlen(fileName
);
8186 if (strncmp(fileName
, "jim-", 4) == 0 &&
8187 strncmp(fileName
+4, pkgName
, pkgNameLen
) == 0 &&
8188 *(fileName
+4+pkgNameLen
) == '-' &&
8189 fileNameLen
> 4 && /* note that this is not really useful */
8190 (strncmp(fileName
+fileNameLen
-4, ".tcl", 4) == 0 ||
8191 strncmp(fileName
+fileNameLen
-4, ".dll", 4) == 0 ||
8192 strncmp(fileName
+fileNameLen
-3, ".so", 3) == 0))
8194 char ver
[6]; /* xx.yy<nulterm> */
8195 char *p
= strrchr(fileName
, '.');
8196 int verLen
, fileVer
;
8198 verLen
= p
- (fileName
+4+pkgNameLen
+1);
8199 if (verLen
< 3 || verLen
> 5) continue;
8200 memcpy(ver
, fileName
+4+pkgNameLen
+1, verLen
);
8202 if (JimPackageVersionToInt(interp
, ver
, &fileVer
, JIM_NONE
)
8203 != JIM_OK
) continue;
8204 if (JimPackageMatchVersion(pkgVer
, fileVer
, flags
) &&
8205 (bestVer
== -1 || bestVer
< fileVer
))
8208 Jim_Free(bestPackage
);
8209 bestPackage
= Jim_Alloc(strlen(buf
)+strlen(fileName
)+2);
8210 sprintf(bestPackage
, "%s/%s", buf
, fileName
);
8219 #else /* JIM_ANSIC */
8221 static char *JimFindBestPackage(Jim_Interp
*interp
, char **prefixes
,
8222 int prefixc
, const char *pkgName
, int pkgVer
, int flags
)
8224 JIM_NOTUSED(interp
);
8225 JIM_NOTUSED(prefixes
);
8226 JIM_NOTUSED(prefixc
);
8227 JIM_NOTUSED(pkgName
);
8228 JIM_NOTUSED(pkgVer
);
8233 #endif /* JIM_ANSIC */
8235 /* Search for a suitable package under every dir specified by jim_libpath
8236 * and load it if possible. If a suitable package was loaded with success
8237 * JIM_OK is returned, otherwise JIM_ERR is returned. */
8238 static int JimLoadPackage(Jim_Interp
*interp
, const char *name
, int ver
,
8241 Jim_Obj
*libPathObjPtr
;
8242 char **prefixes
, *best
;
8243 int prefixc
, i
, retCode
= JIM_OK
;
8245 libPathObjPtr
= Jim_GetGlobalVariableStr(interp
, "jim_libpath", JIM_NONE
);
8246 if (libPathObjPtr
== NULL
) {
8248 libPathObjPtr
= NULL
;
8250 Jim_IncrRefCount(libPathObjPtr
);
8251 Jim_ListLength(interp
, libPathObjPtr
, &prefixc
);
8254 prefixes
= Jim_Alloc(sizeof(char*)*prefixc
);
8255 for (i
= 0; i
< prefixc
; i
++) {
8256 Jim_Obj
*prefixObjPtr
;
8257 if (Jim_ListIndex(interp
, libPathObjPtr
, i
,
8258 &prefixObjPtr
, JIM_NONE
) != JIM_OK
)
8263 prefixes
[i
] = Jim_StrDup(Jim_GetString(prefixObjPtr
, NULL
));
8265 /* Scan every directory to find the "best" package. */
8266 best
= JimFindBestPackage(interp
, prefixes
, prefixc
, name
, ver
, flags
);
8268 char *p
= strrchr(best
, '.');
8269 /* Try to load/source it */
8270 if (p
&& strcmp(p
, ".tcl") == 0) {
8271 retCode
= Jim_EvalFile(interp
, best
);
8273 retCode
= Jim_LoadLibrary(interp
, best
);
8279 for (i
= 0; i
< prefixc
; i
++)
8280 Jim_Free(prefixes
[i
]);
8283 Jim_DecrRefCount(interp
, libPathObjPtr
);
8287 const char *Jim_PackageRequire(Jim_Interp
*interp
, const char *name
,
8288 const char *ver
, int flags
)
8293 /* Start with an empty error string */
8294 Jim_SetResultString(interp
, "", 0);
8296 if (JimPackageVersionToInt(interp
, ver
, &requiredVer
, JIM_ERRMSG
) != JIM_OK
)
8298 he
= Jim_FindHashEntry(&interp
->packages
, name
);
8300 /* Try to load the package. */
8301 if (JimLoadPackage(interp
, name
, requiredVer
, flags
) == JIM_OK
) {
8302 he
= Jim_FindHashEntry(&interp
->packages
, name
);
8308 /* No way... return an error. */
8309 if (flags
& JIM_ERRMSG
) {
8311 Jim_GetString(Jim_GetResult(interp
), &len
);
8312 Jim_AppendStrings(interp
, Jim_GetResult(interp
), len
? "\n" : "",
8313 "Can't find package '", name
, "'", NULL
);
8318 if (JimPackageVersionToInt(interp
, he
->val
, &actualVer
, JIM_ERRMSG
)
8323 /* Check if version matches. */
8324 if (JimPackageMatchVersion(requiredVer
, actualVer
, flags
) == 0) {
8325 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
8326 "Package '", name
, "' already loaded, but with version ",
8334 /* -----------------------------------------------------------------------------
8336 * ---------------------------------------------------------------------------*/
8337 #define JIM_EVAL_SARGV_LEN 8 /* static arguments vector length */
8338 #define JIM_EVAL_SINTV_LEN 8 /* static interpolation vector length */
8340 static int JimCallProcedure(Jim_Interp
*interp
, Jim_Cmd
*cmd
, int argc
,
8341 Jim_Obj
*const *argv
);
8343 /* Handle calls to the [unknown] command */
8344 static int JimUnknown(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
8346 Jim_Obj
**v
, *sv
[JIM_EVAL_SARGV_LEN
];
8349 /* If JimUnknown() is recursively called (e.g. error in the unknown proc,
8352 if (interp
->unknown_called
) {
8356 /* If the [unknown] command does not exists returns
8358 if (Jim_GetCommand(interp
, interp
->unknown
, JIM_NONE
) == NULL
)
8361 /* The object interp->unknown just contains
8362 * the "unknown" string, it is used in order to
8363 * avoid to lookup the unknown command every time
8364 * but instread to cache the result. */
8365 if (argc
+1 <= JIM_EVAL_SARGV_LEN
)
8368 v
= Jim_Alloc(sizeof(Jim_Obj
*)*(argc
+1));
8369 /* Make a copy of the arguments vector, but shifted on
8370 * the right of one position. The command name of the
8371 * command will be instead the first argument of the
8372 * [unknonw] call. */
8373 memcpy(v
+1, argv
, sizeof(Jim_Obj
*)*argc
);
8374 v
[0] = interp
->unknown
;
8376 interp
->unknown_called
++;
8377 retCode
= Jim_EvalObjVector(interp
, argc
+1, v
);
8378 interp
->unknown_called
--;
8386 /* Eval the object vector 'objv' composed of 'objc' elements.
8387 * Every element is used as single argument.
8388 * Jim_EvalObj() will call this function every time its object
8389 * argument is of "list" type, with no string representation.
8391 * This is possible because the string representation of a
8392 * list object generated by the UpdateStringOfList is made
8393 * in a way that ensures that every list element is a different
8394 * command argument. */
8395 int Jim_EvalObjVector(Jim_Interp
*interp
, int objc
, Jim_Obj
*const *objv
)
8400 /* Incr refcount of arguments. */
8401 for (i
= 0; i
< objc
; i
++)
8402 Jim_IncrRefCount(objv
[i
]);
8403 /* Command lookup */
8404 cmdPtr
= Jim_GetCommand(interp
, objv
[0], JIM_ERRMSG
);
8405 if (cmdPtr
== NULL
) {
8406 retcode
= JimUnknown(interp
, objc
, objv
);
8408 /* Call it -- Make sure result is an empty object. */
8409 Jim_SetEmptyResult(interp
);
8410 if (cmdPtr
->cmdProc
) {
8411 interp
->cmdPrivData
= cmdPtr
->privData
;
8412 retcode
= cmdPtr
->cmdProc(interp
, objc
, objv
);
8413 if (retcode
== JIM_ERR_ADDSTACK
) {
8414 //JimAppendStackTrace(interp, "", script->fileName, token[i-argc*2].linenr);
8418 retcode
= JimCallProcedure(interp
, cmdPtr
, objc
, objv
);
8419 if (retcode
== JIM_ERR
) {
8420 JimAppendStackTrace(interp
,
8421 Jim_GetString(objv
[0], NULL
), "", 1);
8425 /* Decr refcount of arguments and return the retcode */
8426 for (i
= 0; i
< objc
; i
++)
8427 Jim_DecrRefCount(interp
, objv
[i
]);
8431 /* Interpolate the given tokens into a unique Jim_Obj returned by reference
8432 * via *objPtrPtr. This function is only called by Jim_EvalObj().
8433 * The returned object has refcount = 0. */
8434 int Jim_InterpolateTokens(Jim_Interp
*interp
, ScriptToken
*token
,
8435 int tokens
, Jim_Obj
**objPtrPtr
)
8437 int totlen
= 0, i
, retcode
;
8439 Jim_Obj
*sintv
[JIM_EVAL_SINTV_LEN
];
8443 if (tokens
<= JIM_EVAL_SINTV_LEN
)
8446 intv
= Jim_Alloc(sizeof(Jim_Obj
*)*
8448 /* Compute every token forming the argument
8449 * in the intv objects vector. */
8450 for (i
= 0; i
< tokens
; i
++) {
8451 switch(token
[i
].type
) {
8454 intv
[i
] = token
[i
].objPtr
;
8457 intv
[i
] = Jim_GetVariable(interp
, token
[i
].objPtr
, JIM_ERRMSG
);
8463 case JIM_TT_DICTSUGAR
:
8464 intv
[i
] = Jim_ExpandDictSugar(interp
, token
[i
].objPtr
);
8471 retcode
= Jim_EvalObj(interp
, token
[i
].objPtr
);
8472 if (retcode
!= JIM_OK
)
8474 intv
[i
] = Jim_GetResult(interp
);
8478 "default token type reached "
8479 "in Jim_InterpolateTokens().");
8482 Jim_IncrRefCount(intv
[i
]);
8483 /* Make sure there is a valid
8484 * string rep, and add the string
8485 * length to the total legnth. */
8486 Jim_GetString(intv
[i
], NULL
);
8487 totlen
+= intv
[i
]->length
;
8489 /* Concatenate every token in an unique
8491 objPtr
= Jim_NewStringObjNoAlloc(interp
,
8493 s
= objPtr
->bytes
= Jim_Alloc(totlen
+1);
8494 objPtr
->length
= totlen
;
8495 for (i
= 0; i
< tokens
; i
++) {
8496 memcpy(s
, intv
[i
]->bytes
, intv
[i
]->length
);
8497 s
+= intv
[i
]->length
;
8498 Jim_DecrRefCount(interp
, intv
[i
]);
8500 objPtr
->bytes
[totlen
] = '\0';
8501 /* Free the intv vector if not static. */
8502 if (tokens
> JIM_EVAL_SINTV_LEN
)
8504 *objPtrPtr
= objPtr
;
8509 Jim_DecrRefCount(interp
, intv
[i
]);
8510 if (tokens
> JIM_EVAL_SINTV_LEN
)
8515 /* Helper of Jim_EvalObj() to perform argument expansion.
8516 * Basically this function append an argument to 'argv'
8517 * (and increments argc by reference accordingly), performing
8518 * expansion of the list object if 'expand' is non-zero, or
8519 * just adding objPtr to argv if 'expand' is zero. */
8520 void Jim_ExpandArgument(Jim_Interp
*interp
, Jim_Obj
***argv
,
8521 int *argcPtr
, int expand
, Jim_Obj
*objPtr
)
8524 (*argv
) = Jim_Realloc(*argv
, sizeof(Jim_Obj
*)*((*argcPtr
)+1));
8525 /* refcount of objPtr not incremented because
8526 * we are actually transfering a reference from
8527 * the old 'argv' to the expanded one. */
8528 (*argv
)[*argcPtr
] = objPtr
;
8533 Jim_ListLength(interp
, objPtr
, &len
);
8534 (*argv
) = Jim_Realloc(*argv
, sizeof(Jim_Obj
*)*((*argcPtr
)+len
));
8535 for (i
= 0; i
< len
; i
++) {
8536 (*argv
)[*argcPtr
] = objPtr
->internalRep
.listValue
.ele
[i
];
8537 Jim_IncrRefCount(objPtr
->internalRep
.listValue
.ele
[i
]);
8540 /* The original object reference is no longer needed,
8541 * after the expansion it is no longer present on
8542 * the argument vector, but the single elements are
8544 Jim_DecrRefCount(interp
, objPtr
);
8548 int Jim_EvalObj(Jim_Interp
*interp
, Jim_Obj
*scriptObjPtr
)
8553 int *cs
; /* command structure array */
8554 int retcode
= JIM_OK
;
8555 Jim_Obj
*sargv
[JIM_EVAL_SARGV_LEN
], **argv
= NULL
, *tmpObjPtr
;
8557 interp
->errorFlag
= 0;
8559 /* If the object is of type "list" and there is no
8560 * string representation for this object, we can call
8561 * a specialized version of Jim_EvalObj() */
8562 if (scriptObjPtr
->typePtr
== &listObjType
&&
8563 scriptObjPtr
->internalRep
.listValue
.len
&&
8564 scriptObjPtr
->bytes
== NULL
) {
8565 Jim_IncrRefCount(scriptObjPtr
);
8566 retcode
= Jim_EvalObjVector(interp
,
8567 scriptObjPtr
->internalRep
.listValue
.len
,
8568 scriptObjPtr
->internalRep
.listValue
.ele
);
8569 Jim_DecrRefCount(interp
, scriptObjPtr
);
8573 Jim_IncrRefCount(scriptObjPtr
); /* Make sure it's shared. */
8574 script
= Jim_GetScript(interp
, scriptObjPtr
);
8575 /* Now we have to make sure the internal repr will not be
8576 * freed on shimmering.
8578 * Think for example to this:
8580 * set x {llength $x; ... some more code ...}; eval $x
8582 * In order to preserve the internal rep, we increment the
8583 * inUse field of the script internal rep structure. */
8586 token
= script
->token
;
8588 cs
= script
->cmdStruct
;
8589 i
= 0; /* 'i' is the current token index. */
8591 /* Reset the interpreter result. This is useful to
8592 * return the emtpy result in the case of empty program. */
8593 Jim_SetEmptyResult(interp
);
8595 /* Execute every command sequentially, returns on
8596 * error (i.e. if a command does not return JIM_OK) */
8599 int argc
= *cs
++; /* Get the number of arguments */
8602 /* Set the expand flag if needed. */
8607 /* Allocate the arguments vector */
8608 if (argc
<= JIM_EVAL_SARGV_LEN
)
8611 argv
= Jim_Alloc(sizeof(Jim_Obj
*)*argc
);
8612 /* Populate the arguments objects. */
8613 for (j
= 0; j
< argc
; j
++) {
8616 /* tokens is negative if expansion is needed.
8617 * for this argument. */
8619 tokens
= (-tokens
)-1;
8623 /* Fast path if the token does not
8624 * need interpolation */
8625 switch(token
[i
].type
) {
8628 argv
[j
] = token
[i
].objPtr
;
8631 tmpObjPtr
= Jim_GetVariable(interp
, token
[i
].objPtr
,
8637 argv
[j
] = tmpObjPtr
;
8639 case JIM_TT_DICTSUGAR
:
8640 tmpObjPtr
= Jim_ExpandDictSugar(interp
, token
[i
].objPtr
);
8645 argv
[j
] = tmpObjPtr
;
8648 retcode
= Jim_EvalObj(interp
, token
[i
].objPtr
);
8649 if (retcode
!= JIM_OK
)
8651 argv
[j
] = Jim_GetResult(interp
);
8655 "default token type reached "
8656 "in Jim_EvalObj().");
8659 Jim_IncrRefCount(argv
[j
]);
8662 /* For interpolation we call an helper
8663 * function doing the work for us. */
8664 if ((retcode
= Jim_InterpolateTokens(interp
,
8665 token
+i
, tokens
, &tmpObjPtr
)) != JIM_OK
)
8669 argv
[j
] = tmpObjPtr
;
8670 Jim_IncrRefCount(argv
[j
]);
8674 /* Handle {expand} expansion */
8676 int *ecs
= cs
- argc
;
8678 Jim_Obj
**eargv
= NULL
;
8680 for (j
= 0; j
< argc
; j
++) {
8681 Jim_ExpandArgument( interp
, &eargv
, &eargc
,
8682 ecs
[j
] < 0, argv
[j
]);
8690 /* Nothing to do with zero args. */
8695 /* Lookup the command to call */
8696 cmd
= Jim_GetCommand(interp
, argv
[0], JIM_ERRMSG
);
8698 /* Call it -- Make sure result is an empty object. */
8699 Jim_SetEmptyResult(interp
);
8701 interp
->cmdPrivData
= cmd
->privData
;
8702 retcode
= cmd
->cmdProc(interp
, argc
, argv
);
8703 if ((retcode
== JIM_ERR
)||(retcode
== JIM_ERR_ADDSTACK
)) {
8704 JimAppendStackTrace(interp
, "", script
->fileName
, token
[i
-argc
*2].linenr
);
8708 retcode
= JimCallProcedure(interp
, cmd
, argc
, argv
);
8709 if (retcode
== JIM_ERR
) {
8710 JimAppendStackTrace(interp
,
8711 Jim_GetString(argv
[0], NULL
), script
->fileName
,
8712 token
[i
-argc
*2].linenr
);
8716 /* Call [unknown] */
8717 retcode
= JimUnknown(interp
, argc
, argv
);
8718 if (retcode
== JIM_ERR
) {
8719 JimAppendStackTrace(interp
,
8720 "", script
->fileName
,
8721 token
[i
-argc
*2].linenr
);
8724 if (retcode
!= JIM_OK
) {
8725 i
-= argc
*2; /* point to the command name. */
8728 /* Decrement the arguments count */
8729 for (j
= 0; j
< argc
; j
++) {
8730 Jim_DecrRefCount(interp
, argv
[j
]);
8733 if (argv
!= sargv
) {
8738 /* Note that we don't have to decrement inUse, because the
8739 * following code transfers our use of the reference again to
8740 * the script object. */
8741 j
= 0; /* on normal termination, the argv array is already
8742 Jim_DecrRefCount-ed. */
8744 /* Handle errors. */
8745 if (retcode
== JIM_ERR
&& !interp
->errorFlag
) {
8746 interp
->errorFlag
= 1;
8747 JimSetErrorFileName(interp
, script
->fileName
);
8748 JimSetErrorLineNumber(interp
, token
[i
].linenr
);
8749 JimResetStackTrace(interp
);
8751 Jim_FreeIntRep(interp
, scriptObjPtr
);
8752 scriptObjPtr
->typePtr
= &scriptObjType
;
8753 Jim_SetIntRepPtr(scriptObjPtr
, script
);
8754 Jim_DecrRefCount(interp
, scriptObjPtr
);
8755 for (i
= 0; i
< j
; i
++) {
8756 Jim_DecrRefCount(interp
, argv
[i
]);
8763 /* Call a procedure implemented in Tcl.
8764 * It's possible to speed-up a lot this function, currently
8765 * the callframes are not cached, but allocated and
8766 * destroied every time. What is expecially costly is
8767 * to create/destroy the local vars hash table every time.
8769 * This can be fixed just implementing callframes caching
8770 * in JimCreateCallFrame() and JimFreeCallFrame(). */
8771 int JimCallProcedure(Jim_Interp
*interp
, Jim_Cmd
*cmd
, int argc
,
8772 Jim_Obj
*const *argv
)
8775 Jim_CallFrame
*callFramePtr
;
8779 if (argc
< cmd
->arityMin
|| (cmd
->arityMax
!= -1 &&
8780 argc
> cmd
->arityMax
)) {
8781 Jim_Obj
*objPtr
= Jim_NewEmptyStringObj(interp
);
8782 Jim_AppendStrings(interp
, objPtr
,
8783 "wrong # args: should be \"", Jim_GetString(argv
[0], NULL
),
8784 (cmd
->arityMin
> 1) ? " " : "",
8785 Jim_GetString(cmd
->argListObjPtr
, NULL
), "\"", NULL
);
8786 Jim_SetResult(interp
, objPtr
);
8789 /* Check if there are too nested calls */
8790 if (interp
->numLevels
== interp
->maxNestingDepth
) {
8791 Jim_SetResultString(interp
,
8792 "Too many nested calls. Infinite recursion?", -1);
8795 /* Create a new callframe */
8796 callFramePtr
= JimCreateCallFrame(interp
);
8797 callFramePtr
->parentCallFrame
= interp
->framePtr
;
8798 callFramePtr
->argv
= argv
;
8799 callFramePtr
->argc
= argc
;
8800 callFramePtr
->procArgsObjPtr
= cmd
->argListObjPtr
;
8801 callFramePtr
->procBodyObjPtr
= cmd
->bodyObjPtr
;
8802 callFramePtr
->staticVars
= cmd
->staticVars
;
8803 Jim_IncrRefCount(cmd
->argListObjPtr
);
8804 Jim_IncrRefCount(cmd
->bodyObjPtr
);
8805 interp
->framePtr
= callFramePtr
;
8806 interp
->numLevels
++;
8809 Jim_ListLength(interp
, cmd
->argListObjPtr
, &num_args
);
8811 /* If last argument is 'args', don't set it here */
8812 if (cmd
->arityMax
== -1) {
8816 for (i
= 0; i
< num_args
; i
++) {
8818 Jim_Obj
*nameObjPtr
;
8819 Jim_Obj
*valueObjPtr
;
8821 Jim_ListIndex(interp
, cmd
->argListObjPtr
, i
, &argObjPtr
, JIM_NONE
);
8822 if (i
+ 1 >= cmd
->arityMin
) {
8823 /* The name is the first element of the list */
8824 Jim_ListIndex(interp
, argObjPtr
, 0, &nameObjPtr
, JIM_NONE
);
8827 /* The element arg is the name */
8828 nameObjPtr
= argObjPtr
;
8831 if (i
+ 1 >= argc
) {
8832 /* No more values, so use default */
8833 /* The value is the second element of the list */
8834 Jim_ListIndex(interp
, argObjPtr
, 1, &valueObjPtr
, JIM_NONE
);
8837 valueObjPtr
= argv
[i
+1];
8839 Jim_SetVariable(interp
, nameObjPtr
, valueObjPtr
);
8841 /* Set optional arguments */
8842 if (cmd
->arityMax
== -1) {
8843 Jim_Obj
*listObjPtr
, *objPtr
;
8846 listObjPtr
= Jim_NewListObj(interp
, argv
+i
, argc
-i
);
8847 Jim_ListIndex(interp
, cmd
->argListObjPtr
, num_args
, &objPtr
, JIM_NONE
);
8848 Jim_SetVariable(interp
, objPtr
, listObjPtr
);
8851 retcode
= Jim_EvalObj(interp
, cmd
->bodyObjPtr
);
8853 /* Destroy the callframe */
8854 interp
->numLevels
--;
8855 interp
->framePtr
= interp
->framePtr
->parentCallFrame
;
8856 if (callFramePtr
->vars
.size
!= JIM_HT_INITIAL_SIZE
) {
8857 JimFreeCallFrame(interp
, callFramePtr
, JIM_FCF_NONE
);
8859 JimFreeCallFrame(interp
, callFramePtr
, JIM_FCF_NOHT
);
8861 /* Handle the JIM_EVAL return code */
8862 if (retcode
== JIM_EVAL
&& interp
->evalRetcodeLevel
!= interp
->numLevels
) {
8863 int savedLevel
= interp
->evalRetcodeLevel
;
8865 interp
->evalRetcodeLevel
= interp
->numLevels
;
8866 while (retcode
== JIM_EVAL
) {
8867 Jim_Obj
*resultScriptObjPtr
= Jim_GetResult(interp
);
8868 Jim_IncrRefCount(resultScriptObjPtr
);
8869 retcode
= Jim_EvalObj(interp
, resultScriptObjPtr
);
8870 Jim_DecrRefCount(interp
, resultScriptObjPtr
);
8872 interp
->evalRetcodeLevel
= savedLevel
;
8874 /* Handle the JIM_RETURN return code */
8875 if (retcode
== JIM_RETURN
) {
8876 retcode
= interp
->returnCode
;
8877 interp
->returnCode
= JIM_OK
;
8882 int Jim_Eval_Named(Jim_Interp
*interp
, const char *script
, const char *filename
, int lineno
)
8885 Jim_Obj
*scriptObjPtr
;
8887 scriptObjPtr
= Jim_NewStringObj(interp
, script
, -1);
8888 Jim_IncrRefCount(scriptObjPtr
);
8892 JimSetSourceInfo( interp
, scriptObjPtr
, filename
, lineno
);
8895 retval
= Jim_EvalObj(interp
, scriptObjPtr
);
8896 Jim_DecrRefCount(interp
, scriptObjPtr
);
8900 int Jim_Eval(Jim_Interp
*interp
, const char *script
)
8902 return Jim_Eval_Named( interp
, script
, NULL
, 0 );
8907 /* Execute script in the scope of the global level */
8908 int Jim_EvalGlobal(Jim_Interp
*interp
, const char *script
)
8910 Jim_CallFrame
*savedFramePtr
;
8913 savedFramePtr
= interp
->framePtr
;
8914 interp
->framePtr
= interp
->topFramePtr
;
8915 retval
= Jim_Eval(interp
, script
);
8916 interp
->framePtr
= savedFramePtr
;
8920 int Jim_EvalObjBackground(Jim_Interp
*interp
, Jim_Obj
*scriptObjPtr
)
8922 Jim_CallFrame
*savedFramePtr
;
8925 savedFramePtr
= interp
->framePtr
;
8926 interp
->framePtr
= interp
->topFramePtr
;
8927 retval
= Jim_EvalObj(interp
, scriptObjPtr
);
8928 interp
->framePtr
= savedFramePtr
;
8929 /* Try to report the error (if any) via the bgerror proc */
8930 if (retval
!= JIM_OK
) {
8933 objv
[0] = Jim_NewStringObj(interp
, "bgerror", -1);
8934 objv
[1] = Jim_GetResult(interp
);
8935 Jim_IncrRefCount(objv
[0]);
8936 Jim_IncrRefCount(objv
[1]);
8937 if (Jim_EvalObjVector(interp
, 2, objv
) != JIM_OK
) {
8938 /* Report the error to stderr. */
8939 Jim_fprintf( interp
, interp
->cookie_stderr
, "Background error:" JIM_NL
);
8940 Jim_PrintErrorMessage(interp
);
8942 Jim_DecrRefCount(interp
, objv
[0]);
8943 Jim_DecrRefCount(interp
, objv
[1]);
8948 int Jim_EvalFile(Jim_Interp
*interp
, const char *filename
)
8952 int nread
, totread
, maxlen
, buflen
;
8954 Jim_Obj
*scriptObjPtr
;
8956 if ((fp
= fopen(filename
, "r")) == NULL
) {
8957 const int cwd_len
=2048;
8958 char *cwd
=malloc(cwd_len
);
8959 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
8960 if (!getcwd( cwd
, cwd_len
)) strcpy(cwd
, "unknown");
8961 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
8962 "Error loading script \"", filename
, "\"",
8964 " err: ", strerror(errno
), NULL
);
8969 maxlen
= totread
= 0;
8971 if (maxlen
< totread
+buflen
+1) {
8972 maxlen
= totread
+buflen
+1;
8973 prg
= Jim_Realloc(prg
, maxlen
);
8975 /* do not use Jim_fread() - this is really a file */
8976 if ((nread
= fread(prg
+totread
, 1, buflen
, fp
)) == 0) break;
8979 prg
[totread
] = '\0';
8980 /* do not use Jim_fclose() - this is really a file */
8983 scriptObjPtr
= Jim_NewStringObjNoAlloc(interp
, prg
, totread
);
8984 JimSetSourceInfo(interp
, scriptObjPtr
, filename
, 1);
8985 Jim_IncrRefCount(scriptObjPtr
);
8986 retval
= Jim_EvalObj(interp
, scriptObjPtr
);
8987 Jim_DecrRefCount(interp
, scriptObjPtr
);
8991 /* -----------------------------------------------------------------------------
8993 * ---------------------------------------------------------------------------*/
8994 static int JimParseSubstStr(struct JimParserCtx
*pc
)
8997 pc
->tline
= pc
->linenr
;
8998 while (*pc
->p
&& *pc
->p
!= '$' && *pc
->p
!= '[') {
9002 pc
->tt
= JIM_TT_ESC
;
9006 static int JimParseSubst(struct JimParserCtx
*pc
, int flags
)
9011 pc
->tstart
= pc
->tend
= pc
->p
;
9012 pc
->tline
= pc
->linenr
;
9013 pc
->tt
= JIM_TT_EOL
;
9019 retval
= JimParseCmd(pc
);
9020 if (flags
& JIM_SUBST_NOCMD
) {
9023 pc
->tt
= (flags
& JIM_SUBST_NOESC
) ?
9024 JIM_TT_STR
: JIM_TT_ESC
;
9029 if (JimParseVar(pc
) == JIM_ERR
) {
9030 pc
->tstart
= pc
->tend
= pc
->p
++; pc
->len
--;
9031 pc
->tline
= pc
->linenr
;
9032 pc
->tt
= JIM_TT_STR
;
9034 if (flags
& JIM_SUBST_NOVAR
) {
9036 if (flags
& JIM_SUBST_NOESC
)
9037 pc
->tt
= JIM_TT_STR
;
9039 pc
->tt
= JIM_TT_ESC
;
9040 if (*pc
->tstart
== '{') {
9049 retval
= JimParseSubstStr(pc
);
9050 if (flags
& JIM_SUBST_NOESC
)
9051 pc
->tt
= JIM_TT_STR
;
9058 /* The subst object type reuses most of the data structures and functions
9059 * of the script object. Script's data structures are a bit more complex
9060 * for what is needed for [subst]itution tasks, but the reuse helps to
9061 * deal with a single data structure at the cost of some more memory
9062 * usage for substitutions. */
9063 static Jim_ObjType substObjType
= {
9065 FreeScriptInternalRep
,
9066 DupScriptInternalRep
,
9068 JIM_TYPE_REFERENCES
,
9071 /* This method takes the string representation of an object
9072 * as a Tcl string where to perform [subst]itution, and generates
9073 * the pre-parsed internal representation. */
9074 int SetSubstFromAny(Jim_Interp
*interp
, struct Jim_Obj
*objPtr
, int flags
)
9077 const char *scriptText
= Jim_GetString(objPtr
, &scriptTextLen
);
9078 struct JimParserCtx parser
;
9079 struct ScriptObj
*script
= Jim_Alloc(sizeof(*script
));
9083 script
->commands
= 0;
9084 script
->token
= NULL
;
9085 script
->cmdStruct
= NULL
;
9087 script
->substFlags
= flags
;
9088 script
->fileName
= NULL
;
9090 JimParserInit(&parser
, scriptText
, scriptTextLen
, 1);
9093 int len
, type
, linenr
;
9095 JimParseSubst(&parser
, flags
);
9096 if (JimParserEof(&parser
)) break;
9097 token
= JimParserGetToken(&parser
, &len
, &type
, &linenr
);
9098 ScriptObjAddToken(interp
, script
, token
, len
, type
,
9101 /* Free the old internal rep and set the new one. */
9102 Jim_FreeIntRep(interp
, objPtr
);
9103 Jim_SetIntRepPtr(objPtr
, script
);
9104 objPtr
->typePtr
= &scriptObjType
;
9108 ScriptObj
*Jim_GetSubst(Jim_Interp
*interp
, Jim_Obj
*objPtr
, int flags
)
9110 struct ScriptObj
*script
= Jim_GetIntRepPtr(objPtr
);
9112 if (objPtr
->typePtr
!= &substObjType
|| script
->substFlags
!= flags
)
9113 SetSubstFromAny(interp
, objPtr
, flags
);
9114 return (ScriptObj
*) Jim_GetIntRepPtr(objPtr
);
9117 /* Performs commands,variables,blackslashes substitution,
9118 * storing the result object (with refcount 0) into
9120 int Jim_SubstObj(Jim_Interp
*interp
, Jim_Obj
*substObjPtr
,
9121 Jim_Obj
**resObjPtrPtr
, int flags
)
9125 int i
, len
, retcode
= JIM_OK
;
9126 Jim_Obj
*resObjPtr
, *savedResultObjPtr
;
9128 script
= Jim_GetSubst(interp
, substObjPtr
, flags
);
9129 #ifdef JIM_OPTIMIZATION
9130 /* Fast path for a very common case with array-alike syntax,
9131 * that's: $foo($bar) */
9132 if (script
->len
== 1 && script
->token
[0].type
== JIM_TT_VAR
) {
9133 Jim_Obj
*varObjPtr
= script
->token
[0].objPtr
;
9135 Jim_IncrRefCount(varObjPtr
);
9136 resObjPtr
= Jim_GetVariable(interp
, varObjPtr
, JIM_ERRMSG
);
9137 if (resObjPtr
== NULL
) {
9138 Jim_DecrRefCount(interp
, varObjPtr
);
9141 Jim_DecrRefCount(interp
, varObjPtr
);
9142 *resObjPtrPtr
= resObjPtr
;
9147 Jim_IncrRefCount(substObjPtr
); /* Make sure it's shared. */
9148 /* In order to preserve the internal rep, we increment the
9149 * inUse field of the script internal rep structure. */
9152 token
= script
->token
;
9155 /* Save the interp old result, to set it again before
9157 savedResultObjPtr
= interp
->result
;
9158 Jim_IncrRefCount(savedResultObjPtr
);
9160 /* Perform the substitution. Starts with an empty object
9161 * and adds every token (performing the appropriate
9162 * var/command/escape substitution). */
9163 resObjPtr
= Jim_NewStringObj(interp
, "", 0);
9164 for (i
= 0; i
< len
; i
++) {
9167 switch(token
[i
].type
) {
9170 Jim_AppendObj(interp
, resObjPtr
, token
[i
].objPtr
);
9173 objPtr
= Jim_GetVariable(interp
, token
[i
].objPtr
, JIM_ERRMSG
);
9174 if (objPtr
== NULL
) goto err
;
9175 Jim_IncrRefCount(objPtr
);
9176 Jim_AppendObj(interp
, resObjPtr
, objPtr
);
9177 Jim_DecrRefCount(interp
, objPtr
);
9179 case JIM_TT_DICTSUGAR
:
9180 objPtr
= Jim_ExpandDictSugar(interp
, token
[i
].objPtr
);
9187 if (Jim_EvalObj(interp
, token
[i
].objPtr
) != JIM_OK
)
9189 Jim_AppendObj(interp
, resObjPtr
, interp
->result
);
9193 "default token type (%d) reached "
9194 "in Jim_SubstObj().", token
[i
].type
);
9199 if (retcode
== JIM_OK
)
9200 Jim_SetResult(interp
, savedResultObjPtr
);
9201 Jim_DecrRefCount(interp
, savedResultObjPtr
);
9202 /* Note that we don't have to decrement inUse, because the
9203 * following code transfers our use of the reference again to
9204 * the script object. */
9205 Jim_FreeIntRep(interp
, substObjPtr
);
9206 substObjPtr
->typePtr
= &scriptObjType
;
9207 Jim_SetIntRepPtr(substObjPtr
, script
);
9208 Jim_DecrRefCount(interp
, substObjPtr
);
9209 *resObjPtrPtr
= resObjPtr
;
9212 Jim_FreeNewObj(interp
, resObjPtr
);
9217 /* -----------------------------------------------------------------------------
9218 * API Input/Export functions
9219 * ---------------------------------------------------------------------------*/
9221 int Jim_GetApi(Jim_Interp
*interp
, const char *funcname
, void *targetPtrPtr
)
9225 he
= Jim_FindHashEntry(&interp
->stub
, funcname
);
9228 memcpy(targetPtrPtr
, &he
->val
, sizeof(void*));
9232 int Jim_RegisterApi(Jim_Interp
*interp
, const char *funcname
, void *funcptr
)
9234 return Jim_AddHashEntry(&interp
->stub
, funcname
, funcptr
);
9237 #define JIM_REGISTER_API(name) \
9238 Jim_RegisterApi(interp, "Jim_" #name, (void *)Jim_ ## name)
9240 void JimRegisterCoreApi(Jim_Interp
*interp
)
9242 interp
->getApiFuncPtr
= Jim_GetApi
;
9243 JIM_REGISTER_API(Alloc
);
9244 JIM_REGISTER_API(Free
);
9245 JIM_REGISTER_API(Eval
);
9246 JIM_REGISTER_API(Eval_Named
);
9247 JIM_REGISTER_API(EvalGlobal
);
9248 JIM_REGISTER_API(EvalFile
);
9249 JIM_REGISTER_API(EvalObj
);
9250 JIM_REGISTER_API(EvalObjBackground
);
9251 JIM_REGISTER_API(EvalObjVector
);
9252 JIM_REGISTER_API(InitHashTable
);
9253 JIM_REGISTER_API(ExpandHashTable
);
9254 JIM_REGISTER_API(AddHashEntry
);
9255 JIM_REGISTER_API(ReplaceHashEntry
);
9256 JIM_REGISTER_API(DeleteHashEntry
);
9257 JIM_REGISTER_API(FreeHashTable
);
9258 JIM_REGISTER_API(FindHashEntry
);
9259 JIM_REGISTER_API(ResizeHashTable
);
9260 JIM_REGISTER_API(GetHashTableIterator
);
9261 JIM_REGISTER_API(NextHashEntry
);
9262 JIM_REGISTER_API(NewObj
);
9263 JIM_REGISTER_API(FreeObj
);
9264 JIM_REGISTER_API(InvalidateStringRep
);
9265 JIM_REGISTER_API(InitStringRep
);
9266 JIM_REGISTER_API(DuplicateObj
);
9267 JIM_REGISTER_API(GetString
);
9268 JIM_REGISTER_API(Length
);
9269 JIM_REGISTER_API(InvalidateStringRep
);
9270 JIM_REGISTER_API(NewStringObj
);
9271 JIM_REGISTER_API(NewStringObjNoAlloc
);
9272 JIM_REGISTER_API(AppendString
);
9273 JIM_REGISTER_API(AppendString_sprintf
);
9274 JIM_REGISTER_API(AppendObj
);
9275 JIM_REGISTER_API(AppendStrings
);
9276 JIM_REGISTER_API(StringEqObj
);
9277 JIM_REGISTER_API(StringMatchObj
);
9278 JIM_REGISTER_API(StringRangeObj
);
9279 JIM_REGISTER_API(FormatString
);
9280 JIM_REGISTER_API(CompareStringImmediate
);
9281 JIM_REGISTER_API(NewReference
);
9282 JIM_REGISTER_API(GetReference
);
9283 JIM_REGISTER_API(SetFinalizer
);
9284 JIM_REGISTER_API(GetFinalizer
);
9285 JIM_REGISTER_API(CreateInterp
);
9286 JIM_REGISTER_API(FreeInterp
);
9287 JIM_REGISTER_API(GetExitCode
);
9288 JIM_REGISTER_API(SetStdin
);
9289 JIM_REGISTER_API(SetStdout
);
9290 JIM_REGISTER_API(SetStderr
);
9291 JIM_REGISTER_API(CreateCommand
);
9292 JIM_REGISTER_API(CreateProcedure
);
9293 JIM_REGISTER_API(DeleteCommand
);
9294 JIM_REGISTER_API(RenameCommand
);
9295 JIM_REGISTER_API(GetCommand
);
9296 JIM_REGISTER_API(SetVariable
);
9297 JIM_REGISTER_API(SetVariableStr
);
9298 JIM_REGISTER_API(SetGlobalVariableStr
);
9299 JIM_REGISTER_API(SetVariableStrWithStr
);
9300 JIM_REGISTER_API(SetVariableLink
);
9301 JIM_REGISTER_API(GetVariable
);
9302 JIM_REGISTER_API(GetCallFrameByLevel
);
9303 JIM_REGISTER_API(Collect
);
9304 JIM_REGISTER_API(CollectIfNeeded
);
9305 JIM_REGISTER_API(GetIndex
);
9306 JIM_REGISTER_API(NewListObj
);
9307 JIM_REGISTER_API(ListAppendElement
);
9308 JIM_REGISTER_API(ListAppendList
);
9309 JIM_REGISTER_API(ListLength
);
9310 JIM_REGISTER_API(ListIndex
);
9311 JIM_REGISTER_API(SetListIndex
);
9312 JIM_REGISTER_API(ConcatObj
);
9313 JIM_REGISTER_API(NewDictObj
);
9314 JIM_REGISTER_API(DictKey
);
9315 JIM_REGISTER_API(DictKeysVector
);
9316 JIM_REGISTER_API(GetIndex
);
9317 JIM_REGISTER_API(GetReturnCode
);
9318 JIM_REGISTER_API(EvalExpression
);
9319 JIM_REGISTER_API(GetBoolFromExpr
);
9320 JIM_REGISTER_API(GetWide
);
9321 JIM_REGISTER_API(GetLong
);
9322 JIM_REGISTER_API(SetWide
);
9323 JIM_REGISTER_API(NewIntObj
);
9324 JIM_REGISTER_API(GetDouble
);
9325 JIM_REGISTER_API(SetDouble
);
9326 JIM_REGISTER_API(NewDoubleObj
);
9327 JIM_REGISTER_API(WrongNumArgs
);
9328 JIM_REGISTER_API(SetDictKeysVector
);
9329 JIM_REGISTER_API(SubstObj
);
9330 JIM_REGISTER_API(RegisterApi
);
9331 JIM_REGISTER_API(PrintErrorMessage
);
9332 JIM_REGISTER_API(InteractivePrompt
);
9333 JIM_REGISTER_API(RegisterCoreCommands
);
9334 JIM_REGISTER_API(GetSharedString
);
9335 JIM_REGISTER_API(ReleaseSharedString
);
9336 JIM_REGISTER_API(Panic
);
9337 JIM_REGISTER_API(StrDup
);
9338 JIM_REGISTER_API(UnsetVariable
);
9339 JIM_REGISTER_API(GetVariableStr
);
9340 JIM_REGISTER_API(GetGlobalVariable
);
9341 JIM_REGISTER_API(GetGlobalVariableStr
);
9342 JIM_REGISTER_API(GetAssocData
);
9343 JIM_REGISTER_API(SetAssocData
);
9344 JIM_REGISTER_API(DeleteAssocData
);
9345 JIM_REGISTER_API(GetEnum
);
9346 JIM_REGISTER_API(ScriptIsComplete
);
9347 JIM_REGISTER_API(PackageRequire
);
9348 JIM_REGISTER_API(PackageProvide
);
9349 JIM_REGISTER_API(InitStack
);
9350 JIM_REGISTER_API(FreeStack
);
9351 JIM_REGISTER_API(StackLen
);
9352 JIM_REGISTER_API(StackPush
);
9353 JIM_REGISTER_API(StackPop
);
9354 JIM_REGISTER_API(StackPeek
);
9355 JIM_REGISTER_API(FreeStackElements
);
9356 JIM_REGISTER_API(fprintf
);
9357 JIM_REGISTER_API(vfprintf
);
9358 JIM_REGISTER_API(fwrite
);
9359 JIM_REGISTER_API(fread
);
9360 JIM_REGISTER_API(fflush
);
9361 JIM_REGISTER_API(fgets
);
9362 JIM_REGISTER_API(GetNvp
);
9363 JIM_REGISTER_API(Nvp_name2value
);
9364 JIM_REGISTER_API(Nvp_name2value_simple
);
9365 JIM_REGISTER_API(Nvp_name2value_obj
);
9366 JIM_REGISTER_API(Nvp_name2value_nocase
);
9367 JIM_REGISTER_API(Nvp_name2value_obj_nocase
);
9369 JIM_REGISTER_API(Nvp_value2name
);
9370 JIM_REGISTER_API(Nvp_value2name_simple
);
9371 JIM_REGISTER_API(Nvp_value2name_obj
);
9373 JIM_REGISTER_API(GetOpt_Setup
);
9374 JIM_REGISTER_API(GetOpt_Debug
);
9375 JIM_REGISTER_API(GetOpt_Obj
);
9376 JIM_REGISTER_API(GetOpt_String
);
9377 JIM_REGISTER_API(GetOpt_Double
);
9378 JIM_REGISTER_API(GetOpt_Wide
);
9379 JIM_REGISTER_API(GetOpt_Nvp
);
9380 JIM_REGISTER_API(GetOpt_NvpUnknown
);
9381 JIM_REGISTER_API(GetOpt_Enum
);
9383 JIM_REGISTER_API(Debug_ArgvString
);
9384 JIM_REGISTER_API(SetResult_sprintf
);
9385 JIM_REGISTER_API(SetResult_NvpUnknown
);
9389 /* -----------------------------------------------------------------------------
9390 * Core commands utility functions
9391 * ---------------------------------------------------------------------------*/
9392 void Jim_WrongNumArgs(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
,
9396 Jim_Obj
*objPtr
= Jim_NewEmptyStringObj(interp
);
9398 Jim_AppendString(interp
, objPtr
, "wrong # args: should be \"", -1);
9399 for (i
= 0; i
< argc
; i
++) {
9400 Jim_AppendObj(interp
, objPtr
, argv
[i
]);
9401 if (!(i
+1 == argc
&& msg
[0] == '\0'))
9402 Jim_AppendString(interp
, objPtr
, " ", 1);
9404 Jim_AppendString(interp
, objPtr
, msg
, -1);
9405 Jim_AppendString(interp
, objPtr
, "\"", 1);
9406 Jim_SetResult(interp
, objPtr
);
9409 static Jim_Obj
*JimCommandsList(Jim_Interp
*interp
, Jim_Obj
*patternObjPtr
)
9411 Jim_HashTableIterator
*htiter
;
9413 Jim_Obj
*listObjPtr
= Jim_NewListObj(interp
, NULL
, 0);
9414 const char *pattern
;
9417 pattern
= patternObjPtr
? Jim_GetString(patternObjPtr
, &patternLen
) : NULL
;
9418 htiter
= Jim_GetHashTableIterator(&interp
->commands
);
9419 while ((he
= Jim_NextHashEntry(htiter
)) != NULL
) {
9420 if (pattern
&& !JimStringMatch(pattern
, patternLen
, he
->key
,
9421 strlen((const char*)he
->key
), 0))
9423 Jim_ListAppendElement(interp
, listObjPtr
,
9424 Jim_NewStringObj(interp
, he
->key
, -1));
9426 Jim_FreeHashTableIterator(htiter
);
9430 #define JIM_VARLIST_GLOBALS 0
9431 #define JIM_VARLIST_LOCALS 1
9432 #define JIM_VARLIST_VARS 2
9434 static Jim_Obj
*JimVariablesList(Jim_Interp
*interp
, Jim_Obj
*patternObjPtr
,
9437 Jim_HashTableIterator
*htiter
;
9439 Jim_Obj
*listObjPtr
= Jim_NewListObj(interp
, NULL
, 0);
9440 const char *pattern
;
9443 pattern
= patternObjPtr
? Jim_GetString(patternObjPtr
, &patternLen
) : NULL
;
9444 if (mode
== JIM_VARLIST_GLOBALS
) {
9445 htiter
= Jim_GetHashTableIterator(&interp
->topFramePtr
->vars
);
9447 /* For [info locals], if we are at top level an emtpy list
9448 * is returned. I don't agree, but we aim at compatibility (SS) */
9449 if (mode
== JIM_VARLIST_LOCALS
&&
9450 interp
->framePtr
== interp
->topFramePtr
)
9452 htiter
= Jim_GetHashTableIterator(&interp
->framePtr
->vars
);
9454 while ((he
= Jim_NextHashEntry(htiter
)) != NULL
) {
9455 Jim_Var
*varPtr
= (Jim_Var
*) he
->val
;
9456 if (mode
== JIM_VARLIST_LOCALS
) {
9457 if (varPtr
->linkFramePtr
!= NULL
)
9460 if (pattern
&& !JimStringMatch(pattern
, patternLen
, he
->key
,
9461 strlen((const char*)he
->key
), 0))
9463 Jim_ListAppendElement(interp
, listObjPtr
,
9464 Jim_NewStringObj(interp
, he
->key
, -1));
9466 Jim_FreeHashTableIterator(htiter
);
9470 static int JimInfoLevel(Jim_Interp
*interp
, Jim_Obj
*levelObjPtr
,
9471 Jim_Obj
**objPtrPtr
)
9473 Jim_CallFrame
*targetCallFrame
;
9475 if (JimGetCallFrameByInteger(interp
, levelObjPtr
, &targetCallFrame
)
9478 /* No proc call at toplevel callframe */
9479 if (targetCallFrame
== interp
->topFramePtr
) {
9480 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
9481 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
9483 Jim_GetString(levelObjPtr
, NULL
), "\"", NULL
);
9486 *objPtrPtr
= Jim_NewListObj(interp
,
9487 targetCallFrame
->argv
,
9488 targetCallFrame
->argc
);
9492 /* -----------------------------------------------------------------------------
9494 * ---------------------------------------------------------------------------*/
9496 /* fake [puts] -- not the real puts, just for debugging. */
9497 static int Jim_PutsCoreCommand(Jim_Interp
*interp
, int argc
,
9498 Jim_Obj
*const *argv
)
9501 int len
, nonewline
= 0;
9503 if (argc
!= 2 && argc
!= 3) {
9504 Jim_WrongNumArgs(interp
, 1, argv
, "-nonewline string");
9508 if (!Jim_CompareStringImmediate(interp
, argv
[1], "-nonewline"))
9510 Jim_SetResultString(interp
, "The second argument must "
9511 "be -nonewline", -1);
9518 str
= Jim_GetString(argv
[1], &len
);
9519 Jim_fwrite(interp
, str
, 1, len
, interp
->cookie_stdout
);
9520 if (!nonewline
) Jim_fprintf( interp
, interp
->cookie_stdout
, JIM_NL
);
9524 /* Helper for [+] and [*] */
9525 static int Jim_AddMulHelper(Jim_Interp
*interp
, int argc
,
9526 Jim_Obj
*const *argv
, int op
)
9528 jim_wide wideValue
, res
;
9529 double doubleValue
, doubleRes
;
9532 res
= (op
== JIM_EXPROP_ADD
) ? 0 : 1;
9534 for (i
= 1; i
< argc
; i
++) {
9535 if (Jim_GetWide(interp
, argv
[i
], &wideValue
) != JIM_OK
)
9537 if (op
== JIM_EXPROP_ADD
)
9542 Jim_SetResult(interp
, Jim_NewIntObj(interp
, res
));
9545 doubleRes
= (double) res
;
9546 for (;i
< argc
; i
++) {
9547 if (Jim_GetDouble(interp
, argv
[i
], &doubleValue
) != JIM_OK
)
9549 if (op
== JIM_EXPROP_ADD
)
9550 doubleRes
+= doubleValue
;
9552 doubleRes
*= doubleValue
;
9554 Jim_SetResult(interp
, Jim_NewDoubleObj(interp
, doubleRes
));
9558 /* Helper for [-] and [/] */
9559 static int Jim_SubDivHelper(Jim_Interp
*interp
, int argc
,
9560 Jim_Obj
*const *argv
, int op
)
9562 jim_wide wideValue
, res
= 0;
9563 double doubleValue
, doubleRes
= 0;
9567 Jim_WrongNumArgs(interp
, 1, argv
, "number ?number ... number?");
9569 } else if (argc
== 2) {
9570 /* The arity = 2 case is different. For [- x] returns -x,
9571 * while [/ x] returns 1/x. */
9572 if (Jim_GetWide(interp
, argv
[1], &wideValue
) != JIM_OK
) {
9573 if (Jim_GetDouble(interp
, argv
[1], &doubleValue
) !=
9578 if (op
== JIM_EXPROP_SUB
)
9579 doubleRes
= -doubleValue
;
9581 doubleRes
= 1.0/doubleValue
;
9582 Jim_SetResult(interp
, Jim_NewDoubleObj(interp
,
9587 if (op
== JIM_EXPROP_SUB
) {
9589 Jim_SetResult(interp
, Jim_NewIntObj(interp
, res
));
9591 doubleRes
= 1.0/wideValue
;
9592 Jim_SetResult(interp
, Jim_NewDoubleObj(interp
,
9597 if (Jim_GetWide(interp
, argv
[1], &res
) != JIM_OK
) {
9598 if (Jim_GetDouble(interp
, argv
[1], &doubleRes
)
9606 for (i
= 2; i
< argc
; i
++) {
9607 if (Jim_GetWide(interp
, argv
[i
], &wideValue
) != JIM_OK
) {
9608 doubleRes
= (double) res
;
9611 if (op
== JIM_EXPROP_SUB
)
9616 Jim_SetResult(interp
, Jim_NewIntObj(interp
, res
));
9619 for (;i
< argc
; i
++) {
9620 if (Jim_GetDouble(interp
, argv
[i
], &doubleValue
) != JIM_OK
)
9622 if (op
== JIM_EXPROP_SUB
)
9623 doubleRes
-= doubleValue
;
9625 doubleRes
/= doubleValue
;
9627 Jim_SetResult(interp
, Jim_NewDoubleObj(interp
, doubleRes
));
9633 static int Jim_AddCoreCommand(Jim_Interp
*interp
, int argc
,
9634 Jim_Obj
*const *argv
)
9636 return Jim_AddMulHelper(interp
, argc
, argv
, JIM_EXPROP_ADD
);
9640 static int Jim_MulCoreCommand(Jim_Interp
*interp
, int argc
,
9641 Jim_Obj
*const *argv
)
9643 return Jim_AddMulHelper(interp
, argc
, argv
, JIM_EXPROP_MUL
);
9647 static int Jim_SubCoreCommand(Jim_Interp
*interp
, int argc
,
9648 Jim_Obj
*const *argv
)
9650 return Jim_SubDivHelper(interp
, argc
, argv
, JIM_EXPROP_SUB
);
9654 static int Jim_DivCoreCommand(Jim_Interp
*interp
, int argc
,
9655 Jim_Obj
*const *argv
)
9657 return Jim_SubDivHelper(interp
, argc
, argv
, JIM_EXPROP_DIV
);
9661 static int Jim_SetCoreCommand(Jim_Interp
*interp
, int argc
,
9662 Jim_Obj
*const *argv
)
9664 if (argc
!= 2 && argc
!= 3) {
9665 Jim_WrongNumArgs(interp
, 1, argv
, "varName ?newValue?");
9670 objPtr
= Jim_GetVariable(interp
, argv
[1], JIM_ERRMSG
);
9673 Jim_SetResult(interp
, objPtr
);
9676 /* argc == 3 case. */
9677 if (Jim_SetVariable(interp
, argv
[1], argv
[2]) != JIM_OK
)
9679 Jim_SetResult(interp
, argv
[2]);
9684 static int Jim_UnsetCoreCommand(Jim_Interp
*interp
, int argc
,
9685 Jim_Obj
*const *argv
)
9690 Jim_WrongNumArgs(interp
, 1, argv
, "varName ?varName ...?");
9693 for (i
= 1; i
< argc
; i
++) {
9694 if (Jim_UnsetVariable(interp
, argv
[i
], JIM_ERRMSG
) != JIM_OK
)
9701 static int Jim_IncrCoreCommand(Jim_Interp
*interp
, int argc
,
9702 Jim_Obj
*const *argv
)
9704 jim_wide wideValue
, increment
= 1;
9707 if (argc
!= 2 && argc
!= 3) {
9708 Jim_WrongNumArgs(interp
, 1, argv
, "varName ?increment?");
9712 if (Jim_GetWide(interp
, argv
[2], &increment
) != JIM_OK
)
9715 intObjPtr
= Jim_GetVariable(interp
, argv
[1], JIM_ERRMSG
);
9716 if (!intObjPtr
) return JIM_ERR
;
9717 if (Jim_GetWide(interp
, intObjPtr
, &wideValue
) != JIM_OK
)
9719 if (Jim_IsShared(intObjPtr
)) {
9720 intObjPtr
= Jim_NewIntObj(interp
, wideValue
+increment
);
9721 if (Jim_SetVariable(interp
, argv
[1], intObjPtr
) != JIM_OK
) {
9722 Jim_FreeNewObj(interp
, intObjPtr
);
9726 Jim_SetWide(interp
, intObjPtr
, wideValue
+increment
);
9727 /* The following step is required in order to invalidate the
9728 * string repr of "FOO" if the var name is on the form of "FOO(IDX)" */
9729 if (Jim_SetVariable(interp
, argv
[1], intObjPtr
) != JIM_OK
) {
9733 Jim_SetResult(interp
, intObjPtr
);
9738 static int Jim_WhileCoreCommand(Jim_Interp
*interp
, int argc
,
9739 Jim_Obj
*const *argv
)
9742 Jim_WrongNumArgs(interp
, 1, argv
, "condition body");
9745 /* Try to run a specialized version of while if the expression
9746 * is in one of the following forms:
9748 * $a < CONST, $a < $b
9749 * $a <= CONST, $a <= $b
9750 * $a > CONST, $a > $b
9751 * $a >= CONST, $a >= $b
9752 * $a != CONST, $a != $b
9753 * $a == CONST, $a == $b
9759 #ifdef JIM_OPTIMIZATION
9762 Jim_Obj
*varAObjPtr
= NULL
, *varBObjPtr
= NULL
, *objPtr
;
9763 int exprLen
, retval
;
9765 /* STEP 1 -- Check if there are the conditions to run the specialized
9766 * version of while */
9768 if ((expr
= Jim_GetExpression(interp
, argv
[1])) == NULL
) goto noopt
;
9769 if (expr
->len
<= 0 || expr
->len
> 3) goto noopt
;
9772 if (expr
->opcode
[0] != JIM_EXPROP_VARIABLE
&&
9773 expr
->opcode
[0] != JIM_EXPROP_NUMBER
)
9777 if (expr
->opcode
[1] != JIM_EXPROP_NOT
||
9778 expr
->opcode
[0] != JIM_EXPROP_VARIABLE
)
9782 if (expr
->opcode
[0] != JIM_EXPROP_VARIABLE
||
9783 (expr
->opcode
[1] != JIM_EXPROP_NUMBER
&&
9784 expr
->opcode
[1] != JIM_EXPROP_VARIABLE
))
9786 switch(expr
->opcode
[2]) {
9788 case JIM_EXPROP_LTE
:
9790 case JIM_EXPROP_GTE
:
9791 case JIM_EXPROP_NUMEQ
:
9792 case JIM_EXPROP_NUMNE
:
9801 "Unexpected default reached in Jim_WhileCoreCommand()");
9805 /* STEP 2 -- conditions meet. Initialization. Take different
9806 * branches for different expression lengths. */
9807 exprLen
= expr
->len
;
9812 if (expr
->opcode
[0] == JIM_EXPROP_VARIABLE
) {
9813 varAObjPtr
= expr
->obj
[0];
9814 Jim_IncrRefCount(varAObjPtr
);
9816 if (Jim_GetWide(interp
, expr
->obj
[0], &wideValue
) != JIM_OK
)
9822 Jim_GetVariable(interp
, varAObjPtr
, JIM_NONE
)) ||
9823 Jim_GetWide(interp
, objPtr
, &wideValue
) != JIM_OK
)
9825 Jim_DecrRefCount(interp
, varAObjPtr
);
9829 if (!wideValue
) break;
9830 if ((retval
= Jim_EvalObj(interp
, argv
[2])) != JIM_OK
) {
9834 Jim_DecrRefCount(interp
, varAObjPtr
);
9842 Jim_DecrRefCount(interp
, varAObjPtr
);
9848 Jim_DecrRefCount(interp
, varAObjPtr
);
9849 } else if (exprLen
== 3) {
9850 jim_wide wideValueA
, wideValueB
, cmpRes
= 0;
9851 int cmpType
= expr
->opcode
[2];
9853 varAObjPtr
= expr
->obj
[0];
9854 Jim_IncrRefCount(varAObjPtr
);
9855 if (expr
->opcode
[1] == JIM_EXPROP_VARIABLE
) {
9856 varBObjPtr
= expr
->obj
[1];
9857 Jim_IncrRefCount(varBObjPtr
);
9859 if (Jim_GetWide(interp
, expr
->obj
[1], &wideValueB
) != JIM_OK
)
9863 if (!(objPtr
= Jim_GetVariable(interp
, varAObjPtr
, JIM_NONE
)) ||
9864 Jim_GetWide(interp
, objPtr
, &wideValueA
) != JIM_OK
)
9866 Jim_DecrRefCount(interp
, varAObjPtr
);
9868 Jim_DecrRefCount(interp
, varBObjPtr
);
9873 Jim_GetVariable(interp
, varBObjPtr
, JIM_NONE
)) ||
9874 Jim_GetWide(interp
, objPtr
, &wideValueB
) != JIM_OK
)
9876 Jim_DecrRefCount(interp
, varAObjPtr
);
9878 Jim_DecrRefCount(interp
, varBObjPtr
);
9884 cmpRes
= wideValueA
< wideValueB
; break;
9885 case JIM_EXPROP_LTE
:
9886 cmpRes
= wideValueA
<= wideValueB
; break;
9888 cmpRes
= wideValueA
> wideValueB
; break;
9889 case JIM_EXPROP_GTE
:
9890 cmpRes
= wideValueA
>= wideValueB
; break;
9891 case JIM_EXPROP_NUMEQ
:
9892 cmpRes
= wideValueA
== wideValueB
; break;
9893 case JIM_EXPROP_NUMNE
:
9894 cmpRes
= wideValueA
!= wideValueB
; break;
9897 if ((retval
= Jim_EvalObj(interp
, argv
[2])) != JIM_OK
) {
9900 Jim_DecrRefCount(interp
, varAObjPtr
);
9902 Jim_DecrRefCount(interp
, varBObjPtr
);
9909 Jim_DecrRefCount(interp
, varAObjPtr
);
9911 Jim_DecrRefCount(interp
, varBObjPtr
);
9916 Jim_DecrRefCount(interp
, varAObjPtr
);
9918 Jim_DecrRefCount(interp
, varBObjPtr
);
9920 /* TODO: case for len == 2 */
9923 Jim_SetEmptyResult(interp
);
9929 /* The general purpose implementation of while starts here */
9931 int boolean
, retval
;
9933 if ((retval
= Jim_GetBoolFromExpr(interp
, argv
[1],
9934 &boolean
)) != JIM_OK
)
9936 if (!boolean
) break;
9937 if ((retval
= Jim_EvalObj(interp
, argv
[2])) != JIM_OK
) {
9951 Jim_SetEmptyResult(interp
);
9956 static int Jim_ForCoreCommand(Jim_Interp
*interp
, int argc
,
9957 Jim_Obj
*const *argv
)
9962 Jim_WrongNumArgs(interp
, 1, argv
, "start test next body");
9965 /* Check if the for is on the form:
9966 * for {set i CONST} {$i < CONST} {incr i}
9967 * for {set i CONST} {$i < $j} {incr i}
9968 * for {set i CONST} {$i <= CONST} {incr i}
9969 * for {set i CONST} {$i <= $j} {incr i}
9970 * XXX: NOTE: if variable traces are implemented, this optimization
9971 * need to be modified to check for the proc epoch at every variable
9973 #ifdef JIM_OPTIMIZATION
9975 ScriptObj
*initScript
, *incrScript
;
9977 jim_wide start
, stop
, currentVal
;
9978 unsigned jim_wide procEpoch
= interp
->procEpoch
;
9979 Jim_Obj
*varNamePtr
, *stopVarNamePtr
= NULL
, *objPtr
;
9981 struct Jim_Cmd
*cmdPtr
;
9983 /* Do it only if there aren't shared arguments */
9984 if (argv
[1] == argv
[2] || argv
[2] == argv
[3] || argv
[1] == argv
[3])
9986 initScript
= Jim_GetScript(interp
, argv
[1]);
9987 expr
= Jim_GetExpression(interp
, argv
[2]);
9988 incrScript
= Jim_GetScript(interp
, argv
[3]);
9990 /* Ensure proper lengths to start */
9991 if (initScript
->len
!= 6) goto evalstart
;
9992 if (incrScript
->len
!= 4) goto evalstart
;
9993 if (expr
->len
!= 3) goto evalstart
;
9994 /* Ensure proper token types. */
9995 if (initScript
->token
[2].type
!= JIM_TT_ESC
||
9996 initScript
->token
[4].type
!= JIM_TT_ESC
||
9997 incrScript
->token
[2].type
!= JIM_TT_ESC
||
9998 expr
->opcode
[0] != JIM_EXPROP_VARIABLE
||
9999 (expr
->opcode
[1] != JIM_EXPROP_NUMBER
&&
10000 expr
->opcode
[1] != JIM_EXPROP_VARIABLE
) ||
10001 (expr
->opcode
[2] != JIM_EXPROP_LT
&&
10002 expr
->opcode
[2] != JIM_EXPROP_LTE
))
10004 cmpType
= expr
->opcode
[2];
10005 /* Initialization command must be [set] */
10006 cmdPtr
= Jim_GetCommand(interp
, initScript
->token
[0].objPtr
, JIM_NONE
);
10007 if (cmdPtr
== NULL
|| cmdPtr
->cmdProc
!= Jim_SetCoreCommand
)
10009 /* Update command must be incr */
10010 cmdPtr
= Jim_GetCommand(interp
, incrScript
->token
[0].objPtr
, JIM_NONE
);
10011 if (cmdPtr
== NULL
|| cmdPtr
->cmdProc
!= Jim_IncrCoreCommand
)
10013 /* set, incr, expression must be about the same variable */
10014 if (!Jim_StringEqObj(initScript
->token
[2].objPtr
,
10015 incrScript
->token
[2].objPtr
, 0))
10017 if (!Jim_StringEqObj(initScript
->token
[2].objPtr
,
10020 /* Check that the initialization and comparison are valid integers */
10021 if (Jim_GetWide(interp
, initScript
->token
[4].objPtr
, &start
) == JIM_ERR
)
10023 if (expr
->opcode
[1] == JIM_EXPROP_NUMBER
&&
10024 Jim_GetWide(interp
, expr
->obj
[1], &stop
) == JIM_ERR
)
10029 /* Initialization */
10030 varNamePtr
= expr
->obj
[0];
10031 if (expr
->opcode
[1] == JIM_EXPROP_VARIABLE
) {
10032 stopVarNamePtr
= expr
->obj
[1];
10033 Jim_IncrRefCount(stopVarNamePtr
);
10035 Jim_IncrRefCount(varNamePtr
);
10037 /* --- OPTIMIZED FOR --- */
10038 /* Start to loop */
10039 objPtr
= Jim_NewIntObj(interp
, start
);
10040 if (Jim_SetVariable(interp
, varNamePtr
, objPtr
) != JIM_OK
) {
10041 Jim_DecrRefCount(interp
, varNamePtr
);
10042 if (stopVarNamePtr
) Jim_DecrRefCount(interp
, stopVarNamePtr
);
10043 Jim_FreeNewObj(interp
, objPtr
);
10047 /* === Check condition === */
10049 objPtr
= Jim_GetVariable(interp
, varNamePtr
, JIM_NONE
);
10050 if (objPtr
== NULL
||
10051 Jim_GetWide(interp
, objPtr
, ¤tVal
) != JIM_OK
)
10053 Jim_DecrRefCount(interp
, varNamePtr
);
10054 if (stopVarNamePtr
) Jim_DecrRefCount(interp
, stopVarNamePtr
);
10057 /* Immediate or Variable? get the 'stop' value if the latter. */
10058 if (stopVarNamePtr
) {
10059 objPtr
= Jim_GetVariable(interp
, stopVarNamePtr
, JIM_NONE
);
10060 if (objPtr
== NULL
||
10061 Jim_GetWide(interp
, objPtr
, &stop
) != JIM_OK
)
10063 Jim_DecrRefCount(interp
, varNamePtr
);
10064 Jim_DecrRefCount(interp
, stopVarNamePtr
);
10068 if (cmpType
== JIM_EXPROP_LT
) {
10069 if (currentVal
>= stop
) break;
10071 if (currentVal
> stop
) break;
10074 if ((retval
= Jim_EvalObj(interp
, argv
[4])) != JIM_OK
) {
10077 if (stopVarNamePtr
)
10078 Jim_DecrRefCount(interp
, stopVarNamePtr
);
10079 Jim_DecrRefCount(interp
, varNamePtr
);
10082 /* nothing to do */
10085 if (stopVarNamePtr
)
10086 Jim_DecrRefCount(interp
, stopVarNamePtr
);
10087 Jim_DecrRefCount(interp
, varNamePtr
);
10091 /* If there was a change in procedures/command continue
10092 * with the usual [for] command implementation */
10093 if (procEpoch
!= interp
->procEpoch
) {
10094 if (stopVarNamePtr
)
10095 Jim_DecrRefCount(interp
, stopVarNamePtr
);
10096 Jim_DecrRefCount(interp
, varNamePtr
);
10100 objPtr
= Jim_GetVariable(interp
, varNamePtr
, JIM_ERRMSG
);
10101 if (objPtr
->refCount
== 1 && objPtr
->typePtr
== &intObjType
) {
10102 objPtr
->internalRep
.wideValue
++;
10103 Jim_InvalidateStringRep(objPtr
);
10105 Jim_Obj
*auxObjPtr
;
10107 if (Jim_GetWide(interp
, objPtr
, ¤tVal
) == JIM_ERR
) {
10108 if (stopVarNamePtr
)
10109 Jim_DecrRefCount(interp
, stopVarNamePtr
);
10110 Jim_DecrRefCount(interp
, varNamePtr
);
10113 auxObjPtr
= Jim_NewIntObj(interp
, currentVal
+1);
10114 if (Jim_SetVariable(interp
, varNamePtr
, auxObjPtr
) == JIM_ERR
) {
10115 if (stopVarNamePtr
)
10116 Jim_DecrRefCount(interp
, stopVarNamePtr
);
10117 Jim_DecrRefCount(interp
, varNamePtr
);
10118 Jim_FreeNewObj(interp
, auxObjPtr
);
10123 if (stopVarNamePtr
)
10124 Jim_DecrRefCount(interp
, stopVarNamePtr
);
10125 Jim_DecrRefCount(interp
, varNamePtr
);
10126 Jim_SetEmptyResult(interp
);
10132 if ((retval
= Jim_EvalObj(interp
, argv
[1])) != JIM_OK
)
10137 /* Test the condition */
10138 if ((retval
= Jim_GetBoolFromExpr(interp
, argv
[2], &boolean
))
10141 if (!boolean
) break;
10143 if ((retval
= Jim_EvalObj(interp
, argv
[4])) != JIM_OK
) {
10149 /* Nothing to do */
10157 if ((retval
= Jim_EvalObj(interp
, argv
[3])) != JIM_OK
) {
10171 Jim_SetEmptyResult(interp
);
10175 /* foreach + lmap implementation. */
10176 static int JimForeachMapHelper(Jim_Interp
*interp
, int argc
,
10177 Jim_Obj
*const *argv
, int doMap
)
10179 int result
= JIM_ERR
, i
, nbrOfLists
, *listsIdx
, *listsEnd
;
10180 int nbrOfLoops
= 0;
10181 Jim_Obj
*emptyStr
, *script
, *mapRes
= NULL
;
10183 if (argc
< 4 || argc
% 2 != 0) {
10184 Jim_WrongNumArgs(interp
, 1, argv
, "varList list ?varList list ...? script");
10188 mapRes
= Jim_NewListObj(interp
, NULL
, 0);
10189 Jim_IncrRefCount(mapRes
);
10191 emptyStr
= Jim_NewEmptyStringObj(interp
);
10192 Jim_IncrRefCount(emptyStr
);
10193 script
= argv
[argc
-1]; /* Last argument is a script */
10194 nbrOfLists
= (argc
- 1 - 1) / 2; /* argc - 'foreach' - script */
10195 listsIdx
= (int*)Jim_Alloc(nbrOfLists
* sizeof(int));
10196 listsEnd
= (int*)Jim_Alloc(nbrOfLists
*2 * sizeof(int));
10197 /* Initialize iterators and remember max nbr elements each list */
10198 memset(listsIdx
, 0, nbrOfLists
* sizeof(int));
10199 /* Remember lengths of all lists and calculate how much rounds to loop */
10200 for (i
=0; i
< nbrOfLists
*2; i
+= 2) {
10203 Jim_ListLength(interp
, argv
[i
+1], &listsEnd
[i
]);
10204 Jim_ListLength(interp
, argv
[i
+2], &listsEnd
[i
+1]);
10205 if (listsEnd
[i
] == 0) {
10206 Jim_SetResultString(interp
, "foreach varlist is empty", -1);
10209 cnt
= div(listsEnd
[i
+1], listsEnd
[i
]);
10210 count
= cnt
.quot
+ (cnt
.rem
? 1 : 0);
10211 if (count
> nbrOfLoops
)
10212 nbrOfLoops
= count
;
10214 for (; nbrOfLoops
-- > 0; ) {
10215 for (i
=0; i
< nbrOfLists
; ++i
) {
10216 int varIdx
= 0, var
= i
* 2;
10217 while (varIdx
< listsEnd
[var
]) {
10218 Jim_Obj
*varName
, *ele
;
10219 int lst
= i
* 2 + 1;
10220 if (Jim_ListIndex(interp
, argv
[var
+1], varIdx
, &varName
, JIM_ERRMSG
)
10223 if (listsIdx
[i
] < listsEnd
[lst
]) {
10224 if (Jim_ListIndex(interp
, argv
[lst
+1], listsIdx
[i
], &ele
, JIM_ERRMSG
)
10227 if (Jim_SetVariable(interp
, varName
, ele
) != JIM_OK
) {
10228 Jim_SetResultString(interp
, "couldn't set loop variable: ", -1);
10231 ++listsIdx
[i
]; /* Remember next iterator of current list */
10232 } else if (Jim_SetVariable(interp
, varName
, emptyStr
) != JIM_OK
) {
10233 Jim_SetResultString(interp
, "couldn't set loop variable: ", -1);
10236 ++varIdx
; /* Next variable */
10239 switch (result
= Jim_EvalObj(interp
, script
)) {
10242 Jim_ListAppendElement(interp
, mapRes
, interp
->result
);
10256 Jim_SetResult(interp
, mapRes
);
10258 Jim_SetEmptyResult(interp
);
10261 Jim_DecrRefCount(interp
, mapRes
);
10262 Jim_DecrRefCount(interp
, emptyStr
);
10263 Jim_Free(listsIdx
);
10264 Jim_Free(listsEnd
);
10269 static int Jim_ForeachCoreCommand(Jim_Interp
*interp
, int argc
,
10270 Jim_Obj
*const *argv
)
10272 return JimForeachMapHelper(interp
, argc
, argv
, 0);
10276 static int Jim_LmapCoreCommand(Jim_Interp
*interp
, int argc
,
10277 Jim_Obj
*const *argv
)
10279 return JimForeachMapHelper(interp
, argc
, argv
, 1);
10283 static int Jim_IfCoreCommand(Jim_Interp
*interp
, int argc
,
10284 Jim_Obj
*const *argv
)
10286 int boolean
, retval
, current
= 1, falsebody
= 0;
10289 /* Far not enough arguments given! */
10290 if (current
>= argc
) goto err
;
10291 if ((retval
= Jim_GetBoolFromExpr(interp
,
10292 argv
[current
++], &boolean
))
10295 /* There lacks something, isn't it? */
10296 if (current
>= argc
) goto err
;
10297 if (Jim_CompareStringImmediate(interp
, argv
[current
],
10298 "then")) current
++;
10299 /* Tsk tsk, no then-clause? */
10300 if (current
>= argc
) goto err
;
10302 return Jim_EvalObj(interp
, argv
[current
]);
10303 /* Ok: no else-clause follows */
10304 if (++current
>= argc
) {
10305 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
10308 falsebody
= current
++;
10309 if (Jim_CompareStringImmediate(interp
, argv
[falsebody
],
10311 /* IIICKS - else-clause isn't last cmd? */
10312 if (current
!= argc
-1) goto err
;
10313 return Jim_EvalObj(interp
, argv
[current
]);
10314 } else if (Jim_CompareStringImmediate(interp
,
10315 argv
[falsebody
], "elseif"))
10316 /* Ok: elseif follows meaning all the stuff
10317 * again (how boring...) */
10319 /* OOPS - else-clause is not last cmd?*/
10320 else if (falsebody
!= argc
-1)
10322 return Jim_EvalObj(interp
, argv
[falsebody
]);
10327 Jim_WrongNumArgs(interp
, 1, argv
, "condition ?then? trueBody ?elseif ...? ?else? falseBody");
10331 enum {SWITCH_EXACT
, SWITCH_GLOB
, SWITCH_RE
, SWITCH_CMD
, SWITCH_UNKNOWN
};
10334 static int Jim_SwitchCoreCommand(Jim_Interp
*interp
, int argc
,
10335 Jim_Obj
*const *argv
)
10337 int retcode
= JIM_ERR
, matchOpt
= SWITCH_EXACT
, opt
=1, patCount
, i
;
10338 Jim_Obj
*command
= 0, *const *caseList
= 0, *strObj
;
10339 Jim_Obj
*script
= 0;
10340 if (argc
< 3) goto wrongnumargs
;
10341 for (opt
=1; opt
< argc
; ++opt
) {
10342 const char *option
= Jim_GetString(argv
[opt
], 0);
10343 if (*option
!= '-') break;
10344 else if (strncmp(option
, "--", 2) == 0) { ++opt
; break; }
10345 else if (strncmp(option
, "-exact", 2) == 0) matchOpt
= SWITCH_EXACT
;
10346 else if (strncmp(option
, "-glob", 2) == 0) matchOpt
= SWITCH_GLOB
;
10347 else if (strncmp(option
, "-regexp", 2) == 0) matchOpt
= SWITCH_RE
;
10348 else if (strncmp(option
, "-command", 2) == 0) { matchOpt
= SWITCH_CMD
;
10349 if ((argc
- opt
) < 2) goto wrongnumargs
;
10350 command
= argv
[++opt
];
10352 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
10353 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
10354 "bad option \"", option
, "\": must be -exact, -glob, "
10355 "-regexp, -command procname or --", 0);
10358 if ((argc
- opt
) < 2) goto wrongnumargs
;
10360 strObj
= argv
[opt
++];
10361 patCount
= argc
- opt
;
10362 if (patCount
== 1) {
10364 JimListGetElements(interp
, argv
[opt
], &patCount
, &vector
);
10367 caseList
= &argv
[opt
];
10368 if (patCount
== 0 || patCount
% 2 != 0) goto wrongnumargs
;
10369 for (i
=0; script
== 0 && i
< patCount
; i
+= 2) {
10370 Jim_Obj
*patObj
= caseList
[i
];
10371 if (!Jim_CompareStringImmediate(interp
, patObj
, "default")
10372 || i
< (patCount
-2)) {
10373 switch (matchOpt
) {
10375 if (Jim_StringEqObj(strObj
, patObj
, 0))
10376 script
= caseList
[i
+1];
10379 if (Jim_StringMatchObj(patObj
, strObj
, 0))
10380 script
= caseList
[i
+1];
10383 command
= Jim_NewStringObj(interp
, "regexp", -1);
10384 /* Fall thru intentionally */
10386 Jim_Obj
*parms
[] = {command
, patObj
, strObj
};
10387 int rc
= Jim_EvalObjVector(interp
, 3, parms
);
10389 /* After the execution of a command we need to
10390 * make sure to reconvert the object into a list
10391 * again. Only for the single-list style [switch]. */
10392 if (argc
-opt
== 1) {
10394 JimListGetElements(interp
, argv
[opt
], &patCount
,
10398 /* command is here already decref'd */
10399 if (rc
!= JIM_OK
) {
10403 rc
= Jim_GetLong(interp
, Jim_GetResult(interp
), &matching
);
10404 if (rc
!= JIM_OK
) {
10409 script
= caseList
[i
+1];
10413 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
10414 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
10415 "internal error: no such option implemented", 0);
10419 script
= caseList
[i
+1];
10422 for(; i
< patCount
&& Jim_CompareStringImmediate(interp
, script
, "-");
10424 script
= caseList
[i
+1];
10425 if (script
&& Jim_CompareStringImmediate(interp
, script
, "-")) {
10426 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
10427 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
10428 "no body specified for pattern \"",
10429 Jim_GetString(caseList
[i
-2], 0), "\"", 0);
10433 Jim_SetEmptyResult(interp
);
10435 retcode
= Jim_EvalObj(interp
, script
);
10438 Jim_WrongNumArgs(interp
, 1, argv
, "?options? string "
10439 "pattern body ... ?default body? or "
10440 "{pattern body ?pattern body ...?}");
10446 static int Jim_ListCoreCommand(Jim_Interp
*interp
, int argc
,
10447 Jim_Obj
*const *argv
)
10449 Jim_Obj
*listObjPtr
;
10451 listObjPtr
= Jim_NewListObj(interp
, argv
+1, argc
-1);
10452 Jim_SetResult(interp
, listObjPtr
);
10457 static int Jim_LindexCoreCommand(Jim_Interp
*interp
, int argc
,
10458 Jim_Obj
*const *argv
)
10460 Jim_Obj
*objPtr
, *listObjPtr
;
10465 Jim_WrongNumArgs(interp
, 1, argv
, "list index ?...?");
10469 Jim_IncrRefCount(objPtr
);
10470 for (i
= 2; i
< argc
; i
++) {
10471 listObjPtr
= objPtr
;
10472 if (Jim_GetIndex(interp
, argv
[i
], &index
) != JIM_OK
) {
10473 Jim_DecrRefCount(interp
, listObjPtr
);
10476 if (Jim_ListIndex(interp
, listObjPtr
, index
, &objPtr
,
10477 JIM_NONE
) != JIM_OK
) {
10478 /* Returns an empty object if the index
10479 * is out of range. */
10480 Jim_DecrRefCount(interp
, listObjPtr
);
10481 Jim_SetEmptyResult(interp
);
10484 Jim_IncrRefCount(objPtr
);
10485 Jim_DecrRefCount(interp
, listObjPtr
);
10487 Jim_SetResult(interp
, objPtr
);
10488 Jim_DecrRefCount(interp
, objPtr
);
10493 static int Jim_LlengthCoreCommand(Jim_Interp
*interp
, int argc
,
10494 Jim_Obj
*const *argv
)
10499 Jim_WrongNumArgs(interp
, 1, argv
, "list");
10502 Jim_ListLength(interp
, argv
[1], &len
);
10503 Jim_SetResult(interp
, Jim_NewIntObj(interp
, len
));
10508 static int Jim_LappendCoreCommand(Jim_Interp
*interp
, int argc
,
10509 Jim_Obj
*const *argv
)
10511 Jim_Obj
*listObjPtr
;
10515 Jim_WrongNumArgs(interp
, 1, argv
, "varName ?value value ...?");
10518 listObjPtr
= Jim_GetVariable(interp
, argv
[1], JIM_NONE
);
10520 /* Create the list if it does not exists */
10521 listObjPtr
= Jim_NewListObj(interp
, NULL
, 0);
10522 if (Jim_SetVariable(interp
, argv
[1], listObjPtr
) != JIM_OK
) {
10523 Jim_FreeNewObj(interp
, listObjPtr
);
10527 shared
= Jim_IsShared(listObjPtr
);
10529 listObjPtr
= Jim_DuplicateObj(interp
, listObjPtr
);
10530 for (i
= 2; i
< argc
; i
++)
10531 Jim_ListAppendElement(interp
, listObjPtr
, argv
[i
]);
10532 if (Jim_SetVariable(interp
, argv
[1], listObjPtr
) != JIM_OK
) {
10534 Jim_FreeNewObj(interp
, listObjPtr
);
10537 Jim_SetResult(interp
, listObjPtr
);
10542 static int Jim_LinsertCoreCommand(Jim_Interp
*interp
, int argc
,
10543 Jim_Obj
*const *argv
)
10549 Jim_WrongNumArgs(interp
, 1, argv
, "list index element "
10554 if (Jim_IsShared(listPtr
))
10555 listPtr
= Jim_DuplicateObj(interp
, listPtr
);
10556 if (Jim_GetIndex(interp
, argv
[2], &index
) != JIM_OK
)
10558 Jim_ListLength(interp
, listPtr
, &len
);
10561 else if (index
< 0)
10562 index
= len
+ index
+ 1;
10563 Jim_ListInsertElements(interp
, listPtr
, index
, argc
-3, &argv
[3]);
10564 Jim_SetResult(interp
, listPtr
);
10567 if (listPtr
!= argv
[1]) {
10568 Jim_FreeNewObj(interp
, listPtr
);
10574 static int Jim_LsetCoreCommand(Jim_Interp
*interp
, int argc
,
10575 Jim_Obj
*const *argv
)
10578 Jim_WrongNumArgs(interp
, 1, argv
, "listVar ?index...? newVal");
10580 } else if (argc
== 3) {
10581 if (Jim_SetVariable(interp
, argv
[1], argv
[2]) != JIM_OK
)
10583 Jim_SetResult(interp
, argv
[2]);
10586 if (Jim_SetListIndex(interp
, argv
[1], argv
+2, argc
-3, argv
[argc
-1])
10587 == JIM_ERR
) return JIM_ERR
;
10592 static int Jim_LsortCoreCommand(Jim_Interp
*interp
, int argc
, Jim_Obj
*const argv
[])
10594 const char *options
[] = {
10595 "-ascii", "-nocase", "-increasing", "-decreasing", NULL
10597 enum {OPT_ASCII
, OPT_NOCASE
, OPT_INCREASING
, OPT_DECREASING
};
10599 int i
, lsortType
= JIM_LSORT_ASCII
; /* default sort type */
10600 int decreasing
= 0;
10603 Jim_WrongNumArgs(interp
, 1, argv
, "?options? list");
10606 for (i
= 1; i
< (argc
-1); i
++) {
10609 if (Jim_GetEnum(interp
, argv
[i
], options
, &option
, "option", JIM_ERRMSG
)
10613 case OPT_ASCII
: lsortType
= JIM_LSORT_ASCII
; break;
10614 case OPT_NOCASE
: lsortType
= JIM_LSORT_NOCASE
; break;
10615 case OPT_INCREASING
: decreasing
= 0; break;
10616 case OPT_DECREASING
: decreasing
= 1; break;
10620 switch(lsortType
) {
10621 case JIM_LSORT_ASCII
: lsortType
= JIM_LSORT_ASCII_DECR
; break;
10622 case JIM_LSORT_NOCASE
: lsortType
= JIM_LSORT_NOCASE_DECR
; break;
10625 resObj
= Jim_DuplicateObj(interp
, argv
[argc
-1]);
10626 ListSortElements(interp
, resObj
, lsortType
);
10627 Jim_SetResult(interp
, resObj
);
10632 static int Jim_AppendCoreCommand(Jim_Interp
*interp
, int argc
,
10633 Jim_Obj
*const *argv
)
10635 Jim_Obj
*stringObjPtr
;
10639 Jim_WrongNumArgs(interp
, 1, argv
, "varName ?value value ...?");
10643 stringObjPtr
= Jim_GetVariable(interp
, argv
[1], JIM_ERRMSG
);
10644 if (!stringObjPtr
) return JIM_ERR
;
10646 stringObjPtr
= Jim_GetVariable(interp
, argv
[1], JIM_NONE
);
10647 if (!stringObjPtr
) {
10648 /* Create the string if it does not exists */
10649 stringObjPtr
= Jim_NewEmptyStringObj(interp
);
10650 if (Jim_SetVariable(interp
, argv
[1], stringObjPtr
)
10652 Jim_FreeNewObj(interp
, stringObjPtr
);
10657 shared
= Jim_IsShared(stringObjPtr
);
10659 stringObjPtr
= Jim_DuplicateObj(interp
, stringObjPtr
);
10660 for (i
= 2; i
< argc
; i
++)
10661 Jim_AppendObj(interp
, stringObjPtr
, argv
[i
]);
10662 if (Jim_SetVariable(interp
, argv
[1], stringObjPtr
) != JIM_OK
) {
10664 Jim_FreeNewObj(interp
, stringObjPtr
);
10667 Jim_SetResult(interp
, stringObjPtr
);
10672 static int Jim_DebugCoreCommand(Jim_Interp
*interp
, int argc
,
10673 Jim_Obj
*const *argv
)
10675 const char *options
[] = {
10676 "refcount", "objcount", "objects", "invstr", "scriptlen", "exprlen",
10681 OPT_REFCOUNT
, OPT_OBJCOUNT
, OPT_OBJECTS
, OPT_INVSTR
, OPT_SCRIPTLEN
,
10682 OPT_EXPRLEN
, OPT_EXPRBC
10687 Jim_WrongNumArgs(interp
, 1, argv
, "option ?...?");
10690 if (Jim_GetEnum(interp
, argv
[1], options
, &option
, "option",
10691 JIM_ERRMSG
) != JIM_OK
)
10693 if (option
== OPT_REFCOUNT
) {
10695 Jim_WrongNumArgs(interp
, 2, argv
, "object");
10698 Jim_SetResult(interp
, Jim_NewIntObj(interp
, argv
[2]->refCount
));
10700 } else if (option
== OPT_OBJCOUNT
) {
10701 int freeobj
= 0, liveobj
= 0;
10706 Jim_WrongNumArgs(interp
, 2, argv
, "");
10709 /* Count the number of free objects. */
10710 objPtr
= interp
->freeList
;
10713 objPtr
= objPtr
->nextObjPtr
;
10715 /* Count the number of live objects. */
10716 objPtr
= interp
->liveList
;
10719 objPtr
= objPtr
->nextObjPtr
;
10721 /* Set the result string and return. */
10722 sprintf(buf
, "free %d used %d", freeobj
, liveobj
);
10723 Jim_SetResultString(interp
, buf
, -1);
10725 } else if (option
== OPT_OBJECTS
) {
10726 Jim_Obj
*objPtr
, *listObjPtr
, *subListObjPtr
;
10727 /* Count the number of live objects. */
10728 objPtr
= interp
->liveList
;
10729 listObjPtr
= Jim_NewListObj(interp
, NULL
, 0);
10732 const char *type
= objPtr
->typePtr
?
10733 objPtr
->typePtr
->name
: "";
10734 subListObjPtr
= Jim_NewListObj(interp
, NULL
, 0);
10735 sprintf(buf
, "%p", objPtr
);
10736 Jim_ListAppendElement(interp
, subListObjPtr
,
10737 Jim_NewStringObj(interp
, buf
, -1));
10738 Jim_ListAppendElement(interp
, subListObjPtr
,
10739 Jim_NewStringObj(interp
, type
, -1));
10740 Jim_ListAppendElement(interp
, subListObjPtr
,
10741 Jim_NewIntObj(interp
, objPtr
->refCount
));
10742 Jim_ListAppendElement(interp
, subListObjPtr
, objPtr
);
10743 Jim_ListAppendElement(interp
, listObjPtr
, subListObjPtr
);
10744 objPtr
= objPtr
->nextObjPtr
;
10746 Jim_SetResult(interp
, listObjPtr
);
10748 } else if (option
== OPT_INVSTR
) {
10752 Jim_WrongNumArgs(interp
, 2, argv
, "object");
10756 if (objPtr
->typePtr
!= NULL
)
10757 Jim_InvalidateStringRep(objPtr
);
10758 Jim_SetEmptyResult(interp
);
10760 } else if (option
== OPT_SCRIPTLEN
) {
10763 Jim_WrongNumArgs(interp
, 2, argv
, "script");
10766 script
= Jim_GetScript(interp
, argv
[2]);
10767 Jim_SetResult(interp
, Jim_NewIntObj(interp
, script
->len
));
10769 } else if (option
== OPT_EXPRLEN
) {
10770 ExprByteCode
*expr
;
10772 Jim_WrongNumArgs(interp
, 2, argv
, "expression");
10775 expr
= Jim_GetExpression(interp
, argv
[2]);
10778 Jim_SetResult(interp
, Jim_NewIntObj(interp
, expr
->len
));
10780 } else if (option
== OPT_EXPRBC
) {
10782 ExprByteCode
*expr
;
10786 Jim_WrongNumArgs(interp
, 2, argv
, "expression");
10789 expr
= Jim_GetExpression(interp
, argv
[2]);
10792 objPtr
= Jim_NewListObj(interp
, NULL
, 0);
10793 for (i
= 0; i
< expr
->len
; i
++) {
10795 Jim_ExprOperator
*op
;
10797 switch(expr
->opcode
[i
]) {
10798 case JIM_EXPROP_NUMBER
: type
= "number"; break;
10799 case JIM_EXPROP_COMMAND
: type
= "command"; break;
10800 case JIM_EXPROP_VARIABLE
: type
= "variable"; break;
10801 case JIM_EXPROP_DICTSUGAR
: type
= "dictsugar"; break;
10802 case JIM_EXPROP_SUBST
: type
= "subst"; break;
10803 case JIM_EXPROP_STRING
: type
= "string"; break;
10805 op
= JimExprOperatorInfo(Jim_GetString(expr
->obj
[i
], NULL
));
10813 Jim_ListAppendElement(interp
, objPtr
,
10814 Jim_NewStringObj(interp
, type
, -1));
10815 Jim_ListAppendElement(interp
, objPtr
, expr
->obj
[i
]);
10817 Jim_SetResult(interp
, objPtr
);
10820 Jim_SetResultString(interp
,
10821 "bad option. Valid options are refcount, "
10822 "objcount, objects, invstr", -1);
10825 return JIM_OK
; /* unreached */
10829 static int Jim_EvalCoreCommand(Jim_Interp
*interp
, int argc
,
10830 Jim_Obj
*const *argv
)
10833 return Jim_EvalObj(interp
, argv
[1]);
10834 } else if (argc
> 2) {
10838 objPtr
= Jim_ConcatObj(interp
, argc
-1, argv
+1);
10839 Jim_IncrRefCount(objPtr
);
10840 retcode
= Jim_EvalObj(interp
, objPtr
);
10841 Jim_DecrRefCount(interp
, objPtr
);
10844 Jim_WrongNumArgs(interp
, 1, argv
, "script ?...?");
10850 static int Jim_UplevelCoreCommand(Jim_Interp
*interp
, int argc
,
10851 Jim_Obj
*const *argv
)
10854 int retcode
, newLevel
, oldLevel
;
10855 Jim_CallFrame
*savedCallFrame
, *targetCallFrame
;
10859 /* Save the old callframe pointer */
10860 savedCallFrame
= interp
->framePtr
;
10862 /* Lookup the target frame pointer */
10863 str
= Jim_GetString(argv
[1], NULL
);
10864 if ((str
[0] >= '0' && str
[0] <= '9') || str
[0] == '#')
10866 if (Jim_GetCallFrameByLevel(interp
, argv
[1],
10868 &newLevel
) != JIM_OK
)
10873 if (Jim_GetCallFrameByLevel(interp
, NULL
,
10875 &newLevel
) != JIM_OK
)
10881 Jim_WrongNumArgs(interp
, 1, argv
,
10882 "?level? command ?arg ...?");
10885 /* Eval the code in the target callframe. */
10886 interp
->framePtr
= targetCallFrame
;
10887 oldLevel
= interp
->numLevels
;
10888 interp
->numLevels
= newLevel
;
10890 retcode
= Jim_EvalObj(interp
, argv
[1]);
10892 objPtr
= Jim_ConcatObj(interp
, argc
-1, argv
+1);
10893 Jim_IncrRefCount(objPtr
);
10894 retcode
= Jim_EvalObj(interp
, objPtr
);
10895 Jim_DecrRefCount(interp
, objPtr
);
10897 interp
->numLevels
= oldLevel
;
10898 interp
->framePtr
= savedCallFrame
;
10901 Jim_WrongNumArgs(interp
, 1, argv
, "?level? command ?arg ...?");
10907 static int Jim_ExprCoreCommand(Jim_Interp
*interp
, int argc
,
10908 Jim_Obj
*const *argv
)
10910 Jim_Obj
*exprResultPtr
;
10914 retcode
= Jim_EvalExpression(interp
, argv
[1], &exprResultPtr
);
10915 } else if (argc
> 2) {
10918 objPtr
= Jim_ConcatObj(interp
, argc
-1, argv
+1);
10919 Jim_IncrRefCount(objPtr
);
10920 retcode
= Jim_EvalExpression(interp
, objPtr
, &exprResultPtr
);
10921 Jim_DecrRefCount(interp
, objPtr
);
10923 Jim_WrongNumArgs(interp
, 1, argv
, "expression ?...?");
10926 if (retcode
!= JIM_OK
) return retcode
;
10927 Jim_SetResult(interp
, exprResultPtr
);
10928 Jim_DecrRefCount(interp
, exprResultPtr
);
10933 static int Jim_BreakCoreCommand(Jim_Interp
*interp
, int argc
,
10934 Jim_Obj
*const *argv
)
10937 Jim_WrongNumArgs(interp
, 1, argv
, "");
10944 static int Jim_ContinueCoreCommand(Jim_Interp
*interp
, int argc
,
10945 Jim_Obj
*const *argv
)
10948 Jim_WrongNumArgs(interp
, 1, argv
, "");
10951 return JIM_CONTINUE
;
10955 static int Jim_ReturnCoreCommand(Jim_Interp
*interp
, int argc
,
10956 Jim_Obj
*const *argv
)
10960 } else if (argc
== 2) {
10961 Jim_SetResult(interp
, argv
[1]);
10962 interp
->returnCode
= JIM_OK
;
10964 } else if (argc
== 3 || argc
== 4) {
10966 if (Jim_GetReturnCode(interp
, argv
[2], &returnCode
) == JIM_ERR
)
10968 interp
->returnCode
= returnCode
;
10970 Jim_SetResult(interp
, argv
[3]);
10973 Jim_WrongNumArgs(interp
, 1, argv
, "?-code code? ?result?");
10976 return JIM_RETURN
; /* unreached */
10980 static int Jim_TailcallCoreCommand(Jim_Interp
*interp
, int argc
,
10981 Jim_Obj
*const *argv
)
10985 objPtr
= Jim_NewListObj(interp
, argv
+1, argc
-1);
10986 Jim_SetResult(interp
, objPtr
);
10991 static int Jim_ProcCoreCommand(Jim_Interp
*interp
, int argc
,
10992 Jim_Obj
*const *argv
)
10995 int arityMin
, arityMax
;
10997 if (argc
!= 4 && argc
!= 5) {
10998 Jim_WrongNumArgs(interp
, 1, argv
, "name arglist ?statics? body");
11001 Jim_ListLength(interp
, argv
[2], &argListLen
);
11002 arityMin
= arityMax
= argListLen
+1;
11009 /* Check for 'args' and adjust arityMin and arityMax if necessary */
11010 Jim_ListIndex(interp
, argv
[2], argListLen
-1, &argPtr
, JIM_NONE
);
11011 str
= Jim_GetString(argPtr
, &len
);
11012 if (len
== 4 && memcmp(str
, "args", 4) == 0) {
11017 /* Check for default arguments and reduce arityMin if necessary */
11018 while (arityMin
> 1) {
11020 Jim_ListIndex(interp
, argv
[2], arityMin
- 2, &argPtr
, JIM_NONE
);
11021 Jim_ListLength(interp
, argPtr
, &len
);
11023 /* No default argument */
11030 return Jim_CreateProcedure(interp
, Jim_GetString(argv
[1], NULL
),
11031 argv
[2], NULL
, argv
[3], arityMin
, arityMax
);
11033 return Jim_CreateProcedure(interp
, Jim_GetString(argv
[1], NULL
),
11034 argv
[2], argv
[3], argv
[4], arityMin
, arityMax
);
11039 static int Jim_ConcatCoreCommand(Jim_Interp
*interp
, int argc
,
11040 Jim_Obj
*const *argv
)
11042 Jim_SetResult(interp
, Jim_ConcatObj(interp
, argc
-1, argv
+1));
11047 static int Jim_UpvarCoreCommand(Jim_Interp
*interp
, int argc
,
11048 Jim_Obj
*const *argv
)
11052 Jim_CallFrame
*targetCallFrame
;
11054 /* Lookup the target frame pointer */
11055 str
= Jim_GetString(argv
[1], NULL
);
11057 ((str
[0] >= '0' && str
[0] <= '9') || str
[0] == '#'))
11059 if (Jim_GetCallFrameByLevel(interp
, argv
[1],
11060 &targetCallFrame
, NULL
) != JIM_OK
)
11065 if (Jim_GetCallFrameByLevel(interp
, NULL
,
11066 &targetCallFrame
, NULL
) != JIM_OK
)
11069 /* Check for arity */
11070 if (argc
< 3 || ((argc
-1)%2) != 0) {
11071 Jim_WrongNumArgs(interp
, 1, argv
, "?level? otherVar localVar ?otherVar localVar ...?");
11074 /* Now... for every other/local couple: */
11075 for (i
= 1; i
< argc
; i
+= 2) {
11076 if (Jim_SetVariableLink(interp
, argv
[i
+1], argv
[i
],
11077 targetCallFrame
) != JIM_OK
) return JIM_ERR
;
11083 static int Jim_GlobalCoreCommand(Jim_Interp
*interp
, int argc
,
11084 Jim_Obj
*const *argv
)
11089 Jim_WrongNumArgs(interp
, 1, argv
, "varName ?varName ...?");
11092 /* Link every var to the toplevel having the same name */
11093 if (interp
->numLevels
== 0) return JIM_OK
; /* global at toplevel... */
11094 for (i
= 1; i
< argc
; i
++) {
11095 if (Jim_SetVariableLink(interp
, argv
[i
], argv
[i
],
11096 interp
->topFramePtr
) != JIM_OK
) return JIM_ERR
;
11101 /* does the [string map] operation. On error NULL is returned,
11102 * otherwise a new string object with the result, having refcount = 0,
11104 static Jim_Obj
*JimStringMap(Jim_Interp
*interp
, Jim_Obj
*mapListObjPtr
,
11105 Jim_Obj
*objPtr
, int nocase
)
11108 const char **key
, *str
, *noMatchStart
= NULL
;
11110 int *keyLen
, strLen
, i
;
11111 Jim_Obj
*resultObjPtr
;
11113 Jim_ListLength(interp
, mapListObjPtr
, &numMaps
);
11115 Jim_SetResultString(interp
,
11116 "list must contain an even number of elements", -1);
11119 /* Initialization */
11121 key
= Jim_Alloc(sizeof(char*)*numMaps
);
11122 keyLen
= Jim_Alloc(sizeof(int)*numMaps
);
11123 value
= Jim_Alloc(sizeof(Jim_Obj
*)*numMaps
);
11124 resultObjPtr
= Jim_NewStringObj(interp
, "", 0);
11125 for (i
= 0; i
< numMaps
; i
++) {
11126 Jim_Obj
*eleObjPtr
;
11128 Jim_ListIndex(interp
, mapListObjPtr
, i
*2, &eleObjPtr
, JIM_NONE
);
11129 key
[i
] = Jim_GetString(eleObjPtr
, &keyLen
[i
]);
11130 Jim_ListIndex(interp
, mapListObjPtr
, i
*2+1, &eleObjPtr
, JIM_NONE
);
11131 value
[i
] = eleObjPtr
;
11133 str
= Jim_GetString(objPtr
, &strLen
);
11136 for (i
= 0; i
< numMaps
; i
++) {
11137 if (strLen
>= keyLen
[i
] && keyLen
[i
]) {
11138 if (!JimStringCompare(str
, keyLen
[i
], key
[i
], keyLen
[i
],
11141 if (noMatchStart
) {
11142 Jim_AppendString(interp
, resultObjPtr
,
11143 noMatchStart
, str
-noMatchStart
);
11144 noMatchStart
= NULL
;
11146 Jim_AppendObj(interp
, resultObjPtr
, value
[i
]);
11148 strLen
-= keyLen
[i
];
11153 if (i
== numMaps
) { /* no match */
11154 if (noMatchStart
== NULL
)
11155 noMatchStart
= str
;
11160 if (noMatchStart
) {
11161 Jim_AppendString(interp
, resultObjPtr
,
11162 noMatchStart
, str
-noMatchStart
);
11164 Jim_Free((void*)key
);
11167 return resultObjPtr
;
11171 static int Jim_StringCoreCommand(Jim_Interp
*interp
, int argc
,
11172 Jim_Obj
*const *argv
)
11175 const char *options
[] = {
11176 "length", "compare", "match", "equal", "range", "map", "repeat",
11177 "index", "first", "tolower", "toupper", NULL
11180 OPT_LENGTH
, OPT_COMPARE
, OPT_MATCH
, OPT_EQUAL
, OPT_RANGE
,
11181 OPT_MAP
, OPT_REPEAT
, OPT_INDEX
, OPT_FIRST
, OPT_TOLOWER
, OPT_TOUPPER
11185 Jim_WrongNumArgs(interp
, 1, argv
, "option ?arguments ...?");
11188 if (Jim_GetEnum(interp
, argv
[1], options
, &option
, "option",
11189 JIM_ERRMSG
) != JIM_OK
)
11192 if (option
== OPT_LENGTH
) {
11196 Jim_WrongNumArgs(interp
, 2, argv
, "string");
11199 Jim_GetString(argv
[2], &len
);
11200 Jim_SetResult(interp
, Jim_NewIntObj(interp
, len
));
11202 } else if (option
== OPT_COMPARE
) {
11204 if ((argc
!= 4 && argc
!= 5) ||
11205 (argc
== 5 && Jim_CompareStringImmediate(interp
,
11206 argv
[2], "-nocase") == 0)) {
11207 Jim_WrongNumArgs(interp
, 2, argv
, "string1 string2");
11214 Jim_SetResult(interp
, Jim_NewIntObj(interp
,
11215 Jim_StringCompareObj(argv
[2],
11216 argv
[3], nocase
)));
11218 } else if (option
== OPT_MATCH
) {
11220 if ((argc
!= 4 && argc
!= 5) ||
11221 (argc
== 5 && Jim_CompareStringImmediate(interp
,
11222 argv
[2], "-nocase") == 0)) {
11223 Jim_WrongNumArgs(interp
, 2, argv
, "?-nocase? pattern "
11231 Jim_SetResult(interp
,
11232 Jim_NewIntObj(interp
, Jim_StringMatchObj(argv
[2],
11233 argv
[3], nocase
)));
11235 } else if (option
== OPT_EQUAL
) {
11237 Jim_WrongNumArgs(interp
, 2, argv
, "string1 string2");
11240 Jim_SetResult(interp
,
11241 Jim_NewIntObj(interp
, Jim_StringEqObj(argv
[2],
11244 } else if (option
== OPT_RANGE
) {
11248 Jim_WrongNumArgs(interp
, 2, argv
, "string first last");
11251 objPtr
= Jim_StringRangeObj(interp
, argv
[2], argv
[3], argv
[4]);
11252 if (objPtr
== NULL
)
11254 Jim_SetResult(interp
, objPtr
);
11256 } else if (option
== OPT_MAP
) {
11260 if ((argc
!= 4 && argc
!= 5) ||
11261 (argc
== 5 && Jim_CompareStringImmediate(interp
,
11262 argv
[2], "-nocase") == 0)) {
11263 Jim_WrongNumArgs(interp
, 2, argv
, "?-nocase? mapList "
11271 objPtr
= JimStringMap(interp
, argv
[2], argv
[3], nocase
);
11272 if (objPtr
== NULL
)
11274 Jim_SetResult(interp
, objPtr
);
11276 } else if (option
== OPT_REPEAT
) {
11281 Jim_WrongNumArgs(interp
, 2, argv
, "string count");
11284 if (Jim_GetWide(interp
, argv
[3], &count
) != JIM_OK
)
11286 objPtr
= Jim_NewStringObj(interp
, "", 0);
11288 Jim_AppendObj(interp
, objPtr
, argv
[2]);
11290 Jim_SetResult(interp
, objPtr
);
11292 } else if (option
== OPT_INDEX
) {
11297 Jim_WrongNumArgs(interp
, 2, argv
, "string index");
11300 if (Jim_GetIndex(interp
, argv
[3], &index
) != JIM_OK
)
11302 str
= Jim_GetString(argv
[2], &len
);
11303 if (index
!= INT_MIN
&& index
!= INT_MAX
)
11304 index
= JimRelToAbsIndex(len
, index
);
11305 if (index
< 0 || index
>= len
) {
11306 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
11309 Jim_SetResult(interp
, Jim_NewStringObj(interp
, str
+index
, 1));
11312 } else if (option
== OPT_FIRST
) {
11313 int index
= 0, l1
, l2
;
11314 const char *s1
, *s2
;
11316 if (argc
!= 4 && argc
!= 5) {
11317 Jim_WrongNumArgs(interp
, 2, argv
, "subString string ?startIndex?");
11320 s1
= Jim_GetString(argv
[2], &l1
);
11321 s2
= Jim_GetString(argv
[3], &l2
);
11323 if (Jim_GetIndex(interp
, argv
[4], &index
) != JIM_OK
)
11325 index
= JimRelToAbsIndex(l2
, index
);
11327 Jim_SetResult(interp
, Jim_NewIntObj(interp
,
11328 JimStringFirst(s1
, l1
, s2
, l2
, index
)));
11330 } else if (option
== OPT_TOLOWER
) {
11332 Jim_WrongNumArgs(interp
, 2, argv
, "string");
11335 Jim_SetResult(interp
, JimStringToLower(interp
, argv
[2]));
11336 } else if (option
== OPT_TOUPPER
) {
11338 Jim_WrongNumArgs(interp
, 2, argv
, "string");
11341 Jim_SetResult(interp
, JimStringToUpper(interp
, argv
[2]));
11347 static int Jim_TimeCoreCommand(Jim_Interp
*interp
, int argc
,
11348 Jim_Obj
*const *argv
)
11351 jim_wide start
, elapsed
;
11353 const char *fmt
= "%" JIM_WIDE_MODIFIER
" microseconds per iteration";
11356 Jim_WrongNumArgs(interp
, 1, argv
, "script ?count?");
11360 if (Jim_GetLong(interp
, argv
[2], &count
) != JIM_OK
)
11366 start
= JimClock();
11370 if ((retval
= Jim_EvalObj(interp
, argv
[1])) != JIM_OK
)
11373 elapsed
= JimClock() - start
;
11374 sprintf(buf
, fmt
, elapsed
/count
);
11375 Jim_SetResultString(interp
, buf
, -1);
11380 static int Jim_ExitCoreCommand(Jim_Interp
*interp
, int argc
,
11381 Jim_Obj
*const *argv
)
11386 Jim_WrongNumArgs(interp
, 1, argv
, "?exitCode?");
11390 if (Jim_GetLong(interp
, argv
[1], &exitCode
) != JIM_OK
)
11393 interp
->exitCode
= exitCode
;
11398 static int Jim_CatchCoreCommand(Jim_Interp
*interp
, int argc
,
11399 Jim_Obj
*const *argv
)
11403 if (argc
!= 2 && argc
!= 3) {
11404 Jim_WrongNumArgs(interp
, 1, argv
, "script ?varName?");
11407 exitCode
= Jim_EvalObj(interp
, argv
[1]);
11409 if (Jim_SetVariable(interp
, argv
[2], Jim_GetResult(interp
))
11413 Jim_SetResult(interp
, Jim_NewIntObj(interp
, exitCode
));
11418 static int Jim_RefCoreCommand(Jim_Interp
*interp
, int argc
,
11419 Jim_Obj
*const *argv
)
11421 if (argc
!= 3 && argc
!= 4) {
11422 Jim_WrongNumArgs(interp
, 1, argv
, "string tag ?finalizer?");
11426 Jim_SetResult(interp
, Jim_NewReference(interp
, argv
[1], argv
[2], NULL
));
11428 Jim_SetResult(interp
, Jim_NewReference(interp
, argv
[1], argv
[2],
11435 static int Jim_GetrefCoreCommand(Jim_Interp
*interp
, int argc
,
11436 Jim_Obj
*const *argv
)
11438 Jim_Reference
*refPtr
;
11441 Jim_WrongNumArgs(interp
, 1, argv
, "reference");
11444 if ((refPtr
= Jim_GetReference(interp
, argv
[1])) == NULL
)
11446 Jim_SetResult(interp
, refPtr
->objPtr
);
11451 static int Jim_SetrefCoreCommand(Jim_Interp
*interp
, int argc
,
11452 Jim_Obj
*const *argv
)
11454 Jim_Reference
*refPtr
;
11457 Jim_WrongNumArgs(interp
, 1, argv
, "reference newValue");
11460 if ((refPtr
= Jim_GetReference(interp
, argv
[1])) == NULL
)
11462 Jim_IncrRefCount(argv
[2]);
11463 Jim_DecrRefCount(interp
, refPtr
->objPtr
);
11464 refPtr
->objPtr
= argv
[2];
11465 Jim_SetResult(interp
, argv
[2]);
11470 static int Jim_CollectCoreCommand(Jim_Interp
*interp
, int argc
,
11471 Jim_Obj
*const *argv
)
11474 Jim_WrongNumArgs(interp
, 1, argv
, "");
11477 Jim_SetResult(interp
, Jim_NewIntObj(interp
, Jim_Collect(interp
)));
11481 /* [finalize] reference ?newValue? */
11482 static int Jim_FinalizeCoreCommand(Jim_Interp
*interp
, int argc
,
11483 Jim_Obj
*const *argv
)
11485 if (argc
!= 2 && argc
!= 3) {
11486 Jim_WrongNumArgs(interp
, 1, argv
, "reference ?finalizerProc?");
11490 Jim_Obj
*cmdNamePtr
;
11492 if (Jim_GetFinalizer(interp
, argv
[1], &cmdNamePtr
) != JIM_OK
)
11494 if (cmdNamePtr
!= NULL
) /* otherwise the null string is returned. */
11495 Jim_SetResult(interp
, cmdNamePtr
);
11497 if (Jim_SetFinalizer(interp
, argv
[1], argv
[2]) != JIM_OK
)
11499 Jim_SetResult(interp
, argv
[2]);
11505 /* [info references] (list of all the references/finalizers) */
11508 static int Jim_RenameCoreCommand(Jim_Interp
*interp
, int argc
,
11509 Jim_Obj
*const *argv
)
11511 const char *oldName
, *newName
;
11514 Jim_WrongNumArgs(interp
, 1, argv
, "oldName newName");
11517 oldName
= Jim_GetString(argv
[1], NULL
);
11518 newName
= Jim_GetString(argv
[2], NULL
);
11519 if (Jim_RenameCommand(interp
, oldName
, newName
) != JIM_OK
) {
11520 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
11521 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
11522 "can't rename \"", oldName
, "\": ",
11523 "command doesn't exist", NULL
);
11530 static int Jim_DictCoreCommand(Jim_Interp
*interp
, int argc
,
11531 Jim_Obj
*const *argv
)
11534 const char *options
[] = {
11535 "create", "get", "set", "unset", "exists", NULL
11538 OPT_CREATE
, OPT_GET
, OPT_SET
, OPT_UNSET
, OPT_EXIST
11542 Jim_WrongNumArgs(interp
, 1, argv
, "option ?arguments ...?");
11546 if (Jim_GetEnum(interp
, argv
[1], options
, &option
, "option",
11547 JIM_ERRMSG
) != JIM_OK
)
11550 if (option
== OPT_CREATE
) {
11554 Jim_WrongNumArgs(interp
, 2, argv
, "?key value ...?");
11557 objPtr
= Jim_NewDictObj(interp
, argv
+2, argc
-2);
11558 Jim_SetResult(interp
, objPtr
);
11560 } else if (option
== OPT_GET
) {
11563 if (Jim_DictKeysVector(interp
, argv
[2], argv
+3, argc
-3, &objPtr
,
11564 JIM_ERRMSG
) != JIM_OK
)
11566 Jim_SetResult(interp
, objPtr
);
11568 } else if (option
== OPT_SET
) {
11570 Jim_WrongNumArgs(interp
, 2, argv
, "varName key ?key ...? value");
11573 return Jim_SetDictKeysVector(interp
, argv
[2], argv
+3, argc
-4,
11575 } else if (option
== OPT_UNSET
) {
11577 Jim_WrongNumArgs(interp
, 2, argv
, "varName key ?key ...?");
11580 return Jim_SetDictKeysVector(interp
, argv
[2], argv
+3, argc
-3,
11582 } else if (option
== OPT_EXIST
) {
11586 if (Jim_DictKeysVector(interp
, argv
[2], argv
+3, argc
-3, &objPtr
,
11587 JIM_ERRMSG
) == JIM_OK
)
11591 Jim_SetResult(interp
, Jim_NewIntObj(interp
, exists
));
11594 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
11595 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
11596 "bad option \"", Jim_GetString(argv
[1], NULL
), "\":",
11597 " must be create, get, set", NULL
);
11604 static int Jim_LoadCoreCommand(Jim_Interp
*interp
, int argc
,
11605 Jim_Obj
*const *argv
)
11608 Jim_WrongNumArgs(interp
, 1, argv
, "libaryFile");
11611 return Jim_LoadLibrary(interp
, Jim_GetString(argv
[1], NULL
));
11615 static int Jim_SubstCoreCommand(Jim_Interp
*interp
, int argc
,
11616 Jim_Obj
*const *argv
)
11622 Jim_WrongNumArgs(interp
, 1, argv
,
11623 "?-nobackslashes? ?-nocommands? ?-novariables? string");
11628 if (Jim_CompareStringImmediate(interp
, argv
[i
+1],
11630 flags
|= JIM_SUBST_NOESC
;
11631 else if (Jim_CompareStringImmediate(interp
, argv
[i
+1],
11633 flags
|= JIM_SUBST_NOVAR
;
11634 else if (Jim_CompareStringImmediate(interp
, argv
[i
+1],
11636 flags
|= JIM_SUBST_NOCMD
;
11638 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
11639 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
11640 "bad option \"", Jim_GetString(argv
[i
+1], NULL
),
11641 "\": must be -nobackslashes, -nocommands, or "
11642 "-novariables", NULL
);
11646 if (Jim_SubstObj(interp
, argv
[argc
-1], &objPtr
, flags
) != JIM_OK
)
11648 Jim_SetResult(interp
, objPtr
);
11653 static int Jim_InfoCoreCommand(Jim_Interp
*interp
, int argc
,
11654 Jim_Obj
*const *argv
)
11656 int cmd
, result
= JIM_OK
;
11657 static const char *commands
[] = {
11658 "body", "commands", "exists", "globals", "level", "locals",
11659 "vars", "version", "complete", "args", "hostname", NULL
11661 enum {INFO_BODY
, INFO_COMMANDS
, INFO_EXISTS
, INFO_GLOBALS
, INFO_LEVEL
,
11662 INFO_LOCALS
, INFO_VARS
, INFO_VERSION
, INFO_COMPLETE
, INFO_ARGS
, INFO_HOSTNAME
};
11665 Jim_WrongNumArgs(interp
, 1, argv
, "command ?args ...?");
11668 if (Jim_GetEnum(interp
, argv
[1], commands
, &cmd
, "command", JIM_ERRMSG
)
11673 if (cmd
== INFO_COMMANDS
) {
11674 if (argc
!= 2 && argc
!= 3) {
11675 Jim_WrongNumArgs(interp
, 2, argv
, "?pattern?");
11679 Jim_SetResult(interp
,JimCommandsList(interp
, argv
[2]));
11681 Jim_SetResult(interp
, JimCommandsList(interp
, NULL
));
11682 } else if (cmd
== INFO_EXISTS
) {
11685 Jim_WrongNumArgs(interp
, 2, argv
, "varName");
11688 exists
= Jim_GetVariable(interp
, argv
[2], 0);
11689 Jim_SetResult(interp
, Jim_NewIntObj(interp
, exists
!= 0));
11690 } else if (cmd
== INFO_GLOBALS
|| cmd
== INFO_LOCALS
|| cmd
== INFO_VARS
) {
11693 case INFO_GLOBALS
: mode
= JIM_VARLIST_GLOBALS
; break;
11694 case INFO_LOCALS
: mode
= JIM_VARLIST_LOCALS
; break;
11695 case INFO_VARS
: mode
= JIM_VARLIST_VARS
; break;
11696 default: mode
= 0; /* avoid warning */; break;
11698 if (argc
!= 2 && argc
!= 3) {
11699 Jim_WrongNumArgs(interp
, 2, argv
, "?pattern?");
11703 Jim_SetResult(interp
,JimVariablesList(interp
, argv
[2], mode
));
11705 Jim_SetResult(interp
, JimVariablesList(interp
, NULL
, mode
));
11706 } else if (cmd
== INFO_LEVEL
) {
11710 Jim_SetResult(interp
,
11711 Jim_NewIntObj(interp
, interp
->numLevels
));
11714 if (JimInfoLevel(interp
, argv
[2], &objPtr
) != JIM_OK
)
11716 Jim_SetResult(interp
, objPtr
);
11719 Jim_WrongNumArgs(interp
, 2, argv
, "?levelNum?");
11722 } else if (cmd
== INFO_BODY
|| cmd
== INFO_ARGS
) {
11726 Jim_WrongNumArgs(interp
, 2, argv
, "procname");
11729 if ((cmdPtr
= Jim_GetCommand(interp
, argv
[2], JIM_ERRMSG
)) == NULL
)
11731 if (cmdPtr
->cmdProc
!= NULL
) {
11732 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
11733 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
11734 "command \"", Jim_GetString(argv
[2], NULL
),
11735 "\" is not a procedure", NULL
);
11738 if (cmd
== INFO_BODY
)
11739 Jim_SetResult(interp
, cmdPtr
->bodyObjPtr
);
11741 Jim_SetResult(interp
, cmdPtr
->argListObjPtr
);
11742 } else if (cmd
== INFO_VERSION
) {
11743 char buf
[(JIM_INTEGER_SPACE
* 2) + 1];
11744 sprintf(buf
, "%d.%d",
11745 JIM_VERSION
/ 100, JIM_VERSION
% 100);
11746 Jim_SetResultString(interp
, buf
, -1);
11747 } else if (cmd
== INFO_COMPLETE
) {
11752 Jim_WrongNumArgs(interp
, 2, argv
, "script");
11755 s
= Jim_GetString(argv
[2], &len
);
11756 Jim_SetResult(interp
,
11757 Jim_NewIntObj(interp
, Jim_ScriptIsComplete(s
, len
, NULL
)));
11758 } else if (cmd
== INFO_HOSTNAME
) {
11759 /* Redirect to os.hostname if it exists */
11760 Jim_Obj
*command
= Jim_NewStringObj(interp
, "os.gethostname", -1);
11761 result
= Jim_EvalObjVector(interp
, 1, &command
);
11767 static int Jim_SplitCoreCommand(Jim_Interp
*interp
, int argc
,
11768 Jim_Obj
*const *argv
)
11770 const char *str
, *splitChars
, *noMatchStart
;
11771 int splitLen
, strLen
, i
;
11772 Jim_Obj
*resObjPtr
;
11774 if (argc
!= 2 && argc
!= 3) {
11775 Jim_WrongNumArgs(interp
, 1, argv
, "string ?splitChars?");
11780 splitChars
= " \n\t\r";
11783 splitChars
= Jim_GetString(argv
[2], &splitLen
);
11785 str
= Jim_GetString(argv
[1], &strLen
);
11786 if (!strLen
) return JIM_OK
;
11787 noMatchStart
= str
;
11788 resObjPtr
= Jim_NewListObj(interp
, NULL
, 0);
11792 for (i
= 0; i
< splitLen
; i
++) {
11793 if (*str
== splitChars
[i
]) {
11796 objPtr
= Jim_NewStringObj(interp
, noMatchStart
,
11797 (str
-noMatchStart
));
11798 Jim_ListAppendElement(interp
, resObjPtr
, objPtr
);
11799 noMatchStart
= str
+1;
11806 Jim_ListAppendElement(interp
, resObjPtr
,
11807 Jim_NewStringObj(interp
, noMatchStart
, (str
-noMatchStart
)));
11809 /* This handles the special case of splitchars eq {}. This
11810 * is trivial but we want to perform object sharing as Tcl does. */
11811 Jim_Obj
*objCache
[256];
11812 const unsigned char *u
= (unsigned char*) str
;
11813 memset(objCache
, 0, sizeof(objCache
));
11814 for (i
= 0; i
< strLen
; i
++) {
11817 if (objCache
[c
] == NULL
)
11818 objCache
[c
] = Jim_NewStringObj(interp
, (char*)u
+i
, 1);
11819 Jim_ListAppendElement(interp
, resObjPtr
, objCache
[c
]);
11822 Jim_SetResult(interp
, resObjPtr
);
11827 static int Jim_JoinCoreCommand(Jim_Interp
*interp
, int argc
,
11828 Jim_Obj
*const *argv
)
11830 const char *joinStr
;
11831 int joinStrLen
, i
, listLen
;
11832 Jim_Obj
*resObjPtr
;
11834 if (argc
!= 2 && argc
!= 3) {
11835 Jim_WrongNumArgs(interp
, 1, argv
, "list ?joinString?");
11843 joinStr
= Jim_GetString(argv
[2], &joinStrLen
);
11845 Jim_ListLength(interp
, argv
[1], &listLen
);
11846 resObjPtr
= Jim_NewStringObj(interp
, NULL
, 0);
11848 for (i
= 0; i
< listLen
; i
++) {
11851 Jim_ListIndex(interp
, argv
[1], i
, &objPtr
, JIM_NONE
);
11852 Jim_AppendObj(interp
, resObjPtr
, objPtr
);
11853 if (i
+1 != listLen
) {
11854 Jim_AppendString(interp
, resObjPtr
, joinStr
, joinStrLen
);
11857 Jim_SetResult(interp
, resObjPtr
);
11862 static int Jim_FormatCoreCommand(Jim_Interp
*interp
, int argc
,
11863 Jim_Obj
*const *argv
)
11868 Jim_WrongNumArgs(interp
, 1, argv
, "formatString ?arg arg ...?");
11871 objPtr
= Jim_FormatString(interp
, argv
[1], argc
-2, argv
+2);
11872 if (objPtr
== NULL
)
11874 Jim_SetResult(interp
, objPtr
);
11879 static int Jim_ScanCoreCommand(Jim_Interp
*interp
, int argc
,
11880 Jim_Obj
*const *argv
)
11882 Jim_Obj
*listPtr
, **outVec
;
11883 int outc
, i
, count
= 0;
11886 Jim_WrongNumArgs(interp
, 1, argv
, "string formatString ?varName ...?");
11889 if (argv
[2]->typePtr
!= &scanFmtStringObjType
)
11890 SetScanFmtFromAny(interp
, argv
[2]);
11891 if (FormatGetError(argv
[2]) != 0) {
11892 Jim_SetResultString(interp
, FormatGetError(argv
[2]), -1);
11896 int maxPos
= FormatGetMaxPos(argv
[2]);
11897 int count
= FormatGetCnvCount(argv
[2]);
11898 if (maxPos
> argc
-3) {
11899 Jim_SetResultString(interp
, "\"%n$\" argument index out of range", -1);
11901 } else if (count
!= 0 && count
< argc
-3) {
11902 Jim_SetResultString(interp
, "variable is not assigned by any "
11903 "conversion specifiers", -1);
11905 } else if (count
> argc
-3) {
11906 Jim_SetResultString(interp
, "different numbers of variable names and "
11907 "field specifiers", -1);
11911 listPtr
= Jim_ScanString(interp
, argv
[1], argv
[2], JIM_ERRMSG
);
11916 if (listPtr
!= 0 && listPtr
!= (Jim_Obj
*)EOF
)
11917 Jim_ListLength(interp
, listPtr
, &len
);
11918 if (listPtr
== (Jim_Obj
*)EOF
|| len
== 0) { // XXX
11919 Jim_SetResult(interp
, Jim_NewIntObj(interp
, -1));
11922 JimListGetElements(interp
, listPtr
, &outc
, &outVec
);
11923 for (i
= 0; i
< outc
; ++i
) {
11924 if (Jim_Length(outVec
[i
]) > 0) {
11926 if (Jim_SetVariable(interp
, argv
[3+i
], outVec
[i
]) != JIM_OK
)
11930 Jim_FreeNewObj(interp
, listPtr
);
11931 Jim_SetResult(interp
, Jim_NewIntObj(interp
, count
));
11933 if (listPtr
== (Jim_Obj
*)EOF
) {
11934 Jim_SetResult(interp
, Jim_NewListObj(interp
, 0, 0));
11937 Jim_SetResult(interp
, listPtr
);
11941 Jim_FreeNewObj(interp
, listPtr
);
11946 static int Jim_ErrorCoreCommand(Jim_Interp
*interp
, int argc
,
11947 Jim_Obj
*const *argv
)
11950 Jim_WrongNumArgs(interp
, 1, argv
, "message");
11953 Jim_SetResult(interp
, argv
[1]);
11958 static int Jim_LrangeCoreCommand(Jim_Interp
*interp
, int argc
,
11959 Jim_Obj
*const *argv
)
11964 Jim_WrongNumArgs(interp
, 1, argv
, "list first last");
11967 if ((objPtr
= Jim_ListRange(interp
, argv
[1], argv
[2], argv
[3])) == NULL
)
11969 Jim_SetResult(interp
, objPtr
);
11974 static int Jim_EnvCoreCommand(Jim_Interp
*interp
, int argc
,
11975 Jim_Obj
*const *argv
)
11983 extern char **environ
;
11987 Jim_Obj
*listObjPtr
= Jim_NewListObj(interp
, NULL
, 0);
11989 for (i
= 0; environ
[i
]; i
++) {
11990 const char *equals
= strchr(environ
[i
], '=');
11992 Jim_ListAppendElement(interp
, listObjPtr
, Jim_NewStringObj(interp
, environ
[i
], equals
- environ
[i
]));
11993 Jim_ListAppendElement(interp
, listObjPtr
, Jim_NewStringObj(interp
, equals
+ 1, -1));
11997 Jim_SetResult(interp
, listObjPtr
);
12002 Jim_WrongNumArgs(interp
, 1, argv
, "varName");
12005 key
= Jim_GetString(argv
[1], NULL
);
12008 Jim_SetResult(interp
, Jim_NewEmptyStringObj(interp
));
12009 Jim_AppendStrings(interp
, Jim_GetResult(interp
),
12010 "environment variable \"",
12011 key
, "\" does not exist", NULL
);
12014 Jim_SetResult(interp
, Jim_NewStringObj(interp
, val
, -1));
12019 static int Jim_SourceCoreCommand(Jim_Interp
*interp
, int argc
,
12020 Jim_Obj
*const *argv
)
12025 Jim_WrongNumArgs(interp
, 1, argv
, "fileName");
12028 retval
= Jim_EvalFile(interp
, Jim_GetString(argv
[1], NULL
));
12029 if (retval
== JIM_ERR
) {
12030 return JIM_ERR_ADDSTACK
;
12032 if (retval
== JIM_RETURN
)
12038 static int Jim_LreverseCoreCommand(Jim_Interp
*interp
, int argc
,
12039 Jim_Obj
*const *argv
)
12041 Jim_Obj
*revObjPtr
, **ele
;
12045 Jim_WrongNumArgs(interp
, 1, argv
, "list");
12048 JimListGetElements(interp
, argv
[1], &len
, &ele
);
12050 revObjPtr
= Jim_NewListObj(interp
, NULL
, 0);
12052 ListAppendElement(revObjPtr
, ele
[len
--]);
12053 Jim_SetResult(interp
, revObjPtr
);
12057 static int JimRangeLen(jim_wide start
, jim_wide end
, jim_wide step
)
12061 if (step
== 0) return -1;
12062 if (start
== end
) return 0;
12063 else if (step
> 0 && start
> end
) return -1;
12064 else if (step
< 0 && end
> start
) return -1;
12066 if (len
< 0) len
= -len
; /* abs(len) */
12067 if (step
< 0) step
= -step
; /* abs(step) */
12068 len
= 1 + ((len
-1)/step
);
12069 /* We can truncate safely to INT_MAX, the range command
12070 * will always return an error for a such long range
12071 * because Tcl lists can't be so long. */
12072 if (len
> INT_MAX
) len
= INT_MAX
;
12073 return (int)((len
< 0) ? -1 : len
);
12077 static int Jim_RangeCoreCommand(Jim_Interp
*interp
, int argc
,
12078 Jim_Obj
*const *argv
)
12080 jim_wide start
= 0, end
, step
= 1;
12084 if (argc
< 2 || argc
> 4) {
12085 Jim_WrongNumArgs(interp
, 1, argv
, "?start? end ?step?");
12089 if (Jim_GetWide(interp
, argv
[1], &end
) != JIM_OK
)
12092 if (Jim_GetWide(interp
, argv
[1], &start
) != JIM_OK
||
12093 Jim_GetWide(interp
, argv
[2], &end
) != JIM_OK
)
12095 if (argc
== 4 && Jim_GetWide(interp
, argv
[3], &step
) != JIM_OK
)
12098 if ((len
= JimRangeLen(start
, end
, step
)) == -1) {
12099 Jim_SetResultString(interp
, "Invalid (infinite?) range specified", -1);
12102 objPtr
= Jim_NewListObj(interp
, NULL
, 0);
12103 for (i
= 0; i
< len
; i
++)
12104 ListAppendElement(objPtr
, Jim_NewIntObj(interp
, start
+i
*step
));
12105 Jim_SetResult(interp
, objPtr
);
12110 static int Jim_RandCoreCommand(Jim_Interp
*interp
, int argc
,
12111 Jim_Obj
*const *argv
)
12113 jim_wide min
= 0, max
, len
, maxMul
;
12115 if (argc
< 1 || argc
> 3) {
12116 Jim_WrongNumArgs(interp
, 1, argv
, "?min? max");
12120 max
= JIM_WIDE_MAX
;
12121 } else if (argc
== 2) {
12122 if (Jim_GetWide(interp
, argv
[1], &max
) != JIM_OK
)
12124 } else if (argc
== 3) {
12125 if (Jim_GetWide(interp
, argv
[1], &min
) != JIM_OK
||
12126 Jim_GetWide(interp
, argv
[2], &max
) != JIM_OK
)
12131 Jim_SetResultString(interp
, "Invalid arguments (max < min)", -1);
12134 maxMul
= JIM_WIDE_MAX
- (len
? (JIM_WIDE_MAX
%len
) : 0);
12138 JimRandomBytes(interp
, &r
, sizeof(jim_wide
));
12139 if (r
< 0 || r
>= maxMul
) continue;
12140 r
= (len
== 0) ? 0 : r
%len
;
12141 Jim_SetResult(interp
, Jim_NewIntObj(interp
, min
+r
));
12147 static int Jim_PackageCoreCommand(Jim_Interp
*interp
, int argc
,
12148 Jim_Obj
*const *argv
)
12151 const char *options
[] = {
12152 "require", "provide", NULL
12154 enum {OPT_REQUIRE
, OPT_PROVIDE
};
12157 Jim_WrongNumArgs(interp
, 1, argv
, "option ?arguments ...?");
12160 if (Jim_GetEnum(interp
, argv
[1], options
, &option
, "option",
12161 JIM_ERRMSG
) != JIM_OK
)
12164 if (option
== OPT_REQUIRE
) {
12168 if (Jim_CompareStringImmediate(interp
, argv
[2], "-exact")) {
12173 if (argc
!= 3 && argc
!= 4) {
12174 Jim_WrongNumArgs(interp
, 2, argv
, "?-exact? package ?version?");
12177 ver
= Jim_PackageRequire(interp
, Jim_GetString(argv
[2], NULL
),
12178 argc
== 4 ? Jim_GetString(argv
[3], NULL
) : "",
12181 return JIM_ERR_ADDSTACK
;
12182 Jim_SetResultString(interp
, ver
, -1);
12183 } else if (option
== OPT_PROVIDE
) {
12185 Jim_WrongNumArgs(interp
, 2, argv
, "package version");
12188 return Jim_PackageProvide(interp
, Jim_GetString(argv
[2], NULL
),
12189 Jim_GetString(argv
[3], NULL
), JIM_ERRMSG
);
12196 Jim_CmdProc cmdProc
;
12197 } Jim_CoreCommandsTable
[] = {
12198 {"set", Jim_SetCoreCommand
},
12199 {"unset", Jim_UnsetCoreCommand
},
12200 {"puts", Jim_PutsCoreCommand
},
12201 {"+", Jim_AddCoreCommand
},
12202 {"*", Jim_MulCoreCommand
},
12203 {"-", Jim_SubCoreCommand
},
12204 {"/", Jim_DivCoreCommand
},
12205 {"incr", Jim_IncrCoreCommand
},
12206 {"while", Jim_WhileCoreCommand
},
12207 {"for", Jim_ForCoreCommand
},
12208 {"foreach", Jim_ForeachCoreCommand
},
12209 {"lmap", Jim_LmapCoreCommand
},
12210 {"if", Jim_IfCoreCommand
},
12211 {"switch", Jim_SwitchCoreCommand
},
12212 {"list", Jim_ListCoreCommand
},
12213 {"lindex", Jim_LindexCoreCommand
},
12214 {"lset", Jim_LsetCoreCommand
},
12215 {"llength", Jim_LlengthCoreCommand
},
12216 {"lappend", Jim_LappendCoreCommand
},
12217 {"linsert", Jim_LinsertCoreCommand
},
12218 {"lsort", Jim_LsortCoreCommand
},
12219 {"append", Jim_AppendCoreCommand
},
12220 {"debug", Jim_DebugCoreCommand
},
12221 {"eval", Jim_EvalCoreCommand
},
12222 {"uplevel", Jim_UplevelCoreCommand
},
12223 {"expr", Jim_ExprCoreCommand
},
12224 {"break", Jim_BreakCoreCommand
},
12225 {"continue", Jim_ContinueCoreCommand
},
12226 {"proc", Jim_ProcCoreCommand
},
12227 {"concat", Jim_ConcatCoreCommand
},
12228 {"return", Jim_ReturnCoreCommand
},
12229 {"upvar", Jim_UpvarCoreCommand
},
12230 {"global", Jim_GlobalCoreCommand
},
12231 {"string", Jim_StringCoreCommand
},
12232 {"time", Jim_TimeCoreCommand
},
12233 {"exit", Jim_ExitCoreCommand
},
12234 {"catch", Jim_CatchCoreCommand
},
12235 {"ref", Jim_RefCoreCommand
},
12236 {"getref", Jim_GetrefCoreCommand
},
12237 {"setref", Jim_SetrefCoreCommand
},
12238 {"finalize", Jim_FinalizeCoreCommand
},
12239 {"collect", Jim_CollectCoreCommand
},
12240 {"rename", Jim_RenameCoreCommand
},
12241 {"dict", Jim_DictCoreCommand
},
12242 {"load", Jim_LoadCoreCommand
},
12243 {"subst", Jim_SubstCoreCommand
},
12244 {"info", Jim_InfoCoreCommand
},
12245 {"split", Jim_SplitCoreCommand
},
12246 {"join", Jim_JoinCoreCommand
},
12247 {"format", Jim_FormatCoreCommand
},
12248 {"scan", Jim_ScanCoreCommand
},
12249 {"error", Jim_ErrorCoreCommand
},
12250 {"lrange", Jim_LrangeCoreCommand
},
12251 {"env", Jim_EnvCoreCommand
},
12252 {"source", Jim_SourceCoreCommand
},
12253 {"lreverse", Jim_LreverseCoreCommand
},
12254 {"range", Jim_RangeCoreCommand
},
12255 {"rand", Jim_RandCoreCommand
},
12256 {"package", Jim_PackageCoreCommand
},
12257 {"tailcall", Jim_TailcallCoreCommand
},
12261 /* Some Jim core command is actually a procedure written in Jim itself. */
12262 static void Jim_RegisterCoreProcedures(Jim_Interp
*interp
)
12264 Jim_Eval(interp
, (char*)
12265 "proc lambda {arglist args} {\n"
12266 " set name [ref {} function lambdaFinalizer]\n"
12267 " uplevel 1 [list proc $name $arglist {expand}$args]\n"
12270 "proc lambdaFinalizer {name val} {\n"
12271 " rename $name {}\n"
12276 void Jim_RegisterCoreCommands(Jim_Interp
*interp
)
12280 while(Jim_CoreCommandsTable
[i
].name
!= NULL
) {
12281 Jim_CreateCommand(interp
,
12282 Jim_CoreCommandsTable
[i
].name
,
12283 Jim_CoreCommandsTable
[i
].cmdProc
,
12287 Jim_RegisterCoreProcedures(interp
);
12290 /* -----------------------------------------------------------------------------
12291 * Interactive prompt
12292 * ---------------------------------------------------------------------------*/
12293 void Jim_PrintErrorMessage(Jim_Interp
*interp
)
12297 if (*interp
->errorFileName
) {
12298 Jim_fprintf(interp
, interp
->cookie_stderr
, "Runtime error, file \"%s\", line %d:" JIM_NL
" ",
12299 interp
->errorFileName
, interp
->errorLine
);
12301 Jim_fprintf(interp
,interp
->cookie_stderr
, "%s" JIM_NL
,
12302 Jim_GetString(interp
->result
, NULL
));
12303 Jim_ListLength(interp
, interp
->stackTrace
, &len
);
12304 for (i
= len
-3; i
>= 0; i
-= 3) {
12306 const char *proc
, *file
, *line
;
12308 Jim_ListIndex(interp
, interp
->stackTrace
, i
, &objPtr
, JIM_NONE
);
12309 proc
= Jim_GetString(objPtr
, NULL
);
12310 Jim_ListIndex(interp
, interp
->stackTrace
, i
+1, &objPtr
,
12312 file
= Jim_GetString(objPtr
, NULL
);
12313 Jim_ListIndex(interp
, interp
->stackTrace
, i
+2, &objPtr
,
12315 line
= Jim_GetString(objPtr
, NULL
);
12317 Jim_fprintf( interp
, interp
->cookie_stderr
,
12318 "in procedure '%s' ", proc
);
12321 Jim_fprintf( interp
, interp
->cookie_stderr
,
12322 "called at file \"%s\", line %s",
12325 if (*file
|| *proc
) {
12326 Jim_fprintf( interp
, interp
->cookie_stderr
, JIM_NL
);
12331 int Jim_InteractivePrompt(Jim_Interp
*interp
)
12333 int retcode
= JIM_OK
;
12334 Jim_Obj
*scriptObjPtr
;
12336 Jim_fprintf(interp
,interp
->cookie_stdout
, "Welcome to Jim version %d.%d, "
12337 "Copyright (c) 2005-8 Salvatore Sanfilippo" JIM_NL
,
12338 JIM_VERSION
/ 100, JIM_VERSION
% 100);
12339 Jim_SetVariableStrWithStr(interp
, "jim_interactive", "1");
12342 const char *result
;
12343 const char *retcodestr
[] = {
12344 "ok", "error", "return", "break", "continue", "eval", "exit"
12348 if (retcode
!= 0) {
12349 if (retcode
>= 2 && retcode
<= 6)
12350 Jim_fprintf(interp
,interp
->cookie_stdout
, "[%s] . ", retcodestr
[retcode
]);
12352 Jim_fprintf(interp
,interp
->cookie_stdout
, "[%d] . ", retcode
);
12354 Jim_fprintf( interp
, interp
->cookie_stdout
, ". ");
12355 Jim_fflush( interp
, interp
->cookie_stdout
);
12356 scriptObjPtr
= Jim_NewStringObj(interp
, "", 0);
12357 Jim_IncrRefCount(scriptObjPtr
);
12363 if ( Jim_fgets(interp
, buf
, 1024, interp
->cookie_stdin
) == NULL
) {
12364 Jim_DecrRefCount(interp
, scriptObjPtr
);
12367 Jim_AppendString(interp
, scriptObjPtr
, buf
, -1);
12368 str
= Jim_GetString(scriptObjPtr
, &len
);
12369 if (Jim_ScriptIsComplete(str
, len
, &state
))
12371 Jim_fprintf( interp
, interp
->cookie_stdout
, "%c> ", state
);
12372 Jim_fflush( interp
, interp
->cookie_stdout
);
12374 retcode
= Jim_EvalObj(interp
, scriptObjPtr
);
12375 Jim_DecrRefCount(interp
, scriptObjPtr
);
12376 result
= Jim_GetString(Jim_GetResult(interp
), &reslen
);
12377 if (retcode
== JIM_ERR
) {
12378 Jim_PrintErrorMessage(interp
);
12379 } else if (retcode
== JIM_EXIT
) {
12380 exit(Jim_GetExitCode(interp
));
12383 Jim_fwrite( interp
, result
, 1, reslen
, interp
->cookie_stdout
);
12384 Jim_fprintf( interp
,interp
->cookie_stdout
, JIM_NL
);
12392 /* -----------------------------------------------------------------------------
12393 * Jim's idea of STDIO..
12394 * ---------------------------------------------------------------------------*/
12396 int Jim_fprintf( Jim_Interp
*interp
, void *cookie
, const char *fmt
, ... )
12402 r
= Jim_vfprintf( interp
, cookie
, fmt
,ap
);
12407 int Jim_vfprintf( Jim_Interp
*interp
, void *cookie
, const char *fmt
, va_list ap
)
12409 if( (interp
== NULL
) || (interp
->cb_vfprintf
== NULL
) ){
12413 return (*(interp
->cb_vfprintf
))( cookie
, fmt
, ap
);
12416 size_t Jim_fwrite( Jim_Interp
*interp
, const void *ptr
, size_t size
, size_t n
, void *cookie
)
12418 if( (interp
== NULL
) || (interp
->cb_fwrite
== NULL
) ){
12422 return (*(interp
->cb_fwrite
))( ptr
, size
, n
, cookie
);
12425 size_t Jim_fread( Jim_Interp
*interp
, void *ptr
, size_t size
, size_t n
, void *cookie
)
12427 if( (interp
== NULL
) || (interp
->cb_fread
== NULL
) ){
12431 return (*(interp
->cb_fread
))( ptr
, size
, n
, cookie
);
12434 int Jim_fflush( Jim_Interp
*interp
, void *cookie
)
12436 if( (interp
== NULL
) || (interp
->cb_fflush
== NULL
) ){
12437 /* pretend all is well */
12440 return (*(interp
->cb_fflush
))( cookie
);
12443 char* Jim_fgets( Jim_Interp
*interp
, char *s
, int size
, void *cookie
)
12445 if( (interp
== NULL
) || (interp
->cb_fgets
== NULL
) ){
12449 return (*(interp
->cb_fgets
))( s
, size
, cookie
);
12452 Jim_Nvp_name2value_simple( const Jim_Nvp
*p
, const char *name
)
12455 if( 0 == strcmp( name
, p
->name
) ){
12460 return ((Jim_Nvp
*)(p
));
12464 Jim_Nvp_name2value_nocase_simple( const Jim_Nvp
*p
, const char *name
)
12467 if( 0 == strcasecmp( name
, p
->name
) ){
12472 return ((Jim_Nvp
*)(p
));
12476 Jim_Nvp_name2value_obj( Jim_Interp
*interp
,
12481 return Jim_Nvp_name2value( interp
, p
, Jim_GetString( o
, NULL
), result
);
12486 Jim_Nvp_name2value( Jim_Interp
*interp
,
12493 p
= Jim_Nvp_name2value_simple( _p
, name
);
12497 *result
= (Jim_Nvp
*)(p
);
12509 Jim_Nvp_name2value_obj_nocase( Jim_Interp
*interp
, const Jim_Nvp
*p
, Jim_Obj
*o
, Jim_Nvp
**puthere
)
12511 return Jim_Nvp_name2value_nocase( interp
, p
, Jim_GetString( o
, NULL
), puthere
);
12515 Jim_Nvp_name2value_nocase( Jim_Interp
*interp
, const Jim_Nvp
*_p
, const char *name
, Jim_Nvp
**puthere
)
12519 p
= Jim_Nvp_name2value_nocase_simple( _p
, name
);
12522 *puthere
= (Jim_Nvp
*)(p
);
12534 Jim_Nvp_value2name_obj( Jim_Interp
*interp
, const Jim_Nvp
*p
, Jim_Obj
*o
, Jim_Nvp
**result
)
12539 e
= Jim_GetWide( interp
, o
, &w
);
12544 return Jim_Nvp_value2name( interp
, p
, w
, result
);
12548 Jim_Nvp_value2name_simple( const Jim_Nvp
*p
, int value
)
12551 if( value
== p
->value
){
12556 return ((Jim_Nvp
*)(p
));
12561 Jim_Nvp_value2name( Jim_Interp
*interp
, const Jim_Nvp
*_p
, int value
, Jim_Nvp
**result
)
12565 p
= Jim_Nvp_value2name_simple( _p
, value
);
12568 *result
= (Jim_Nvp
*)(p
);
12580 Jim_GetOpt_Setup( Jim_GetOptInfo
*p
, Jim_Interp
*interp
, int argc
, Jim_Obj
* const * argv
)
12582 memset( p
, 0, sizeof(*p
) );
12583 p
->interp
= interp
;
12591 Jim_GetOpt_Debug( Jim_GetOptInfo
*p
)
12595 Jim_fprintf( p
->interp
, p
->interp
->cookie_stderr
, "---args---\n");
12596 for( x
= 0 ; x
< p
->argc
; x
++ ){
12597 Jim_fprintf( p
->interp
, p
->interp
->cookie_stderr
,
12600 Jim_GetString( p
->argv
[x
], NULL
) );
12602 Jim_fprintf( p
->interp
, p
->interp
->cookie_stderr
, "-------\n");
12607 Jim_GetOpt_Obj( Jim_GetOptInfo
*goi
, Jim_Obj
**puthere
)
12611 o
= NULL
; // failure
12629 Jim_GetOpt_String( Jim_GetOptInfo
*goi
, char **puthere
, int *len
)
12636 r
= Jim_GetOpt_Obj( goi
, &o
);
12638 cp
= Jim_GetString( o
, len
);
12641 *puthere
= (char *)(cp
);
12648 Jim_GetOpt_Double( Jim_GetOptInfo
*goi
, double *puthere
)
12654 if( puthere
== NULL
){
12658 r
= Jim_GetOpt_Obj( goi
, &o
);
12660 r
= Jim_GetDouble( goi
->interp
, o
, puthere
);
12662 Jim_SetResult_sprintf( goi
->interp
,
12663 "not a number: %s",
12664 Jim_GetString( o
, NULL
) );
12671 Jim_GetOpt_Wide( Jim_GetOptInfo
*goi
, jim_wide
*puthere
)
12677 if( puthere
== NULL
){
12681 r
= Jim_GetOpt_Obj( goi
, &o
);
12683 r
= Jim_GetWide( goi
->interp
, o
, puthere
);
12688 int Jim_GetOpt_Nvp( Jim_GetOptInfo
*goi
,
12689 const Jim_Nvp
*nvp
,
12696 if( puthere
== NULL
){
12700 e
= Jim_GetOpt_Obj( goi
, &o
);
12702 e
= Jim_Nvp_name2value_obj( goi
->interp
,
12712 Jim_GetOpt_NvpUnknown( Jim_GetOptInfo
*goi
,
12713 const Jim_Nvp
*nvptable
,
12717 Jim_SetResult_NvpUnknown( goi
->interp
,
12722 Jim_SetResult_NvpUnknown( goi
->interp
,
12731 Jim_GetOpt_Enum( Jim_GetOptInfo
*goi
,
12732 const char * const * lookup
,
12739 if( puthere
== NULL
){
12742 e
= Jim_GetOpt_Obj( goi
, &o
);
12744 e
= Jim_GetEnum( goi
->interp
,
12757 Jim_SetResult_sprintf( Jim_Interp
*interp
, const char *fmt
,... )
12763 buf
= jim_vasprintf( fmt
, ap
);
12766 Jim_SetResultString( interp
, buf
, -1 );
12767 jim_vasprintf_done(buf
);
12774 Jim_SetResult_NvpUnknown( Jim_Interp
*interp
,
12775 Jim_Obj
*param_name
,
12776 Jim_Obj
*param_value
,
12777 const Jim_Nvp
*nvp
)
12780 Jim_SetResult_sprintf( interp
,
12781 "%s: Unknown: %s, try one of: ",
12782 Jim_GetString( param_name
, NULL
),
12783 Jim_GetString( param_value
, NULL
) );
12785 Jim_SetResult_sprintf( interp
,
12786 "Unknown param: %s, try one of: ",
12787 Jim_GetString( param_value
, NULL
) );
12789 while( nvp
->name
){
12793 if( (nvp
+1)->name
){
12800 Jim_AppendStrings( interp
,
12801 Jim_GetResult(interp
),
12808 static Jim_Obj
*debug_string_obj
;
12811 Jim_Debug_ArgvString( Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
12815 if( debug_string_obj
){
12816 Jim_FreeObj( interp
, debug_string_obj
);
12819 debug_string_obj
= Jim_NewEmptyStringObj( interp
);
12820 for( x
= 0 ; x
< argc
; x
++ ){
12821 Jim_AppendStrings( interp
,
12823 Jim_GetString( argv
[x
], NULL
),
12828 return Jim_GetString( debug_string_obj
, NULL
);
12834 * Local Variables: ***
12835 * c-basic-offset: 4 ***