kArray1.h

Go to the documentation of this file.

#ifndef K_API_ARRAY_1_H
#define K_API_ARRAY_1_H

#include <kApi/kApiDef.h>
#include <kApi/Data/kArray1.x.h>

//typedef kObject kArray1;   --forward-declared in kApiDef.x.h 

kFx(kStatus) kArray1_Construct(kArray1* array, kType itemType, kSize length, kAlloc allocator);

kFx(kStatus) kArray1_ConstructEx(kArray1* array, kType itemType, kSize length, kAlloc allocator, kAlloc valueAllocator);

kFx(kStatus) kArray1_Allocate(kArray1 array, kType itemType, kSize length); 

kInlineFx(kStatus) kArray1_Resize(kArray1 array, kSize length)
{
    return kArray1_Allocate(array, kArray1_ItemType(array), length); 
}

kFx(kStatus) kArray1_Attach(kArray1 array, void* items, kType itemType, kSize length); 

#define kArray1_AttachT(kArray1_array, TPtr_items, kType_itemType, kSize_length) \
    xkArray1_AttachT(kArray1_array, TPtr_items, kType_itemType, kSize_length, sizeof(*(TPtr_items)))

kInlineFx(kStatus) kArray1_Assign(kArray1 array, kArray1 source)
{
    return xkArray1_Assign(array, source, kNULL); 
}

#if defined (K_CPP)
kInlineFx(kStatus) kArray1_Assign(kArray1 array, kArray1 source, kObject context)
{
    return xkArray1_Assign(array, source, context); 
}
#endif 

kFx(kStatus) kArray1_Zero(kArray1 array); 

kFx(kStatus) kArray1_SetItem(kArray1 array, kSize index, const void* item); 

#define kArray1_SetItemT(kArray1_array, kSize_index, TPtr_item) \
    xkArray1_SetItemT(kArray1_array, kSize_index, TPtr_item, sizeof(*(TPtr_item)))

kFx(kStatus) kArray1_Item(kArray1 array, kSize index, void* item); 

#define kArray1_ItemT(kArray1_array, kSize_index, TPtr_item) \
    xkArray1_ItemT(kArray1_array, kSize_index, TPtr_item, sizeof(*(TPtr_item)))

#define kArray1_SetAsT(kArray1_array, kSize_index, T_value, T) \
    (kPointer_WriteAs(xkArray1_AsT(kArray1_array, kSize_index, sizeof(T)), T_value, T), (void)0)

#define kArray1_AsT(kArray1_array, kSize_index, T) \
    kPointer_ReadAs(xkArray1_AsT(kArray1_array, kSize_index, sizeof(T)), T)

kInlineFx(void*) kArray1_Data(kArray1 array)
{
    kObj(kArray1, array);
    
    return obj->items;
}

#define kArray1_DataT(kArray1_array, T) \
    kCast(T*, xkArray1_DataT(kArray1_array, sizeof(T)))

kInlineFx(void*) kArray1_DataAt(kArray1 array, kSSize index)
{
    kObj(kArray1, array);
   
    return kPointer_ItemOffset(obj->items, index, obj->itemSize);
}

#define kArray1_DataAtT(kArray1_array, kSSize_index, T) \
    kCast(T*, xkArray1_DataAtT(kArray1_array, kSSize_index, sizeof(T)))

kInlineFx(kSize) kArray1_DataSize(kArray1 array)
{
    kObj(kArray1, array);

    return obj->length * obj->itemSize;
}

kInlineFx(void*) kArray1_At(kArray1 array, kSize index)
{    
#   if !defined(K_FSS_912_DISABLE_BOUNDS_CHECK)
    {
        kAssert(index < kArray1_Length(array));
    }
#   endif

    return kArray1_DataAt(array, (kSSize)index);
}

#define kArray1_AtT(kArray1_array, kSize_index, T) \
    kCast(T*, xkArray1_AtT(kArray1_array, kSize_index, sizeof(T)))

kInlineFx(kType) kArray1_ItemType(kArray1 array)
{
    kObj(kArray1, array);

    return obj->itemType;
}

kInlineFx(kSize) kArray1_ItemSize(kArray1 array)
{
    kObj(kArray1, array);

    return obj->itemSize;
}

kInlineFx(kSize) kArray1_Length(kArray1 array)
{
    kObj(kArray1, array);

    return obj->length;
}

kInlineFx(kSize) kArray1_Count(kArray1 array)
{
    kObj(kArray1, array);

    return obj->length;
}

kInlineFx(kAlloc) kArray1_DataAlloc(kArray1 array)
{
    kObj(kArray1, array);

    return kType_IsValue(obj->itemType) ? obj->valueAlloc : kObject_Alloc(array); 
}

#endif