refactor: tests work, all fine

Its better for me this way, its just this little change at least, next
is fucking going and fixig all damn tests, the fucking wors part

CMakeLists.txt

@@ -1,39 +1,48 @@
 cmake_minimum_required(VERSION 3.20)
-project(calculator VERSION 1.0 LANGUAGES C)
+project(arraylist VERSION 1.0 LANGUAGES C)
 
 set(CMAKE_C_STANDARD 11)
 set(CMAKE_C_STANDARD_REQUIRED ON)
 
-# Export compile_commands.json (para clangd)
+# clangd
 set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
-add_compile_options(
+# Opciones
+option(ARRAYLIST_BUILD_TESTS "Build arraylist tests" ON)
+option(ARRAYLIST_ENABLE_SANITIZERS "Enable sanitizers for tests" ON)
+
+# ------------------------
+# Library
+# ------------------------
+add_library(arraylist
+    src/arraylist.c
+)
+
+target_include_directories(arraylist
+    PUBLIC
+        $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
+        $<INSTALL_INTERFACE:include>
+)
+
+target_compile_options(arraylist PRIVATE
     -Wall
     -Wextra
     -Wpedantic
 )
 
+# ------------------------
+# Example (opcional)
+# ------------------------
+add_executable(arraylist_example src/main.c)
 
-include_directories(include)
-
-add_library(arraylist_lib
-    src/arraylist.c
+target_link_libraries(arraylist_example
+    arraylist
 )
 
-add_executable(arraylist_main src/main.c)
-
-target_link_libraries(arraylist_main arraylist_lib)
-
-function(enable_sanitizers target)
-    target_compile_options(${target} PRIVATE -fsanitize=address -fno-omit-frame-pointer)
-    target_link_options(${target} PRIVATE -fsanitize=address)
-endfunction()
-
-
 # ------------------------
 # Testing
 # ------------------------
-
-enable_testing()
-add_subdirectory(test)
-
+if(ARRAYLIST_BUILD_TESTS)
+    enable_testing()
+    add_subdirectory(test)
+endif()

README.md

@@ -0,0 +1 @@
+# Hola

include/arraylist.h

@@ -7,10 +7,7 @@
 
 typedef struct ArrayList ArrayList;
 
-typedef struct {
-    ArrayList *array;
-    size_t offset;
-} ArrayListSlice;
+typedef struct ArraySlice ArraySlice;
 
 typedef enum {
     ARRLIST_OK = 0,
@@ -21,11 +18,17 @@ typedef enum {
     ARRLIST_NULL_ARG,
     ARRLIST_INVALID_ELEM_SIZE,
     ARRLIST_INVALID_CAPACITY,
+    ARRLIST_IS_BORROWED,
+    ARRLIST_INVALID_SLICE,
+    ARRLIST_INVALID_ARR,
+    ARRLIST_INVALID_START,
+    ARRLIST_BORROW_UNDERFLOW,
 } ArrayListErr;
 
-ArrayList *arraylist_init(size_t capacity, size_t elem_size);
+ArrayListErr arraylist_init(ArrayList **arr, size_t capacity, size_t elem_size);
 ArrayListErr arraylist_destroy(ArrayList **arr);
 ArrayListErr arraylist_clear(ArrayList *arr);
+ArrayList *arraylist_clone(const ArrayList *arr);
 
 size_t arraylist_size(const ArrayList *arr);
 size_t arraylist_capacity(const ArrayList *arr);
@@ -46,4 +49,22 @@ ArrayListErr arraylist_set(ArrayList *arr, size_t index, void *data);
 ArrayListErr arraylist_resize(ArrayList *arr, size_t new_capacity);
 ArrayListErr arraylist_reserve(ArrayList *arr, size_t size_to_reserve);
 
+//Slice stuff
+ArrayListErr arraylist_slice(ArraySlice **slice, ArrayList *arr, size_t start, size_t len);
+ArrayListErr arraylist_slice_unsafe(ArraySlice **slice, ArrayList *arr, size_t start, size_t len);
+ArrayListErr arrayslice_destroy(ArraySlice **slice);
+
+bool arrayslice_is_valid(const ArraySlice *slice);
+size_t arrayslice_size(const ArraySlice *slice);
+
+// peek and next can be null, get can't, like, why would you use get without
+// actually getting something?, for validating an index?, use size idiot
+ArrayListErr arrayslice_peek(const ArraySlice *slice, void *out);
+ArrayListErr arrayslice_next(ArraySlice *slice, void *out);
+
+ArrayListErr arrayslice_reset(ArraySlice *slice);
+ArrayListErr arrayslice_advance(ArraySlice *slice, size_t n);
+
+ArrayListErr arrayslice_to_arraylist(ArrayList **arr, const ArraySlice *slice);
+
 #endif

src/arraylist.c

@@ -9,6 +9,15 @@ struct ArrayList{
     size_t capacity;
     size_t len;
     size_t elem_size;
+    size_t borrows;
+};
+
+struct ArraySlice {
+    ArrayList *arr;
+    size_t start;
+    size_t end;
+    size_t current;
+    bool is_safe;
 };
 
 // Grow and shrink factor is 2, 1.5 might give different results i guess
@@ -17,33 +26,42 @@ struct ArrayList{
 static ArrayListErr arraylist_grow(ArrayList *arr);
 static ArrayListErr arraylist_shrink(ArrayList *arr);
 
-ArrayList *arraylist_init(size_t capacity, size_t elem_size) {
+ArrayListErr arraylist_init(ArrayList **arr, size_t capacity, size_t elem_size) {
+    if (arr == NULL) {
+        return ARRLIST_NULL_ARG;
+    }
+    
+    *arr = NULL;
+
     if (capacity == 0) {
-        return NULL;
+        return ARRLIST_INVALID_CAPACITY;
     }
 
     if (elem_size == 0) {
-        return NULL;
+        return ARRLIST_INVALID_ELEM_SIZE;
     }
 
     if (capacity > SIZE_MAX / elem_size) {
-        return NULL;
+        return ARRLIST_INVALID_CAPACITY;
     }
 
-    ArrayList *arr = malloc(sizeof(ArrayList));
-    if (arr == NULL) {
-        return NULL;
-    }
-    arr->capacity = capacity;
-    arr->elem_size = elem_size;
-    arr->len = 0;
-    arr->buffer = malloc(capacity * elem_size);
-    if (arr->buffer == NULL) {
-        free(arr);
-        return NULL;
+    ArrayList *new_arr = malloc(sizeof(ArrayList));
+    if (new_arr == NULL) {
+        return ARRLIST_BAD_ALLOC;
     }
 
-    return arr;
+    new_arr->capacity = capacity;
+    new_arr->elem_size = elem_size;
+    new_arr->len = 0;
+    new_arr->borrows = 0;
+    new_arr->buffer = malloc(capacity * elem_size);
+    if (new_arr->buffer == NULL) {
+        free(new_arr);
+        return ARRLIST_BAD_ALLOC;
+    }
+
+    *arr = new_arr;
+    return ARRLIST_OK;
 }
 
 ArrayListErr arraylist_destroy(ArrayList **arr) {
@@ -51,6 +69,10 @@ ArrayListErr arraylist_destroy(ArrayList **arr) {
         return ARRLIST_NULL_ARG;
     }
 
+    if ((*arr)->borrows > 0) {
+        return ARRLIST_IS_BORROWED;
+    }
+
     // No problem on using free on NULL :)
     free((*arr)->buffer);
     free(*arr);
@@ -64,9 +86,10 @@ ArrayListErr arraylist_clear(ArrayList *arr) {
         return ARRLIST_NULL_ARG;
     }
 
-    memset(arr->buffer, 0, arr->capacity * arr->elem_size);
-    arr->capacity = 0;
-    arr->elem_size = 0;
+    if (arr->borrows > 0) {
+        return ARRLIST_IS_BORROWED;
+    }
+
     arr->len = 0;
     return ARRLIST_OK;
 }
@@ -134,6 +157,10 @@ ArrayListErr arraylist_push_back(ArrayList *arr, void *data) {
         return ARRLIST_NULL_ARG;
     }
 
+    if (arr->borrows > 0) {
+        return ARRLIST_IS_BORROWED;
+    }
+
     if (arr->len >= arr->capacity) {
         ArrayListErr err = arraylist_grow(arr);
 
@@ -152,6 +179,10 @@ ArrayListErr arraylist_push_front(ArrayList *arr, void *data) {
         return ARRLIST_NULL_ARG;
     }
 
+    if (arr->borrows > 0) {
+        return ARRLIST_IS_BORROWED;
+    }
+
     if (arr->len >= arr->capacity) {
         ArrayListErr err = arraylist_grow(arr);
 
@@ -162,9 +193,9 @@ ArrayListErr arraylist_push_front(ArrayList *arr, void *data) {
 
     // No problem if array is full because  it grows if it's full
     memmove(
-        arr->buffer,
         arr->buffer + arr->elem_size,
-        (arr->len - 1) * arr->elem_size
+        arr->buffer,
+        (arr->len) * arr->elem_size
     );
 
     memcpy(
@@ -182,6 +213,10 @@ ArrayListErr arraylist_insert(ArrayList *arr, size_t index, void *data) {
         return ARRLIST_NULL_ARG;
     }
 
+    if (arr->borrows > 0) {
+        return ARRLIST_IS_BORROWED;
+    }
+
     if (index > arr->len) {
         return ARRLIST_OUT_OF_BOUNDS;
     }
@@ -212,6 +247,10 @@ ArrayListErr arraylist_pop_back(ArrayList *arr, void *out) {
         return ARRLIST_NULL_ARG;
     }
 
+    if (arr->borrows > 0) {
+        return ARRLIST_IS_BORROWED;
+    }
+
     if (arr->len < 1) {
         return ARRLIST_EMPTY;
     }
@@ -240,6 +279,10 @@ ArrayListErr arraylist_pop_front(ArrayList *arr, void *out) {
         return ARRLIST_NULL_ARG;
     }
 
+    if (arr->borrows > 0) {
+        return ARRLIST_IS_BORROWED;
+    }
+
     if (arr->len < 1) {
         return ARRLIST_EMPTY;
     }
@@ -260,8 +303,8 @@ ArrayListErr arraylist_pop_front(ArrayList *arr, void *out) {
     }
 
     memmove(
-        arr->buffer + arr->elem_size,
         arr->buffer,
+        arr->buffer + arr->elem_size,
         (arr->len - 1) * arr->elem_size);
 
     arr->len--;
@@ -274,12 +317,16 @@ ArrayListErr arraylist_remove_at(ArrayList *arr, size_t index, void *out) {
         return ARRLIST_NULL_ARG;
     }
 
+    if (arr->borrows > 0) {
+        return ARRLIST_IS_BORROWED;
+    }
+
     if (index >= arr->len) {
         return ARRLIST_OUT_OF_BOUNDS;
     }
 
     if (arr->len < 1) {
-        return ARRLIST_OK;
+        return ARRLIST_EMPTY;
     }
 
     if (out != NULL) {
@@ -290,13 +337,10 @@ ArrayListErr arraylist_remove_at(ArrayList *arr, size_t index, void *out) {
         );
     }
 
-    for (size_t i = index; i < arr->len; i++) {
-        memcpy(
+    memmove(
         arr->buffer + (index * arr->elem_size),
-            arr->buffer + ((i + 1) * arr->elem_size),
-            arr->elem_size
-        );
-    }
+        arr->buffer + ((index + 1) * arr->elem_size),
+        (arr->len - index) * arr->elem_size);
 
     arr->len--;
 
@@ -342,6 +386,10 @@ ArrayListErr arraylist_resize(ArrayList *arr, size_t new_capacity) {
         return ARRLIST_NULL_ARG;
     }
 
+    if (arr->borrows > 0) {
+        return ARRLIST_IS_BORROWED;
+    }
+
     if (new_capacity < 1) {
         return ARRLIST_INVALID_CAPACITY;
     }
@@ -365,11 +413,13 @@ ArrayListErr arraylist_reserve(ArrayList *arr, size_t size_to_reserve) {
         return ARRLIST_NULL_ARG;
     }
 
-    if (size_to_reserve < 1) {
-        return ARRLIST_INVALID_CAPACITY;
+    if (arr->borrows > 0) {
+        return ARRLIST_IS_BORROWED;
     }
 
-    if (arr->capacity + size_to_reserve > SIZE_MAX / arr->elem_size) {
+    if (arr->capacity + size_to_reserve > SIZE_MAX / arr->elem_size ||
+        size_to_reserve > SIZE_MAX / arr->elem_size) {
+
         return  ARRLIST_ALLOC_OVERFLOW;
     }
 
@@ -385,3 +435,192 @@ ArrayListErr arraylist_reserve(ArrayList *arr, size_t size_to_reserve) {
     arr->capacity += size_to_reserve;
     return ARRLIST_OK;
 }
+
+ArrayListErr arraylist_slice(ArraySlice **slice, ArrayList *arr, size_t start, size_t len) {
+    if (arr == NULL || slice == NULL) {
+        return ARRLIST_NULL_ARG;
+    }
+
+    if (arr->len == 0) {
+        return ARRLIST_INVALID_ARR;
+    }
+
+    if (start > SIZE_MAX - len) {
+        return ARRLIST_INVALID_CAPACITY;
+    }
+
+    if (start + len > arr->len || len == 0) {
+        return ARRLIST_INVALID_START;
+    }
+
+    ArraySlice *new_slice = malloc(sizeof(ArraySlice));
+    if (new_slice == NULL) {
+        return ARRLIST_BAD_ALLOC;
+    }
+
+    new_slice->arr = arr;
+    new_slice->start = start;
+    new_slice->end = start + len;
+    new_slice->current = start;
+    new_slice->is_safe = true;
+
+    arr->borrows++;
+    *slice = new_slice;
+    return ARRLIST_OK;
+}
+
+ArrayListErr arraylist_slice_unsafe(ArraySlice **slice, ArrayList *arr, size_t start, size_t len) {
+    if (arr == NULL || slice == NULL) {
+        return ARRLIST_NULL_ARG;
+    }
+
+    if (arr->len == 0) {
+        return ARRLIST_INVALID_ARR;
+    }
+
+    if (start > SIZE_MAX - len) {
+        return ARRLIST_INVALID_CAPACITY;
+    }
+
+    if (start + len > arr->len || len == 0) {
+        return ARRLIST_INVALID_START;
+    }
+
+    ArraySlice *new_slice = malloc(sizeof(ArraySlice));
+    if (new_slice == NULL) {
+        return ARRLIST_BAD_ALLOC;
+    }
+
+    new_slice->arr = arr;
+    new_slice->start = start;
+    new_slice->end = start + len;
+    new_slice->current = start;
+    new_slice->is_safe = false;
+
+    *slice = new_slice;
+    return ARRLIST_OK;
+}
+
+ArrayListErr arrayslice_destroy(ArraySlice **slice) {
+    if (slice == NULL || *slice == NULL) {
+        return ARRLIST_NULL_ARG;
+    }
+
+    if ((*slice)->is_safe) {
+        (*slice)->arr->borrows--;
+    }
+
+    free(*slice);
+    *slice = NULL;
+
+    return ARRLIST_OK;
+}
+
+bool arrayslice_is_valid(const ArraySlice *slice) {
+    if (slice == NULL) {
+        return false;
+    }
+
+    return slice->current != slice->end;
+}
+
+size_t arrayslice_size(const ArraySlice *slice) {
+    if (slice == NULL) {
+        return 0;
+    }
+
+    return slice->end - slice->start;
+}
+
+ArrayListErr arrayslice_peek(const ArraySlice *slice, void *out) {
+    if (slice == NULL || out == NULL) {
+        return ARRLIST_NULL_ARG;
+    }
+
+    if (slice->current >= slice->end) {
+        return ARRLIST_INVALID_SLICE;
+    }
+
+    arraylist_get(slice->arr, slice->current, out);
+
+    return ARRLIST_OK;
+}
+
+ArrayListErr arrayslice_next(ArraySlice *slice, void *out) {
+    // HERE, it makes sense that you want to advance to the next
+    // without actually getting the value so it's good
+    if (slice == NULL) {
+        return ARRLIST_NULL_ARG;
+    }
+
+    if (slice->current == slice->end) {
+        return ARRLIST_INVALID_SLICE;
+    }
+
+    arraylist_get(slice->arr, slice->current, out);
+
+    slice->current++;
+    return ARRLIST_OK;
+}
+
+ArrayListErr arrayslice_reset(ArraySlice *slice) {
+    if (slice == NULL) {
+        return ARRLIST_NULL_ARG;
+    }
+
+    slice->current = slice->start;
+
+    return ARRLIST_OK;
+}
+
+ArrayListErr arrayslice_advance(ArraySlice *slice, size_t n) {
+    if (slice == NULL) {
+        return ARRLIST_NULL_ARG;
+    }
+
+    if (n > SIZE_MAX - slice->current || slice->current + n > slice->end) {
+        return ARRLIST_OUT_OF_BOUNDS;
+    }
+    
+    slice->current += n;
+
+    return ARRLIST_OK;
+}
+
+ArrayListErr arrayslice_to_arraylist(ArrayList **arr, const ArraySlice *slice) {
+    if (slice == NULL || slice->arr == NULL) {
+        return ARRLIST_NULL_ARG;
+    }
+
+    if (arr == NULL) {
+        return ARRLIST_NULL_ARG;
+    }
+
+    if (slice->start >= slice->end) {
+        return ARRLIST_INVALID_SLICE;
+    }
+
+    size_t len = slice->end - slice->start;
+
+    ArrayList *new_arr;
+    ArrayListErr init_err = arraylist_init(
+        &new_arr,
+        arraylist_capacity(slice->arr),
+        slice->arr->elem_size
+    );
+
+    if (init_err != ARRLIST_OK) {
+        return init_err;
+    }
+
+    memcpy(
+        new_arr->buffer,
+        slice->arr->buffer + (slice->start * slice->arr->elem_size),
+        slice->arr->elem_size * len
+    );
+
+    new_arr->len = len;
+
+    *arr = new_arr;
+    return ARRLIST_OK;
+}

test/CMakeLists.txt

@@ -3,13 +3,21 @@ find_package(cmocka REQUIRED)
 add_executable(test_arraylist test_arraylist.c)
 
 target_link_libraries(test_arraylist
-    arraylist_lib
+    arraylist
     cmocka::cmocka
 )
 
-enable_sanitizers(test_arraylist)
+# Sanitizers (portables)
+if(ARRAYLIST_ENABLE_SANITIZERS)
+    if(CMAKE_C_COMPILER_ID MATCHES "GNU|Clang")
+        target_compile_options(test_arraylist PRIVATE
+            -fsanitize=address
+            -fno-omit-frame-pointer
+        )
+        target_link_options(test_arraylist PRIVATE
+            -fsanitize=address
+        )
+    endif()
+endif()
 
-target_compile_options(test_arraylist PRIVATE -fsanitize=address -fno-omit-frame-pointer)
-target_link_options(test_arraylist PRIVATE -fsanitize=address)
-
-add_test(NAME arraylist_tests COMMAND arraylists_arena)
+add_test(NAME arraylist_tests COMMAND test_arraylist)