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	tag_free (struct Tag **ptr)
	Free a Tag.
struct Tag *	tag_new (void)
	Create a new Tag.
void	driver_tags_free (struct TagList *tl)
	Free tags from a header.
void	driver_tags_get (struct TagList *tl, struct Buffer *tags)
	Get tags all tags separated by space.
void	driver_tags_get_transformed (struct TagList *tl, struct Buffer *tags)
	Get transformed tags separated by space.
void	driver_tags_get_transformed_for (struct TagList *tl, const char *name, struct Buffer *tags)
	Get transformed tags for a tag name separated by space.
void	driver_tags_get_with_hidden (struct TagList *tl, struct Buffer *tags)
	Get all tags, also hidden ones, separated by space.
bool	driver_tags_replace (struct TagList *tl, const char *tags)
	Replace all tags.
void	driver_tags_add (struct TagList *tl, char *tag)
	Add a tag to header.
void	driver_tags_init (void)
	Initialize structures used for tags.
void	driver_tags_cleanup (void)
	Deinitialize structures used for tags.

Variables
struct HashTable *	TagTransforms
	Hash Table: "inbox" -> "i" - Alternative tag names.
struct HashTable *	TagFormats
	Hash Table: "inbox" -> "GI" - Tag format strings.

Detailed Description

Driver based email tags.

Authors

• Mehdi Abaakouk
• Richard Russon
• Pietro Cerutti
• Dennis Schön

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
	)

tag_free()

void tag_free

(

struct Tag **

ptr

)

Free a Tag.

Parameters

ptr	Tag to free

Definition at line 48 of file tags.c.

{
  if (!ptr || !*ptr)
    return;
 
  struct Tag *tag = *ptr;
  FREE(&tag->name);
  FREE(&tag->transformed);
 
  FREE(ptr);
}

Here is the caller graph for this function:

tag_new()

struct Tag * tag_new

(

void

)

Create a new Tag.

Return values

ptr

New Tag

Definition at line 64 of file tags.c.

{
  return mutt_mem_calloc(1, sizeof(struct Tag));
}

Here is the call graph for this function:

Here is the caller graph for this function:

driver_tags_free()

void driver_tags_free

(

struct TagList *

tl

)

Free tags from a header.

Parameters

[in]

tl

List of tags

Free the whole tags structure

Definition at line 131 of file tags.c.

{
  if (!tl)
    return;
 
  struct Tag *tag = STAILQ_FIRST(tl);
  struct Tag *next = NULL;
  while (tag)
  {
    next = STAILQ_NEXT(tag, entries);
    tag_free(&tag);
    tag = next;
  }
  STAILQ_INIT(tl);
}

Here is the call graph for this function:

Here is the caller graph for this function:

driver_tags_get()

void driver_tags_get	(	struct TagList *	tl,
		struct Buffer *	tags
	)

Get tags all tags separated by space.

Parameters

[in]	tl	List of tags
[out]	tags	String list of tags

Note

Hidden tags are not returned. Use driver_tags_get_with_hidden() for that.

Definition at line 164 of file tags.c.

{
  driver_tags_getter(tl, false, false, NULL, tags);
}

Here is the call graph for this function:

Here is the caller graph for this function:

driver_tags_get_transformed()

void driver_tags_get_transformed	(	struct TagList *	tl,
		struct Buffer *	tags
	)

Get transformed tags separated by space.

Parameters

[in]	tl	List of tags
[out]	tags	String list of tags

Definition at line 152 of file tags.c.

{
  driver_tags_getter(tl, false, true, NULL, tags);
}

Here is the call graph for this function:

Here is the caller graph for this function:

driver_tags_get_transformed_for()

void driver_tags_get_transformed_for	(	struct TagList *	tl,
		const char *	name,
		struct Buffer *	tags
	)

Get transformed tags for a tag name separated by space.

Parameters

[in]	tl	List of tags
[in]	name	Tag to transform
[out]	tags	String list of tags

Note

Will also return hidden tags.

Definition at line 187 of file tags.c.

{
  driver_tags_getter(tl, true, true, name, tags);
}

Here is the call graph for this function:

Here is the caller graph for this function:

driver_tags_get_with_hidden()

void driver_tags_get_with_hidden	(	struct TagList *	tl,
		struct Buffer *	tags
	)

Get all tags, also hidden ones, separated by space.

Parameters

[in]	tl	List of tags
[out]	tags	String list of tags

Definition at line 174 of file tags.c.

{
  driver_tags_getter(tl, true, false, NULL, tags);
}

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 *	tl,
		const char *	tags
	)

Replace all tags.

Parameters

[in]	tl	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 201 of file tags.c.

{
  if (!tl)
    return false;
 
  driver_tags_free(tl);
 
  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(tl, 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 *	tl,
		char *	new_tag
	)

Add a tag to header.

Parameters

[in]	tl	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 107 of file tags.c.

{
  char *new_tag_transformed = mutt_hash_find(TagTransforms, new_tag);
 
  struct Tag *tag = tag_new();
  tag->name = new_tag;
  tag->hidden = false;
  tag->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))
      tag->hidden = true;
 
  STAILQ_INSERT_TAIL(tl, tag, 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 233 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 245 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

Hash Table: "inbox" -> "i" - Alternative tag names.

Definition at line 41 of file tags.c.

TagFormats

struct HashTable* TagFormats

extern

Hash Table: "inbox" -> "GI" - Tag format strings.

Definition at line 42 of file tags.c.