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 * unesc_header;           /* cache unescaped header... */
  34         gchar * expr;
  35         gchar * unesc_expr;             /* cache unescaped expression... */
  36         int value;
  37         regex_t * preg;
  38         int error;
  39         gboolean result;
  40 };
  41
  42 typedef struct _MatcherProp MatcherProp;
  43
  44 struct _MatcherList {
  45         GSList * matchers;
  46         gboolean bool_and;
  47 };
  48
  49 typedef struct _MatcherList MatcherList;
  50
  51
  52 enum {
  53         /* match */
  54         MATCHCRITERIA_ALL,
  55         MATCHCRITERIA_UNREAD, MATCHCRITERIA_NOT_UNREAD,
  56         MATCHCRITERIA_NEW, MATCHCRITERIA_NOT_NEW,
  57         MATCHCRITERIA_MARKED, MATCHCRITERIA_NOT_MARKED,
  58         MATCHCRITERIA_DELETED, MATCHCRITERIA_NOT_DELETED,
  59         MATCHCRITERIA_REPLIED, MATCHCRITERIA_NOT_REPLIED,
  60         MATCHCRITERIA_FORWARDED, MATCHCRITERIA_NOT_FORWARDED,
  61         MATCHCRITERIA_SUBJECT, MATCHCRITERIA_NOT_SUBJECT,
  62         MATCHCRITERIA_FROM, MATCHCRITERIA_NOT_FROM,
  63         MATCHCRITERIA_TO, MATCHCRITERIA_NOT_TO,
  64         MATCHCRITERIA_CC, MATCHCRITERIA_NOT_CC,
  65         MATCHCRITERIA_TO_OR_CC, MATCHCRITERIA_NOT_TO_AND_NOT_CC,
  66         MATCHCRITERIA_AGE_GREATER, MATCHCRITERIA_AGE_LOWER,
  67         MATCHCRITERIA_NEWSGROUPS, MATCHCRITERIA_NOT_NEWSGROUPS,
  68         MATCHCRITERIA_INREPLYTO, MATCHCRITERIA_NOT_INREPLYTO,
  69         MATCHCRITERIA_REFERENCES, MATCHCRITERIA_NOT_REFERENCES,
  70         MATCHCRITERIA_SCORE_GREATER, MATCHCRITERIA_SCORE_LOWER,
  71         MATCHCRITERIA_HEADER, MATCHCRITERIA_NOT_HEADER,
  72         MATCHCRITERIA_HEADERS_PART, MATCHCRITERIA_NOT_HEADERS_PART,
  73         MATCHCRITERIA_MESSAGE, MATCHCRITERIA_NOT_MESSAGE,
  74         MATCHCRITERIA_BODY_PART, MATCHCRITERIA_NOT_BODY_PART,
  75         MATCHCRITERIA_EXECUTE, MATCHCRITERIA_NOT_EXECUTE,
  76         MATCHCRITERIA_SCORE_EQUAL,
  77         MATCHCRITERIA_SIZE_GREATER,
  78         MATCHCRITERIA_SIZE_SMALLER,
  79         MATCHCRITERIA_SIZE_EQUAL,
  80         /* match type */
  81         MATCHTYPE_MATCHCASE,
  82         MATCHTYPE_MATCH,
  83         MATCHTYPE_REGEXPCASE,
  84         MATCHTYPE_REGEXP,
  85         /* actions */
  86         MATCHACTION_SCORE,
  87         MATCHACTION_EXECUTE,
  88         MATCHACTION_MOVE,
  89         MATCHACTION_COPY,
  90         MATCHACTION_DELETE,
  91         MATCHACTION_MARK,
  92         MATCHACTION_UNMARK,
  93         MATCHACTION_MARK_AS_READ,
  94         MATCHACTION_MARK_AS_UNREAD,
  95         MATCHACTION_FORWARD,
  96         MATCHACTION_FORWARD_AS_ATTACHMENT,
  97         MATCHACTION_COLOR,
  98         MATCHACTION_REDIRECT,
  99         MATCHACTION_DELETE_ON_SERVER,
 100         /* boolean operations */
 101         MATCHERBOOL_OR,
 102         MATCHERBOOL_AND,
 103 };
 104
 105 gchar * get_matchparser_tab_str(gint id);
 106 MatcherProp * matcherprop_new(gint criteria, gchar * header,
 107                               gint matchtype, gchar * expr,
 108                               int age);
 109 void matcherprop_free(MatcherProp * prop);
 110 MatcherProp * matcherprop_parse(gchar ** str);
 111
 112 gboolean matcherprop_match(MatcherProp * prop, MsgInfo * info);
 113
 114 MatcherList * matcherlist_new(GSList * matchers, gboolean bool_and);
 115 void matcherlist_free(MatcherList * cond);
 116 MatcherList * matcherlist_parse(gchar ** str);
 117
 118 gboolean matcherlist_match(MatcherList * cond, MsgInfo * info);
 119
 120 gint matcher_parse_keyword(gchar ** str);
 121 gint matcher_parse_number(gchar ** str);
 122 gboolean matcher_parse_boolean_op(gchar ** str);
 123 gchar * matcher_parse_regexp(gchar ** str);
 124 gchar * matcher_parse_str(gchar ** str);
 125 gchar * matcher_escape_str(const gchar *str);
 126 gchar * matcher_unescape_str(gchar *str);
 127 gchar * matcherprop_to_string(MatcherProp * matcher);
 128 gchar * matcherlist_to_string(MatcherList * matchers);
 129 gchar * matching_build_command(gchar * cmd, MsgInfo * info);
 130
 131
 132 void prefs_matcher_read_config(void);
 133 void prefs_matcher_write_config(void);
 134
 135
 136 #endif