---

XMLCommon.h

Go to the documentation of this file.

/******************************************************************
        ANet_Daemon/Common/XMLCommon.h
        XML accessor functions
        
        Part of the run-time wrapper of the ANet project.
        
        Distributed under GPL: http://www.gnu.org/copyleft/gpl.html
******************************************************************/

#ifndef XML_COMMON
#define XML_COMMON

#include "ANetCommon.h"
#include "Memory.h"

typedef struct ANetAttribute {
  UInt8 *name;
  UInt8 *value;
} ANetAttribute;

typedef struct ANetAttribListItem {
  struct ANetAttribListItem *next;
  ANetAttribute attribute;
} ANetAttribListItem;

typedef struct ANetTag {
  UInt8 *name; // C string
  struct ANetTag *parent;
  void *children; // typecast to ANetTagListItem*
  ANetAttribListItem *attributes;
} ANetTag;

typedef struct ANetTagListItem {
  struct ANetTagListItem *next;
  ANetTag tag;
} ANetTagListItem;

typedef UInt32 ANetAttributeID;
typedef UInt32 ANetTagID;
// TagIDs are used to "hide" the implementation of the XML parser.
// Initially, they are all typecasted pointers, but later on
// they won't point directly to a memory location.


// XML ACCESSORS

UInt32 ANetGetTagName(ANetTagID tagID, UInt8 *nameBuffer, UInt16 maxNameSize);
// You *MUST* allocate memory yourself for nameBuffer

UInt32 ANetGetParent(ANetTagID tagID, ANetTagID *parent);

UInt32 ANetGetNthChild(ANetTagID tagID, UInt32 n, ANetTagID *child);
UInt32 ANetGetNbrChildren(ANetTagID tagID, UInt32 *nbr);
UInt32 ANetFindChildren(ANetTagID root, UInt8 *name, UInt8 *ID);
// ID is the tag's ID, as defined in the DTD file.
// This function can only be used if the tag does have IDs.

UInt32 ANetGetNthAttribute(ANetTagID tagID, UInt32 n, ANetAttributeID atribute);
UInt32 ANetGetNbrAttributes(ANetTagID tagID, UInt32 *nbr);
UInt32 ANetFindAttribute(ANetTagID tagID, UInt8 *name, ANetAttributeID attribute);
UInt32 ANetFindValue(ANetTagID tagID, UInt8 *name, UInt8 *value,
                     UInt16 maxValueSize);

UInt32 ANetGetAttributeName(ANetAttributeID attribID, UInt8 *name,
                            UInt16 maxNameSize);
UInt32 ANetGetAttributeValue(ANetAttributeID attribID, UInt8 *value,
                             UInt16 maxValueSize);

// XML CREATORS / DESTRUCTORS

UInt32 ANetCreateTag(ANetTagID parent, UInt8 *name, ANetTagID *newTagID);
UInt32 ANetRemoveTag(ANetTagID parent, ANetTagID toRemove);

UInt32 ANetAddAttribute(ANetTagID tagID, UInt8 *name, UInt8 *value,
                        ANetAttributeID *newAttributeID);
UInt32 ANetRemoveAttribute(ANetTagID tagID, ANetAttributeID toRemove);

// Note that access rights for XML tags and attributes are implicit,
// including for newly created tags or attributes.

#endif

---