src/common/xml.h

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2004 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  */
  19
  20 #ifndef __XML_H__
  21 #define __XML_H__
  22
  23 #include <glib.h>
  24 #include <stdio.h>
  25
  26 #define XMLBUFSIZE      8192
  27
  28 typedef struct _XMLAttr         XMLAttr;
  29 typedef struct _XMLTag          XMLTag;
  30 typedef struct _XMLNode         XMLNode;
  31 typedef struct _XMLFile         XMLFile;
  32
  33 struct _XMLAttr
  34 {
  35         gchar *name;
  36         gchar *value;
  37 };
  38
  39 struct _XMLTag
  40 {
  41         gchar *tag;
  42         GList *attr;
  43 };
  44
  45 struct _XMLNode
  46 {
  47         XMLTag *tag;
  48         gchar *element;
  49 };
  50
  51 struct _XMLFile
  52 {
  53         FILE *fp;
  54
  55         GString *buf;
  56         gchar *bufp;
  57
  58         gchar *dtd;
  59         gchar *encoding;
  60
  61         GList *tag_stack;
  62         guint level;
  63
  64         gboolean is_empty_element;
  65 };
  66
  67 XMLFile *xml_open_file          (const gchar    *path);
  68 void     xml_close_file         (XMLFile        *file);
  69 GNode   *xml_parse_file         (const gchar    *path);
  70
  71 gint xml_get_dtd                (XMLFile        *file);
  72 gint xml_parse_next_tag         (XMLFile        *file);
  73 void xml_push_tag               (XMLFile        *file,
  74                                  XMLTag         *tag);
  75 void xml_pop_tag                (XMLFile        *file);
  76
  77 XMLTag *xml_get_current_tag     (XMLFile        *file);
  78 GList  *xml_get_current_tag_attr(XMLFile        *file);
  79 gchar  *xml_get_element         (XMLFile        *file);
  80
  81 gint xml_read_line              (XMLFile        *file);
  82 void xml_truncate_buf           (XMLFile        *file);
  83 gboolean  xml_compare_tag       (XMLFile        *file,
  84                                  const gchar    *name);
  85
  86 XMLNode *xml_node_new           (XMLTag         *tag,
  87                                  const gchar    *text);
  88
  89 XMLTag  *xml_tag_new            (const gchar    *tag);
  90 XMLAttr *xml_attr_new           (const gchar    *name,
  91                                  const gchar    *value);
  92 XMLAttr *xml_attr_new_int       (const gchar    *name,
  93                                  const gint      value);
  94 void xml_tag_add_attr           (XMLTag         *tag,
  95                                  XMLAttr*       attr);
  96
  97 XMLTag  *xml_copy_tag           (XMLTag         *tag);
  98 XMLAttr *xml_copy_attr          (XMLAttr        *attr);
  99
 100 gint xml_unescape_str           (gchar          *str);
 101 gint xml_file_put_escape_str    (FILE           *fp,
 102                                  const gchar    *str);
 103
 104 gint xml_file_put_xml_decl      (FILE           *fp);
 105 gint xml_file_put_node          (FILE           *fp,
 106                                  XMLNode        *node);
 107
 108 void xml_free_node              (XMLNode        *node);
 109 void xml_free_tree              (GNode          *node);
 110
 111 void xml_free_tag               (XMLTag         *tag);
 112 void xml_write_tree             (GNode          *node,
 113                                  FILE           *fp);
 114 GNode *xml_copy_tree            (GNode          *node);
 115
 116 #endif /* __XML_H__ */