legato_array.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_array.h

  Summary:
    An array implementation for storing pointers for the
    Legato user interface library

  Description:
    This is an array implementation that is used internally by the 
    Legato user interface library.  
*******************************************************************************/


#ifndef LEGATO_ARRAY_H
#define LEGATO_ARRAY_H

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

#ifdef __cplusplus
extern "C" {
#endif

// *****************************************************************************
typedef struct leArray
{
    void** values;  
    uint32_t size; 
    uint32_t capacity; 
} leArray;

// *****************************************************************************
leResult leArray_Create(leArray* arr);


// *****************************************************************************
leResult leArray_Resize(leArray* arr, uint32_t sz);

// *****************************************************************************
leResult leArray_PushFront(leArray* arr, void* val);

// *****************************************************************************
leResult leArray_PopFront(leArray* arr);

// *****************************************************************************
leResult leArray_PushBack(leArray* arr, void* val);

// *****************************************************************************
leResult leArray_PopBack(leArray* arr);

// *****************************************************************************
leResult leArray_InsertAt(leArray* arr,
                          uint32_t idx,
                          void* val);

// *****************************************************************************
leResult leArray_RemoveAt(leArray* arr, uint32_t idx);

// *****************************************************************************
leResult leArray_Remove(leArray* arr, void* val);

// *****************************************************************************
void* leArray_Get(const leArray* arr, uint32_t idx);

// *****************************************************************************
leResult leArray_Set(leArray* arr, uint32_t idx, void* val);

// *****************************************************************************
int32_t leArray_Find(const leArray* arr, void* val);

// *****************************************************************************
leResult leArray_Copy(leArray* src, leArray* dest);

// *****************************************************************************
leResult leArray_Clear(leArray* arr);

#ifdef __cplusplus
}
#endif

#endif /* LEGATO_ARRAY_H */