Kari Argillander
f806c5829b
* pre-commit: Update and enable clang-format check There is newer version from clang-format so use that. We do not yet want 18 as that is little bit too new. * Format some thing by hand which clang-format "breaks" Clang-format will format some things little bit off in some cases. Format some things by hand so we get cleaner end result. * Run clang-format with ``` pre-commit run --all-files clang-format ``` We have already in previously checked places where clang-format does not make good format and ignored those (hopefully most of the things). --------- Co-authored-by: Kari Argillander <kari.argillander@fidelix.com>
101 lines
2.9 KiB
C
101 lines
2.9 KiB
C
/**
|
|
* @file
|
|
* @brief API for a Key List library
|
|
* @author Steve Karg <skarg@users.sourceforge.net>
|
|
* @date 2003
|
|
* @copyright SPDX-License-Identifier: MIT
|
|
*/
|
|
#ifndef BACNET_SYS_KEYLIST_H
|
|
#define BACNET_SYS_KEYLIST_H
|
|
/* BACnet Stack defines - first */
|
|
#include "bacnet/bacdef.h"
|
|
/* BACnet Stack API */
|
|
#include "bacnet/basic/sys/key.h"
|
|
|
|
/* This is a key sorted linked list data library that */
|
|
/* uses a key or index to access the data. */
|
|
/* If the keys are duplicated, they can be added into the list like FIFO */
|
|
|
|
/* list data and datatype */
|
|
struct Keylist_Node {
|
|
KEY key; /* unique number that is sorted in the list */
|
|
void *data; /* pointer to some data that is stored */
|
|
};
|
|
|
|
typedef struct Keylist {
|
|
struct Keylist_Node **array; /* array of nodes */
|
|
int count; /* number of nodes in this list - more efficient than loop */
|
|
int size; /* number of available nodes on this list - can grow or shrink */
|
|
} KEYLIST_TYPE;
|
|
typedef KEYLIST_TYPE *OS_Keylist;
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif /* __cplusplus */
|
|
|
|
/* returns head of the list or NULL on failure. */
|
|
BACNET_STACK_EXPORT
|
|
OS_Keylist Keylist_Create(void);
|
|
|
|
/* delete specified list */
|
|
/* note: you should pop all the nodes off the list first. */
|
|
BACNET_STACK_EXPORT
|
|
void Keylist_Delete(OS_Keylist list);
|
|
|
|
/* inserts a node into its sorted position */
|
|
/* returns the index where it was added */
|
|
BACNET_STACK_EXPORT
|
|
int Keylist_Data_Add(OS_Keylist list, KEY key, void *data);
|
|
|
|
/* deletes a node specified by its key */
|
|
BACNET_STACK_EXPORT
|
|
/* returns the data from the node */
|
|
void *Keylist_Data_Delete(OS_Keylist list, KEY key);
|
|
|
|
/* deletes a node specified by its index */
|
|
BACNET_STACK_EXPORT
|
|
/* returns the data from the node */
|
|
void *Keylist_Data_Delete_By_Index(OS_Keylist list, int index);
|
|
|
|
/* returns the data from last node, and removes it from the list */
|
|
BACNET_STACK_EXPORT
|
|
void *Keylist_Data_Pop(OS_Keylist list);
|
|
|
|
/* removes and frees all data from the list */
|
|
BACNET_STACK_EXPORT
|
|
void Keylist_Data_Free(OS_Keylist list);
|
|
|
|
/* returns the data from the node specified by key */
|
|
BACNET_STACK_EXPORT
|
|
void *Keylist_Data(OS_Keylist list, KEY key);
|
|
|
|
/* returns the index from the node specified by key */
|
|
BACNET_STACK_EXPORT
|
|
int Keylist_Index(OS_Keylist list, KEY key);
|
|
|
|
/* returns the data specified by index */
|
|
BACNET_STACK_EXPORT
|
|
void *Keylist_Data_Index(OS_Keylist list, int index);
|
|
|
|
/* returns the node key specified by the index */
|
|
BACNET_STACK_DEPRECATED("Use Keylist_Index_Key() instead")
|
|
BACNET_STACK_EXPORT
|
|
KEY Keylist_Key(OS_Keylist list, int index);
|
|
|
|
/* returns the node key specified by the index */
|
|
BACNET_STACK_EXPORT
|
|
bool Keylist_Index_Key(OS_Keylist list, int index, KEY *pKey);
|
|
|
|
/* returns the next empty key from the list */
|
|
BACNET_STACK_EXPORT
|
|
KEY Keylist_Next_Empty_Key(OS_Keylist list, KEY key);
|
|
|
|
/* returns the number of items in the list */
|
|
BACNET_STACK_EXPORT
|
|
int Keylist_Count(OS_Keylist list);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* __cplusplus */
|
|
#endif
|