Many hyperlinks are disabled.
Use anonymous login
to enable hyperlinks.
Changes In Branch tip-625 Excluding Merge-Ins
This is equivalent to a diff from a9db66657b to 0af4a5494c
2022-08-29
| ||
18:05 | sync with core-8-branch check-in: c077434fb1 user: griffin tags: tip-629 | |
08:03 | TIP 625 - list reimplementation check-in: d9b720c46d user: apnadkarni tags: core-8-branch | |
03:26 | Merged core-8-branch Closed-Leaf check-in: 0af4a5494c user: apnadkarni tags: tip-625 | |
2022-08-28
| ||
21:45 | Create new branch named "http-bugfixes-2022H2" check-in: 8b0fe6d753 user: kjnash tags: http-bugfixes-2022H2 | |
2022-08-26
| ||
23:12 | Merge 8.7 check-in: 692e27d3f1 user: jan.nijtmans tags: trunk, main | |
23:11 | [37108037b9]: Apply patch 0005 for CHERI check-in: a9db66657b user: jan.nijtmans tags: core-8-branch | |
22:50 | merge-mark check-in: c6af6c3381 user: jan.nijtmans tags: core-8-branch | |
2022-08-06
| ||
16:00 | Remove knownBug constraint now that apply has been fixed check-in: 582629b93a user: apnadkarni tags: tip-625 | |
Changes to generic/tclCmdIL.c.
︙ | ︙ | |||
15 16 17 18 19 20 21 22 23 24 25 26 27 28 | * * See the file "license.terms" for information on usage and redistribution of * this file, and for a DISCLAIMER OF ALL WARRANTIES. */ #include "tclInt.h" #include "tclRegexp.h" /* * During execution of the "lsort" command, structures of the following type * are used to arrange the objects being sorted into a collection of linked * lists. */ | > | 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 | * * See the file "license.terms" for information on usage and redistribution of * this file, and for a DISCLAIMER OF ALL WARRANTIES. */ #include "tclInt.h" #include "tclRegexp.h" #include <assert.h> /* * During execution of the "lsort" command, structures of the following type * are used to arrange the objects being sorted into a collection of linked * lists. */ |
︙ | ︙ | |||
2894 2895 2896 2897 2898 2899 2900 | /* * Get an empty list object that is allocated large enough to hold each * init value elementCount times. */ listPtr = Tcl_NewListObj(totalElems, NULL); if (totalElems) { | | > > > > > > > | < < | 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 | /* * Get an empty list object that is allocated large enough to hold each * init value elementCount times. */ listPtr = Tcl_NewListObj(totalElems, NULL); if (totalElems) { ListRep listRep; ListObjGetRep(listPtr, &listRep); dataArray = ListRepElementsBase(&listRep); listRep.storePtr->numUsed = totalElems; if (listRep.spanPtr) { /* Future proofing in case Tcl_NewListObj returns a span */ listRep.spanPtr->spanStart = listRep.storePtr->firstUsed; listRep.spanPtr->spanLength = listRep.storePtr->numUsed; } } /* * Set the elements. Note that we handle the common degenerate case of a * single value being repeated separately to permit the compiler as much * room as possible to optimize a loop that might be run a very large * number of times. |
︙ | ︙ | |||
3077 3078 3079 3080 3081 3082 3083 | if (!elemc) { Tcl_SetObjResult(interp, objv[1]); return TCL_OK; } if (Tcl_IsShared(objv[1]) | | | | > > | | > > > > > | 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 | if (!elemc) { Tcl_SetObjResult(interp, objv[1]); return TCL_OK; } if (Tcl_IsShared(objv[1]) || ListObjRepIsShared(objv[1])) { /* Bug 1675044 */ Tcl_Obj *resultObj, **dataArray; ListRep listRep; resultObj = Tcl_NewListObj(elemc, NULL); /* Modify the internal rep in-place */ ListObjGetRep(resultObj, &listRep); listRep.storePtr->numUsed = elemc; dataArray = ListRepElementsBase(&listRep); if (listRep.spanPtr) { /* Future proofing */ listRep.spanPtr->spanStart = listRep.storePtr->firstUsed; listRep.spanPtr->spanLength = listRep.storePtr->numUsed; } for (i=0,j=elemc-1 ; i<elemc ; i++,j--) { dataArray[j] = elemv[i]; Tcl_IncrRefCount(elemv[i]); } Tcl_SetObjResult(interp, resultObj); |
︙ | ︙ | |||
4405 4406 4407 4408 4409 4410 4411 | } /* * Now store the sorted elements in the result list. */ if (sortInfo.resultCode == TCL_OK) { | | | | | 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 | } /* * Now store the sorted elements in the result list. */ if (sortInfo.resultCode == TCL_OK) { ListRep listRep; Tcl_Obj **newArray, *objPtr; resultPtr = Tcl_NewListObj(sortInfo.numElements * groupSize, NULL); ListObjGetRep(resultPtr, &listRep); newArray = ListRepElementsBase(&listRep); if (group) { for (i=0; elementPtr!=NULL ; elementPtr=elementPtr->nextPtr) { idx = elementPtr->payload.index; for (j = 0; j < groupSize; j++) { if (indices) { TclNewIndexObj(objPtr, idx + j - groupOffset); newArray[i++] = objPtr; |
︙ | ︙ | |||
4439 4440 4441 4442 4443 4444 4445 | } else { for (i=0; elementPtr != NULL ; elementPtr = elementPtr->nextPtr) { objPtr = elementPtr->payload.objPtr; newArray[i++] = objPtr; Tcl_IncrRefCount(objPtr); } } | > | > > > | 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 | } else { for (i=0; elementPtr != NULL ; elementPtr = elementPtr->nextPtr) { objPtr = elementPtr->payload.objPtr; newArray[i++] = objPtr; Tcl_IncrRefCount(objPtr); } } listRep.storePtr->numUsed = i; if (listRep.spanPtr) { listRep.spanPtr->spanStart = listRep.storePtr->firstUsed; listRep.spanPtr->spanLength = listRep.storePtr->numUsed; } Tcl_SetObjResult(interp, resultPtr); } done: if (sortMode == SORTMODE_COMMAND) { TclDecrRefCount(sortInfo.compareCmdPtr); TclDecrRefCount(listObj); |
︙ | ︙ |
Changes to generic/tclExecute.c.
︙ | ︙ | |||
3512 3513 3514 3515 3516 3517 3518 | if (Tcl_IsShared(objResultPtr)) { Tcl_Obj *newValue = Tcl_DuplicateObj(objResultPtr); TclDecrRefCount(objResultPtr); varPtr->value.objPtr = objResultPtr = newValue; Tcl_IncrRefCount(newValue); } | | | 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 | if (Tcl_IsShared(objResultPtr)) { Tcl_Obj *newValue = Tcl_DuplicateObj(objResultPtr); TclDecrRefCount(objResultPtr); varPtr->value.objPtr = objResultPtr = newValue; Tcl_IncrRefCount(newValue); } if (TclListObjAppendElements(interp, objResultPtr, objc, objv) != TCL_OK) { TRACE_ERROR(interp); goto gotError; } TRACE_APPEND(("%.30s\n", O2S(objResultPtr))); NEXT_INST_V(pcAdjustment, cleanup, 1); |
︙ | ︙ | |||
3570 3571 3572 3573 3574 3575 3576 | } else { if (Tcl_IsShared(objResultPtr)) { valueToAssign = Tcl_DuplicateObj(objResultPtr); createdNewObj = 1; } else { valueToAssign = objResultPtr; } | | | 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 | } else { if (Tcl_IsShared(objResultPtr)) { valueToAssign = Tcl_DuplicateObj(objResultPtr); createdNewObj = 1; } else { valueToAssign = objResultPtr; } if (TclListObjAppendElements(interp, valueToAssign, objc, objv) != TCL_OK) { if (createdNewObj) { TclDecrRefCount(valueToAssign); } goto errorInLappendListPtr; } } |
︙ | ︙ |
Changes to generic/tclInt.decls.
︙ | ︙ | |||
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 | Tcl_Obj *TclpCreateTemporaryDirectory(Tcl_Obj *dirObj, Tcl_Obj *basenameObj) } declare 259 { void TclUnusedStubEntry(void) } ############################################################################## # Define the platform specific internal Tcl interface. These functions are # only available on the designated platform. interface tclIntPlat | > > > > > > > > > > > | 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 | Tcl_Obj *TclpCreateTemporaryDirectory(Tcl_Obj *dirObj, Tcl_Obj *basenameObj) } declare 259 { void TclUnusedStubEntry(void) } # TIP 625: for unit testing - create list objects with span declare 260 { Tcl_Obj *TclListTestObj(int length, int leadingSpace, int endSpace) } # TIP 625: for unit testing - check list invariants declare 261 { void TclListObjValidate(Tcl_Interp *interp, Tcl_Obj *listObj) } ############################################################################## # Define the platform specific internal Tcl interface. These functions are # only available on the designated platform. interface tclIntPlat |
︙ | ︙ |
Changes to generic/tclInt.h.
︙ | ︙ | |||
2433 2434 2435 2436 2437 2438 2439 | */ #define TCL_INVOKE_HIDDEN (1<<0) #define TCL_INVOKE_NO_UNKNOWN (1<<1) #define TCL_INVOKE_NO_TRACEBACK (1<<2) /* | | | | > | > | > > > > > | | > | > | < > > > | < > > > > > > > | > > > > > > > > | < > | > > > > > > > > > > > > > > > | > | > | > | > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > | > | > | > > > | > > > | > > | > > > > > | > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | | | > | > > > > > > | | | | | | | 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 | */ #define TCL_INVOKE_HIDDEN (1<<0) #define TCL_INVOKE_NO_UNKNOWN (1<<1) #define TCL_INVOKE_NO_TRACEBACK (1<<2) /* * TclListSizeT is the type for holding list element counts. It's defined * simplify sharing source between Tcl8 and Tcl9. */ #if TCL_MAJOR_VERSION > 8 typedef ptrdiff_t ListSizeT; /* TODO - may need to fix to match Tcl9's API */ /* * SSIZE_MAX, NOT SIZE_MAX as negative differences need to be expressed * between values of the ListSizeT type so limit the range to signed */ #define ListSizeT_MAX PTRDIFF_MAX #else typedef int ListSizeT; #define ListSizeT_MAX INT_MAX #endif /* * ListStore -- * * A Tcl list's internal representation is defined through three structures. * * A ListStore struct is a structure that includes a variable size array that * serves as storage for a Tcl list. A contiguous sequence of slots in the * array, the "in-use" area, holds valid pointers to Tcl_Obj values that * belong to one or more Tcl lists. The unused slots before and after these * are free slots that may be used to prepend and append without having to * reallocate the struct. The ListStore may be shared amongst multiple lists * and reference counted. * * A ListSpan struct defines a sequence of slots within a ListStore. This sequence * always lies within the "in-use" area of the ListStore. Like ListStore, the * structure may be shared among multiple lists and is reference counted. * * A ListRep struct holds the internal representation of a Tcl list as stored * in a Tcl_Obj. It is composed of a ListStore and a ListSpan that together * define the content of the list. The ListSpan specifies the range of slots * within the ListStore that hold elements for this list. The ListSpan is * optional in which case the list includes all the "in-use" slots of the * ListStore. * */ typedef struct ListStore { ListSizeT firstUsed; /* Index of first slot in use within slots[] */ ListSizeT numUsed; /* Number of slots in use (starting firstUsed) */ ListSizeT numAllocated; /* Total number of slots[] array slots. */ int refCount; /* Number of references to this instance */ int flags; /* LISTSTORE_* flags */ Tcl_Obj *slots[TCLFLEXARRAY]; /* Variable size array. Grown as needed */ } ListStore; #define LISTSTORE_CANONICAL 0x1 /* All Tcl_Obj's referencing this store have their string representation derived from the list representation */ /* Max number of elements that can be contained in a list */ #define LIST_MAX \ ((ListSizeT)(((size_t)ListSizeT_MAX - offsetof(ListStore, slots)) \ / sizeof(Tcl_Obj *))) /* Memory size needed for a ListStore to hold numSlots_ elements */ #define LIST_SIZE(numSlots_) \ ((int)(offsetof(ListStore, slots) + ((numSlots_) * sizeof(Tcl_Obj *)))) /* * ListSpan -- * See comments above for ListStore */ typedef struct ListSpan { ListSizeT spanStart; /* Starting index of the span */ ListSizeT spanLength; /* Number of elements in the span */ int refCount; /* Count of references to this span record */ } ListSpan; #ifndef LIST_SPAN_THRESHOLD /* May be set on build line */ #define LIST_SPAN_THRESHOLD 101 #endif /* * ListRep -- * See comments above for ListStore */ typedef struct ListRep { ListStore *storePtr;/* element array shared amongst different lists */ ListSpan *spanPtr; /* If not NULL, the span holds the range of slots within *storePtr that contain this list elements. */ } ListRep; /* * Macros used to get access list internal representations. * * Naming conventions: * ListRep* - expect a pointer to a valid ListRep * ListObj* - expect a pointer to a Tcl_Obj whose internal type is known to * be a list (tclListType). Will crash otherwise. * TclListObj* - expect a pointer to a Tcl_Obj whose internal type may or may not * be tclListType. These will convert as needed and return error if * conversion not possible. */ /* Returns the starting slot for this listRep in the contained ListStore */ #define ListRepStart(listRepPtr_) \ ((listRepPtr_)->spanPtr ? (listRepPtr_)->spanPtr->spanStart \ : (listRepPtr_)->storePtr->firstUsed) /* Returns the number of elements in this listRep */ #define ListRepLength(listRepPtr_) \ ((listRepPtr_)->spanPtr ? (listRepPtr_)->spanPtr->spanLength \ : (listRepPtr_)->storePtr->numUsed) /* Returns a pointer to the first slot containing this ListRep elements */ #define ListRepElementsBase(listRepPtr_) \ (&(listRepPtr_)->storePtr->slots[ListRepStart(listRepPtr_)]) /* Stores the number of elements and base address of the element array */ #define ListRepElements(listRepPtr_, objc_, objv_) \ (((objv_) = ListRepElementsBase(listRepPtr_)), \ ((objc_) = ListRepLength(listRepPtr_))) /* Returns 1/0 whether the ListRep's ListStore is shared. */ #define ListRepIsShared(listRepPtr_) ((listRepPtr_)->storePtr->refCount > 1) /* Returns a pointer to the ListStore component */ #define ListObjStorePtr(listObj_) \ ((ListStore *)((listObj_)->internalRep.twoPtrValue.ptr1)) /* Returns a pointer to the ListSpan component */ #define ListObjSpanPtr(listObj_) \ ((ListSpan *)((listObj_)->internalRep.twoPtrValue.ptr2)) /* Returns the ListRep internal representaton in a Tcl_Obj */ #define ListObjGetRep(listObj_, listRepPtr_) \ do { \ (listRepPtr_)->storePtr = ListObjStorePtr(listObj_); \ (listRepPtr_)->spanPtr = ListObjSpanPtr(listObj_); \ } while (0) /* Returns the length of the list */ #define ListObjLength(listObj_, len_) \ ((len_) = ListObjSpanPtr(listObj_) ? ListObjSpanPtr(listObj_)->spanLength \ : ListObjStorePtr(listObj_)->numUsed) /* Returns the starting slot index of this list's elements in the ListStore */ #define ListObjStart(listObj_) \ (ListObjSpanPtr(listObj_) ? ListObjSpanPtr(listObj_)->spanStart \ : ListObjStorePtr(listObj_)->firstUsed) /* Stores the element count and base address of this list's elements */ #define ListObjGetElements(listObj_, objc_, objv_) \ (((objv_) = &ListObjStorePtr(listObj_)->slots[ListObjStart(listObj_)]), \ (ListObjLength(listObj_, (objc_)))) /* * Returns 1/0 whether the internal representation (not the Tcl_Obj itself) * is shared. Note by intent this only checks for sharing of ListStore, * not spans. */ #define ListObjRepIsShared(listObj_) (ListObjStorePtr(listObj_)->refCount > 1) /* * Certain commands like concat are optimized if an existing string * representation of a list object is known to be in canonical format (i.e. * generated from the list representation). There are three conditions when * this will be the case: * (1) No string representation exists which means it will obviously have * to be generated from the list representation when needed * (2) The ListStore flags is marked canonical. This is done at the time * the string representation is generated from the list IF the list * representation does not have a span (see comments in UpdateStringOfList). * (3) The list representation does not have a span component. This is * because list Tcl_Obj's with spans are always created from existing lists * and never from strings (see SetListFromAny) and thus their string * representation will always be canonical. */ #define ListObjIsCanonical(listObj_) \ (((listObj_)->bytes == NULL) \ || (ListObjStorePtr(listObj_)->flags & LISTSTORE_CANONICAL) \ || ListObjSpanPtr(listObj_) != NULL) /* * Converts the Tcl_Obj to a list if it isn't one and stores the element * count and base address of this list's elements in objcPtr_ and objvPtr_. * Return TCL_OK on success or TCL_ERROR if the Tcl_Obj cannot be * converted to a list. */ #define TclListObjGetElementsM(interp_, listObj_, objcPtr_, objvPtr_) \ (((listObj_)->typePtr == &tclListType) \ ? ((ListObjGetElements((listObj_), *(objcPtr_), *(objvPtr_))), \ TCL_OK) \ : Tcl_ListObjGetElements( \ (interp_), (listObj_), (objcPtr_), (objvPtr_))) /* * Converts the Tcl_Obj to a list if it isn't one and stores the element * count in lenPtr_. Returns TCL_OK on success or TCL_ERROR if the * Tcl_Obj cannot be converted to a list. */ #define TclListObjLengthM(interp_, listObj_, lenPtr_) \ (((listObj_)->typePtr == &tclListType) \ ? ((ListObjLength((listObj_), *(lenPtr_))), TCL_OK) \ : Tcl_ListObjLength((interp_), (listObj_), (lenPtr_))) #define TclListObjIsCanonical(listObj_) \ (((listObj_)->typePtr == &tclListType) ? ListObjIsCanonical((listObj_)) : 0) /* * Modes for collecting (or not) in the implementations of TclNRForeachCmd, * TclNRLmapCmd and their compilations. */ #define TCL_EACH_KEEP_NONE 0 /* Discard iteration result like [foreach] */ |
︙ | ︙ | |||
3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 | int indexCount, Tcl_Obj *const indexArray[]); /* TIP #280 */ MODULE_SCOPE void TclListLines(Tcl_Obj *listObj, int line, int n, int *lines, Tcl_Obj *const *elems); MODULE_SCOPE Tcl_Obj * TclListObjCopy(Tcl_Interp *interp, Tcl_Obj *listPtr); MODULE_SCOPE Tcl_Obj * TclListObjRange(Tcl_Obj *listPtr, int fromIdx, int toIdx); MODULE_SCOPE Tcl_Obj * TclLsetList(Tcl_Interp *interp, Tcl_Obj *listPtr, Tcl_Obj *indexPtr, Tcl_Obj *valuePtr); MODULE_SCOPE Tcl_Obj * TclLsetFlat(Tcl_Interp *interp, Tcl_Obj *listPtr, int indexCount, Tcl_Obj *const indexArray[], Tcl_Obj *valuePtr); MODULE_SCOPE Tcl_Command TclMakeEnsemble(Tcl_Interp *interp, const char *name, const EnsembleImplMap map[]); | > > > | 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 | int indexCount, Tcl_Obj *const indexArray[]); /* TIP #280 */ MODULE_SCOPE void TclListLines(Tcl_Obj *listObj, int line, int n, int *lines, Tcl_Obj *const *elems); MODULE_SCOPE Tcl_Obj * TclListObjCopy(Tcl_Interp *interp, Tcl_Obj *listPtr); MODULE_SCOPE Tcl_Obj * TclListObjRange(Tcl_Obj *listPtr, int fromIdx, int toIdx); MODULE_SCOPE int TclListObjAppendElements(Tcl_Interp *interp, Tcl_Obj *toObj, int elemCount, Tcl_Obj *const elemObjv[]); MODULE_SCOPE Tcl_Obj * TclLsetList(Tcl_Interp *interp, Tcl_Obj *listPtr, Tcl_Obj *indexPtr, Tcl_Obj *valuePtr); MODULE_SCOPE Tcl_Obj * TclLsetFlat(Tcl_Interp *interp, Tcl_Obj *listPtr, int indexCount, Tcl_Obj *const indexArray[], Tcl_Obj *valuePtr); MODULE_SCOPE Tcl_Command TclMakeEnsemble(Tcl_Interp *interp, const char *name, const EnsembleImplMap map[]); |
︙ | ︙ | |||
5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 | #define NRE_ASSERT(expr) assert((expr)) #else #define NRE_ASSERT(expr) #endif #include "tclIntDecls.h" #include "tclIntPlatDecls.h" #if !defined(USE_TCL_STUBS) && !defined(TCL_MEM_DEBUG) #define Tcl_AttemptAlloc(size) TclpAlloc(size) #define Tcl_AttemptRealloc(ptr, size) TclpRealloc((ptr), (size)) #define Tcl_Free(ptr) TclpFree(ptr) #endif | > | 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 | #define NRE_ASSERT(expr) assert((expr)) #else #define NRE_ASSERT(expr) #endif #include "tclIntDecls.h" #include "tclIntPlatDecls.h" #if !defined(USE_TCL_STUBS) && !defined(TCL_MEM_DEBUG) #define Tcl_AttemptAlloc(size) TclpAlloc(size) #define Tcl_AttemptRealloc(ptr, size) TclpRealloc((ptr), (size)) #define Tcl_Free(ptr) TclpFree(ptr) #endif |
︙ | ︙ |
Changes to generic/tclIntDecls.h.
︙ | ︙ | |||
654 655 656 657 658 659 660 661 662 663 664 665 666 667 | Tcl_LibraryInitProc *initProc, Tcl_LibraryInitProc *safeInitProc); /* 258 */ EXTERN Tcl_Obj * TclpCreateTemporaryDirectory(Tcl_Obj *dirObj, Tcl_Obj *basenameObj); /* 259 */ EXTERN void TclUnusedStubEntry(void); typedef struct TclIntStubs { int magic; void *hooks; void (*reserved0)(void); void (*reserved1)(void); | > > > > > > | 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 | Tcl_LibraryInitProc *initProc, Tcl_LibraryInitProc *safeInitProc); /* 258 */ EXTERN Tcl_Obj * TclpCreateTemporaryDirectory(Tcl_Obj *dirObj, Tcl_Obj *basenameObj); /* 259 */ EXTERN void TclUnusedStubEntry(void); /* 260 */ EXTERN Tcl_Obj * TclListTestObj(int length, int leadingSpace, int endSpace); /* 261 */ EXTERN void TclListObjValidate(Tcl_Interp *interp, Tcl_Obj *listObj); typedef struct TclIntStubs { int magic; void *hooks; void (*reserved0)(void); void (*reserved1)(void); |
︙ | ︙ | |||
919 920 921 922 923 924 925 926 927 928 929 930 931 932 | Tcl_Obj * (*tclPtrSetVar) (Tcl_Interp *interp, Tcl_Var varPtr, Tcl_Var arrayPtr, Tcl_Obj *part1Ptr, Tcl_Obj *part2Ptr, Tcl_Obj *newValuePtr, int flags); /* 253 */ Tcl_Obj * (*tclPtrIncrObjVar) (Tcl_Interp *interp, Tcl_Var varPtr, Tcl_Var arrayPtr, Tcl_Obj *part1Ptr, Tcl_Obj *part2Ptr, Tcl_Obj *incrPtr, int flags); /* 254 */ int (*tclPtrObjMakeUpvar) (Tcl_Interp *interp, Tcl_Var otherPtr, Tcl_Obj *myNamePtr, int myFlags); /* 255 */ int (*tclPtrUnsetVar) (Tcl_Interp *interp, Tcl_Var varPtr, Tcl_Var arrayPtr, Tcl_Obj *part1Ptr, Tcl_Obj *part2Ptr, int flags); /* 256 */ void (*tclStaticLibrary) (Tcl_Interp *interp, const char *prefix, Tcl_LibraryInitProc *initProc, Tcl_LibraryInitProc *safeInitProc); /* 257 */ Tcl_Obj * (*tclpCreateTemporaryDirectory) (Tcl_Obj *dirObj, Tcl_Obj *basenameObj); /* 258 */ void (*tclUnusedStubEntry) (void); /* 259 */ } TclIntStubs; extern const TclIntStubs *tclIntStubsPtr; #ifdef __cplusplus } #endif | > > | 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 | Tcl_Obj * (*tclPtrSetVar) (Tcl_Interp *interp, Tcl_Var varPtr, Tcl_Var arrayPtr, Tcl_Obj *part1Ptr, Tcl_Obj *part2Ptr, Tcl_Obj *newValuePtr, int flags); /* 253 */ Tcl_Obj * (*tclPtrIncrObjVar) (Tcl_Interp *interp, Tcl_Var varPtr, Tcl_Var arrayPtr, Tcl_Obj *part1Ptr, Tcl_Obj *part2Ptr, Tcl_Obj *incrPtr, int flags); /* 254 */ int (*tclPtrObjMakeUpvar) (Tcl_Interp *interp, Tcl_Var otherPtr, Tcl_Obj *myNamePtr, int myFlags); /* 255 */ int (*tclPtrUnsetVar) (Tcl_Interp *interp, Tcl_Var varPtr, Tcl_Var arrayPtr, Tcl_Obj *part1Ptr, Tcl_Obj *part2Ptr, int flags); /* 256 */ void (*tclStaticLibrary) (Tcl_Interp *interp, const char *prefix, Tcl_LibraryInitProc *initProc, Tcl_LibraryInitProc *safeInitProc); /* 257 */ Tcl_Obj * (*tclpCreateTemporaryDirectory) (Tcl_Obj *dirObj, Tcl_Obj *basenameObj); /* 258 */ void (*tclUnusedStubEntry) (void); /* 259 */ Tcl_Obj * (*tclListTestObj) (int length, int leadingSpace, int endSpace); /* 260 */ void (*tclListObjValidate) (Tcl_Interp *interp, Tcl_Obj *listObj); /* 261 */ } TclIntStubs; extern const TclIntStubs *tclIntStubsPtr; #ifdef __cplusplus } #endif |
︙ | ︙ | |||
1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 | (tclIntStubsPtr->tclPtrUnsetVar) /* 256 */ #define TclStaticLibrary \ (tclIntStubsPtr->tclStaticLibrary) /* 257 */ #define TclpCreateTemporaryDirectory \ (tclIntStubsPtr->tclpCreateTemporaryDirectory) /* 258 */ #define TclUnusedStubEntry \ (tclIntStubsPtr->tclUnusedStubEntry) /* 259 */ #endif /* defined(USE_TCL_STUBS) */ /* !END!: Do not edit above this line. */ #undef TCL_STORAGE_CLASS #define TCL_STORAGE_CLASS DLLIMPORT | > > > > | 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 | (tclIntStubsPtr->tclPtrUnsetVar) /* 256 */ #define TclStaticLibrary \ (tclIntStubsPtr->tclStaticLibrary) /* 257 */ #define TclpCreateTemporaryDirectory \ (tclIntStubsPtr->tclpCreateTemporaryDirectory) /* 258 */ #define TclUnusedStubEntry \ (tclIntStubsPtr->tclUnusedStubEntry) /* 259 */ #define TclListTestObj \ (tclIntStubsPtr->tclListTestObj) /* 260 */ #define TclListObjValidate \ (tclIntStubsPtr->tclListObjValidate) /* 261 */ #endif /* defined(USE_TCL_STUBS) */ /* !END!: Do not edit above this line. */ #undef TCL_STORAGE_CLASS #define TCL_STORAGE_CLASS DLLIMPORT |
︙ | ︙ |
Changes to generic/tclInterp.c.
︙ | ︙ | |||
8 9 10 11 12 13 14 15 16 17 18 19 20 21 | * Copyright © 2004 Donal K. Fellows * * See the file "license.terms" for information on usage and redistribution * of this file, and for a DISCLAIMER OF ALL WARRANTIES. */ #include "tclInt.h" /* * A pointer to a string that holds an initialization script that if non-NULL * is evaluated in Tcl_Init() prior to the built-in initialization script * above. This variable can be modified by the function below. */ | > | 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | * Copyright © 2004 Donal K. Fellows * * See the file "license.terms" for information on usage and redistribution * of this file, and for a DISCLAIMER OF ALL WARRANTIES. */ #include "tclInt.h" #include <assert.h> /* * A pointer to a string that holds an initialization script that if non-NULL * is evaluated in Tcl_Init() prior to the built-in initialization script * above. This variable can be modified by the function below. */ |
︙ | ︙ | |||
1818 1819 1820 1821 1822 1823 1824 | int objc, /* Number of arguments. */ Tcl_Obj *const objv[]) /* Argument vector. */ { Alias *aliasPtr = (Alias *)clientData; int prefc, cmdc, i; Tcl_Obj **prefv, **cmdv; Tcl_Obj *listPtr; | | > > | | | > > > | 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 | int objc, /* Number of arguments. */ Tcl_Obj *const objv[]) /* Argument vector. */ { Alias *aliasPtr = (Alias *)clientData; int prefc, cmdc, i; Tcl_Obj **prefv, **cmdv; Tcl_Obj *listPtr; ListRep listRep; int flags = TCL_EVAL_INVOKE; /* * Append the arguments to the command prefix and invoke the command in * the target interp's global namespace. */ prefc = aliasPtr->objc; prefv = &aliasPtr->objPtr; cmdc = prefc + objc - 1; /* TODO - encapsulate this into tclListObj.c */ listPtr = Tcl_NewListObj(cmdc, NULL); ListObjGetRep(listPtr, &listRep); cmdv = ListRepElementsBase(&listRep); listRep.storePtr->numUsed = cmdc; if (listRep.spanPtr) { listRep.spanPtr->spanStart = listRep.storePtr->firstUsed; listRep.spanPtr->spanLength = listRep.storePtr->numUsed; } prefv = &aliasPtr->objPtr; memcpy(cmdv, prefv, prefc * sizeof(Tcl_Obj *)); memcpy(cmdv+prefc, objv+1, (objc-1) * sizeof(Tcl_Obj *)); for (i=0; i<cmdc; i++) { Tcl_IncrRefCount(cmdv[i]); |
︙ | ︙ |
Changes to generic/tclListObj.c.
1 2 3 4 5 | /* * tclListObj.c -- * * This file contains functions that implement the Tcl list object type. * | < < | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | | > > > | > | > > > | > > > > > > > > | | | | | < < < < < < > > > > > > > > > > | > > | > > > | > > > > > > > > > > > > > > > > > > > > > | | > > | > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > | > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > | > > > > | > > > | > > > > > | > > > > > > > > > > > > > > > | > > > > > > > > | > > > > > > > > > | > | | > > > > > > > > > > > > > > > > > > > > > > > | > > > | > > > > > > > > > > > > > > > > > > > > > | > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | | > > > > > > > > > > > > > > > > > > | < > > > > > | | > < < > > > > > > > > > > > > > > > > > > > > > | > > > > > > | > < | > | > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > | > > > | > > > | > > > > > > > > > > > > | > > | > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | | > > > | > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | < < < | | | < > > > > > > | > > > > | | < | | > > > > > > > > > > > > > > > > > > | < < < | < < < < < | > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | | > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > | > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > < | | | | > | | | < < < < | < > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | < > > < > > > | | | | | < | | | | | | | | < < < | < | < < < < < | | > > > | | | | | > > > > > > > > > > > | | | | | < < < | < | < < < < < < | | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > | > > > > > > > > < | < < < < < < < < < | > > > | | > > | | | | | | | | < | | < | | < | < | | | | | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > | | | < | | < | | < < < < < < < < | < < < < < < < < < < < < < < < < | < < < < | < < | < < < | < < < < | | | | | | | < < | > | | > > > | | | | | | < < < < < | < > | | | | < | < < < < < < < < | < < < < < < < | < | > | < | < < < | < < | | < | < > | | | < < | | | | < < < < | > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > | < | < < | < < | | | | < < | > | | | < | | < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < | < < | < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < | < < < < < < < < | < < < < < < < < < | < < < < < < < < < < < < < < < < < < < < < < < < < < < | | | | > | < | | | | | < | < < | | < | < | | | | > | < < > | | | | | | < < | | | | < < < | | | > > | < | < | > > | < < | | < | | | | < < > | > | | | < | > | | < < < < < < | < | > > > | | | < > | | < < < | | | > > > | < | | | < < | < | < > | | < | | | | | < | > > > > > > > | < | | < < < | < < < | | < < < | < < | < < < | < < < < < < < | < < < | | | | | | > | | > > > > | | > > > > > > | > > | > > > > > > > > > > > > > | > | > > > > > > > > > | | > > > | < > > > > > > | > > > | < < > < < > | < < < | > > > | | | | > > | < | < < > > > > > > > > > | < > | | < > | | | < < < | > > > > > > > > > > > > > > > | < < < < | < < > > | < | > > > > > > | < > | > > > > > > | > > > > > > > | | | < < > > | > > > > | < | < | > | | > > | | > > > | | > > > > | > > > > > > > > > > | | > | < > | > > > > | < > | < < | > | > > > > > > | > > | > | > > | > | > > | | > > > | > | > | < < > > | < | > > > > > | < | > > | < | > | > > | > > > > | < < > | | > | | | | | | | | | | < < | > > | | > > > | > > > > | < > > > > > > > > > > > > > > > > > > | | > > > > > > | > > > > > > > | < < | < > > > > > > > > > | > > > > > > > > > > > > > > | < < > > > > > | > | < > | < > > > > > > | | | > > | > > > > > > > | | < < < > > > > > | < < > > > > > > | < < < > > | < | | | | > > > | | | > > > | | > | > > | | | | | | | < < | > > > > > < | | < | > | > | < | < | > < | | | | > < | < | < < | < | | | | | > > > < < > | > > > > | | < < | | | | | | | | | < | < < > | | > | < | < < | | | | | > > | | > < > | > > > > < | | | | | | < | < | < > | < | | | | < | < | > | | | | | > | < > | > | | < < | < < | | | | < < < | < | | > | | > > < < < < < < < < | | | | | | > > | | | | | | | | < > > > > > > > | | | | | | | > | | > > > | > | | | | | | | | | | | | | | | | | | | | | | | | > | | | < < | > | > | | | | < < < < | < | < | < | | | > > > > > > | > > > | < < < < | < < < | | > > | | | | | | | | > | > | > | | | | | < < < | < | < < < < < | | < < < < | | | | | < | | < > | | < < | | | | < | | < | < | < < < < | < < < < < < < < | | < < < | < < < | < | < < | > > > | | < | < < < < < < < < < | < < < < < | | | < < < < < < < | | | > | < < < < < | < < < | < < < < < | < | | | > > < | | < < | | | | | < | | | > | | > > | < | | | | < | < | | < | < | < > | < | < | < < > | > > | | | > > > > | | < | | > | | > > > > | < | < | | | | | < < < < > | > > > > > > > > | > > > > | < | | | > | > | | > < | | | < | | | > > > > > > > > > > > | < < | < | < | < < | < < < > > | | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 | /* * tclListObj.c -- * * This file contains functions that implement the Tcl list object type. * * Copyright © 2022 Ashok P. Nadkarni. All rights reserved. * * See the file "license.terms" for information on usage and redistribution of * this file, and for a DISCLAIMER OF ALL WARRANTIES. */ #include "tclInt.h" #include <assert.h> /* * TODO - memmove is fast. Measure at what size we should prefer memmove * (for unshared objects only) in lieu of range operations. On the other * hand, more cache dirtied? */ /* * Macros for validation and bug checking. */ /* * Control whether asserts are enabled. Always enable in debug builds. In non-debug * builds, can be set with cdebug="-DENABLE_LIST_ASSERTS" on the nmake command line. */ #ifdef ENABLE_LIST_ASSERTS # ifdef NDEBUG # undef NDEBUG /* Activate assert() macro */ # endif #else # ifndef NDEBUG # define ENABLE_LIST_ASSERTS /* Always activate list asserts in debug mode */ # endif #endif #ifdef ENABLE_LIST_ASSERTS #define LIST_ASSERT(cond_) assert(cond_) /* TODO - is there a Tcl-specific one? */ /* * LIST_INDEX_ASSERT is to catch errors with negative indices and counts * being passed AFTER validation. On Tcl9 length types are unsigned hence * the checks against LIST_MAX. On Tcl8 length types are signed hence the * also checks against 0. */ #define LIST_INDEX_ASSERT(idxarg_) \ do { \ ListSizeT idx_ = (idxarg_); /* To guard against ++ etc. */ \ LIST_ASSERT(idx_ >= 0 && idx_ < LIST_MAX); \ } while (0) /* Ditto for counts except upper limit is different */ #define LIST_COUNT_ASSERT(countarg_) \ do { \ ListSizeT count_ = (countarg_); /* To guard against ++ etc. */ \ LIST_ASSERT(count_ >= 0 && count_ <= LIST_MAX); \ } while (0) #else #define LIST_ASSERT(cond_) ((void) 0) #define LIST_INDEX_ASSERT(idx_) ((void) 0) #define LIST_COUNT_ASSERT(count_) ((void) 0) #endif /* Checks for when caller should have already converted to internal list type */ #define LIST_ASSERT_TYPE(listObj_) \ LIST_ASSERT((listObj_)->typePtr == &tclListType); /* * If ENABLE_LIST_INVARIANTS is enabled (-DENABLE_LIST_INVARIANTS from the * command line), the entire list internal representation is checked for * inconsistencies. This has a non-trivial cost so has to be separately * enabled and not part of assertions checking. However, the test suite does * invoke ListRepValidate directly even without ENABLE_LIST_INVARIANTS. */ #ifdef ENABLE_LIST_INVARIANTS #define LISTREP_CHECK(listRepPtr_) ListRepValidate(listRepPtr_, __FILE__, __LINE__) #else #define LISTREP_CHECK(listRepPtr_) (void) 0 #endif /* * Flags used for controlling behavior of allocation of list * internal representations. * * If the LISTREP_PANIC_ON_FAIL bit is set, the function will panic if * list is too large or memory cannot be allocated. Without the flag * a NULL pointer is returned. * * The LISTREP_SPACE_FAVOR_NONE, LISTREP_SPACE_FAVOR_FRONT, * LISTREP_SPACE_FAVOR_BACK, LISTREP_SPACE_ONLY_BACK flags are used to * control additional space when allocating. * - If none of these flags is present, the exact space requested is * allocated, nothing more. * - Otherwise, if only LISTREP_FAVOR_FRONT is present, extra space is * allocated with more towards the front. * - Conversely, if only LISTREP_FAVOR_BACK is present extra space is allocated * with more to the back. * - If both flags are present (LISTREP_SPACE_FAVOR_NONE), the extra space * is equally apportioned. * - Finally if LISTREP_SPACE_ONLY_BACK is present, ALL extra space is at * the back. */ #define LISTREP_PANIC_ON_FAIL 0x00000001 #define LISTREP_SPACE_FAVOR_FRONT 0x00000002 #define LISTREP_SPACE_FAVOR_BACK 0x00000004 #define LISTREP_SPACE_ONLY_BACK 0x00000008 #define LISTREP_SPACE_FAVOR_NONE \ (LISTREP_SPACE_FAVOR_FRONT | LISTREP_SPACE_FAVOR_BACK) #define LISTREP_SPACE_FLAGS \ (LISTREP_SPACE_FAVOR_FRONT | LISTREP_SPACE_FAVOR_BACK \ | LISTREP_SPACE_ONLY_BACK) /* * Prototypes for non-inline static functions defined later in this file: */ static int MemoryAllocationError(Tcl_Interp *, size_t size); static int ListLimitExceededError(Tcl_Interp *); static ListStore *ListStoreNew(ListSizeT objc, Tcl_Obj *const objv[], int flags); static int ListRepInit(ListSizeT objc, Tcl_Obj *const objv[], int flags, ListRep *); static int ListRepInitAttempt(Tcl_Interp *, ListSizeT objc, Tcl_Obj *const objv[], ListRep *); static void ListRepClone(ListRep *fromRepPtr, ListRep *toRepPtr, int flags); static void ListRepUnsharedFreeUnreferenced(const ListRep *repPtr); static int TclListObjGetRep(Tcl_Interp *, Tcl_Obj *listPtr, ListRep *repPtr); static void ListRepRange(ListRep *srcRepPtr, ListSizeT rangeStart, ListSizeT rangeEnd, int preserveSrcRep, ListRep *rangeRepPtr); static ListStore *ListStoreReallocate(ListStore *storePtr, ListSizeT numSlots); static void ListRepValidate(const ListRep *repPtr, const char *file, int lineNum); static void DupListInternalRep(Tcl_Obj *srcPtr, Tcl_Obj *copyPtr); static void FreeListInternalRep(Tcl_Obj *listPtr); static int SetListFromAny(Tcl_Interp *interp, Tcl_Obj *objPtr); static void UpdateStringOfList(Tcl_Obj *listPtr); /* * The structure below defines the list Tcl object type by means of functions * that can be invoked by generic object code. * * The internal representation of a list object is ListRep defined in tcl.h. */ const Tcl_ObjType tclListType = { "list", /* name */ FreeListInternalRep, /* freeIntRepProc */ DupListInternalRep, /* dupIntRepProc */ UpdateStringOfList, /* updateStringProc */ SetListFromAny /* setFromAnyProc */ }; /* Macros to manipulate the List internal rep */ #define ListRepIncrRefs(repPtr_) \ do { \ (repPtr_)->storePtr->refCount++; \ if ((repPtr_)->spanPtr) \ (repPtr_)->spanPtr->refCount++; \ } while (0) /* Returns number of free unused slots at the back of the ListRep's ListStore */ #define ListRepNumFreeTail(repPtr_) \ ((repPtr_)->storePtr->numAllocated \ - ((repPtr_)->storePtr->firstUsed + (repPtr_)->storePtr->numUsed)) /* Returns number of free unused slots at the front of the ListRep's ListStore */ #define ListRepNumFreeHead(repPtr_) ((repPtr_)->storePtr->firstUsed) /* Returns a pointer to the slot corresponding to list index listIdx_ */ #define ListRepSlotPtr(repPtr_, listIdx_) \ (&(repPtr_)->storePtr->slots[ListRepStart(repPtr_) + (listIdx_)]) /* * Macros to replace the internal representation in a Tcl_Obj. There are * subtle differences in each so make sure to use the right one to avoid * memory leaks, access to freed memory and the like. * * ListObjStompRep - assumes the Tcl_Obj internal representation can be * overwritten AND that the passed ListRep already has reference counts that * include the reference from the Tcl_Obj. Basically just copies the pointers * and sets the internal Tcl_Obj type to list * * ListObjOverwriteRep - like ListObjOverwriteRep but additionally * increments reference counts on the passed ListRep. Generally used when * the string representation of the Tcl_Obj is not to be modified. * * ListObjReplaceRepAndInvalidate - Like ListObjOverwriteRep but additionally * assumes the Tcl_Obj internal rep is valid (and possibly even same as * passed ListRep) and frees it first. Additionally invalidates the string * representation. Generally used when modifying a Tcl_Obj value. */ #define ListObjStompRep(objPtr_, repPtr_) \ do { \ (objPtr_)->internalRep.twoPtrValue.ptr1 = (repPtr_)->storePtr; \ (objPtr_)->internalRep.twoPtrValue.ptr2 = (repPtr_)->spanPtr; \ (objPtr_)->typePtr = &tclListType; \ } while (0) #define ListObjOverwriteRep(objPtr_, repPtr_) \ do { \ ListRepIncrRefs(repPtr_); \ ListObjStompRep(objPtr_, repPtr_); \ } while (0) #define ListObjReplaceRepAndInvalidate(objPtr_, repPtr_) \ do { \ /* Note order important, don't use ListObjOverwriteRep! */ \ ListRepIncrRefs(repPtr_); \ TclFreeInternalRep(objPtr_); \ TclInvalidateStringRep(objPtr_); \ ListObjStompRep(objPtr_, repPtr_); \ } while (0) /* *------------------------------------------------------------------------ * * ListSpanNew -- * * Allocates and initializes memory for a new ListSpan. The reference * count on the returned struct is 0. * * Results: * Non-NULL pointer to the allocated ListSpan. * * Side effects: * The function will panic on memory allocation failure. * *------------------------------------------------------------------------ */ static inline ListSpan * ListSpanNew( ListSizeT firstSlot, /* Starting slot index of the span */ ListSizeT numSlots) /* Number of slots covered by the span */ { ListSpan *spanPtr = (ListSpan *) ckalloc(sizeof(*spanPtr)); spanPtr->refCount = 0; spanPtr->spanStart = firstSlot; spanPtr->spanLength = numSlots; return spanPtr; } /* *------------------------------------------------------------------------ * * ListSpanIncrRefs -- * * Increments the reference count on the spanPtr * * Results: * None. * * Side effects: * The obvious. * *------------------------------------------------------------------------ */ static inline void ListSpanIncrRefs(ListSpan *spanPtr) { spanPtr->refCount += 1; } /* *------------------------------------------------------------------------ * * ListSpanDecrRefs -- * * Decrements the reference count on a span, freeing the memory if * it drops to zero or less. * * Results: * None. * * Side effects: * The memory may be freed. * *------------------------------------------------------------------------ */ static inline void ListSpanDecrRefs(ListSpan *spanPtr) { if (spanPtr->refCount <= 1) { ckfree(spanPtr); } else { spanPtr->refCount -= 1; } } /* *------------------------------------------------------------------------ * * ListSpanMerited -- * * Creation of a new list may sometimes be done as a span on existing * storage instead of allocating new. The tradeoff is that if the * original list is released, the new span-based list may hold on to * more memory than desired. This function implements heuristics for * deciding which option is better. * * Results: * Returns non-0 if a span-based list is likely to be more optimal * and 0 if not. * * Side effects: * None. * *------------------------------------------------------------------------ */ static inline int ListSpanMerited( ListSizeT length, /* Length of the proposed span */ ListSizeT usedStorageLength, /* Number of slots currently in used */ ListSizeT allocatedStorageLength) /* Length of the currently allocation */ { /* TODO - heuristics thresholds need to be determined - currently, information about the sharing (ref count) of existing storage is not passed. Perhaps it should be. For example if the existing storage has a "large" ref count, then it might make sense to do even a small span. */ if (length < LIST_SPAN_THRESHOLD) { return 0;/* No span for small lists */ } if (length < (allocatedStorageLength / 2 - allocatedStorageLength / 8)) { return 0; /* No span if less than 3/8 of allocation */ } if (length < usedStorageLength / 2) { return 0; /* No span if less than half current storage */ } return 1; } /* *------------------------------------------------------------------------ * * ListStoreUpSize -- * * For reasons of efficiency, extra space is allocated for a ListStore * compared to what was requested. This function calculates how many * slots should actually be allocated for a given request size. * * Results: * Number of slots to allocate. * * Side effects: * None. * *------------------------------------------------------------------------ */ static inline ListSizeT ListStoreUpSize(ListSizeT numSlotsRequested) { /* TODO -how much extra? May be double only for smaller requests? */ return numSlotsRequested < (LIST_MAX / 2) ? 2 * numSlotsRequested : LIST_MAX; } /* *------------------------------------------------------------------------ * * ListRepFreeUnreferenced -- * * Inline wrapper for ListRepUnsharedFreeUnreferenced that does quick checks * before calling it. * * IMPORTANT: this function must not be called on an internal * representation of a Tcl_Obj that is itself shared. * * Results: * None. * * Side effects: * See comments for ListRepUnsharedFreeUnreferenced. * *------------------------------------------------------------------------ */ static inline void ListRepFreeUnreferenced(const ListRep *repPtr) { if (! ListRepIsShared(repPtr) && repPtr->spanPtr) { /* T:listrep-1.5.1 */ ListRepUnsharedFreeUnreferenced(repPtr); } } /* *------------------------------------------------------------------------ * * ObjArrayIncrRefs -- * * Increments the reference counts for Tcl_Obj's in a subarray. * * Results: * None. * * Side effects: * As above. * *------------------------------------------------------------------------ */ static inline void ObjArrayIncrRefs( Tcl_Obj * const *objv, /* Pointer to the array */ ListSizeT startIdx, /* Starting index of subarray within objv */ ListSizeT count) /* Number of elements in the subarray */ { Tcl_Obj * const *end; LIST_INDEX_ASSERT(startIdx); LIST_COUNT_ASSERT(count); objv += startIdx; end = objv + count; while (objv < end) { Tcl_IncrRefCount(*objv); ++objv; } } /* *------------------------------------------------------------------------ * * ObjArrayDecrRefs -- * * Decrements the reference counts for Tcl_Obj's in a subarray. * * Results: * None. * * Side effects: * As above. * *------------------------------------------------------------------------ */ static inline void ObjArrayDecrRefs( Tcl_Obj * const *objv, /* Pointer to the array */ ListSizeT startIdx, /* Starting index of subarray within objv */ ListSizeT count) /* Number of elements in the subarray */ { Tcl_Obj * const *end; LIST_INDEX_ASSERT(startIdx); LIST_COUNT_ASSERT(count); objv += startIdx; end = objv + count; while (objv < end) { Tcl_DecrRefCount(*objv); ++objv; } } /* *------------------------------------------------------------------------ * * ObjArrayCopy -- * * Copies an array of Tcl_Obj* pointers. * * Results: * None. * * Side effects: * Reference counts on copied Tcl_Obj's are incremented. * *------------------------------------------------------------------------ */ static inline void ObjArrayCopy( Tcl_Obj **to, /* Destination */ ListSizeT count, /* Number of pointers to copy */ Tcl_Obj *const from[]) /* Source array of Tcl_Obj* */ { Tcl_Obj **end; LIST_COUNT_ASSERT(count); end = to + count; /* TODO - would memmove followed by separate IncrRef loop be faster? */ while (to < end) { Tcl_IncrRefCount(*from); *to++ = *from++; } } /* *------------------------------------------------------------------------ * * MemoryAllocationError -- * * Generates a memory allocation failure error. * * Results: * Always TCL_ERROR. * * Side effects: * Error message and code are stored in the interpreter if not NULL. * *------------------------------------------------------------------------ */ static int MemoryAllocationError( Tcl_Interp *interp, /* Interpreter for error message. May be NULL */ size_t size) /* Size of attempted allocation that failed */ { if (interp != NULL) { Tcl_SetObjResult( interp, Tcl_ObjPrintf( "list construction failed: unable to alloc %" TCL_LL_MODIFIER "u bytes", (Tcl_WideInt)size)); Tcl_SetErrorCode(interp, "TCL", "MEMORY", NULL); } return TCL_ERROR; } /* *------------------------------------------------------------------------ * * ListLimitExceeded -- * * Generates an error for exceeding maximum list size. * * Results: * Always TCL_ERROR. * * Side effects: * Error message and code are stored in the interpreter if not NULL. * *------------------------------------------------------------------------ */ static int ListLimitExceededError(Tcl_Interp *interp) { if (interp != NULL) { Tcl_SetObjResult( interp, Tcl_NewStringObj("max length of a Tcl list exceeded", -1)); Tcl_SetErrorCode(interp, "TCL", "MEMORY", NULL); } return TCL_ERROR; } /* *------------------------------------------------------------------------ * * ListRepUnsharedShiftDown -- * * Shifts the "in-use" contents in the ListStore for a ListRep down * by the given number of slots. The ListStore must be unshared and * the free space at the front of the storage area must be big enough. * It is the caller's responsibility to check. * * Results: * None. * * Side effects: * The contents of the ListRep's ListStore area are shifted down in the * storage area. The ListRep's ListSpan is updated accordingly. * *------------------------------------------------------------------------ */ static inline void ListRepUnsharedShiftDown(ListRep *repPtr, ListSizeT shiftCount) { ListStore *storePtr; LISTREP_CHECK(repPtr); LIST_ASSERT(!ListRepIsShared(repPtr)); storePtr = repPtr->storePtr; LIST_COUNT_ASSERT(shiftCount); LIST_ASSERT(storePtr->firstUsed >= shiftCount); memmove(&storePtr->slots[storePtr->firstUsed - shiftCount], &storePtr->slots[storePtr->firstUsed], storePtr->numUsed * sizeof(Tcl_Obj *)); storePtr->firstUsed -= shiftCount; if (repPtr->spanPtr) { repPtr->spanPtr->spanStart -= shiftCount; LIST_ASSERT(repPtr->spanPtr->spanLength == storePtr->numUsed); } else { /* * If there was no span, firstUsed must have been 0 (Invariant) * AND shiftCount must have been 0 (<= firstUsed on call) * In other words, this would have been a no-op */ LIST_ASSERT(storePtr->firstUsed == 0); LIST_ASSERT(shiftCount == 0); } LISTREP_CHECK(repPtr); } /* *------------------------------------------------------------------------ * * ListRepUnsharedShiftUp -- * * Shifts the "in-use" contents in the ListStore for a ListRep up * by the given number of slots. The ListStore must be unshared and * the free space at the back of the storage area must be big enough. * It is the caller's responsibility to check. * TODO - this function is not currently used. * * Results: * None. * * Side effects: * The contents of the ListRep's ListStore area are shifted up in the * storage area. The ListRep's ListSpan is updated accordingly. * *------------------------------------------------------------------------ */ static inline void ListRepUnsharedShiftUp(ListRep *repPtr, ListSizeT shiftCount) { ListStore *storePtr; LISTREP_CHECK(repPtr); LIST_ASSERT(!ListRepIsShared(repPtr)); LIST_COUNT_ASSERT(shiftCount); storePtr = repPtr->storePtr; LIST_ASSERT((storePtr->firstUsed + storePtr->numUsed + shiftCount) <= storePtr->numAllocated); memmove(&storePtr->slots[storePtr->firstUsed + shiftCount], &storePtr->slots[storePtr->firstUsed], storePtr->numUsed * sizeof(Tcl_Obj *)); storePtr->firstUsed += shiftCount; if (repPtr->spanPtr) { repPtr->spanPtr->spanStart += shiftCount; } else { /* No span means entire original list is span */ /* Should have been zero before shift - Invariant TBD */ LIST_ASSERT(storePtr->firstUsed == shiftCount); repPtr->spanPtr = ListSpanNew(shiftCount, storePtr->numUsed); } LISTREP_CHECK(repPtr); } /* *------------------------------------------------------------------------ * * ListRepValidate -- * * Checks all invariants for a ListRep and panics on failure. * Note this is independent of NDEBUG, assert etc. * * Results: * None. * * Side effects: * Panics if any invariant is not met. * *------------------------------------------------------------------------ */ static void ListRepValidate(const ListRep *repPtr, const char *file, int lineNum) { ListStore *storePtr = repPtr->storePtr; const char *condition; (void)storePtr; /* To stop gcc from whining about unused vars */ #define INVARIANT(cond_) \ do { \ if (!(cond_)) { \ condition = #cond_; \ goto failure; \ } \ } while (0) /* Separate each condition so line number gives exact reason for failure */ INVARIANT(storePtr != NULL); INVARIANT(storePtr->numAllocated >= 0); INVARIANT(storePtr->numAllocated <= LIST_MAX); INVARIANT(storePtr->firstUsed >= 0); INVARIANT(storePtr->firstUsed < storePtr->numAllocated); INVARIANT(storePtr->numUsed >= 0); INVARIANT(storePtr->numUsed <= storePtr->numAllocated); INVARIANT(storePtr->firstUsed <= (storePtr->numAllocated - storePtr->numUsed)); if (! ListRepIsShared(repPtr)) { /* * If this is the only reference and there is no span, then store * occupancy must begin at 0 */ INVARIANT(repPtr->spanPtr || repPtr->storePtr->firstUsed == 0); } INVARIANT(ListRepStart(repPtr) >= storePtr->firstUsed); INVARIANT(ListRepLength(repPtr) <= storePtr->numUsed); INVARIANT(ListRepStart(repPtr) <= (storePtr->firstUsed + storePtr->numUsed - ListRepLength(repPtr))); #undef INVARIANT return; failure: Tcl_Panic("List internal failure in %s line %d. Condition: %s", file, lineNum, condition); } /* *------------------------------------------------------------------------ * * TclListObjValidate -- * * Wrapper around ListRepValidate. Primarily used from test suite. * * Results: * None. * * Side effects: * Will panic if internal structure is not consistent or if object * cannot be converted to a list object. * *------------------------------------------------------------------------ */ void TclListObjValidate(Tcl_Interp *interp, Tcl_Obj *listObj) { ListRep listRep; if (TclListObjGetRep(interp, listObj, &listRep) != TCL_OK) { Tcl_Panic("Object passed to TclListObjValidate cannot be converted to " "a list object."); } ListRepValidate(&listRep, __FILE__, __LINE__); } /* *---------------------------------------------------------------------- * * ListStoreNew -- * * Allocates a new ListStore with space for at least objc elements. objc * must be > 0. If objv!=NULL, initializes with the first objc values * in that array. If objv==NULL, initalize 0 elements, with space * to add objc more. * * Normally the function allocates the exact space requested unless * the flags arguments has any LISTREP_SPACE_* * bits set. See the comments for those #defines. * * Results: * On success, a pointer to the allocated ListStore is returned. * On allocation failure, panics if LISTREP_PANIC_ON_FAIL is set in * flags; otherwise returns NULL. * * Side effects: * The ref counts of the elements in objv are incremented on success * since the returned ListStore references them. * *---------------------------------------------------------------------- */ static ListStore * ListStoreNew( ListSizeT objc, Tcl_Obj *const objv[], int flags) { ListStore *storePtr; ListSizeT capacity; /* * First check to see if we'd overflow and try to allocate an object * larger than our memory allocator allows. */ if (objc > LIST_MAX) { if (flags & LISTREP_PANIC_ON_FAIL) { Tcl_Panic("max length of a Tcl list exceeded"); } return NULL; } if (flags & LISTREP_SPACE_FLAGS) { capacity = ListStoreUpSize(objc); } else { capacity = objc; } storePtr = (ListStore *)attemptckalloc(LIST_SIZE(capacity)); if (storePtr == NULL && capacity != objc) { capacity = objc; /* Try allocating exact size */ storePtr = (ListStore *)attemptckalloc(LIST_SIZE(capacity)); } if (storePtr == NULL) { if (flags & LISTREP_PANIC_ON_FAIL) { Tcl_Panic("list creation failed: unable to alloc %u bytes", LIST_SIZE(objc)); } return NULL; } storePtr->refCount = 0; storePtr->flags = 0; storePtr->numAllocated = capacity; if (capacity == objc) { storePtr->firstUsed = 0; } else { ListSizeT extra = capacity - objc; int spaceFlags = flags & LISTREP_SPACE_FLAGS; if (spaceFlags == LISTREP_SPACE_ONLY_BACK) { storePtr->firstUsed = 0; } else if (spaceFlags == LISTREP_SPACE_FAVOR_FRONT) { /* Leave more space in the front */ storePtr->firstUsed = extra - (extra / 4); /* NOT same as 3*extra/4 */ } else if (spaceFlags == LISTREP_SPACE_FAVOR_BACK) { /* Leave more space in the back */ storePtr->firstUsed = extra / 4; } else { /* Apportion equally */ storePtr->firstUsed = extra / 2; } } if (objv) { storePtr->numUsed = objc; ObjArrayCopy(&storePtr->slots[storePtr->firstUsed], objc, objv); } else { storePtr->numUsed = 0; } return storePtr; } /* *------------------------------------------------------------------------ * * ListStoreReallocate -- * * Reallocates the memory for a ListStore. * * Results: * Pointer to the ListStore which may be the same as storePtr or pointer * to a new block of memory. On reallocation failure, NULL is returned. * * * Side effects: * The memory pointed to by storePtr is freed if it a new block has to * be returned. * * *------------------------------------------------------------------------ */ ListStore * ListStoreReallocate (ListStore *storePtr, ListSizeT numSlots) { ListSizeT newCapacity; ListStore *newStorePtr; newCapacity = ListStoreUpSize(numSlots); newStorePtr = (ListStore *)attemptckrealloc(storePtr, LIST_SIZE(newCapacity)); if (newStorePtr == NULL) { newCapacity = numSlots; newStorePtr = (ListStore *)attemptckrealloc(storePtr, LIST_SIZE(newCapacity)); if (newStorePtr == NULL) return NULL; } /* Only the capacity has changed, fix it in the header */ newStorePtr->numAllocated = newCapacity; return newStorePtr; } /* *---------------------------------------------------------------------- * * ListRepInit -- * * Initializes a ListRep to hold a list internal representation * with space for objc elements. * * objc must be > 0. If objv!=NULL, initializes with the first objc * values in that array. If objv==NULL, initalize list internal rep to * have 0 elements, with space to add objc more. * * Normally the function allocates the exact space requested unless * the flags arguments has one of the LISTREP_SPACE_* bits set. * See the comments for those #defines. * * The reference counts of the ListStore and ListSpan (if present) * pointed to by the initialized repPtr are set to zero. * Caller has to manage them as necessary. * * Results: * On success, TCL_OK is returned with *listRepPtr initialized. * On failure, panics if LISTREP_PANIC_ON_FAIL is set in flags; otherwise * returns TCL_ERROR with *listRepPtr fields set to NULL. * * Side effects: * The ref counts of the elements in objv are incremented since the * resulting list now refers to them. * *---------------------------------------------------------------------- */ static int ListRepInit( ListSizeT objc, Tcl_Obj *const objv[], int flags, ListRep *repPtr ) { ListStore *storePtr; /* * The whole list implementation has an implicit assumption that lenths * and indices used a signed integer type. Tcl9 API's currently use * unsigned types. This assert is to remind that need to review code * when adapting for Tcl9. */ LIST_ASSERT(((ListSizeT)-1) < 0); storePtr = ListStoreNew(objc, objv, flags); if (storePtr) { repPtr->storePtr = storePtr; if (storePtr->firstUsed == 0) { repPtr->spanPtr = NULL; } else { repPtr->spanPtr = ListSpanNew(storePtr->firstUsed, storePtr->numUsed); } return TCL_OK; } /* * Initialize to keep gcc happy at the call site. Else it complains * about possibly uninitialized use. */ repPtr->storePtr = NULL; repPtr->spanPtr = NULL; return TCL_ERROR; } /* *---------------------------------------------------------------------- * * ListRepInitAttempt -- * * Creates a list internal rep with space for objc elements. See * ListRepInit for requirements for parameters (in particular objc must * be > 0). This function only adds error messages to the interpreter if * not NULL. * * The reference counts of the ListStore and ListSpan (if present) * pointed to by the initialized repPtr are set to zero. * Caller has to manage them as necessary. * * Results: * On success, TCL_OK is returned with *listRepPtr initialized. * On allocation failure, returnes TCL_ERROR with an error message * in the interpreter if non-NULL. * * Side effects: * The ref counts of the elements in objv are incremented since the * resulting list now refers to them. * *---------------------------------------------------------------------- */ static int ListRepInitAttempt( Tcl_Interp *interp, ListSizeT objc, Tcl_Obj *const objv[], ListRep *repPtr) { int result = ListRepInit(objc, objv, 0, repPtr); if (result != TCL_OK && interp != NULL) { if (objc > LIST_MAX) { ListLimitExceededError(interp); } else { MemoryAllocationError(interp, LIST_SIZE(objc)); } } return result; } /* *------------------------------------------------------------------------ * * ListRepClone -- * * Does a deep clone of an existing ListRep. * * Normally the function allocates the exact space needed unless * the flags arguments has one of the LISTREP_SPACE_* bits set. * See the comments for those #defines. * * Results: * None. * * Side effects: * The toRepPtr location is initialized with the ListStore and ListSpan * (if needed) containing a copy of the list elements in fromRepPtr. * The function will panic if memory cannot be allocated. * *------------------------------------------------------------------------ */ static void ListRepClone(ListRep *fromRepPtr, ListRep *toRepPtr, int flags) { Tcl_Obj **fromObjs; ListSizeT numFrom; ListRepElements(fromRepPtr, numFrom, fromObjs); ListRepInit(numFrom, fromObjs, flags | LISTREP_PANIC_ON_FAIL, toRepPtr); } /* *------------------------------------------------------------------------ * * ListRepUnsharedFreeUnreferenced -- * * Frees any Tcl_Obj's from the "in-use" area of the ListStore for a * ListRep that are not actually references from any lists. * * IMPORTANT: this function must not be called on a shared internal * representation or the internal representation of a shared Tcl_Obj. * * Results: * None. * * Side effects: * The firstUsed and numUsed fields of the ListStore are updated to * reflect the new "in-use" extent. * *------------------------------------------------------------------------ */ static void ListRepUnsharedFreeUnreferenced(const ListRep *repPtr) { ListSizeT count; ListStore *storePtr; ListSpan *spanPtr; LIST_ASSERT(!ListRepIsShared(repPtr)); LISTREP_CHECK(repPtr); storePtr = repPtr->storePtr; spanPtr = repPtr->spanPtr; if (spanPtr == NULL) { LIST_ASSERT(storePtr->firstUsed == 0); /* Invariant TBD */ return; } /* Collect garbage at front */ count = spanPtr->spanStart - storePtr->firstUsed; LIST_COUNT_ASSERT(count); if (count > 0) { /* T:listrep-1.5.1,6.{1:8} */ ObjArrayDecrRefs(storePtr->slots, storePtr->firstUsed, count); storePtr->firstUsed = spanPtr->spanStart; LIST_ASSERT(storePtr->numUsed >= count); storePtr->numUsed -= count; } /* Collect garbage at back */ count = (storePtr->firstUsed + storePtr->numUsed) - (spanPtr->spanStart + spanPtr->spanLength); LIST_COUNT_ASSERT(count); if (count > 0) { /* T:listrep-6.{1:8} */ ObjArrayDecrRefs( storePtr->slots, spanPtr->spanStart + spanPtr->spanLength, count); LIST_ASSERT(storePtr->numUsed >= count); storePtr->numUsed -= count; } LIST_ASSERT(ListRepStart(repPtr) == storePtr->firstUsed); LIST_ASSERT(ListRepLength(repPtr) == storePtr->numUsed); LISTREP_CHECK(repPtr); } /* *---------------------------------------------------------------------- * * Tcl_NewListObj -- * * This function is normally called when not debugging: i.e., when * TCL_MEM_DEBUG is not defined. It creates a new list object from an * (objc,objv) array: that is, each of the objc elements of the array * referenced by objv is inserted as an element into a new Tcl object. * * When TCL_MEM_DEBUG is defined, this function just returns the result * of calling the debugging version Tcl_DbNewListObj. * * Results: * A new list object is returned that is initialized from the object * pointers in objv. If objc is less than or equal to zero, an empty * object is returned. The new object's string representation is left * NULL. The resulting new list object has ref count 0. * * Side effects: * The ref counts of the elements in objv are incremented since the * resulting list now refers to them. * *---------------------------------------------------------------------- */ #ifdef TCL_MEM_DEBUG #undef Tcl_NewListObj Tcl_Obj * Tcl_NewListObj( ListSizeT objc, /* Count of objects referenced by objv. */ Tcl_Obj *const objv[]) /* An array of pointers to Tcl objects. */ { return Tcl_DbNewListObj(objc, objv, "unknown", 0); } #else /* if not TCL_MEM_DEBUG */ Tcl_Obj * Tcl_NewListObj( ListSizeT objc, /* Count of objects referenced by objv. */ Tcl_Obj *const objv[]) /* An array of pointers to Tcl objects. */ { ListRep listRep; Tcl_Obj *listObj; TclNewObj(listObj); if (objc <= 0) { return listObj; } ListRepInit(objc, objv, LISTREP_PANIC_ON_FAIL, &listRep); ListObjReplaceRepAndInvalidate(listObj, &listRep); return listObj; } #endif /* if TCL_MEM_DEBUG */ /* *---------------------------------------------------------------------- * * Tcl_DbNewListObj -- * * This function is normally called when debugging: i.e., when * TCL_MEM_DEBUG is defined. It creates new list objects. It is the same * as the Tcl_NewListObj function above except that it calls * Tcl_DbCkalloc directly with the file name and line number from its * caller. This simplifies debugging since then the [memory active] * command will report the correct file name and line number when * reporting objects that haven't been freed. * * When TCL_MEM_DEBUG is not defined, this function just returns the * result of calling Tcl_NewListObj. * * Results: * A new list object is returned that is initialized from the object * pointers in objv. If objc is less than or equal to zero, an empty * object is returned. The new object's string representation is left * NULL. The new list object has ref count 0. * * Side effects: * The ref counts of the elements in objv are incremented since the * resulting list now refers to them. * *---------------------------------------------------------------------- */ #ifdef TCL_MEM_DEBUG Tcl_Obj * Tcl_DbNewListObj( ListSizeT objc, /* Count of objects referenced by objv. */ Tcl_Obj *const objv[], /* An array of pointers to Tcl objects. */ const char *file, /* The name of the source file calling this * function; used for debugging. */ int line) /* Line number in the source file; used for * debugging. */ { Tcl_Obj *listObj; ListRep listRep; TclDbNewObj(listObj, file, line); if (objc <= 0) { return listObj; } ListRepInit(objc, objv, LISTREP_PANIC_ON_FAIL, &listRep); ListObjReplaceRepAndInvalidate(listObj, &listRep); return listObj; } #else /* if not TCL_MEM_DEBUG */ Tcl_Obj * Tcl_DbNewListObj( ListSizeT objc, /* Count of objects referenced by objv. */ Tcl_Obj *const objv[], /* An array of pointers to Tcl objects. */ TCL_UNUSED(const char *) /*file*/, TCL_UNUSED(int) /*line*/) { return Tcl_NewListObj(objc, objv); } #endif /* TCL_MEM_DEBUG */ /* *------------------------------------------------------------------------ * * TclNewListObj2 -- * * Create a new Tcl_Obj list comprising of the concatenation of two * Tcl_Obj* arrays. * TODO - currently this function is not used within tclListObj but * need to see if it would be useful in other files that preallocate * lists and then append. * * Results: * Non-NULL pointer to the allocate Tcl_Obj. * * Side effects: * None. * *------------------------------------------------------------------------ */ Tcl_Obj * TclNewListObj2( ListSizeT objc1, /* Count of objects referenced by objv1. */ Tcl_Obj *const objv1[], /* First array of pointers to Tcl objects. */ ListSizeT objc2, /* Count of objects referenced by objv2. */ Tcl_Obj *const objv2[] /* Second array of pointers to Tcl objects. */ ) { Tcl_Obj *listObj; ListStore *storePtr; ListSizeT objc = objc1 + objc2; listObj = Tcl_NewListObj(objc, NULL); if (objc == 0) { return listObj; /* An empty object */ } LIST_ASSERT_TYPE(listObj); storePtr = ListObjStorePtr(listObj); LIST_ASSERT(ListObjSpanPtr(listObj) == NULL); LIST_ASSERT(storePtr->firstUsed == 0); LIST_ASSERT(storePtr->numUsed == 0); LIST_ASSERT(storePtr->numAllocated >= objc); if (objc1) { ObjArrayCopy(storePtr->slots, objc1, objv1); } if (objc2) { ObjArrayCopy(&storePtr->slots[objc1], objc2, objv2); } storePtr->numUsed = objc; return listObj; } /* *---------------------------------------------------------------------- * * TclListObjGetRep -- * * This function returns a copy of the ListRep stored * as the internal representation of an object. The reference * counts of the (ListStore, ListSpan) contained in the representation * are NOT incremented. * * Results: * The return value is normally TCL_OK; in this case *listRepP * is set to a copy of the descriptor stored as the internal * representation of the Tcl_Obj containing a list. if listPtr does not * refer to a list object and the object can not be converted to one, * TCL_ERROR is returned and an error message will be left in the * interpreter's result if interp is not NULL. * * Side effects: * The possible conversion of the object referenced by listPtr * to a list object. *repPtr is initialized to the internal rep * if result is TCL_OK, or set to NULL on error. *---------------------------------------------------------------------- */ static int TclListObjGetRep( Tcl_Interp *interp, /* Used to report errors if not NULL. */ Tcl_Obj *listObj, /* List object for which an element array is * to be returned. */ ListRep *repPtr) /* Location to store descriptor */ { if (!TclHasInternalRep(listObj, &tclListType)) { int result; result = SetListFromAny(interp, listObj); if (result != TCL_OK) { /* Init to keep gcc happy wrt uninitialized fields at call site */ repPtr->storePtr = NULL; repPtr->spanPtr = NULL; return result; } } ListObjGetRep(listObj, repPtr); LISTREP_CHECK(repPtr); return TCL_OK; } /* *---------------------------------------------------------------------- * * Tcl_SetListObj -- * * Modify an object to be a list containing each of the objc elements of * the object array referenced by objv. * * Results: * None. * * Side effects: * The object is made a list object and is initialized from the object * pointers in objv. If objc is less than or equal to zero, an empty * object is returned. The new object's string representation is left * NULL. The ref counts of the elements in objv are incremented since the * list now refers to them. The object's old string and internal * representations are freed and its type is set NULL. * *---------------------------------------------------------------------- */ void Tcl_SetListObj( Tcl_Obj *objPtr, /* Object whose internal rep to init. */ ListSizeT objc, /* Count of objects referenced by objv. */ Tcl_Obj *const objv[]) /* An array of pointers to Tcl objects. */ { if (Tcl_IsShared(objPtr)) { Tcl_Panic("%s called with shared object", "Tcl_SetListObj"); } /* * Set the object's type to "list" and initialize the internal rep. * However, if there are no elements to put in the list, just give the * object an empty string rep and a NULL type. NOTE ListRepInit must * not be called with objc == 0! */ if (objc > 0) { ListRep listRep; /* TODO - perhaps ask for extra space? */ ListRepInit(objc, objv, LISTREP_PANIC_ON_FAIL, &listRep); ListObjReplaceRepAndInvalidate(objPtr, &listRep); } else { TclFreeInternalRep(objPtr); TclInvalidateStringRep(objPtr); Tcl_InitStringRep(objPtr, NULL, 0); } } /* *---------------------------------------------------------------------- * * TclListObjCopy -- * * Makes a "pure list" copy of a list value. This provides for the C * level a counterpart of the [lrange $list 0 end] command, while using * internals details to be as efficient as possible. * * Results: * Normally returns a pointer to a new Tcl_Obj, that contains the same * list value as *listPtr does. The returned Tcl_Obj has a refCount of * zero. If *listPtr does not hold a list, NULL is returned, and if * interp is non-NULL, an error message is recorded there. * * Side effects: * None. * *---------------------------------------------------------------------- */ Tcl_Obj * TclListObjCopy( Tcl_Interp *interp, /* Used to report errors if not NULL. */ Tcl_Obj *listObj) /* List object for which an element array is * to be returned. */ { Tcl_Obj *copyObj; if (!TclHasInternalRep(listObj, &tclListType)) { if (SetListFromAny(interp, listObj) != TCL_OK) { return NULL; } } TclNewObj(copyObj); TclInvalidateStringRep(copyObj); DupListInternalRep(listObj, copyObj); return copyObj; } /* *------------------------------------------------------------------------ * * ListRepRange -- * * Initializes a ListRep as a range within the passed ListRep. * The range limits are clamped to the list boundaries. * * Results: * None. * * Side effects: * The ListStore and ListSpan referenced by in the returned ListRep * may or may not be the same as those passed in. For example, the * ListStore may differ because the range is small enough that a new * ListStore is more memory-optimal. The ListSpan may differ because * it is NULL or shared. Regardless, reference counts on the returned * values are not incremented. Generally, ListObjReplaceRepAndInvalidate * may be used to store the new ListRep back into an object or a * ListRepIncrRefs followed by ListRepDecrRefs to free in case of errors. * Any other use should be carefully reconsidered. * TODO WARNING:- this is an awkward interface and easy for caller * to get wrong. Mostly due to refcount combinations. Perhaps passing * in the source listObj instead of source listRep might simplify. * *------------------------------------------------------------------------ */ static void ListRepRange( ListRep *srcRepPtr, /* Contains source of the range */ ListSizeT rangeStart, /* Index of first element to include */ ListSizeT rangeEnd, /* Index of last element to include */ int preserveSrcRep, /* If true, srcRepPtr contents must not be modified (generally because a shared Tcl_Obj references it) */ ListRep *rangeRepPtr) /* Output. Must NOT be == srcRepPtr */ { Tcl_Obj **srcElems; ListSizeT numSrcElems = ListRepLength(srcRepPtr); ListSizeT rangeLen; ListSizeT numAfterRangeEnd; LISTREP_CHECK(srcRepPtr); /* Take the opportunity to garbage collect */ /* TODO - we probably do not need the preserveSrcRep here unlike later */ if (!preserveSrcRep) { /* T:listrep-1.{4,5,8,9},2.{4:7},3.{15:18},4.{7,8} */ ListRepFreeUnreferenced(srcRepPtr); } /* else T:listrep-2.{4.2,4.3,5.2,5.3,6.2,7.2,8.1} */ if (rangeStart < 0) { rangeStart = 0; } if (rangeEnd >= numSrcElems) { rangeEnd = numSrcElems - 1; } if (rangeStart > rangeEnd) { /* Empty list of capacity 1. */ ListRepInit(1, NULL, LISTREP_PANIC_ON_FAIL, rangeRepPtr); return; } rangeLen = rangeEnd - rangeStart + 1; /* * We can create a range one of four ways: * (0) Range encapsulates entire list * (1) Special case: deleting in-place from end of an unshared object * (2) Use a ListSpan referencing the current ListStore * (3) Creating a new ListStore * (4) Removing all elements outside the range in the current ListStore * Option (4) may only be done if caller has not disallowed it AND * the ListStore is not shared. * * The choice depends on heuristics related to speed and memory. * TODO - heuristics below need to be measured and tuned. * * Note: Even if nothing below cause any changes, we still want the * string-canonizing effect of [lrange 0 end] so the Tcl_Obj should not * be returned as is even if the range encompasses the whole list. */ if (rangeStart == 0 && rangeEnd == (numSrcElems-1)) { /* Option 0 - entire list. This may be used to canonicalize */ /* T:listrep-1.10.1,2.8.1 */ *rangeRepPtr = *srcRepPtr; /* Not ref counts not incremented */ } else if (rangeStart == 0 && (!preserveSrcRep) && (!ListRepIsShared(srcRepPtr) && srcRepPtr->spanPtr == NULL)) { /* Option 1 - Special case unshared, exclude end elements, no span */ LIST_ASSERT(srcRepPtr->storePtr->firstUsed == 0); /* If no span */ ListRepElements(srcRepPtr, numSrcElems, srcElems); numAfterRangeEnd = numSrcElems - (rangeEnd + 1); /* Assert: Because numSrcElems > rangeEnd earlier */ LIST_ASSERT(numAfterRangeEnd >= 0); if (numAfterRangeEnd != 0) { /* T:listrep-1.{8,9} */ ObjArrayDecrRefs(srcElems, rangeEnd + 1, numAfterRangeEnd); } /* srcRepPtr->storePtr->firstUsed,numAllocated unchanged */ srcRepPtr->storePtr->numUsed = rangeLen; srcRepPtr->storePtr->flags = 0; rangeRepPtr->storePtr = srcRepPtr->storePtr; /* Note no incr ref */ rangeRepPtr->spanPtr = NULL; } else if (ListSpanMerited(rangeLen, srcRepPtr->storePtr->numUsed, srcRepPtr->storePtr->numAllocated)) { /* Option 2 - because span would be most efficient */ ListSizeT spanStart = ListRepStart(srcRepPtr) + rangeStart; if (!preserveSrcRep && srcRepPtr->spanPtr && srcRepPtr->spanPtr->refCount <= 1) { /* If span is not shared reuse it */ /* T:listrep-2.7.3,3.{16,18} */ srcRepPtr->spanPtr->spanStart = spanStart; srcRepPtr->spanPtr->spanLength = rangeLen; *rangeRepPtr = *srcRepPtr; } else { /* Span not present or is shared. */ /* T:listrep-1.5,2.{5,7},4.{7,8} */ rangeRepPtr->storePtr = srcRepPtr->storePtr; rangeRepPtr->spanPtr = ListSpanNew(spanStart, rangeLen); } /* * We have potentially created a new internal representation that * references the same storage as srcRep but not yet incremented its * reference count. So do NOT call freezombies if preserveSrcRep * is mandated. */ if (!preserveSrcRep) { /* T:listrep-1.{5.1,5.2,5.4},2.{5,7},3.{16,18},4.{7,8} */ ListRepFreeUnreferenced(rangeRepPtr); } } else if (preserveSrcRep || ListRepIsShared(srcRepPtr)) { /* Option 3 - span or modification in place not allowed/desired */ /* T:listrep-2.{4,6} */ ListRepElements(srcRepPtr, numSrcElems, srcElems); /* TODO - allocate extra space? */ ListRepInit(rangeLen, &srcElems[rangeStart], LISTREP_PANIC_ON_FAIL, rangeRepPtr); } else { /* * Option 4 - modify in place. Note that because of the invariant * that spanless list stores must start at 0, we have to move * everything to the front. * TODO - perhaps if a span already exists, no need to move to front? * or maybe no need to move all the way to the front? * TODO - if range is small relative to allocation, allocate new? */ /* Asserts follow from call to ListRepFreeUnreferenced earlier */ LIST_ASSERT(!preserveSrcRep); LIST_ASSERT(!ListRepIsShared(srcRepPtr)); LIST_ASSERT(ListRepStart(srcRepPtr) == srcRepPtr->storePtr->firstUsed); LIST_ASSERT(ListRepLength(srcRepPtr) == srcRepPtr->storePtr->numUsed); ListRepElements(srcRepPtr, numSrcElems, srcElems); /* Free leading elements outside range */ if (rangeStart != 0) { /* T:listrep-1.4,3.15 */ ObjArrayDecrRefs(srcElems, 0, rangeStart); } /* Ditto for trailing */ numAfterRangeEnd = numSrcElems - (rangeEnd + 1); /* Assert: Because numSrcElems > rangeEnd earlier */ LIST_ASSERT(numAfterRangeEnd >= 0); if (numAfterRangeEnd != 0) { /* T:listrep-3.17 */ ObjArrayDecrRefs(srcElems, rangeEnd + 1, numAfterRangeEnd); } memmove(&srcRepPtr->storePtr->slots[0], &srcRepPtr->storePtr ->slots[srcRepPtr->storePtr->firstUsed + rangeStart], rangeLen * sizeof(Tcl_Obj *)); srcRepPtr->storePtr->firstUsed = 0; srcRepPtr->storePtr->numUsed = rangeLen; srcRepPtr->storePtr->flags = 0; if (srcRepPtr->spanPtr) { /* In case the source has a span, update it for consistency */ /* T:listrep-3.{15,17} */ srcRepPtr->spanPtr->spanStart = srcRepPtr->storePtr->firstUsed; srcRepPtr->spanPtr->spanLength = srcRepPtr->storePtr->numUsed; } rangeRepPtr->storePtr = srcRepPtr->storePtr; rangeRepPtr->spanPtr = NULL; } /* TODO - call freezombies here if !preserveSrcRep? */ /* Note ref counts intentionally not incremented */ LISTREP_CHECK(rangeRepPtr); return; } /* *---------------------------------------------------------------------- * * TclListObjRange -- * * Makes a slice of a list value. * *listObj must be known to be a valid list. * * Results: * Returns a pointer to the sliced list. * This may be a new object or the same object if not shared. * Returns NULL if passed listObj was not a list and could not be * converted to one. * * Side effects: * The possible conversion of the object referenced by listPtr * to a list object. * *---------------------------------------------------------------------- */ Tcl_Obj * TclListObjRange( Tcl_Obj *listObj, /* List object to take a range from. */ ListSizeT rangeStart, /* Index of first element to include. */ ListSizeT rangeEnd) /* Index of last element to include. */ { ListRep listRep; ListRep resultRep; int isShared; if (TclListObjGetRep(NULL, listObj, &listRep) != TCL_OK) return NULL; isShared = Tcl_IsShared(listObj); ListRepRange(&listRep, rangeStart, rangeEnd, isShared, &resultRep); if (isShared) { /* T:listrep-1.10.1,2.{4.2,4.3,5.2,5.3,6.2,7.2,8.1} */ TclNewObj(listObj); } /* T:listrep-1.{4.3,5.1,5.2} */ ListObjReplaceRepAndInvalidate(listObj, &resultRep); return listObj; } /* *---------------------------------------------------------------------- * * Tcl_ListObjGetElements -- * * This function returns an (objc,objv) array of the elements in a list * object. * * Results: * The return value is normally TCL_OK; in this case *objcPtr is set to * the count of list elements and *objvPtr is set to a pointer to an * array of (*objcPtr) pointers to each list element. If listPtr does not * refer to a list object and the object can not be converted to one, * TCL_ERROR is returned and an error message will be left in the * interpreter's result if interp is not NULL. * * The objects referenced by the returned array should be treated as * readonly and their ref counts are _not_ incremented; the caller must * do that if it holds on to a reference. Furthermore, the pointer and * length returned by this function may change as soon as any function is * called on the list object; be careful about retaining the pointer in a * local data structure. * * Side effects: * The possible conversion of the object referenced by listPtr * to a list object. * *---------------------------------------------------------------------- */ #undef Tcl_ListObjGetElements int Tcl_ListObjGetElements( Tcl_Interp *interp, /* Used to report errors if not NULL. */ Tcl_Obj *objPtr, /* List object for which an element array is * to be returned. */ ListSizeT *objcPtr, /* Where to store the count of objects * referenced by objv. */ Tcl_Obj ***objvPtr) /* Where to store the pointer to an array of * pointers to the list's objects. */ { ListRep listRep; if (TclListObjGetRep(interp, objPtr, &listRep) != TCL_OK) return TCL_ERROR; ListRepElements(&listRep, *objcPtr, *objvPtr); return TCL_OK; } /* *---------------------------------------------------------------------- * * Tcl_ListObjAppendList -- * * This function appends the elements in the list fromObj * to toObj. toObj must not be shared else the function will panic. * * Results: * The return value is normally TCL_OK. If fromObj or toObj do not * refer to list values, TCL_ERROR is returned and an error message is * left in the interpreter's result if interp is not NULL. * * Side effects: * The reference counts of the elements in fromObj are incremented * since the list now refers to them. toObj and fromObj are * converted, if necessary, to list objects. Also, appending the new * elements may cause toObj's array of element pointers to grow. * toObj's old string representation, if any, is invalidated. * *---------------------------------------------------------------------- */ int Tcl_ListObjAppendList( Tcl_Interp *interp, /* Used to report errors if not NULL. */ Tcl_Obj *toObj, /* List object to append elements to. */ Tcl_Obj *fromObj) /* List obj with elements to append. */ { ListSizeT objc; Tcl_Obj **objv; if (Tcl_IsShared(toObj)) { Tcl_Panic("%s called with shared object", "Tcl_ListObjAppendList"); } if (TclListObjGetElementsM(interp, fromObj, &objc, &objv) != TCL_OK) { return TCL_ERROR; } /* * Insert the new elements starting after the lists's last element. * Delete zero existing elements. */ return TclListObjAppendElements(interp, toObj, objc, objv); } /* *------------------------------------------------------------------------ * * TclListObjAppendElements -- * * Appends multiple elements to a Tcl_Obj list object. If * the passed Tcl_Obj is not a list object, it will be converted to one * and an error raised if the conversion fails. * * The Tcl_Obj must not be shared though the internal representation * may be. * * Results: * On success, TCL_OK is returned with the specified elements appended. * On failure, TCL_ERROR is returned with an error message in the * interpreter if not NULL. * * Side effects: * None. * *------------------------------------------------------------------------ */ int TclListObjAppendElements ( Tcl_Interp *interp, /* Used to report errors if not NULL. */ Tcl_Obj *toObj, /* List object to append */ ListSizeT elemCount, /* Number of elements in elemObjs[] */ Tcl_Obj * const elemObjv[]) /* Objects to append to toObj's list. */ { ListRep listRep; Tcl_Obj **toObjv; ListSizeT toLen; ListSizeT finalLen; if (Tcl_IsShared(toObj)) { Tcl_Panic("%s called with shared object", "TclListObjAppendElements"); } if (TclListObjGetRep(interp, toObj, &listRep) != TCL_OK) return TCL_ERROR; /* Cannot be converted to a list */ if (elemCount == 0) return TCL_OK; /* Nothing to do. Note AFTER check for list above */ ListRepElements(&listRep, toLen, toObjv); if (elemCount > LIST_MAX || toLen > (LIST_MAX - elemCount)) { return ListLimitExceededError(interp); } finalLen = toLen + elemCount; if (!ListRepIsShared(&listRep)) { /* * Reuse storage if possible. Even if too small, realloc-ing instead * of creating a new ListStore will save us on manipulating Tcl_Obj * reference counts on the elements which is a substantial cost * if the list is not small. */ ListSizeT numTailFree; ListRepFreeUnreferenced(&listRep); /* Collect garbage before checking room */ LIST_ASSERT(ListRepStart(&listRep) == listRep.storePtr->firstUsed); LIST_ASSERT(ListRepLength(&listRep) == listRep.storePtr->numUsed); LIST_ASSERT(toLen == listRep.storePtr->numUsed); if (finalLen > listRep.storePtr->numAllocated) { /* T:listrep-1.{2,11},3.6 */ ListStore *newStorePtr; newStorePtr = ListStoreReallocate(listRep.storePtr, finalLen); if (newStorePtr == NULL) { return MemoryAllocationError(interp, LIST_SIZE(finalLen)); } LIST_ASSERT(newStorePtr->numAllocated >= finalLen); listRep.storePtr = newStorePtr; /* * WARNING: at this point the Tcl_Obj internal rep potentially * points to freed storage if the reallocation returned a * different location. Overwrite it to bring it back in sync. */ ListObjStompRep(toObj, &listRep); } /* else T:listrep-3.{4,5} */ LIST_ASSERT(listRep.storePtr->numAllocated >= finalLen); /* Current store big enough */ numTailFree = ListRepNumFreeTail(&listRep); LIST_ASSERT((numTailFree + listRep.storePtr->firstUsed) >= elemCount); /* Total free */ if (numTailFree < elemCount) { /* Not enough room at back. Move some to front */ /* T:listrep-3.5 */ ListSizeT shiftCount = elemCount - numTailFree; /* Divide remaining space between front and back */ shiftCount += (listRep.storePtr->numAllocated - finalLen) / 2; LIST_ASSERT(shiftCount <= listRep.storePtr->firstUsed); if (shiftCount) { /* T:listrep-3.5 */ ListRepUnsharedShiftDown(&listRep, shiftCount); } } /* else T:listrep-3.{4,6} */ ObjArrayCopy(&listRep.storePtr->slots[ListRepStart(&listRep) + ListRepLength(&listRep)], elemCount, elemObjv); listRep.storePtr->numUsed = finalLen; if (listRep.spanPtr) { /* T:listrep-3.{4,5,6} */ LIST_ASSERT(listRep.spanPtr->spanStart == listRep.storePtr->firstUsed); listRep.spanPtr->spanLength = finalLen; } /* else T:listrep-3.6.3 */ LIST_ASSERT(ListRepStart(&listRep) == listRep.storePtr->firstUsed); LIST_ASSERT(ListRepLength(&listRep) == finalLen); LISTREP_CHECK(&listRep); ListObjReplaceRepAndInvalidate(toObj, &listRep); return TCL_OK; } /* * Have to make a new list rep, either shared or no room in old one. * If the old list did not have a span (all elements at front), do * not leave space in the front either, assuming all appends and no * prepends. */ if (ListRepInit(finalLen, NULL, listRep.spanPtr ? LISTREP_SPACE_FAVOR_BACK : LISTREP_SPACE_ONLY_BACK, &listRep) != TCL_OK) { return TCL_ERROR; } LIST_ASSERT(listRep.storePtr->numAllocated >= finalLen); if (toLen) { /* T:listrep-2.{2,9},4.5 */ ObjArrayCopy(ListRepSlotPtr(&listRep, 0), toLen, toObjv); } ObjArrayCopy(ListRepSlotPtr(&listRep, toLen), elemCount, elemObjv); listRep.storePtr->numUsed = finalLen; if (listRep.spanPtr) { /* T:listrep-4.5 */ LIST_ASSERT(listRep.spanPtr->spanStart == listRep.storePtr->firstUsed); listRep.spanPtr->spanLength = finalLen; } LISTREP_CHECK(&listRep); ListObjReplaceRepAndInvalidate(toObj, &listRep); return TCL_OK; } /* *---------------------------------------------------------------------- * * Tcl_ListObjAppendElement -- * * This function is a special purpose version of Tcl_ListObjAppendList: * it appends a single object referenced by elemObj to the list object * referenced by toObj. If toObj is not already a list object, an * attempt will be made to convert it to one. * * Results: * The return value is normally TCL_OK; in this case elemObj is added to * the end of toObj's list. If toObj does not refer to a list object * and the object can not be converted to one, TCL_ERROR is returned and * an error message will be left in the interpreter's result if interp is * not NULL. * * Side effects: * The ref count of elemObj is incremented since the list now refers to * it. toObj will be converted, if necessary, to a list object. Also, * appending the new element may cause listObj's array of element * pointers to grow. toObj's old string representation, if any, is * invalidated. * *---------------------------------------------------------------------- */ int Tcl_ListObjAppendElement( Tcl_Interp *interp, /* Used to report errors if not NULL. */ Tcl_Obj *toObj, /* List object to append elemObj to. */ Tcl_Obj *elemObj) /* Object to append to toObj's list. */ { /* * TODO - compare perf with 8.6 to see if worth optimizing single * element case */ return TclListObjAppendElements(interp, toObj, 1, &elemObj); } /* *---------------------------------------------------------------------- * * Tcl_ListObjIndex -- * * This function returns a pointer to the index'th object from the list * referenced by listPtr. The first element has index 0. If index is * negative or greater than or equal to the number of elements in the * list, a NULL is returned. If listPtr is not a list object, an attempt * will be made to convert it to a list. * * Results: * The return value is normally TCL_OK; in this case objPtrPtr is set to * the Tcl_Obj pointer for the index'th list element or NULL if index is * out of range. This object should be treated as readonly and its ref * count is _not_ incremented; the caller must do that if it holds on to * the reference. If listPtr does not refer to a list and can't be * converted to one, TCL_ERROR is returned and an error message is left * in the interpreter's result if interp is not NULL. * * Side effects: * listPtr will be converted, if necessary, to a list object. * *---------------------------------------------------------------------- */ int Tcl_ListObjIndex( Tcl_Interp *interp, /* Used to report errors if not NULL. */ Tcl_Obj *listObj, /* List object to index into. */ ListSizeT index, /* Index of element to return. */ Tcl_Obj **objPtrPtr) /* The resulting Tcl_Obj* is stored here. */ { Tcl_Obj **elemObjs; ListSizeT numElems; /* * TODO * Unlike the original list code, this does not optimize for lindex'ing * an empty string when the internal rep is not already a list. On the * other hand, this code will be faster for the case where the object * is currently a dict. Benchmark the two cases. */ if (TclListObjGetElementsM(interp, listObj, &numElems, &elemObjs) != TCL_OK) { return TCL_ERROR; } if ((index < 0) || (index >= numElems)) { *objPtrPtr = NULL; } else { *objPtrPtr = elemObjs[index]; } return TCL_OK; } /* *---------------------------------------------------------------------- * * Tcl_ListObjLength -- * * This function returns the number of elements in a list object. If the * object is not already a list object, an attempt will be made to * convert it to one. * * Results: * The return value is normally TCL_OK; in this case *intPtr will be set * to the integer count of list elements. If listPtr does not refer to a * list object and the object can not be converted to one, TCL_ERROR is * returned and an error message will be left in the interpreter's result * if interp is not NULL. * * Side effects: * The possible conversion of the argument object to a list object. * *---------------------------------------------------------------------- */ #undef Tcl_ListObjLength int Tcl_ListObjLength( Tcl_Interp *interp, /* Used to report errors if not NULL. */ Tcl_Obj *listObj, /* List object whose #elements to return. */ ListSizeT *lenPtr) /* The resulting int is stored here. */ { ListRep listRep; /* * TODO * Unlike the original list code, this does not optimize for lindex'ing * an empty string when the internal rep is not already a list. On the * other hand, this code will be faster for the case where the object * is currently a dict. Benchmark the two cases. */ if (TclListObjGetRep(interp, listObj, &listRep) != TCL_OK) { return TCL_ERROR; } *lenPtr = ListRepLength(&listRep); return TCL_OK; } /* *---------------------------------------------------------------------- * * Tcl_ListObjReplace -- * * This function replaces zero or more elements of the list referenced by * listObj with the objects from an (objc,objv) array. The objc elements * of the array referenced by objv replace the count elements in listPtr * starting at first. * * If the argument first is zero or negative, it refers to the first * element. If first is greater than or equal to the number of elements * in the list, then no elements are deleted; the new elements are * appended to the list. Count gives the number of elements to replace. * If count is zero or negative then no elements are deleted; the new * elements are simply inserted before first. * * The argument objv refers to an array of objc pointers to the new * elements to be added to listPtr in place of those that were deleted. * If objv is NULL, no new elements are added. If listPtr is not a list * object, an attempt will be made to convert it to one. * * Results: * The return value is normally TCL_OK. If listPtr does not refer to a * list object and can not be converted to one, TCL_ERROR is returned and * an error message will be left in the interpreter's result if interp is * not NULL. * * Side effects: * The ref counts of the objc elements in objv are incremented since the * resulting list now refers to them. Similarly, the ref counts for * replaced objects are decremented. listObj is converted, if necessary, * to a list object. listObj's old string representation, if any, is * freed. * *---------------------------------------------------------------------- */ int Tcl_ListObjReplace( Tcl_Interp *interp, /* Used for error reporting if not NULL. */ Tcl_Obj *listObj, /* List object whose elements to replace. */ ListSizeT first, /* Index of first element to replace. */ ListSizeT numToDelete, /* Number of elements to replace. */ ListSizeT numToInsert, /* Number of objects to insert. */ Tcl_Obj *const insertObjs[])/* Tcl objects to insert */ { ListRep listRep; ListSizeT origListLen; ListSizeT lenChange; ListSizeT leadSegmentLen; ListSizeT tailSegmentLen; ListSizeT numFreeSlots; ListSizeT leadShift; ListSizeT tailShift; Tcl_Obj **listObjs; int favor; if (Tcl_IsShared(listObj)) { Tcl_Panic("%s called with shared object", "Tcl_ListObjReplace"); } if (TclListObjGetRep(interp, listObj, &listRep) != TCL_OK) return TCL_ERROR; /* Cannot be converted to a list */ /* TODO - will need modification if Tcl9 sticks to unsigned indices */ /* Make limits sane */ origListLen = ListRepLength(&listRep); if (first < 0) { first = 0; } if (first > origListLen) { first = origListLen; /* So we'll insert after last element. */ } if (numToDelete < 0) { numToDelete = 0; } else if (first > ListSizeT_MAX - numToDelete /* Handle integer overflow */ || origListLen < first + numToDelete) { numToDelete = origListLen - first; } if (numToInsert > ListSizeT_MAX - (origListLen - numToDelete)) { return ListLimitExceededError(interp); } if ((first+numToDelete) >= origListLen) { /* Operating at back of list. Favor leaving space at back */ favor = LISTREP_SPACE_FAVOR_BACK; } else if (first == 0) { /* Operating on front of list. Favor leaving space in front */ favor = LISTREP_SPACE_FAVOR_FRONT; } else { /* Operating on middle of list. */ favor = LISTREP_SPACE_FAVOR_NONE; } /* * There are a number of special cases to consider from an optimization * point of view. * (1) Pure deletes (numToInsert==0) from the front or back can be treated * as a range op irrespective of whether the ListStore is shared or not * (2) Pure inserts (numToDelete == 0) * (2a) Pure inserts at the back can be treated as appends * (2b) Pure inserts from the *front* can be optimized under certain * conditions by inserting before first ListStore slot in use if there * is room, again irrespective of sharing * (3) If the ListStore is shared OR there is insufficient free space * OR existing allocation is too large compared to new size, create * a new ListStore * (4) Unshared ListStore with sufficient free space. Delete, shift and * insert within the ListStore. */ /* Note: do not do TclInvalidateStringRep as yet in case there are errors */ /* Check Case (1) - Treat pure deletes from front or back as range ops */ if (numToInsert == 0) { if (numToDelete == 0) { /* * Should force canonical even for no-op. Remember Tcl_Obj unshared * so OK to invalidate string rep */ /* T:listrep-1.10,2.8 */ TclInvalidateStringRep(listObj); return TCL_OK; } if (first == 0) { /* Delete from front, so return tail. */ /* T:listrep-1.{4,5},2.{4,5},3.{15,16},4.7 */ ListRep tailRep; ListRepRange(&listRep, numToDelete, origListLen-1, 0, &tailRep); ListObjReplaceRepAndInvalidate(listObj, &tailRep); return TCL_OK; } else if ((first+numToDelete) >= origListLen) { /* Delete from tail, so return head */ /* T:listrep-1.{8,9},2.{6,7},3.{17,18},4.8 */ ListRep headRep; ListRepRange(&listRep, 0, first-1, 0, &headRep); ListObjReplaceRepAndInvalidate(listObj, &headRep); return TCL_OK; } /* Deletion from middle. Fall through to general case */ } /* Garbage collect before checking the pure insert optimization */ ListRepFreeUnreferenced(&listRep); /* * Check Case (2) - pure inserts under certain conditions: */ if (numToDelete == 0) { /* Case (2a) - Append to list. */ if (first == origListLen) { /* T:listrep-1.11,2.9,3.{5,6},2.2.1 */ return TclListObjAppendElements( interp, listObj, numToInsert, insertObjs); } /* * Case (2b) - pure inserts at front under some circumstances * (i) Insertion must be at head of list * (ii) The list's span must be at head of the in-use slots in the store * (iii) There must be unused room at front of the store * NOTE THIS IS TRUE EVEN IF THE ListStore IS SHARED as it will not * affect the other Tcl_Obj's referencing this ListStore. */ if (first == 0 && /* (i) */ ListRepStart(&listRep) == listRep.storePtr->firstUsed && /* (ii) */ numToInsert <= listRep.storePtr->firstUsed /* (iii) */ ) { ListSizeT newLen; LIST_ASSERT(numToInsert); /* Else would have returned above */ listRep.storePtr->firstUsed -= numToInsert; ObjArrayCopy(&listRep.storePtr->slots[listRep.storePtr->firstUsed], numToInsert, insertObjs); listRep.storePtr->numUsed += numToInsert; newLen = listRep.spanPtr->spanLength + numToInsert; if (listRep.spanPtr && listRep.spanPtr->refCount <= 1) { /* An unshared span record, re-use it */ /* T:listrep-3.1 */ listRep.spanPtr->spanStart = listRep.storePtr->firstUsed; listRep.spanPtr->spanLength = newLen; } else { /* Need a new span record */ if (listRep.storePtr->firstUsed == 0) { listRep.spanPtr = NULL; } else { /* T:listrep-4.3 */ listRep.spanPtr = ListSpanNew(listRep.storePtr->firstUsed, newLen); } } ListObjReplaceRepAndInvalidate(listObj, &listRep); return TCL_OK; } } /* Just for readability of the code */ lenChange = numToInsert - numToDelete; leadSegmentLen = first; tailSegmentLen = origListLen - (first + numToDelete); numFreeSlots = listRep.storePtr->numAllocated - listRep.storePtr->numUsed; /* * Before further processing, if unshared, try and reallocate to avoid * new allocation below. This avoids expensive ref count manipulation * later by not having to go through the ListRepInit and * ListObjReplaceAndInvalidate below. * TODO - we could be smarter about the reallocate. Use of realloc * means all new free space is at the back. Instead, the realloc could * be an explicit alloc and memmove which would let us redistribute * free space. */ if (numFreeSlots < lenChange && !ListRepIsShared(&listRep)) { /* T:listrep-1.{1,3,14,18,21},3.{3,10,11,14,27,32,41} */ ListStore *newStorePtr = ListStoreReallocate(listRep.storePtr, origListLen + lenChange); if (newStorePtr == NULL) { return MemoryAllocationError(interp, LIST_SIZE(origListLen + lenChange)); } listRep.storePtr = newStorePtr; numFreeSlots = listRep.storePtr->numAllocated - listRep.storePtr->numUsed; /* * WARNING: at this point the Tcl_Obj internal rep potentially * points to freed storage if the reallocation returned a * different location. Overwrite it to bring it back in sync. */ ListObjStompRep(listObj, &listRep); } /* * Case (3) a new ListStore is required * (a) The passed-in ListStore is shared * (b) There is not enough free space in the unshared passed-in ListStore * (c) The new unshared size is much "smaller" (TODO) than the allocated space * TODO - for unshared case ONLY, consider a "move" based implementation */ if (ListRepIsShared(&listRep) || /* 3a */ numFreeSlots < lenChange || /* 3b */ (origListLen + lenChange) < (listRep.storePtr->numAllocated / 4) /* 3c */ ) { ListRep newRep; Tcl_Obj **toObjs; listObjs = &listRep.storePtr->slots[ListRepStart(&listRep)]; ListRepInit(origListLen + lenChange, NULL, LISTREP_PANIC_ON_FAIL | favor, &newRep); toObjs = ListRepSlotPtr(&newRep, 0); if (leadSegmentLen > 0) { /* T:listrep-2.{2,3,13:18},4.{6,9,13:18} */ ObjArrayCopy(toObjs, leadSegmentLen, listObjs); } if (numToInsert > 0) { /* T:listrep-2.{1,2,3,10:18},4.{1,2,4,6,10:18} */ ObjArrayCopy(&toObjs[leadSegmentLen], numToInsert, insertObjs); } if (tailSegmentLen > 0) { /* T:listrep-2.{1,2,3,10:15},4.{1,2,4,6,9:12,16:18} */ ObjArrayCopy(&toObjs[leadSegmentLen + numToInsert], tailSegmentLen, &listObjs[leadSegmentLen+numToDelete]); } newRep.storePtr->numUsed = origListLen + lenChange; if (newRep.spanPtr) { /* T:listrep-2.{1,2,3,10:18},4.{1,2,4,6,9:18} */ newRep.spanPtr->spanLength = newRep.storePtr->numUsed; } LISTREP_CHECK(&newRep); ListObjReplaceRepAndInvalidate(listObj, &newRep); return TCL_OK; } /* * Case (4) - unshared ListStore with sufficient room. * After deleting elements, there will be a corresponding gap. If this * gap does not match number of insertions, either the lead segment, * or the tail segment, or both will have to be moved. * The general strategy is to move the fewest number of elements. If * * TODO - what about appends to unshared ? Is below sufficiently optimal? */ /* Following must hold for unshared listreps after ListRepFreeUnreferenced above */ LIST_ASSERT(origListLen == listRep.storePtr->numUsed); LIST_ASSERT(origListLen == ListRepLength(&listRep)); LIST_ASSERT(ListRepStart(&listRep) == listRep.storePtr->firstUsed); LIST_ASSERT((numToDelete + numToInsert) > 0); /* Base of slot array holding the list elements */ listObjs = &listRep.storePtr->slots[ListRepStart(&listRep)]; /* * Free up elements to be deleted. Before that, increment the ref counts * for objects to be inserted in case there is overlap. T:listobj-11.1 */ if (numToInsert) { /* T:listrep-1.{1,3,12:21},3.{2,3,7:14,23:41} */ ObjArrayIncrRefs(insertObjs, 0, numToInsert); } if (numToDelete) { /* T:listrep-1.{6,7,12:21},3.{19:41} */ ObjArrayDecrRefs(listObjs, first, numToDelete); } /* * TODO - below the moves are optimized but this may result in needing a * span allocation. Perhaps for small lists, it may be more efficient to * just move everything up front and save on allocating a span. */ /* * Calculate shifts if necessary to accomodate insertions. * NOTE: all indices are relative to listObjs which is not necessarily the * start of the ListStore storage area. * * leadShift - how much to shift the lead segment * tailShift - how much to shift the tail segment * insertTarget - index where to insert. */ if (lenChange == 0) { /* T:listrep-1.{12,15,19},3.{23,28,33}. Exact fit */ leadShift = 0; tailShift = 0; } else if (lenChange < 0) { /* * More deletions than insertions. The gap after deletions is large * enough for insertions. Move a segment depending on size. */ if (leadSegmentLen > tailSegmentLen) { /* Tail segment smaller. Insert after lead, move tail down */ /* T:listrep-1.{7,17,20},3.{21,2229,35} */ leadShift = 0; tailShift = lenChange; } else { /* Lead segment smaller. Insert before tail, move lead up */ /* T:listrep-1.{6,13,16},3.{19,20,24,34} */ leadShift = -lenChange; tailShift = 0; } } else { LIST_ASSERT(lenChange > 0); /* Reminder */ /* * We need to make room for the insertions. Again we have multiple * possibilities. We may be able to get by just shifting one segment * or need to shift both. In the former case, favor shifting the * smaller segment. */ ListSizeT leadSpace = ListRepNumFreeHead(&listRep); ListSizeT tailSpace = ListRepNumFreeTail(&listRep); ListSizeT finalFreeSpace = leadSpace + tailSpace - lenChange; LIST_ASSERT((leadSpace + tailSpace) >= lenChange); if (leadSpace >= lenChange && (leadSegmentLen < tailSegmentLen || tailSpace < lenChange)) { /* Move only lead to the front to make more room */ /* T:listrep-3.25,36,38, */ leadShift = -lenChange; tailShift = 0; /* * Redistribute the remaining free space between the front and * back if either there is no tail space left or if the * entire list is the head anyways. This is an important * optimization for further operations like further asymmetric * insertions. */ if (finalFreeSpace > 1 && (tailSpace == 0 || tailSegmentLen == 0)) { ListSizeT postShiftLeadSpace = leadSpace - lenChange; if (postShiftLeadSpace > (finalFreeSpace/2)) { ListSizeT extraShift = postShiftLeadSpace - (finalFreeSpace / 2); leadShift -= extraShift; tailShift = -extraShift; /* Move tail to the front as well */ } } /* else T:listrep-3.{7,12,25,38} */ LIST_ASSERT(leadShift >= 0 || leadSpace >= -leadShift); } else if (tailSpace >= lenChange) { /* Move only tail segment to the back to make more room. */ /* T:listrep-3.{8,10,11,14,26,27,30,32,37,39,41} */ leadShift = 0; tailShift = lenChange; /* * See comments above. This is analogous. */ if (finalFreeSpace > 1 && (leadSpace == 0 || leadSegmentLen == 0)) { ListSizeT postShiftTailSpace = tailSpace - lenChange; if (postShiftTailSpace > (finalFreeSpace/2)) { /* T:listrep-1.{1,3,14,18,21},3.{2,3,26,27} */ ListSizeT extraShift = postShiftTailSpace - (finalFreeSpace / 2); tailShift += extraShift; leadShift = extraShift; /* Move head to the back as well */ } } LIST_ASSERT(tailShift <= tailSpace); } else { /* * Both lead and tail need to be shifted to make room. * Divide remaining free space equally between front and back. */ /* T:listrep-3.{9,13,31,40} */ LIST_ASSERT(leadSpace < lenChange); LIST_ASSERT(tailSpace < lenChange); /* * leadShift = leadSpace - (finalFreeSpace/2) * Thus leadShift <= leadSpace * Also, * = leadSpace - (leadSpace + tailSpace - lenChange)/2 * = leadSpace/2 - tailSpace/2 + lenChange/2 * >= 0 because lenChange > tailSpace */ leadShift = leadSpace - (finalFreeSpace / 2); tailShift = lenChange - leadShift; if (tailShift > tailSpace) { /* Account for integer division errors */ leadShift += 1; tailShift -= 1; } /* * Following must be true because otherwise one of the previous * if clauses would have been taken. */ LIST_ASSERT(leadShift > 0 && leadShift < lenChange); LIST_ASSERT(tailShift > 0 && tailShift < lenChange); leadShift = -leadShift; /* Lead is actually shifted downward */ } } /* Careful about order of moves! */ if (leadShift > 0) { /* Will happen when we have to make room at bottom */ if (tailShift != 0 && tailSegmentLen != 0) { /* T:listrep-1.{1,3,14,18},3.{2,3,26,27} */ ListSizeT tailStart = leadSegmentLen + numToDelete; memmove(&listObjs[tailStart + tailShift], &listObjs[tailStart], tailSegmentLen * sizeof(Tcl_Obj *)); } if (leadSegmentLen != 0) { /* T:listrep-1.{3,6,16,18,21},3.{19,20,34} */ memmove(&listObjs[leadShift], &listObjs[0], leadSegmentLen * sizeof(Tcl_Obj *)); } } else { if (leadShift != 0 && leadSegmentLen != 0) { /* T:listrep-3.{7,9,12,13,31,36,38,40} */ memmove(&listObjs[leadShift], &listObjs[0], leadSegmentLen * sizeof(Tcl_Obj *)); } if (tailShift != 0 && tailSegmentLen != 0) { /* T:listrep-1.{7,17},3.{8:11,13,14,21,22,35,37,39:41} */ ListSizeT tailStart = leadSegmentLen + numToDelete; memmove(&listObjs[tailStart + tailShift], &listObjs[tailStart], tailSegmentLen * sizeof(Tcl_Obj *)); } } if (numToInsert) { /* Do NOT use ObjArrayCopy here since we have already incr'ed ref counts */ /* T:listrep-1.{1,3,12:21},3.{2,3,7:14,23:41} */ memmove(&listObjs[leadSegmentLen + leadShift], insertObjs, numToInsert * sizeof(Tcl_Obj *)); } listRep.storePtr->firstUsed += leadShift; listRep.storePtr->numUsed = origListLen + lenChange; listRep.storePtr->flags = 0; if (listRep.spanPtr && listRep.spanPtr->refCount <= 1) { /* An unshared span record, re-use it, even if not required */ /* T:listrep-3.{2,3,7:14},3.{19:41} */ listRep.spanPtr->spanStart = listRep.storePtr->firstUsed; listRep.spanPtr->spanLength = listRep.storePtr->numUsed; } else { /* Need a new span record */ if (listRep.storePtr->firstUsed == 0) { /* T:listrep-1.{7,12,15,17,19,20} */ listRep.spanPtr = NULL; } else { /* T:listrep-1.{1,3,6.1,13,14,16,18,21} */ listRep.spanPtr = ListSpanNew(listRep.storePtr->firstUsed, listRep.storePtr->numUsed); } } LISTREP_CHECK(&listRep); ListObjReplaceRepAndInvalidate(listObj, &listRep); return TCL_OK; } /* *---------------------------------------------------------------------- * * TclLindexList -- * * This procedure handles the 'lindex' command when objc==3. * * Results: * Returns a pointer to the object extracted, or NULL if an error * occurred. The returned object already includes one reference count for * the pointer returned. * * Side effects: * None. * * Notes: * This procedure is implemented entirely as a wrapper around * TclLindexFlat. All it does is reconfigure the argument format into the * form required by TclLindexFlat, while taking care to manage shimmering * in such a way that we tend to keep the most useful internalreps and/or * avoid the most expensive conversions. * *---------------------------------------------------------------------- */ Tcl_Obj * TclLindexList( Tcl_Interp *interp, /* Tcl interpreter. */ Tcl_Obj *listObj, /* List being unpacked. */ Tcl_Obj *argObj) /* Index or index list. */ { ListSizeT index; /* Index into the list. */ Tcl_Obj *indexListCopy; Tcl_Obj **indexObjs; ListSizeT numIndexObjs; /* * Determine whether argPtr designates a list or a single index. We have * to be careful about the order of the checks to avoid repeated * shimmering; if internal rep is already a list do not shimmer it. * see TIP#22 and TIP#33 for the details. */ if (!TclHasInternalRep(argObj, &tclListType) && TclGetIntForIndexM(NULL, argObj, ListSizeT_MAX - 1, &index) == TCL_OK) { /* * argPtr designates a single index. */ return TclLindexFlat(interp, listObj, 1, &argObj); } /* * Here we make a private copy of the index list argument to avoid any * shimmering issues that might invalidate the indices array below while * we are still using it. This is probably unnecessary. It does not appear * that any damaging shimmering is possible, and no test has been devised * to show any error when this private copy is not made. But it's cheap, * and it offers some future-proofing insurance in case the TclLindexFlat * implementation changes in some unexpected way, or some new form of * trace or callback permits things to happen that the current * implementation does not. */ indexListCopy = TclListObjCopy(NULL, argObj); if (indexListCopy == NULL) { /* * The argument is neither an index nor a well-formed list. * Report the error via TclLindexFlat. * TODO - This is as original. why not directly return an error? */ return TclLindexFlat(interp, listObj, 1, &argObj); } ListObjGetElements(indexListCopy, numIndexObjs, indexObjs); listObj = TclLindexFlat(interp, listObj, numIndexObjs, indexObjs); Tcl_DecrRefCount(indexListCopy); return listObj; } /* *---------------------------------------------------------------------- * * TclLindexFlat -- * * This procedure is the core of the 'lindex' command, with all index * arguments presented as a flat list. * * Results: * Returns a pointer to the object extracted, or NULL if an error * occurred. The returned object already includes one reference count for * the pointer returned. * * Side effects: * None. * * Notes: * The reference count of the returned object includes one reference * corresponding to the pointer returned. Thus, the calling code will * usually do something like: * Tcl_SetObjResult(interp, result); * Tcl_DecrRefCount(result); * *---------------------------------------------------------------------- */ Tcl_Obj * TclLindexFlat( Tcl_Interp *interp, /* Tcl interpreter. */ Tcl_Obj *listObj, /* Tcl object representing the list. */ ListSizeT indexCount, /* Count of indices. */ Tcl_Obj *const indexArray[])/* Array of pointers to Tcl objects that * represent the indices in the list. */ { ListSizeT i; Tcl_IncrRefCount(listObj); for (i=0 ; i<indexCount && listObj ; i++) { ListSizeT index, listLen = 0; Tcl_Obj **elemPtrs = NULL, *sublistCopy; /* * Here we make a private copy of the current sublist, so we avoid any * shimmering issues that might invalidate the elemPtr array below * while we are still using it. See test lindex-8.4. */ sublistCopy = TclListObjCopy(interp, listObj); Tcl_DecrRefCount(listObj); listObj = NULL; if (sublistCopy == NULL) { /* The sublist is not a list at all => error. */ break; } LIST_ASSERT_TYPE(sublistCopy); ListObjGetElements(sublistCopy, listLen, elemPtrs); if (TclGetIntForIndexM(interp, indexArray[i], /*endValue*/ listLen-1, &index) == TCL_OK) { if (index<0 || index>=listLen) { /* * Index is out of range. Break out of loop with empty result. * First check remaining indices for validity */ while (++i < indexCount) { if (TclGetIntForIndexM( interp, indexArray[i], ListSizeT_MAX - 1, &index) != TCL_OK) { Tcl_DecrRefCount(sublistCopy); return NULL; } } TclNewObj(listObj); } else { /* Extract the pointer to the appropriate element. */ listObj = elemPtrs[index]; } Tcl_IncrRefCount(listObj); } Tcl_DecrRefCount(sublistCopy); } return listObj; } /* *---------------------------------------------------------------------- * * TclLsetList -- * * Core of the 'lset' command when objc == 4. Objv[2] may be either a * scalar index or a list of indices. * It also handles 'lpop' when given a NULL value. * * Results: * Returns the new value of the list variable, or NULL if there was an * error. The returned object includes one reference count for the * pointer returned. * * Side effects: * None. * * Notes: * This procedure is implemented entirely as a wrapper around * TclLsetFlat. All it does is reconfigure the argument format into the * form required by TclLsetFlat, while taking care to manage shimmering * in such a way that we tend to keep the most useful internalreps and/or * avoid the most expensive conversions. * *---------------------------------------------------------------------- */ Tcl_Obj * TclLsetList( Tcl_Interp *interp, /* Tcl interpreter. */ Tcl_Obj *listObj, /* Pointer to the list being modified. */ Tcl_Obj *indexArgObj, /* Index or index-list arg to 'lset'. */ Tcl_Obj *valueObj) /* Value arg to 'lset' or NULL to 'lpop'. */ { ListSizeT indexCount = 0; /* Number of indices in the index list. */ Tcl_Obj **indices = NULL; /* Vector of indices in the index list. */ Tcl_Obj *retValueObj; /* Pointer to the list to be returned. */ ListSizeT index; /* Current index in the list - discarded. */ Tcl_Obj *indexListCopy; /* * Determine whether the index arg designates a list or a single index. * We have to be careful about the order of the checks to avoid repeated * shimmering; see TIP #22 and #23 for details. */ if (!TclHasInternalRep(indexArgObj, &tclListType) && TclGetIntForIndexM(NULL, indexArgObj, ListSizeT_MAX - 1, &index) == TCL_OK) { /* indexArgPtr designates a single index. */ /* T:listrep-1.{2.1,12.1,15.1,19.1},2.{2.3,9.3,10.1,13.1,16.1}, 3.{4,5,6}.3 */ return TclLsetFlat(interp, listObj, 1, &indexArgObj, valueObj); } indexListCopy = TclListObjCopy(NULL, indexArgObj); if (indexListCopy == NULL) { /* * indexArgPtr designates something that is neither an index nor a * well formed list. Report the error via TclLsetFlat. */ return TclLsetFlat(interp, listObj, 1, &indexArgObj, valueObj); } LIST_ASSERT_TYPE(indexListCopy); ListObjGetElements(indexListCopy, indexCount, indices); /* * Let TclLsetFlat handle the actual lset'ting. */ retValueObj = TclLsetFlat(interp, listObj, indexCount, indices, valueObj); Tcl_DecrRefCount(indexListCopy); return retValueObj; } /* *---------------------------------------------------------------------- * * TclLsetFlat -- * * Core engine of the 'lset' command. * It also handles 'lpop' when given a NULL value. * * Results: * Returns the new value of the list variable, or NULL if an error * occurred. The returned object includes one reference count for the * pointer returned. * * Side effects: * On entry, the reference count of the variable value does not reflect * any references held on the stack. The first action of this function is * to determine whether the object is shared, and to duplicate it if it * is. The reference count of the duplicate is incremented. At this * point, the reference count will be 1 for either case, so that the * object will appear to be unshared. * * If an error occurs, and the object has been duplicated, the reference * count on the duplicate is decremented so that it is now 0: this * dismisses any memory that was allocated by this function. * * If no error occurs, the reference count of the original object is * incremented if the object has not been duplicated, and nothing is done * to a reference count of the duplicate. Now the reference count of an * unduplicated object is 2 (the returned pointer, plus the one stored in * the variable). The reference count of a duplicate object is 1, * reflecting that the returned pointer is the only active reference. The * caller is expected to store the returned value back in the variable * and decrement its reference count. (INST_STORE_* does exactly this.) * *---------------------------------------------------------------------- */ Tcl_Obj * TclLsetFlat( Tcl_Interp *interp, /* Tcl interpreter. */ Tcl_Obj *listObj, /* Pointer to the list being modified. */ ListSizeT indexCount, /* Number of index args. */ Tcl_Obj *const indexArray[], /* Index args. */ Tcl_Obj *valueObj) /* Value arg to 'lset' or NULL to 'lpop'. */ { ListSizeT index, len; int result; Tcl_Obj *subListObj, *retValueObj; Tcl_Obj *pendingInvalidates[10]; Tcl_Obj **pendingInvalidatesPtr = pendingInvalidates; ListSizeT numPendingInvalidates = 0; /* * If there are no indices, simply return the new value. (Without * indices, [lset] is a synonym for [set]. * [lpop] does not use this but protect for NULL valueObj just in case. */ if (indexCount == 0) { if (valueObj != NULL) { Tcl_IncrRefCount(valueObj); } return valueObj; } /* * If the list is shared, make a copy we can modify (copy-on-write). We * use Tcl_DuplicateObj() instead of TclListObjCopy() for a few reasons: * 1) we have not yet confirmed listObj is actually a list; 2) We make a * verbatim copy of any existing string rep, and when we combine that with * the delayed invalidation of string reps of modified Tcl_Obj's * implemented below, the outcome is that any error condition that causes * this routine to return NULL, will leave the string rep of listObj and * all elements to be unchanged. */ subListObj = Tcl_IsShared(listObj) ? Tcl_DuplicateObj(listObj) : listObj; /* * Anchor the linked list of Tcl_Obj's whose string reps must be * invalidated if the operation succeeds. */ retValueObj = subListObj; result = TCL_OK; /* Allocate if static array for pending invalidations is too small */ if (indexCount > (int) (sizeof(pendingInvalidates) / sizeof(pendingInvalidates[0]))) { pendingInvalidatesPtr = (Tcl_Obj **) ckalloc(indexCount * sizeof(*pendingInvalidatesPtr)); } /* * Loop through all the index arguments, and for each one dive into the * appropriate sublist. */ do { ListSizeT elemCount; Tcl_Obj *parentList, **elemPtrs; /* * Check for the possible error conditions... */ if (TclListObjGetElementsM(interp, subListObj, &elemCount, &elemPtrs) != TCL_OK) { /* ...the sublist we're indexing into isn't a list at all. */ result = TCL_ERROR; break; } /* * WARNING: the macro TclGetIntForIndexM is not safe for * post-increments, avoid '*indexArray++' here. */ if (TclGetIntForIndexM(interp, *indexArray, elemCount - 1, &index) != TCL_OK) { /* ...the index we're trying to use isn't an index at all. */ result = TCL_ERROR; indexArray++; /* Why bother with this increment? TBD */ break; } indexArray++; if (index < 0 || index > elemCount || (valueObj == NULL && index >= elemCount)) { /* ...the index points outside the sublist. */ if (interp != NULL) { Tcl_SetObjResult(interp, Tcl_ObjPrintf("index \"%s\" out of range", Tcl_GetString(indexArray[-1]))); Tcl_SetErrorCode(interp, "TCL", "VALUE", "INDEX" "OUTOFRANGE", NULL); } result = TCL_ERROR; break; } /* * No error conditions. As long as we're not yet on the last index, * determine the next sublist for the next pass through the loop, * and take steps to make sure it is an unshared copy, as we intend * to modify it. */ if (--indexCount) { parentList = subListObj; if (index == elemCount) { TclNewObj(subListObj); } else { subListObj = elemPtrs[index]; } if (Tcl_IsShared(subListObj)) { subListObj = Tcl_DuplicateObj(subListObj); } /* * Replace the original elemPtr[index] in parentList with a copy * we know to be unshared. This call will also deal with the * situation where parentList shares its internalrep with other * Tcl_Obj's. Dealing with the shared internalrep case can * cause subListObj to become shared again, so detect that case * and make and store another copy. */ if (index == elemCount) { Tcl_ListObjAppendElement(NULL, parentList, subListObj); } else { TclListObjSetElement(NULL, parentList, index, subListObj); } if (Tcl_IsShared(subListObj)) { subListObj = Tcl_DuplicateObj(subListObj); TclListObjSetElement(NULL, parentList, index, subListObj); } /* * The TclListObjSetElement() calls do not spoil the string rep * of parentList, and that's fine for now, since all we've done * so far is replace a list element with an unshared copy. The * list value remains the same, so the string rep. is still * valid, and unchanged, which is good because if this whole * routine returns NULL, we'd like to leave no change to the * value of the lset variable. Later on, when we set valueObj * in its proper place, then all containing lists will have * their values changed, and will need their string reps * spoiled. We maintain a list of all those Tcl_Obj's (via a * little internalrep surgery) so we can spoil them at that * time. */ pendingInvalidatesPtr[numPendingInvalidates] = parentList; ++numPendingInvalidates; } } while (indexCount > 0); /* * Either we've detected and error condition, and exited the loop with * result == TCL_ERROR, or we've successfully reached the last index, and * we're ready to store valueObj. On success, we need to invalidate * the string representations of intermediate lists whose contained * list element would have changed. */ if (result == TCL_OK) { while (numPendingInvalidates > 0) { Tcl_Obj *objPtr; --numPendingInvalidates; objPtr = pendingInvalidatesPtr[numPendingInvalidates]; if (result == TCL_OK) { /* * We're going to store valueObj, so spoil string reps of all * containing lists. * TODO - historically, the storing of the internal rep was done * because the ptr2 field of the internal rep was used to chain * objects whose string rep needed to be invalidated. Now this * is no longer the case, so replacing of the internal rep * should not be needed. The TclInvalidateStringRep should * suffice. Formulate a test case before changing. */ ListRep objInternalRep; TclListObjGetRep(NULL, objPtr, &objInternalRep); ListObjReplaceRepAndInvalidate(objPtr, &objInternalRep); } } } if (pendingInvalidatesPtr != pendingInvalidates) ckfree(pendingInvalidatesPtr); if (result != TCL_OK) { /* * Error return; message is already in interp. Clean up any excess * memory. */ if (retValueObj != listObj) { Tcl_DecrRefCount(retValueObj); } return NULL; } /* * Store valueObj in proper sublist and return. The -1 is to avoid a * compiler warning (not a problem because we checked that we have a * proper list - or something convertible to one - above). */ len = -1; TclListObjLengthM(NULL, subListObj, &len); if (valueObj == NULL) { /* T:listrep-1.{4.2,5.4,6.1,7.1,8.3},2.{4,5}.4 */ Tcl_ListObjReplace(NULL, subListObj, index, 1, 0, NULL); } else if (index == len) { /* T:listrep-1.2.1,2.{2.3,9.3},3.{4,5,6}.3 */ Tcl_ListObjAppendElement(NULL, subListObj, valueObj); } else { /* T:listrep-1.{12.1,15.1,19.1},2.{10,13,16}.1 */ TclListObjSetElement(NULL, subListObj, index, valueObj); TclInvalidateStringRep(subListObj); } Tcl_IncrRefCount(retValueObj); return retValueObj; } /* *---------------------------------------------------------------------- * * TclListObjSetElement -- * * Set a single element of a list to a specified value * * Results: * The return value is normally TCL_OK. If listObj does not refer to a * list object and cannot be converted to one, TCL_ERROR is returned and * an error message will be left in the interpreter result if interp is * not NULL. Similarly, if index designates an element outside the range * [0..listLength-1], where listLength is the count of elements in the * list object designated by listObj, TCL_ERROR is returned and an error * message is left in the interpreter result. * * Side effects: * Tcl_Panic if listObj designates a shared object. Otherwise, attempts * to convert it to a list with a non-shared internal rep. Decrements the * ref count of the object at the specified index within the list, * replaces with the object designated by valueObj, and increments the * ref count of the replacement object. * *---------------------------------------------------------------------- */ int TclListObjSetElement( Tcl_Interp *interp, /* Tcl interpreter; used for error reporting * if not NULL. */ Tcl_Obj *listObj, /* List object in which element should be * stored. */ ListSizeT index, /* Index of element to store. */ Tcl_Obj *valueObj) /* Tcl object to store in the designated list * element. */ { ListRep listRep; Tcl_Obj **elemPtrs; /* Pointers to elements of the list. */ ListSizeT elemCount; /* Number of elements in the list. */ /* Ensure that the listObj parameter designates an unshared list. */ if (Tcl_IsShared(listObj)) { Tcl_Panic("%s called with shared object", "TclListObjSetElement"); } if (TclListObjGetRep(interp, listObj, &listRep) != TCL_OK) { return TCL_ERROR; } elemCount = ListRepLength(&listRep); /* Ensure that the index is in bounds. */ if (index<0 || index>=elemCount) { if (interp != NULL) { Tcl_SetObjResult(interp, Tcl_ObjPrintf( "index \"%d\" out of range", index)); Tcl_SetErrorCode(interp, "TCL", "VALUE", "INDEX", "OUTOFRANGE", NULL); } return TCL_ERROR; } /* * Note - garbage collect this only AFTER checking indices above. * Do not want to modify listrep and then not store it back in listObj. */ ListRepFreeUnreferenced(&listRep); /* Replace a shared internal rep with an unshared copy */ if (listRep.storePtr->refCount > 1) { ListRep newInternalRep; /* T:listrep-2.{10,13,16}.1 */ /* TODO - leave extra space? */ ListRepClone(&listRep, &newInternalRep, LISTREP_PANIC_ON_FAIL); listRep = newInternalRep; } /* else T:listrep-1.{12.1,15.1,19.1} */ /* Retrieve element array AFTER potential cloning above */ ListRepElements(&listRep, elemCount, elemPtrs); /* * Add a reference to the new list element and remove from old before * replacing it. Order is important! */ Tcl_IncrRefCount(valueObj); Tcl_DecrRefCount(elemPtrs[index]); elemPtrs[index] = valueObj; /* Internal rep may be cloned so replace */ ListObjReplaceRepAndInvalidate(listObj, &listRep); return TCL_OK; } /* *---------------------------------------------------------------------- * * FreeListInternalRep -- * * Deallocate the storage associated with a list object's internal * representation. * * Results: * None. * * Side effects: * Frees listPtr's List* internal representation, if no longer shared. * May decrement the ref counts of element objects, which may free them. * *---------------------------------------------------------------------- */ static void FreeListInternalRep( Tcl_Obj *listObj) /* List object with internal rep to free. */ { ListRep listRep; ListObjGetRep(listObj, &listRep); if (listRep.storePtr->refCount-- <= 1) { ObjArrayDecrRefs( listRep.storePtr->slots, listRep.storePtr->firstUsed, listRep.storePtr->numUsed); ckfree(listRep.storePtr); } if (listRep.spanPtr) { ListSpanDecrRefs(listRep.spanPtr); } } /* *---------------------------------------------------------------------- * * DupListInternalRep -- * * Initialize the internal representation of a list Tcl_Obj to share the * internal representation of an existing list object. * * Results: * None. * * Side effects: * The reference count of the List internal rep is incremented. * *---------------------------------------------------------------------- */ static void DupListInternalRep( Tcl_Obj *srcObj, /* Object with internal rep to copy. */ Tcl_Obj *copyObj) /* Object with internal rep to set. */ { ListRep listRep; ListObjGetRep(srcObj, &listRep); ListObjOverwriteRep(copyObj, &listRep); } /* *---------------------------------------------------------------------- * * SetListFromAny -- * * Attempt to generate a list internal form for the Tcl object "objPtr". * * Results: * The return value is TCL_OK or TCL_ERROR. If an error occurs during * conversion, an error message is left in the interpreter's result * unless "interp" is NULL. * * Side effects: * If no error occurs, a list is stored as "objPtr"s internal * representation. * *---------------------------------------------------------------------- */ static int SetListFromAny( Tcl_Interp *interp, /* Used for error reporting if not NULL. */ Tcl_Obj *objPtr) /* The object to convert. */ { Tcl_Obj **elemPtrs; ListRep listRep; /* * Dictionaries are a special case; they have a string representation such * that *all* valid dictionaries are valid lists. Hence we can convert * more directly. Only do this when there's no existing string rep; if * there is, it is the string rep that's authoritative (because it could * describe duplicate keys). */ if (!TclHasStringRep(objPtr) && TclHasInternalRep(objPtr, &tclDictType)) { Tcl_Obj *keyPtr, *valuePtr; Tcl_DictSearch search; int done; ListSizeT size; /* * Create the new list representation. Note that we do not need to do * anything with the string representation as the transformation (and * the reverse back to a dictionary) are both order-preserving. Also * note that since we know we've got a valid dictionary (by * representation) we also know that fetching the size of the * dictionary or iterating over it will not fail. */ Tcl_DictObjSize(NULL, objPtr, &size); /* TODO - leave space in front and/or back? */ if (ListRepInitAttempt( interp, size > 0 ? 2 * size : 1, NULL, &listRep) != TCL_OK) { return TCL_ERROR; } LIST_ASSERT(listRep.spanPtr == NULL); /* Guard against future changes */ LIST_ASSERT(listRep.storePtr->firstUsed == 0); LIST_ASSERT((listRep.storePtr->flags & LISTSTORE_CANONICAL) == 0); listRep.storePtr->numUsed = 2 * size; /* Populate the list representation. */ elemPtrs = listRep.storePtr->slots; Tcl_DictObjFirst(NULL, objPtr, &search, &keyPtr, &valuePtr, &done); while (!done) { *elemPtrs++ = keyPtr; *elemPtrs++ = valuePtr; Tcl_IncrRefCount(keyPtr); Tcl_IncrRefCount(valuePtr); Tcl_DictObjNext(&search, &keyPtr, &valuePtr, &done); } } else { ListSizeT estCount, length; const char *limit, *nextElem = TclGetStringFromObj(objPtr, &length); /* * Allocate enough space to hold a (Tcl_Obj *) for each * (possible) list element. */ estCount = TclMaxListLength(nextElem, length, &limit); estCount += (estCount == 0); /* Smallest list struct holds 1 * element. */ /* TODO - allocate additional space? */ if (ListRepInitAttempt(interp, estCount, NULL, &listRep) != TCL_OK) { return TCL_ERROR; } LIST_ASSERT(listRep.spanPtr == NULL); /* Guard against future changes */ LIST_ASSERT(listRep.storePtr->firstUsed == 0); elemPtrs = listRep.storePtr->slots; /* Each iteration, parse and store a list element. */ while (nextElem < limit) { const char *elemStart; char *check; ListSizeT elemSize; int literal; if (TCL_OK != TclFindElement(interp, nextElem, limit - nextElem, &elemStart, &nextElem, &elemSize, &literal)) { fail: while (--elemPtrs >= listRep.storePtr->slots) { Tcl_DecrRefCount(*elemPtrs); } ckfree(listRep.storePtr); return TCL_ERROR; } if (elemStart == limit) { break; } TclNewObj(*elemPtrs); TclInvalidateStringRep(*elemPtrs); check = Tcl_InitStringRep(*elemPtrs, literal ? elemStart : NULL, elemSize); if (elemSize && check == NULL) { MemoryAllocationError(interp, elemSize); goto fail; } if (!literal) { Tcl_InitStringRep(*elemPtrs, NULL, TclCopyAndCollapse(elemSize, elemStart, check)); } Tcl_IncrRefCount(*elemPtrs++);/* Since list now holds ref to it. */ } listRep.storePtr->numUsed = elemPtrs - listRep.storePtr->slots; } LISTREP_CHECK(&listRep); /* * Store the new internalRep. We do this as late * as possible to allow the conversion code, in particular * Tcl_GetStringFromObj, to use the old internalRep. */ /* * Note old string representation NOT to be invalidated. * So do NOT use ListObjReplaceRepAndInvalidate. InternalRep to be freed AFTER * IncrRefs so do not use ListObjOverwriteRep */ ListRepIncrRefs(&listRep); TclFreeInternalRep(objPtr); objPtr->internalRep.twoPtrValue.ptr1 = listRep.storePtr; objPtr->internalRep.twoPtrValue.ptr2 = listRep.spanPtr; objPtr->typePtr = &tclListType; return TCL_OK; } /* *---------------------------------------------------------------------- * * UpdateStringOfList -- * * Update the string representation for a list object. Note: This * function does not invalidate an existing old string rep so storage * will be lost if this has not already been done. * * Results: * None. * * Side effects: * The object's string is set to a valid string that results from the * list-to-string conversion. This string will be empty if the list has * no elements. The list internal representation should not be NULL and * we assume it is not NULL. * *---------------------------------------------------------------------- */ static void UpdateStringOfList( Tcl_Obj *listObj) /* List object with string rep to update. */ { # define LOCAL_SIZE 64 char localFlags[LOCAL_SIZE], *flagPtr = NULL; ListSizeT numElems, i, length, bytesNeeded = 0; const char *elem, *start; char *dst; Tcl_Obj **elemPtrs; ListRep listRep; ListObjGetRep(listObj, &listRep); LISTREP_CHECK(&listRep); ListRepElements(&listRep, numElems, elemPtrs); /* * Mark the list as being canonical; although it will now have a string * rep, it is one we derived through proper "canonical" quoting and so * it's known to be free from nasties relating to [concat] and [eval]. * However, we only do this if this is not a spanned list. Marking the * storage canonical for a spanned list make ALL lists using the storage * canonical which is not right. (Consider a list generated from a * string and then this function called for a spanned list generated * from it). On the other hand, a spanned list is always canonical * (never generated from a string) so it does not have to be explicitly * marked as such. The ListObjIsCanonical macro takes this into account. * See the comments there. */ if (listRep.spanPtr == NULL) { LIST_ASSERT(listRep.storePtr->firstUsed == 0);/* Invariant */ listRep.storePtr->flags |= LISTSTORE_CANONICAL; } /* Handle empty list case first, so rest of the routine is simpler. */ if (numElems == 0) { Tcl_InitStringRep(listObj, NULL, 0); return; } /* Pass 1: estimate space, gather flags. */ if (numElems <= LOCAL_SIZE) { flagPtr = localFlags; } else { /* We know numElems <= LIST_MAX, so this is safe. */ flagPtr = (char *)ckalloc(numElems); } for (i = 0; i < numElems; i++) { flagPtr[i] = (i ? TCL_DONT_QUOTE_HASH : 0); elem = TclGetStringFromObj(elemPtrs[i], &length); bytesNeeded += TclScanElement(elem, length, flagPtr+i); if (bytesNeeded < 0) { /* TODO - what is the max #define for Tcl9? */ Tcl_Panic("max size for a Tcl value (%d bytes) exceeded", INT_MAX); } } /* TODO - what is the max #define for Tcl9? */ if (bytesNeeded > INT_MAX - numElems + 1) { Tcl_Panic("max size for a Tcl value (%d bytes) exceeded", INT_MAX); } bytesNeeded += numElems - 1; /* * Pass 2: copy into string rep buffer. */ start = dst = Tcl_InitStringRep(listObj, NULL, bytesNeeded); TclOOM(dst, bytesNeeded); for (i = 0; i < numElems; i++) { flagPtr[i] |= (i ? TCL_DONT_QUOTE_HASH : 0); elem = TclGetStringFromObj(elemPtrs[i], &length); dst += TclConvertElement(elem, length, dst, flagPtr[i]); *dst++ = ' '; } /* Set the string length to what was actually written, the safe choice */ (void) Tcl_InitStringRep(listObj, NULL, dst - 1 - start); if (flagPtr != localFlags) { ckfree(flagPtr); } } /* *------------------------------------------------------------------------ * * TclListTestObj -- * * Returns a list object with a specific internal rep and content. * Used specifically for testing so span can be controlled explicitly. * * Results: * Pointer to the Tcl_Obj containing the list. * * Side effects: * None. * *------------------------------------------------------------------------ */ Tcl_Obj * TclListTestObj (int length, int leadingSpace, int endSpace) { if (length < 0) length = 0; if (leadingSpace < 0) leadingSpace = 0; if (endSpace < 0) endSpace = 0; ListRep listRep; ListSizeT capacity; Tcl_Obj *listObj; TclNewObj(listObj); /* Only a test object so ignoring overflow checks */ capacity = length + leadingSpace + endSpace; if (capacity == 0) { return listObj; } ListRepInit(capacity, NULL, 0, &listRep); ListStore *storePtr = listRep.storePtr; int i; for (i = 0; i < length; ++i) { storePtr->slots[i + leadingSpace] = Tcl_NewIntObj(i); Tcl_IncrRefCount(storePtr->slots[i + leadingSpace]); } storePtr->firstUsed = leadingSpace; storePtr->numUsed = length; if (leadingSpace != 0) { listRep.spanPtr = ListSpanNew(leadingSpace, length); } ListObjReplaceRepAndInvalidate(listObj, &listRep); return listObj; } /* * Local Variables: * mode: c * c-basic-offset: 4 * fill-column: 78 * End: */ |
Changes to generic/tclStubInit.c.
︙ | ︙ | |||
1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 | TclPtrSetVar, /* 253 */ TclPtrIncrObjVar, /* 254 */ TclPtrObjMakeUpvar, /* 255 */ TclPtrUnsetVar, /* 256 */ TclStaticLibrary, /* 257 */ TclpCreateTemporaryDirectory, /* 258 */ TclUnusedStubEntry, /* 259 */ }; static const TclIntPlatStubs tclIntPlatStubs = { TCL_STUB_MAGIC, 0, #if !defined(_WIN32) && !defined(__CYGWIN__) && !defined(MAC_OSX_TCL) /* UNIX */ TclGetAndDetachPids, /* 0 */ | > > | 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 | TclPtrSetVar, /* 253 */ TclPtrIncrObjVar, /* 254 */ TclPtrObjMakeUpvar, /* 255 */ TclPtrUnsetVar, /* 256 */ TclStaticLibrary, /* 257 */ TclpCreateTemporaryDirectory, /* 258 */ TclUnusedStubEntry, /* 259 */ TclListTestObj, /* 260 */ TclListObjValidate, /* 261 */ }; static const TclIntPlatStubs tclIntPlatStubs = { TCL_STUB_MAGIC, 0, #if !defined(_WIN32) && !defined(__CYGWIN__) && !defined(MAC_OSX_TCL) /* UNIX */ TclGetAndDetachPids, /* 0 */ |
︙ | ︙ |
Changes to generic/tclTest.c.
︙ | ︙ | |||
269 270 271 272 273 274 275 276 277 278 279 280 281 282 | static Tcl_CmdProc TestgetintCmd; static Tcl_CmdProc TestlongsizeCmd; static Tcl_CmdProc TestgetplatformCmd; static Tcl_ObjCmdProc TestgetvarfullnameCmd; static Tcl_CmdProc TestinterpdeleteCmd; static Tcl_CmdProc TestlinkCmd; static Tcl_ObjCmdProc TestlinkarrayCmd; static Tcl_ObjCmdProc TestlocaleCmd; static Tcl_CmdProc TestmainthreadCmd; static Tcl_CmdProc TestsetmainloopCmd; static Tcl_CmdProc TestexitmainloopCmd; static Tcl_CmdProc TestpanicCmd; static Tcl_ObjCmdProc TestparseargsCmd; static Tcl_ObjCmdProc TestparserObjCmd; | > | 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 | static Tcl_CmdProc TestgetintCmd; static Tcl_CmdProc TestlongsizeCmd; static Tcl_CmdProc TestgetplatformCmd; static Tcl_ObjCmdProc TestgetvarfullnameCmd; static Tcl_CmdProc TestinterpdeleteCmd; static Tcl_CmdProc TestlinkCmd; static Tcl_ObjCmdProc TestlinkarrayCmd; static Tcl_ObjCmdProc TestlistrepCmd; static Tcl_ObjCmdProc TestlocaleCmd; static Tcl_CmdProc TestmainthreadCmd; static Tcl_CmdProc TestsetmainloopCmd; static Tcl_CmdProc TestexitmainloopCmd; static Tcl_CmdProc TestpanicCmd; static Tcl_ObjCmdProc TestparseargsCmd; static Tcl_ObjCmdProc TestparserObjCmd; |
︙ | ︙ | |||
652 653 654 655 656 657 658 659 660 661 662 663 664 665 | NULL, NULL); Tcl_CreateObjCommand(interp, "testgetvarfullname", TestgetvarfullnameCmd, NULL, NULL); Tcl_CreateCommand(interp, "testinterpdelete", TestinterpdeleteCmd, NULL, NULL); Tcl_CreateCommand(interp, "testlink", TestlinkCmd, NULL, NULL); Tcl_CreateObjCommand(interp, "testlinkarray", TestlinkarrayCmd, NULL, NULL); Tcl_CreateObjCommand(interp, "testlocale", TestlocaleCmd, NULL, NULL); Tcl_CreateCommand(interp, "testpanic", TestpanicCmd, NULL, NULL); Tcl_CreateObjCommand(interp, "testparseargs", TestparseargsCmd,NULL,NULL); Tcl_CreateObjCommand(interp, "testparser", TestparserObjCmd, NULL, NULL); Tcl_CreateObjCommand(interp, "testparsevar", TestparsevarObjCmd, | > | 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 | NULL, NULL); Tcl_CreateObjCommand(interp, "testgetvarfullname", TestgetvarfullnameCmd, NULL, NULL); Tcl_CreateCommand(interp, "testinterpdelete", TestinterpdeleteCmd, NULL, NULL); Tcl_CreateCommand(interp, "testlink", TestlinkCmd, NULL, NULL); Tcl_CreateObjCommand(interp, "testlinkarray", TestlinkarrayCmd, NULL, NULL); Tcl_CreateObjCommand(interp, "testlistrep", TestlistrepCmd, NULL, NULL); Tcl_CreateObjCommand(interp, "testlocale", TestlocaleCmd, NULL, NULL); Tcl_CreateCommand(interp, "testpanic", TestpanicCmd, NULL, NULL); Tcl_CreateObjCommand(interp, "testparseargs", TestparseargsCmd,NULL,NULL); Tcl_CreateObjCommand(interp, "testparser", TestparserObjCmd, NULL, NULL); Tcl_CreateObjCommand(interp, "testparsevar", TestparsevarObjCmd, |
︙ | ︙ | |||
3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 | } return TCL_OK; wrongArgs: Tcl_WrongNumArgs(interp, 2, objv, "?-readonly? type size name ?address?"); return TCL_ERROR; } /* *---------------------------------------------------------------------- * * TestlocaleCmd -- * * This procedure implements the "testlocale" command. It is used | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 | } return TCL_OK; wrongArgs: Tcl_WrongNumArgs(interp, 2, objv, "?-readonly? type size name ?address?"); return TCL_ERROR; } /* *---------------------------------------------------------------------- * * TestlistrepCmd -- * * This function is invoked to generate a list object with a specific * internal representation. * * Results: * A standard Tcl result. * * Side effects: * None. * *---------------------------------------------------------------------- */ static int TestlistrepCmd( TCL_UNUSED(void *), Tcl_Interp *interp, /* Current interpreter. */ int objc, /* Number of arguments. */ Tcl_Obj *const objv[]) /* Argument objects. */ { /* Subcommands supported by this command */ const char* subcommands[] = { "new", "describe", "config", "validate", NULL }; enum { LISTREP_NEW, LISTREP_DESCRIBE, LISTREP_CONFIG, LISTREP_VALIDATE } cmdIndex; Tcl_Obj *resultObj = NULL; if (objc < 2) { Tcl_WrongNumArgs(interp, 1, objv, "command ?arg ...?"); return TCL_ERROR; } if (Tcl_GetIndexFromObj( interp, objv[1], subcommands, "command", 0, &cmdIndex) != TCL_OK) { return TCL_ERROR; } switch (cmdIndex) { case LISTREP_NEW: if (objc < 3 || objc > 5) { Tcl_WrongNumArgs(interp, 2, objv, "length ?leadSpace endSpace?"); return TCL_ERROR; } else { int length; int leadSpace = 0; int endSpace = 0; if (Tcl_GetIntFromObj(interp, objv[2], &length) != TCL_OK) { return TCL_ERROR; } if (objc > 3) { if (Tcl_GetIntFromObj(interp, objv[3], &leadSpace) != TCL_OK) { return TCL_ERROR; } if (objc > 4) { if (Tcl_GetIntFromObj(interp, objv[4], &endSpace) != TCL_OK) { return TCL_ERROR; } } } resultObj = TclListTestObj(length, leadSpace, endSpace); } break; case LISTREP_DESCRIBE: #define APPEND_FIELD(targetObj_, structPtr_, fld_) \ do { \ Tcl_ListObjAppendElement( \ interp, (targetObj_), Tcl_NewStringObj(#fld_, -1)); \ Tcl_ListObjAppendElement( \ interp, (targetObj_), Tcl_NewWideIntObj((structPtr_)->fld_)); \ } while (0) if (objc != 3) { Tcl_WrongNumArgs(interp, 2, objv, "object"); return TCL_ERROR; } else { Tcl_Obj **objs; ListSizeT nobjs; ListRep listRep; Tcl_Obj *listRepObjs[4]; /* Force list representation */ if (Tcl_ListObjGetElements(interp, objv[2], &nobjs, &objs) != TCL_OK) { return TCL_ERROR; } ListObjGetRep(objv[2], &listRep); listRepObjs[0] = Tcl_NewStringObj("store", -1); listRepObjs[1] = Tcl_NewListObj(12, NULL); Tcl_ListObjAppendElement( interp, listRepObjs[1], Tcl_NewStringObj("memoryAddress", -1)); Tcl_ListObjAppendElement( interp, listRepObjs[1], Tcl_ObjPrintf("%p", listRep.storePtr)); APPEND_FIELD(listRepObjs[1], listRep.storePtr, firstUsed); APPEND_FIELD(listRepObjs[1], listRep.storePtr, numUsed); APPEND_FIELD(listRepObjs[1], listRep.storePtr, numAllocated); APPEND_FIELD(listRepObjs[1], listRep.storePtr, refCount); APPEND_FIELD(listRepObjs[1], listRep.storePtr, flags); if (listRep.spanPtr) { listRepObjs[2] = Tcl_NewStringObj("span", -1); listRepObjs[3] = Tcl_NewListObj(8, NULL); Tcl_ListObjAppendElement(interp, listRepObjs[3], Tcl_NewStringObj("memoryAddress", -1)); Tcl_ListObjAppendElement( interp, listRepObjs[3], Tcl_ObjPrintf("%p", listRep.spanPtr)); APPEND_FIELD(listRepObjs[3], listRep.spanPtr, spanStart); APPEND_FIELD( listRepObjs[3], listRep.spanPtr, spanLength); APPEND_FIELD(listRepObjs[3], listRep.spanPtr, refCount); } resultObj = Tcl_NewListObj(listRep.spanPtr ? 4 : 2, listRepObjs); } #undef APPEND_FIELD break; case LISTREP_CONFIG: if (objc != 2) { Tcl_WrongNumArgs(interp, 2, objv, "object"); return TCL_ERROR; } resultObj = Tcl_NewListObj(2, NULL); Tcl_ListObjAppendElement( NULL, resultObj, Tcl_NewStringObj("LIST_SPAN_THRESHOLD", -1)); Tcl_ListObjAppendElement( NULL, resultObj, Tcl_NewWideIntObj(LIST_SPAN_THRESHOLD)); break; case LISTREP_VALIDATE: if (objc != 3) { Tcl_WrongNumArgs(interp, 2, objv, "object"); return TCL_ERROR; } TclListObjValidate(interp, objv[2]); /* Panics if invalid */ resultObj = Tcl_NewObj(); break; } Tcl_SetObjResult(interp, resultObj); return TCL_OK; } /* *---------------------------------------------------------------------- * * TestlocaleCmd -- * * This procedure implements the "testlocale" command. It is used |
︙ | ︙ |
Added tests-perf/comparePerf.tcl.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 | #!/usr/bin/tclsh # ------------------------------------------------------------------------ # # comparePerf.tcl -- # # Script to compare performance data from multiple runs. # # ------------------------------------------------------------------------ # # See the file "license.terms" for information on usage and redistribution # of this file. # # Usage: # tclsh comparePerf.tcl [--regexp RE] [--ratio time|rate] [--combine] [--base BASELABEL] PERFFILE ... # # The test data from each input file is tabulated so as to compare the results # of test runs. If a PERFFILE does not exist, it is retried by adding the # .perf extension. If the --regexp is specified, only test results whose # id matches RE are examined. # # If the --combine option is specified, results of test sets with the same # label are combined and averaged in the output. # # If the --base option is specified, the BASELABEL is used as the label to use # the base timing. Otherwise, the label of the first data file is used. # # If --ratio option is "time" the ratio of test timing vs base test timing # is shown. If "rate" (default) the inverse is shown. # # If --no-header is specified, the header describing test configuration is # not output. # # The format of input files is as follows: # # Each line must begin with one of the characters below followed by a space # followed by a string whose semantics depend on the initial character. # E - Full path to the Tcl executable that was used to generate the file # V - The Tcl patchlevel of the implementation # D - A description for the test run for human consumption # L - A label used to identify run environment. The --combine option will # average all measuremets that have the same label. An input file without # a label is treated as having a unique label and not combined with any other. # P - A test measurement (see below) # R - The number of runs made for the each test # # - A comment, may be an arbitrary string. Usually included in performance # data to describe the test. This is silently ignored # # Any lines not matching one of the above are ignored with a warning to stderr. # # A line beginning with the "P" marker is a test measurement. The first word # following is a floating point number representing the test runtime. # The remaining line (after trimming of whitespace) is the id of the test. # Test generators are encouraged to make the id a well-defined machine-parseable # as well human readable description of the test. The id must not appear more # than once. An example test measurement line: # P 2.32280 linsert in unshared L[10000] 1 elems 10000 times at 0 (var) # Note here the iteration count is not present. # namespace eval perf::compare { # List of dictionaries, one per input file variable PerfData } proc perf::compare::warn {message} { puts stderr "Warning: $message" } proc perf::compare::print {text} { puts stdout $text } proc perf::compare::slurp {testrun_path} { variable PerfData set runtimes [dict create] set path [file normalize $testrun_path] set fd [open $path] array set header {} while {[gets $fd line] >= 0} { set line [regsub -all {\s+} [string trim $line] " "] switch -glob -- $line { "#*" { # Skip comments } "R *" - "L *" - "D *" - "V *" - "T *" - "E *" { set marker [lindex $line 0] if {[info exists header($marker)]} { warn "Ignoring $marker record (duplicate): \"$line\"" } set header($marker) [string range $line 2 end] } "P *" { if {[scan $line "P %f %n" runtime id_start] == 2} { set id [string range $line $id_start end] if {[dict exists $runtimes $id]} { warn "Ignoring duplicate test id \"$id\"" } else { dict set runtimes $id $runtime } } else { warn "Invalid test result line format: \"$line\"" } } default { puts stderr "Warning: ignoring unrecognized line \"$line\"" } } } close $fd set result [dict create Input $path Runtimes $runtimes] foreach {c k} { L Label V Version E Executable D Description } { if {[info exists header($c)]} { dict set result $k $header($c) } } return $result } proc perf::compare::burp {test_sets} { variable Options # Print the key for each test run set header " " set separator " " foreach test_set $test_sets { set test_set_key "\[[incr test_set_num]\]" if {! $Options(--no-header)} { print "$test_set_key" foreach k {Label Executable Version Input Description} { if {[dict exists $test_set $k]} { print "$k: [dict get $test_set $k]" } } } append header $test_set_key $separator set separator " "; # Expand because later columns have ratio } set header [string trimright $header] if {! $Options(--no-header)} { print "" if {$Options(--ratio) eq "rate"} { set ratio_description "ratio of baseline to the measurement (higher is faster)." } else { set ratio_description "ratio of measurement to the baseline (lower is faster)." } print "The first column \[1\] is the baseline measurement." print "Subsequent columns are pairs of the additional measurement and " print $ratio_description print "" } # Print the actual test run data print $header set test_sets [lassign $test_sets base_set] set fmt {%#10.5f} set fmt_ratio {%-6.2f} foreach {id base_runtime} [dict get $base_set Runtimes] { if {[info exists Options(--regexp)]} { if {![regexp $Options(--regexp) $id]} { continue } } if {$Options(--print-test-number)} { set line "[format %-4s [incr counter].]" } else { set line "" } append line [format $fmt $base_runtime] foreach test_set $test_sets { if {[dict exists $test_set Runtimes $id]} { set runtime [dict get $test_set Runtimes $id] if {$Options(--ratio) eq "time"} { if {$base_runtime != 0} { set ratio [format $fmt_ratio [expr {$runtime/$base_runtime}]] } else { if {$runtime == 0} { set ratio "NaN " } else { set ratio "Inf " } } } else { if {$runtime != 0} { set ratio [format $fmt_ratio [expr {$base_runtime/$runtime}]] } else { if {$base_runtime == 0} { set ratio "NaN " } else { set ratio "Inf " } } } append line "|" [format $fmt $runtime] "|" $ratio } else { append line [string repeat { } 11] } } append line "|" $id print $line } } proc perf::compare::chew {test_sets} { variable Options # Combine test sets that have the same label, averaging the values set unlabeled_sets {} array set labeled_sets {} foreach test_set $test_sets { # If there is no label, treat as independent set if {![dict exists $test_set Label]} { lappend unlabeled_sets $test_set } else { lappend labeled_sets([dict get $test_set Label]) $test_set } } foreach label [array names labeled_sets] { set combined_set [lindex $labeled_sets($label) 0] set runtimes [dict get $combined_set Runtimes] foreach test_set [lrange $labeled_sets($label) 1 end] { dict for {id timing} [dict get $test_set Runtimes] { dict lappend runtimes $id $timing } } dict for {id timings} $runtimes { set total [tcl::mathop::+ {*}$timings] dict set runtimes $id [expr {$total/[llength $timings]}] } dict set combined_set Runtimes $runtimes set labeled_sets($label) $combined_set } # Choose the "base" test set if {![info exists Options(--base)]} { set first_set [lindex $test_sets 0] if {[dict exists $first_set Label]} { # Use label of first as the base set Options(--base) [dict get $first_set Label] } } if {[info exists Options(--base)] && $Options(--base) ne ""} { lappend combined_sets $labeled_sets($Options(--base));# Will error if no such unset labeled_sets($Options(--base)) } else { lappend combined_sets [lindex $unlabeled_sets 0] set unlabeled_sets [lrange $unlabeled_sets 1 end] } foreach label [array names labeled_sets] { lappend combined_sets $labeled_sets($label) } lappend combined_sets {*}$unlabeled_sets return $combined_sets } proc perf::compare::setup {argv} { variable Options array set Options { --ratio rate --combine 0 --print-test-number 0 --no-header 0 } while {[llength $argv]} { set argv [lassign $argv arg] switch -glob -- $arg { -r - --regexp { if {[llength $argv] == 0} { error "Missing value for option $arg" } set argv [lassign $argv val] set Options(--regexp) $val } --ratio { if {[llength $argv] == 0} { error "Missing value for option $arg" } set argv [lassign $argv val] if {$val ni {time rate}} { error "Value for option $arg must be either \"time\" or \"rate\"" } set Options(--ratio) $val } --print-test-number - --combine - --no-header { set Options($arg) 1 } --base { if {[llength $argv] == 0} { error "Missing value for option $arg" } set argv [lassign $argv val] set Options($arg) $val } -- { # Remaining will be passed back to the caller break } --* { error "Unknown option $arg" } -* { error "Unknown option -[lindex $arg 0]" } default { # Remaining will be passed back to the caller set argv [linsert $argv 0 $arg] break; } } } set paths {} foreach path $argv { set path [file join $path]; # Convert from native else glob fails if {[file isfile $path]} { lappend paths $path continue } if {[file isfile $path.perf]} { lappend paths $path.perf continue } lappend paths {*}[glob -nocomplain $path] } return $paths } proc perf::compare::main {} { variable Options set paths [setup $::argv] if {[llength $paths] == 0} { error "No test data files specified." } set test_data [list ] set seen [dict create] foreach path $paths { if {![dict exists $seen $path]} { lappend test_data [slurp $path] dict set seen $path "" } } if {$Options(--combine)} { set test_data [chew $test_data] } burp $test_data } perf::compare::main |
Added tests-perf/listPerf.tcl.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 | #!/usr/bin/tclsh # ------------------------------------------------------------------------ # # listPerf.tcl -- # # This file provides performance tests for list operations. # # ------------------------------------------------------------------------ # # See the file "license.terms" for information on usage and redistribution # of this file. # # Note: this file does not use the test-performance.tcl framework as we want # more direct control over timerate options. catch {package require twapi} namespace eval perf::list { variable perfScript [file normalize [info script]] # Test for each of these lengths variable Lengths {10 100 1000 10000} variable RunTimes set RunTimes(command) 0.0 set RunTimes(total) 0.0 variable Options array set Options { --print-comments 0 --print-iterations 0 } # Procs used for calibrating overhead proc proc2args {a b} {} proc proc3args {a b c} {} proc print {s} { puts $s } proc print_usage {} { puts stderr "Usage: [file tail [info nameofexecutable]] $::argv0 \[options\] \[command ...\]" puts stderr "\t--description DESC\tHuman readable description of test run" puts stderr "\t--label LABEL\tA label used to identify test environment" puts stderr "\t--print-comments\tPrint comment for each test" puts stderr "\t--print-iterations\tPrint number of iterations run for each test" } proc setup {argv} { variable Options variable Lengths while {[llength $argv]} { set argv [lassign $argv arg] switch -glob -- $arg { --print-comments - --print-iterations { set Options($arg) 1 } --label - --description { if {[llength $argv] == 0} { error "Missing value for option $arg" } set argv [lassign $argv val] set Options($arg) $val } --lengths { if {[llength $argv] == 0} { error "Missing value for option $arg" } set argv [lassign $argv val] set Lengths $val } -- { # Remaining will be passed back to the caller break } --* { error "Unknown option $arg" } default { # Remaining will be passed back to the caller set argv [linsert $argv 0 $arg] break; } } } return $argv } proc format_timings {us iters} { variable Options if {!$Options(--print-iterations)} { return "[format {%#10.4f} $us]" } return "[format {%#10.4f} $us] [format {%8d} $iters]" } proc measure {id script args} { variable NullOverhead variable RunTimes variable Options set opts(-overhead) "" set opts(-runs) 5 while {[llength $args]} { set args [lassign $args opt] if {[llength $args] == 0} { error "No argument supplied for $opt option. Test: $id" } set args [lassign $args val] switch $opt { -setup - -cleanup - -overhead - -time - -runs - -reps { set opts($opt) $val } default { error "Unknown option $opt. Test: $id" } } } set timerate_args {} if {[info exists opts(-time)]} { lappend timerate_args $opts(-time) } if {[info exists opts(-reps)]} { if {[info exists opts(-time)]} { set timerate_args [list $opts(-time) $opts(-reps)] } else { # Force the default for first time option set timerate_args [list 1000 $opts(-reps)] } } elseif {[info exists opts(-time)]} { set timerate_args [list $opts(-time)] } if {[info exists opts(-setup)]} { uplevel 1 $opts(-setup) } # Cache the empty overhead to prevent unnecessary delays. Note if you modify # to cache other scripts, the cache key must be AFTER substituting the # overhead script in the caller's context. if {$opts(-overhead) eq ""} { if {![info exists NullOverhead]} { set NullOverhead [lindex [timerate {}] 0] } set overhead_us $NullOverhead } else { # The overhead measurements might use setup so we need to setup # first and then cleanup in preparation for setting up again for # the script to be measured if {[info exists opts(-setup)]} { uplevel 1 $opts(-setup) } set overhead_us [lindex [uplevel 1 [list timerate $opts(-overhead)]] 0] if {[info exists opts(-cleanup)]} { uplevel 1 $opts(-cleanup) } } set timings {} for {set i 0} {$i < $opts(-runs)} {incr i} { if {[info exists opts(-setup)]} { uplevel 1 $opts(-setup) } lappend timings [uplevel 1 [list timerate -overhead $overhead_us $script {*}$timerate_args]] if {[info exists opts(-cleanup)]} { uplevel 1 $opts(-cleanup) } } set timings [lsort -real -index 0 $timings] if {$opts(-runs) > 15} { set ignore [expr {$opts(-runs)/8}] } elseif {$opts(-runs) >= 5} { set ignore 2 } else { set ignore 0 } # Ignore highest and lowest set timings [lrange $timings 0 end-$ignore] # Average it out set us 0 set iters 0 foreach timing $timings { set us [expr {$us + [lindex $timing 0]}] set iters [expr {$iters + [lindex $timing 2]}] } set us [expr {$us/[llength $timings]}] set iters [expr {$iters/[llength $timings]}] set RunTimes(command) [expr {$RunTimes(command) + $us}] print "P [format_timings $us $iters] $id" } proc comment {args} { variable Options if {$Options(--print-comments)} { print "# [join $args { }]" } } proc spanned_list {len} { # Note - for small len, this will not create a spanned list set delta [expr {$len/8}] return [lrange [lrepeat [expr {$len+(2*$delta)}] a] $delta [expr {$delta+$len-1}]] } proc print_separator {command} { comment [string repeat = 80] comment Command: $command } oo::class create ListPerf { constructor {args} { my variable Opts # Note default Opts can be overridden in construct as well as in measure set Opts [dict merge { -setup { set L [lrepeat $len a] set Lspan [perf::list::spanned_list $len] } -cleanup { unset -nocomplain L unset -nocomplain Lspan unset -nocomplain L2 } } $args] } method measure {comment script locals args} { my variable Opts dict with locals {} ::perf::list::measure $comment $script {*}[dict merge $Opts $args] } method option {opt val} { my variable Opts dict set Opts $opt $val } method option_unset {opt} { my variable Opts unset -nocomplain Opts($opt) } } proc linsert_describe {share_mode len at num iters} { return "linsert L\[$len\] $share_mode $num elems $iters times at $at" } proc linsert_perf {} { variable Lengths print_separator linsert ListPerf create perf -overhead {set L {}} -time 1000 # Note: Const indices take different path through bytecode than variable # indices hence separate cases below # Var case foreach share_mode {shared unshared} { set idx 0 if {$share_mode eq "shared"} { comment == Insert into empty lists comment Insert one element into empty list measure [linsert_describe shared 0 "0 (var)" 1 1] {linsert $L $idx ""} -setup {set idx 0; set L {}} } else { comment == Insert into empty lists comment Insert one element into empty list measure [linsert_describe unshared 0 "0 (var)" 1 1] {linsert {} $idx ""} -setup {set idx 0} } foreach idx_str [list 0 1 mid end-1 end] { foreach len $Lengths { if {$idx_str eq "mid"} { set idx [expr {$len/2}] } else { set idx $idx_str } # perf option -reps $reps set reps 1000 if {$share_mode eq "shared"} { comment Insert once to shared list with variable index perf measure [linsert_describe shared $len "$idx (var)" 1 1] \ {linsert $L $idx x} [list len $len idx $idx] -overhead {} -reps 100000 comment Insert multiple times to shared list with variable index perf measure [linsert_describe shared $len "$idx (var)" 1 $reps] { set L [linsert $L $idx X] } [list len $len idx $idx] -reps $reps comment Insert multiple items multiple times to shared list with variable index perf measure [linsert_describe shared $len "$idx (var)" 5 $reps] { set L [linsert $L $idx X X X X X] } [list len $len idx $idx] -reps $reps } else { # NOTE : the Insert once case is left out for unshared lists # because it requires re-init on every iteration resulting # in a lot of measurement noise comment Insert multiple times to unshared list with variable index perf measure [linsert_describe unshared $len "$idx (var)" 1 $reps] { set L [linsert $L[set L {}] $idx X] } [list len $len idx $idx] -reps $reps comment Insert multiple items multiple times to unshared list with variable index perf measure [linsert_describe unshared $len "$idx (var)" 5 $reps] { set L [linsert $L[set L {}] $idx X X X X X] } [list len $len idx $idx] -reps $reps } } } } # Const index foreach share_mode {shared unshared} { if {$share_mode eq "shared"} { comment == Insert into empty lists comment Insert one element into empty list measure [linsert_describe shared 0 "0 (const)" 1 1] {linsert $L 0 ""} -setup {set L {}} } else { comment == Insert into empty lists comment Insert one element into empty list measure [linsert_describe unshared 0 "0 (const)" 1 1] {linsert {} 0 ""} } foreach idx_str [list 0 1 mid end end-1] { foreach len $Lengths { # Note end, end-1 explicitly calculated as otherwise they # are not treated as const if {$idx_str eq "mid"} { set idx [expr {$len/2}] } elseif {$idx_str eq "end"} { set idx [expr {$len-1}] } elseif {$idx_str eq "end-1"} { set idx [expr {$len-2}] } else { set idx $idx_str } #perf option -reps $reps set reps 100 if {$share_mode eq "shared"} { comment Insert once to shared list with const index perf measure [linsert_describe shared $len "$idx (const)" 1 1] \ "linsert \$L $idx x" [list len $len] -overhead {} -reps 10000 comment Insert multiple times to shared list with const index perf measure [linsert_describe shared $len "$idx (const)" 1 $reps] \ "set L \[linsert \$L $idx X\]" [list len $len] -reps $reps comment Insert multiple items multiple times to shared list with const index perf measure [linsert_describe shared $len "$idx (const)" 5 $reps] \ "set L \[linsert \$L $idx X X X X X\]" [list len $len] -reps $reps } else { comment Insert multiple times to unshared list with const index perf measure [linsert_describe unshared $len "$idx (const)" 1 $reps] \ "set L \[linsert \$L\[set L {}\] $idx X]" [list len $len] -reps $reps comment Insert multiple items multiple times to unshared list with const index perf measure [linsert_describe unshared $len "$idx (const)" 5 $reps] \ "set L \[linsert \$L\[set L {}\] $idx X X X X X]" [list len $len] -reps $reps } } } } # Note: no span tests because the inserts above will themselves create # spanned lists perf destroy } proc list_describe {len text} { return "list L\[$len\] $text" } proc list_perf {} { variable Lengths print_separator list ListPerf create perf foreach len $Lengths { set s [join [lrepeat $len x]] comment Create a list from a string perf measure [list_describe $len "from a string"] {list $s} [list s $s len $len] } foreach len $Lengths { comment Create a list from expansion - single list (special optimal case) perf measure [list_describe $len "from a {*}list"] {list {*}$L} [list len $len] comment Create a list from two lists - real test of expansion speed perf measure [list_describe $len "from a {*}list {*}list"] {list {*}$L {*}$L} [list len [expr {$len/2}]] } } proc lappend_describe {share_mode len num iters} { return "lappend L\[$len\] $share_mode $num elems $iters times" } proc lappend_perf {} { variable Lengths print_separator lappend ListPerf create perf -setup {set L [lrepeat [expr {$len/4}] x]} # Shared foreach len $Lengths { comment Append to a shared list variable multiple times perf measure [lappend_describe shared [expr {$len/2}] 1 $len] { set L2 $L; # Make shared lappend L x } [list len $len] -reps $len -overhead {set L2 $L} } # Unshared foreach len $Lengths { comment Append to a unshared list variable multiple times perf measure [lappend_describe unshared [expr {$len/2}] 1 $len] { lappend L x } [list len $len] -reps $len } # Span foreach len $Lengths { comment Append to a unshared-span list variable multiple times perf measure [lappend_describe unshared-span [expr {$len/2}] 1 $len] { lappend Lspan x } [list len $len] -reps $len } perf destroy } proc lpop_describe {share_mode len at reps} { return "lpop L\[$len\] $share_mode at $at $reps times" } proc lpop_perf {} { variable Lengths print_separator lpop ListPerf create perf # Shared perf option -overhead {set L2 $L} foreach len $Lengths { set reps [expr {($len >= 1000 ? ($len/2) : $len) - 2}] foreach idx {0 1 end-1 end} { comment Pop element at position $idx from a shared list variable perf measure [lpop_describe shared $len $idx $reps] { set L2 $L lpop L $idx } [list len $len idx $idx] -reps $reps } } # Unshared perf option -overhead {} foreach len $Lengths { set reps [expr {($len >= 1000 ? ($len/2) : $len) - 2}] foreach idx {0 1 end-1 end} { comment Pop element at position $idx from an unshared list variable perf measure [lpop_describe unshared $len $idx $reps] { lpop L $idx } [list len $len idx $idx] -reps $reps } } perf destroy # Nested ListPerf create perf -setup { set L [lrepeat $len [list a b]] } # Shared, nested index perf option -overhead {set L2 $L; set L L2} foreach len $Lengths { set reps [expr {($len >= 1000 ? ($len/2) : $len) - 2}] foreach idx {0 1 end-1 end} { perf measure [lpop_describe shared $len "{$idx 0}" $reps] { set L2 $L lpop L $idx 0 set L $L2 } [list len $len idx $idx] -reps $reps } } # TODO - Nested Unshared # Not sure how to measure performance. When unshared there is no copy # so deleting a nested index repeatedly is not feasible perf destroy } proc lassign_describe {share_mode len num reps} { return "lassign L\[$len\] $share_mode $num elems $reps times" } proc lassign_perf {} { variable Lengths print_separator lassign ListPerf create perf foreach share_mode {shared unshared} { foreach len $Lengths { if {$share_mode eq "shared"} { set reps 1000 comment Reflexive lassign - shared perf measure [lassign_describe shared $len 1 $reps] { set L2 $L set L2 [lassign $L2 v] } [list len $len] -overhead {set L2 $L} -reps $reps comment Reflexive lassign - shared, multiple perf measure [lassign_describe shared $len 5 $reps] { set L2 $L set L2 [lassign $L2 a b c d e] } [list len $len] -overhead {set L2 $L} -reps $reps } else { set reps [expr {($len >= 1000 ? ($len/2) : $len) - 2}] comment Reflexive lassign - unshared perf measure [lassign_describe unshared $len 1 $reps] { set L [lassign $L v] } [list len $len] -reps $reps } } } perf destroy } proc lrepeat_describe {len num} { return "lrepeat L\[$len\] $num elems at a time" } proc lrepeat_perf {} { variable Lengths print_separator lrepeat ListPerf create perf -reps 100000 foreach len $Lengths { comment Generate a list from a single repeated element perf measure [lrepeat_describe $len 1] { lrepeat $len a } [list len $len] comment Generate a list from multiple repeated elements perf measure [lrepeat_describe $len 5] { lrepeat $len a b c d e } [list len $len] } perf destroy } proc lreverse_describe {share_mode len} { return "lreverse L\[$len\] $share_mode" } proc lreverse_perf {} { variable Lengths print_separator lreverse ListPerf create perf -reps 10000 foreach share_mode {shared unshared} { foreach len $Lengths { if {$share_mode eq "shared"} { comment Reverse a shared list perf measure [lreverse_describe shared $len] { lreverse $L } [list len $len] if {$len > 100} { comment Reverse a shared-span list perf measure [lreverse_describe shared-span $len] { lreverse $Lspan } [list len $len] } } else { comment Reverse a unshared list perf measure [lreverse_describe unshared $len] { set L [lreverse $L[set L {}]] } [list len $len] -overhead {set L $L; set L {}} if {$len >= 100} { comment Reverse a unshared-span list perf measure [lreverse_describe unshared-span $len] { set Lspan [lreverse $Lspan[set Lspan {}]] } [list len $len] -overhead {set Lspan $Lspan; set Lspan {}} } } } } perf destroy } proc llength_describe {share_mode len} { return "llength L\[$len\] $share_mode" } proc llength_perf {} { variable Lengths print_separator llength ListPerf create perf -reps 100000 foreach len $Lengths { comment Length of a list perf measure [llength_describe shared $len] { llength $L } [list len $len] if {$len >= 100} { comment Length of a span list perf measure [llength_describe shared-span $len] { llength $Lspan } [list len $len] } } perf destroy } proc lindex_describe {share_mode len at} { return "lindex L\[$len\] $share_mode at $at" } proc lindex_perf {} { variable Lengths print_separator lindex ListPerf create perf -reps 100000 foreach len $Lengths { comment Index into a list set idx [expr {$len/2}] perf measure [lindex_describe shared $len $idx] { lindex $L $idx } [list len $len idx $idx] if {$len >= 100} { comment Index into a span list perf measure [lindex_describe shared-span $len $idx] { lindex $Lspan $idx } [list len $len idx $idx] } } perf destroy } proc lrange_describe {share_mode len range} { return "lrange L\[$len\] $share_mode range $range" } proc lrange_perf {} { variable Lengths print_separator lrange ListPerf create perf -time 1000 -reps 100000 foreach share_mode {shared unshared} { foreach len $Lengths { set eighth [expr {$len/8}] set ranges [list \ [list 0 0] [list 0 end-1] \ [list $eighth [expr {3*$eighth}]] \ [list $eighth [expr {7*$eighth}]] \ [list 1 end] [list end-1 end] \ ] foreach range $ranges { comment Range $range in $share_mode list of length $len if {$share_mode eq "shared"} { perf measure [lrange_describe shared $len $range] \ "lrange \$L $range" [list len $len range $range] } else { perf measure [lrange_describe unshared $len $range] \ "lrange \[lrepeat \$len\ a] $range" \ [list len $len range $range] -overhead {lrepeat $len a} } } if {$len >= 100} { foreach range $ranges { comment Range $range in ${share_mode}-span list of length $len if {$share_mode eq "shared"} { perf measure [lrange_describe shared-span $len $range] \ "lrange \$Lspan {*}$range" [list len $len range $range] } else { perf measure [lrange_describe unshared-span $len $range] \ "lrange \[perf::list::spanned_list \$len\] $range" \ [list len $len range $range] -overhead {perf::list::spanned_list $len} } } } } } perf destroy } proc lset_describe {share_mode len at} { return "lset L\[$len\] $share_mode at $at" } proc lset_perf {} { variable Lengths print_separator lset ListPerf create perf -reps 10000 # Shared foreach share_mode {shared unshared} { foreach len $Lengths { foreach idx {0 1 end-1 end end+1} { comment lset at position $idx in a $share_mode list variable if {$share_mode eq "shared"} { perf measure [lset_describe shared $len $idx] { set L2 $L lset L $idx X } [list len $len idx $idx] -overhead {set L2 $L} } else { perf measure [lset_describe unshared $len $idx] { lset L $idx X } [list len $len idx $idx] } } } } perf destroy # Nested ListPerf create perf -setup { set L [lrepeat $len [list a b]] } foreach share_mode {shared unshared} { foreach len $Lengths { foreach idx {0 1 end-1 end} { comment lset at position $idx in a $share_mode list variable if {$share_mode eq "shared"} { perf measure [lset_describe shared $len "{$idx 0}"] { set L2 $L lset L $idx 0 X } [list len $len idx $idx] -overhead {set L2 $L} } else { perf measure [lset_describe unshared $len "{$idx 0}"] { lset L $idx 0 {X Y} } [list len $len idx $idx] } } } } perf destroy } proc lremove_describe {share_mode len at nremoved} { return "lremove L\[$len\] $share_mode $nremoved elements at $at" } proc lremove_perf {} { variable Lengths print_separator lremove ListPerf create perf -reps 10000 foreach share_mode {shared unshared} { foreach len $Lengths { foreach idx [list 0 1 [expr {$len/2}] end-1 end] { if {$share_mode eq "shared"} { comment Remove one element from shared list perf measure [lremove_describe shared $len $idx 1] \ {lremove $L $idx} [list len $len idx $idx] } else { comment Remove one element from unshared list set reps [expr {$len >= 1000 ? ($len/8) : ($len-2)}] perf measure [lremove_describe unshared $len $idx 1] \ {set L [lremove $L[set L {}] $idx]} [list len $len idx $idx] \ -overhead {set L $L; set L {}} -reps $reps } } if {$share_mode eq "shared"} { comment Remove multiple elements from shared list perf measure [lremove_describe shared $len [list 0 1 [expr {$len/2}] end-1 end] 5] { lremove $L 0 1 [expr {$len/2}] end-1 end } [list len $len] } } # Span foreach len $Lengths { foreach idx [list 0 1 [expr {$len/2}] end-1 end] { if {$share_mode eq "shared"} { comment Remove one element from shared-span list perf measure [lremove_describe shared-span $len $idx 1] \ {lremove $Lspan $idx} [list len $len idx $idx] } else { comment Remove one element from unshared-span list set reps [expr {$len >= 1000 ? ($len/8) : ($len-2)}] perf measure [lremove_describe unshared-span $len $idx 1] \ {set Lspan [lremove $Lspan[set Lspan {}] $idx]} [list len $len idx $idx] \ -overhead {set Lspan $Lspan; set Lspan {}} -reps $reps } } if {$share_mode eq "shared"} { comment Remove multiple elements from shared-span list perf measure [lremove_describe shared-span $len [list 0 1 [expr {$len/2}] end-1 end] 5] { lremove $Lspan 0 1 [expr {$len/2}] end-1 end } [list len $len] } } } perf destroy } proc lreplace_describe {share_mode len first last ninsert {times 1}} { if {$last < $first} { return "lreplace L\[$len\] $share_mode 0 ($first:$last) elems at $first with $ninsert elems $times times." } return "lreplace L\[$len\] $share_mode $first:$last with $ninsert elems $times times." } proc lreplace_perf {} { variable Lengths print_separator lreplace set default_reps 10000 ListPerf create perf -reps $default_reps foreach share_mode {shared unshared} { # Insert only foreach len $Lengths { set reps [expr {$len <= 100 ? ($len-2) : ($len/8)}] foreach first [list 0 1 [expr {$len/2}] end-1 end] { if {$share_mode eq "shared"} { comment Insert one to shared list perf measure [lreplace_describe shared $len $first -1 1] { lreplace $L $first -1 x } [list len $len first $first] comment Insert multiple to shared list perf measure [lreplace_describe shared $len $first -1 10] { lreplace $L $first -1 X X X X X X X X X X } [list len $len first $first] comment Insert one to shared list repeatedly perf measure [lreplace_describe shared $len $first -1 1 $reps] { set L [lreplace $L $first -1 x] } [list len $len first $first] -reps $reps comment Insert multiple to shared list repeatedly perf measure [lreplace_describe shared $len $first -1 10 $reps] { set L [lreplace $L $first -1 X X X X X X X X X X] } [list len $len first $first] -reps $reps } else { comment Insert one to unshared list perf measure [lreplace_describe unshared $len $first -1 1] { set L [lreplace $L[set L {}] $first -1 x] } [list len $len first $first] -overhead { set L $L; set L {} } -reps $reps comment Insert multiple to unshared list perf measure [lreplace_describe unshared $len $first -1 10] { set L [lreplace $L[set L {}] $first -1 X X X X X X X X X X] } [list len $len first $first] -overhead { set L $L; set L {} } -reps $reps } } } # Delete only foreach len $Lengths { set reps [expr {$len <= 100 ? ($len-2) : ($len/8)}] foreach first [list 0 1 [expr {$len/2}] end-1 end] { if {$share_mode eq "shared"} { comment Delete one from shared list perf measure [lreplace_describe shared $len $first $first 0] { lreplace $L $first $first } [list len $len first $first] } else { comment Delete one from unshared list perf measure [lreplace_describe unshared $len $first $first 0] { set L [lreplace $L[set L {}] $first $first x] } [list len $len first $first] -overhead { set L $L; set L {} } -reps $reps } } } # Insert + delete foreach len $Lengths { set reps [expr {$len <= 100 ? ($len-2) : ($len/8)}] foreach range [list {0 1} {1 2} {end-2 end-1} {end-1 end}] { lassign $range first last if {$share_mode eq "shared"} { comment Insertions more than deletions from shared list perf measure [lreplace_describe shared $len $first $last 3] { lreplace $L $first $last X Y Z } [list len $len first $first last $last] comment Insertions same as deletions from shared list perf measure [lreplace_describe shared $len $first $last 2] { lreplace $L $first $last X Y } [list len $len first $first last $last] comment Insertions fewer than deletions from shared list perf measure [lreplace_describe shared $len $first $last 1] { lreplace $L $first $last X } [list len $len first $first last $last] } else { comment Insertions more than deletions from unshared list perf measure [lreplace_describe unshared $len $first $last 3] { set L [lreplace $L[set L {}] $first $last X Y Z] } [list len $len first $first last $last] -overhead { set L $L; set L {} } -reps $reps comment Insertions same as deletions from unshared list perf measure [lreplace_describe unshared $len $first $last 2] { set L [lreplace $L[set L {}] $first $last X Y ] } [list len $len first $first last $last] -overhead { set L $L; set L {} } -reps $reps comment Insertions fewer than deletions from unshared list perf measure [lreplace_describe unshared $len $first $last 1] { set L [lreplace $L[set L {}] $first $last X] } [list len $len first $first last $last] -overhead { set L $L; set L {} } -reps $reps } } } # Spanned Insert + delete foreach len $Lengths { set reps [expr {$len <= 100 ? ($len-2) : ($len/8)}] foreach range [list {0 1} {1 2} {end-2 end-1} {end-1 end}] { lassign $range first last if {$share_mode eq "shared"} { comment Insertions more than deletions from shared-span list perf measure [lreplace_describe shared-span $len $first $last 3] { lreplace $Lspan $first $last X Y Z } [list len $len first $first last $last] comment Insertions same as deletions from shared-span list perf measure [lreplace_describe shared-span $len $first $last 2] { lreplace $Lspan $first $last X Y } [list len $len first $first last $last] comment Insertions fewer than deletions from shared-span list perf measure [lreplace_describe shared-span $len $first $last 1] { lreplace $Lspan $first $last X } [list len $len first $first last $last] } else { comment Insertions more than deletions from unshared-span list perf measure [lreplace_describe unshared-span $len $first $last 3] { set Lspan [lreplace $Lspan[set Lspan {}] $first $last X Y Z] } [list len $len first $first last $last] -overhead { set Lspan $Lspan; set Lspan {} } -reps $reps comment Insertions same as deletions from unshared-span list perf measure [lreplace_describe unshared-span $len $first $last 2] { set Lspan [lreplace $Lspan[set Lspan {}] $first $last X Y ] } [list len $len first $first last $last] -overhead { set Lspan $Lspan; set Lspan {} } -reps $reps comment Insertions fewer than deletions from unshared-span list perf measure [lreplace_describe unshared-span $len $first $last 1] { set Lspan [lreplace $Lspan[set Lspan {}] $first $last X] } [list len $len first $first last $last] -overhead { set Lspan $Lspan; set Lspan {} } -reps $reps } } } } perf destroy } proc split_describe {len} { return "split L\[$len\]" } proc split_perf {} { variable Lengths print_separator split ListPerf create perf -setup {set S [string repeat "x " $len]} foreach len $Lengths { comment Split a string perf measure [split_describe $len] { split $S " " } [list len $len] } } proc join_describe {share_mode len} { return "join L\[$len\] $share_mode" } proc join_perf {} { variable Lengths print_separator join ListPerf create perf -reps 10000 foreach len $Lengths { comment Join a list perf measure [join_describe shared $len] { join $L } [list len $len] } foreach len $Lengths { comment Join a spanned list perf measure [join_describe shared-span $len] { join $Lspan } [list len $len] } perf destroy } proc lsearch_describe {share_mode len} { return "lsearch L\[$len\] $share_mode" } proc lsearch_perf {} { variable Lengths print_separator lsearch ListPerf create perf -reps 100000 foreach len $Lengths { comment Search a list perf measure [lsearch_describe shared $len] { lsearch $L needle } [list len $len] } foreach len $Lengths { comment Search a spanned list perf measure [lsearch_describe shared-span $len] { lsearch $Lspan needle } [list len $len] } perf destroy } proc foreach_describe {share_mode len} { return "foreach L\[$len\] $share_mode" } proc foreach_perf {} { variable Lengths print_separator foreach ListPerf create perf -reps 10000 foreach len $Lengths { comment Iterate through a list perf measure [foreach_describe shared $len] { foreach e $L {} } [list len $len] } foreach len $Lengths { comment Iterate a spanned list perf measure [foreach_describe shared-span $len] { foreach e $Lspan {} } [list len $len] } perf destroy } proc lmap_describe {share_mode len} { return "lmap L\[$len\] $share_mode" } proc lmap_perf {} { variable Lengths print_separator lmap ListPerf create perf -reps 10000 foreach len $Lengths { comment Iterate through a list perf measure [lmap_describe shared $len] { lmap e $L {} } [list len $len] } foreach len $Lengths { comment Iterate a spanned list perf measure [lmap_describe shared-span $len] { lmap e $Lspan {} } [list len $len] } perf destroy } proc get_sort_sample {{spanned 0}} { variable perfScript variable sortSampleText if {![info exists sortSampleText]} { set fd [open $perfScript] set sortSampleText [split [read $fd] ""] close $fd } set sortSampleText [string range $sortSampleText 0 9999] # NOTE: do NOT cache list result in a variable as we need it unshared if {$spanned} { return [lrange [split $sortSampleText ""] 1 end-1] } else { return [split $sortSampleText ""] } } proc lsort_describe {share_mode len} { return "lsort L\[$len] $share_mode" } proc lsort_perf {} { print_separator lsort ListPerf create perf -setup {} comment Sort a shared list perf measure [lsort_describe shared [llength [perf::list::get_sort_sample]]] { lsort $L } {} -setup {set L [perf::list::get_sort_sample]} comment Sort a shared-span list perf measure [lsort_describe shared-span [llength [perf::list::get_sort_sample 1]]] { lsort $L } {} -setup {set L [perf::list::get_sort_sample 1]} comment Sort an unshared list perf measure [lsort_describe unshared [llength [perf::list::get_sort_sample]]] { lsort [perf::list::get_sort_sample] } {} -overhead {perf::list::get_sort_sample} comment Sort an unshared-span list perf measure [lsort_describe unshared-span [llength [perf::list::get_sort_sample 1]]] { lsort [perf::list::get_sort_sample 1] } {} -overhead {perf::list::get_sort_sample 1} perf destroy } proc concat_describe {canonicality len elemlen} { return "concat L\[$len\] $canonicality with elements of length $elemlen" } proc concat_perf {} { variable Lengths print_separator concat ListPerf create perf -reps 100000 foreach len $Lengths { foreach elemlen {1 100} { comment Pure lists (no string representation) perf measure [concat_describe "pure lists" $len $elemlen] { concat $L $L } [list len $len elemlen $elemlen] -setup { set L [lrepeat $len [string repeat a $elemlen]] } comment Canonical lists (with string representation) perf measure [concat_describe "canonical lists" $len $elemlen] { concat $L $L } [list len $len elemlen $elemlen] -setup { set L [lrepeat $len [string repeat a $elemlen]] append x x $L; # Generate string while keeping internal rep list unset x } comment Non-canonical lists perf measure [concat_describe "non-canonical lists" $len $elemlen] { concat $L $L } [list len $len elemlen $elemlen] -setup { set L [string repeat "[string repeat a $elemlen] " $len] llength $L } } } # Span version foreach len $Lengths { foreach elemlen {1 100} { comment Pure span lists (no string representation) perf measure [concat_describe "pure spanned lists" $len $elemlen] { concat $L $L } [list len $len elemlen $elemlen] -setup { set L [lrange [lrepeat [expr {$len+2}] [string repeat a $elemlen]] 1 end-1] } comment Canonical span lists (with string representation) perf measure [concat_describe "canonical spanned lists" $len $elemlen] { concat $L $L } [list len $len elemlen $elemlen] -setup { set L [lrange [lrepeat [expr {$len+2}] [string repeat a $elemlen]] 1 end-1] append x x $L; # Generate string while keeping internal rep list unset x } } } perf destroy } proc test {} { variable RunTimes variable Options set selections [perf::list::setup $::argv] if {[llength $selections] == 0} { set commands [info commands ::perf::list::*_perf] } else { set commands [lmap sel $selections { if {$sel eq "help"} { print_usage continue } set cmd ::perf::list::${sel}_perf if {$cmd ni [info commands ::perf::list::*_perf]} { puts stderr "Error: command $sel is not known or supported. Skipping." continue } set cmd }] } comment Setting up timerate -calibrate {} if {[info exists Options(--label)]} { print "L $Options(--label)" } print "V [info patchlevel]" print "E [info nameofexecutable]" if {[info exists Options(--description)]} { print "D $Options(--description)" } set twapi_keys {-privatebytes -workingset -workingsetpeak} if {[info commands ::twapi::get_process_memory_info] ne ""} { set twapi_vm_pre [::twapi::get_process_memory_info] } foreach cmd [lsort -dictionary $commands] { set RunTimes(command) 0.0 $cmd set RunTimes(total) [expr {$RunTimes(total)+$RunTimes(command)}] print "P [format_timings $RunTimes(command) 1] [string range $cmd 14 end-5] total run time" } # Print total runtime in same format as timerate output print "P [format_timings $RunTimes(total) 1] Total run time" if {[info exists twapi_vm_pre]} { set twapi_vm_post [::twapi::get_process_memory_info] set MB 1048576.0 foreach key $twapi_keys { set pre [expr {[dict get $twapi_vm_pre $key]/$MB}] set post [expr {[dict get $twapi_vm_post $key]/$MB}] print "P [format_timings $pre 1] Memory (MB) $key pre-test" print "P [format_timings $post 1] Memory (MB) $key post-test" print "P [format_timings [expr {$post-$pre}] 1] Memory (MB) delta $key" } } if {[info commands memory] ne ""} { foreach line [split [memory info] \n] { if {$line eq ""} continue set line [split $line] set val [expr {[lindex $line end]/1000.0}] set line [string trim [join [lrange $line 0 end-1]]] print "P [format_timings $val 1] memdbg $line (in thousands)" } print "# Allocations not freed on exit written to the lost-memory.tmp file." print "# These will have to be manually compared." # env TCL_FINALIZE_ON_EXIT must be set to 1 for this. # DO NOT SET HERE - set ::env(TCL_FINALIZE_ON_EXIT) 1 # Must be set in environment before starting tclsh else bogus results if {[info exists Options(--label)]} { set dump_file list-memory-$Options(--label).memdmp } else { set dump_file list-memory-[pid].memdmp } memory onexit $dump_file } } } if {[info exists ::argv0] && [file tail $::argv0] eq [file tail [info script]]} { ::perf::list::test } |
Changes to tests/apply.test.
︙ | ︙ | |||
257 258 259 260 261 262 263 | test apply-9.1 {leaking internal rep} -setup { proc getbytes {} { set lines [split [memory info] "\n"] lindex $lines 3 3 } set lam [list {} {set a 1}] | | | 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 | test apply-9.1 {leaking internal rep} -setup { proc getbytes {} { set lines [split [memory info] "\n"] lindex $lines 3 3 } set lam [list {} {set a 1}] } -constraints {memory} -body { set end [getbytes] for {set i 0} {$i < 5} {incr i} { ::apply [lrange $lam 0 end] set tmp $end set end [getbytes] } set leakedBytes [expr {$end - $tmp}] |
︙ | ︙ |
Added tests/listRep.test.
> > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 | # This file contains tests that specifically exercise the internal representation # of a list. # # Copyright © 2022 Ashok P. Nadkarni # # See the file "license.terms" for information on usage and redistribution # of this file, and for a DISCLAIMER OF ALL WARRANTIES. # Unlike the other files related to list commands which for the most part do # black box testing focusing on functionality, this file does more of white box # testing to exercise code paths that implement different list representations # (with spans, leading free space etc., shared/unshared etc.) In addition to # functional correctness, the tests also check for the expected internal # representation as that pertains to performance heuristics. Generally speaking, # combinations of the following need to be tested, # - free space in front, back, neither, both of list representation # - shared Tcl_Objs # - shared internal reps (independent of shared Tcl_Objs) # - byte-compiled vs non-compiled # # Being white box tests, they are sensitive to changes to further optimizations # and changes in heuristics. That cannot be helped. if {"::tcltest" ni [namespace children]} { package require tcltest 2.5 namespace import -force ::tcltest::* } ::tcltest::loadTestedCommands catch [list package require -exact tcl::test [info patchlevel]] testConstraint testlistrep [llength [info commands testlistrep]] proc describe {l args} {dict get [testlistrep describe $l] {*}$args} proc irange {first last} { set l {} while {$first <= $last} { lappend l $first incr first } return $l } proc leadSpace {l} { # Returns the leading space in a list store return [dict get [describe $l] store firstUsed] } proc tailSpace {l} { # Returns the trailing space in a list store array set rep [describe $l] dict with rep(store) { return [expr {$numAllocated - ($firstUsed + $numUsed)}] } } proc allocated {l} { # Returns the allocated space in a list store return [dict get [describe $l] store numAllocated] } proc repStoreRefCount {l} { # Returns the ref count for the list store return [dict get [describe $l] store refCount] } proc validate {l} { # Panics if internal listrep structures are not valid testlistrep validate $l } proc leadSpaceMore {l} { set leadSpace [leadSpace $l] expr {$leadSpace > 0 && $leadSpace >= 2*[tailSpace $l]} } proc tailSpaceMore {l} { set tailSpace [tailSpace $l] expr {$tailSpace > 0 && $tailSpace >= 2*[leadSpace $l]} } proc spaceEqual {l} { # 1 if lead and tail space shared (diff of 1 at most) and more than 0 set leadSpace [leadSpace $l] set tailSpace [tailSpace $l] if {$leadSpace == 0 && $tailSpace == 0} { # At least one must be positive return 0 } set diff [expr {$leadSpace - $tailSpace}] return [expr {$diff >= -1 && $diff <= 1}] } proc storeAddress {l} { return [describe $l store memoryAddress] } proc sameStore {l1 l2} { expr {[storeAddress $l1] == [storeAddress $l2]} } proc hasSpan {l args} { # Returns 1 if list has a span. If args are specified, they are checked with # span values (start and length) array set rep [describe $l] if {![info exists rep(span)]} { return 0 } if {[llength $args] == 0} { return 1; # No need to check values } lassign $args start len if {[dict get $rep(span) spanStart] == $start && [dict get $rep(span) spanLength] == $len} { return 1 } return 0 } proc checkListrep {l listLen numAllocated leadSpace tailSpace {refCount 0}} { # Checks if the internal representation of $l match # passed arguments. Return "" if yes, else error messages. array set rep [testlistrep describe $l] set rep(leadSpace) [dict get $rep(store) firstUsed] set rep(numAllocated) [dict get $rep(store) numAllocated] set rep(tailSpace) [expr { $rep(numAllocated) - ($rep(leadSpace) + [dict get $rep(store) numUsed]) }] set rep(refCount) [dict get $rep(store) refCount] if {[info exists rep(span)]} { set rep(listLen) [dict get $rep(span) spanLength] } else { set rep(listLen) [dict get $rep(store) numUsed] } set errors [list] foreach arg {listLen numAllocated leadSpace tailSpace} { if {$rep($arg) != [set $arg]} { lappend errors "$arg in list representation ($rep($arg)) is not expected value ([set $arg])." } } # Check refCount only if caller has specified it as non-0 if {$refCount && $refCount != $rep(refCount)} { lappend errors "refCount in list representation ($rep(refCount)) is not expected value ($refCount)." } return $errors } proc assertListrep {l listLen numAllocated leadSpace tailSpace {refCount 0}} { # Like check_listrep but raises error set errors [checkListrep $l $listLen $numAllocated $leadSpace $tailSpace $refCount] if {[llength $errors]} { error [join $errors \n] } return } # The default length should be large enough that doubling the allocation will # clearly distinguish free space allocation difference between front and back. # (difference in the two should at least be 2 else we cannot tell if front # or back was favored appropriately) proc freeSpaceNone {{len 8}} {return [testlistrep new $len 0 0]} proc freeSpaceLead {{len 8} {lead 3}} {return [testlistrep new $len $lead 0]} proc freeSpaceTail {{len 8} {tail 3}} {return [testlistrep new $len 0 $tail]} proc freeSpaceBoth {{len 8} {lead 3} {tail 3}} { return [testlistrep new $len $lead $tail] } proc zombieSample {{len 1000} {leadzombies 100} {tailzombies 100}} { # returns an unshared listrep with zombies in front and back # don't combine freespacenone and lrange else zombies are freed set l [freeSpaceNone [expr {$len+$leadzombies+$tailzombies}]] return [lrange $l $leadzombies [expr {$leadzombies+$len-1}]] } # Just ensure above stubs return what's expected if {[testConstraint testlistrep]} { assertListrep [freeSpaceNone] 8 8 0 0 1 assertListrep [freeSpaceLead] 8 11 3 0 1 assertListrep [freeSpaceTail] 8 11 0 3 1 assertListrep [freeSpaceBoth] 8 14 3 3 1 assertListrep [zombieSample] 1000 1200 0 0 1 if {![hasSpan [zombieSample]] || [dict get [testlistrep describe [zombieSample]] span spanStart] == 0} { error "zombieSample span missing or span start is at 0." } } # Define some variables for some indices because the Tcl compiler will do some # operations completely in byte code if indices are literals set zero 0 set one 1 set two 2 set four 4 set end end # # Test sets: # 1.* - unshared internal rep, no spans, with no free space # 2.* - shared internal rep, no spans, with no free space # 3.* - unshared internal rep, spanned # 4.* - shared internal rep, spanned # 5.* - shared Tcl_Obj # 6.* - lists with zombie Tcl_Obj's # # listrep-1.* tests all operate on unshared listreps with no free space test listrep-1.1 { Inserts in front of unshared list with no free space should reallocate with equal free space at front and back -- linsert version } -constraints testlistrep -body { set l [linsert [freeSpaceNone] $zero 99] validate $l list $l [spaceEqual $l] } -result [list {99 0 1 2 3 4 5 6 7} 1] test listrep-1.1.1 { Inserts in front of unshared list with no free space should reallocate with equal free space at front and back -- lreplace version } -constraints testlistrep -body { set l [lreplace [freeSpaceNone] $zero -1 99] validate $l list $l [spaceEqual $l] } -result [list {99 0 1 2 3 4 5 6 7} 1] test listrep-1.2 { Inserts at back of unshared list with no free space should allocate all space at back -- linsert version } -constraints testlistrep -body { set l [linsert [freeSpaceNone] $end 99] validate $l list $l [leadSpace $l] [tailSpace $l] } -result [list {0 1 2 3 4 5 6 7 99} 0 9] test listrep-1.2.1 { Inserts at back of unshared list with no free space should allocate all space at back -- lset version } -constraints testlistrep -body { set l [freeSpaceNone] lset l $end+1 99 validate $l list $l [leadSpace $l] [tailSpace $l] } -result [list {0 1 2 3 4 5 6 7 99} 0 9] test listrep-1.2.2 { Inserts at back of unshared list with no free space should allocate all space at back -- lappend version } -constraints testlistrep -body { set l [freeSpaceNone] lappend l 99 validate $l list $l [leadSpace $l] [tailSpace $l] } -result [list {0 1 2 3 4 5 6 7 99} 0 9] test listrep-1.3 { Inserts in middle of unshared list with no free space should reallocate with equal free space at front and back - linsert version } -constraints testlistrep -body { set l [linsert [freeSpaceNone] $four 99] validate $l list $l [spaceEqual $l] } -result [list {0 1 2 3 99 4 5 6 7} 1] test listrep-1.3.1 { Inserts in middle of unshared list with no free space should reallocate with equal free space at front and back - lreplace version } -constraints testlistrep -body { set l [lreplace [freeSpaceNone] $four $four-1 99] validate $l list $l [spaceEqual $l] } -result [list {0 1 2 3 99 4 5 6 7} 1] test listrep-1.4 { Deletes from front of small unshared list with no free space should just shift up leaving room at back - lreplace version } -constraints testlistrep -body { set l [lreplace [freeSpaceNone] $zero $zero] validate $l list $l [leadSpace $l] [tailSpace $l] } -result [list {1 2 3 4 5 6 7} 0 1] test listrep-1.4.1 { Deletes from front of small unshared list with no free space should just shift up leaving room at back - lassign version } -constraints testlistrep -body { set l [lassign [freeSpaceNone] e] validate $l list $e $l [leadSpace $l] [tailSpace $l] } -result [list 0 {1 2 3 4 5 6 7} 0 1] test listrep-1.4.2 { Deletes from front of small unshared list with no free space should just shift up leaving room at back - lpop version } -constraints testlistrep -body { set l [freeSpaceNone] set e [lpop l $zero] validate $l list $e $l [leadSpace $l] [tailSpace $l] } -result [list 0 {1 2 3 4 5 6 7} 0 1] test listrep-1.4.3 { Deletes from front of small unshared list with no free space should just shift up leaving room at back - lrange version } -constraints testlistrep -body { set l [lrange [freeSpaceNone] $one $end] validate $l list $l [leadSpace $l] [tailSpace $l] } -result [list {1 2 3 4 5 6 7} 0 1] test listrep-1.4.4 { Deletes from front of small unshared list with no free space should just shift up leaving room at back - lremove version } -constraints testlistrep -body { set l [lremove [freeSpaceNone] $zero] validate $l list $l [leadSpace $l] [tailSpace $l] } -result [list {1 2 3 4 5 6 7} 0 1] test listrep-1.5 { Deletes from front of large unshared list with no free space should create a span - lreplace version } -constraints testlistrep -body { set l [lreplace [freeSpaceNone 1000] $zero $one] validate $l list $l [leadSpace $l] [tailSpace $l] [hasSpan $l 2 998] } -result [list [irange 2 999] 2 0 1] test listrep-1.5.1 { Deletes from front of large unshared list with no free space should create a span - lassign version } -constraints testlistrep -body { set l [lassign [freeSpaceNone 1000] e] validate $l list $e $l [leadSpace $l] [tailSpace $l] [hasSpan $l 1 999] } -result [list 0 [irange 1 999] 1 0 1] test listrep-1.5.2 { Deletes from front of large unshared list with no free space should create a span - lrange version } -constraints testlistrep -body { set l [lrange [freeSpaceNone 1000] $two end] validate $l list $l [leadSpace $l] [tailSpace $l] [hasSpan $l 2 998] } -result [list [irange 2 999] 2 0 1] test listrep-1.5.3 { Deletes from front of large unshared list with no free space should create a span - lremove version } -constraints testlistrep -body { set l [lremove [freeSpaceNone 1000] $zero] validate $l list $l [leadSpace $l] [tailSpace $l] [hasSpan $l 1 999] } -result [list [irange 1 999] 1 0 1] test listrep-1.5.4 { Deletes from front of large unshared list with no free space should create a span - lpop version } -constraints testlistrep -body { set l [freeSpaceNone 1000] set e [lpop l 0] validate $l list $e $l [leadSpace $l] [tailSpace $l] [hasSpan $l 1 999] } -result [list 0 [irange 1 999] 1 0 1] test listrep-1.6 { Deletes closer to front of large list should move (smaller) front segment -- lreplace version } -constraints testlistrep -body { set l [lreplace [freeSpaceNone 1000] $four $four] validate $l list $l [leadSpace $l] [tailSpace $l] [hasSpan $l 1 999] } -result [list [concat [irange 0 3] [irange 5 999]] 1 0 1] test listrep-1.6.1 { Deletes closer to front of large list should move (smaller) front segment -- lpop version } -constraints testlistrep -body { set l [freeSpaceNone 1000] set e [lpop l $four] validate $l list $e $l [leadSpace $l] [tailSpace $l] [hasSpan $l 1 999] } -result [list 4 [concat [irange 0 3] [irange 5 999]] 1 0 1] test listrep-1.7 { Deletes closer to back of large list should move (smaller) back segment and will not need a span - lreplace version } -constraints testlistrep -body { set l [lreplace [freeSpaceNone 1000] end-$four end-$four] validate $l list $l [leadSpace $l] [tailSpace $l] [hasSpan $l] } -result [list [concat [irange 0 994] [irange 996 999]] 0 1 0] test listrep-1.7.1 { Deletes closer to back of large list should move (smaller) back segment and will not need a span - lpop version } -constraints testlistrep -body { set l [freeSpaceNone 1000] set e [lpop l $end-4] validate $l list $e $l [leadSpace $l] [tailSpace $l] [hasSpan $l] } -result [list 995 [concat [irange 0 994] [irange 996 999]] 0 1 0] test listrep-1.8 { Deletes at back of small unshared list should not need a span - lreplace version } -constraints testlistrep -body { set l [lreplace [freeSpaceNone] end-$one end] validate $l list $l [leadSpace $l] [tailSpace $l] [hasSpan $l] } -result [list {0 1 2 3 4 5} 0 2 0] test listrep-1.8.1 { Deletes at back of small unshared list should not need a span - lrange version } -constraints testlistrep -body { set l [lrange [freeSpaceNone] $zero end-$two] validate $l list $l [leadSpace $l] [tailSpace $l] [hasSpan $l] } -result [list {0 1 2 3 4 5} 0 2 0] test listrep-1.8.2 { Deletes at back of small unshared list should not need a span - lremove version } -constraints testlistrep -body { set l [lremove [freeSpaceNone] $end-1 $end] validate $l list $l [leadSpace $l] [tailSpace $l] [hasSpan $l] } -result [list {0 1 2 3 4 5} 0 2 0] test listrep-1.8.3 { Deletes at back of small unshared list should not need a span - lpop version } -constraints testlistrep -body { set l [freeSpaceNone] set e [lpop l $end] validate $l list $e $l [leadSpace $l] [tailSpace $l] [hasSpan $l] } -result [list 7 {0 1 2 3 4 5 6} 0 1 0] test listrep-1.9 { Deletes at back of large unshared list should not need a span - lreplace version } -constraints testlistrep -body { set l [lreplace [freeSpaceNone 1000] end-$four end] validate $l list $l [leadSpace $l] [tailSpace $l] [hasSpan $l] } -result [list [irange 0 994] 0 5 0] test listrep-1.9.1 { Deletes at back of large unshared list should not need a span - lrange version } -constraints testlistrep -body { set l [lrange [freeSpaceNone 1000] 0 $end-5] validate $l list $l [leadSpace $l] [tailSpace $l] [hasSpan $l] } -result [list [irange 0 994] 0 5 0] test listrep-1.9.2 { Deletes at back of large unshared list should not need a span - lremove version } -constraints testlistrep -body { set l [lremove [freeSpaceNone 1000] end-$four $end-3 end-$two $end-1 $end] validate $l list $l [leadSpace $l] [tailSpace $l] [hasSpan $l] } -result [list [irange 0 994] 0 5 0] test listrep-1.9.3 { Deletes at back of large unshared list should not need a span - lpop version } -constraints testlistrep -body { set l [freeSpaceNone 1000] set e [lpop l $end] validate $l list $e $l [leadSpace $l] [tailSpace $l] [hasSpan $l] } -result [list 999 [irange 0 998] 0 1 0] test listrep-1.10 { no-op on unshared list should force a canonical list string - lreplace version } -body { lreplace { 1 2 3 4 } $zero -1 } -result {1 2 3 4} test listrep-1.10.1 { no-op on unshared list should force a canonical list string - lrange version } -body { lrange { 1 2 3 4 } $zero $end } -result {1 2 3 4} test listrep-1.11 { Append elements to large unshared list is optimized as lappend so no free space in front - lreplace version } -body { # Note $end, not end else byte code compiler short-cuts set l [lreplace [freeSpaceNone 1000] $end+1 $end+1 1000] validate $l list $l [leadSpace $l] [expr {[tailSpace $l] > 0}] [hasSpan $l] } -result [list [irange 0 1000] 0 1 0] test listrep-1.11.1 { Append elements to large unshared list is optimized as lappend so no free space in front - linsert version } -body { # Note $end, not end else byte code compiler short-cuts set l [linsert [freeSpaceNone 1000] $end+1 1000] validate $l list $l [leadSpace $l] [expr {[tailSpace $l] > 0}] [hasSpan $l] } -result [list [irange 0 1000] 0 1 0] test listrep-1.11.2 { Append elements to large unshared list leaves no free space in front - lappend version } -body { # Note $end, not end else byte code compiler short-cuts set l [freeSpaceNone 1000] lappend l 1000 1001 validate $l list $l [leadSpace $l] [expr {[tailSpace $l] > 0}] [hasSpan $l] } -result [list [irange 0 1001] 0 1 0] test listrep-1.12 { Replacement of elements at front with same number elements in unshared list is in-place - lreplace version } -body { set l [lreplace [freeSpaceNone] $zero $one 10 11] validate $l list $l [leadSpace $l] [tailSpace $l] } -result [list {10 11 2 3 4 5 6 7} 0 0] test listrep-1.12.1 { Replacement of elements at front with same number elements in unshared list is in-place - lset version } -body { set l [freeSpaceNone] lset l 0 -1 validate $l list $l [leadSpace $l] [tailSpace $l] } -result [list {-1 1 2 3 4 5 6 7} 0 0] test listrep-1.13 { Replacement of elements at front with fewer elements in unshared list results in a spanned list with space only in front } -body { set l [lreplace [freeSpaceNone] $zero $four 10] validate $l list $l [leadSpace $l] [tailSpace $l] } -result [list {10 5 6 7} 4 0] test listrep-1.14 { Replacement of elements at front with more elements in unshared list results in a reallocated spanned list with space at front and back } -body { set l [lreplace [freeSpaceNone] $zero $one 10 11 12] validate $l list $l [spaceEqual $l] } -result [list {10 11 12 2 3 4 5 6 7} 1] test listrep-1.15 { Replacement of elements in middle with same number elements in unshared list is in-place - lreplace version } -body { set l [lreplace [freeSpaceNone] $one $two 10 11] validate $l list $l [leadSpace $l] [tailSpace $l] } -result [list {0 10 11 3 4 5 6 7} 0 0] test listrep-1.15.1 { Replacement of elements in middle with same number elements in unshared list is in-place - lset version } -body { set l [freeSpaceNone] lset l $two -1 validate $l list $l [leadSpace $l] [tailSpace $l] } -result [list {0 1 -1 3 4 5 6 7} 0 0] test listrep-1.16 { Replacement of elements in front half with fewer elements in unshared list results in a spanned list with space only in front since smaller segment moved } -body { set l [lreplace [freeSpaceNone] $one $four 10] validate $l list $l [leadSpace $l] [tailSpace $l] } -result [list {0 10 5 6 7} 3 0] test listrep-1.17 { Replacement of elements in back half with fewer elements in unshared list results in a spanned list with space only at back } -body { set l [lreplace [freeSpaceNone] end-$four end-$one 10] validate $l list $l [leadSpace $l] [tailSpace $l] } -result [list {0 1 2 10 7} 0 3] test listrep-1.18 { Replacement of elements in middle more elements in unshared list results in a reallocated spanned list with space at front and back } -body { set l [lreplace [freeSpaceNone] $one $two 10 11 12] validate $l list $l [spaceEqual $l] } -result [list {0 10 11 12 3 4 5 6 7} 1] test listrep-1.19 { Replacement of elements at back with same number elements in unshared list is in-place - lreplace version } -body { set l [lreplace [freeSpaceNone] $end-1 $end 10 11] validate $l list $l [leadSpace $l] [tailSpace $l] } -result [list {0 1 2 3 4 5 10 11} 0 0] test listrep-1.19.1 { Replacement of elements at back with same number elements in unshared list is in-place - lset version } -body { set l [freeSpaceNone] lset l $end 10 validate $l list $l [leadSpace $l] [tailSpace $l] } -result [list {0 1 2 3 4 5 6 10} 0 0] test listrep-1.20 { Replacement of elements at back with fewer elements in unshared list is in-place with space only at the back } -body { set l [lreplace [freeSpaceNone] $end-2 $end 10] validate $l list $l [leadSpace $l] [tailSpace $l] } -result [list {0 1 2 3 4 10} 0 2] test listrep-1.21 { Replacement of elements at back with more elements in unshared list allocates new representation with equal space at front and back } -body { set l [lreplace [freeSpaceNone] $end-1 $end 10 11 12] validate $l list $l [spaceEqual $l] } -result [list {0 1 2 3 4 5 10 11 12} 1] # # listrep-2.* tests all operate on shared list reps with no free space. Note the # *list internal rep* must be shared, not only the Tcl_Obj so just assigning to # another variable does not suffice. The lrange construct on an variable's value # will do the needful. test listrep-2.1 { Inserts in front of shared list with no free space should reallocate with more leading space in front - linsert version } -constraints testlistrep -body { set a [freeSpaceNone] set b [lrange $a $zero end]; # Ensure shared listrep set l [linsert $b $zero 99] validate $l list [repStoreRefCount $b] $l [leadSpaceMore $l] [repStoreRefCount $l] } -result [list 2 {99 0 1 2 3 4 5 6 7} 1 1] test listrep-2.1.1 { Inserts in front of shared list with no free space should reallocate with more leading space in front - lreplace version } -constraints testlistrep -body { set a [freeSpaceNone] set b [lrange $a $zero end]; # Ensure shared listrep set l [lreplace $b $zero -1 99] validate $l list [repStoreRefCount $b] $l [leadSpaceMore $l] [repStoreRefCount $l] } -result [list 2 {99 0 1 2 3 4 5 6 7} 1 1] test listrep-2.2 { Inserts at back of shared list with no free space should reallocate with more leading space in back - linsert version } -constraints testlistrep -body { set a [freeSpaceNone] set b [lrange $a $zero end]; # Ensure shared listrep set l [linsert $b $end 99] validate $l list [repStoreRefCount $b] $l [tailSpaceMore $l] [repStoreRefCount $l] } -result [list 2 {0 1 2 3 4 5 6 7 99} 1 1] test listrep-2.2.1 { Inserts at back of shared list with no free space should reallocate with more leading space in back - lreplace version } -constraints testlistrep -body { set a [freeSpaceNone] set b [lrange $a $zero end]; # Ensure shared listrep set l [lreplace $b $end+1 end+$one 99] validate $l list [repStoreRefCount $b] $l [tailSpaceMore $l] [repStoreRefCount $l] } -result [list 2 {0 1 2 3 4 5 6 7 99} 1 1] test listrep-2.2.2 { Inserts at back of shared list with no free space should reallocate with more leading space in back - lappend version } -constraints testlistrep -body { set a [freeSpaceNone] set b [lrange $a $zero end]; # Ensure shared listrep set l [lappend b 99] validate $l list [repStoreRefCount $b] $l [tailSpaceMore $l] [repStoreRefCount $l] } -result [list 1 {0 1 2 3 4 5 6 7 99} 1 1] test listrep-2.2.3 { Inserts at back of shared list with no free space should reallocate with more leading space in back - lset version } -constraints testlistrep -body { set a [freeSpaceNone] set b [lrange $a $zero end]; # Ensure shared listrep set l [lset b $end+1 99] validate $l list [repStoreRefCount $b] $l [tailSpaceMore $l] [repStoreRefCount $l] } -result [list 1 {0 1 2 3 4 5 6 7 99} 1 1] test listrep-2.3 { Inserts in middle of shared list with no free space should reallocate with equal spacing - linsert version } -constraints testlistrep -body { set a [freeSpaceNone] set b [lrange $a $zero end]; # Ensure shared listrep set l [linsert $b $four 99] validate $l list [repStoreRefCount $b] $l [spaceEqual $l] [repStoreRefCount $l] } -result [list 2 {0 1 2 3 99 4 5 6 7} 1 1] test listrep-2.3.1 { Inserts in middle of shared list with no free space should reallocate with equal spacing - lreplace version } -constraints testlistrep -body { set a [freeSpaceNone] set b [lrange $a $zero end]; # Ensure shared listrep set l [lreplace $b $four $four-1 99] validate $l list [repStoreRefCount $b] $l [spaceEqual $l] [repStoreRefCount $l] } -result [list 2 {0 1 2 3 99 4 5 6 7} 1 1] test listrep-2.4 { Deletes from front of small shared list with no free space should allocate new list of exact size - lreplace version } -constraints testlistrep -body { set a [freeSpaceNone] set b [lrange $a $zero end]; # Ensure shared listrep set l [lreplace $b $zero $zero] validate $l list [repStoreRefCount $b] $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list 2 {1 2 3 4 5 6 7} 0 0 1] test listrep-2.4.1 { Deletes from front of small shared list with no free space should allocate new list of exact size - lremove version } -constraints testlistrep -body { set a [freeSpaceNone] set b [lrange $a $zero end]; # Ensure shared listrep set l [lremove $b $zero $one] validate $l list [repStoreRefCount $b] $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list 2 {2 3 4 5 6 7} 0 0 1] test listrep-2.4.2 { Deletes from front of small shared list with no free space should allocate new list of exact size - lrange version } -constraints testlistrep -body { set a [freeSpaceNone] set b [lrange $a $zero end]; # Ensure shared listrep set l [lrange $b $one $end] validate $l list [repStoreRefCount $b] $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list 2 {1 2 3 4 5 6 7} 0 0 1] test listrep-2.4.3 { Deletes from front of small shared list with no free space should allocate new list of exact size - lassign version } -constraints testlistrep -body { set a [freeSpaceNone] set b [lrange $a $zero end]; # Ensure shared listrep set l [lassign $b e] validate $l list $e [repStoreRefCount $b] $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list 0 2 {1 2 3 4 5 6 7} 0 0 1] test listrep-2.4.4 { Deletes from front of small shared list with no free space should allocate new list of exact size - lpop version } -constraints testlistrep -body { set a [freeSpaceNone] set l [lrange $a $zero end]; # Ensure shared listrep set e [lpop l $zero] validate $l list $e $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list 0 {1 2 3 4 5 6 7} 0 0 1] test listrep-2.5 { Deletes from front of large shared list with no free space should create span - lreplace version } -constraints testlistrep -body { set a [freeSpaceNone 1000] set b [lrange $a $zero end]; # Ensure shared listrep set l [lreplace $b $zero $zero] validate $l # The listrep store should be shared among a, b, l (3 refs) list [sameStore $b $l] [repStoreRefCount $b] $l [hasSpan $l] [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list 1 3 [irange 1 999] 1 0 0 3] test listrep-2.5.1 { Deletes from front of large shared list with no free space should create span - lremove version } -constraints testlistrep -body { set a [freeSpaceNone 1000] set b [lrange $a $zero end]; # Ensure shared listrep set l [lremove $b $zero $one] validate $l # The listrep store should be shared among a, b, l (3 refs) list [sameStore $b $l] [repStoreRefCount $b] $l [hasSpan $l] [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list 1 3 [irange 2 999] 1 0 0 3] test listrep-2.5.2 { Deletes from front of large shared list with no free space should create span - lrange version } -constraints testlistrep -body { set a [freeSpaceNone 1000] set b [lrange $a $zero end]; # Ensure shared listrep set l [lrange $b $two $end] validate $l # The listrep store should be shared among a, b, l (3 refs) list [sameStore $b $l] [repStoreRefCount $b] $l [hasSpan $l] [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list 1 3 [irange 2 999] 1 0 0 3] test listrep-2.5.3 { Deletes from front of large shared list with no free space should create span - lassign version } -constraints testlistrep -body { set a [freeSpaceNone 1000] set b [lrange $a $zero end]; # Ensure shared listrep set l [lassign $b e] validate $l # The listrep store should be shared among a, b, l (3 refs) list $e [sameStore $b $l] [repStoreRefCount $b] $l [hasSpan $l] [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list 0 1 3 [irange 1 999] 1 0 0 3] test listrep-2.5.4 { Deletes from front of large shared list with no free space should create span - lpop version } -constraints testlistrep -body { set a [freeSpaceNone 1000] set l [lrange $a $zero end]; # Ensure shared listrep set e [lpop l $zero] validate $l # The listrep store should be shared among a, b, l (3 refs) list $e $l [hasSpan $l] [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list 0 [irange 1 999] 1 0 0 2] test listrep-2.6 { Deletes from back of small shared list with no free space should allocate new list of exact size - lreplace version } -constraints testlistrep -body { set a [freeSpaceNone] set b [lrange $a $zero end]; # Ensure shared listrep set l [lreplace $b $end $end] validate $l list [repStoreRefCount $b] $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list 2 {0 1 2 3 4 5 6} 0 0 1] test listrep-2.6.1 { Deletes from back of small shared list with no free space should allocate new list of exact size - lremove version } -constraints testlistrep -body { set a [freeSpaceNone] set b [lrange $a $zero end]; # Ensure shared listrep set l [lremove $b $end $end-1] validate $l list [repStoreRefCount $b] $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list 2 {0 1 2 3 4 5} 0 0 1] test listrep-2.6.2 { Deletes from back of small shared list with no free space should allocate new list of exact size - lrange version } -constraints testlistrep -body { set a [freeSpaceNone] set b [lrange $a $zero end]; # Ensure shared listrep set l [lrange $b $zero $end-1] validate $l list [repStoreRefCount $b] $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list 2 {0 1 2 3 4 5 6} 0 0 1] test listrep-2.6.3 { Deletes from back of small shared list with no free space should allocate new list of exact size - lpop version } -constraints testlistrep -body { set a [freeSpaceNone] set l [lrange $a $zero end]; # Ensure shared listrep set e [lpop l] validate $l list $e $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list 7 {0 1 2 3 4 5 6} 0 0 1] test listrep-2.7 { Deletes from back of large shared list with no free space should use a span - lreplace version } -constraints testlistrep -body { set a [freeSpaceNone 1000] set b [lrange $a $zero end]; # Ensure shared listrep set l [lreplace $b $end $end] validate $l # Note lead and tail space is 0 because original list store in a,b is used list [repStoreRefCount $b] $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list 3 [irange 0 998] 0 0 3] test listrep-2.7.1 { Deletes from back of large shared list with no free space should use a span - lremove version } -constraints testlistrep -body { set a [freeSpaceNone 1000] set b [lrange $a $zero end]; # Ensure shared listrep set l [lremove $b $end-1 $end] validate $l # Note lead and tail space is 0 because original list store in a,b is used list [repStoreRefCount $b] $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list 3 [irange 0 997] 0 0 3] test listrep-2.7.2 { Deletes from back of large shared list with no free space should use a span - lrange version } -constraints testlistrep -body { set a [freeSpaceNone 1000] set b [lrange $a $zero end]; # Ensure shared listrep set l [lrange $b $zero $end-1] validate $l # Note lead and tail space is 0 because original list store in a,b is used list [repStoreRefCount $b] $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list 3 [irange 0 998] 0 0 3] test listrep-2.7.3 { Deletes from back of large shared list with no free space should use a span - lpop version } -constraints testlistrep -body { set a [freeSpaceNone 1000] set l [lrange $a $zero end]; # Ensure shared listrep set e [lpop l] validate $l # Note lead and tail space is 0 because original list store in a,b is used list $e $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list 999 [irange 0 998] 0 0 2] test listrep-2.8 { no-op on shared list should force a canonical list representation with original unchanged - lreplace version } -body { set l { 1 2 3 4 } list [lreplace $l $zero -1] $l } -result [list {1 2 3 4} { 1 2 3 4 }] test listrep-2.8.1 { no-op on shared list should force a canonical list representation with original unchanged - lrange version } -body { set l { 1 2 3 4 } list [lrange $l $zero end] $l } -result [list {1 2 3 4} { 1 2 3 4 }] test listrep-2.9 { Appends to back of large shared list with no free space allocates new list with space only at the back - lreplace version } -constraints testlistrep -body { set a [freeSpaceNone 1000] set b [lrange $a $zero end]; # Ensure shared listrep set l [lreplace $b $end+1 $end+1 1000] validate $l list [repStoreRefCount $b] $l [leadSpace $l] [expr {[tailSpace $l]>0}] [repStoreRefCount $l] } -result [list 2 [irange 0 1000] 0 1 1] test listrep-2.9.1 { Appends to back of large shared list with no free space allocates new list with space only at the back - linsert version } -constraints testlistrep -body { set a [freeSpaceNone 1000] set b [lrange $a $zero end]; # Ensure shared listrep set l [linsert $b $end+1 1000 1001] validate $l list [repStoreRefCount $b] $l [leadSpace $l] [expr {[tailSpace $l]>0}] [repStoreRefCount $l] } -result [list 2 [irange 0 1001] 0 1 1] test listrep-2.9.2 { Appends to back of large shared list with no free space allocates new list with space only at the back - lappend version } -constraints testlistrep -body { set a [freeSpaceNone 1000] set l [lrange $a $zero end]; # Ensure shared listrep lappend l 1000 validate $l list $l [leadSpace $l] [expr {[tailSpace $l]>0}] [repStoreRefCount $l] } -result [list [irange 0 1000] 0 1 1] test listrep-2.9.3 { Appends to back of large shared list with no free space allocates new list with space only at the back - lset version } -constraints testlistrep -body { set a [freeSpaceNone 1000] set l [lrange $a $zero end]; # Ensure shared listrep lset l $end+1 1000 validate $l list $l [leadSpace $l] [expr {[tailSpace $l]>0}] [repStoreRefCount $l] } -result [list [irange 0 1000] 0 1 1] test listrep-2.10 { Replacement of elements at front with same number in shared list results in a new list store with more space in front than back - lreplace version } -constraints testlistrep -body { set a [freeSpaceNone] set b [lrange $a $zero end]; # Ensure shared listrep set l [lreplace $b $zero $one 10 11] validate $l list [repStoreRefCount $b] $l [leadSpaceMore $l] [repStoreRefCount $l] } -result [list 2 {10 11 2 3 4 5 6 7} 1 1] test listrep-2.10.1 { Replacement of elements at front with same number in shared list results in a new list store with no extra space - lset version } -constraints testlistrep -body { set a [freeSpaceNone] set l [lrange $a $zero end]; # Ensure shared listrep lset l $zero 10 validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list {10 1 2 3 4 5 6 7} 0 0 1] test listrep-2.11 { Replacement of elements at front with fewer elements in shared list results in a new list store with more space in front than back } -constraints testlistrep -body { set a [freeSpaceNone] set b [lrange $a $zero end]; # Ensure shared listrep set l [lreplace $b $zero $four 10] validate $l list [repStoreRefCount $b] $l [leadSpaceMore $l] [repStoreRefCount $l] } -result [list 2 {10 5 6 7} 1 1] test listrep-2.12 { Replacement of elements at front with more elements in shared list results in a new spanned list with more space in front } -constraints testlistrep -body { set a [freeSpaceNone] set b [lrange $a $zero end]; # Ensure shared listrep set l [lreplace $b $zero $one 10 11 12] validate $l list [repStoreRefCount $b] $l [leadSpaceMore $l] [repStoreRefCount $l] } -result [list 2 {10 11 12 2 3 4 5 6 7} 1 1] test listrep-2.13 { Replacement of elements in middle with same number in shared list results in a new list store with equal space in front and back - lreplace version } -constraints testlistrep -body { set a [freeSpaceNone] set b [lrange $a $zero end]; # Ensure shared listrep set l [lreplace $b $one $two 10 11] validate $l list [repStoreRefCount $b] $l [spaceEqual $l] [repStoreRefCount $l] } -result [list 2 {0 10 11 3 4 5 6 7} 1 1] test listrep-2.13.1 { Replacement of elements in middle with same number in shared list results in a new list store with exact allocation - lset version } -constraints testlistrep -body { set a [freeSpaceNone] set l [lrange $a $zero end]; # Ensure shared listrep lset l $one 10 validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list {0 10 2 3 4 5 6 7} 0 0 1] test listrep-2.14 { Replacement of elements in middle with fewer elements in shared list results in a new list store with equal space } -constraints testlistrep -body { set a [freeSpaceNone] set b [lrange $a $zero end]; # Ensure shared listrep set l [lreplace $b $one 5 10] validate $l list [repStoreRefCount $b] $l [spaceEqual $l] [repStoreRefCount $l] } -result [list 2 {0 10 6 7} 1 1] test listrep-2.15 { Replacement of elements in middle with more elements in shared list results in a new spanned list with space in front and back } -constraints testlistrep -body { set a [freeSpaceNone] set b [lrange $a $zero end]; # Ensure shared listrep set l [lreplace $b $one $two 10 11 12] validate $l list [repStoreRefCount $b] $l [spaceEqual $l] [repStoreRefCount $l] } -result [list 2 {0 10 11 12 3 4 5 6 7} 1 1] test listrep-2.16 { Replacement of elements at back with same number in shared list results in a new list store with more space in back than front - lreplace version } -constraints testlistrep -body { set a [freeSpaceNone] set b [lrange $a $zero end]; # Ensure shared listrep set l [lreplace $b end-$one $end 10 11] validate $l list [repStoreRefCount $b] $l [tailSpaceMore $l] [repStoreRefCount $l] } -result [list 2 {0 1 2 3 4 5 10 11} 1 1] test listrep-2.16.1 { Replacement of elements at back with same number in shared list results in a new list store with no extra - lreplace version } -constraints testlistrep -body { set a [freeSpaceNone] set l [lrange $a $zero end]; # Ensure shared listrep lset l $end 10 validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list {0 1 2 3 4 5 6 10} 0 0 1] test listrep-2.17 { Replacement of elements at back with fewer elements in shared list results in a new list store with more space in back than front } -constraints testlistrep -body { set a [freeSpaceNone] set b [lrange $a $zero end]; # Ensure shared listrep set l [lreplace $b end-$four $end 10] validate $l list [repStoreRefCount $b] $l [tailSpaceMore $l] [repStoreRefCount $l] } -result [list 2 {0 1 2 10} 1 1] test listrep-2.18 { Replacement of elements at back with more elements in shared list results in a new list store with more space in back than front } -constraints testlistrep -body { set a [freeSpaceNone] set b [lrange $a $zero end]; # Ensure shared listrep set l [lreplace $b end-$four $end 10] validate $l list [repStoreRefCount $b] $l [tailSpaceMore $l] [repStoreRefCount $l] } -result [list 2 {0 1 2 10} 1 1] # # listrep-3.* - tests on unshared spanned listreps test listrep-3.1 { Inserts in front of unshared spanned list with room in front should just shrink the lead space - linsert version } -constraints testlistrep -body { set l [linsert [freeSpaceBoth] $zero -2 -1] validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list [irange -2 7] 1 3 1] test listrep-3.1.1 { Inserts in front of unshared spanned list with room in front should just shrink the lead space - lreplace version } -constraints testlistrep -body { set l [lreplace [freeSpaceBoth] $zero -1 -2 -1] validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list [irange -2 7] 1 3 1] test listrep-3.2 { Inserts in front of unshared spanned list with insufficient room in front but enough total freespace should redistribute free space - linsert version } -constraints testlistrep -body { set l [linsert [freeSpaceBoth 8 1 10] $zero -2 -1] validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list [irange -2 7] 5 4 1] test listrep-3.2.1 { Inserts in front of unshared spanned list with insufficient room in front but enough total freespace should redistribute free space - lreplace version } -constraints testlistrep -body { set l [lreplace [freeSpaceBoth 8 1 10] $zero -1 -2 -1] validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list [irange -2 7] 5 4 1] test listrep-3.3 { Inserts in front of unshared spanned list with insufficient total freespace should reallocate with equal free space - linsert version } -constraints testlistrep -body { set l [linsert [freeSpaceBoth 8 1 1] $zero -3 -2 -1] validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list [irange -3 7] 6 5 1] test listrep-3.3.1 { Inserts in front of unshared spanned list with insufficient total freespace should reallocate with equal free space - lreplace version } -constraints testlistrep -body { set l [lreplace [freeSpaceBoth 8 1 1] $zero -1 -3 -2 -1] validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list [irange -3 7] 6 5 1] test listrep-3.4 { Inserts at back of unshared spanned list with room at back should not reallocate - linsert version } -constraints testlistrep -body { set l [linsert [freeSpaceBoth] $end 8] validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list [irange 0 8] 3 2 1] test listrep-3.4.1 { Inserts at back of unshared spanned list with room at back should not reallocate - lreplace version } -constraints testlistrep -body { set l [lreplace [freeSpaceBoth] $end+1 $end+1 8 9] validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list [irange 0 9] 3 1 1] test listrep-3.4.2 { Inserts at back of unshared spanned list with room at back should not reallocate - lappend version } -constraints testlistrep -body { set l [freeSpaceBoth] lappend l 8 9 10 validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list [irange 0 10] 3 0 1] test listrep-3.4.3 { Inserts at back of unshared spanned list with room at back should not reallocate - lset version } -constraints testlistrep -body { set l [freeSpaceBoth] lset l $end+1 8 validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list [irange 0 8] 3 2 1] test listrep-3.5 { Inserts at back of unshared spanned list with insufficient room in back but enough total freespace should redistribute free space - linsert version } -constraints testlistrep -body { set l [linsert [freeSpaceBoth 8 10 1] $end 8 9] validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list [irange 0 9] 5 4 1] test listrep-3.5.1 { Inserts at back of unshared spanned list with insufficient room in back but enough total freespace should redistribute free space - lreplace version } -constraints testlistrep -body { set l [lreplace [freeSpaceBoth 8 10 1] $end+1 $end+1 8 9] validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list [irange 0 9] 5 4 1] test listrep-3.5.2 { Inserts at back of unshared spanned list with insufficient room in back but enough total freespace should redistribute free space - lappend version } -constraints testlistrep -body { set l [freeSpaceBoth 8 10 1] lappend l 8 9 validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list [irange 0 9] 5 4 1] test listrep-3.5.3 { Inserts at back of unshared spanned list with insufficient room in back but enough total freespace should redistribute free space - lset version } -constraints testlistrep -body { set l [freeSpaceBoth 8 10 0] lset l $end+1 8 validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list [irange 0 8] 5 4 1] test listrep-3.6 { Inserts in back of unshared spanned list with insufficient total freespace should reallocate with all *additional* space at back. Note this differs from the insert in front case because here we realloc(). - linsert version } -constraints testlistrep -body { set l [linsert [freeSpaceBoth 8 1 1] $end 8 9 10] validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list [irange 0 10] 1 10 1] test listrep-3.6.1 { Inserts in back of unshared spanned list with insufficient total freespace should reallocate with all *additional* space at back. Note this differs from the insert in front case because here we realloc() - lreplace version } -constraints testlistrep -body { set l [lreplace [freeSpaceBoth 8 1 1] $end+1 $end+1 8 9 10] validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list [irange 0 10] 1 10 1] test listrep-3.6.2 { Inserts in back of unshared spanned list with insufficient total freespace should reallocate with all *additional* space at back. Note this differs from the insert in front case because here we realloc() - lappend version } -constraints testlistrep -body { set l [freeSpaceBoth 8 1 1] lappend l 8 9 10 validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list [irange 0 10] 1 10 1] test listrep-3.6.3 { Inserts in back of unshared spanned list with insufficient total freespace should reallocate with all *additional* space at back. Note this differs from the insert in front case because here we realloc() - lset version } -constraints testlistrep -body { set l [freeSpaceNone] lset l $end+1 8 validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list [irange 0 8] 0 9 1] test listrep-3.7 { Inserts in front half of unshared spanned list with room in front should not reallocate and should move front segment } -constraints testlistrep -body { set l [linsert [freeSpaceBoth] $one -2 -1] validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list {0 -2 -1 1 2 3 4 5 6 7} 1 3 1] test listrep-3.8 { Inserts in front half of unshared spanned list with insufficient leading space but with enough tail space - linsert version } -constraints testlistrep -body { set l [linsert [freeSpaceBoth 8 1 5] $one -2 -1] validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list {0 -2 -1 1 2 3 4 5 6 7} 1 3 1] test listrep-3.8.1 { Inserts in front half of unshared spanned list with insufficient leading space but with enough tail space - lreplace version } -constraints testlistrep -body { set l [lreplace [freeSpaceBoth 8 1 5] $one -1 -2 -1] validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list {0 -2 -1 1 2 3 4 5 6 7} 1 3 1] test listrep-3.9 { Inserts in front half of unshared spanned list with sufficient total free space - linsert version } -constraints testlistrep -body { set l [linsert [freeSpaceBoth 8 2 2] $one -3 -2 -1] validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list {0 -3 -2 -1 1 2 3 4 5 6 7} 0 1 1] test listrep-3.9.1 { Inserts in front half of unshared spanned list with sufficient total free space - lreplace version } -constraints testlistrep -body { set l [lreplace [freeSpaceBoth 8 2 2] $one -1 -3 -2 -1] validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list {0 -3 -2 -1 1 2 3 4 5 6 7} 0 1 1] test listrep-3.10 { Inserts in front half of unshared spanned list with insufficient total space. Note use of realloc() means new space will be at the back - linsert version } -constraints testlistrep -body { set l [linsert [freeSpaceBoth 8 1 1] $one -3 -2 -1] validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list {0 -3 -2 -1 1 2 3 4 5 6 7} 1 10 1] test listrep-3.10.1 { Inserts in front half of unshared spanned list with insufficient total space. Note use of realloc() means new space will be at the back - lreplace version } -constraints testlistrep -body { set l [lreplace [freeSpaceBoth 8 1 1] $one -1 -3 -2 -1] validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list {0 -3 -2 -1 1 2 3 4 5 6 7} 1 10 1] test listrep-3.11 { Inserts in back half of unshared spanned list with room in back should not reallocate and should move back segment - linsert version } -constraints testlistrep -body { set l [linsert [freeSpaceBoth] $end-$one 8 9] validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list {0 1 2 3 4 5 6 8 9 7} 3 1 1] test listrep-3.11.1 { Inserts in back half of unshared spanned list with room in back should not reallocate and should move back segment - lreplace version } -constraints testlistrep -body { set l [lreplace [freeSpaceBoth] $end -1 8 9] validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list {0 1 2 3 4 5 6 8 9 7} 3 1 1] test listrep-3.12 { Inserts in back half of unshared spanned list with insufficient tail space but with enough leading space - linsert version } -constraints testlistrep -body { set l [linsert [freeSpaceBoth 8 5 1] $end-$one 8 9] validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list {0 1 2 3 4 5 6 8 9 7} 3 1 1] test listrep-3.12.1 { Inserts in back half of unshared spanned list with insufficient tail space but with enough leading space - lreplace version } -constraints testlistrep -body { set l [lreplace [freeSpaceBoth 8 5 1] $end -1 8 9] validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list {0 1 2 3 4 5 6 8 9 7} 3 1 1] test listrep-3.13 { Inserts in back half of unshared spanned list with sufficient total free space - linsert version } -constraints testlistrep -body { set l [linsert [freeSpaceBoth 8 2 2] $end-$one 8 9 10] validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list {0 1 2 3 4 5 6 8 9 10 7} 0 1 1] test listrep-3.13.1 { Inserts in back half of unshared spanned list with sufficient total free space - lreplace version } -constraints testlistrep -body { set l [lreplace [freeSpaceBoth 8 2 2] $end -1 8 9 10] validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list {0 1 2 3 4 5 6 8 9 10 7} 0 1 1] test listrep-3.14 { Inserts in back half of unshared spanned list with insufficient total space. Note use of realloc() means new space will be at the back - linsert version } -constraints testlistrep -body { set l [linsert [freeSpaceBoth 8 1 1] $end-$one 8 9 10] validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list {0 1 2 3 4 5 6 8 9 10 7} 1 10 1] test listrep-3.14.1 { Inserts in back half of unshared spanned list with insufficient total space. Note use of realloc() means new space will be at the back - lrepalce version } -constraints testlistrep -body { set l [lreplace [freeSpaceBoth 8 1 1] $end -1 8 9 10] validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list {0 1 2 3 4 5 6 8 9 10 7} 1 10 1] test listrep-3.15 { Deletes from front of small unshared span list results in elements moved up front and span removal - lreplace version } -constraints testlistrep -body { set l [lreplace [freeSpaceBoth] $zero $zero] validate $l list $l [leadSpace $l] [tailSpace $l] [hasSpan $l] } -result [list {1 2 3 4 5 6 7} 0 7 0] test listrep-3.15.1 { Deletes from front of small unshared span list results in elements moved up front and span removal - lremove version } -constraints testlistrep -body { set l [lremove [freeSpaceBoth] $zero $one] validate $l list $l [leadSpace $l] [tailSpace $l] [hasSpan $l] } -result [list {2 3 4 5 6 7} 0 8 0] test listrep-3.15.2 { Deletes from front of small unshared span list results in elements moved up front and span removal - lrange version } -constraints testlistrep -body { set l [lrange [freeSpaceBoth] $one $end] validate $l list $l [leadSpace $l] [tailSpace $l] [hasSpan $l] } -result [list {1 2 3 4 5 6 7} 0 7 0] test listrep-3.15.3 { Deletes from front of small unshared span list results in elements moved up front and span removal - lassign version } -constraints testlistrep -body { set l [lassign [freeSpaceBoth] e] validate $l list $e $l [leadSpace $l] [tailSpace $l] [hasSpan $l] } -result [list 0 {1 2 3 4 5 6 7} 0 7 0] test listrep-3.15.4 { Deletes from front of small unshared span list results in elements moved up front and span removal - lpop version } -constraints testlistrep -body { set l [freeSpaceBoth] set e [lpop l $zero] validate $l list $l [leadSpace $l] [tailSpace $l] [hasSpan $l] } -result [list {1 2 3 4 5 6 7} 0 7 0] test listrep-3.16 { Deletes from front of large unshared span list results in another span - lreplace version } -constraints testlistrep -body { set l [lreplace [freeSpaceBoth 1000 10 10] $zero $one] validate $l list $l [leadSpace $l] [tailSpace $l] [hasSpan $l 12 998] } -result [list [irange 2 999] 12 10 1] test listrep-3.16.1 { Deletes from front of large unshared span list results in another span - lremove version } -constraints testlistrep -body { set l [lremove [freeSpaceBoth 1000 10 10] $zero $one] validate $l list $l [leadSpace $l] [tailSpace $l] [hasSpan $l 12 998] } -result [list [irange 2 999] 12 10 1] test listrep-3.16.2 { Deletes from front of large unshared span list results in another span - lrange version } -constraints testlistrep -body { set l [lrange [freeSpaceBoth 1000 10 10] $two $end] validate $l list $l [leadSpace $l] [tailSpace $l] [hasSpan $l 12 998] } -result [list [irange 2 999] 12 10 1] test listrep-3.16.3 { Deletes from front of large unshared span list results in another span - lassign version } -constraints testlistrep -body { set l [lassign [freeSpaceBoth 1000 10 10] e] validate $l list $e $l [leadSpace $l] [tailSpace $l] [hasSpan $l 11 999] } -result [list 0 [irange 1 999] 11 10 1] test listrep-3.16.4 { Deletes from front of large unshared span list results in another span - lpop version } -constraints testlistrep -body { set l [freeSpaceBoth 1000 10 10] set e [lpop l $zero] validate $l list $e $l [leadSpace $l] [tailSpace $l] [hasSpan $l 11 999] } -result [list 0 [irange 1 999] 11 10 1] test listrep-3.17 { Deletes from back of small unshared span list results in new store without span - lreplace version } -constraints testlistrep -body { set l [lreplace [freeSpaceBoth] $end $end] validate $l list $l [leadSpace $l] [tailSpace $l] [hasSpan $l] } -result [list {0 1 2 3 4 5 6} 0 7 0] test listrep-3.17.1 { Deletes from back of small unshared span list results in new store without span - lremove version } -constraints testlistrep -body { set l [lremove [freeSpaceBoth] $end] validate $l list $l [leadSpace $l] [tailSpace $l] [hasSpan $l] } -result [list {0 1 2 3 4 5 6} 0 7 0] test listrep-3.17.2 { Deletes from back of small unshared span list results in new store without span - lrange version } -constraints testlistrep -body { set l [lrange [freeSpaceBoth] $zero $end-1] validate $l list $l [leadSpace $l] [tailSpace $l] [hasSpan $l] } -result [list {0 1 2 3 4 5 6} 0 7 0] test listrep-3.17.3 { Deletes from back of small unshared span list results in new store without span - lpop version } -constraints testlistrep -body { set l [freeSpaceBoth] set e [lpop l] validate $l list $e $l [leadSpace $l] [tailSpace $l] [hasSpan $l] } -result [list 7 {0 1 2 3 4 5 6} 0 7 0] test listrep-3.18 { Deletes from back of large unshared span list results in another span - lreplace version } -constraints testlistrep -body { set l [lreplace [freeSpaceBoth 1000 10 10] $end-1 $end] validate $l list $l [leadSpace $l] [tailSpace $l] [hasSpan $l 10 998] } -result [list [irange 0 997] 10 12 1] test listrep-3.18.1 { Deletes from back of large unshared span list results in another span - lremove version } -constraints testlistrep -body { set l [lremove [freeSpaceBoth 1000 10 10] $end-1 $end] validate $l list $l [leadSpace $l] [tailSpace $l] [hasSpan $l 10 998] } -result [list [irange 0 997] 10 12 1] test listrep-3.18.2 { Deletes from back of large unshared span list results in another span - lrange version } -constraints testlistrep -body { set l [lrange [freeSpaceBoth 1000 10 10] $zero $end-2] validate $l list $l [leadSpace $l] [tailSpace $l] [hasSpan $l 10 998] } -result [list [irange 0 997] 10 12 1] test listrep-3.18.3 { Deletes from back of large unshared span list results in another span - lpop version } -constraints testlistrep -body { set l [freeSpaceBoth 1000 10 10] set e [lpop l] validate $l list $e $l [leadSpace $l] [tailSpace $l] [hasSpan $l 10 999] } -result [list 999 [irange 0 998] 10 11 1] test listrep-3.19 { Deletes from front half of small unshared span list results in movement of smaller front segment - lreplace version } -constraints testlistrep -body { set l [lreplace [freeSpaceBoth] $one $two] validate $l list $l [leadSpace $l] [tailSpace $l] [hasSpan $l 5 6] } -result [list {0 3 4 5 6 7} 5 3 1] test listrep-3.19.1 { Deletes from front half of small unshared span list results in movement of smaller front segment - lremove version } -constraints testlistrep -body { set l [lremove [freeSpaceBoth] $one $two] validate $l list $l [leadSpace $l] [tailSpace $l] [hasSpan $l 5 6] } -result [list {0 3 4 5 6 7} 5 3 1] test listrep-3.20 { Deletes from front half of large unshared span list results in movement of smaller front segment - lreplace version } -constraints testlistrep -body { set l [lreplace [freeSpaceBoth 1000 10 10] $one $two] validate $l list $l [leadSpace $l] [tailSpace $l] [hasSpan $l 12 998] } -result [list [list 0 {*}[irange 3 999]] 12 10 1] test listrep-3.20.1 { Deletes from front half of large unshared span list results in movement of smaller front segment - lremove version } -constraints testlistrep -body { set l [lremove [freeSpaceBoth 1000 10 10] $one $two] validate $l list $l [leadSpace $l] [tailSpace $l] [hasSpan $l 12 998] } -result [list [list 0 {*}[irange 3 999]] 12 10 1] test listrep-3.21 { Deletes from back half of small unshared span list results in movement of smaller back segment - lreplace version } -constraints testlistrep -body { set l [lreplace [freeSpaceBoth] $end-2 $end-1] validate $l list $l [leadSpace $l] [tailSpace $l] [hasSpan $l 3 6] } -result [list {0 1 2 3 4 7} 3 5 1] test listrep-3.21.1 { Deletes from back half of small unshared span list results in movement of smaller back segment - lremove version } -constraints testlistrep -body { set l [lremove [freeSpaceBoth] $end-2 $end-1] validate $l list $l [leadSpace $l] [tailSpace $l] [hasSpan $l 3 6] } -result [list {0 1 2 3 4 7} 3 5 1] test listrep-3.22 { Deletes from back half of large unshared span list results in movement of smaller back segment - lreplace version } -constraints testlistrep -body { set l [lreplace [freeSpaceBoth 1000 10 10] $end-2 $end-1] validate $l list $l [leadSpace $l] [tailSpace $l] [hasSpan $l 10 998] } -result [list [list {*}[irange 0 996] 999] 10 12 1] test listrep-3.22.1 { Deletes from back half of large unshared span list results in movement of smaller back segment - lremove version } -constraints testlistrep -body { set l [lremove [freeSpaceBoth 1000 10 10] $end-2 $end-1] validate $l list $l [leadSpace $l] [tailSpace $l] [hasSpan $l 10 998] } -result [list [list {*}[irange 0 996] 999] 10 12 1] test listrep-3.23 { Replacement of elements at front with same number elements in unshared spanned list is in-place - lreplace version } -body { set l [lreplace [freeSpaceBoth] $zero $one 10 11] list $l [leadSpace $l] [tailSpace $l] } -result [list {10 11 2 3 4 5 6 7} 3 3] test listrep-3.23.1 { Replacement of elements at front with same number elements in unshared spanned list is in-place - lset version } -body { set l [freeSpaceBoth] lset l $zero 10 list $l [leadSpace $l] [tailSpace $l] } -result [list {10 1 2 3 4 5 6 7} 3 3] test listrep-3.24 { Replacement of elements at front with fewer elements in unshared spanned list expands leading space - lreplace version } -body { set l [lreplace [freeSpaceBoth] $zero $four 10] list $l [leadSpace $l] [tailSpace $l] } -result [list {10 5 6 7} 7 3] test listrep-3.25 { Replacement of elements at front with more elements in unshared spanned list with sufficient leading space shrinks leading space } -body { set l [lreplace [freeSpaceBoth] $zero $one 10 11 12] list $l [leadSpace $l] [tailSpace $l] } -result [list {10 11 12 2 3 4 5 6 7} 2 3] test listrep-3.26 { Replacement of elements at front with more elements in unshared spanned list with insufficient leading space but sufficient total free space } -constraints testlistrep -body { set l [lreplace [freeSpaceBoth 8 1 10] $zero $one 10 11 12 13] validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list {10 11 12 13 2 3 4 5 6 7} 5 4 1] test listrep-3.27 { Replacement of elements at front in unshared spanned list with insufficient total freespace should reallocate with equal free space } -constraints testlistrep -body { set l [lreplace [freeSpaceBoth 8 1 1] $zero $one 10 11 12 13 14] validate $l list $l [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list {10 11 12 13 14 2 3 4 5 6 7} 6 5 1] test listrep-3.28 { Replacement of elements at back with same number of elements in unshared spanned list is in-place - lreplace version } -body { set l [lreplace [freeSpaceBoth] $end-1 $end 10 11] validate $l list $l [leadSpace $l] [tailSpace $l] } -result [list {0 1 2 3 4 5 10 11} 3 3] test listrep-3.28.1 { Replacement of elements at back with same number of elements in unshared spanned list is in-place - lset version } -body { set l [freeSpaceBoth] lset l $end 10 validate $l list $l [leadSpace $l] [tailSpace $l] } -result [list {0 1 2 3 4 5 6 10} 3 3] test listrep-3.29 { Replacement of elements at back with fewer elements in unshared spanned list expands tail space } -body { set l [lreplace [freeSpaceBoth] $end-2 $end 10] validate $l list $l [leadSpace $l] [tailSpace $l] } -result [list {0 1 2 3 4 10} 3 5] test listrep-3.30 { Replacement of elements at back with more elements in unshared spanned list with sufficient tail space shrinks tailspace } -body { set l [lreplace [freeSpaceBoth] $end-1 $end 10 11 12] validate $l list $l [leadSpace $l] [tailSpace $l] } -result [list {0 1 2 3 4 5 10 11 12} 3 2] test listrep-3.31 { Replacement of elements at back with more elements in unshared spanned list with insufficient tail space but enough total free space moves up the span } -body { set l [lreplace [freeSpaceBoth 8 2 2] $end-1 $end 10 11 12 13 14] validate $l list $l [leadSpace $l] [tailSpace $l] } -result [list {0 1 2 3 4 5 10 11 12 13 14} 0 1] test listrep-3.32 { Replacement of elements at back with more elements in unshared spanned list with insufficient total space reallocates with more room in the tail because of realloc() } -body { set l [lreplace [freeSpaceBoth 8 1 1] $end-1 $end 10 11 12 13 14] validate $l list $l [leadSpace $l] [tailSpace $l] } -result [list {0 1 2 3 4 5 10 11 12 13 14} 1 10] test listrep-3.33 { Replacement of elements in the middle in an unshared spanned list with the same number of elements - lreplace version } -body { set l [lreplace [freeSpaceBoth] $two $four 10 11 12] validate $l list $l [leadSpace $l] [tailSpace $l] } -result [list {0 1 10 11 12 5 6 7} 3 3] test listrep-3.33.1 { Replacement of elements in the middle in an unshared spanned list with the same number of elements - lset version } -body { set l [freeSpaceBoth] lset l $two 10 validate $l list $l [leadSpace $l] [tailSpace $l] } -result [list {0 1 10 3 4 5 6 7} 3 3] test listrep-3.34 { Replacement of elements in an unshared spanned list with fewer elements in the front half moves the front (smaller) segment } -body { set l [lreplace [freeSpaceBoth] $two $four 10 11] validate $l list $l [leadSpace $l] [tailSpace $l] } -result [list {0 1 10 11 5 6 7} 4 3] test listrep-3.35 { Replacement of elements in an unshared spanned list with fewer elements in the back half moves the tail (smaller) segment } -body { set l [lreplace [freeSpaceBoth] $end-2 $end-1 10] validate $l list $l [leadSpace $l] [tailSpace $l] } -result [list {0 1 2 3 4 10 7} 3 4] test listrep-3.36 { Replacement of elements in an unshared spanned list with more elements when both front and back have room should move the smaller segment (front case) } -body { set l [lreplace [freeSpaceBoth] $one $two 8 9 10] validate $l list $l [leadSpace $l] [tailSpace $l] } -result [list {0 8 9 10 3 4 5 6 7} 2 3] test listrep-3.37 { Replacement of elements in an unshared spanned list with more elements when both front and back have room should move the smaller segment (back case) } -body { set l [lreplace [freeSpaceBoth] $end-2 $end-1 8 9 10] validate $l list $l [leadSpace $l] [tailSpace $l] } -result [list {0 1 2 3 4 8 9 10 7} 3 2] test listrep-3.38 { Replacement of elements in an unshared spanned list with more elements when only front has room } -body { set l [lreplace [freeSpaceBoth 8 3 1] $end-1 $end-1 8 9 10] validate $l list $l [leadSpace $l] [tailSpace $l] } -result [list {0 1 2 3 4 5 8 9 10 7} 1 1] test listrep-3.39 { Replacement of elements in an unshared spanned list with more elements when only back has room } -body { set l [lreplace [freeSpaceBoth 8 1 3] $one $one 8 9 10] validate $l list $l [leadSpace $l] [tailSpace $l] } -result [list {0 8 9 10 2 3 4 5 6 7} 1 1] test listrep-3.40 { Replacement of elements in an unshared spanned list with more elements when neither send has enough room by itself } -body { set l [lreplace [freeSpaceBoth] $one $one 8 9 10 11 12] validate $l list $l [leadSpace $l] [tailSpace $l] } -result [list {0 8 9 10 11 12 2 3 4 5 6 7} 1 1] test listrep-3.41 { Replacement of elements in an unshared spanned list with more elements when there is not enough free space results in new allocation. The back end has more space because of realloc() } -body { set l [lreplace [freeSpaceBoth 8 1 1] $one $one 8 9 10 11 12] validate $l list $l [leadSpace $l] [tailSpace $l] } -result [list {0 8 9 10 11 12 2 3 4 5 6 7} 1 11] # # 4.* - tests on shared spanned lists test listrep-4.1 { Inserts in front of shared spanned list with used elements in lead space creates new list rep with more lead than tail space - linsert version } -constraints testlistrep -body { set master [freeSpaceNone 1000] set spanl [lrange $master $two $end-2] set l [linsert $spanl $zero -1] validate $l list $master $spanl $l [leadSpaceMore $l] [hasSpan $l] [repStoreRefCount $master] [repStoreRefCount $spanl] [repStoreRefCount $l] } -result [list [irange 0 999] [irange 2 997] [list -1 {*}[irange 2 997]] 1 1 2 2 1] test listrep-4.1.1 { Inserts in front of shared spanned list with used elements in lead space creates new list rep with more lead than tail space - lreplace version } -constraints testlistrep -body { set master [freeSpaceNone 1000] set spanl [lrange $master $two $end-2] set l [lreplace $spanl $zero -1 -2] validate $l list $master $spanl $l [leadSpaceMore $l] [hasSpan $l] [repStoreRefCount $master] [repStoreRefCount $spanl] [repStoreRefCount $l] } -result [list [irange 0 999] [irange 2 997] [list -2 {*}[irange 2 997]] 1 1 2 2 1] test listrep-4.2 { Inserts in front of shared spanned list with orphaned leading elements allocate a new list rep with more lead than tail space - linsert version TODO - ideally this should garbage collect the orphans and reuse the lead space but that needs a "lprepend" command else the listrep operand is shared and hence orphans cannot be freed } -constraints testlistrep -body { set master [freeSpaceLead 1000 100] set spanl [lrange $master $two $end-2] unset master; # So elements at 0, 1 are not used set l [linsert $spanl $zero -1] validate $l list $spanl $l [sameStore $spanl $l] [leadSpaceMore $l] [hasSpan $l] [repStoreRefCount $spanl] [repStoreRefCount $l] } -result [list [irange 2 997] [list -1 {*}[irange 2 997]] 0 1 1 1 1] test listrep-4.2.1 { Inserts in front of shared spanned list with orphaned leading elements allocate a new list rep with more lead than tail space - lreplace version TODO - ideally this should garbage collect the orphans and reuse the lead space but that needs a "lprepend" command else the listrep operand is shared and hence orphans cannot be freed } -constraints testlistrep -body { set master [freeSpaceLead 1000 100] set spanl [lrange $master $two $end-2] unset master; # So elements at 0, 1 are not used set l [lreplace $spanl $zero -1 -2] validate $l list $spanl $l [sameStore $spanl $l] [leadSpaceMore $l] [hasSpan $l] [repStoreRefCount $spanl] [repStoreRefCount $l] } -result [list [irange 2 997] [list -2 {*}[irange 2 997]] 0 1 1 1 1] test listrep-4.3 { Inserts in front of shared spanned list where span is at front of used space reuses the same list store - linsert version } -constraints testlistrep -body { set master [freeSpaceLead 1000 100] set spanl [lrange $master $zero $end-2] set l [linsert $spanl $zero -1] validate $l list $spanl $l [sameStore $spanl $l] [leadSpace $l] [tailSpace $l] [hasSpan $l] [repStoreRefCount $spanl] [repStoreRefCount $l] } -result [list [irange 0 997] [irange -1 997] 1 99 0 1 3 3] test listrep-4.3.1 { Inserts in front of shared spanned list where span is at front of used space reuses the same list store - lreplace version } -constraints testlistrep -body { set master [freeSpaceLead 1000 100] set spanl [lrange $master $zero $end-2] set l [lreplace $spanl $zero -1 -1] validate $l list $spanl $l [sameStore $spanl $l] [leadSpace $l] [tailSpace $l] [hasSpan $l] [repStoreRefCount $spanl] [repStoreRefCount $l] } -result [list [irange 0 997] [irange -1 997] 1 99 0 1 3 3] test listrep-4.4 { Inserts in front of shared spanned list where span is at front of used space allocates new listrep if lead space insufficient even if total free space is sufficient. New listrep should have more lead space than tail space. - linsert version } -constraints testlistrep -body { set master [freeSpaceBoth 1000 2] set spanl [lrange $master $zero $end-2] set l [linsert $spanl $zero -3 -2 -1] validate $l list $spanl $l [sameStore $spanl $l] [leadSpaceMore $l] [hasSpan $l] [repStoreRefCount $spanl] [repStoreRefCount $l] } -result [list [irange 0 997] [irange -3 997] 0 1 1 2 1] test listrep-4.4.1 { Inserts in front of shared spanned list where span is at front of used space allocates new listrep if lead space insufficient even if total free space is sufficient. New listrep should have more lead space than tail space. - lreplace version } -constraints testlistrep -body { set master [freeSpaceBoth 1000 2] set spanl [lrange $master $zero $end-2] set l [lreplace $spanl $zero -1 -3 -2 -1] validate $l list $spanl $l [sameStore $spanl $l] [leadSpaceMore $l] [hasSpan $l] [repStoreRefCount $spanl] [repStoreRefCount $l] } -result [list [irange 0 997] [irange -3 997] 0 1 1 2 1] test listrep-4.5 { Inserts in back of shared spanned list where span is at end of used space still allocates a new listrep and trailing space is more than leading space - linsert version } -constraints testlistrep -body { set master [freeSpaceBoth 1000 2] set spanl [lrange $master $two $end] set l [linsert $spanl $end 1000] validate $l list $spanl $l [sameStore $spanl $l] [tailSpaceMore $l] [hasSpan $l] [repStoreRefCount $spanl] [repStoreRefCount $l] } -result [list [irange 2 999] [irange 2 1000] 0 1 1 2 1] test listrep-4.5.1 { Inserts in back of shared spanned list where span is at end of used space still allocates a new listrep and trailing space is more than leading space - lreplace version } -constraints testlistrep -body { set master [freeSpaceBoth 1000 2] set spanl [lrange $master $two $end] set l [lreplace $spanl $end+1 $end+1 1000] validate $l list $spanl $l [sameStore $spanl $l] [tailSpaceMore $l] [hasSpan $l] [repStoreRefCount $spanl] [repStoreRefCount $l] } -result [list [irange 2 999] [irange 2 1000] 0 1 1 2 1] test listrep-4.5.2 { Inserts in back of shared spanned list where span is at end of used space still allocates a new listrep and trailing space is more than leading space - lappend version } -constraints testlistrep -body { set master [freeSpaceBoth 1000 2] set l [lrange $master $two $end] lappend l 1000 validate $l list $l [sameStore $master $l] [tailSpaceMore $l] [hasSpan $l] [repStoreRefCount $l] } -result [list [irange 2 1000] 0 1 1 1] test listrep-4.5.3 { Inserts in back of shared spanned list where span is at end of used space still allocates a new listrep and trailing space is more than leading space - lset version } -constraints testlistrep -body { set master [freeSpaceBoth 1000 2] set l [lrange $master $two $end] lset l $end+1 1000 validate $l list $l [sameStore $master $l] [tailSpaceMore $l] [hasSpan $l] [repStoreRefCount $l] } -result [list [irange 2 1000] 0 1 1 1] test listrep-4.6 { Inserts in middle of shared spanned list allocates a new listrep with equal lead and tail space - linsert version } -constraints testlistrep -body { set master [freeSpaceBoth 1000 2] set spanl [lrange $master $two $end-2] set i 200 set l [linsert $spanl $i 1000] validate $l list $spanl $l [sameStore $spanl $l] [spaceEqual $l] [hasSpan $l] [repStoreRefCount $spanl] [repStoreRefCount $l] } -result [list [irange 2 997] [concat [irange 2 201] 1000 [irange 202 997]] 0 1 1 2 1] test listrep-4.6.1 { Inserts in middle of shared spanned list allocates a new listrep with equal lead and tail space - lreplace version } -constraints testlistrep -body { set master [freeSpaceBoth 1000 2] set spanl [lrange $master $two $end-2] set i 200 set l [lreplace $spanl $i -1 1000] validate $l list $spanl $l [sameStore $spanl $l] [spaceEqual $l] [hasSpan $l] [repStoreRefCount $spanl] [repStoreRefCount $l] } -result [list [irange 2 997] [concat [irange 2 201] 1000 [irange 202 997]] 0 1 1 2 1] test listrep-4.7 { Deletes from front of shared spanned list do not create a new allocation - lreplace version } -constraints testlistrep -body { set master [freeSpaceNone 1000] set spanl [lrange $master $two $end-2] set l [lreplace $spanl $zero $one] validate $l list $spanl $l [sameStore $spanl $l] [hasSpan $l] [repStoreRefCount $spanl] [repStoreRefCount $l] } -result [list [irange 2 997] [irange 4 997] 1 1 3 3] test listrep-4.7.1 { Deletes from front of shared spanned list do not create a new allocation - lremove version } -constraints testlistrep -body { set master [freeSpaceNone 1000] set spanl [lrange $master $two $end-2] set l [lremove $spanl $zero $one] validate $l list $spanl $l [sameStore $spanl $l] [hasSpan $l] [repStoreRefCount $spanl] [repStoreRefCount $l] } -result [list [irange 2 997] [irange 4 997] 1 1 3 3] test listrep-4.7.2 { Deletes from front of shared spanned list do not create a new allocation - lrange version } -constraints testlistrep -body { set master [freeSpaceNone 1000] set spanl [lrange $master $two $end-2] set l [lrange $spanl $two $end] validate $l list $spanl $l [sameStore $spanl $l] [hasSpan $l] [repStoreRefCount $spanl] [repStoreRefCount $l] } -result [list [irange 2 997] [irange 4 997] 1 1 3 3] test listrep-4.7.3 { Deletes from front of shared spanned list do not create a new allocation - lassign version } -constraints testlistrep -body { set master [freeSpaceNone 1000] set spanl [lrange $master $two $end-2] set l [lassign $spanl e] validate $l list $e $spanl $l [sameStore $spanl $l] [hasSpan $l] [repStoreRefCount $spanl] [repStoreRefCount $l] } -result [list 2 [irange 2 997] [irange 3 997] 1 1 3 3] test listrep-4.7.4 { Deletes from front of shared spanned list do not create a new allocation - lpop version } -constraints testlistrep -body { set master [freeSpaceNone 1000] set l [lrange $master $two $end-2] set e [lpop l $zero] validate $l list $e $l [sameStore $master $l] [hasSpan $l] [repStoreRefCount $l] } -result [list 2 [irange 3 997] 1 1 2] test listrep-4.8 { Deletes from end of shared spanned list do not create a new allocation - lreplace version } -constraints testlistrep -body { set master [freeSpaceNone 1000] set spanl [lrange $master $two $end-2] set l [lreplace $spanl $end-1 $end] validate $l list $spanl $l [sameStore $spanl $l] [hasSpan $l] [repStoreRefCount $spanl] [repStoreRefCount $l] } -result [list [irange 2 997] [irange 2 995] 1 1 3 3] test listrep-4.8.1 { Deletes from end of shared spanned list do not create a new allocation - lremove version } -constraints testlistrep -body { set master [freeSpaceNone 1000] set spanl [lrange $master $two $end-2] set l [lremove $spanl $end-1 $end] validate $l list $spanl $l [sameStore $spanl $l] [hasSpan $l] [repStoreRefCount $spanl] [repStoreRefCount $l] } -result [list [irange 2 997] [irange 2 995] 1 1 3 3] test listrep-4.8.2 { Deletes from end of shared spanned list do not create a new allocation - lrange version } -constraints testlistrep -body { set master [freeSpaceNone 1000] set spanl [lrange $master $two $end-2] set l [lrange $spanl 0 $end-2] validate $l list $spanl $l [sameStore $spanl $l] [hasSpan $l] [repStoreRefCount $spanl] [repStoreRefCount $l] } -result [list [irange 2 997] [irange 2 995] 1 1 3 3] test listrep-4.8.3 { Deletes from end of shared spanned list do not create a new allocation - lpop version } -constraints testlistrep -body { set master [freeSpaceNone 1000] set l [lrange $master $two $end-2] set e [lpop l] validate $l list $e $l [sameStore $master $l] [hasSpan $l] [repStoreRefCount $l] } -result [list 997 [irange 2 996] 1 1 2] test listrep-4.9 { Deletes from middle of shared spanned list creates a new allocation with equal free space at front and back - lreplace version } -constraints testlistrep -body { set master [freeSpaceNone 1000] set spanl [lrange $master $two $end-2] set i 500 set l [lreplace $spanl $i $i] validate $l list $spanl $l [sameStore $spanl $l] [hasSpan $l] [spaceEqual $l] [repStoreRefCount $spanl] [repStoreRefCount $l] } -result [list [irange 2 997] [concat [irange 2 501] [irange 503 997]] 0 1 1 2 1] test listrep-4.9.1 { Deletes from middle of shared spanned list creates a new allocation with equal free space at front and back - lremove version } -constraints testlistrep -body { set master [freeSpaceNone 1000] set spanl [lrange $master $two $end-2] set i 500 set l [lremove $spanl $i $i] validate $l list $spanl $l [sameStore $spanl $l] [hasSpan $l] [spaceEqual $l] [repStoreRefCount $spanl] [repStoreRefCount $l] } -result [list [irange 2 997] [concat [irange 2 501] [irange 503 997]] 0 1 1 2 1] test listrep-4.9.2 { Deletes from middle of shared spanned list creates a new allocation with equal free space at front and back - lpop version } -constraints testlistrep -body { set master [freeSpaceNone 1000] set l [lrange $master $two $end-2] set i 500 set e [lpop l $i] validate $l list $e $l [sameStore $master $l] [hasSpan $l] [spaceEqual $l] [repStoreRefCount $l] } -result [list 502 [concat [irange 2 501] [irange 503 997]] 0 1 1 1] test listrep-4.10 { Replacements with same number of elements at front of shared spanned list create a new allocation with more space in front - lreplace version } -constraints testlistrep -body { set master [freeSpaceNone 1000] set spanl [lrange $master $two $end-2] set l [lreplace $spanl $zero $one -2 -1] validate $l list $spanl $l [sameStore $spanl $l] [leadSpaceMore $l] [hasSpan $l] [repStoreRefCount $spanl] [repStoreRefCount $l] } -result [list [irange 2 997] [concat {-2 -1} [irange 4 997]] 0 1 1 2 1] test listrep-4.10.1 { Replacements with same number of elements at front of shared spanned list create a new allocation with exact size } -constraints testlistrep -body { set master [freeSpaceNone 1000] set l [lrange $master $two $end-2] lset l $zero -1 validate $l list $l [sameStore $master $l] [hasSpan $l] [repStoreRefCount $l] } -result [list [concat {-1} [irange 3 997]] 0 0 1] test listrep-4.11 { Replacements with fewer elements at front of shared spanned list create a new allocation with more space in front } -constraints testlistrep -body { set master [freeSpaceNone 1000] set spanl [lrange $master $two $end-2] set l [lreplace $spanl $zero $one -1] validate $l list $spanl $l [sameStore $spanl $l] [leadSpaceMore $l] [hasSpan $l] [repStoreRefCount $spanl] [repStoreRefCount $l] } -result [list [irange 2 997] [concat {-1} [irange 4 997]] 0 1 1 2 1] test listrep-4.12 { Replacements with more elements at front of shared spanned list create a new allocation with more space in front } -constraints testlistrep -body { set master [freeSpaceNone 1000] set spanl [lrange $master $two $end-2] set l [lreplace $spanl $zero $one -3 -2 -1] validate $l list $spanl $l [sameStore $spanl $l] [leadSpaceMore $l] [hasSpan $l] [repStoreRefCount $spanl] [repStoreRefCount $l] } -result [list [irange 2 997] [concat {-3 -2 -1} [irange 4 997]] 0 1 1 2 1] test listrep-4.13 { Replacements with same number of elements at back of shared spanned list create a new allocation with more space in back - lreplace version } -constraints testlistrep -body { set master [freeSpaceNone 1000] set spanl [lrange $master $two $end-2] set l [lreplace $spanl $end-1 $end 1000 1001] validate $l list $spanl $l [sameStore $spanl $l] [tailSpaceMore $l] [hasSpan $l] [repStoreRefCount $spanl] [repStoreRefCount $l] } -result [list [irange 2 997] [concat [irange 2 995] {1000 1001}] 0 1 1 2 1] test listrep-4.13.1 { Replacements with same number of elements at back of shared spanned list create a new exact allocation with no span - lset version } -constraints testlistrep -body { set master [freeSpaceNone 1000] set l [lrange $master $two $end-2] lset l $end 1000 validate $l list $l [sameStore $master $l] [tailSpace $l] [hasSpan $l] [repStoreRefCount $l] } -result [list [concat [irange 2 996] {1000}] 0 0 0 1] test listrep-4.14 { Replacements with fewer elements at back of shared spanned list create a new allocation with more space in back } -constraints testlistrep -body { set master [freeSpaceNone 1000] set spanl [lrange $master $two $end-2] set l [lreplace $spanl $end-1 $end 1000] validate $l list $spanl $l [sameStore $spanl $l] [tailSpaceMore $l] [hasSpan $l] [repStoreRefCount $spanl] [repStoreRefCount $l] } -result [list [irange 2 997] [concat [irange 2 995] {1000}] 0 1 1 2 1] test listrep-4.15 { Replacements with more elements at back of shared spanned list create a new allocation with more space in back } -constraints testlistrep -body { set master [freeSpaceNone 1000] set spanl [lrange $master $two $end-2] set l [lreplace $spanl $end-1 $end 1000 1001 1002] validate $l list $spanl $l [sameStore $spanl $l] [tailSpaceMore $l] [hasSpan $l] [repStoreRefCount $spanl] [repStoreRefCount $l] } -result [list [irange 2 997] [concat [irange 2 995] {1000 1001 1002}] 0 1 1 2 1] test listrep-4.16 { Replacements with same number of elements in middle of shared spanned list create a new allocation with equal lead and tail sapce } -constraints testlistrep -body { set master [freeSpaceNone 1000] set spanl [lrange $master $two $end-2] set l [lreplace $spanl $one $two -2 -1] validate $l list $spanl $l [sameStore $spanl $l] [spaceEqual $l] [hasSpan $l] [repStoreRefCount $spanl] [repStoreRefCount $l] } -result [list [irange 2 997] [concat {2 -2 -1} [irange 5 997]] 0 1 1 2 1] test listrep-4.16.1 { Replacements with same number of elements in middle of shared spanned list create a new exact allocation - lset version } -constraints testlistrep -body { set master [freeSpaceNone 1000] set l [lrange $master $two $end-2] lset l $one -2 validate $l list $l [sameStore $master $l] [hasSpan $l] [tailSpace $l] [repStoreRefCount $l] } -result [list [concat {2 -2} [irange 4 997]] 0 0 0 1] test listrep-4.17 { Replacements with fewer elements in middle of shared spanned list create a new allocation with equal lead and tail sapce } -constraints testlistrep -body { set master [freeSpaceNone 1000] set spanl [lrange $master $two $end-2] set l [lreplace $spanl $end-2 $end-1 1000] validate $l list $spanl $l [sameStore $spanl $l] [spaceEqual $l] [hasSpan $l] [repStoreRefCount $spanl] [repStoreRefCount $l] } -result [list [irange 2 997] [concat [irange 2 994] {1000 997}] 0 1 1 2 1] test listrep-4.18 { Replacements with more elements in middle of shared spanned list create a new allocation with equal lead and tail sapce } -constraints testlistrep -body { set master [freeSpaceNone 1000] set spanl [lrange $master $two $end-2] set l [lreplace $spanl $end-2 $end-1 1000 1001 1002] validate $l list $spanl $l [sameStore $spanl $l] [spaceEqual $l] [hasSpan $l] [repStoreRefCount $spanl] [repStoreRefCount $l] } -result [list [irange 2 997] [concat [irange 2 994] {1000 1001 1002 997}] 0 1 1 2 1] # 5.* - tests on shared Tcl_Obj # Tests when Tcl_Obj is shared but listrep is not. This is to ensure that # checks for shared values check the Tcl_Obj reference counts in addition to # the list internal representation reference counts. Probably some or all # cases are already covered elsewhere but easier to just test than look. test listrep-5.1 { Verify that operation on a shared Tcl_Obj with a single-ref, spanless list representation only modifies the target object - lappend version } -constraints testlistrep -body { set l [freeSpaceNone] set l2 $l set same [sameStore $l $l2] lappend l 8 list $same $l $l2 [sameStore $l $l2] } -result [list 1 [irange 0 8] [irange 0 7] 0] test listrep-5.1.1 { Verify that operation on a shared Tcl_Obj with a single-ref, spanless list representation only modifies the target object - lset version } -constraints testlistrep -body { set l [freeSpaceNone] set l2 $l set same [sameStore $l $l2] lset l $end+1 8 list $same $l $l2 [sameStore $l $l2] } -result [list 1 [irange 0 8] [irange 0 7] 0] test listrep-5.1.2 { Verify that operation on a shared Tcl_Obj with a single-ref, spanless list representation only modifies the target object - lpop version } -constraints testlistrep -body { set l [freeSpaceNone] set l2 $l set same [sameStore $l $l2] lpop l list $same $l $l2 [sameStore $l $l2] [hasSpan $l] } -result [list 1 [irange 0 6] [irange 0 7] 0 0] test listrep-5.2 { Verify that operation on a shared Tcl_Obj with a single-ref, spanned list representation only modifies the target object - lappend version } -constraints testlistrep -body { set l [freeSpaceBoth 1000 10 10] set l2 $l set same [sameStore $l $l2] lappend l 1000 list $same $l $l2 [sameStore $l $l2] [hasSpan $l] [hasSpan $l2] } -result [list 1 [irange 0 1000] [irange 0 999] 0 1 1] test listrep-5.2.1 { Verify that operation on a shared Tcl_Obj with a single-ref, spanned list representation only modifies the target object - lset version } -constraints testlistrep -body { set l [freeSpaceBoth 1000 10 10] set l2 $l set same [sameStore $l $l2] lset l $end+1 1000 list $same $l $l2 [sameStore $l $l2] [hasSpan $l] [hasSpan $l2] } -result [list 1 [irange 0 1000] [irange 0 999] 0 1 1] test listrep-5.2.2 { Verify that operation on a shared Tcl_Obj with a single-ref, spanned list representation only modifies the target object - lpop version } -constraints testlistrep -body { set l [freeSpaceNone 1000] set l2 $l set same [sameStore $l $l2] lpop l list $same $l $l2 [sameStore $l $l2] [hasSpan $l] [hasSpan $l2] } -result [list 1 [irange 0 998] [irange 0 999] 1 1 0] # # 6.* - tests when lists contain zombies. # The list implementation does lazy freeing in some cases so the list store # contain Tcl_Obj's that are not actually referenced by any list (zombies). # These are to be freed next time the list store is modified by a list # operation as long as it is no longer shared. test listrep-6.1 { Verify that zombies are freed up - linsert at front } -constraints testlistrep -body { set l [zombieSample 200 10 10] set addr [storeAddress $l] # set l {} is for reference counts to drop to 1 set l [linsert $l[set l {}] $zero -1] list $l [expr {$addr == [storeAddress $l]}] [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list [list -1 {*}[irange 10 209]] 1 9 10 1] test listrep-6.1.1 { Verify that zombies are freed up - linsert in middle } -constraints testlistrep -body { set l [zombieSample 200 10 10] set addr [storeAddress $l] # set l {} is for reference counts to drop to 1 set l [linsert $l[set l {}] $one -1] list $l [expr {$addr == [storeAddress $l]}] [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list [list 10 -1 {*}[irange 11 209]] 1 9 10 1] test listrep-6.1.2 { Verify that zombies are freed up - linsert at end } -constraints testlistrep -body { set l [zombieSample 200 10 10] set addr [storeAddress $l] # set l {} is for reference counts to drop to 1 set l [linsert $l[set l {}] $end 210] list $l [expr {$addr == [storeAddress $l]}] [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list [irange 10 210] 1 10 9 1] test listrep-6.2 { Verify that zombies are freed up - lrange version (whole) } -constraints testlistrep -body { set l [zombieSample 200 10 10] set addr [storeAddress $l] # set l {} is for reference counts to drop to 1 set l [lrange $l[set l {}] $zero $end] list $l [expr {$addr == [storeAddress $l]}] [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list [irange 10 209] 1 10 10 1] test listrep-6.2.1 { Verify that zombies are freed up - lrange version (subrange) } -constraints testlistrep -body { set l [zombieSample 200 10 10] set addr [storeAddress $l] # set l {} is for reference counts to drop to 1 set l [lrange $l[set l {}] $one $end-1] list $l [expr {$addr == [storeAddress $l]}] [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list [irange 11 208] 1 11 11 1] test listrep-6.3 { Verify that zombies are freed up - lassign version } -constraints testlistrep -body { set l [zombieSample 200 10 10] set addr [storeAddress $l] # set l {} is for reference counts to drop to 1 set l [lassign $l[set l {}] e] list $e $l [expr {$addr == [storeAddress $l]}] [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list 10 [irange 11 209] 1 11 10 1] test listrep-6.4 { Verify that zombies are freed up - lremove version (front) } -constraints testlistrep -body { set l [zombieSample 200 10 10] set addr [storeAddress $l] # set l {} is for reference counts to drop to 1 set l [lremove $l[set l {}] $zero] list $l [expr {$addr == [storeAddress $l]}] [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list [irange 11 209] 1 11 10 1] test listrep-6.4.1 { Verify that zombies are freed up - lremove version (back) } -constraints testlistrep -body { set l [zombieSample 200 10 10] set addr [storeAddress $l] # set l {} is for reference counts to drop to 1 set l [lremove $l[set l {}] $end] list $l [expr {$addr == [storeAddress $l]}] [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list [irange 10 208] 1 10 11 1] test listrep-6.5 { Verify that zombies are freed up - lreplace at front } -constraints testlistrep -body { set l [zombieSample 200 10 10] set addr [storeAddress $l] # set l {} is for reference counts to drop to 1 set l [lreplace $l[set l {}] $zero $one -3 -2 -1] list $l [expr {$addr == [storeAddress $l]}] [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list [list -3 -2 -1 {*}[irange 12 209]] 1 9 10 1] test listrep-6.5.1 { Verify that zombies are freed up - lreplace at back } -constraints testlistrep -body { set l [zombieSample 200 10 10] set addr [storeAddress $l] # set l {} is for reference counts to drop to 1 set l [lreplace $l[set l {}] $end-1 $end -1 -2 -3] list $l [expr {$addr == [storeAddress $l]}] [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list [list {*}[irange 10 207] -1 -2 -3] 1 10 9 1] test listrep-6.6 { Verify that zombies are freed up - lappend } -constraints testlistrep -body { set l [zombieSample 200 10 10] set addr [storeAddress $l] lappend l 210 list $l [expr {$addr == [storeAddress $l]}] [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list [irange 10 210] 1 10 9 1] test listrep-6.7 { Verify that zombies are freed up - lpop version (front) } -constraints testlistrep -body { set l [zombieSample 200 10 10] set addr [storeAddress $l] set e [lpop l $zero] list $e $l [expr {$addr == [storeAddress $l]}] [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list 10 [irange 11 209] 1 11 10 1] test listrep-6.7.1 { Verify that zombies are freed up - lpop version (back) } -constraints testlistrep -body { set l [zombieSample 200 10 10] set addr [storeAddress $l] set e [lpop l] list $e $l [expr {$addr == [storeAddress $l]}] [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list 209 [irange 10 208] 1 10 11 1] test listrep-6.8 { Verify that zombies are freed up - lset version } -constraints testlistrep -body { set l [zombieSample 200 10 10] set addr [storeAddress $l] lset l $zero -1 list $l [expr {$addr == [storeAddress $l]}] [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list [list -1 {*}[irange 11 209]] 1 10 10 1] test listrep-6.8.1 { Verify that zombies are freed up - lset version (back) } -constraints testlistrep -body { set l [zombieSample 200 10 10] set addr [storeAddress $l] lset l $end+1 210 list $l [expr {$addr == [storeAddress $l]}] [leadSpace $l] [tailSpace $l] [repStoreRefCount $l] } -result [list [irange 10 210] 1 10 9 1] # All done ::tcltest::cleanupTests return |