slist.h File Reference

A separated list of strings. More...

#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include "list.h"

Include dependency graph for slist.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	Slist
	String list. More...

Functions
struct Slist *	slist_add_string (struct Slist *list, const char *str)
	Add a string to a list.
struct Slist *	slist_dup (const struct Slist *list)
	Create a copy of an Slist object.
bool	slist_equal (const struct Slist *a, const struct Slist *b)
	Compare two string lists.
void	slist_free (struct Slist **ptr)
	Free an Slist object.
bool	slist_is_empty (const struct Slist *list)
	Is the slist empty?
bool	slist_is_member (const struct Slist *list, const char *str)
	Is a string a member of a list?
struct Slist *	slist_new (uint32_t flags)
	Create a new string list.
struct Slist *	slist_parse (const char *str, uint32_t flags)
	Parse a list of strings into a list.
struct Slist *	slist_remove_string (struct Slist *list, const char *str)
	Remove a string from a list.
int	slist_to_buffer (const struct Slist *list, struct Buffer *buf)
	Export an Slist to a Buffer.

Detailed Description

A separated list of strings.

Authors

• Richard Russon

Copyright

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Definition in file slist.h.

Function Documentation

slist_add_string()

struct Slist * slist_add_string	(	struct Slist *	list,
		const char *	str
	)

Add a string to a list.

Parameters

list	List to modify
str	String to add

Return values

ptr	Modified list

Note

String will be copied

Definition at line 68 of file slist.c.

{
  if (!list)
    return NULL;
 
  if (str && (str[0] == '\0'))
    str = NULL;
 
  if (!str && !(list->flags & D_SLIST_ALLOW_EMPTY))
    return list;
 
  mutt_list_insert_tail(&list->head, mutt_str_dup(str));
  list->count++;
 
  return list;
}

Here is the call graph for this function:

Here is the caller graph for this function:

slist_dup()

struct Slist * slist_dup

(

const struct Slist *

list

)

Create a copy of an Slist object.

Parameters

list	Slist to duplicate

Return values

ptr	New Slist object

Definition at line 108 of file slist.c.

{
  if (!list)
    return NULL;
 
  struct Slist *list_new = slist_new(list->flags);
 
  mutt_list_copy_tail(&list_new->head, &list->head);
  list_new->count = list->count;
  return list_new;
}

Here is the call graph for this function:

Here is the caller graph for this function:

slist_equal()

bool slist_equal	(	const struct Slist *	a,
		const struct Slist *	b
	)

Compare two string lists.

Parameters

a	First list
b	Second list

Return values

true	They are identical

Definition at line 91 of file slist.c.

{
  if (!a && !b) /* both empty */
    return true;
  if (!a ^ !b) /* one is empty, but not the other */
    return false;
  if (a->count != b->count)
    return false;
 
  return mutt_list_equal(&a->head, &b->head);
}

Here is the call graph for this function:

Here is the caller graph for this function:

slist_free()

void slist_free

(

struct Slist **

ptr

)

Free an Slist object.

Parameters

ptr	Slist to free

Definition at line 124 of file slist.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct Slist *slist = *ptr;
  mutt_list_free(&slist->head);
 
  FREE(ptr);
}

Here is the call graph for this function:

Here is the caller graph for this function:

slist_is_empty()

bool slist_is_empty

(

const struct Slist *

list

)

Is the slist empty?

Parameters

list	List to check

Return values

true	List is empty

Definition at line 140 of file slist.c.

{
  if (!list)
    return true;
 
  return list->count == 0;
}

Here is the caller graph for this function:

slist_is_member()

bool slist_is_member	(	const struct Slist *	list,
		const char *	str
	)

Is a string a member of a list?

Parameters

list	List to modify
str	String to find

Return values

true	String is in the list

Definition at line 154 of file slist.c.

