queue_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_DS_QUEUE_API_H
#define JUNO_DS_QUEUE_API_H
#include "juno/ds/array_api.h"
#include "juno/macros.h"
#include "juno/memory/pointer_api.h"
#include "juno/status.h"
#include "juno/module.h"
#include <stddef.h>
#ifdef __cplusplus
extern "C"
{
#endif
 
typedef struct JUNO_DS_QUEUE_ROOT_TAG JUNO_DS_QUEUE_ROOT_T;
typedef struct JUNO_DS_QUEUE_API_TAG  JUNO_DS_QUEUE_API_T;
 
 
struct JUNO_DS_QUEUE_ROOT_TAG JUNO_MODULE_ROOT(JUNO_DS_QUEUE_API_T,
    JUNO_DS_ARRAY_ROOT_T *ptQueueArray; 
    size_t iStartIndex;                 
    size_t zLength;                     
);
 
struct JUNO_DS_QUEUE_API_TAG
{
    JUNO_STATUS_T (*Enqueue)(JUNO_DS_QUEUE_ROOT_T *ptQueue, JUNO_POINTER_T tItem);
    JUNO_STATUS_T (*Dequeue)(JUNO_DS_QUEUE_ROOT_T *ptQueue, JUNO_POINTER_T tReturn);
    JUNO_RESULT_POINTER_T (*Peek)(JUNO_DS_QUEUE_ROOT_T *ptQueue);
};
 
static inline JUNO_STATUS_T JunoDs_QueueApiVerify(const JUNO_DS_QUEUE_API_T *ptQueueApi)
{
     JUNO_ASSERT_EXISTS(
        ptQueueApi &&
        ptQueueApi->Enqueue &&
        ptQueueApi->Dequeue &&
        ptQueueApi->Peek
    );
    return JUNO_STATUS_SUCCESS;   
}
 
// @{"req": ["REQ-QUEUE-001"]}
static inline JUNO_STATUS_T JunoDs_QueueVerify(const JUNO_DS_QUEUE_ROOT_T *ptQueue)
{
    JUNO_ASSERT_EXISTS(ptQueue);
    JUNO_STATUS_T tStatus = JunoDs_ArrayVerify(ptQueue->ptQueueArray);
    JUNO_ASSERT_SUCCESS(tStatus, return tStatus);
    return JunoDs_QueueApiVerify(ptQueue->ptApi);
}
 
JUNO_STATUS_T JunoDs_QueuePush(JUNO_DS_QUEUE_ROOT_T *ptQueue, JUNO_POINTER_T tItem);
JUNO_STATUS_T JunoDs_QueuePop(JUNO_DS_QUEUE_ROOT_T *ptQueue, JUNO_POINTER_T tReturn);
JUNO_RESULT_POINTER_T JunoDs_QueuePeek(JUNO_DS_QUEUE_ROOT_T *ptQueue);
 
JUNO_STATUS_T JunoDs_QueueInit(JUNO_DS_QUEUE_ROOT_T *ptQueue, JUNO_DS_ARRAY_ROOT_T *ptQueueArray, JUNO_FAILURE_HANDLER_T pfcnFailureHdlr, JUNO_USER_DATA_T *pvFailureUserData);
 
#ifdef __cplusplus
}
#endif
#endif // JUNO_DS_QUEUE_API_H