v4/apidocs/icalstrarray_8h_source.html

/*======================================================================

 FILE: icalstrarray.h

 CREATOR: Ken Murchison 24 Aug 2022


 SPDX-FileCopyrightText: 2022, Fastmail Pty. Ltd. (https://fastmail.com)

 SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0

 ======================================================================*/


#ifndef ICALSTRARRAY_H

#define ICALSTRARRAY_H


#include "libical_ical_export.h"

#include "icalarray.h"


#include <stdlib.h>


/* An icalstrarray is just an icalarray in disguise. */

typedef icalarray icalstrarray;


#define icalstrarray_new(increment_size) \

    (icalarray_new(sizeof(char *), increment_size))


LIBICAL_ICAL_EXPORT const char *icalstrarray_element_at(icalstrarray *array, size_t position);


LIBICAL_ICAL_EXPORT size_t icalstrarray_size(const icalstrarray *array);


LIBICAL_ICAL_EXPORT size_t icalstrarray_find(icalstrarray *array,

                                             const char *needle);


LIBICAL_ICAL_EXPORT void icalstrarray_append(icalstrarray *array,

                                             const char *elem);


LIBICAL_ICAL_EXPORT void icalstrarray_add(icalstrarray *array,

                                          const char *elem);


LIBICAL_ICAL_EXPORT void icalstrarray_remove_element_at(icalstrarray *array,

                                                        size_t position);


LIBICAL_ICAL_EXPORT void icalstrarray_remove(icalstrarray *array,

                                             const char *del);


LIBICAL_ICAL_EXPORT void icalstrarray_free(icalstrarray *array);


LIBICAL_ICAL_EXPORT void icalstrarray_sort(icalstrarray *array);


LIBICAL_ICAL_EXPORT icalstrarray *icalstrarray_clone(icalstrarray *array);


#endif /* ICALSTRARRAY_H */

icalarray.h
An array of arbitrarily-sized elements which grows dynamically as elements are added.

icalstrarray_element_at
const char * icalstrarray_element_at(icalstrarray *array, size_t position)
Accesses a string stored in the array.
Definition icalstrarray.c:32

icalstrarray_find
size_t icalstrarray_find(icalstrarray *array, const char *needle)
Finds a string in the array.
Definition icalstrarray.c:40

icalstrarray_remove
void icalstrarray_remove(icalstrarray *array, const char *del)
Removes all occurrences of a string.
Definition icalstrarray.c:96

icalstrarray_append
void icalstrarray_append(icalstrarray *array, const char *elem)
Appends a string to the array.
Definition icalstrarray.c:59

icalstrarray_remove_element_at
void icalstrarray_remove_element_at(icalstrarray *array, size_t position)
Removes the string at an array position.
Definition icalstrarray.c:82

icalstrarray_clone
icalstrarray * icalstrarray_clone(icalstrarray *array)
Clones the array and all its elements.
Definition icalstrarray.c:145

icalstrarray_add
void icalstrarray_add(icalstrarray *array, const char *elem)
Appends a string to the array, omitting duplicates.
Definition icalstrarray.c:71

icalstrarray_sort
void icalstrarray_sort(icalstrarray *array)
Sorts the strings in the array in ascending order.
Definition icalstrarray.c:137

icalstrarray_free
void icalstrarray_free(icalstrarray *array)
Frees this array's memory and all its elements.
Definition icalstrarray.c:116

icalstrarray_size
size_t icalstrarray_size(const icalstrarray *array)
Indicates the count of strings stored in the array.
Definition icalstrarray.c:24