string_utils.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_UTILS_H
#define STRING_UTILS_H
 
#include <stdio.h>
 
#include "typedefs.h"
#include "grassroots_util_library.h"
#include "linked_list.h"
 
 
#ifdef __cplusplus
  extern "C" {
#endif
 
 
GRASSROOTS_UTIL_API char *CopyToNewString (const char * const src_p, const size_t length_to_copy, bool trim);
 
 
GRASSROOTS_UTIL_API char *EasyCopyToNewString (const char * const src_s);
 
 
GRASSROOTS_UTIL_API void FreeCopiedString (char *str_p);
 
 
GRASSROOTS_UTIL_API bool GetLineFromFile (FILE *in_f, char **buffer_pp);
 
 
GRASSROOTS_UTIL_API void FreeLineBuffer (char *buffer_p);
 
 
GRASSROOTS_UTIL_API bool CloneValidString (const char *src_s, char **dest_ss);
 
 
GRASSROOTS_UTIL_API LinkedList *ParseStringToStringLinkedList (const char * const format_p, const char * const delimiters_p, const bool treat_whitespace_as_delimiter_flag);
 
 
 
GRASSROOTS_UTIL_API LinkedList *ParseStringToIntLinkedList (const char * const format_p, const char * const delimiters_p);
 
 
GRASSROOTS_UTIL_API LinkedList *ParseStringToDataLinkedList (const char * const format_p, const char * const delimiters_p);
 
 
GRASSROOTS_UTIL_API char *ConcatenateStrings (const char * const first_s, const char * const second_s);
 
 
GRASSROOTS_UTIL_API void ReplaceCharacter (char *value_s, const char char_to_replace, const char replacement_char);
 
 
 
GRASSROOTS_UTIL_API bool SearchAndReplaceInString (const char *src_s, char **dest_ss, const char *to_replace_s, const char *with_s);
 
 
GRASSROOTS_UTIL_API bool GetKeyValuePair (char *line_p, char **key_pp, char **value_pp, const char comment_identifier);
 
 
GRASSROOTS_UTIL_API char *GetNextToken (const char **start_pp, const char *delimiters_p, const bool check_for_whitespace_flag, const bool update_position_flag);
 
GRASSROOTS_UTIL_API void FreeToken (char *token_s);
 
 
GRASSROOTS_UTIL_API void NullifyTrailingZeroes (char *numeric_string_p);
 
 
GRASSROOTS_UTIL_API bool IsStringEmpty (const char *value_s);
 
 
GRASSROOTS_UTIL_API int Stricmp (const char *c0_s, const char *c1_s);
 
 
GRASSROOTS_UTIL_API int Strnicmp (const char *c0_s, const char *c1_s, size_t length);
 
 
GRASSROOTS_UTIL_API const char *Stristr (const char *value_s, const char *substring_s);
 
 
 
GRASSROOTS_UTIL_API char *Strrstr (const char *haystack_s, const char *needle_s);
 
 
 
GRASSROOTS_UTIL_API bool ReplaceStringValue (char **dest_ss, const char * const src_s);
 
 
GRASSROOTS_UTIL_API void ReplaceChars (char *value_s, char old_data, char new_data);
 
 
GRASSROOTS_UTIL_API uint32 HashString (const void * const key_p);
 
 
GRASSROOTS_UTIL_API char *GetFileContentsAsString (FILE *input_f);
 
 
GRASSROOTS_UTIL_API char *GetFileContentsAsStringByFilename (const char *filename_s);
 
GRASSROOTS_UTIL_API char *ConcatenateVarargsStrings (const char *value_s, ...);
 
 
 
 
 
 
GRASSROOTS_UTIL_API bool DoesStringContainWhitespace (const char *value_s);
 
 
GRASSROOTS_UTIL_API bool DoesStringEndWith (const char *value_s, const char *ending_s);
 
 
GRASSROOTS_UTIL_API bool DoesStringStartWith (const char *value_s, const char *start_s);
 
 
GRASSROOTS_UTIL_API char *GetStringAsLowerCase (const char *value_s);
 
 
GRASSROOTS_UTIL_API void FreeStringArray (char **values_ss, const size_t num_values);
 
 
GRASSROOTS_UTIL_API bool DoStringsMatch (const char * const val_0_s, const char * const val_1_s);
 
 
GRASSROOTS_UTIL_API bool CopyAndAddStringValue (const char * const src_s, char **dest_ss);
 
 
GRASSROOTS_UTIL_API char *RemoveStartingAndTrailingWhitespace (const char *value_s);
 
 
#ifdef __cplusplus
}
#endif
 
 
 
 
 
#endif  /* #ifndef STRING_UTILS_H */