map_api.h

Go to the documentation of this file.

/*
    MIT License
 
    Copyright (c) 2025 Robin A. Onsay
 
    Permission is hereby granted, free of charge, to any person obtaining
    a copy of this software and associated documentation files
    (the "Software"), to deal in the Software without restriction,
    including without limitation the rights to use, copy, modify, merge,
    publish, distribute, sublicense, and/or sell copies of the Software,
    and to permit persons to whom the Software is furnished to do so,
    subject to the following conditions:
 
    The above copyright notice and this permission notice shall be
    included in all copies or substantial portions of the Software.
*/
 
#ifndef JUNO_MAP_API_H
#define JUNO_MAP_API_H
#include "juno/ds/array_api.h"
#include "juno/macros.h"
#include "juno/memory/pointer_api.h"
#include "juno/module.h"
#include <stdbool.h>
#include <stddef.h>
#include "juno/status.h"
#include "juno/types.h"
#ifdef __cplusplus
extern "C"
{
#endif
typedef struct JUNO_MAP_API_TAG JUNO_MAP_API_T;
typedef struct JUNO_MAP_ROOT_TAG JUNO_MAP_ROOT_T;
typedef struct JUNO_MAP_HASHABLE_POINTER_API_TAG JUNO_MAP_HASHABLE_POINTER_API_T;
struct JUNO_MAP_ROOT_TAG JUNO_MODULE_ROOT(JUNO_MAP_API_T,
    const JUNO_MAP_HASHABLE_POINTER_API_T *ptHashablePointerApi; 
    const JUNO_VALUE_POINTER_API_T *ptValuePointerApi;           
    JUNO_DS_ARRAY_ROOT_T *ptHashMap;                             
);
 
struct JUNO_MAP_HASHABLE_POINTER_API_TAG
{
    JUNO_RESULT_SIZE_T (*Hash)(JUNO_POINTER_T tItem);
    JUNO_RESULT_BOOL_T (*IsValueNull)(JUNO_POINTER_T tItem);
};
 
struct JUNO_MAP_API_TAG
{
    JUNO_RESULT_POINTER_T (*Get)(JUNO_MAP_ROOT_T *ptJunoMap, JUNO_POINTER_T tReturnItem);
    JUNO_STATUS_T (*Set)(JUNO_MAP_ROOT_T *ptJunoMap, JUNO_POINTER_T tItem);
    JUNO_STATUS_T (*Remove)(JUNO_MAP_ROOT_T *ptJunoMap, JUNO_POINTER_T tKey);
};
 
static inline JUNO_STATUS_T JunoDs_MapVerify(JUNO_MAP_ROOT_T *ptMap)
{
    JUNO_ASSERT_EXISTS(
        ptMap &&
        ptMap->ptApi &&
        ptMap->ptHashablePointerApi &&
        ptMap->ptValuePointerApi &&
        ptMap->ptHashMap &&
        ptMap->ptHashablePointerApi->Hash &&
        ptMap->ptHashablePointerApi->IsValueNull &&
        ptMap->ptValuePointerApi->Equals
    );
    JUNO_STATUS_T tStatus = JunoDs_ArrayVerify(ptMap->ptHashMap);
    return tStatus;
}
 
JUNO_STATUS_T JunoDs_MapInit(JUNO_MAP_ROOT_T *ptMapRoot, const JUNO_MAP_HASHABLE_POINTER_API_T *ptHashablePointerApi, const JUNO_VALUE_POINTER_API_T *ptValuePointerApi, JUNO_DS_ARRAY_ROOT_T *ptArray, JUNO_FAILURE_HANDLER_T pfcnFailureHandler, JUNO_USER_DATA_T *pvUserData);
 
JUNO_RESULT_POINTER_T JunoDs_MapGet(JUNO_MAP_ROOT_T *ptJunoMap, JUNO_POINTER_T tItem);
 
JUNO_STATUS_T JunoDs_MapSet(JUNO_MAP_ROOT_T *ptJunoMap, JUNO_POINTER_T tItem);
 
JUNO_STATUS_T JunoDs_MapRemove(JUNO_MAP_ROOT_T *ptJunoMap, JUNO_POINTER_T tKey);
#ifdef __cplusplus
}
#endif
#endif // JUNO_MAP_API_H