gwenhywfar  4.13.1
Typedefs | Enumerations | Functions
stringlist.h File Reference
#include <gwenhywfar/gwenhywfarapi.h>

Go to the source code of this file.

Typedefs

typedef struct GWEN_STRINGLISTSTRUCT GWEN_STRINGLIST
 
typedef struct GWEN_STRINGLISTENTRYSTRUCT GWEN_STRINGLISTENTRY
 

Enumerations

enum  GWEN_STRINGLIST_SORT_MODE { GWEN_StringList_SortModeNoCase =0, GWEN_StringList_SortModeCase, GWEN_StringList_SortModeInt }
 

Functions

GWENHYWFAR_API void GWEN_StringList_AppendEntry (GWEN_STRINGLIST *sl, GWEN_STRINGLISTENTRY *se)
 
GWENHYWFAR_API int GWEN_StringList_AppendString (GWEN_STRINGLIST *sl, const char *s, int take, int checkDouble)
 
GWENHYWFAR_API void GWEN_StringList_Clear (GWEN_STRINGLIST *sl)
 
GWENHYWFAR_API unsigned int GWEN_StringList_Count (const GWEN_STRINGLIST *sl)
 
GWENHYWFAR_API GWEN_STRINGLISTGWEN_StringList_dup (const GWEN_STRINGLIST *sl)
 
GWENHYWFAR_API GWEN_STRINGLISTENTRYGWEN_StringList_FindStringEntry (const GWEN_STRINGLIST *sl, const char *s)
 
GWENHYWFAR_API GWEN_STRINGLISTENTRYGWEN_StringList_FirstEntry (const GWEN_STRINGLIST *sl)
 
GWENHYWFAR_API const char * GWEN_StringList_FirstString (const GWEN_STRINGLIST *l)
 
GWENHYWFAR_API void * GWEN_StringList_ForEach (const GWEN_STRINGLIST *l, void *(*func)(const char *s, void *u), void *user_data)
 
GWENHYWFAR_API void GWEN_StringList_free (GWEN_STRINGLIST *sl)
 
GWENHYWFAR_API GWEN_STRINGLISTGWEN_StringList_fromString (const char *str, const char *delimiters, int checkDouble)
 
GWENHYWFAR_API GWEN_STRINGLISTGWEN_StringList_fromTabString (const char *s, int checkDup)
 
GWENHYWFAR_API int GWEN_StringList_GetStringPos (const GWEN_STRINGLIST *sl, const char *s)
 
GWENHYWFAR_API int GWEN_StringList_HasString (const GWEN_STRINGLIST *sl, const char *s)
 
GWENHYWFAR_API int GWEN_StringList_InsertString (GWEN_STRINGLIST *sl, const char *s, int take, int checkDouble)
 
GWENHYWFAR_API GWEN_STRINGLISTGWEN_StringList_new (void)
 
GWENHYWFAR_API void GWEN_StringList_RemoveEntry (GWEN_STRINGLIST *sl, GWEN_STRINGLISTENTRY *se)
 
GWENHYWFAR_API int GWEN_StringList_RemoveString (GWEN_STRINGLIST *sl, const char *s)
 
GWENHYWFAR_API void GWEN_StringList_SetIgnoreRefCount (GWEN_STRINGLIST *sl, int i)
 
GWENHYWFAR_API void GWEN_StringList_SetSenseCase (GWEN_STRINGLIST *sl, int i)
 
GWENHYWFAR_API void GWEN_StringList_Sort (GWEN_STRINGLIST *l, int ascending, GWEN_STRINGLIST_SORT_MODE sortMode)
 
GWENHYWFAR_API const char * GWEN_StringList_StringAt (const GWEN_STRINGLIST *l, int idx)
 
GWENHYWFAR_API const char * GWEN_StringListEntry_Data (const GWEN_STRINGLISTENTRY *se)
 
GWENHYWFAR_API void GWEN_StringListEntry_free (GWEN_STRINGLISTENTRY *sl)
 
GWENHYWFAR_API GWEN_STRINGLISTENTRYGWEN_StringListEntry_new (const char *s, int take)
 
GWENHYWFAR_API GWEN_STRINGLISTENTRYGWEN_StringListEntry_Next (const GWEN_STRINGLISTENTRY *se)
 
GWENHYWFAR_API void GWEN_StringListEntry_ReplaceString (GWEN_STRINGLISTENTRY *e, const char *s, int take)
 
GWENHYWFAR_API void GWEN_StringListEntry_SetData (GWEN_STRINGLISTENTRY *se, const char *s)
 

Typedef Documentation

typedef struct GWEN_STRINGLISTSTRUCT GWEN_STRINGLIST

Definition at line 54 of file stringlist.h.

typedef struct GWEN_STRINGLISTENTRYSTRUCT GWEN_STRINGLISTENTRY

Definition at line 51 of file stringlist.h.

Enumeration Type Documentation

Enumerator
GWEN_StringList_SortModeNoCase 

case-insensitive, i.e. using strcasecmp(3).

GWEN_StringList_SortModeCase 

case-sensitive, i.e. using strcmp(3).

GWEN_StringList_SortModeInt 

handle string list entries as integers (-> correct sorting of ASCII coded values like "10", "1")

Definition at line 39 of file stringlist.h.

Function Documentation

GWENHYWFAR_API void GWEN_StringList_AppendEntry ( GWEN_STRINGLIST sl,
GWEN_STRINGLISTENTRY se 
)
GWENHYWFAR_API int GWEN_StringList_AppendString ( GWEN_STRINGLIST sl,
const char *  s,
int  take,
int  checkDouble 
)

