add BaseIndex requested feature + Enumerator fix on tB beta 416

Author: Theadd

ArrayListLib/Sources/ArrayList.twin

@@ -7,22 +7,28 @@ Public Class ArrayList
     Private pItems() As Variant
     Private pIndex As Long
     Private pVersion As Long
+    Private pBaseIndex As Long
+    
+    Public Sub New(Optional ByVal Capacity As Long = 2, Optional ByVal BaseIndex As Long = 0)
+        ReDim pItems(0 To Capacity - 1)
+        pBaseIndex = BaseIndex
+    End Sub
 
     [ DefaultMember ]
     Public Property Get Item(ByVal Index As Long) As Variant Implements IArrayList.Item
-        If Index < 0 Or Index >= pIndex Then Err.Raise 9
-        Return pItems(Index)
+        If Index < pBaseIndex Or Index >= pIndex + pBaseIndex Then Err.Raise 9
+        Return pItems(Index - pBaseIndex)
     End Property
 
     Public Property Let Item(ByVal Index As Long, Value As Variant) Implements IArrayList.Item
-        If Index < 0 Or Index >= pIndex Then Err.Raise 9
-        pItems(Index) = Value
+        If Index < pBaseIndex Or Index >= pIndex + pBaseIndex Then Err.Raise 9
+        pItems(Index - pBaseIndex) = Value
         pVersion += 1
     End Property
 
     Public Property Set Item(ByVal Index As Long, Value As Variant) Implements IArrayList.Item
-        If Index < 0 Or Index >= pIndex Then Err.Raise 9
-        Set pItems(Index) = Value
+        If Index < pBaseIndex Or Index >= pIndex + pBaseIndex Then Err.Raise 9
+        Set pItems(Index - pBaseIndex) = Value
         pVersion += 1
     End Property
 
@@ -35,6 +41,9 @@ Public Class ArrayList
         pVersion += 1
     End Property
 
+    Public Property Get BaseIndex() As Long Implements IArrayList.BaseIndex: Return pBaseIndex: End Property
+    
+    Public Property Let BaseIndex(Value As Long) Implements IArrayList.BaseIndex: pBaseIndex = Value: pVersion += 1: End Property
     [ Hidden ]
     Public Property Get Version() As Long Implements IArrayList.Version: Return pVersion: End Property
 
@@ -53,7 +62,7 @@ Public Class ArrayList
     [ Hidden ]
     [ Description ("CAUTION: Limit usage only in For Each In .Items calls, do NOT assign the return value of .Items to another variable unless you know what you're doing.") ]
     Public Function Items() As Variant() Implements IArrayList.Items
