mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2024-11-13 12:56:15 +01:00
70ee43f1e9
Add SPDX license (but not copyright) headers to all files which follow a certain pattern in their existing non-machine-readable header comment. This commit was entirely generated using the command: ``` git ls-files glib/*.[ch] | xargs perl -0777 -pi -e 's/\n \*\n \* This library is free software; you can redistribute it and\/or\n \* modify it under the terms of the GNU Lesser General Public/\n \*\n \* SPDX-License-Identifier: LGPL-2.1-or-later\n \*\n \* This library is free software; you can redistribute it and\/or\n \* modify it under the terms of the GNU Lesser General Public/igs' ``` Signed-off-by: Philip Withnall <pwithnall@endlessos.org> Helps: #1415
264 lines
11 KiB
C
264 lines
11 KiB
C
/* gmarkup.h - Simple XML-like string parser/writer
|
|
*
|
|
* Copyright 2000 Red Hat, Inc.
|
|
*
|
|
* SPDX-License-Identifier: LGPL-2.1-or-later
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with this library; if not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef __G_MARKUP_H__
|
|
#define __G_MARKUP_H__
|
|
|
|
#if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
|
|
#error "Only <glib.h> can be included directly."
|
|
#endif
|
|
|
|
#include <stdarg.h>
|
|
|
|
#include <glib/gerror.h>
|
|
#include <glib/gslist.h>
|
|
|
|
G_BEGIN_DECLS
|
|
|
|
/**
|
|
* GMarkupError:
|
|
* @G_MARKUP_ERROR_BAD_UTF8: text being parsed was not valid UTF-8
|
|
* @G_MARKUP_ERROR_EMPTY: document contained nothing, or only whitespace
|
|
* @G_MARKUP_ERROR_PARSE: document was ill-formed
|
|
* @G_MARKUP_ERROR_UNKNOWN_ELEMENT: error should be set by #GMarkupParser
|
|
* functions; element wasn't known
|
|
* @G_MARKUP_ERROR_UNKNOWN_ATTRIBUTE: error should be set by #GMarkupParser
|
|
* functions; attribute wasn't known
|
|
* @G_MARKUP_ERROR_INVALID_CONTENT: error should be set by #GMarkupParser
|
|
* functions; content was invalid
|
|
* @G_MARKUP_ERROR_MISSING_ATTRIBUTE: error should be set by #GMarkupParser
|
|
* functions; a required attribute was missing
|
|
*
|
|
* Error codes returned by markup parsing.
|
|
*/
|
|
typedef enum
|
|
{
|
|
G_MARKUP_ERROR_BAD_UTF8,
|
|
G_MARKUP_ERROR_EMPTY,
|
|
G_MARKUP_ERROR_PARSE,
|
|
/* The following are primarily intended for specific GMarkupParser
|
|
* implementations to set.
|
|
*/
|
|
G_MARKUP_ERROR_UNKNOWN_ELEMENT,
|
|
G_MARKUP_ERROR_UNKNOWN_ATTRIBUTE,
|
|
G_MARKUP_ERROR_INVALID_CONTENT,
|
|
G_MARKUP_ERROR_MISSING_ATTRIBUTE
|
|
} GMarkupError;
|
|
|
|
/**
|
|
* G_MARKUP_ERROR:
|
|
*
|
|
* Error domain for markup parsing.
|
|
* Errors in this domain will be from the #GMarkupError enumeration.
|
|
* See #GError for information on error domains.
|
|
*/
|
|
#define G_MARKUP_ERROR g_markup_error_quark ()
|
|
|
|
GLIB_AVAILABLE_IN_ALL
|
|
GQuark g_markup_error_quark (void);
|
|
|
|
/**
|
|
* GMarkupParseFlags:
|
|
* @G_MARKUP_DO_NOT_USE_THIS_UNSUPPORTED_FLAG: flag you should not use
|
|
* @G_MARKUP_TREAT_CDATA_AS_TEXT: When this flag is set, CDATA marked
|
|
* sections are not passed literally to the @passthrough function of
|
|
* the parser. Instead, the content of the section (without the
|
|
* `<![CDATA[` and `]]>`) is
|
|
* passed to the @text function. This flag was added in GLib 2.12
|
|
* @G_MARKUP_PREFIX_ERROR_POSITION: Normally errors caught by GMarkup
|
|
* itself have line/column information prefixed to them to let the
|
|
* caller know the location of the error. When this flag is set the
|
|
* location information is also prefixed to errors generated by the
|
|
* #GMarkupParser implementation functions
|
|
* @G_MARKUP_IGNORE_QUALIFIED: Ignore (don't report) qualified
|
|
* attributes and tags, along with their contents. A qualified
|
|
* attribute or tag is one that contains ':' in its name (ie: is in
|
|
* another namespace). Since: 2.40.
|
|
*
|
|
* Flags that affect the behaviour of the parser.
|
|
*/
|
|
typedef enum
|
|
{
|
|
G_MARKUP_DO_NOT_USE_THIS_UNSUPPORTED_FLAG = 1 << 0,
|
|
G_MARKUP_TREAT_CDATA_AS_TEXT = 1 << 1,
|
|
G_MARKUP_PREFIX_ERROR_POSITION = 1 << 2,
|
|
G_MARKUP_IGNORE_QUALIFIED = 1 << 3
|
|
} GMarkupParseFlags;
|
|
|
|
/**
|
|
* GMarkupParseContext:
|
|
*
|
|
* A parse context is used to parse a stream of bytes that
|
|
* you expect to contain marked-up text.
|
|
*
|
|
* See g_markup_parse_context_new(), #GMarkupParser, and so
|
|
* on for more details.
|
|
*/
|
|
typedef struct _GMarkupParseContext GMarkupParseContext;
|
|
typedef struct _GMarkupParser GMarkupParser;
|
|
|
|
/**
|
|
* GMarkupParser:
|
|
* @start_element: Callback to invoke when the opening tag of an element
|
|
* is seen. The callback's @attribute_names and @attribute_values parameters
|
|
* are %NULL-terminated.
|
|
* @end_element: Callback to invoke when the closing tag of an element
|
|
* is seen. Note that this is also called for empty tags like
|
|
* `<empty/>`.
|
|
* @text: Callback to invoke when some text is seen (text is always
|
|
* inside an element). Note that the text of an element may be spread
|
|
* over multiple calls of this function. If the
|
|
* %G_MARKUP_TREAT_CDATA_AS_TEXT flag is set, this function is also
|
|
* called for the content of CDATA marked sections.
|
|
* @passthrough: Callback to invoke for comments, processing instructions
|
|
* and doctype declarations; if you're re-writing the parsed document,
|
|
* write the passthrough text back out in the same position. If the
|
|
* %G_MARKUP_TREAT_CDATA_AS_TEXT flag is not set, this function is also
|
|
* called for CDATA marked sections.
|
|
* @error: Callback to invoke when an error occurs.
|
|
*
|
|
* Any of the fields in #GMarkupParser can be %NULL, in which case they
|
|
* will be ignored. Except for the @error function, any of these callbacks
|
|
* can set an error; in particular the %G_MARKUP_ERROR_UNKNOWN_ELEMENT,
|
|
* %G_MARKUP_ERROR_UNKNOWN_ATTRIBUTE, and %G_MARKUP_ERROR_INVALID_CONTENT
|
|
* errors are intended to be set from these callbacks. If you set an error
|
|
* from a callback, g_markup_parse_context_parse() will report that error
|
|
* back to its caller.
|
|
*/
|
|
struct _GMarkupParser
|
|
{
|
|
/* Called for open tags <foo bar="baz"> */
|
|
void (*start_element) (GMarkupParseContext *context,
|
|
const gchar *element_name,
|
|
const gchar **attribute_names,
|
|
const gchar **attribute_values,
|
|
gpointer user_data,
|
|
GError **error);
|
|
|
|
/* Called for close tags </foo> */
|
|
void (*end_element) (GMarkupParseContext *context,
|
|
const gchar *element_name,
|
|
gpointer user_data,
|
|
GError **error);
|
|
|
|
/* Called for character data */
|
|
/* text is not nul-terminated */
|
|
void (*text) (GMarkupParseContext *context,
|
|
const gchar *text,
|
|
gsize text_len,
|
|
gpointer user_data,
|
|
GError **error);
|
|
|
|
/* Called for strings that should be re-saved verbatim in this same
|
|
* position, but are not otherwise interpretable. At the moment
|
|
* this includes comments and processing instructions.
|
|
*/
|
|
/* text is not nul-terminated. */
|
|
void (*passthrough) (GMarkupParseContext *context,
|
|
const gchar *passthrough_text,
|
|
gsize text_len,
|
|
gpointer user_data,
|
|
GError **error);
|
|
|
|
/* Called on error, including one set by other
|
|
* methods in the vtable. The GError should not be freed.
|
|
*/
|
|
void (*error) (GMarkupParseContext *context,
|
|
GError *error,
|
|
gpointer user_data);
|
|
};
|
|
|
|
GLIB_AVAILABLE_IN_ALL
|
|
GMarkupParseContext *g_markup_parse_context_new (const GMarkupParser *parser,
|
|
GMarkupParseFlags flags,
|
|
gpointer user_data,
|
|
GDestroyNotify user_data_dnotify);
|
|
GLIB_AVAILABLE_IN_2_36
|
|
GMarkupParseContext *g_markup_parse_context_ref (GMarkupParseContext *context);
|
|
GLIB_AVAILABLE_IN_2_36
|
|
void g_markup_parse_context_unref (GMarkupParseContext *context);
|
|
GLIB_AVAILABLE_IN_ALL
|
|
void g_markup_parse_context_free (GMarkupParseContext *context);
|
|
GLIB_AVAILABLE_IN_ALL
|
|
gboolean g_markup_parse_context_parse (GMarkupParseContext *context,
|
|
const gchar *text,
|
|
gssize text_len,
|
|
GError **error);
|
|
GLIB_AVAILABLE_IN_ALL
|
|
void g_markup_parse_context_push (GMarkupParseContext *context,
|
|
const GMarkupParser *parser,
|
|
gpointer user_data);
|
|
GLIB_AVAILABLE_IN_ALL
|
|
gpointer g_markup_parse_context_pop (GMarkupParseContext *context);
|
|
|
|
GLIB_AVAILABLE_IN_ALL
|
|
gboolean g_markup_parse_context_end_parse (GMarkupParseContext *context,
|
|
GError **error);
|
|
GLIB_AVAILABLE_IN_ALL
|
|
const gchar * g_markup_parse_context_get_element (GMarkupParseContext *context);
|
|
GLIB_AVAILABLE_IN_ALL
|
|
const GSList * g_markup_parse_context_get_element_stack (GMarkupParseContext *context);
|
|
|
|
/* For user-constructed error messages, has no precise semantics */
|
|
GLIB_AVAILABLE_IN_ALL
|
|
void g_markup_parse_context_get_position (GMarkupParseContext *context,
|
|
gint *line_number,
|
|
gint *char_number);
|
|
GLIB_AVAILABLE_IN_ALL
|
|
gpointer g_markup_parse_context_get_user_data (GMarkupParseContext *context);
|
|
|
|
/* useful when saving */
|
|
GLIB_AVAILABLE_IN_ALL
|
|
gchar* g_markup_escape_text (const gchar *text,
|
|
gssize length);
|
|
|
|
GLIB_AVAILABLE_IN_ALL
|
|
gchar *g_markup_printf_escaped (const char *format,
|
|
...) G_GNUC_PRINTF (1, 2);
|
|
GLIB_AVAILABLE_IN_ALL
|
|
gchar *g_markup_vprintf_escaped (const char *format,
|
|
va_list args) G_GNUC_PRINTF(1, 0);
|
|
|
|
typedef enum
|
|
{
|
|
G_MARKUP_COLLECT_INVALID,
|
|
G_MARKUP_COLLECT_STRING,
|
|
G_MARKUP_COLLECT_STRDUP,
|
|
G_MARKUP_COLLECT_BOOLEAN,
|
|
G_MARKUP_COLLECT_TRISTATE,
|
|
|
|
G_MARKUP_COLLECT_OPTIONAL = (1 << 16)
|
|
} GMarkupCollectType;
|
|
|
|
|
|
/* useful from start_element */
|
|
GLIB_AVAILABLE_IN_ALL
|
|
gboolean g_markup_collect_attributes (const gchar *element_name,
|
|
const gchar **attribute_names,
|
|
const gchar **attribute_values,
|
|
GError **error,
|
|
GMarkupCollectType first_type,
|
|
const gchar *first_attr,
|
|
...);
|
|
|
|
G_END_DECLS
|
|
|
|
#endif /* __G_MARKUP_H__ */
|