git.meshlink.io Git - catta/blob - avahi-common/strlst.h

   1 #ifndef footxtlisthfoo
   2 #define footxtlisthfoo
   3
   4 /* $Id$ */
   5
   6 /***
   7   This file is part of avahi.
   8
   9   avahi is free software; you can redistribute it and/or modify it
  10   under the terms of the GNU Lesser General Public License as
  11   published by the Free Software Foundation; either version 2.1 of the
  12   License, or (at your option) any later version.
  13
  14   avahi is distributed in the hope that it will be useful, but WITHOUT
  15   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  16   or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
  17   Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public
  20   License along with avahi; if not, write to the Free Software
  21   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  22   USA.
  23 ***/
  24
  25 /** \file strlst.h Implementation of a data type to store lists of strings */
  26
  27 #include <sys/types.h>
  28 #include <inttypes.h>
  29 #include <stdarg.h>
  30
  31 #include <avahi-common/cdecl.h>
  32 #include <avahi-common/gccmacro.h>
  33
  34 AVAHI_C_DECL_BEGIN
  35
  36 /** Linked list of strings that can contain any number of binary
  37  * characters, including NUL bytes. An empty list is created by
  38  * assigning a NULL to a pointer to AvahiStringList. The string list
  39  * is stored in reverse order, so that appending to the string list is
  40  * effectively a prepending to the linked list.  This object is used
  41  * primarily for storing DNS TXT record data. */
  42 typedef struct AvahiStringList {
  43     struct AvahiStringList *next; /**< Pointe to the next linked list element */
  44     size_t size;  /**< Size of text[] */
  45     uint8_t text[1]; /**< Character data */
  46 } AvahiStringList;
  47
  48 /** Create a new string list by taking a variable list of NUL
  49  * terminated strings. The strings are copied using g_strdup(). The
  50  * argument list must be terminated by a NULL pointer. */
  51 AvahiStringList *avahi_string_list_new(const char *txt, ...) AVAHI_GCC_SENTINEL;
  52
  53 /** Same as avahi_string_list_new() but pass a va_list structure */
  54 AvahiStringList *avahi_string_list_new_va(va_list va);
  55
  56 /** Create a new string list from a string array. The strings are
  57  * copied using g_strdup(). length should contain the length of the
  58  * array, or -1 if the array is NULL terminated*/
  59 AvahiStringList *avahi_string_list_new_from_array(const char **array, int length);
  60
  61 /** Free a string list */
  62 void avahi_string_list_free(AvahiStringList *l);
  63
  64 /** Append a NUL terminated string to the specified string list. The
  65  * passed string is copied using g_strdup(). Returns the new list
  66  * start. */
  67 AvahiStringList *avahi_string_list_add(AvahiStringList *l, const char *text);
  68
  69 /** Append an arbitrary length byte string to the list. Returns the
  70  * new list start. */
  71 AvahiStringList *avahi_string_list_add_arbitrary(AvahiStringList *l, const uint8_t *text, size_t size);
  72
  73 /** Append a new entry to the string list. The string is not filled
  74 with data. The caller should fill in string data afterwards by writing
  75 it to l->text, where l is the pointer returned by this function. This
  76 function exists solely to optimize a few operations where otherwise
  77 superfluous string copying would be necessary. */
  78 AvahiStringList*avahi_string_list_add_anonymous(AvahiStringList *l, size_t size);
  79
  80 /** Same as avahi_string_list_add(), but takes a variable number of
  81  * NUL terminated strings. The argument list must be terminated by a
  82  * NULL pointer. Returns the new list start. */
  83 AvahiStringList *avahi_string_list_add_many(AvahiStringList *r, ...) AVAHI_GCC_SENTINEL;
  84
  85 /** Same as avahi_string_list_add_many(), but use a va_list
  86  * structure. Returns the new list start. */
  87 AvahiStringList *avahi_string_list_add_many_va(AvahiStringList *r, va_list va);
  88
  89 /** Convert the string list object to a single character string,
  90  * seperated by spaces and enclosed in "". g_free() the result! This
  91  * function doesn't work well with string that contain NUL bytes. */
  92 char* avahi_string_list_to_string(AvahiStringList *l);
  93
  94 /** Serialize the string list object in a way that is compatible with
  95  * the storing of DNS TXT records. Strings longer than 255 bytes are truncated. */
  96 size_t avahi_string_list_serialize(AvahiStringList *l, void * data, size_t size);
  97
  98 /** Inverse of avahi_string_list_serialize() */
  99 AvahiStringList *avahi_string_list_parse(const void *data, size_t size);
 100
 101 /** Compare to string lists */
 102 int avahi_string_list_equal(const AvahiStringList *a, const AvahiStringList *b);
 103
 104 /** Copy a string list */
 105 AvahiStringList *avahi_string_list_copy(const AvahiStringList *l);
 106
 107 /** Reverse the string list. */
 108 AvahiStringList* avahi_string_list_reverse(AvahiStringList *l);
 109
 110 /** Return the number of elements in the string list */
 111 unsigned avahi_string_list_length(const AvahiStringList *l);
 112
 113 AVAHI_C_DECL_END
 114
 115 #endif
 116