CAENLinkedList.h

Go to the documentation of this file.

/******************************************************************************
*
*   CAEN SpA - Software Division
*   Via Vetraia, 11 - 55049 - Viareggio ITALY
*   +39 0594 388 398 - www.caen.it
*
*******************************************************************************
*
*   Copyright (C) 2019-2022 CAEN SpA
*
*   This file is part of the CAEN Utility.
*
*   The CAEN Utility is free software; you can redistribute it and/or
*   modify it under the terms of the GNU Lesser General Public
*   License as published by the Free Software Foundation; either
*   version 3 of the License, or (at your option) any later version.
*
*   The CAEN Utility is distributed in the hope that it will be useful,
*   but WITHOUT ANY WARRANTY; without even the implied warranty of
*   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
*   Lesser General Public License for more details.
*
*   You should have received a copy of the GNU Lesser General Public
*   License along with the CAEN Utility; if not, see
*   https://www.gnu.org/licenses/.
*
*   SPDX-License-Identifier: LGPL-3.0-or-later
*
******************************************************************************
*
*   \file       CAENLinkedList.h
*   \brief      Utilities to implement linked lists
*   \author     Francesco Pepe
*
******************************************************************************/

#ifndef CAEN_INCLUDE_CAENLINKEDLIST_H_
#define CAEN_INCLUDE_CAENLINKEDLIST_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>

#include <types/CAENLinkedListTypes.h>
#include <CAENUtility.h>

c_nodiscard
CAEN_UTILITY_DLLAPI c_linkedlist_t CAEN_UTILITY_API c_linkedlist_create();

c_nodiscard
CAEN_UTILITY_DLLAPI c_listnode_t* CAEN_UTILITY_API c_linkedlist_insert_after(c_listnode_t* node, void* newElement);

c_nodiscard
CAEN_UTILITY_DLLAPI c_listnode_t* CAEN_UTILITY_API c_linkedlist_insert_before(c_listnode_t* node, void* newElement);

c_nodiscard
CAEN_UTILITY_DLLAPI c_Utility_ErrorCode_t CAEN_UTILITY_API c_linkedlist_insert_last(c_linkedlist_t* list, void* newElement);

c_nodiscard
CAEN_UTILITY_DLLAPI c_Utility_ErrorCode_t CAEN_UTILITY_API c_linkedlist_insert_first(c_linkedlist_t* list, void* newElement);

c_nodiscard
CAEN_UTILITY_DLLAPI void* CAEN_UTILITY_API c_linkedlist_delete(c_linkedlist_t* list, c_listnode_t* node);

c_nodiscard
CAEN_UTILITY_DLLAPI void* CAEN_UTILITY_API c_linkedlist_delete_data_compare(c_linkedlist_t* list, void* data, c_listdata_comparator_t cmp);

c_nodiscard
CAEN_UTILITY_DLLAPI void* CAEN_UTILITY_API c_linkedlist_delete_data(c_linkedlist_t* list, void* data);

c_nodiscard
CAEN_UTILITY_DLLAPI void* CAEN_UTILITY_API c_linkedlist_delete_last(c_linkedlist_t* list);

c_nodiscard
CAEN_UTILITY_DLLAPI void* CAEN_UTILITY_API c_linkedlist_delete_first(c_linkedlist_t* list);

#ifdef __cplusplus
}
#endif

#endif // CAEN_INCLUDE_CAENURL_H_