designpatternexamples/general/conststringlist_8h_source.html

#pragma once

#ifndef __CONSTSTRINGLIST_H__

#define __CONSTSTRINGLIST_H__


#include <stdbool.h>


typedef struct _ConstStringList

{

    const char** strings;


    size_t strings_count;


    size_t allocated_count;


} ConstStringList;


void ConstStringList_Initialize(ConstStringList* stringList);


void ConstStringList_Clear(ConstStringList* stringList);


bool ConstStringList_AddString(ConstStringList* stringList, const char* string);


bool ConstStringList_AddStrings(ConstStringList* stringList, const char** strings, size_t numStrings);


void ConstStringList_Remove(ConstStringList* stringList, int removeIndex);


int ConstStringList_Find(ConstStringList* stringList, const char* string);


bool ConstStringList_AreListsEqual(ConstStringList* left, ConstStringList* right);


#endif // __CONSTSTRINGLIST_H__


ConstStringList_Find
int ConstStringList_Find(ConstStringList *stringList, const char *string)
Search the given string list for the given string. If found, return the index of the found string.
Definition: conststringlist.c:141

ConstStringList_Initialize
void ConstStringList_Initialize(ConstStringList *stringList)
Initialize the given string list.
Definition: conststringlist.c:15

ConstStringList_AddStrings
bool ConstStringList_AddStrings(ConstStringList *stringList, const char **strings, size_t numStrings)
Add an array of strings to the given string list.
Definition: conststringlist.c:82

ConstStringList
struct _ConstStringList ConstStringList
Represents a list of pointers to zero-terminated strings that are to remain constant and never delete...

ConstStringList_AreListsEqual
bool ConstStringList_AreListsEqual(ConstStringList *left, ConstStringList *right)
Compare two strings lists to determine if they have the same contents.
Definition: conststringlist.c:163

ConstStringList_AddString
bool ConstStringList_AddString(ConstStringList *stringList, const char *string)
Add a string to the given string list.
Definition: conststringlist.c:45

ConstStringList_Remove
void ConstStringList_Remove(ConstStringList *stringList, int removeIndex)
Remove the specified string from the given string list.
Definition: conststringlist.c:123

ConstStringList_Clear
void ConstStringList_Clear(ConstStringList *stringList)
Clear the specified string list. The strings in the list are left alone, but the list itself is delet...
Definition: conststringlist.c:28

_ConstStringList
Represents a list of pointers to zero-terminated strings that are to remain constant and never delete...
Definition: conststringlist.h:19

_ConstStringList::strings_count
size_t strings_count
Number of strings in the strings list.
Definition: conststringlist.h:29

_ConstStringList::strings
const char ** strings
Pointer to an array of zero-terminated string pointers. These strings are constant and will not be du...
Definition: conststringlist.h:24

_ConstStringList::allocated_count
size_t allocated_count
The number of strings that can be held in the strings list.
Definition: conststringlist.h:34