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
  28 G_BEGIN_DECLS
  29
  30 typedef enum
  31 {
  32   G_MARKUP_ERROR_BAD_UTF8,
  33   G_MARKUP_ERROR_EMPTY,
  34   G_MARKUP_ERROR_PARSE,
  35   /* These three are primarily intended for specific GMarkupParser
  36    * implementations to set.
  37    */
  38   G_MARKUP_ERROR_UNKNOWN_ELEMENT,
  39   G_MARKUP_ERROR_UNKNOWN_ATTRIBUTE,
  40   G_MARKUP_ERROR_INVALID_CONTENT
  41 } GMarkupError;
  42
  43 #define G_MARKUP_ERROR g_markup_error_quark ()
  44
  45 GQuark g_markup_error_quark (void);
  46
  47 typedef enum
  48 {
  49   G_MARKUP_DO_NOT_USE_THIS_UNSUPPORTED_FLAG = 1 << 0,
  50   G_MARKUP_TREAT_CDATA_AS_TEXT              = 1 << 1
  51 } GMarkupParseFlags;
  52
  53 typedef struct _GMarkupParseContext GMarkupParseContext;
  54 typedef struct _GMarkupParser GMarkupParser;
  55
  56 struct _GMarkupParser
  57 {
  58   /* Called for open tags <foo bar="baz"> */
  59   void (*start_element)  (GMarkupParseContext *context,
  60                           const gchar         *element_name,
  61                           const gchar        **attribute_names,
  62                           const gchar        **attribute_values,
  63                           gpointer             user_data,
  64                           GError             **error);
  65
  66   /* Called for close tags </foo> */
  67   void (*end_element)    (GMarkupParseContext *context,
  68                           const gchar         *element_name,
  69                           gpointer             user_data,
  70                           GError             **error);
  71
  72   /* Called for character data */
  73   /* text is not nul-terminated */
  74   void (*text)           (GMarkupParseContext *context,
  75                           const gchar         *text,
  76                           gsize                text_len,
  77                           gpointer             user_data,
  78                           GError             **error);
  79
  80   /* Called for strings that should be re-saved verbatim in this same
  81    * position, but are not otherwise interpretable.  At the moment
  82    * this includes comments and processing instructions.
  83    */
  84   /* text is not nul-terminated. */
  85   void (*passthrough)    (GMarkupParseContext *context,
  86                           const gchar         *passthrough_text,
  87                           gsize                text_len,
  88                           gpointer             user_data,
  89                           GError             **error);
  90
  91   /* Called on error, including one set by other
  92    * methods in the vtable. The GError should not be freed.
  93    */
  94   void (*error)          (GMarkupParseContext *context,
  95                           GError              *error,
  96                           gpointer             user_data);
  97 };
  98
  99 GMarkupParseContext *g_markup_parse_context_new   (const GMarkupParser *parser,
 100                                                    GMarkupParseFlags    flags,
 101                                                    gpointer             user_data,
 102                                                    GDestroyNotify       user_data_dnotify);
 103 void                 g_markup_parse_context_free  (GMarkupParseContext *context);
 104 gboolean             g_markup_parse_context_parse (GMarkupParseContext *context,
 105                                                    const gchar         *text,
 106                                                    gssize               text_len,
 107                                                    GError             **error);
 108
 109 gboolean             g_markup_parse_context_end_parse (GMarkupParseContext *context,
 110                                                        GError             **error);
 111 G_CONST_RETURN gchar *g_markup_parse_context_get_element (GMarkupParseContext *context);
 112 G_CONST_RETURN GSList *g_markup_parse_context_get_element_stack (GMarkupParseContext *context);
 113
 114 /* For user-constructed error messages, has no precise semantics */
 115 void                 g_markup_parse_context_get_position (GMarkupParseContext *context,
 116                                                           gint                *line_number,
 117                                                           gint                *char_number);
 118
 119 /* useful when saving */
 120 gchar* g_markup_escape_text (const gchar *text,
 121                              gssize       length);
 122
 123 gchar *g_markup_printf_escaped (const char *format,
 124                                 ...) G_GNUC_PRINTF (1, 2);
 125 gchar *g_markup_vprintf_escaped (const char *format,
 126                                  va_list     args);
 127
 128 G_END_DECLS
 129
 130 #endif /* __G_MARKUP_H__ */
 131