tags.h File Reference

Driver based email tags. More...

#include <stdbool.h>
#include "mutt/lib.h"

Include dependency graph for tags.h:

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

Go to the source code of this file.

Data Structures
struct	Tag
	LinkedList Tag Element. More...

Functions
	STAILQ_HEAD (TagList, Tag)
void	driver_tags_free (struct TagList *list)
	Free tags from a header. More...
char *	driver_tags_get (struct TagList *list)
	Get tags. More...
char *	driver_tags_get_transformed (struct TagList *list)
	Get transformed tags. More...
char *	driver_tags_get_transformed_for (struct TagList *list, const char *name)
	Get transformed tag for a tag name from a header. More...
char *	driver_tags_get_with_hidden (struct TagList *list)
	Get tags with hiddens. More...
bool	driver_tags_replace (struct TagList *list, const char *tags)
	Replace all tags. More...
void	driver_tags_add (struct TagList *list, char *tag)
	Add a tag to header. More...
void	driver_tags_init (void)
	Initialize structures used for tags. More...
void	driver_tags_cleanup (void)
	Deinitialize structures used for tags. More...

Variables
struct HashTable *	TagTransforms
	Lookup table of alternative tag names. More...
struct HashTable *	TagFormats
	Hash Table of tag-formats (tag -> format string) More...

Detailed Description

Driver based email tags.

Authors

• Mehdi Abaakouk

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 tags.h.

Function Documentation

STAILQ_HEAD()

STAILQ_HEAD	(	TagList	,
		Tag
	)

driver_tags_free()

void driver_tags_free

(

struct TagList *

list

)

Free tags from a header.

Parameters

[in]

list

List of tags

Free the whole tags structure

Definition at line 107 of file tags.c.

{
  if (!list)
    return;
 
  struct Tag *np = STAILQ_FIRST(list);
  struct Tag *next = NULL;
  while (np)
  {
    next = STAILQ_NEXT(np, entries);
    FREE(&np->name);
    FREE(&np->transformed);
    FREE(&np);
    np = next;
  }
  STAILQ_INIT(list);
}

Here is the caller graph for this function:

driver_tags_get()

char * driver_tags_get

(

struct TagList *

list

)

Get tags.

Parameters

[in]

list

List of tags

Return values

ptr	String list of tags

Return a new allocated string containing all tags separated by space

Definition at line 145 of file tags.c.

{
  return driver_tags_getter(list, false, false, NULL);
}

Here is the call graph for this function:

Here is the caller graph for this function:

driver_tags_get_transformed()

char * driver_tags_get_transformed

(

struct TagList *

list

)

Get transformed tags.

Parameters

[in]

list

List of tags

Return values

ptr	String list of tags

Return a new allocated string containing all tags separated by space with transformation

Definition at line 133 of file tags.c.

{
  return driver_tags_getter(list, false, true, NULL);
}

Here is the call graph for this function:

Here is the caller graph for this function:

driver_tags_get_transformed_for()

char * driver_tags_get_transformed_for	(	struct TagList *	head,
		const char *	name
	)

Get transformed tag for a tag name from a header.

Parameters

[in]	head	List of tags
[in]	name	Tag to transform

Return values

ptr	String tag

Return a new allocated string containing all tags separated by space even the hiddens.

Definition at line 172 of file tags.c.

{
  return driver_tags_getter(head, true, true, name);
}

Here is the call graph for this function:

Here is the caller graph for this function:

driver_tags_get_with_hidden()

char * driver_tags_get_with_hidden

(

struct TagList *

list

)

Get tags with hiddens.

Parameters

[in]

list

List of tags

Return values

ptr	String list of tags

Return a new allocated string containing all tags separated by space even the hiddens.

Definition at line 158 of file tags.c.

{
  return driver_tags_getter(list, true, false, NULL);
}

Here is the call graph for this function:

Here is the caller graph for this function:

driver_tags_replace()

bool driver_tags_replace	(	struct TagList *	head,
		const char *	tags
	)

Replace all tags.

Parameters

[in]	head	List of tags
[in]	tags	string of all tags separated by space

Return values

false	No changes are made
true	Tags are updated

Free current tags structures and replace it by new tags

Definition at line 186 of file tags.c.

{
  if (!head)
    return false;
 
  driver_tags_free(head);
 
  if (tags)
  {
    struct ListHead hsplit = STAILQ_HEAD_INITIALIZER(hsplit);
    mutt_list_str_split(&hsplit, tags, ' ');
    struct ListNode *np = NULL;
    STAILQ_FOREACH(np, &hsplit, entries)
    {
      driver_tags_add(head, np->data);
    }
    mutt_list_clear(&hsplit);
  }
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

driver_tags_add()

void driver_tags_add	(	struct TagList *	list,
		char *	new_tag
	)

Add a tag to header.

Parameters

[in]	list	List of tags
[in]	new_tag	String representing the new tag

Add a tag to the header tags

Note

The ownership of the string is passed to the TagList structure

Definition at line 83 of file tags.c.

{
  char *new_tag_transformed = mutt_hash_find(TagTransforms, new_tag);
 
  struct Tag *tn = mutt_mem_calloc(1, sizeof(struct Tag));
  tn->name = new_tag;
  tn->hidden = false;
  tn->transformed = mutt_str_dup(new_tag_transformed);
 
  /* filter out hidden tags */
  const struct Slist *c_hidden_tags = cs_subset_slist(NeoMutt->sub, "hidden_tags");
  if (c_hidden_tags)
    if (mutt_list_find(&c_hidden_tags->head, new_tag))
      tn->hidden = true;
 
  STAILQ_INSERT_TAIL(list, tn, entries);
}

Here is the call graph for this function:

Here is the caller graph for this function:

driver_tags_init()

void driver_tags_init

(

void

)

Initialize structures used for tags.

Definition at line 218 of file tags.c.

{
  TagTransforms = mutt_hash_new(64, MUTT_HASH_STRCASECMP | MUTT_HASH_STRDUP_KEYS);
  mutt_hash_set_destructor(TagTransforms, tags_deleter, 0);
 
  TagFormats = mutt_hash_new(64, MUTT_HASH_STRDUP_KEYS);
  mutt_hash_set_destructor(TagFormats, tags_deleter, 0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

driver_tags_cleanup()

void driver_tags_cleanup

(

void

)

Deinitialize structures used for tags.

Definition at line 230 of file tags.c.

{
  mutt_hash_free(&TagFormats);
  mutt_hash_free(&TagTransforms);
}

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

TagTransforms

struct HashTable* TagTransforms

extern

Lookup table of alternative tag names.

Definition at line 38 of file tags.c.

TagFormats

struct HashTable* TagFormats

extern

Hash Table of tag-formats (tag -> format string)

Definition at line 39 of file tags.c.