claws-mail/src/matcher.h

/*
 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
 * Copyright (C) 2002 by the Sylpheed Claws Team and Hiroyuki Yamamoto
 *
 * 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, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

#ifndef MATCHER_H

#define MATCHER_H

#include <sys/types.h>
#include <regex.h>
#include <glib.h>
#include "procmsg.h"

struct _MatcherProp {
	int matchtype;
	int criteria;
	gchar * header;
	gchar * expr;
	int value;
	regex_t * preg;
	int error;
	gboolean result;
};

typedef struct _MatcherProp MatcherProp;

struct _MatcherList {
	GSList * matchers;
	gboolean bool_and;
};

typedef struct _MatcherList MatcherList;


enum {
	/* match */
	MATCHCRITERIA_ALL,
	MATCHCRITERIA_UNREAD, MATCHCRITERIA_NOT_UNREAD,
	MATCHCRITERIA_NEW, MATCHCRITERIA_NOT_NEW,
	MATCHCRITERIA_MARKED, MATCHCRITERIA_NOT_MARKED,
	MATCHCRITERIA_DELETED, MATCHCRITERIA_NOT_DELETED,
	MATCHCRITERIA_REPLIED, MATCHCRITERIA_NOT_REPLIED,
	MATCHCRITERIA_FORWARDED, MATCHCRITERIA_NOT_FORWARDED,
	MATCHCRITERIA_SUBJECT, MATCHCRITERIA_NOT_SUBJECT,
	MATCHCRITERIA_FROM, MATCHCRITERIA_NOT_FROM,
	MATCHCRITERIA_TO, MATCHCRITERIA_NOT_TO,
	MATCHCRITERIA_CC, MATCHCRITERIA_NOT_CC,
	MATCHCRITERIA_TO_OR_CC, MATCHCRITERIA_NOT_TO_AND_NOT_CC,
	MATCHCRITERIA_AGE_GREATER, MATCHCRITERIA_AGE_LOWER,
	MATCHCRITERIA_NEWSGROUPS, MATCHCRITERIA_NOT_NEWSGROUPS,
	MATCHCRITERIA_INREPLYTO, MATCHCRITERIA_NOT_INREPLYTO,
	MATCHCRITERIA_REFERENCES, MATCHCRITERIA_NOT_REFERENCES,
	MATCHCRITERIA_SCORE_GREATER, MATCHCRITERIA_SCORE_LOWER,
	MATCHCRITERIA_HEADER, MATCHCRITERIA_NOT_HEADER,
	MATCHCRITERIA_HEADERS_PART, MATCHCRITERIA_NOT_HEADERS_PART,
	MATCHCRITERIA_MESSAGE, MATCHCRITERIA_NOT_MESSAGE,
	MATCHCRITERIA_BODY_PART, MATCHCRITERIA_NOT_BODY_PART,
	MATCHCRITERIA_EXECUTE, MATCHCRITERIA_NOT_EXECUTE,
	MATCHCRITERIA_SCORE_EQUAL,
	MATCHCRITERIA_SIZE_GREATER, 
	MATCHCRITERIA_SIZE_SMALLER,
	MATCHCRITERIA_SIZE_EQUAL,
	/* match type */
	MATCHTYPE_MATCHCASE,
	MATCHTYPE_MATCH,
	MATCHTYPE_REGEXPCASE,
	MATCHTYPE_REGEXP,
	/* actions */
	MATCHACTION_SCORE,
	MATCHACTION_EXECUTE,
	MATCHACTION_MOVE,
	MATCHACTION_COPY,
	MATCHACTION_DELETE,
	MATCHACTION_MARK,
	MATCHACTION_UNMARK,
	MATCHACTION_MARK_AS_READ,
	MATCHACTION_MARK_AS_UNREAD,
	MATCHACTION_FORWARD,
	MATCHACTION_FORWARD_AS_ATTACHMENT,
	MATCHACTION_COLOR,
	MATCHACTION_REDIRECT,
	MATCHACTION_DELETE_ON_SERVER,
	/* boolean operations */
	MATCHERBOOL_OR,
	MATCHERBOOL_AND,
};

gchar * get_matchparser_tab_str(gint id);
MatcherProp * matcherprop_new(gint criteria, gchar * header,
			      gint matchtype, gchar * expr,
			      int age);

MatcherProp * matcherprop_unquote_new(gint criteria, gchar * header,
    gint matchtype, gchar * expr,
    int value);

void matcherprop_free(MatcherProp * prop);
MatcherProp * matcherprop_parse(gchar ** str);

MatcherProp * matcherprop_copy(MatcherProp *src);

gboolean matcherprop_match(MatcherProp * prop, MsgInfo * info);

MatcherList * matcherlist_new(GSList * matchers, gboolean bool_and);
void matcherlist_free(MatcherList * cond);
MatcherList * matcherlist_parse(gchar ** str);

gboolean matcherlist_match(MatcherList * cond, MsgInfo * info);

gint matcher_parse_keyword(gchar ** str);
gint matcher_parse_number(gchar ** str);
gboolean matcher_parse_boolean_op(gchar ** str);
gchar * matcher_parse_regexp(gchar ** str);
gchar * matcher_parse_str(gchar ** str);
gchar * matcher_escape_str(const gchar *str);
gchar * matcher_unescape_str(gchar *str);
gchar * matcherprop_to_string(MatcherProp * matcher);
gchar * matcherlist_to_string(MatcherList * matchers);
gchar * matching_build_command(gchar * cmd, MsgInfo * info);


void prefs_matcher_read_config(void);
void prefs_matcher_write_config(void);


#endif