{
  if (!list)
    return false;
 
  if (!str && !(list->flags & D_SLIST_ALLOW_EMPTY))
    return false;
 
  struct ListNode *np = NULL;
  STAILQ_FOREACH(np, &list->head, entries)
  {
    if (mutt_str_equal(np->data, str))
      return true;
  }
  return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

slist_new()

struct Slist * slist_new

(

uint32_t

flags

)

Create a new string list.

Parameters

flags

Flag to set, e.g. D_SLIST_SEP_COMMA

Return values

ptr	New string list

Definition at line 51 of file slist.c.

{
  struct Slist *list = MUTT_MEM_CALLOC(1, struct Slist);
  list->flags = flags;
  STAILQ_INIT(&list->head);
 
  return list;
}

Here is the caller graph for this function:

slist_parse()

struct Slist * slist_parse	(	const char *	str,
		uint32_t	flags
	)

Parse a list of strings into a list.

Parameters

str	String of strings
flags	Flags, e.g. D_SLIST_ALLOW_EMPTY

Return values

ptr	New Slist object

Definition at line 177 of file slist.c.

{
  char *src = mutt_str_dup(str);
  if (!src && !(flags & D_SLIST_ALLOW_EMPTY))
    return NULL;
 
  char sep = ' ';
  if ((flags & D_SLIST_SEP_MASK) == D_SLIST_SEP_COMMA)
    sep = ',';
  else if ((flags & D_SLIST_SEP_MASK) == D_SLIST_SEP_COLON)
    sep = ':';
 
  struct Slist *list = MUTT_MEM_CALLOC(1, struct Slist);
  list->flags = flags;
  STAILQ_INIT(&list->head);
 
  if (!src)
    return list;
 
  char *start = src;
  for (char *p = start; *p; p++)
  {
    if ((p[0] == '\\') && (p[1] != '\0'))
    {
      p++;
      continue;
    }
 
    if (p[0] == sep)
    {
      p[0] = '\0';
      if (slist_is_member(list, start))
      {
        start = p + 1;
        continue;
      }
      mutt_list_insert_tail(&list->head, mutt_str_dup(start));
      list->count++;
      start = p + 1;
    }
  }
 
  if (!slist_is_member(list, start))
  {
    mutt_list_insert_tail(&list->head, mutt_str_dup(start));
    list->count++;
  }
 
  FREE(&src);
  return list;
}

Here is the call graph for this function:

Here is the caller graph for this function:

slist_remove_string()

struct Slist * slist_remove_string	(	struct Slist *	list,
		const char *	str
	)

Remove a string from a list.

Parameters

list	List to modify
str	String to remove

Return values

ptr	Modified list

Definition at line 235 of file slist.c.

{
  if (!list)
    return NULL;
  if (!str && !(list->flags & D_SLIST_ALLOW_EMPTY))
    return list;
 
  struct ListNode *prev = NULL;
  struct ListNode *np = NULL;
  struct ListNode *tmp = NULL;
  STAILQ_FOREACH_SAFE(np, &list->head, entries, tmp)
  {
    if (mutt_str_equal(np->data, str))
    {
      if (prev)
        STAILQ_REMOVE_AFTER(&list->head, prev, entries);
      else
        STAILQ_REMOVE_HEAD(&list->head, entries);
      FREE(&np->data);
      FREE(&np);
      list->count--;
      break;
    }
    prev = np;
  }
  return list;
}

Here is the call graph for this function:

Here is the caller graph for this function:

slist_to_buffer()

int slist_to_buffer	(	const struct Slist *	list,
		struct Buffer *	buf
	)

Export an Slist to a Buffer.

Parameters

list	List to export
buf	Buffer for the results

Return values

num	Number of strings written to Buffer

Definition at line 269 of file slist.c.

{
  if (!list || !buf || (list->count == 0))
    return 0;
 
  struct ListNode *np = NULL;
  STAILQ_FOREACH(np, &list->head, entries)
  {
    buf_addstr(buf, np->data);
    if (STAILQ_NEXT(np, entries))
    {
      const int sep = (list->flags & D_SLIST_SEP_MASK);
      if (sep == D_SLIST_SEP_COMMA)
        buf_addch(buf, ',');
      else if (sep == D_SLIST_SEP_COLON)
        buf_addch(buf, ':');
      else
        buf_addch(buf, ' ');
    }
  }
 
  return list->count;
}

Here is the call graph for this function:

Here is the caller graph for this function: