Tizen Native API
|
Functions | |
Eina_UStrbuf * | eina_ustrbuf_new (void) |
Create a new string buffer. | |
Eina_UStrbuf * | eina_ustrbuf_manage_new (Eina_Unicode *str) |
Create a new string buffer using the passed string. The passed string is used directly as the buffer, it's somehow the opposite function of. | |
Eina_UStrbuf * | eina_ustrbuf_manage_new_length (Eina_Unicode *str, size_t length) |
Create a new string buffer using the passed string. The passed string is used directly as the buffer, it's somehow the opposite function of. | |
void | eina_ustrbuf_free (Eina_UStrbuf *buf) |
Free a string buffer. | |
void | eina_ustrbuf_reset (Eina_UStrbuf *buf) |
Reset a string buffer. | |
Eina_Bool | eina_ustrbuf_append (Eina_UStrbuf *buf, const Eina_Unicode *str) 2) |
Append a string to a buffer, reallocating as necessary. | |
Eina_Bool | eina_ustrbuf_append_escaped (Eina_UStrbuf *buf, const Eina_Unicode *str) 2) |
Append an escaped string to a buffer, reallocating as necessary. | |
Eina_Bool | eina_ustrbuf_append_n (Eina_UStrbuf *buf, const Eina_Unicode *str, size_t maxlen) 2) |
Append a string to a buffer, reallocating as necessary, limited by the given length. | |
Eina_Bool | eina_ustrbuf_append_length (Eina_UStrbuf *buf, const Eina_Unicode *str, size_t length) 2) |
Append a string of exact length to a buffer, reallocating as necessary. | |
Eina_Bool | eina_ustrbuf_append_char (Eina_UStrbuf *buf, Eina_Unicode c) |
Append a character to a string buffer, reallocating as necessary. | |
Eina_Bool | eina_ustrbuf_insert (Eina_UStrbuf *buf, const Eina_Unicode *str, size_t pos) 2) |
Insert a string to a buffer, reallocating as necessary. | |
Eina_Bool | eina_ustrbuf_insert_escaped (Eina_UStrbuf *buf, const Eina_Unicode *str, size_t pos) 2) |
Insert an escaped string to a buffer, reallocating as necessary. | |
Eina_Bool | eina_ustrbuf_insert_n (Eina_UStrbuf *buf, const Eina_Unicode *str, size_t maxlen, size_t pos) 2) |
Insert a string to a buffer, reallocating as necessary. Limited by maxlen. | |
Eina_Bool | eina_ustrbuf_insert_length (Eina_UStrbuf *buf, const Eina_Unicode *str, size_t length, size_t pos) 2) |
Insert a string of exact length to a buffer, reallocating as necessary. | |
Eina_Bool | eina_ustrbuf_insert_char (Eina_UStrbuf *buf, Eina_Unicode c, size_t pos) |
Insert a character to a string buffer, reallocating as necessary. | |
Eina_Bool | eina_ustrbuf_remove (Eina_UStrbuf *buf, size_t start, size_t end) |
Remove a slice of the given string buffer. | |
const Eina_Unicode * | eina_ustrbuf_string_get (const Eina_UStrbuf *buf) |
Retrieve a pointer to the contents of a string buffer. | |
Eina_Unicode * | eina_ustrbuf_string_steal (Eina_UStrbuf *buf) |
Steal the contents of a string buffer. | |
void | eina_ustrbuf_string_free (Eina_UStrbuf *buf) |
Free the contents of a string buffer but not the buffer. | |
size_t | eina_ustrbuf_length_get (const Eina_UStrbuf *buf) |
Retrieve the length of the string buffer content. | |
Typedefs | |
typedef struct _Eina_Strbuf | Eina_UStrbuf |
Defines | |
#define | eina_ustrbuf_prepend(buf, str) eina_ustrbuf_insert(buf, str, 0) |
Prepend the given string to the given buffer. | |
#define | eina_ustrbuf_prepend_escaped(buf, str) eina_ustrbuf_insert_escaped(buf, str, 0) |
Prepend the given escaped string to the given buffer. | |
#define | eina_ustrbuf_prepend_n(buf, str, maxlen) eina_ustrbuf_insert_n(buf, str, maxlen, 0) |
Prepend the given escaped string to the given buffer. | |
#define | eina_ustrbuf_prepend_length(buf, str, length) eina_ustrbuf_insert_length(buf, str, length, 0) |
Prepend the given escaped string to the given buffer. | |
#define | eina_ustrbuf_prepend_char(buf, c) eina_ustrbuf_insert_char(buf, c, 0) |
Prepend the given unicode character to the given buffer. |
These functions provide unicode string buffers management.
The Unicode String Buffer data type is designed to be a mutable string, allowing to append, prepend or insert a string to a buffer.
Define Documentation
#define eina_ustrbuf_prepend | ( | buf, | |
str | |||
) | eina_ustrbuf_insert(buf, str, 0) |
Prepend the given string to the given buffer.
- Parameters:
-
buf The string buffer to prepend to. str The string to prepend.
- Returns:
- EINA_TRUE on success, EINA_FALSE on failure.
- Since :
- 2.3
This macro is calling eina_ustrbuf_insert() at position 0.If buf
can't prepend it, EINA_FALSE is returned, otherwise EINA_TRUE is returned.
#define eina_ustrbuf_prepend_char | ( | buf, | |
c | |||
) | eina_ustrbuf_insert_char(buf, c, 0) |
Prepend the given unicode character to the given buffer.
- Parameters:
-
buf The string buffer to prepend to. c The Eina_Unicode character to prepend.
- Returns:
- EINA_TRUE on success, EINA_FALSE on failure.
- Since :
- 2.3
This macro is calling eina_ustrbuf_insert_Eina_Unicode *() at position 0. If buf
can't prepend it, EINA_FALSE is returned, otherwise EINA_TRUE is returned.
#define eina_ustrbuf_prepend_escaped | ( | buf, | |
str | |||
) | eina_ustrbuf_insert_escaped(buf, str, 0) |
Prepend the given escaped string to the given buffer.
- Parameters:
-
buf The string buffer to prepend to. str The string to prepend.
- Returns:
- EINA_TRUE on success, EINA_FALSE on failure.
- Since :
- 2.3
This macro is calling eina_ustrbuf_insert_escaped() at position 0. If buf
can't prepend it, EINA_FALSE is returned, otherwise EINA_TRUE is returned.
#define eina_ustrbuf_prepend_length | ( | buf, | |
str, | |||
length | |||
) | eina_ustrbuf_insert_length(buf, str, length, 0) |
Prepend the given escaped string to the given buffer.
- Parameters:
-
buf The string buffer to prepend to. str The string to prepend. length The exact length to use.
- Returns:
- EINA_TRUE on success, EINA_FALSE on failure.
- Since :
- 2.3
This macro is calling eina_ustrbuf_insert_length() at position 0. If buf
can't prepend it, EINA_FALSE is returned, otherwise EINA_TRUE is returned.
#define eina_ustrbuf_prepend_n | ( | buf, | |
str, | |||
maxlen | |||
) | eina_ustrbuf_insert_n(buf, str, maxlen, 0) |
Prepend the given escaped string to the given buffer.
- Parameters:
-
buf The string buffer to prepend to. str The string to prepend. maxlen The maximum number of Eina_Unicode *s to prepend.
- Returns:
- EINA_TRUE on success, EINA_FALSE on failure.
- Since :
- 2.3
This macro is calling eina_ustrbuf_insert_n() at position 0. If buf
can't prepend it, EINA_FALSE is returned, otherwise EINA_TRUE is returned.
Typedef Documentation
Type for a string buffer.
Function Documentation
Eina_Bool eina_ustrbuf_append | ( | Eina_UStrbuf * | buf, |
const Eina_Unicode * | str | ||
) |
Append a string to a buffer, reallocating as necessary.
- Since :
- 2.3
- Parameters:
-
[in] buf The string buffer to append to. [in] str The string to append.
- Returns:
- EINA_TRUE on success, EINA_FALSE on failure.
- Remarks:
- This function appends
str
tobuf
. It computes the length ofstr
, so is slightly slower than eina_ustrbuf_append_length(). If the length is known beforehand, consider using that variant. Ifbuf
can't append it, EINA_FALSE is returned, otherwise EINA_TRUE is returned.
Eina_Bool eina_ustrbuf_append_char | ( | Eina_UStrbuf * | buf, |
Eina_Unicode | c | ||
) |
Append a character to a string buffer, reallocating as necessary.
- Since :
- 2.3
- Parameters:
-
[in] buf The string buffer to append to. [in] c The char to append.
- Returns:
- EINA_TRUE on success, EINA_FALSE on failure.
- Remarks:
- This function inserts
c
tobuf
. If it can not insert it, EINA_FALSE is returned, otherwise EINA_TRUE is returned.
Eina_Bool eina_ustrbuf_append_escaped | ( | Eina_UStrbuf * | buf, |
const Eina_Unicode * | str | ||
) |
Append an escaped string to a buffer, reallocating as necessary.
- Parameters:
-
buf The string buffer to append to. str The string to append.
- Returns:
- EINA_TRUE on success, EINA_FALSE on failure.
- Since :
- 2.3
This function appends the escaped string str
to buf
. If str
can not be appended, EINA_FALSE is returned, otherwise, EINA_TRUE is returned.
Eina_Bool eina_ustrbuf_append_length | ( | Eina_UStrbuf * | buf, |
const Eina_Unicode * | str, | ||
size_t | length | ||
) |
Append a string of exact length to a buffer, reallocating as necessary.
- Since :
- 2.3
- Parameters:
-
[in] buf The string buffer to append to. [in] str The string to append. [in] length The exact length to use.
- Returns:
- EINA_TRUE on success, EINA_FALSE on failure.
- Remarks:
- This function appends
str
tobuf
.str
must be of size at mostlength
. It is slightly faster than eina_ustrbuf_append() as it does not compute the size ofstr
. It is useful when dealing with strings of known size, such as eina_strngshare. Ifbuf
can't append it, EINA_FALSE is returned, otherwise EINA_TRUE is returned.
- See also:
- eina_stringshare_length()
- eina_ustrbuf_append()
- eina_ustrbuf_append_n()
Eina_Bool eina_ustrbuf_append_n | ( | Eina_UStrbuf * | buf, |
const Eina_Unicode * | str, | ||
size_t | maxlen | ||
) |
Append a string to a buffer, reallocating as necessary, limited by the given length.
- Since :
- 2.3
- Parameters:
-
[in] buf The string buffer to append to. [in] str The string to append. [in] maxlen The maximum number of characters to append.
- Returns:
- EINA_TRUE on success, EINA_FALSE on failure.
- Remarks:
- This function appends at most
maxlen
characters ofstr
tobuf
. It can't appends more than the length ofstr
. It computes the length ofstr
, so is slightly slower than eina_ustrbuf_append_length(). If the length is known beforehand, consider using that variant (maxlen
should then be checked so that it is greater than the size ofstr
). Ifstr
can not be appended, EINA_FALSE is returned, otherwise, EINA_TRUE is returned.
void eina_ustrbuf_free | ( | Eina_UStrbuf * | buf | ) |
Free a string buffer.
- Since :
- 2.3
- Parameters:
-
[in] buf The string buffer to free.
- Remarks:
- This function frees the memory of
buf
.buf
must have been created by eina_ustrbuf_new().
Eina_Bool eina_ustrbuf_insert | ( | Eina_UStrbuf * | buf, |
const Eina_Unicode * | str, | ||
size_t | pos | ||
) |
Insert a string to a buffer, reallocating as necessary.
- Since :
- 2.3
- Parameters:
-
[in] buf The string buffer to insert. [in] str The string to insert. [in] pos The position to insert the string.
- Returns:
- EINA_TRUE on success, EINA_FALSE on failure.
- Remarks:
- This function inserts
str
tobuf
at positionpos
. It computes the length ofstr
, so is slightly slower than eina_ustrbuf_insert_length(). If the length is known beforehand, consider using that variant. Ifbuf
can't insert it, EINA_FALSE is returned, otherwise EINA_TRUE is returned.
Eina_Bool eina_ustrbuf_insert_char | ( | Eina_UStrbuf * | buf, |
Eina_Unicode | c, | ||
size_t | pos | ||
) |
Insert a character to a string buffer, reallocating as necessary.
- Since :
- 2.3
- Parameters:
-
[in] buf The string buffer to insert to. [in] c The char to insert. [in] pos The position to insert the char.
- Returns:
- EINA_TRUE on success, EINA_FALSE on failure.
- Remarks:
- This function inserts
c
tobuf
at positionpos
. Ifbuf
can't append it, EINA_FALSE is returned, otherwise EINA_TRUE is returned.
Eina_Bool eina_ustrbuf_insert_escaped | ( | Eina_UStrbuf * | buf, |
const Eina_Unicode * | str, | ||
size_t | pos | ||
) |
Insert an escaped string to a buffer, reallocating as necessary.
- Parameters:
-
buf The string buffer to insert to. str The string to insert. pos The position to insert the string.
- Returns:
- EINA_TRUE on success, EINA_FALSE on failure.
- Since :
- 2.3
This function inserts the escaped string str
to buf
at position pos
. If buf
can't insert str
, EINA_FALSE is returned, otherwise EINA_TRUE is returned.
Eina_Bool eina_ustrbuf_insert_length | ( | Eina_UStrbuf * | buf, |
const Eina_Unicode * | str, | ||
size_t | length, | ||
size_t | pos | ||
) |
Insert a string of exact length to a buffer, reallocating as necessary.
- Since :
- 2.3
- Parameters:
-
[in] buf The string buffer to insert to. [in] str The string to insert. [in] length The exact length to use. [in] pos The position to insert the string.
- Returns:
- EINA_TRUE on success, EINA_FALSE on failure.
- Remarks:
- This function inserts
str
tobuf
.str
must be of size at mostlength
. It is slightly faster than eina_ustrbuf_insert() as it does not compute the size ofstr
. It is useful when dealing with strings of known size, such as eina_strngshare. Ifbuf
can't insert it, EINA_FALSE is returned, otherwise EINA_TRUE is returned.
- See also:
- eina_stringshare_length()
- eina_ustrbuf_insert()
- eina_ustrbuf_insert_n()
Eina_Bool eina_ustrbuf_insert_n | ( | Eina_UStrbuf * | buf, |
const Eina_Unicode * | str, | ||
size_t | maxlen, | ||
size_t | pos | ||
) |
Insert a string to a buffer, reallocating as necessary. Limited by maxlen.
- Since :
- 2.3
- Parameters:
-
[in] buf The string buffer to insert to. [in] str The string to insert. [in] maxlen The maximum number of chars to insert. [in] pos The position to insert the string.
- Returns:
- EINA_TRUE on success, EINA_FALSE on failure.
- Remarks:
- This function inserts
str
otbuf
at positionpos
, with at mostmaxlen
bytes. The number of inserted characters can not be greater than the length ofstr
. It computes the length ofstr
, so is slightly slower than eina_ustrbuf_insert_length(). If the length is known beforehand, consider using that variant (maxlen
should then be checked so that it is greater than the size ofstr
). Ifstr
can not be inserted, EINA_FALSE is returned, otherwise, EINA_TRUE is returned.
size_t eina_ustrbuf_length_get | ( | const Eina_UStrbuf * | buf | ) |
Retrieve the length of the string buffer content.
- Since :
- 2.3
- Parameters:
-
[in] buf The string buffer.
- Returns:
- The current length of the string, in bytes.
- Remarks:
- This function returns the length of
buf
.
Eina_UStrbuf* eina_ustrbuf_manage_new | ( | Eina_Unicode * | str | ) |
Create a new string buffer using the passed string. The passed string is used directly as the buffer, it's somehow the opposite function of.
- Since :
- 2.3
eina_ustrbuf_string_steal . The passed string must be malloced.
- Parameters:
-
[in] str the string to manage
- Returns:
- Newly allocated string buffer instance.
- Remarks:
- This function creates a new string buffer. On error,
NULL
is returned. To free the resources, use eina_strbuf_free().
- Since (EFL) :
- 1.1.0
Eina_UStrbuf* eina_ustrbuf_manage_new_length | ( | Eina_Unicode * | str, |
size_t | length | ||
) |
Create a new string buffer using the passed string. The passed string is used directly as the buffer, it's somehow the opposite function of.
- Since :
- 2.3
eina_ustrbuf_string_steal . The passed string must be malloced.
- Parameters:
-
[in] str the string to manage [in] length the length of the string.
- Returns:
- Newly allocated string buffer instance.
- Remarks:
- This function creates a new string buffer. On error,
NULL
is returned. To free the resources, use eina_ustrbuf_free().
- See also:
- eina_ustrbuf_manage_new()
- Since (EFL) :
- 1.2.0
Eina_UStrbuf* eina_ustrbuf_new | ( | void | ) |
Create a new string buffer.
- Since :
- 2.3
- Returns:
- Newly allocated string buffer instance.
- Remarks:
- This function creates a new string buffer. On error,
NULL
is returned. To free the resources, use eina_ustrbuf_free().
Eina_Bool eina_ustrbuf_remove | ( | Eina_UStrbuf * | buf, |
size_t | start, | ||
size_t | end | ||
) |
Remove a slice of the given string buffer.
- Since :
- 2.3
- Parameters:
-
[in] buf The string buffer to remove a slice. [in] start The initial (inclusive) slice position to start removing, in bytes. [in] end The final (non-inclusive) slice position to finish removing, in bytes.
- Returns:
- EINA_TRUE on success, EINA_FALSE on failure.
- Remarks:
- This function removes a slice of
buf
, starting atstart
(inclusive) and ending atend
(non-inclusive). Both values are in bytes. It returns EINA_FALSE on failure, EINA_TRUE otherwise.
void eina_ustrbuf_reset | ( | Eina_UStrbuf * | buf | ) |
Reset a string buffer.
- Since :
- 2.3
- Parameters:
-
[in] buf The string buffer to reset.
- Remarks:
- This function reset
buf:
the buffer len is set to 0, and the string is set to '\0'. No memory is free'd.
void eina_ustrbuf_string_free | ( | Eina_UStrbuf * | buf | ) |
Free the contents of a string buffer but not the buffer.
- Since :
- 2.3
- Parameters:
-
[in] buf The string buffer to free the string of.
- Remarks:
- This function frees the string contained in
buf
without freeingbuf
.
const Eina_Unicode* eina_ustrbuf_string_get | ( | const Eina_UStrbuf * | buf | ) |
Retrieve a pointer to the contents of a string buffer.
- Since :
- 2.3
- Parameters:
-
[in] buf The string buffer.
- Returns:
- The current string in the string buffer.
- Remarks:
- This function returns the string contained in
buf
. The returned value must not be modified and will no longer be valid ifbuf
is modified. In other words, any eina_ustrbuf_append() or similar will make that pointer invalid.
- See also:
- eina_ustrbuf_string_steal()
Steal the contents of a string buffer.
- Since :
- 2.3
- Parameters:
-
[in] buf The string buffer to steal.
- Returns:
- The current string in the string buffer.
- Remarks:
- This function returns the string contained in
buf
.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 also:
- eina_ustrbuf_string_get()