src/pulsecore/strlist.h

   1 #ifndef foostrlisthfoo
   2 #define foostrlisthfoo
   3
   4 /***
   5   This file is part of PulseAudio.
   6
   7   Copyright 2004-2006 Lennart Poettering
   8
   9   PulseAudio is free software; you can redistribute it and/or modify
  10   it under the terms of the GNU Lesser General Public License as published
  11   by the Free Software Foundation; either version 2.1 of the License,
  12   or (at your option) any later version.
  13
  14   PulseAudio is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with PulseAudio; if not, write to the Free Software
  21   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  22   USA.
  23 ***/
  24
  25 typedef struct pa_strlist pa_strlist;
  26
  27 /* Add the specified server string to the list, return the new linked list head */
  28 pa_strlist* pa_strlist_prepend(pa_strlist *l, const char *s);
  29
  30 /* Remove the specified string from the list, return the new linked list head */
  31 pa_strlist* pa_strlist_remove(pa_strlist *l, const char *s);
  32
  33 /* Make a whitespace separated string of all server stringes. Returned memory has to be freed with pa_xfree() */
  34 char *pa_strlist_tostring(pa_strlist *l);
  35
  36 /* Free the entire list */
  37 void pa_strlist_free(pa_strlist *l);
  38
  39 /* Return the next entry in the list in *string and remove it from
  40  * the list. Returns the new list head. The memory *string points to
  41  * has to be freed with pa_xfree() */
  42 pa_strlist* pa_strlist_pop(pa_strlist *l, char **s);
  43
  44 /* Parse a whitespace separated server list */
  45 pa_strlist* pa_strlist_parse(const char *s);
  46
  47 /* Reverse string list */
  48 pa_strlist *pa_strlist_reverse(pa_strlist *l);
  49
  50 /* Return the next item in the list */
  51 pa_strlist *pa_strlist_next(pa_strlist *s);
  52
  53 /* Return the string associated to the current item */
  54 const char *pa_strlist_data(pa_strlist *s);
  55
  56 #endif