Files
zTC1/mico-os/libraries/utilities/LinkListUtils.h

111 lines
4.0 KiB
C

/**
******************************************************************************
* @file LinkListUtils.h
* @author William Xu
* @version V1.0.0
* @date 12-Jan-2015
* @brief This header contains function prototypes called by link list operation
******************************************************************************
*
* The MIT License
* Copyright (c) 2014 MXCHIP Inc.
*
* 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.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
* IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
******************************************************************************
*/
#pragma once
#include "common.h"
#ifdef __cplusplus
extern "C" {
#endif
/******************************************************
* Type Definitions
******************************************************/
typedef struct linked_list_node linked_list_node_t;
/******************************************************
* Structures
******************************************************/
#pragma pack(1)
struct linked_list_node
{
void* data;
linked_list_node_t* next;
linked_list_node_t* prev;
};
typedef struct
{
uint32_t count;
linked_list_node_t* front;
linked_list_node_t* rear;
} linked_list_t;
#pragma pack()
typedef bool (*linked_list_compare_callback_t)( linked_list_node_t* node_to_compare, void* user_data );
/******************************************************
* Global Variables
******************************************************/
/******************************************************
* Function Declarations
******************************************************/
OSStatus linked_list_init( linked_list_t* list );
OSStatus linked_list_deinit( linked_list_t* list );
OSStatus linked_list_get_count( linked_list_t* list, uint32_t* count );
OSStatus linked_list_set_node_data( linked_list_node_t* node, const void* data );
OSStatus linked_list_get_front_node( linked_list_t* list, linked_list_node_t** front_node );
OSStatus linked_list_get_rear_node( linked_list_t* list, linked_list_node_t** rear_node );
OSStatus linked_list_find_node( linked_list_t* list, linked_list_compare_callback_t callback, void* user_data, linked_list_node_t** node_found );
OSStatus linked_list_insert_node_at_front( linked_list_t* list, linked_list_node_t* node );
OSStatus linked_list_insert_node_at_rear( linked_list_t* list, linked_list_node_t* node );
OSStatus linked_list_insert_node_before( linked_list_t* list, linked_list_node_t* reference_node, linked_list_node_t* node_to_insert );
OSStatus linked_list_insert_node_after( linked_list_t* list, linked_list_node_t* reference_node, linked_list_node_t* node_to_insert );
OSStatus linked_list_remove_node( linked_list_t* list, linked_list_node_t* node );
OSStatus linked_list_remove_node_from_front( linked_list_t* list, linked_list_node_t** removed_node );
OSStatus linked_list_remove_node_from_rear( linked_list_t* list, linked_list_node_t** removed_node );
#ifdef __cplusplus
} /* extern "C" */
#endif