Files
C-Macro-Collections/cmc/linkedlist/header.h
T

71 lines
3.0 KiB
C

/**
* Copyright (c) 2019 Leonardo Vencovsky
*
* This file is part of the C Macro Collections Library.
*
* 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.
*/
/* Value struct function table */
struct CMC_DEF_FVAL(SNAME)
{
/* Comparator function */
CMC_DEF_FTAB_CMP(V);
/* Copy function */
CMC_DEF_FTAB_CPY(V);
/* To string function */
CMC_DEF_FTAB_STR(V);
/* Free from memory function */
CMC_DEF_FTAB_FREE(V);
/* Hash function */
CMC_DEF_FTAB_HASH(V);
/* Priority function */
CMC_DEF_FTAB_PRI(V);
};
/* Collection Functions */
/* Collection Allocation and Deallocation */
struct SNAME *CMC_(PFX, _new)(struct CMC_DEF_FVAL(SNAME) * f_val);
struct SNAME *CMC_(PFX, _new_custom)(struct CMC_DEF_FVAL(SNAME) * f_val, CMC_ALLOC_TYPE alloc,
CMC_CALLBACK_TYPE callbacks);
void CMC_(PFX, _clear)(struct SNAME *_list_);
void CMC_(PFX, _free)(struct SNAME *_list_);
/* Customization of Allocation and Callbacks */
void CMC_(PFX, _customize)(struct SNAME *_list_, CMC_ALLOC_TYPE alloc, CMC_CALLBACK_TYPE callbacks);
/* Collection Input and Output */
bool CMC_(PFX, _push_front)(struct SNAME *_list_, V value);
bool CMC_(PFX, _push_at)(struct SNAME *_list_, V value, size_t index);
bool CMC_(PFX, _push_back)(struct SNAME *_list_, V value);
bool CMC_(PFX, _pop_front)(struct SNAME *_list_);
bool CMC_(PFX, _pop_at)(struct SNAME *_list_, size_t index);
bool CMC_(PFX, _pop_back)(struct SNAME *_list_);
/* Element Access */
V CMC_(PFX, _front)(struct SNAME *_list_);
V CMC_(PFX, _get)(struct SNAME *_list_, size_t index);
V *CMC_(PFX, _get_ref)(struct SNAME *_list_, size_t index);
V CMC_(PFX, _back)(struct SNAME *_list_);
/* Collection State */
bool CMC_(PFX, _contains)(struct SNAME *_list_, V value);
bool CMC_(PFX, _empty)(struct SNAME *_list_);
size_t CMC_(PFX, _count)(struct SNAME *_list_);
int CMC_(PFX, _flag)(struct SNAME *_list_);
/* Collection Utility */
struct SNAME *CMC_(PFX, _copy_of)(struct SNAME *_list_);
bool CMC_(PFX, _equals)(struct SNAME *_list1_, struct SNAME *_list2_);