456 lines
17 KiB
C
456 lines
17 KiB
C
#ifndef EINA_STRBUF_H
|
|
#define EINA_STRBUF_H
|
|
|
|
#include <stddef.h>
|
|
#include <stdarg.h>
|
|
|
|
#include "eina_types.h"
|
|
|
|
/**
|
|
* @addtogroup Eina_Data_Types_Group Data Types
|
|
*
|
|
* @{
|
|
*/
|
|
/**
|
|
* @addtogroup Eina_String_Buffer_Group String Buffer
|
|
*
|
|
* @brief These functions provide string buffers management.
|
|
*
|
|
* The String Buffer data type is designed to be a mutable string,
|
|
* allowing to append, prepend or insert a string to a buffer.
|
|
*
|
|
* @{
|
|
*/
|
|
/**
|
|
* @typedef Eina_Strbuf
|
|
* Type for a string buffer.
|
|
*/
|
|
typedef struct _Eina_Strbuf Eina_Strbuf;
|
|
|
|
/**
|
|
* @brief Create a new string buffer.
|
|
*
|
|
* @return Newly allocated string buffer instance.
|
|
*
|
|
* This function creates a new string buffer. On error, @c NULL is
|
|
* returned and Eina error is set to #EINA_ERROR_OUT_OF_MEMORY. To
|
|
* free the resources, use eina_strbuf_free().
|
|
*
|
|
* @see eina_strbuf_free()
|
|
* @see eina_strbuf_append()
|
|
* @see eina_strbuf_string_get()
|
|
*/
|
|
EAPI Eina_Strbuf *eina_strbuf_new(void) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
|
|
/**
|
|
* @brief Free a string buffer.
|
|
*
|
|
* @param buf The string buffer to free.
|
|
*
|
|
* This function frees the memory of @p buf. @p buf must have been
|
|
* created by eina_strbuf_new().
|
|
*/
|
|
EAPI void eina_strbuf_free(Eina_Strbuf *buf) EINA_ARG_NONNULL(1);
|
|
/**
|
|
* @brief Reset a string buffer.
|
|
*
|
|
* @param buf The string buffer to reset.
|
|
*
|
|
* This function reset @p buf: the buffer len is set to 0, and the
|
|
* string is set to '\\0'. No memory is free'd.
|
|
*/
|
|
EAPI void eina_strbuf_reset(Eina_Strbuf *buf) EINA_ARG_NONNULL(1);
|
|
|
|
/**
|
|
* @brief Append a string to a buffer, reallocating as necessary.
|
|
*
|
|
* @param buf The string buffer to append to.
|
|
* @param str The string to append.
|
|
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
|
|
*
|
|
* This function appends @p str to @p buf. It computes the length of
|
|
* @p str, so is slightly slower than eina_strbuf_append_length(). If
|
|
* the length is known beforehand, consider using that variant. If
|
|
* @p buf can't append it, #EINA_FALSE is returned, otherwise
|
|
* #EINA_TRUE is returned.
|
|
*
|
|
* @see eina_strbuf_append()
|
|
* @see eina_strbuf_append_length()
|
|
*/
|
|
EAPI Eina_Bool eina_strbuf_append(Eina_Strbuf *buf, const char *str) EINA_ARG_NONNULL(1, 2);
|
|
/**
|
|
* @brief Append an escaped string to a buffer, reallocating as necessary.
|
|
*
|
|
* @param buf The string buffer to append to.
|
|
* @param str The string to append.
|
|
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
|
|
*
|
|
* This function appends the escaped string @p str to @p buf. If @p
|
|
* str can not be appended, #EINA_FALSE is returned, otherwise,
|
|
* #EINA_TRUE is returned.
|
|
*/
|
|
EAPI Eina_Bool eina_strbuf_append_escaped(Eina_Strbuf *buf, const char *str) EINA_ARG_NONNULL(1, 2);
|
|
/**
|
|
* @brief Append a string to a buffer, reallocating as necessary,
|
|
* limited by the given length.
|
|
*
|
|
* @param buf The string buffer to append to.
|
|
* @param str The string to append.
|
|
* @param maxlen The maximum number of characters to append.
|
|
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
|
|
*
|
|
* This function appends at most @p maxlen characters of @p str to
|
|
* @p buf. It can't appends more than the length of @p str. It
|
|
* computes the length of @p str, so is slightly slower than
|
|
* eina_strbuf_append_length(). If the length is known beforehand,
|
|
* consider using that variant (@p maxlen should then be checked so
|
|
* that it is greater than the size of @p str). If @p str can not be
|
|
* appended, #EINA_FALSE is returned, otherwise, #EINA_TRUE is
|
|
* returned.
|
|
*
|
|
* @see eina_strbuf_append()
|
|
* @see eina_strbuf_append_length()
|
|
*/
|
|
EAPI Eina_Bool eina_strbuf_append_n(Eina_Strbuf *buf, const char *str, size_t maxlen) EINA_ARG_NONNULL(1, 2);
|
|
/**
|
|
* @brief Append a string of exact length to a buffer, reallocating as necessary.
|
|
*
|
|
* @param buf The string buffer to append to.
|
|
* @param str The string to append.
|
|
* @param length The exact length to use.
|
|
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
|
|
*
|
|
* This function appends @p str to @p buf. @p str must be of size at
|
|
* most @p length. It is slightly faster than eina_strbuf_append() as
|
|
* it does not compute the size of @p str. It is useful when dealing
|
|
* with strings of known size, such as eina_strngshare. If @p buf
|
|
* can't append it, #EINA_FALSE is returned, otherwise #EINA_TRUE is
|
|
* returned.
|
|
*
|
|
* @see eina_stringshare_length()
|
|
* @see eina_strbuf_append()
|
|
* @see eina_strbuf_append_n()
|
|
*/
|
|
EAPI Eina_Bool eina_strbuf_append_length(Eina_Strbuf *buf, const char *str, size_t length) EINA_ARG_NONNULL(1, 2);
|
|
/**
|
|
* @brief Append a character to a string buffer, reallocating as
|
|
* necessary.
|
|
*
|
|
* @param buf The string buffer to append to.
|
|
* @param c The char to append.
|
|
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
|
|
*
|
|
* This function inserts @p c to @p buf. If it can not insert it,
|
|
* #EINA_FALSE is returned, otherwise #EINA_TRUE is returned.
|
|
*/
|
|
EAPI Eina_Bool eina_strbuf_append_char(Eina_Strbuf *buf, char c) EINA_ARG_NONNULL(1);
|
|
/**
|
|
* @brief Append a string to a buffer, reallocating as necessary.
|
|
*
|
|
* @param buf The string buffer to append to.
|
|
* @param fmt The string to append.
|
|
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
|
|
*
|
|
* @see eina_strbuf_append()
|
|
*/
|
|
EAPI Eina_Bool eina_strbuf_append_printf(Eina_Strbuf *buf, const char *fmt, ...) EINA_ARG_NONNULL(1, 2) EINA_PRINTF(2, 3);
|
|
/**
|
|
* @brief Append a string to a buffer, reallocating as necessary.
|
|
*
|
|
* @param buf The string buffer to append to.
|
|
* @param fmt The string to append.
|
|
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
|
|
*
|
|
* @see eina_strbuf_append()
|
|
*/
|
|
EAPI Eina_Bool eina_strbuf_append_vprintf(Eina_Strbuf *buf, const char *fmt, va_list args) EINA_ARG_NONNULL(1, 2);
|
|
/**
|
|
* @brief Insert a string to a buffer, reallocating as necessary.
|
|
*
|
|
* @param buf The string buffer to insert.
|
|
* @param str The string to insert.
|
|
* @param pos The position to insert the string.
|
|
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
|
|
*
|
|
* This function inserts @p str to @p buf at position @p pos. It
|
|
* computes the length of @p str, so is slightly slower than
|
|
* eina_strbuf_insert_length(). If the length is known beforehand,
|
|
* consider using that variant. If @p buf can't insert it, #EINA_FALSE
|
|
* is returned, otherwise #EINA_TRUE is returned.
|
|
*/
|
|
EAPI Eina_Bool eina_strbuf_insert(Eina_Strbuf *buf, const char *str, size_t pos) EINA_ARG_NONNULL(1, 2);
|
|
/**
|
|
* @brief Insert an escaped string to a buffer, reallocating as
|
|
* necessary.
|
|
*
|
|
* @param buf The string buffer to insert to.
|
|
* @param str The string to insert.
|
|
* @param pos The position to insert the string.
|
|
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
|
|
*
|
|
* This function inserts the escaped string @p str to @p buf at
|
|
* position @p pos. If @p buf can't insert @p str, #EINA_FALSE is
|
|
* returned, otherwise #EINA_TRUE is returned.
|
|
*/
|
|
EAPI Eina_Bool eina_strbuf_insert_escaped(Eina_Strbuf *buf, const char *str, size_t pos) EINA_ARG_NONNULL(1, 2);
|
|
/**
|
|
* @brief Insert a string to a buffer, reallocating as necessary. Limited by maxlen.
|
|
*
|
|
* @param buf The string buffer to insert to.
|
|
* @param str The string to insert.
|
|
* @param maxlen The maximum number of chars to insert.
|
|
* @param pos The position to insert the string.
|
|
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
|
|
*
|
|
* This function inserts @p str ot @p buf at position @p pos, with at
|
|
* most @p maxlen bytes. The number of inserted characters can not be
|
|
* greater than the length of @p str. It computes the length of
|
|
* @p str, so is slightly slower than eina_strbuf_insert_length(). If the
|
|
* length is known beforehand, consider using that variant (@p maxlen
|
|
* should then be checked so that it is greater than the size of
|
|
* @p str). If @p str can not be inserted, #EINA_FALSE is returned,
|
|
* otherwise, #EINA_TRUE is returned.
|
|
*/
|
|
EAPI Eina_Bool eina_strbuf_insert_n(Eina_Strbuf *buf, const char *str, size_t maxlen, size_t pos) EINA_ARG_NONNULL(1, 2);
|
|
/**
|
|
* @brief Insert a string of exact length to a buffer, reallocating as necessary.
|
|
*
|
|
* @param buf The string buffer to insert to.
|
|
* @param str The string to insert.
|
|
* @param length The exact length to use.
|
|
* @param pos The position to insert the string.
|
|
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
|
|
*
|
|
* This function inserts @p str to @p buf. @p str must be of size at
|
|
* most @p length. It is slightly faster than eina_strbuf_insert() as
|
|
* it does not compute the size of @p str. It is useful when dealing
|
|
* with strings of known size, such as eina_strngshare. If @p buf
|
|
* can't insert it, #EINA_FALSE is returned, otherwise #EINA_TRUE is
|
|
* returned.
|
|
*
|
|
* @see eina_stringshare_length()
|
|
* @see eina_strbuf_insert()
|
|
* @see eina_strbuf_insert_n()
|
|
*/
|
|
EAPI Eina_Bool eina_strbuf_insert_length(Eina_Strbuf *buf, const char *str, size_t length, size_t pos) EINA_ARG_NONNULL(1, 2);
|
|
/**
|
|
* @brief Insert a character to a string buffer, reallocating as
|
|
* necessary.
|
|
*
|
|
* @param buf The string buffer to insert to.
|
|
* @param c The char to insert.
|
|
* @param pos The position to insert the char.
|
|
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
|
|
*
|
|
* This function inserts @p c to @p buf at position @p pos. If @p buf
|
|
* can't append it, #EINA_FALSE is returned, otherwise #EINA_TRUE is
|
|
* returned.
|
|
*/
|
|
EAPI Eina_Bool eina_strbuf_insert_char(Eina_Strbuf *buf, char c, size_t pos) EINA_ARG_NONNULL(1);
|
|
/**
|
|
* @brief Insert a string to a buffer, reallocating as necessary.
|
|
*
|
|
* @param buf The string buffer to insert.
|
|
* @param fmt The string to insert.
|
|
* @param pos The position to insert the string.
|
|
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
|
|
*/
|
|
EAPI Eina_Bool eina_strbuf_insert_printf(Eina_Strbuf *buf, const char *fmt, size_t pos, ...) EINA_ARG_NONNULL(1, 2) EINA_PRINTF(2, 4);
|
|
/**
|
|
* @brief Insert a string to a buffer, reallocating as necessary.
|
|
*
|
|
* @param buf The string buffer to insert.
|
|
* @param fmt The string to insert.
|
|
* @param pos The position to insert the string.
|
|
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
|
|
*/
|
|
EAPI Eina_Bool eina_strbuf_insert_vprintf(Eina_Strbuf *buf, const char *fmt, size_t pos, va_list args) EINA_ARG_NONNULL(1, 2);
|
|
|
|
/**
|
|
* @def eina_strbuf_prepend(buf, str)
|
|
* @brief Prepend the given string to the given buffer
|
|
*
|
|
* @param buf The string buffer to prepend to.
|
|
* @param str The string to prepend.
|
|
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
|
|
*
|
|
* This macro is calling eina_strbuf_insert() at position 0.If @p buf
|
|
* can't prepend it, #EINA_FALSE is returned, otherwise #EINA_TRUE is
|
|
* returned.
|
|
*/
|
|
#define eina_strbuf_prepend(buf, str) eina_strbuf_insert(buf, str, 0)
|
|
|
|
/**
|
|
* @def eina_strbuf_prepend_escaped(buf, str)
|
|
* @brief Prepend the given escaped string to the given buffer
|
|
*
|
|
* @param buf The string buffer to prepend to.
|
|
* @param str The string to prepend.
|
|
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
|
|
*
|
|
* This macro is calling eina_strbuf_insert_escaped() at position 0. If
|
|
* @p buf can't prepend it, #EINA_FALSE is returned, otherwise
|
|
* #EINA_TRUE is returned.
|
|
*/
|
|
#define eina_strbuf_prepend_escaped(buf, str) eina_strbuf_insert_escaped(buf, str, 0)
|
|
|
|
/**
|
|
* @def eina_strbuf_prepend_n(buf, str)
|
|
* @brief Prepend the given escaped string to the given buffer
|
|
*
|
|
* @param buf The string buffer to prepend to.
|
|
* @param str The string to prepend.
|
|
* @param maxlen The maximum number of chars to prepend.
|
|
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
|
|
*
|
|
* This macro is calling eina_strbuf_insert_n() at position 0. If
|
|
* @p buf can't prepend it, #EINA_FALSE is returned, otherwise
|
|
* #EINA_TRUE is returned.
|
|
*/
|
|
#define eina_strbuf_prepend_n(buf, str, maxlen) eina_strbuf_insert_n(buf, str, maxlen, 0)
|
|
|
|
/**
|
|
* @def eina_strbuf_prepend_length(buf, str)
|
|
* @brief Prepend the given escaped string to the given buffer
|
|
*
|
|
* @param buf The string buffer to prepend to.
|
|
* @param str The string to prepend.
|
|
* @param length The exact length to use.
|
|
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
|
|
*
|
|
* This macro is calling eina_strbuf_insert_length() at position 0. If
|
|
* @p buf can't prepend it, #EINA_FALSE is returned, otherwise
|
|
* #EINA_TRUE is returned.
|
|
*/
|
|
#define eina_strbuf_prepend_length(buf, str, length) eina_strbuf_insert_length( buf, str, length, 0)
|
|
|
|
/**
|
|
* @def eina_strbuf_prepend_char(buf, str)
|
|
* @brief Prepend the given character to the given buffer
|
|
*
|
|
* @param buf The string buffer to prepend to.
|
|
* @param c The character to prepend.
|
|
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
|
|
*
|
|
* This macro is calling eina_strbuf_insert_char() at position 0. If
|
|
* @p buf can't prepend it, #EINA_FALSE is returned, otherwise
|
|
* #EINA_TRUE is returned.
|
|
*/
|
|
#define eina_strbuf_prepend_char(buf, c) eina_strbuf_insert_char(buf, c, 0)
|
|
|
|
/**
|
|
* @def eina_strbuf_prepend_printf(buf, fmt, ...)
|
|
* @brief Prepend the given string to the given buffer
|
|
*
|
|
* @param buf The string buffer to prepend to.
|
|
* @param str The string to prepend.
|
|
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
|
|
*
|
|
* This macro is calling eina_strbuf_insert_printf() at position 0.If @p buf
|
|
* can't prepend it, #EINA_FALSE is returned, otherwise #EINA_TRUE is
|
|
* returned.
|
|
*/
|
|
#define eina_strbuf_prepend_printf(buf, fmt, ...) eina_strbuf_insert_printf(buf, fmt, 0, ## __VA_ARGS__)
|
|
|
|
/**
|
|
* @def eina_strbuf_prepend_vprintf(buf, fmt, args)
|
|
* @brief Prepend the given string to the given buffer
|
|
*
|
|
* @param buf The string buffer to prepend to.
|
|
* @param fmt The string to prepend.
|
|
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
|
|
*
|
|
* This macro is calling eina_strbuf_insert_vprintf() at position 0.If @p buf
|
|
* can't prepend it, #EINA_FALSE is returned, otherwise #EINA_TRUE is
|
|
* returned.
|
|
*/
|
|
#define eina_strbuf_prepend_vprintf(buf, fmt, args) eina_strbuf_insert_vprintf(buf, fmt, 0, args)
|
|
|
|
/**
|
|
* @brief Remove a slice of the given string buffer.
|
|
*
|
|
* @param buf The string buffer to remove a slice.
|
|
* @param start The initial (inclusive) slice position to start
|
|
* removing, in bytes.
|
|
* @param end The final (non-inclusive) slice position to finish
|
|
* removing, in bytes.
|
|
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
|
|
*
|
|
* This function removes a slice of @p buf, starting at @p start
|
|
* (inclusive) and ending at @p end (non-inclusive). Both values are
|
|
* in bytes. It returns #EINA_FALSE on failure, #EINA_TRUE otherwise.
|
|
*/
|
|
|
|
EAPI Eina_Bool eina_strbuf_remove(Eina_Strbuf *buf, size_t start, size_t end) EINA_ARG_NONNULL(1);
|
|
/**
|
|
* @brief Retrieve a pointer to the contents of a string buffer
|
|
*
|
|
* @param buf The string buffer.
|
|
* @return The current string in the string buffer.
|
|
*
|
|
* This function returns the string contained in @p buf. The returned
|
|
* value must not be modified and will no longer be valid if @p buf is
|
|
* modified. In other words, any eina_strbuf_append() or similar will
|
|
* make that pointer invalid.
|
|
*
|
|
* @see eina_strbuf_string_steal()
|
|
*/
|
|
EAPI const char *eina_strbuf_string_get(const Eina_Strbuf *buf) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
|
|
/**
|
|
* @brief Steal the contents of a string buffer.
|
|
*
|
|
* @param buf The string buffer to steal.
|
|
* @return The current string in the string buffer.
|
|
*
|
|
* This function returns the string contained in @p buf. @p buf is
|
|
* then initialized and does not own the returned string anymore. The
|
|
* caller must release the memory of the returned string by calling
|
|
* free().
|
|
*
|
|
* @see eina_strbuf_string_get()
|
|
*/
|
|
EAPI char *eina_strbuf_string_steal(Eina_Strbuf *buf) EINA_MALLOC EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1);
|
|
/**
|
|
* @brief Free the contents of a string buffer but not the buffer.
|
|
*
|
|
* @param buf The string buffer to free the string of.
|
|
*
|
|
* This function frees the string contained in @p buf without freeing
|
|
* @p buf.
|
|
*/
|
|
EAPI void eina_strbuf_string_free(Eina_Strbuf *buf) EINA_ARG_NONNULL(1);
|
|
/**
|
|
* @brief Retrieve the length of the string buffer content.
|
|
*
|
|
* @param buf The string buffer.
|
|
* @return The current length of the string, in bytes.
|
|
*
|
|
* This function returns the length of @p buf.
|
|
*/
|
|
EAPI size_t eina_strbuf_length_get(const Eina_Strbuf *buf) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT;
|
|
EAPI Eina_Bool eina_strbuf_replace(Eina_Strbuf *buf, const char *str, const char *with, unsigned int n) EINA_ARG_NONNULL(1, 2, 3);
|
|
|
|
/**
|
|
* @def eina_strbuf_replace_first(buf, str, with)
|
|
* @brief Prepend the given character to the given buffer
|
|
*
|
|
* @param buf The string buffer to work with.
|
|
* @param str The string to replace.
|
|
* @param with The replaceing string.
|
|
* @return #EINA_TRUE on success, #EINA_FALSE on failure.
|
|
*
|
|
* This macro is calling eina_strbuf_replace() with the n-th occurence
|
|
* equal to @c 1. If @p buf can't replace it, #EINA_FALSE is returned,
|
|
* otherwise #EINA_TRUE is returned.
|
|
*/
|
|
#define eina_strbuf_replace_first(buf, str, with) eina_strbuf_replace(buf, str, with, 1)
|
|
|
|
EAPI int eina_strbuf_replace_all(Eina_Strbuf *buf, const char *str, const char *with) EINA_ARG_NONNULL(1, 2, 3);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
/**
|
|
* @}
|
|
*/
|
|
#endif /* EINA_STRBUF_H */
|