You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
libiec61850/src/common/inc/string_utilities.h

143 lines
4.0 KiB
C

/*
* string_utilities.h
*
* Copyright 2013-2018 Michael Zillgith
*
* This file is part of libIEC61850.
*
* libIEC61850 is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* libIEC61850 is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with libIEC61850. If not, see <http://www.gnu.org/licenses/>.
*
* See COPYING file for the complete license text.
*/
#ifndef STRING_UTILITIES_H_
#define STRING_UTILITIES_H_
#include "libiec61850_common_api.h"
#include "linked_list.h"
#ifdef __cplusplus
extern "C" {
#endif
LIB61850_INTERNAL char*
StringUtils_copyString(const char* string);
LIB61850_INTERNAL char*
StringUtils_copyStringMax(char* dest, int maxBufferSize, const char* str1);
LIB61850_INTERNAL char*
StringUtils_copyStringToBuffer(const char* string, char* buffer);
LIB61850_INTERNAL char*
StringUtils_copySubString(char* startPos, char* endPos);
/**
* \brief Concatenate strings. count indicates the number of strings
* to concatenate.
*/
LIB61850_INTERNAL char*
StringUtils_createString(int count, ...);
/**
* \brief Concatenate strings in user provided buffer. count indicates the number of strings
* to concatenate.
*/
LIB61850_INTERNAL char*
StringUtils_createStringInBuffer(char* newStr, int bufSize, int count, ...);
LIB61850_INTERNAL char*
StringUtils_createStringFromBuffer(const uint8_t* buf, int size);
LIB61850_INTERNAL char*
StringUtils_createStringFromBufferInBuffer(char* newString, const uint8_t* buf, int size);
LIB61850_INTERNAL void
StringUtils_replace(char* string, char oldChar, char newChar);
LIB61850_INTERNAL char*
StringUtils_concatString(char* dest, int maxBufferSize, const char* str1, const char* str2);
LIB61850_INTERNAL char*
StringUtils_appendString(char* dest, int maxBufferSize, const char* str);
LIB61850_INTERNAL bool
StringUtils_isDigit(char character);
LIB61850_INTERNAL int
StringUtils_digitToInt(char digit);
LIB61850_INTERNAL int
StringUtils_digitsToInt(const char* digits, int count);
LIB61850_INTERNAL int
StringUtils_createBufferFromHexString(char* hexString, uint8_t* buffer);
/**
* \brief test if string starts with prefix
*/
LIB61850_INTERNAL bool
StringUtils_startsWith(const char* string, const char* prefix);
LIB61850_INTERNAL bool
StringUtils_endsWith(const char* str, const char* suffix);
/**
* \brief Compare to characters using the collation order as defined in ISO 9506-2 7.5.2
*
* \param a the first string
* \param b the second string
*
* \returns 0 if a equals b; a positive number if b > a; a negative number if b < a
*/
LIB61850_INTERNAL int
StringUtils_compareChars(char a, char b);
/**
* \brief Compare to strings using the collation order as defined in ISO 9506-2 7.5.2
*
* \param a the first string
* \param b the second string
*
* \returns 0 if a equals b; a positive number if b > a; a negative number if b < a
*/
LIB61850_INTERNAL int
StringUtils_compareStrings(const char* a, const char* b);
/**
* \brief sort a list of strings alphabetically (according to the MMS identifier collation order)
*
* \param list a list that contains string elements
*/
LIB61850_INTERNAL void
StringUtils_sortList(LinkedList list);
/**
* \brief Convert IPv6 address string to byte array (uint8_t array)
*
* \param addressString the IPv6 address string in standard notation
* \param ipV6Addr buffer to store the IPv6 address bytes (has to be at least 16 bytes)
*
* \return true when parsing has been successful, false otherwise
*/
LIB61850_INTERNAL bool
StringUtils_convertIPv6AdddressStringToByteArray(const char* addressString, uint8_t ipV6Addr[]);
#ifdef __cplusplus
}
#endif
#endif /* STRING_UTILITIES_H_ */