legato_list.h

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2020 Microchip Technology Inc. and its subsidiaries.
*
* Subject to your compliance with these terms, you may use Microchip software
* and any derivatives exclusively with Microchip products. It is your
* responsibility to comply with third party license terms applicable to your
* use of third party software (including open source software) that may
* accompany Microchip software.
*
* THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, WHETHER
* EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, INCLUDING ANY IMPLIED
* WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A
* PARTICULAR PURPOSE.
*
* IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE,
* INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND
* WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS
* BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO THE
* FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS IN
* ANY WAY RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF FEES, IF ANY,
* THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE.
*******************************************************************************/

/*******************************************************************************
 Module for Microchip Graphics Library - Legato User Interface Library

  Company:
    Microchip Technology Inc.

  File Name:
    legato_list.h

  Summary:
    A linked list implementation for the Legato user interface library

  Description:
    This is a linked list implementation that is used internally by the 
    Legato user interface library.  
*******************************************************************************/

#ifndef LEGATO_LIST_H
#define LEGATO_LIST_H

#include "gfx/legato/common/legato_common.h"

#ifdef __cplusplus
extern "C" {
#endif

// *****************************************************************************
/* Structure:
    leListNode

  Summary:
    Linked list node definition

  Remarks:
    None.
*/

typedef struct leListNode
{
    struct leListNode* next; 
    void* val; 
} leListNode;


// *****************************************************************************
/* Structure:
    leList

  Summary:
    Linked list definition

  Remarks:
    None.
*/

typedef struct leList
{
    leListNode* head; 
    leListNode* tail; 
    size_t size; 
} leList;

// *****************************************************************************
int32_t leList_Create(leList* list);

// *****************************************************************************
int32_t leList_Assign(leList* list, size_t idx, void* val);

// *****************************************************************************
int32_t leList_PushFront(leList* list, void*);

// *****************************************************************************
void leList_PopFront(leList* list);

// *****************************************************************************
int32_t leList_PushBack(leList* list, void* val);

// *****************************************************************************
int32_t leList_PopBack(leList* list);

// *****************************************************************************
void* leList_Get(const leList* list, uint32_t idx);

// *****************************************************************************
int32_t leList_Find(const leList* list, void* val);

// *****************************************************************************
int32_t leList_InsertAt(leList* list,
                        void* val,
                        uint32_t idx);

// *****************************************************************************
int32_t leList_Remove(leList* list, void* val);

// *****************************************************************************
int32_t leList_RemoveAt(leList* list, uint32_t idx);

// *****************************************************************************
int32_t leList_Copy(leList* l, leList* r);

// *****************************************************************************
void leList_Clear(leList* list);

// *****************************************************************************
void leList_Destroy(leList* list);

#ifdef __cplusplus
}
#endif

#endif /* LEGATO_LIST_H */