src/matcher.h

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 2002 by the Sylpheed Claws Team and Hiroyuki Yamamoto
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18  */
  19
  20 #ifndef MATCHER_H
  21
  22 #define MATCHER_H
  23
  24 #include <sys/types.h>
  25 #include <regex.h>
  26 #include <glib.h>
  27 #include "procmsg.h"
  28
  29 struct _MatcherProp {
  30         int matchtype;
  31         int criteria;
  32         gchar * header;
  33         gchar * expr;
  34         int value;
  35         regex_t * preg;
  36         int error;
  37         gboolean result;
  38 };
  39
  40 typedef struct _MatcherProp MatcherProp;
  41
  42 struct _MatcherList {
  43         GSList * matchers;
  44         gboolean bool_and;
  45 };
  46
  47 typedef struct _MatcherList MatcherList;
  48
  49
  50 enum {
  51         /* match */
  52         MATCHCRITERIA_ALL,
  53         MATCHCRITERIA_UNREAD, MATCHCRITERIA_NOT_UNREAD,
  54         MATCHCRITERIA_NEW, MATCHCRITERIA_NOT_NEW,
  55         MATCHCRITERIA_MARKED, MATCHCRITERIA_NOT_MARKED,
  56         MATCHCRITERIA_DELETED, MATCHCRITERIA_NOT_DELETED,
  57         MATCHCRITERIA_REPLIED, MATCHCRITERIA_NOT_REPLIED,
  58         MATCHCRITERIA_FORWARDED, MATCHCRITERIA_NOT_FORWARDED,
  59         MATCHCRITERIA_SUBJECT, MATCHCRITERIA_NOT_SUBJECT,
  60         MATCHCRITERIA_FROM, MATCHCRITERIA_NOT_FROM,
  61         MATCHCRITERIA_TO, MATCHCRITERIA_NOT_TO,
  62         MATCHCRITERIA_CC, MATCHCRITERIA_NOT_CC,
  63         MATCHCRITERIA_TO_OR_CC, MATCHCRITERIA_NOT_TO_AND_NOT_CC,
  64         MATCHCRITERIA_AGE_GREATER, MATCHCRITERIA_AGE_LOWER,
  65         MATCHCRITERIA_NEWSGROUPS, MATCHCRITERIA_NOT_NEWSGROUPS,
  66         MATCHCRITERIA_INREPLYTO, MATCHCRITERIA_NOT_INREPLYTO,
  67         MATCHCRITERIA_REFERENCES, MATCHCRITERIA_NOT_REFERENCES,
  68         MATCHCRITERIA_SCORE_GREATER, MATCHCRITERIA_SCORE_LOWER,
  69         MATCHCRITERIA_HEADER, MATCHCRITERIA_NOT_HEADER,
  70         MATCHCRITERIA_HEADERS_PART, MATCHCRITERIA_NOT_HEADERS_PART,
  71         MATCHCRITERIA_MESSAGE, MATCHCRITERIA_NOT_MESSAGE,
  72         MATCHCRITERIA_BODY_PART, MATCHCRITERIA_NOT_BODY_PART,
  73         MATCHCRITERIA_EXECUTE, MATCHCRITERIA_NOT_EXECUTE,
  74         MATCHCRITERIA_SCORE_EQUAL,
  75         MATCHCRITERIA_SIZE_GREATER,
  76         MATCHCRITERIA_SIZE_SMALLER,
  77         MATCHCRITERIA_SIZE_EQUAL,
  78         /* match type */
  79         MATCHTYPE_MATCHCASE,
  80         MATCHTYPE_MATCH,
  81         MATCHTYPE_REGEXPCASE,
  82         MATCHTYPE_REGEXP,
  83         /* actions */
  84         MATCHACTION_SCORE,
  85         MATCHACTION_EXECUTE,
  86         MATCHACTION_MOVE,
  87         MATCHACTION_COPY,
  88         MATCHACTION_DELETE,
  89         MATCHACTION_MARK,
  90         MATCHACTION_UNMARK,
  91         MATCHACTION_MARK_AS_READ,
  92         MATCHACTION_MARK_AS_UNREAD,
  93         MATCHACTION_FORWARD,
  94         MATCHACTION_FORWARD_AS_ATTACHMENT,
  95         MATCHACTION_COLOR,
  96         MATCHACTION_REDIRECT,
  97         MATCHACTION_DELETE_ON_SERVER,
  98         /* boolean operations */
  99         MATCHERBOOL_OR,
 100         MATCHERBOOL_AND,
 101 };
 102
 103 gchar * get_matchparser_tab_str(gint id);
 104 MatcherProp * matcherprop_new(gint criteria, gchar * header,
 105                               gint matchtype, gchar * expr,
 106                               int age);
 107
 108 MatcherProp * matcherprop_unquote_new(gint criteria, gchar * header,
 109     gint matchtype, gchar * expr,
 110     int value);
 111
 112 void matcherprop_free(MatcherProp * prop);
 113 MatcherProp * matcherprop_parse(gchar ** str);
 114
 115 MatcherProp * matcherprop_copy(MatcherProp *src);
 116
 117 gboolean matcherprop_match(MatcherProp * prop, MsgInfo * info);
 118
 119 MatcherList * matcherlist_new(GSList * matchers, gboolean bool_and);
 120 void matcherlist_free(MatcherList * cond);
 121 MatcherList * matcherlist_parse(gchar ** str);
 122
 123 gboolean matcherlist_match(MatcherList * cond, MsgInfo * info);
 124
 125 gint matcher_parse_keyword(gchar ** str);
 126 gint matcher_parse_number(gchar ** str);
 127 gboolean matcher_parse_boolean_op(gchar ** str);
 128 gchar * matcher_parse_regexp(gchar ** str);
 129 gchar * matcher_parse_str(gchar ** str);
 130 gchar * matcher_escape_str(const gchar *str);
 131 gchar * matcher_unescape_str(gchar *str);
 132 gchar * matcherprop_to_string(MatcherProp * matcher);
 133 gchar * matcherlist_to_string(MatcherList * matchers);
 134 gchar * matching_build_command(gchar * cmd, MsgInfo * info);
 135
 136
 137 void prefs_matcher_read_config(void);
 138 void prefs_matcher_write_config(void);
 139
 140
 141 #endif