summaryrefslogtreecommitdiff
path: root/prism/util/pm_string_list.h
blob: 0d406cc5d8036d935d6a3744e8c6e8cfff3af152 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
/**
 * @file pm_string_list.h
 *
 * A list of strings.
 */
#ifndef PRISM_STRING_LIST_H
#define PRISM_STRING_LIST_H

#include "prism/defines.h"
#include "prism/util/pm_string.h"

#include <stddef.h>
#include <stdlib.h>

/**
 * A list of strings.
 */
typedef struct {
    /** The length of the string list. */
    size_t length;

    /** The capacity of the string list that has been allocated. */
    size_t capacity;

    /** A pointer to the start of the string list. */
    pm_string_t *strings;
} pm_string_list_t;

/**
 * Append a pm_string_t to the given string list.
 *
 * @param string_list The string list to append to.
 * @param string The string to append.
 */
void pm_string_list_append(pm_string_list_t *string_list, pm_string_t *string);

/**
 * Free the memory associated with the string list.
 *
 * @param string_list The string list to free.
 */
PRISM_EXPORTED_FUNCTION void pm_string_list_free(pm_string_list_t *string_list);

#endif