glib/gmarkup.h

   1 /* gmarkup.h - Simple XML-like string parser/writer
   2  *
   3  *  Copyright 2000 Red Hat, Inc.
   4  *
   5  * GLib is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU Lesser General Public License as
   7  * published by the Free Software Foundation; either version 2 of the
   8  * License, or (at your option) any later version.
   9  *
  10  * GLib 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 GLib; see the file COPYING.LIB.  If not,
  17  * write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  *   Boston, MA 02111-1307, USA.
  19  */
  20
  21 #ifndef __G_MARKUP_H__
  22 #define __G_MARKUP_H__
  23
  24 #include <stdarg.h>
  25
  26 #include <glib/gerror.h>
  27 #include <glib/gslist.h>
  28
  29 G_BEGIN_DECLS
  30
  31 typedef enum
  32 {
  33   G_MARKUP_ERROR_BAD_UTF8,
  34   G_MARKUP_ERROR_EMPTY,
  35   G_MARKUP_ERROR_PARSE,
  36   /* The following are primarily intended for specific GMarkupParser
  37    * implementations to set.
  38    */
  39   G_MARKUP_ERROR_UNKNOWN_ELEMENT,
  40   G_MARKUP_ERROR_UNKNOWN_ATTRIBUTE,
  41   G_MARKUP_ERROR_INVALID_CONTENT,
  42   G_MARKUP_ERROR_MISSING_ATTRIBUTE
  43 } GMarkupError;
  44
  45 #define G_MARKUP_ERROR g_markup_error_quark ()
  46
  47 GQuark g_markup_error_quark (void);
  48
  49 typedef enum
  50 {
  51   G_MARKUP_DO_NOT_USE_THIS_UNSUPPORTED_FLAG = 1 << 0,
  52   G_MARKUP_TREAT_CDATA_AS_TEXT              = 1 << 1,
  53   G_MARKUP_PREFIX_ERROR_POSITION            = 1 << 2
  54 } GMarkupParseFlags;
  55
  56 typedef struct _GMarkupParseContext GMarkupParseContext;
  57 typedef struct _GMarkupParser GMarkupParser;
  58
  59 struct _GMarkupParser
  60 {
  61   /* Called for open tags <foo bar="baz"> */
  62   void (*start_element)  (GMarkupParseContext *context,
  63                           const gchar         *element_name,
  64                           const gchar        **attribute_names,
  65                           const gchar        **attribute_values,
  66                           gpointer             user_data,
  67                           GError             **error);
  68
  69   /* Called for close tags </foo> */
  70   void (*end_element)    (GMarkupParseContext *context,
  71                           const gchar         *element_name,
  72                           gpointer             user_data,
  73                           GError             **error);
  74
  75   /* Called for character data */
  76   /* text is not nul-terminated */
  77   void (*text)           (GMarkupParseContext *context,
  78                           const gchar         *text,
  79                           gsize                text_len,
  80                           gpointer             user_data,
  81                           GError             **error);
  82
  83   /* Called for strings that should be re-saved verbatim in this same
  84    * position, but are not otherwise interpretable.  At the moment
  85    * this includes comments and processing instructions.
  86    */
  87   /* text is not nul-terminated. */
  88   void (*passthrough)    (GMarkupParseContext *context,
  89                           const gchar         *passthrough_text,
  90                           gsize                text_len,
  91                           gpointer             user_data,
  92                           GError             **error);
  93
  94   /* Called on error, including one set by other
  95    * methods in the vtable. The GError should not be freed.
  96    */
  97   void (*error)          (GMarkupParseContext *context,
  98                           GError              *error,
  99                           gpointer             user_data);
 100 };
 101
 102 GMarkupParseContext *g_markup_parse_context_new   (const GMarkupParser *parser,
 103                                                    GMarkupParseFlags    flags,
 104                                                    gpointer             user_data,
 105                                                    GDestroyNotify       user_data_dnotify);
 106 void                 g_markup_parse_context_free  (GMarkupParseContext *context);
 107 gboolean             g_markup_parse_context_parse (GMarkupParseContext *context,
 108                                                    const gchar         *text,
 109                                                    gssize               text_len,
 110                                                    GError             **error);
 111
 112 gboolean             g_markup_parse_context_end_parse (GMarkupParseContext *context,
 113                                                        GError             **error);
 114 G_CONST_RETURN gchar *g_markup_parse_context_get_element (GMarkupParseContext *context);
 115 G_CONST_RETURN GSList *g_markup_parse_context_get_element_stack (GMarkupParseContext *context);
 116
 117 /* For user-constructed error messages, has no precise semantics */
 118 void                 g_markup_parse_context_get_position (GMarkupParseContext *context,
 119                                                           gint                *line_number,
 120                                                           gint                *char_number);
 121
 122 /* useful when saving */
 123 gchar* g_markup_escape_text (const gchar *text,
 124                              gssize       length);
 125
 126 gchar *g_markup_printf_escaped (const char *format,
 127                                 ...) G_GNUC_PRINTF (1, 2);
 128 gchar *g_markup_vprintf_escaped (const char *format,
 129                                  va_list     args);
 130
 131 typedef enum
 132 {
 133   G_MARKUP_COLLECT_INVALID,
 134   G_MARKUP_COLLECT_STRING,
 135   G_MARKUP_COLLECT_STRDUP,
 136   G_MARKUP_COLLECT_BOOLEAN,
 137   G_MARKUP_COLLECT_TRISTATE,
 138
 139   G_MARKUP_COLLECT_OPTIONAL = (1 << 16)
 140 } GMarkupCollectType;
 141
 142
 143 /* useful from start_element */
 144 gboolean   g_markup_collect_attributes (const gchar         *element_name,
 145                                         const gchar        **attribute_names,
 146                                         const gchar        **attribute_values,
 147                                         GError             **error,
 148                                         GMarkupCollectType   first_type,
 149                                         const gchar         *first_attr,
 150                                         ...);
 151
 152 G_END_DECLS
 153
 154 #endif /* __G_MARKUP_H__ */
 155