-        /* Returns a Variant Array pointing to the same memory as the internal array of this list 
+        /* Returns a 0-based Variant Array pointing to the same memory as the internal array of this list 
          * without increasing the reference count of byref elements within the list.
          * If you assign this array to a variable in your code, you must remove the reference
          * before it goes out of scope to prevent double deallocation of byref values.
@@ -74,7 +83,7 @@ Public Class ArrayList
     Public Function Add(Value As Variant) As Long Implements IArrayList.Add
         If pIndex > UBound(pItems) Then GrowCapacity 1
         If IsObject(Value) Then Set pItems(pIndex) = Value Else pItems(pIndex) = Value
-        Add = pIndex
+        Add = pIndex + pBaseIndex
         pIndex += 1
         pVersion += 1
     End Function
@@ -89,7 +98,8 @@ Public Class ArrayList
 
     [ Description ("Creates a shallow copy of this ArrayList.") ]
     Public Function Clone() As Variant Implements IArrayList.Clone
-        Dim Target As New ArrayList
+        Dim Target As ArrayList
+        Set Target = New ArrayList(BaseIndex:=pBaseIndex)
         C2IArrayList(Target).CloneTo Target, C2IArrayList(Me), 0, pIndex
         Return Target
     End Function
@@ -138,13 +148,41 @@ Public Class ArrayList
     End Sub
 
     [ Enumerator ]
+    [ Description ("When using this enumerator for more advanced usage other than regular For Each usage, Index is always 0-based regardless of the current BaseIndex value in this ArrayList.") ]
     Public Function GetEnumerator(Optional ByVal Index As Long = 0, Optional ByVal GetCount As Variant, Optional ByVal GetStep As Long = 1, Optional ByRef ThisEnumerator As IEnumerator) As stdole.IUnknown Implements IArrayList.GetEnumerator
+        Static mEnumerator As Enumerator, mEnumeratorB As Enumerator, mVer As Long, mVerB As Long
         If IsMissing(GetCount) Then GetCount = pIndex - Index
-        Return New Enumerator(pItems, Index, GetCount, GetStep, ThisEnumerator)
+        If GetCount > 0 Then
+        	If mEnumerator Is Nothing Then
+                Set mEnumerator = New Enumerator(pItems, Index, GetCount, GetStep, ThisEnumerator)
+                mVer = pVersion
+            Else
+                If pVersion <> mVer Then
+                    mEnumerator.Bind pItems, Index, GetCount, GetStep
+                    mVer = pVersion
+                Else
+                    If Not mEnumerator.IsAvailable Then
+                        If mEnumeratorB Is Nothing Then
+                            Set mEnumeratorB = New Enumerator(pItems, Index, GetCount, GetStep, ThisEnumerator)
+                            mVerB = pVersion
+                        ElseIf pVersion <> mVerB Then
+                            mEnumeratorB.Bind pItems, Index, GetCount, GetStep
+                            mVerB = pVersion
+                        End If
+                        Set ThisEnumerator = mEnumeratorB
+                        Return mEnumeratorB
+                    End If
+                End If
+            End If
+            Set ThisEnumerator = mEnumerator
+            Return mEnumerator
+        End If
     End Function
 
     [ Description ("Returns the index of a particular item. Returns -1 if the item isn't in the list.") ]
-    Public Function IndexOf(Value As Variant, Optional ByVal Index As Long = 0, Optional ByVal GetCount As Variant) As Long Implements IArrayList.IndexOf
+    Public Function IndexOf(Value As Variant, Optional ByVal Index As Variant, Optional ByVal GetCount As Variant) As Long Implements IArrayList.IndexOf
+        If IsMissing(Index) Then Index = pBaseIndex
+        Index = CLng(Index - pBaseIndex)
         If IsMissing(GetCount) Then GetCount = pIndex - Index
         If Index > pIndex Or GetCount < 0 Or Index > pIndex - GetCount Then Err.Raise 9
         GetCount = Index + GetCount - 1
@@ -153,23 +191,24 @@ Public Class ArrayList
         Select Case vt
             Case vbNull
                 For i = Index To GetCount
-                    If IsNull(pItems(i)) Then Return i
+                    If IsNull(pItems(i)) Then Return i + pBaseIndex
                 Next i
             Case vbObject
                 For i = Index To GetCount
-                    If VarType(pItems(i)) = vt AndAlso ObjPtr(pItems(i)) = ObjPtr(Value) Then Return i
+                    If VarType(pItems(i)) = vt AndAlso ObjPtr(pItems(i)) = ObjPtr(Value) Then Return i + pBaseIndex
                 Next i
             Case Else
                 For i = Index To GetCount
-                    If VarType(pItems(i)) = vt AndAlso pItems(i) = Value Then Return i
+                    If VarType(pItems(i)) = vt AndAlso pItems(i) = Value Then Return i + pBaseIndex
                 Next i
         End Select
         Return -1
     End Function
 
     [ Description ("Returns the last index of a particular item. Returns -1 if the item isn't in the list.") ]
     Public Function LastIndexOf(ByRef Value As Variant, Optional ByVal Index As Variant, Optional ByVal GetCount As Variant) As Long Implements IArrayList.LastIndexOf
-        If IsMissing(Index) Then Index = pIndex - 1
+        If IsMissing(Index) Then Index = pIndex + pBaseIndex - 1
+        Index = CLng(Index - pBaseIndex)
         If IsMissing(GetCount) Then GetCount = Index + 1
         If Index >= pIndex Or GetCount > Index + 1 Then Err.Raise 9
         GetCount = Index - (GetCount - 1)
@@ -178,36 +217,37 @@ Public Class ArrayList
         Select Case vt
             Case vbNull
                 For i = Index To GetCount Step -1
-                    If IsNull(pItems(i)) Then Return i
+                    If IsNull(pItems(i)) Then Return i + pBaseIndex
                 Next i
             Case vbObject
                 For i = Index To GetCount Step -1
-                    If VarType(pItems(i)) = vt AndAlso ObjPtr(pItems(i)) = ObjPtr(Value) Then Return i
+                    If VarType(pItems(i)) = vt AndAlso ObjPtr(pItems(i)) = ObjPtr(Value) Then Return i + pBaseIndex
                 Next i
             Case Else
                 For i = Index To GetCount Step -1
-                    If VarType(pItems(i)) = vt AndAlso pItems(i) = Value Then Return i
+                    If VarType(pItems(i)) = vt AndAlso pItems(i) = Value Then Return i + pBaseIndex
                 Next i
         End Select
         Return -1
     End Function
 
     [ Description ("Inserts value into the list at position Index. Index must be non-negative and less than or equal to the number of elements in the list. If Index equals the number of items in the list, then value is appended to the end.") ]
     Public Sub Insert(ByVal Index As Long, Value As Variant) Implements IArrayList.Insert
-        ReserveSpaceForInsert Index, 1
-        If IsObject(Value) Then Set pItems(Index) = Value Else pItems(Index) = Value
+        ReserveSpaceForInsert Index - pBaseIndex, 1
+        If IsObject(Value) Then Set pItems(Index - pBaseIndex) = Value Else pItems(Index - pBaseIndex) = Value
         pIndex += 1
         pVersion += 1
     End Sub
 
     [ Description ("Removes an item from the list.") ]
     Public Sub Remove(Value As Variant) Implements IArrayList.Remove
         Dim Index As Long = IndexOf(Value)
-        If Index >= 0 Then RemoveAt Index
+        If Index >= pBaseIndex Then RemoveAt Index
     End Sub
 
     [ Description ("Removes the item at Index position.") ]
     Public Sub RemoveAt(ByVal Index As Long) Implements IArrayList.RemoveAt
+        Index = Index - pBaseIndex
         If Index < 0 Or Index >= pIndex Then Err.Raise 9
         pItems(Index) = Empty
         If Index < pIndex - 1 Then VBA.vbaCopyBytes (pIndex - Index - 1) * VARIANT_SIZE, VarPtr(pItems(Index)), VarPtr(pItems(Index + 1))
@@ -218,6 +258,7 @@ Public Class ArrayList
 
     Public Sub RemoveRange(ByVal Index As Long, ByVal GetCount As Long) Implements IArrayList.RemoveRange
         Dim i As Long
+        Index = Index - pBaseIndex
         If Index < 0 Or GetCount < 0 Or (pIndex - Index < GetCount) Then Err.Raise 9
         For i = 0 To GetCount - 1
             pItems(Index + i) = Empty
@@ -228,30 +269,33 @@ Public Class ArrayList
         pVersion += 1
     End Sub
 
-    Public Sub Reverse(Optional ByVal Index As Long = 0, Optional ByVal GetCount As Variant) Implements IArrayList.Reverse
+    Public Sub Reverse(Optional ByVal Index As Variant, Optional ByVal GetCount As Variant) Implements IArrayList.Reverse
+        If IsMissing(Index) Then Index = pBaseIndex
+        Index = CLng(Index) - pBaseIndex
         If IsMissing(GetCount) Then GetCount = pIndex - Index
         If Index < 0 Or GetCount < 0 Or (pIndex - Index < GetCount) Then Err.Raise 9
         Dim i As Long, p0 As LongPtr = VarPtr(pItems(0)), iMax As Long = GetCount \ 2
         For i = 0 To iMax
-        	VSwap p0 + (Index + i) * VARIANT_SIZE, p0 + CLngPtr(Index + (GetCount - 1) - i) * VARIANT_SIZE
+        	VSwap p0 + CLngPtr(Index + i) * VARIANT_SIZE, p0 + CLngPtr(Index + (GetCount - 1) - i) * VARIANT_SIZE
         Next i
         pVersion += 1
     End Sub
 
     Public Function ToArray() As Variant() Implements IArrayList.ToArray
         Dim t() As Variant
         If pIndex = 0 Then Return Array()
-        ReDim t(0 To pIndex - 1)
-        VariantArrayClone VarPtr(t(0)), VarPtr(pItems(0)), pIndex
+        ReDim t(pBaseIndex To pIndex + pBaseIndex - 1)
+        VariantArrayClone VarPtr(t(pBaseIndex)), VarPtr(pItems(0)), pIndex
         ReassignArrayTo ToArray, t
     End Function
 
     Public Sub AddRange(Target As Variant) Implements IArrayList.AddRange
-        InsertRange pIndex, Target
+        InsertRange pIndex + pBaseIndex, Target
     End Sub
 
     Public Sub InsertRange(ByVal Index As Long, Target As Variant) Implements IArrayList.InsertRange
         Dim v As Variant, GetCount As Long
+        Index -= pBaseIndex
         Select Case VarType(Target)
         	Case vbArray + vbVariant
                 GetCount = (UBound(Target) - LBound(Target)) + 1
@@ -282,13 +326,14 @@ Public Class ArrayList
     End Sub
 
     Public Function GetRange(ByVal Index As Long, ByVal GetCount As Long) As IListRange Implements IArrayList.GetRange
-        If Index < 0 Or GetCount < 0 Or pIndex - Index < GetCount Then Err.Raise 9
+        If Index < pBaseIndex Or GetCount < 0 Or pIndex - (Index - pBaseIndex) < GetCount Then Err.Raise 9
         Dim r As New ListRange
         Set GetRange = r.Bind(Me, Index, GetCount)
     End Function
 
     Public Sub SetRange(ByVal Index As Long, Target As Variant) Implements IArrayList.SetRange
         Dim v As Variant, GetCount As Long
+        Index -= pBaseIndex
         Select Case VarType(Target)
             Case vbArray + vbVariant
                 GetCount = (UBound(Target) - LBound(Target)) + 1
@@ -318,12 +363,14 @@ Public Class ArrayList
     /* [ CompilerOptions ("+llvm,+optimize") ] */
     [ ArrayBoundsChecks (False) ]
     [ IntegerOverflowChecks (False) ]
