legato_dynamicstring.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.
*******************************************************************************/

#ifndef LEGATO_DYNAMICSTRING_H
#define LEGATO_DYNAMICSTRING_H

#include "gfx/legato/string/legato_string.h"

/* internal use only */
struct leDynamicString;

#define LE_DYNAMICSTRING_VTABLE(THIS_TYPE) \
    LE_STRING_VTABLE(THIS_TYPE) \
    \
        uint32_t (*getCapacity)(THIS_TYPE* str); \
        leResult (*setCapacity)(THIS_TYPE* str, uint32_t cap); \

typedef struct leDynamicStringVTable
{
    LE_DYNAMICSTRING_VTABLE(struct leDynamicString)
} leDynamicStringVTable;
// *****************************************************************************
typedef struct leDynamicString
{
    leString base;                      
    const leDynamicStringVTable* fn;    
    leChar*     data;                   
    uint16_t    capacity;               
    uint16_t    length;                 
    const leFont*  font;                
} leDynamicString;

// *****************************************************************************
leDynamicString* leDynamicString_New(void);

// *****************************************************************************
void leDynamicString_Constructor(leDynamicString* str);


#ifdef _DOXYGEN_
#define THIS_TYPE struct leWidget

// *****************************************************************************
virtual uint32_t getCapacity(leDynamicString* _this);

// *****************************************************************************
virtual leResult setCapacity(leDynamicString* _this,
                             uint32_t cap);

#undef THIS_TYPE
#endif

#endif /* LEGATO_DYNAMICSTRING_H */