OcXmlLib.h

Go to the documentation of this file.

 
//
// Copyright (c) 2012 ooxi/xml.c
//     https://github.com/ooxi/xml.c
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the
// use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it
// freely, subject to the following restrictions:
//
//  1. The origin of this software must not be misrepresented; you must not
//     claim that you wrote the original software. If you use this software in a
//     product, an acknowledgment in the product documentation would be
//     appreciated but is not required.
//
//  2. Altered source versions must be plainly marked as such, and must not be
//     misrepresented as being the original software.
//
//  3. This notice may not be removed or altered from any source distribution.
//
 
#ifndef OC_XML_LIB_H
#define OC_XML_LIB_H
 
#include <Library/BaseOverflowLib.h>
 
#ifndef XML_PARSER_NEST_LEVEL
#define XML_PARSER_NEST_LEVEL  32ULL
#endif
 
#ifndef XML_PARSER_NODE_COUNT
#define XML_PARSER_NODE_COUNT  32768ULL
#endif
 
#ifndef XML_PARSER_MAX_REFERENCE_COUNT
#define XML_PARSER_MAX_REFERENCE_COUNT  (32ULL*1024)
#endif
 
#ifndef XML_PARSER_MAX_SIZE
#define XML_PARSER_MAX_SIZE  (32ULL*1024*1024)
#endif
 
// #define XML_PARSER_VERBOSE
// #define XML_PRINT_ERRORS
 
typedef enum PLIST_NODE_TYPE_ {
  PLIST_NODE_TYPE_ANY,
  PLIST_NODE_TYPE_ARRAY,
  PLIST_NODE_TYPE_DICT,
  PLIST_NODE_TYPE_KEY,
  PLIST_NODE_TYPE_STRING,
  PLIST_NODE_TYPE_DATA,
  PLIST_NODE_TYPE_DATE,
  PLIST_NODE_TYPE_TRUE,
  PLIST_NODE_TYPE_FALSE,
  PLIST_NODE_TYPE_REAL,
  PLIST_NODE_TYPE_INTEGER,
  PLIST_NODE_TYPE_MAX
} PLIST_NODE_TYPE;
 
struct XML_DOCUMENT_;
struct XML_NODE_;
typedef struct XML_DOCUMENT_  XML_DOCUMENT;
typedef struct XML_NODE_      XML_NODE;
 
XML_DOCUMENT *
XmlDocumentParse (
  IN OUT  CHAR8    *Buffer,
  IN      UINT32   Length,
  IN      BOOLEAN  WithRefs
  );
 
CHAR8 *
XmlDocumentExport (
  IN   CONST XML_DOCUMENT  *Document,
  OUT  UINT32              *Length  OPTIONAL,
  IN   UINT32              Skip,
  IN   BOOLEAN             PrependPlistInfo
  );
 
VOID
XmlDocumentFree (
  IN OUT  XML_DOCUMENT  *Document
  );
 
XML_NODE *
XmlDocumentRoot (
  IN  CONST XML_DOCUMENT  *Document
  );
 
CONST CHAR8 *
XmlNodeName (
  IN  CONST XML_NODE  *Node
  );
 
CONST CHAR8 *
XmlNodeContent (
  IN  CONST XML_NODE  *Node
  );
 
VOID
XmlNodeChangeContent (
  IN OUT  XML_NODE     *Node,
  IN      CONST CHAR8  *Content
  );
 
UINT32
XmlNodeChildren (
  IN  CONST XML_NODE  *Node
  );
 
XML_NODE *
XmlNodeChild (
  IN  CONST XML_NODE  *Node,
  IN  UINT32          Child
  );
 
XML_NODE *
EFIAPI
XmlEasyChild (
  IN OUT  XML_NODE     *Node,
  IN      CONST CHAR8  *ChildName,
  ...
  );
 
XML_NODE *
XmlNodeAppend (
  IN OUT  XML_NODE     *Node,
  IN      CONST CHAR8  *Name,
  IN      CONST CHAR8  *Attributes  OPTIONAL,
  IN      CONST CHAR8  *Content     OPTIONAL
  );
 
XML_NODE *
XmlNodePrepend (
  IN OUT  XML_NODE     *Node,
  IN      CONST CHAR8  *Name,
  IN      CONST CHAR8  *Attributes,
  IN      CONST CHAR8  *Content
  );
 
VOID
XmlNodeRemoveByIndex (
  IN OUT  XML_NODE  *Node,
  IN      UINT32    Index
  );
 
VOID
XmlNodeRemove (
  IN OUT  XML_NODE  *Node,
  IN      XML_NODE  *ChildNode
  );
 
CONST CHAR8 *
XmlUnescapeString (
  IN      CONST CHAR8  *String
  );
 
XML_NODE *
PlistDocumentRoot (
  IN  CONST XML_DOCUMENT  *Document
  );
 
XML_NODE *
PlistNodeCast (
  IN  XML_NODE         *Node  OPTIONAL,
  IN  PLIST_NODE_TYPE  Type
  );
 
UINT32
PlistDictChildren (
  IN  CONST XML_NODE  *Node
  );
 
XML_NODE *
PlistDictChild (
  IN   CONST XML_NODE  *Node,
  IN   UINT32          Child,
  OUT  XML_NODE        **Value OPTIONAL
  );
 
CONST CHAR8 *
PlistKeyValue (
  IN  XML_NODE  *Node  OPTIONAL
  );
 
BOOLEAN
PlistStringValue (
  IN      XML_NODE  *Node   OPTIONAL,
  OUT  CHAR8        *Value,
  IN OUT  UINT32    *Size
  );
 
BOOLEAN
PlistDataValue (
  IN      XML_NODE  *Node    OPTIONAL,
  OUT     UINT8     *Buffer,
  IN OUT  UINT32    *Size
  );
 
BOOLEAN
PlistBooleanValue (
  IN   XML_NODE  *Node   OPTIONAL,
  OUT  BOOLEAN   *Value
  );
 
BOOLEAN
PlistIntegerValue (
  IN   XML_NODE  *Node   OPTIONAL,
  OUT  VOID      *Value,
  IN   UINT32    Size,
  IN   BOOLEAN   Hex
  );
 
BOOLEAN
PlistMultiDataValue (
  IN      XML_NODE  *Node    OPTIONAL,
  OUT  VOID         *Buffer,
  IN OUT  UINT32    *Size
  );
 
BOOLEAN
PlistStringSize (
  IN   XML_NODE  *Node  OPTIONAL,
  OUT  UINT32    *Size
  );
 
BOOLEAN
PlistDataSize (
  IN   XML_NODE  *Node  OPTIONAL,
  OUT  UINT32    *Size
  );
 
BOOLEAN
PlistMultiDataSize (
  IN   XML_NODE  *Node  OPTIONAL,
  OUT  UINT32    *Size
  );
 
#endif // OC_XML_LIB_H