-    Public Sub Sort(Optional ByVal Index As Long = 0, Optional ByVal GetCount As Variant, Optional Comparer As IComparer = Nothing) Implements IArrayList.Sort
+    Public Sub Sort(Optional ByVal Index As Variant, Optional ByVal GetCount As Variant, Optional Comparer As IComparer = Nothing) Implements IArrayList.Sort
+        If IsMissing(Index) Then Index = pBaseIndex
+        Index -= pBaseIndex
         If IsMissing(GetCount) Then GetCount = pIndex - Index
         If Comparer IsNot Nothing Then
-            QuickSort Index, Index + GetCount - 1, Comparer
+            QuickSort CLng(Index), Index + GetCount - 1, Comparer
         Else
-            QuickSortV2 Index, Index + GetCount - 1
+            QuickSortV2 CLng(Index), Index + GetCount - 1
         End If
         pVersion += 1
     End Sub
@@ -334,13 +381,14 @@ Public Class ArrayList
     [ Description ("Searches a section of a sorted list. Returns the index of the given value in the list. If not found, returns a negative integer. Use the bitwise operator (Not) to get the index of the first element larger than this one, if any.") ]
     Public Function BinarySearch(ByVal Index As Long, ByVal GetCount As Long, Value As Variant, Optional ByRef Comparer As IComparer = Nothing) As Long Implements IArrayList.BinarySearch
         Dim lo As Long, hi As Long, i As Long
