#include <sofia-sip/su_types.h>
#include <sofia-sip/su_alloc.h>
#include <stdarg.h>
#include <stddef.h>
#include <sofia-sip/su_config.h>
Include dependency graph for su_tag.h:
Go to the source code of this file.
Data Structures | |
struct | tagi_t |
Tag item. More... | |
Defines | |
#define | TAG_LIST |
Tag list signature. | |
#define | TAG_NULL() |
Initialize a tag item marking the end of list. | |
#define | TAG_END() |
Initialize a tag item marking the end of list. | |
#define | TAG_SKIP(x) |
Initialize an empty tag item. | |
#define | TAG_NEXT(next) |
Initialize a tag item pointing to another tag list at next. | |
#define | TAG_ANY() |
Initialize a filter tag item accepting any item. | |
#define | TAG_IF(condition, item) |
Initialize a item if condition is true; otherwise, initialize an empty tag item. | |
#define | SU_ALIGN(x) |
Align to pointer size. | |
Typedefs | |
typedef typedefSOFIA_BEGIN_DECLS struct tag_type_s const * | tag_type_t |
Tag item type. | |
typedef intptr_t | tag_value_t |
Tag item value. | |
typedef tag_class_s const | tag_class_t |
Tag type class. | |
typedef tag_type_s const | tag_typedef_t [1] |
Definition of tag type. | |
Functions | |
SOFIAPUBFUN int | t_snprintf (tagi_t const *t, char b[], size_t size) |
Convert tag item to a string. | |
SOFIAPUBFUN int | t_scan (tag_type_t tt, su_home_t *home, char const *s, tag_value_t *return_value) |
Convert string to a tag value. | |
SOFIAPUBFUN size_t | tl_tmove (tagi_t *dst, size_t, tag_type_t, tag_value_t,...) |
Move a tag list. | |
SOFIAPUBFUN int | tl_gets (tagi_t const lst[], tag_type_t, tag_value_t,...) |
Find tags from given list. | |
SOFIAPUBFUN int | tl_tgets (tagi_t lst[], tag_type_t, tag_value_t,...) |
Find tags from given list. | |
SOFIAPUBFUN int | tl_tremove (tagi_t lst[], tag_type_t, tag_value_t,...) |
Remove listed tags from the list lst. | |
SOFIAPUBFUN size_t | tl_len (tagi_t const lst[]) |
Calculate effective length of a tag list. | |
SOFIAPUBFUN size_t | tl_xtra (tagi_t const lst[], size_t offset) |
Calculate the size of extra memory areas associated with tag list. | |
SOFIAPUBFUN tagi_t * | tl_next (tagi_t const *lst) |
Get next tag item from list. | |
SOFIAPUBFUN tagi_t * | tl_move (tagi_t *dst, tagi_t const src[]) |
Move a tag list. | |
SOFIAPUBFUN tagi_t * | tl_dup (tagi_t dst[], tagi_t const lst[], void **bb) |
Duplicate a tag list. | |
SOFIAPUBFUN tagi_t * | tl_adup (su_home_t *, tagi_t const lst[]) |
Allocate and duplicate a tag list. | |
SOFIAPUBFUN tagi_t const * | tl_find (tagi_t const lst[], tag_type_t tt) |
Find a tag from given list. | |
SOFIAPUBFUN tagi_t * | tl_afilter (su_home_t *, tagi_t const filter[], tagi_t const lst[]) |
Filter a tag list. | |
SOFIAPUBFUN tagi_t * | tl_filtered_tlist (su_home_t *home, tagi_t const filter[], tag_type_t, tag_value_t,...) |
Create a filtered tag list. | |
SOFIAPUBFUN size_t | tl_vlen (va_list ap) |
Calculate length of a tag list with a va_list . | |
SOFIAPUBFUN tagi_t * | tl_list (tag_type_t tag, tag_value_t value,...) |
Make a tag list until TAG_NEXT() or TAG_END(). | |
SOFIAPUBFUN tagi_t * | tl_vlist (va_list ap) |
Convert va_list to tag list. | |
SOFIAPUBFUN tagi_t * | tl_llist (tag_type_t tag, tag_value_t value,...) |
Make a linear tag list until TAG_END(). | |
SOFIAPUBFUN tagi_t * | tl_vllist (tag_type_t tag, tag_value_t value, va_list ap) |
Make a linear tag list. | |
SOFIAPUBFUN void | tl_vfree (tagi_t *t) |
Free a tag list allocated by tl_list(), tl_llist() or tl_vlist(). | |
Variables | |
SOFIAPUBVAR tag_typedef_t | tag_null |
End of tag list. | |
SOFIAPUBVAR tag_typedef_t | tag_skip |
Ignore tag item. | |
SOFIAPUBVAR tag_typedef_t | tag_next |
Jump to another tag list. | |
SOFIAPUBVAR tag_typedef_t | tag_any |
Any tag accepted when filtering. |
Filter a tag list.
The function tl_afilter() will build a tag list containing tags specified in filter and extracted from src. It will allocate the memory used by tag list via the specified memory home, which may be also NULL
.
Duplicate a tag list.
The function tl_dup() deep copies the tag list src to the buffer dst. Memory areas associated with src are copied to buffer at **bb.
The size of the dst buffer must be at least tl_len(src)
bytes. The size of buffer **bb must be at least tl_dup_xtra(src)
bytes.
dst | pointer to the destination buffer | |
src | tag list to be duplicated | |
bb | pointer to pointer to buffer |
Move a tag list.
The function tl_move() copies the tag list src to the buffer dst. The size of the dst list must be at least tl_len(src)
bytes.
dst | pointer to the destination buffer | |
src | tag list to be moved |
SOFIAPUBFUN int tl_tgets | ( | tagi_t | lst[], | |
tag_type_t | tag, | |||
tag_value_t | value, | |||
... | ||||
) |
Find tags from given list.
The function tl_tgets() copies values of argument tag list into the tag list lst.
SOFIAPUBFUN size_t tl_tmove | ( | tagi_t * | dst, | |
size_t | size, | |||
tag_type_t | t_tag, | |||
tag_value_t | t_value, | |||
... | ||||
) |
Move a tag list.
The function tl_tmove() moves the tag list arguments to dst. The dst must have big enough for all arguments.
dst | pointer to the destination buffer | |
size | sizeof dst | |
t_tag,t_value,... | tag list |