sopc_singly_linked_list.h

Go to the documentation of this file.

/*
 * Licensed to Systerel under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Systerel licenses this file to you under the Apache
 * License, Version 2.0 (the "License"); you may not use this
 * file except in compliance with the License. You may obtain
 * a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
 
#ifndef SOPC_SINGLY_LINKED_LIST_H_
#define SOPC_SINGLY_LINKED_LIST_H_
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
typedef struct SOPC_SLinkedList SOPC_SLinkedList;
 
typedef struct SOPC_SLinkedList_Elt SOPC_SLinkedList_Elt;
 
typedef SOPC_SLinkedList_Elt* SOPC_SLinkedListIterator;
 
SOPC_SLinkedList* SOPC_SLinkedList_Create(size_t sizeMax);
 
uintptr_t SOPC_SLinkedList_Prepend(SOPC_SLinkedList* list, uint32_t id, uintptr_t value);
 
uintptr_t SOPC_SLinkedList_Append(SOPC_SLinkedList* list, uint32_t id, uintptr_t value);
 
uintptr_t SOPC_SLinkedList_SortedInsert(SOPC_SLinkedList* list,
                                        uint32_t id,
                                        uintptr_t value,
                                        int8_t (*pCompFn)(uintptr_t left, uintptr_t right));
 
uintptr_t SOPC_SLinkedList_PopHead(SOPC_SLinkedList* list);
 
uintptr_t SOPC_SLinkedList_PopLast(SOPC_SLinkedList* list);
 
uintptr_t SOPC_SLinkedList_GetHead(SOPC_SLinkedList* list);
 
uintptr_t SOPC_SLinkedList_GetLast(SOPC_SLinkedList* list);
 
uintptr_t SOPC_SLinkedList_FindFromId(SOPC_SLinkedList* list, uint32_t id);
 
void SOPC_SLinkedList_Apply(SOPC_SLinkedList* list, void (*pFn)(uint32_t id, uintptr_t val));
 
uintptr_t SOPC_SLinkedList_RemoveFromId(SOPC_SLinkedList* list, uint32_t id);
 
uintptr_t SOPC_SLinkedList_RemoveFromValuePtr(SOPC_SLinkedList* list, uintptr_t value);
 
void SOPC_SLinkedList_Clear(SOPC_SLinkedList* list);
 
void SOPC_SLinkedList_Delete(SOPC_SLinkedList* list);
 
void SOPC_SLinkedList_EltGenericFree(uint32_t id, uintptr_t val);
 
SOPC_SLinkedListIterator SOPC_SLinkedList_GetIterator(SOPC_SLinkedList* list);
 
bool SOPC_SLinkedList_HasNext(const SOPC_SLinkedListIterator* it);
 
uintptr_t SOPC_SLinkedList_Next(SOPC_SLinkedListIterator* it);
 
uintptr_t SOPC_SLinkedList_NextWithId(SOPC_SLinkedListIterator* it, uint32_t* pId);
 
uint32_t SOPC_SLinkedList_GetLength(SOPC_SLinkedList* list);
 
uint32_t SOPC_SLinkedList_GetCapacity(SOPC_SLinkedList* list);
 
bool SOPC_SLinkedList_SetCapacity(SOPC_SLinkedList* list, size_t sizeMax);
 
#endif /* SOPC_SINGLE_LINKED_LIST_H_ */