subjectrx.h File Reference

Parse Subject-regex Commands. More...

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

Include dependency graph for subjectrx.h:

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

Go to the source code of this file.

Enumerations
enum	NotifySubjectRx { NT_SUBJECTRX_ADD = 1 , NT_SUBJECTRX_DELETE , NT_SUBJECTRX_DELETE_ALL }
	Subject Regex notification types. More...

Functions
void	subjectrx_init (struct NeoMutt *n, struct IndexModuleData *md)
	Create new Subject Regex List.
void	subjectrx_cleanup (struct IndexModuleData *md)
	Free the Subject Regex List.
enum CommandResult	parse_subjectrx_list (const struct Command *cmd, struct Buffer *line, const struct ParseContext *pc, struct ParseError *pe)
	Parse the 'subject-regex' command - Implements Command::parse() -.
enum CommandResult	parse_unsubjectrx_list (const struct Command *cmd, struct Buffer *line, const struct ParseContext *pc, struct ParseError *pe)
	Parse the 'unsubject-regex' command - Implements Command::parse() -.
bool	subjectrx_apply_mods (struct Envelope *env)
	Apply regex modifications to the subject.
void	subjectrx_clear_mods (struct MailboxView *mv)
	Clear out all modified email subjects.

Detailed Description

Parse Subject-regex Commands.

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

Enumeration Type Documentation

NotifySubjectRx

enum NotifySubjectRx

Subject Regex notification types.

Observers of NT_SUBJECTRX will not be passed any Event data.

Note

Notifications are sent after the event.

Enumerator
NT_SUBJECTRX_ADD	Subject Regex has been added.
NT_SUBJECTRX_DELETE	Subject Regex has been deleted.
NT_SUBJECTRX_DELETE_ALL	All Subject Regexes have been deleted.

Definition at line 43 of file subjectrx.h.

{
  NT_SUBJECTRX_ADD = 1,    
  NT_SUBJECTRX_DELETE,     
  NT_SUBJECTRX_DELETE_ALL, 
};

Function Documentation

subjectrx_init()

void subjectrx_init	(	struct NeoMutt *	n,
		struct IndexModuleData *	md )

Create new Subject Regex List.

Definition at line 42 of file subjectrx.c.

{
  STAILQ_INIT(&md->subject_rx_list);
 
  md->subject_rx_notify = notify_new();
  notify_set_parent(md->subject_rx_notify, n->notify);
}

Here is the call graph for this function:

Here is the caller graph for this function:

subjectrx_cleanup()

void subjectrx_cleanup

(

struct IndexModuleData *

md

)

Free the Subject Regex List.

Definition at line 53 of file subjectrx.c.

{
  notify_free(&md->subject_rx_notify);
 
  mutt_replacelist_free(&md->subject_rx_list);
}

Here is the call graph for this function:

Here is the caller graph for this function:

subjectrx_apply_mods()

bool subjectrx_apply_mods

(

struct Envelope *

env

)

Apply regex modifications to the subject.

Parameters

env	Envelope of Email

Return values

true	Subject modified

Definition at line 148 of file subjectrx.c.

{
  if (!env || !env->subject || (*env->subject == '\0'))
    return false;
 
  if (env->disp_subj)
    return true;
 
  struct IndexModuleData *md = neomutt_get_module_data(NeoMutt, MODULE_ID_INDEX);
  ASSERT(md);
 
  if (STAILQ_EMPTY(&md->subject_rx_list))
    return false;
 
  env->disp_subj = mutt_replacelist_apply(&md->subject_rx_list, env->subject);
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

subjectrx_clear_mods()

void subjectrx_clear_mods

(

struct MailboxView *

mv

)

Clear out all modified email subjects.

Parameters

mv	Mailbox view

Definition at line 170 of file subjectrx.c.

{
  if (!mv || !mv->mailbox)
    return;
 
  struct Mailbox *m = mv->mailbox;
 
  for (int i = 0; i < m->msg_count; i++)
  {
    struct Email *e = m->emails[i];
    if (!e || !e->env)
      continue;
    FREE(&e->env->disp_subj);
  }
}

Here is the caller graph for this function: