string_linked_list.h

Go to the documentation of this file.

/*
** Copyright 2014-2016 The Earlham Institute
** 
** Licensed under the Apache License, Version 2.0 (the "License");
** you may not use this file except in compliance with the License.
** You may obtain a copy of the License at
** 
**     http://www.apache.org/licenses/LICENSE-2.0
** 
** Unless required by applicable law or agreed to in writing, software
** distributed under the License is distributed on an "AS IS" BASIS,
** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
** See the License for the specific language governing permissions and
** limitations under the License.
*/
 
#ifndef STRING_LINKED_LIST_H
#define STRING_LINKED_LIST_H
 
#include <stdio.h>
 
#include "grassroots_util_library.h"
#include "linked_list.h"
#include "memory_allocations.h"
 
 
#ifdef __cplusplus
  extern "C" {
#endif
 
 
typedef struct StringListNode
{
  ListItem sln_node;
 
  char *sln_string_s;
 
  MEM_FLAG sln_string_flag;
} StringListNode;
 
 
GRASSROOTS_UTIL_API StringListNode *AllocateStringListNode (const char * const str_p, const MEM_FLAG mem_flag);
 
 
 
GRASSROOTS_UTIL_API bool InitStringListNode (StringListNode *node_p, const char * const value_s, const MEM_FLAG mem_flag);
 
 
GRASSROOTS_UTIL_API void FreeStringListNode (ListItem * const node_p);
 
 
GRASSROOTS_UTIL_API void ClearStringListNode (StringListNode *node_p);
 
 
GRASSROOTS_UTIL_API LinkedList *AllocateStringLinkedList (void);
 
 
GRASSROOTS_UTIL_API LinkedList *CopyStringLinkedList (const LinkedList * const src_p);
 
 
GRASSROOTS_UTIL_API char *GetStringLinkedListAsString (const LinkedList * const src_p);
 
 
 
GRASSROOTS_UTIL_API bool AddStringToStringLinkedList (LinkedList *list_p, const char * const str_p, const MEM_FLAG mem_flag);
 
 
 
 
 
GRASSROOTS_UTIL_API char *DetachStringFromStringListNode (StringListNode *node_p);
 
 
#ifdef __cplusplus
}
#endif
 
#endif  /* #ifndef STRING_LINKED_LIST_H */