MagickCore  6.9.11-60
Convert, Edit, Or Compose Bitmap Images
xml-tree.h
Go to the documentation of this file.
1 /*
2  Copyright 1999-2021 ImageMagick Studio LLC, a non-profit organization
3  dedicated to making software imaging solutions freely available.
4 
5  You may not use this file except in compliance with the License. You may
6  obtain a copy of the License at
7 
8  https://imagemagick.org/script/license.php
9 
10  Unless required by applicable law or agreed to in writing, software
11  distributed under the License is distributed on an "AS IS" BASIS,
12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  See the License for the specific language governing permissions and
14  limitations under the License.
15 
16  Magick's toolkit xml-tree methods.
17 */
18 #ifndef MAGICKCORE_XML_TREE_H
19 #define MAGICKCORE_XML_TREE_H
20 
21 #include "magick/exception.h"
22 #include "magick/splay-tree.h"
23 
24 #if defined(__cplusplus) || defined(c_plusplus)
25 extern "C" {
26 #endif
27 
28 typedef struct _XMLTreeInfo
30 
31 extern MagickExport char
32  *CanonicalXMLContent(const char *,const MagickBooleanType),
34 
35 extern MagickExport const char
36  *GetXMLTreeAttribute(XMLTreeInfo *,const char *),
40 
43 
45  *AddChildToXMLTree(XMLTreeInfo *,const char *,const size_t),
46  *AddPathToXMLTree(XMLTreeInfo *,const char *,const size_t),
49  *GetXMLTreeChild(XMLTreeInfo *,const char *),
51  *GetXMLTreePath(XMLTreeInfo *,const char *),
54  *NewXMLTree(const char *,ExceptionInfo *),
55  *NewXMLTreeTag(const char *),
58  *SetXMLTreeAttribute(XMLTreeInfo *,const char *,const char *),
59  *SetXMLTreeContent(XMLTreeInfo *,const char *);
60 
61 #if defined(__cplusplus) || defined(c_plusplus)
62 }
63 #endif
64 
65 #endif
XMLTreeInfoToXML
MagickExport char * XMLTreeInfoToXML(XMLTreeInfo *xml_info)
Definition: xml-tree.c:2761
DestroyXMLTreeOrdered
static void DestroyXMLTreeOrdered(XMLTreeInfo *xml_info)
Definition: xml-tree.c:477
MagickExport
#define MagickExport
Definition: method-attribute.h:80
skip_tags
static const char * skip_tags[3]
Definition: xml-tree.c:1934
sentinel
static char * sentinel[]
Definition: xml-tree.c:136
GetXMLTreeProcessingInstructions
MagickExport const char ** GetXMLTreeProcessingInstructions(XMLTreeInfo *, const char *)
FileToXML
MagickPrivate char * FileToXML(const char *filename, const size_t extent)
Definition: xml-tree.c:597
_XMLTreeInfo::child
XMLTreeInfo * child
Definition: xml-tree.c:91
GetXMLTreeAttribute
MagickExport const char * GetXMLTreeAttribute(XMLTreeInfo *, const char *)
GetMagickModule
#define GetMagickModule()
Definition: log.h:29
IsSkipTag
static MagickBooleanType IsSkipTag(const char *tag)
Definition: xml-tree.c:1941
_XMLTreeInfo::parent
XMLTreeInfo * parent
Definition: xml-tree.c:87
_SplayTreeInfo
Definition: splay-tree.c:83
_XMLTreeInfo::semaphore
SemaphoreInfo * semaphore
Definition: xml-tree.c:97
MagickCoreSignature
#define MagickCoreSignature
Definition: method-attribute.h:86
O_BINARY
#define O_BINARY
Definition: studio.h:362
FormatLocaleString
MagickExport ssize_t FormatLocaleString(char *magick_restrict string, const size_t length, const char *magick_restrict format,...)
Definition: locale.c:497
OptionWarning
@ OptionWarning
Definition: exception.h:34
ParseOpenTag
static void ParseOpenTag(XMLTreeRoot *root, char *tag, char **attributes)
Definition: xml-tree.c:1918
ResizeQuantumMemory
MagickExport void * ResizeQuantumMemory(void *memory, const size_t count, const size_t quantum)
Definition: memory.c:1447
MagickMaxBufferExtent
#define MagickMaxBufferExtent
Definition: blob.h:28
AddChildToXMLTree
MagickExport XMLTreeInfo * AddChildToXMLTree(XMLTreeInfo *xml_info, const char *tag, const size_t offset)
Definition: xml-tree.c:166
_XMLTreeRoot
Definition: xml-tree.c:107
GetXMLTreeChild
MagickExport XMLTreeInfo * GetXMLTreeChild(XMLTreeInfo *, const char *)
image-private.h
GetXMLTreeAttribute
MagickExport const char * GetXMLTreeAttribute(XMLTreeInfo *xml_info, const char *tag)
Definition: xml-tree.c:777
GetXMLTreeTag
MagickExport const char * GetXMLTreeTag(XMLTreeInfo *xml_info)
Definition: xml-tree.c:1156
UnmapBlob
MagickExport MagickBooleanType UnmapBlob(void *, const size_t)
Definition: blob.c:4752
InsertTagIntoXMLTree
MagickExport XMLTreeInfo * InsertTagIntoXMLTree(XMLTreeInfo *, XMLTreeInfo *, const size_t)
ParseTagFromXMLTree
MagickExport XMLTreeInfo * ParseTagFromXMLTree(XMLTreeInfo *)
ParseEntities
static char * ParseEntities(char *xml, char **entities, int state)
Definition: xml-tree.c:1368
AddPathToXMLTree
MagickExport XMLTreeInfo * AddPathToXMLTree(XMLTreeInfo *xml_info, const char *path, const size_t offset)
Definition: xml-tree.c:214
DestroyXMLTreeRoot
static void DestroyXMLTreeRoot(XMLTreeInfo *xml_info)
Definition: xml-tree.c:493
NumberPredefinedEntities
#define NumberPredefinedEntities
Definition: xml-tree.c:70
GetXMLTreePath
MagickExport XMLTreeInfo * GetXMLTreePath(XMLTreeInfo *, const char *)
ResourceLimitError
@ ResourceLimitError
Definition: exception.h:55
utility.h
AddPathToXMLTree
MagickExport XMLTreeInfo * AddPathToXMLTree(XMLTreeInfo *, const char *, const size_t)
_XMLTreeRoot::semaphore
SemaphoreInfo * semaphore
Definition: xml-tree.c:126
_XMLTreeInfo::sibling
XMLTreeInfo * sibling
Definition: xml-tree.c:89
string_.h
DestroyString
MagickExport char * DestroyString(char *string)
Definition: string.c:808
GetPathComponent
MagickExport void GetPathComponent(const char *path, PathType type, char *component)
Definition: utility.c:1218
MagickTrue
@ MagickTrue
Definition: magick-type.h:205
GetXMLTreeContent
MagickExport const char * GetXMLTreeContent(XMLTreeInfo *xml_info)
Definition: xml-tree.c:934
blob.h
semaphore.h
CanonicalXMLContent
MagickExport char * CanonicalXMLContent(const char *, const MagickBooleanType)
blob-private.h
ParseInternalDoctype
static MagickBooleanType ParseInternalDoctype(XMLTreeRoot *root, char *xml, size_t length, ExceptionInfo *exception)
Definition: xml-tree.c:1692
NewXMLTree
MagickExport XMLTreeInfo * NewXMLTree(const char *, ExceptionInfo *)
GetNextXMLTreeTag
MagickExport XMLTreeInfo * GetNextXMLTreeTag(XMLTreeInfo *)
GetXMLTreeAttributes
MagickExport MagickBooleanType GetXMLTreeAttributes(const XMLTreeInfo *xml_info, SplayTreeInfo *attributes)
Definition: xml-tree.c:846
GetXMLTreeAttributes
MagickExport MagickBooleanType GetXMLTreeAttributes(const XMLTreeInfo *, SplayTreeInfo *)
Definition: xml-tree.c:846
TraceEvent
@ TraceEvent
Definition: log.h:38
GetXMLTreeSibling
MagickExport XMLTreeInfo * GetXMLTreeSibling(XMLTreeInfo *xml_info)
Definition: xml-tree.c:1124
AcquireMagickMemory
MagickExport void * AcquireMagickMemory(const size_t size)
Definition: memory.c:552
_XMLTreeRoot::debug
MagickBooleanType debug
Definition: xml-tree.c:123
_XMLTreeInfo
Definition: xml-tree.c:77
_XMLTreeRoot::processing_instructions
char *** processing_instructions
Definition: xml-tree.c:118
DestroyXMLTreeChild
static void DestroyXMLTreeChild(XMLTreeInfo *xml_info)
Definition: xml-tree.c:461
GetXMLTreeOrdered
MagickExport XMLTreeInfo * GetXMLTreeOrdered(XMLTreeInfo *)
SemaphoreInfo
Definition: semaphore.c:61
ParseCloseTag
static XMLTreeInfo * ParseCloseTag(XMLTreeRoot *root, char *tag, ExceptionInfo *exception)
Definition: xml-tree.c:1572
GetXMLTreeProcessingInstructions
MagickExport const char ** GetXMLTreeProcessingInstructions(XMLTreeInfo *xml_info, const char *target)
Definition: xml-tree.c:1076
NewXMLTreeTag
MagickExport XMLTreeInfo * NewXMLTreeTag(const char *tag)
Definition: xml-tree.c:2362
_XMLTreeInfo::debug
MagickBooleanType debug
Definition: xml-tree.c:94
ValidateEntities
static MagickBooleanType ValidateEntities(char *tag, char *xml, const size_t depth, char **entities)
Definition: xml-tree.c:1586
_XMLTreeRoot::signature
size_t signature
Definition: xml-tree.c:129
PruneTagFromXMLTree
MagickExport XMLTreeInfo * PruneTagFromXMLTree(XMLTreeInfo *xml_info)
Definition: xml-tree.c:2418
ConcatenateString
MagickExport MagickBooleanType ConcatenateString(char **magick_restrict destination, const char *magick_restrict source)
Definition: string.c:491
_XMLTreeInfo::next
XMLTreeInfo * next
Definition: xml-tree.c:88
MagickMaxRecursionDepth
#define MagickMaxRecursionDepth
Definition: studio.h:381
DestroyXMLTree
MagickExport XMLTreeInfo * DestroyXMLTree(XMLTreeInfo *)
_XMLTreeInfo::offset
size_t offset
Definition: xml-tree.c:84
LocaleCompare
MagickExport int LocaleCompare(const char *p, const char *q)
Definition: locale.c:1435
_XMLTreeRoot::root
struct _XMLTreeInfo root
Definition: xml-tree.c:108
PruneTagFromXMLTree
MagickExport XMLTreeInfo * PruneTagFromXMLTree(XMLTreeInfo *)
CanonicalPath
@ CanonicalPath
Definition: utility.h:35
splay-tree.h
SetXMLTreeContent
MagickExport XMLTreeInfo * SetXMLTreeContent(XMLTreeInfo *xml_info, const char *content)
Definition: xml-tree.c:2584
MagickPrivate
#define MagickPrivate
Definition: method-attribute.h:81
xml-tree-private.h
AddChildToXMLTree
MagickExport XMLTreeInfo * AddChildToXMLTree(XMLTreeInfo *, const char *, const size_t)
MagickFalse
@ MagickFalse
Definition: magick-type.h:204
NewXMLTree
MagickExport XMLTreeInfo * NewXMLTree(const char *xml, ExceptionInfo *exception)
Definition: xml-tree.c:1956
IsEventLogging
MagickExport MagickBooleanType IsEventLogging(void)
Definition: log.c:725
xml-tree.h
GetXMLTreeSibling
MagickExport XMLTreeInfo * GetXMLTreeSibling(XMLTreeInfo *)
ParseCharacterContent
static void ParseCharacterContent(XMLTreeRoot *root, char *xml, const size_t length, const char state)
Definition: xml-tree.c:1547
DestroyXMLTreeAttributes
static char ** DestroyXMLTreeAttributes(char **attributes)
Definition: xml-tree.c:437
DestroyXMLTree
MagickExport XMLTreeInfo * DestroyXMLTree(XMLTreeInfo *xml_info)
Definition: xml-tree.c:556
EncodePredefinedEntities
static char * EncodePredefinedEntities(const char *source, ssize_t offset, char **destination, size_t *length, size_t *extent, MagickBooleanType pedantic)
Definition: xml-tree.c:2621
_XMLTreeInfo::signature
size_t signature
Definition: xml-tree.c:100
SetXMLTreeAttribute
MagickExport XMLTreeInfo * SetXMLTreeAttribute(XMLTreeInfo *xml_info, const char *tag, const char *value)
Definition: xml-tree.c:2492
Base64Encode
MagickExport char * Base64Encode(const unsigned char *blob, const size_t blob_length, size_t *encode_length)
Definition: utility.c:498
AddValueToSplayTree
MagickExport MagickBooleanType AddValueToSplayTree(SplayTreeInfo *splay_tree, const void *key, const void *value)
Definition: splay-tree.c:153
_XMLTreeInfo::ordered
XMLTreeInfo * ordered
Definition: xml-tree.c:90
_XMLTreeInfo::attributes
char ** attributes
Definition: xml-tree.c:80
GetNextXMLTreeTag
MagickExport XMLTreeInfo * GetNextXMLTreeTag(XMLTreeInfo *xml_info)
Definition: xml-tree.c:742
_XMLTreeRoot::attributes
char *** attributes
Definition: xml-tree.c:120
GetXMLTreePath
MagickExport XMLTreeInfo * GetXMLTreePath(XMLTreeInfo *xml_info, const char *path)
Definition: xml-tree.c:1001
log.h
ConstantString
MagickExport char * ConstantString(const char *source)
Definition: string.c:698
MagickBooleanType
MagickBooleanType
Definition: magick-type.h:203
ConvertLatin1ToUTF8
static unsigned char * ConvertLatin1ToUTF8(const unsigned char *magick_restrict content)
Definition: token-private.h:51
RelinquishMagickMemory
MagickExport void * RelinquishMagickMemory(void *memory)
Definition: memory.c:1162
_ExceptionInfo
Definition: exception.h:103
utility-private.h
studio.h
ConvertUTF16ToUTF8
static char * ConvertUTF16ToUTF8(const char *content, size_t *length)
Definition: xml-tree.c:1287
StringToLong
static long StringToLong(const char *magick_restrict value)
Definition: string-private.h:108
token-private.h
GetPathComponents
MagickExport char ** GetPathComponents(const char *path, size_t *number_components)
Definition: utility.c:1409
XMLTreeInfoToXML
MagickExport char * XMLTreeInfoToXML(XMLTreeInfo *)
Definition: xml-tree.c:2761
InsertTagIntoXMLTree
MagickExport XMLTreeInfo * InsertTagIntoXMLTree(XMLTreeInfo *xml_info, XMLTreeInfo *child, const size_t offset)
Definition: xml-tree.c:1194
memory_.h
ParseProcessingInstructions
static void ParseProcessingInstructions(XMLTreeRoot *root, char *xml, size_t length)
Definition: xml-tree.c:1615
SubimagePath
@ SubimagePath
Definition: utility.h:34
_XMLTreeInfo::tag
char * tag
Definition: xml-tree.c:79
_XMLTreeRoot::node
XMLTreeInfo * node
Definition: xml-tree.c:112
exception-private.h
NewXMLTreeTag
MagickExport XMLTreeInfo * NewXMLTreeTag(const char *)
SetXMLTreeAttribute
MagickExport XMLTreeInfo * SetXMLTreeAttribute(XMLTreeInfo *, const char *, const char *)
ThrowMagickException
MagickExport MagickBooleanType ThrowMagickException(ExceptionInfo *exception, const char *module, const char *function, const size_t line, const ExceptionType severity, const char *tag, const char *format,...)
Definition: exception.c:1149
ThrowFatalException
#define ThrowFatalException(severity, tag)
Definition: exception-private.h:42
exception.h
SetXMLTreeContent
MagickExport XMLTreeInfo * SetXMLTreeContent(XMLTreeInfo *, const char *)
Definition: xml-tree.c:2584
_XMLTreeInfo::content
char * content
Definition: xml-tree.c:81
ReadMode
@ ReadMode
Definition: blob.h:33
CopyMagickString
MagickExport size_t CopyMagickString(char *magick_restrict destination, const char *magick_restrict source, const size_t length)
Definition: string.c:751
LogMagickEvent
MagickExport MagickBooleanType LogMagickEvent(const LogEventType type, const char *module, const char *function, const size_t line, const char *format,...)
Definition: log.c:1420
XMLTreeTagToXML
static char * XMLTreeTagToXML(XMLTreeInfo *xml_info, char **source, size_t *length, size_t *extent, size_t start, char ***attributes)
Definition: xml-tree.c:2655
MaxTextExtent
#define MaxTextExtent
Definition: method-attribute.h:89
GetXMLTreeTag
MagickExport const char * GetXMLTreeTag(XMLTreeInfo *)
Definition: xml-tree.c:1156
GetXMLTreeOrdered
MagickExport XMLTreeInfo * GetXMLTreeOrdered(XMLTreeInfo *xml_info)
Definition: xml-tree.c:966
string-private.h
GetXMLTreeChild
MagickExport XMLTreeInfo * GetXMLTreeChild(XMLTreeInfo *xml_info, const char *tag)
Definition: xml-tree.c:894
ResourceLimitFatalError
@ ResourceLimitFatalError
Definition: exception.h:78
AcquireString
MagickExport char * AcquireString(const char *source)
Definition: string.c:125
CanonicalXMLContent
MagickExport char * CanonicalXMLContent(const char *content, const MagickBooleanType pedantic)
Definition: xml-tree.c:298
MagickMin
#define MagickMin(x, y)
Definition: image-private.h:37
open_utf8
static int open_utf8(const char *path, int flags, mode_t mode)
Definition: utility-private.h:166
XMLWhitespace
#define XMLWhitespace
Definition: xml-tree.c:71
GetXMLTreeContent
MagickExport const char * GetXMLTreeContent(XMLTreeInfo *)
_XMLTreeRoot::standalone
MagickBooleanType standalone
Definition: xml-tree.c:115
MapBlob
MagickExport unsigned char * MapBlob(int, const MapMode, const MagickOffsetType, const size_t)
Definition: blob.c:2392
MAGICK_SSIZE_MAX
#define MAGICK_SSIZE_MAX
Definition: studio.h:382
AcquireQuantumMemory
MagickExport void * AcquireQuantumMemory(const size_t count, const size_t quantum)
Definition: memory.c:665
_XMLTreeRoot::entities
char ** entities
Definition: xml-tree.c:119
MagickOffsetType
ssize_t MagickOffsetType
Definition: magick-type.h:139