gmime/gmime-parser.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*  GMime
   3  *  Copyright (C) 2000-2012 Jeffrey Stedfast
   4  *
   5  *  This library is free software; you can redistribute it and/or
   6  *  modify it under the terms of the GNU Lesser General Public License
   7  *  as published by the Free Software Foundation; either version 2.1
   8  *  of the License, or (at your option) any later version.
   9  *
  10  *  This library 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 GNU
  13  *  Lesser General Public License for more details.
  14  *
  15  *  You should have received a copy of the GNU Lesser General Public
  16  *  License along with this library; if not, write to the Free
  17  *  Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA
  18  *  02110-1301, USA.
  19  */
  20
  21
  22 #ifndef __GMIME_PARSER_H__
  23 #define __GMIME_PARSER_H__
  24
  25 #include <glib.h>
  26 #include <glib-object.h>
  27 #include <errno.h>
  28
  29 #include <gmime/gmime-object.h>
  30 #include <gmime/gmime-message.h>
  31 #include <gmime/gmime-content-type.h>
  32 #include <gmime/gmime-stream.h>
  33
  34 G_BEGIN_DECLS
  35
  36 #define GMIME_TYPE_PARSER            (g_mime_parser_get_type ())
  37 #define GMIME_PARSER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GMIME_TYPE_PARSER, GMimeParser))
  38 #define GMIME_PARSER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GMIME_TYPE_PARSER, GMimeParserClass))
  39 #define GMIME_IS_PARSER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GMIME_TYPE_PARSER))
  40 #define GMIME_IS_PARSER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GMIME_TYPE_PARSER))
  41 #define GMIME_PARSER_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GMIME_TYPE_PARSER, GMimeParserClass))
  42
  43 typedef struct _GMimeParser GMimeParser;
  44 typedef struct _GMimeParserClass GMimeParserClass;
  45
  46
  47 /**
  48  * GMimeParser:
  49  * @parent_object: parent #GObject
  50  * @priv: private parser state
  51  *
  52  * A MIME parser context.
  53  **/
  54 struct _GMimeParser {
  55         GObject parent_object;
  56
  57         struct _GMimeParserPrivate *priv;
  58 };
  59
  60 struct _GMimeParserClass {
  61         GObjectClass parent_class;
  62
  63 };
  64
  65
  66 /**
  67  * GMimeParserHeaderRegexFunc:
  68  * @parser: The #GMimeParser object.
  69  * @header: The header field matched.
  70  * @value: The header field value.
  71  * @offset: The header field offset.
  72  * @user_data: The user-supplied callback data.
  73  *
  74  * Function signature for the callback to
  75  * g_mime_parser_set_header_regex().
  76  **/
  77 typedef void (* GMimeParserHeaderRegexFunc) (GMimeParser *parser, const char *header,
  78                                              const char *value, gint64 offset,
  79                                              gpointer user_data);
  80
  81
  82 GType g_mime_parser_get_type (void);
  83
  84 GMimeParser *g_mime_parser_new (void);
  85 GMimeParser *g_mime_parser_new_with_stream (GMimeStream *stream);
  86
  87 void g_mime_parser_init_with_stream (GMimeParser *parser, GMimeStream *stream);
  88
  89 gboolean g_mime_parser_get_persist_stream (GMimeParser *parser);
  90 void g_mime_parser_set_persist_stream (GMimeParser *parser, gboolean persist);
  91
  92 gboolean g_mime_parser_get_scan_from (GMimeParser *parser);
  93 void g_mime_parser_set_scan_from (GMimeParser *parser, gboolean scan_from);
  94
  95 gboolean g_mime_parser_get_respect_content_length (GMimeParser *parser);
  96 void g_mime_parser_set_respect_content_length (GMimeParser *parser, gboolean respect_content_length);
  97
  98 void g_mime_parser_set_header_regex (GMimeParser *parser, const char *regex,
  99                                      GMimeParserHeaderRegexFunc header_cb,
 100                                      gpointer user_data);
 101
 102 GMimeObject *g_mime_parser_construct_part (GMimeParser *parser);
 103
 104 GMimeMessage *g_mime_parser_construct_message (GMimeParser *parser);
 105
 106 gint64 g_mime_parser_tell (GMimeParser *parser);
 107
 108 gboolean g_mime_parser_eos (GMimeParser *parser);
 109
 110 char *g_mime_parser_get_from (GMimeParser *parser);
 111
 112 gint64 g_mime_parser_get_from_offset (GMimeParser *parser);
 113 gint64 g_mime_parser_get_headers_begin (GMimeParser *parser);
 114 gint64 g_mime_parser_get_headers_end (GMimeParser *parser);
 115
 116 G_END_DECLS
 117
 118 #endif /* __GMIME_PARSER_H__ */