Appends a string.

Returns
0 if not appended, !=0 if appended
Parameters
takeif true then the StringList takes over ownership of the string
checkDoubleif true the the string will only be appended if it does not already exist
GWENHYWFAR_API void GWEN_StringList_Clear ( GWEN_STRINGLIST sl)
GWENHYWFAR_API unsigned int GWEN_StringList_Count ( const GWEN_STRINGLIST sl)

Returns the number of elements in this list.

GWENHYWFAR_API GWEN_STRINGLIST* GWEN_StringList_dup ( const GWEN_STRINGLIST sl)
GWENHYWFAR_API GWEN_STRINGLISTENTRY* GWEN_StringList_FindStringEntry ( const GWEN_STRINGLIST sl,
const char *  s 
)

Returns the first stringlist entry which contains the given string

Returns
string list entry containing the given string, NULL otherwise
GWENHYWFAR_API GWEN_STRINGLISTENTRY* GWEN_StringList_FirstEntry ( const GWEN_STRINGLIST sl)
GWENHYWFAR_API const char* GWEN_StringList_FirstString ( const GWEN_STRINGLIST l)

Returns the first string in this list.

GWENHYWFAR_API void* GWEN_StringList_ForEach ( const GWEN_STRINGLIST l,
void *(*)(const char *s, void *u)  func,
void *  user_data 
)

Traverses the list, calling the callback function 'func' on each list element. Traversal will stop when 'func' returns a non-NULL value, and the routine will return with that value. Otherwise the routine will return NULL.

Parameters
lThe list to traverse.
funcThe function to be called with each list element.
user_dataA pointer passed on to the function 'func'.
Returns
The non-NULL pointer returned by 'func' as soon as it returns one. Otherwise (i.e. 'func' always returns NULL) returns NULL.
GWENHYWFAR_API void GWEN_StringList_free ( GWEN_STRINGLIST sl)
GWENHYWFAR_API GWEN_STRINGLIST* GWEN_StringList_fromString ( const char *  str,
const char *  delimiters,
int  checkDouble 
)
GWENHYWFAR_API GWEN_STRINGLIST* GWEN_StringList_fromTabString ( const char *  s,
int  checkDup 
)
GWENHYWFAR_API int GWEN_StringList_GetStringPos ( const GWEN_STRINGLIST sl,
const char *  s 
)

Returns the position of the given string within the stringlist.

Returns
position, -1 if not found
GWENHYWFAR_API int GWEN_StringList_HasString ( const GWEN_STRINGLIST sl,
const char *  s 
)

Checks whether the given string already exists within in the string list.

Returns
!=0 if found, 0 otherwise
GWENHYWFAR_API int GWEN_StringList_InsertString ( GWEN_STRINGLIST sl,
const char *  s,
int  take,
int  checkDouble 
)

Inserts a string.

Returns
0 if not inserted, !=0 if inserted
Parameters
takeif true then the StringList takes over ownership of the string
checkDoubleif true the the string will only be appended if it does not already exist
GWENHYWFAR_API GWEN_STRINGLIST* GWEN_StringList_new ( void  )
GWENHYWFAR_API void GWEN_StringList_RemoveEntry ( GWEN_STRINGLIST sl,
GWEN_STRINGLISTENTRY se 
)
GWENHYWFAR_API int GWEN_StringList_RemoveString ( GWEN_STRINGLIST sl,
const char *  s 
)

Removes a given string from the stringlist.

Returns
0 if not found, !=0 if found and removed
GWENHYWFAR_API void GWEN_StringList_SetIgnoreRefCount ( GWEN_STRINGLIST sl,
int  i 
)

Normally this group of functions ignores reference counters on stringlist entries when removing a string via GWEN_StringList_RemoveString. You can change this behaviour here.

Parameters
slstring list
iif 0 then reference counters are honoured
GWENHYWFAR_API void GWEN_StringList_SetSenseCase ( GWEN_STRINGLIST sl,
int  i 
)

Normally this group of functions ignores cases when comparing two strings. You can change this behaviour here.

Parameters
slstring list
iif 0 then cases are ignored
GWENHYWFAR_API void GWEN_StringList_Sort ( GWEN_STRINGLIST l,
int  ascending,
GWEN_STRINGLIST_SORT_MODE  sortMode 
)

Sorts this list. Internally this uses qsort(3), so the sorting should be reasonably fast even for large lists.

Parameters
lThe list to sort.
ascendingIf non-zero, the list is sorted ascending, i.e. smallest string first, according to strcmp(3) rules. If zero, the list is sorted descending.
sortModeSee GWEN_StringList_SortModeNoCase and following
GWENHYWFAR_API const char* GWEN_StringList_StringAt ( const GWEN_STRINGLIST l,
int  idx 
)
GWENHYWFAR_API const char* GWEN_StringListEntry_Data ( const GWEN_STRINGLISTENTRY se)
GWENHYWFAR_API void GWEN_StringListEntry_free ( GWEN_STRINGLISTENTRY sl)
GWENHYWFAR_API GWEN_STRINGLISTENTRY* GWEN_StringListEntry_new ( const char *  s,
int  take 
)
GWENHYWFAR_API GWEN_STRINGLISTENTRY* GWEN_StringListEntry_Next ( const GWEN_STRINGLISTENTRY se)
GWENHYWFAR_API void GWEN_StringListEntry_ReplaceString ( GWEN_STRINGLISTENTRY e,
const char *  s,
int  take 
)
GWENHYWFAR_API void GWEN_StringListEntry_SetData ( GWEN_STRINGLISTENTRY se,
const char *  s 
)