src/matcher.h

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 2002 by the Claws Mail 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 3 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, see <http://www.gnu.org/licenses/>.
  17  *
  18  */
  19
  20 #ifndef MATCHER_H
  21 #define MATCHER_H
  22
  23 #include <sys/types.h>
  24 #include <regex.h>
  25 #include <glib.h>
  26 #include "procmsg.h"
  27
  28 /* constants generated by yacc */
  29 #include "matcher_parser_lex.h"
  30 #include "matcher_parser_parse.h"
  31
  32 struct _MatcherProp {
  33         int matchtype;
  34         int criteria;
  35         gchar *header;
  36         gchar *expr;
  37         int value;
  38         regex_t *preg;
  39         int error;
  40         gboolean result;
  41         gboolean done;
  42 };
  43
  44 typedef struct _MatcherProp MatcherProp;
  45
  46 struct _MatcherList {
  47         GSList *matchers;
  48         gboolean bool_and;
  49 };
  50
  51 typedef struct _MatcherList MatcherList;
  52
  53
  54 /* map MATCHCRITERIA_ to yacc's MATCHER_ */
  55 #define MC_(name) \
  56         MATCHCRITERIA_ ## name = MATCHER_ ## name
  57
  58 /* map MATCHTYPE_ to yacc's MATCHER_ */
  59 #define MT_(name) \
  60         MATCHTYPE_ ## name = MATCHER_ ## name
  61
  62 /* map MATCHACTION_ to yacc's MATCHER_ */
  63 #define MA_(name) \
  64         MATCHACTION_ ## name = MATCHER_ ## name
  65
  66 /* map MATCHBOOL_ to yacc's MATCHER_ */
  67 #define MB_(name) \
  68         MATCHERBOOL_ ## name = MATCHER_ ## name
  69
  70 enum {
  71         /* match */
  72         MC_(ALL),
  73         MC_(UNREAD), MC_(NOT_UNREAD),
  74         MC_(NEW), MC_(NOT_NEW),
  75         MC_(MARKED), MC_(NOT_MARKED),
  76         MC_(DELETED), MC_(NOT_DELETED),
  77         MC_(REPLIED), MC_(NOT_REPLIED),
  78         MC_(FORWARDED), MC_(NOT_FORWARDED),
  79         MC_(LOCKED), MC_(NOT_LOCKED),
  80         MC_(SPAM),MC_(NOT_SPAM),
  81         MC_(PARTIAL), MC_(NOT_PARTIAL),
  82         MC_(COLORLABEL), MC_(NOT_COLORLABEL),
  83         MC_(IGNORE_THREAD), MC_(NOT_IGNORE_THREAD),
  84         MC_(WATCH_THREAD), MC_(NOT_WATCH_THREAD),
  85         MC_(SUBJECT), MC_(NOT_SUBJECT),
  86         MC_(FROM), MC_(NOT_FROM),
  87         MC_(TO), MC_(NOT_TO),
  88         MC_(CC), MC_(NOT_CC),
  89         MC_(TO_OR_CC), MC_(NOT_TO_AND_NOT_CC),
  90         MC_(AGE_GREATER), MC_(AGE_LOWER),
  91         MC_(NEWSGROUPS), MC_(NOT_NEWSGROUPS),
  92         MC_(INREPLYTO), MC_(NOT_INREPLYTO),
  93         MC_(REFERENCES), MC_(NOT_REFERENCES),
  94         MC_(SCORE_GREATER), MC_(SCORE_LOWER),
  95         MC_(HEADER), MC_(NOT_HEADER),
  96         MC_(HEADERS_PART), MC_(NOT_HEADERS_PART),
  97         MC_(MESSAGE), MC_(NOT_MESSAGE),
  98         MC_(BODY_PART), MC_(NOT_BODY_PART),
  99         MC_(TEST), MC_(NOT_TEST),
 100         MC_(SCORE_EQUAL),
 101         MC_(SIZE_GREATER),
 102         MC_(SIZE_SMALLER),
 103         MC_(SIZE_EQUAL),
 104         MC_(FOUND_IN_ADDRESSBOOK),MC_(NOT_FOUND_IN_ADDRESSBOOK),
 105         MC_(TAG),MC_(NOT_TAG),
 106         MC_(TAGGED),MC_(NOT_TAGGED),
 107
 108         /* match type */
 109         MT_(MATCHCASE),
 110         MT_(MATCH),
 111         MT_(REGEXPCASE),
 112         MT_(REGEXP),
 113         /* actions */
 114         MA_(SCORE),
 115         MA_(EXECUTE),
 116         MA_(MOVE),
 117         MA_(COPY),
 118         MA_(DELETE),
 119         MA_(MARK),
 120         MA_(UNMARK),
 121         MA_(LOCK),
 122         MA_(UNLOCK),
 123         MA_(MARK_AS_READ),
 124         MA_(MARK_AS_UNREAD),
 125         MA_(MARK_AS_SPAM),
 126         MA_(MARK_AS_HAM),
 127         MA_(FORWARD),
 128         MA_(FORWARD_AS_ATTACHMENT),
 129         MA_(COLOR),
 130         MA_(REDIRECT),
 131         MA_(CHANGE_SCORE),
 132         MA_(SET_SCORE),
 133         MA_(STOP),
 134         MA_(HIDE),
 135         MA_(IGNORE),
 136         MA_(WATCH),
 137         MA_(ADD_TO_ADDRESSBOOK),
 138         MA_(SET_TAG),
 139         MA_(UNSET_TAG),
 140         MA_(CLEAR_TAGS),
 141         /* boolean operations */
 142         MB_(OR),
 143         MB_(AND)
 144 };
 145
 146 const gchar *get_matchparser_tab_str    (gint id);
 147 gint get_matchparser_tab_id             (const gchar *str);
 148
 149 MatcherProp *matcherprop_new            (gint            criteria,
 150                                          const gchar    *header,
 151                                          gint            matchtype,
 152                                          const gchar    *expr,
 153                                          int             value);
 154 MatcherProp *matcherprop_new_create     (gint            criteria,
 155                                          const gchar    *header,
 156                                          gint            matchtype,
 157                                          const gchar    *expr,
 158                                          int             value);
 159 void matcherprop_free                   (MatcherProp *prop);
 160
 161 MatcherProp *matcherprop_parse          (gchar  **str);
 162
 163 MatcherProp *matcherprop_copy           (const MatcherProp *src);
 164
 165 gboolean matcherprop_match              (MatcherProp    *prop,
 166                                          MsgInfo        *info);
 167
 168 MatcherList * matcherlist_new           (GSList         *matchers,
 169                                          gboolean       bool_and);
 170 void matcherlist_free                   (MatcherList    *cond);
 171
 172 MatcherList *matcherlist_parse          (gchar          **str);
 173
 174 gboolean matcherlist_match              (MatcherList    *cond,
 175                                          MsgInfo        *info);
 176
 177 gint matcher_parse_keyword              (gchar          **str);
 178 gint matcher_parse_number               (gchar          **str);
 179 gboolean matcher_parse_boolean_op       (gchar          **str);
 180 gchar *matcher_parse_regexp             (gchar          **str);
 181 gchar *matcher_parse_str                (gchar          **str);
 182 gchar *matcherprop_to_string            (MatcherProp    *matcher);
 183 gchar *matcherlist_to_string            (const MatcherList      *matchers);
 184 gchar *matching_build_command           (const gchar    *cmd,
 185                                          MsgInfo        *info);
 186
 187 void prefs_matcher_read_config          (void);
 188 void prefs_matcher_write_config         (void);
 189
 190 gchar * matcher_quote_str(const gchar * src);
 191
 192 #endif