xml.h

Go to the documentation of this file.

// Copyright (C) 2004-2024 Artifex Software, Inc.
//
// This file is part of MuPDF.
//
// MuPDF is free software: you can redistribute it and/or modify it under the
// terms of the GNU Affero General Public License as published by the Free
// Software Foundation, either version 3 of the License, or (at your option)
// any later version.
//
// MuPDF 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 Affero General Public License for more
// details.
//
// You should have received a copy of the GNU Affero General Public License
// along with MuPDF. If not, see <https://www.gnu.org/licenses/agpl-3.0.en.html>
//
// Alternative licensing terms are available from the licensor.
// For commercial licensing, see <https://www.artifex.com/> or contact
// Artifex Software, Inc., 39 Mesa Street, Suite 108A, San Francisco,
// CA 94129, USA, for further information.
 
#ifndef MUPDF_FITZ_XML_H
#define MUPDF_FITZ_XML_H
 
#include "mupdf/fitz/system.h"
#include "mupdf/fitz/context.h"
#include "mupdf/fitz/buffer.h"
#include "mupdf/fitz/pool.h"
#include "mupdf/fitz/archive.h"

 
typedef struct fz_xml fz_xml;
 
/* For backwards compatibility */
typedef fz_xml fz_xml_doc;

fz_xml *fz_parse_xml(fz_context *ctx, fz_buffer *buf, int preserve_white);

fz_xml *fz_parse_xml_stream(fz_context *ctx, fz_stream *stream, int preserve_white);

fz_xml *fz_parse_xml_archive_entry(fz_context *ctx, fz_archive *dir, const char *filename, int preserve_white);

fz_xml *fz_try_parse_xml_archive_entry(fz_context *ctx, fz_archive *dir, const char *filename, int preserve_white);

fz_xml *fz_parse_xml_from_html5(fz_context *ctx, fz_buffer *buf);

fz_xml *fz_keep_xml(fz_context *ctx, fz_xml *xml);

void fz_drop_xml(fz_context *ctx, fz_xml *xml);

void fz_detach_xml(fz_context *ctx, fz_xml *node);

fz_xml *fz_xml_root(fz_xml_doc *xml);

fz_xml *fz_xml_prev(fz_xml *item);

fz_xml *fz_xml_next(fz_xml *item);

fz_xml *fz_xml_up(fz_xml *item);

fz_xml *fz_xml_down(fz_xml *item);

int fz_xml_is_tag(fz_xml *item, const char *name);

char *fz_xml_tag(fz_xml *item);

char *fz_xml_att(fz_xml *item, const char *att);

char *fz_xml_att_alt(fz_xml *item, const char *one, const char *two);

int fz_xml_att_eq(fz_xml *item, const char *name, const char *match);

void fz_xml_add_att(fz_context *ctx, fz_pool *pool, fz_xml *node, const char *key, const char *val);

char *fz_xml_text(fz_xml *item);

void fz_output_xml(fz_context *ctx, fz_output *out, fz_xml *item, int level);

void fz_debug_xml(fz_xml *item, int level);

fz_xml *fz_xml_find(fz_xml *item, const char *tag);

fz_xml *fz_xml_find_next(fz_xml *item, const char *tag);

fz_xml *fz_xml_find_down(fz_xml *item, const char *tag);

fz_xml *fz_xml_find_match(fz_xml *item, const char *tag, const char *att, const char *match);

fz_xml *fz_xml_find_next_match(fz_xml *item, const char *tag, const char *att, const char *match);

fz_xml *fz_xml_find_down_match(fz_xml *item, const char *tag, const char *att, const char *match);

fz_xml *fz_xml_find_dfs(fz_xml *item, const char *tag, const char *att, const char *match);

fz_xml *fz_xml_find_dfs_top(fz_xml *item, const char *tag, const char *att, const char *match, fz_xml *top);

fz_xml *fz_xml_find_next_dfs(fz_xml *item, const char *tag, const char *att, const char *match);

fz_xml *fz_xml_find_next_dfs_top(fz_xml *item, const char *tag, const char *att, const char *match, fz_xml *top);

char *fz_new_text_from_xml(fz_context *ctx, fz_xml *root);


fz_xml *fz_dom_body(fz_context *ctx, fz_xml *dom);

fz_xml *fz_dom_document_element(fz_context *ctx, fz_xml *dom);

fz_xml *fz_dom_create_element(fz_context *ctx, fz_xml *dom, const char *tag);

fz_xml *fz_dom_create_text_node(fz_context *ctx, fz_xml *dom, const char *text);

fz_xml *fz_dom_find(fz_context *ctx, fz_xml *elt, const char *tag, const char *att, const char *match);

fz_xml *fz_dom_find_next(fz_context *ctx, fz_xml *elt, const char *tag, const char *att, const char *match);

void fz_dom_append_child(fz_context *ctx, fz_xml *parent, fz_xml *child);

void fz_dom_insert_before(fz_context *ctx, fz_xml *node, fz_xml *new_elt);

void fz_dom_insert_after(fz_context *ctx, fz_xml *node, fz_xml *new_elt);

void fz_dom_remove(fz_context *ctx, fz_xml *elt);

fz_xml *fz_dom_clone(fz_context *ctx, fz_xml *elt);

fz_xml *fz_dom_first_child(fz_context *ctx, fz_xml *elt);

fz_xml *fz_dom_parent(fz_context *ctx, fz_xml *elt);

fz_xml *fz_dom_next(fz_context *ctx, fz_xml *elt);

fz_xml *fz_dom_previous(fz_context *ctx, fz_xml *elt);

void fz_dom_add_attribute(fz_context *ctx, fz_xml *elt, const char *att, const char *value);

void fz_dom_remove_attribute(fz_context *ctx, fz_xml *elt, const char *att);

const char *fz_dom_attribute(fz_context *ctx, fz_xml *elt, const char *att);

const char *fz_dom_get_attribute(fz_context *ctx, fz_xml *elt, int i, const char **att);

fz_xml *fz_new_dom(fz_context *ctx, const char *tag);

fz_xml *fz_new_dom_node(fz_context *ctx, fz_xml *dom, const char *tag);

fz_xml *fz_new_dom_text_node(fz_context *ctx, fz_xml *dom, const char *text);

void fz_write_xml(fz_context *ctx, fz_xml *root, fz_output *out, int indented);

void fz_save_xml(fz_context *ctx, fz_xml *root, const char *path, int indented);
 
#endif