kArray3.h

Go to the documentation of this file.

#ifndef K_API_ARRAY_3_H
#define K_API_ARRAY_3_H

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

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

kFx(kStatus) kArray3_Construct(kArray3* array, kType itemType, kSize length0, kSize length1, kSize length2, kAlloc allocator);

kFx(kStatus) kArray3_ConstructEx(kArray3* array, kType itemType, kSize length0, kSize length1, kSize length2,  kAlloc allocator, kAlloc valueAllocator);

kFx(kStatus) kArray3_Allocate(kArray3 array, kType itemType, kSize length0, kSize length1, kSize length2); 

kInlineFx(kStatus) kArray3_Resize(kArray3 array, kSize length0, kSize length1, kSize length2)
{
    return kArray3_Allocate(array, kArray3_ItemType(array), length0, length1, length2); 
}

kFx(kStatus) kArray3_Attach(kArray3 array, void* items, kType itemType, kSize length0, kSize length1, kSize length2); 

#define kArray3_AttachT(kArray3_array, TPtr_items, kType_itemType, kSize_length0, kSize_length1, kSize_length2) \
    xkArray3_AttachT(kArray3_array, TPtr_items, kType_itemType, kSize_length0, kSize_length1, kSize_length2, sizeof(*(TPtr_items)))

kInlineFx(kStatus) kArray3_Assign(kArray3 array, kArray3 source)
{
    return xkArray3_Assign(array, source, kNULL);
}

#if defined (K_CPP)
kInlineFx(kStatus) kArray3_Assign(kArray3 array, kArray3 source, kObject context)
{
    return xkArray3_Assign(array, source, context);
}
#endif

kFx(kStatus) kArray3_Zero(kArray3 array); 

kFx(kStatus) kArray3_SetItem(kArray3 array, kSize index0, kSize index1, kSize index2, const void* item); 

#define kArray3_SetItemT(kArray3_array, kSize_index0, kSize_index1, kSize_index2, TPtr_item) \
    xkArray3_SetItemT(kArray3_array, kSize_index0, kSize_index1, kSize_index2, TPtr_item, sizeof(*(TPtr_item)))

kFx(kStatus) kArray3_Item(kArray3 array, kSize index0, kSize index1, kSize index2, void* item); 

#define kArray3_ItemT(kArray3_array, kSize_index0, kSize_index1, kSize_index2, TPtr_item) \
    xkArray3_ItemT(kArray3_array, kSize_index0, kSize_index1, kSize_index2, TPtr_item, sizeof(*(TPtr_item)))


#define kArray3_SetAsT(kArray3_array, kSize_index0, kSize_index1, kSize_index2, T_value, T) \
    (kPointer_WriteAs(xkArray3_AsT(kArray3_array, kSize_index0, kSize_index1, kSize_index2, sizeof(T)), T_value, T), (void)0)

#define kArray3_AsT(kArray3_array, kSize_index0, kSize_index1, kSize_index2, T) \
    kPointer_ReadAs(xkArray3_AsT(kArray3_array, kSize_index0, kSize_index1, kSize_index2, sizeof(T)), T)

kInlineFx(void*) kArray3_Data(kArray3 array)
{
    kObj(kArray3, array);

    return obj->items; 
}

#define kArray3_DataT(kArray3_array, T) \
    kCast(T*, xkArray3_DataT(kArray3_array, sizeof(T)))

kInlineFx(void*) kArray3_DataAt(kArray3 array, kSSize index0, kSSize index1, kSSize index2)
{
    kObj(kArray3, array); 
    kSSize index = (index0*(kSSize)obj->length[1] + index1)*(kSSize)obj->length[2] + index2; 

    return kPointer_ItemOffset(obj->items, index, obj->itemSize);
}

#define kArray3_DataAtT(kArray3_array, kSize_index0, kSize_index1, kSize_index2, T) \
    kCast(T*, xkArray3_DataAtT(kArray3_array, kSize_index0, kSize_index1, kSize_index2, sizeof(T)))

kInlineFx(kSize) kArray3_DataSize(kArray3 array)
{
    kObj(kArray3, array); 

    return kArray3_Count(array) * obj->itemSize;
}

kInlineFx(void*) kArray3_At(kArray3 array, kSize index0, kSize index1, kSize index2)
{    
#   if !defined(K_FSS_912_DISABLE_BOUNDS_CHECK)
    {
        kAssert(index0 < kArray3_Length(array, 0));
        kAssert(index1 < kArray3_Length(array, 1));
        kAssert(index2 < kArray3_Length(array, 2));
    }
#   endif

    return kArray3_DataAt(array, (kSSize)index0, (kSSize)index1, (kSSize)index2);
}

#define kArray3_AtT(kArray3_array, kSize_index0, kSize_index1, kSize_index2, T) \
    kCast(T*, xkArray3_AtT(kArray3_array, kSize_index0, kSize_index1, kSize_index2, sizeof(T)))

kInlineFx(kType) kArray3_ItemType(kArray3 array)
{
    kObj(kArray3, array); 

    return obj->itemType;  
}

kInlineFx(kSize) kArray3_ItemSize(kArray3 array)
{
    kObj(kArray3, array); 

    return obj->itemSize;
}

kInlineFx(kSize) kArray3_Length(kArray3 array, kSize dimension)
{
    kObj(kArray3, array); 

    kAssert(dimension < 3); 

    return obj->length[dimension];
}

kInlineFx(kSize) kArray3_Count(kArray3 array)
{
    kObj(kArray3, array); 

    return obj->length[0] * obj->length[1] * obj->length[2];
}

kInlineFx(kAlloc) kArray3_DataAlloc(kArray3 array)
{
    kObj(kArray3, array);

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

#endif