+        Index -= pBaseIndex
         lo = Index
         hi = Index + GetCount - 1
         If Comparer IsNot Nothing Then
             Do While (lo <= hi)
                 i = lo + ((hi - lo) \ 2)
                 Select Case Comparer.Compare(pItems(i), Value)
-                    Case 0: Return i
+                    Case 0: Return i + pBaseIndex
                     Case Is < 0: lo = i + 1
                     Case Else: hi = i - 1
                 End Select
@@ -349,37 +397,33 @@ Public Class ArrayList
             Do While (lo <= hi)
                 i = lo + ((hi - lo) \ 2)
                 Select Case pItems(i)
-                    Case Value: Return i
+                    Case Value: Return i + pBaseIndex
                     Case Is < Value: lo = i + 1
                     Case Else: hi = i - 1
                 End Select
             Loop
         End If
-        Return Not lo
+        Return Not (lo + pBaseIndex)
     End Function
 
     #Region "HIDDEN METHODS IN MSCORLIB"
     [ Hidden ]
     Public Function IndexOf_2(ByRef Value As Variant, ByVal Index As Long, ByVal GetCount As Long) As Long: Return IndexOf(Value, Index, GetCount): End Function
     [ Hidden ]
-    Public Function IndexOf_3(ByRef Value As Variant) As Long: Return IndexOf(Value, 0): End Function
+    Public Function IndexOf_3(ByRef Value As Variant) As Long: Return IndexOf(Value, pBaseIndex): End Function
     [ Hidden ]
