Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / libxml2 / 429d3a0aae2eda7ba9451f9c9f8523c61cc0368b / . / include / libxml / c14n.h
blob: 3011af79ebbd2a499f888cfe6f2b6faf91ce8279 [file] [log] [blame]
Daniel Veillard044fc6b2002-03-04 17:09:44 +0000[diff] [blame]1/*
Daniel Veillardbe586972003-11-18 20:56:51 +0000[diff] [blame]2 * Summary: Provide Canonical XML and Exclusive XML Canonicalization
3 * Description: the c14n modules provides a
4 *
Daniel Veillarddee23482008-04-11 12:58:43 +0000[diff] [blame]5 * "Canonical XML" implementation
Daniel Veillard044fc6b2002-03-04 17:09:44 +0000[diff] [blame]6 * http://www.w3.org/TR/xml-c14n
Daniel Veillarddee23482008-04-11 12:58:43 +0000[diff] [blame]7 *
Daniel Veillardbe586972003-11-18 20:56:51 +0000[diff] [blame]8 * and an
9 *
Daniel Veillard044fc6b2002-03-04 17:09:44 +0000[diff] [blame]10 * "Exclusive XML Canonicalization" implementation
11 * http://www.w3.org/TR/xml-exc-c14n
Daniel Veillarddee23482008-04-11 12:58:43 +0000[diff] [blame]12
Daniel Veillardbe586972003-11-18 20:56:51 +0000[diff] [blame]13 * Copy: See Copyright for the status of this software.
Daniel Veillarddee23482008-04-11 12:58:43 +0000[diff] [blame]14 *
Daniel Veillard044fc6b2002-03-04 17:09:44 +0000[diff] [blame]15 * Author: Aleksey Sanin <aleksey@aleksey.com>
16 */
17#ifndef __XML_C14N_H__
Daniel Veillarddee23482008-04-11 12:58:43 +0000[diff] [blame]18#define __XML_C14N_H__
Daniel Veillarda2351322004-06-27 12:08:10 +0000[diff] [blame]19#ifdef LIBXML_C14N_ENABLED
Daniel Veillarda9cce9c2003-09-29 13:20:24 +0000[diff] [blame]20#ifdef LIBXML_OUTPUT_ENABLED
Daniel Veillard044fc6b2002-03-04 17:09:44 +0000[diff] [blame]21
22#ifdef __cplusplus
23extern "C" {
Daniel Veillarddee23482008-04-11 12:58:43 +0000[diff] [blame]24#endif /* __cplusplus */
Daniel Veillard044fc6b2002-03-04 17:09:44 +0000[diff] [blame]25
Igor Zlatkovic76874e42003-08-25 09:05:12 +0000[diff] [blame]26#include <libxml/xmlversion.h>
Daniel Veillard044fc6b2002-03-04 17:09:44 +0000[diff] [blame]27#include <libxml/tree.h>
Daniel Veillarddee23482008-04-11 12:58:43 +0000[diff] [blame]28#include <libxml/xpath.h>
Daniel Veillard044fc6b2002-03-04 17:09:44 +0000[diff] [blame]29
30/*
31 * XML Canonicazation
32 * http://www.w3.org/TR/xml-c14n
33 *
34 * Exclusive XML Canonicazation
35 * http://www.w3.org/TR/xml-exc-c14n
36 *
37 * Canonical form of an XML document could be created if and only if
38 * a) default attributes (if any) are added to all nodes
39 * b) all character and parsed entity references are resolved
Daniel Veillarddee23482008-04-11 12:58:43 +0000[diff] [blame]40 * In order to achive this in libxml2 the document MUST be loaded with
Daniel Veillard044fc6b2002-03-04 17:09:44 +0000[diff] [blame]41 * following global setings:
Daniel Veillarddee23482008-04-11 12:58:43 +0000[diff] [blame]42 *
Daniel Veillard044fc6b2002-03-04 17:09:44 +0000[diff] [blame]43 * xmlLoadExtDtdDefaultValue = XML_DETECT_IDS | XML_COMPLETE_ATTRS;
44 * xmlSubstituteEntitiesDefault(1);
45 *
46 * or corresponding parser context setting:
47 * xmlParserCtxtPtr ctxt;
Daniel Veillarddee23482008-04-11 12:58:43 +0000[diff] [blame]48 *
49 * ...
Daniel Veillard044fc6b2002-03-04 17:09:44 +0000[diff] [blame]50 * ctxt->loadsubset = XML_DETECT_IDS | XML_COMPLETE_ATTRS;
51 * ctxt->replaceEntities = 1;
52 * ...
53 */
Aleksey Sanin2c135a12002-08-01 06:31:50 +0000[diff] [blame]54
Aleksey Sanin83868242009-07-09 10:26:22 +0200[diff] [blame]55/*
56 * xmlC14NMode:
57 *
58 * Predefined values for C14N modes
59 *
60 */
61typedef enum {
62 XML_C14N_1_0 = 0, /* Origianal C14N 1.0 spec */
63 XML_C14N_EXCLUSIVE_1_0 = 1, /* Exclusive C14N 1.0 spec */
64 XML_C14N_1_1 = 2 /* C14N 1.1 spec */
65} xmlC14NMode;
Aleksey Sanin2c135a12002-08-01 06:31:50 +0000[diff] [blame]66
Daniel Veillarddee23482008-04-11 12:58:43 +0000[diff] [blame]67XMLPUBFUN int XMLCALL
Igor Zlatkovic76874e42003-08-25 09:05:12 +0000[diff] [blame]68 xmlC14NDocSaveTo (xmlDocPtr doc,
Daniel Veillard044fc6b2002-03-04 17:09:44 +0000[diff] [blame]69 xmlNodeSetPtr nodes,
Aleksey Sanin83868242009-07-09 10:26:22 +0200[diff] [blame]70 int mode, /* a xmlC14NMode */
Daniel Veillard044fc6b2002-03-04 17:09:44 +0000[diff] [blame]71 xmlChar **inclusive_ns_prefixes,
Daniel Veillarddee23482008-04-11 12:58:43 +0000[diff] [blame]72 int with_comments,
Daniel Veillard044fc6b2002-03-04 17:09:44 +0000[diff] [blame]73 xmlOutputBufferPtr buf);
74
Igor Zlatkovic76874e42003-08-25 09:05:12 +0000[diff] [blame]75XMLPUBFUN int XMLCALL
76 xmlC14NDocDumpMemory (xmlDocPtr doc,
Daniel Veillard044fc6b2002-03-04 17:09:44 +0000[diff] [blame]77 xmlNodeSetPtr nodes,
Aleksey Sanin175beba2009-07-09 22:54:00 +0200[diff] [blame]78 int mode, /* a xmlC14NMode */
Daniel Veillard044fc6b2002-03-04 17:09:44 +0000[diff] [blame]79 xmlChar **inclusive_ns_prefixes,
Daniel Veillarddee23482008-04-11 12:58:43 +0000[diff] [blame]80 int with_comments,
Daniel Veillard044fc6b2002-03-04 17:09:44 +0000[diff] [blame]81 xmlChar **doc_txt_ptr);
82
Igor Zlatkovic76874e42003-08-25 09:05:12 +0000[diff] [blame]83XMLPUBFUN int XMLCALL
84 xmlC14NDocSave (xmlDocPtr doc,
Daniel Veillard044fc6b2002-03-04 17:09:44 +0000[diff] [blame]85 xmlNodeSetPtr nodes,
Aleksey Sanin175beba2009-07-09 22:54:00 +0200[diff] [blame]86 int mode, /* a xmlC14NMode */
Daniel Veillard044fc6b2002-03-04 17:09:44 +0000[diff] [blame]87 xmlChar **inclusive_ns_prefixes,
Daniel Veillarddee23482008-04-11 12:58:43 +0000[diff] [blame]88 int with_comments,
Daniel Veillard044fc6b2002-03-04 17:09:44 +0000[diff] [blame]89 const char* filename,
90 int compression);
91
92
Aleksey Sanin2c135a12002-08-01 06:31:50 +0000[diff] [blame]93/**
94 * This is the core C14N function
95 */
Daniel Veillarddee23482008-04-11 12:58:43 +0000[diff] [blame]96/**
97 * xmlC14NIsVisibleCallback:
98 * @user_data: user data
99 * @node: the curent node
100 * @parent: the parent node
101 *
102 * Signature for a C14N callback on visible nodes
103 *
104 * Returns 1 if the node should be included
105 */
106typedef int (*xmlC14NIsVisibleCallback) (void* user_data,
Aleksey Sanin2c135a12002-08-01 06:31:50 +0000[diff] [blame]107 xmlNodePtr node,
108 xmlNodePtr parent);
109
Igor Zlatkovic76874e42003-08-25 09:05:12 +0000[diff] [blame]110XMLPUBFUN int XMLCALL
111 xmlC14NExecute (xmlDocPtr doc,
Aleksey Sanin2c135a12002-08-01 06:31:50 +0000[diff] [blame]112 xmlC14NIsVisibleCallback is_visible_callback,
Daniel Veillarddee23482008-04-11 12:58:43 +0000[diff] [blame]113 void* user_data,
Aleksey Sanin175beba2009-07-09 22:54:00 +0200[diff] [blame]114 int mode, /* a xmlC14NMode */
Aleksey Sanin2c135a12002-08-01 06:31:50 +0000[diff] [blame]115 xmlChar **inclusive_ns_prefixes,
Daniel Veillarddee23482008-04-11 12:58:43 +0000[diff] [blame]116 int with_comments,
Aleksey Sanin2c135a12002-08-01 06:31:50 +0000[diff] [blame]117 xmlOutputBufferPtr buf);
118
Daniel Veillard044fc6b2002-03-04 17:09:44 +0000[diff] [blame]119#ifdef __cplusplus
120}
121#endif /* __cplusplus */
122
Daniel Veillarda9cce9c2003-09-29 13:20:24 +0000[diff] [blame]123#endif /* LIBXML_OUTPUT_ENABLED */
Daniel Veillarda2351322004-06-27 12:08:10 +0000[diff] [blame]124#endif /* LIBXML_C14N_ENABLED */
Daniel Veillard044fc6b2002-03-04 17:09:44 +0000[diff] [blame]125#endif /* __XML_C14N_H__ */
126