-    Public Sub Sort_2(ByRef Comparer As IComparer): Sort 0, , Comparer: End Sub
+    Public Sub Sort_2(ByRef Comparer As IComparer): Sort pBaseIndex, , Comparer: End Sub
     [ Hidden ]
-    Public Function BinarySearch_2(ByRef Value As Variant) As Long: Return BinarySearch(0, pIndex, Value): End Function
+    Public Function BinarySearch_2(ByRef Value As Variant) As Long: Return BinarySearch(pBaseIndex, pIndex, Value): End Function
     [ Hidden ]
-    Public Function BinarySearch_3(ByRef Value As Variant, ByRef Comparer As IComparer) As Long: Return BinarySearch(0, pIndex, Value, Comparer): End Function
+    Public Function BinarySearch_3(ByRef Value As Variant, ByRef Comparer As IComparer) As Long: Return BinarySearch(pBaseIndex, pIndex, Value, Comparer): End Function
     [ Hidden ]
     Public Function LastIndexOf_2(ByRef Value As Variant, ByVal Index As Long) As Long: Return LastIndexOf(Value, Index, Index + 1): End Function
     [ Hidden ]
     Public Function LastIndexOf_3(ByRef Value As Variant, ByVal Index As Long, ByVal GetCount As Long) As Long: Return LastIndexOf(Value, Index, GetCount): End Function
     #End Region
 
     #Region "PRIVATE METHODS"
-    Public Sub New()
-        ReDim pItems(0 To 1)
-    End Sub
-    
     Private Sub Class_Terminate()
         On Error Resume Next
         DoEvents

ArrayListLib/Sources/Enumerator.twin

@@ -31,6 +31,7 @@ Public Class Enumerator
     Private Items() As Variant
     Private CStep As Long
     Private NStep As Long
+    Private IsEnumerating As Boolean
     Private Const E_INVALIDARGS As Long = &H80070057
     Private Const S_OK As Long = 0
     Private Const S_FALSE As Long = 1
@@ -53,6 +54,8 @@ Public Class Enumerator
         PutMem4 ArrPtr(Items) + SAFEARRAY_CELEMENTS_OFFSET, Value
     End Property
 
+    Public Property Get IsAvailable() As Boolean: IsAvailable = Not IsEnumerating: End Property
+    
     Public Sub New()
     End Sub
 
@@ -74,8 +77,13 @@ Public Class Enumerator
         End With
         VBA.PutMemPtr VarPtrArr(Items), VarPtr(sa)
         CStep = GetStep
+        NStep = 0
         MaxValue = GetCount
-        If CStep < 0 Then CIndex = GetCount - 1
+        If CStep < 0 Then
+            CIndex = GetCount - 1
+        Else
+            CIndex = 0
+        End If
     End Sub
 
     [ Enumerator ]
@@ -98,6 +106,7 @@ Public Class Enumerator
                 Err.ReturnHResult = S_OK
             Else
                 If VarPtr(pceltFetched) <> 0 Then pceltFetched = 0
+                IsEnumerating = False
                 Err.ReturnHResult = S_FALSE
             End If
         End If
@@ -114,6 +123,8 @@ Public Class Enumerator
 
     Private Sub Reset() Implements IEnumerator.Reset
         CIndex = If(CStep < 0, MaxValue - 1, 0)
+        NStep = 0
+        IsEnumerating = True
     End Sub
 
     Private Sub Clone(ByRef ppenum As IEnumVARIANT) Implements IEnumerator.Clone